ci: Add taskfiles and update GH workflows for linting Python files. (#60)

Co-authored-by: Lin Zhihao <59785146+LinZhihao-723@users.noreply.github.com>

Author: davidlion

.github/workflows/code-linting-checks.yaml

@@ -2,9 +2,15 @@ name: "code-linting-checks"
 
 on:
   pull_request:
-    paths: ["**/*.yaml"]
+    paths:
+      - "**/*.py"
+      - "**/*.pyi"
+      - "**/*.yaml"
   push:
-    paths: ["**/*.yaml"]
+    paths:
+      - "**/*.py"
+      - "**/*.pyi"
+      - "**/*.yaml"
   schedule:
     # Run daily at 00:15 UTC (the 15 is to avoid periods of high load)
     - cron: "15 0 * * *"
@@ -35,6 +41,10 @@ jobs:
         shell: "bash"
         run: "npm install -g @go-task/cli"
 
+      - name: "Install uv"
+        shell: "bash"
+        run: "curl --fail --location --silent --show-error https://astral.sh/uv/install.sh | sh"
+
       - name: "Run lint task"
         shell: "bash"
         run: "task lint:check"

exports/lint-configs/python/README.md

@@ -0,0 +1,9 @@
+# Python linter configs
+
+This directory contains standalone, working Python linter configuration files that serve as
+reference settings for integrating these linters into your project.
+
+For a project with its own `pyproject.toml` file, at the time of writing, there is no clean, general
+solution for including the standalone configuration files for different linters. In this scenario,
+the settings inside the configuration files should be copied into your `pyproject.toml` file, as
+seen in [ystdlib-py/pyproject.toml](../../ystdlib-py/pyproject.toml).

exports/lint-configs/python/mypy.ini

@@ -0,0 +1,8 @@
+[mypy]
+strict = true
+
+# Additional output
+pretty = true
+show_error_code_links = true
+show_error_context = true
+show_error_end = true

exports/lint-configs/python/ruff.toml

@@ -0,0 +1,27 @@
+line-length = 100
+
+[lint]
+select = ["ALL"]
+ignore = [
+    "COM812",  # Redundant and conflicts with ruff format
+    "D203",  # No blank line before docstrings (D211)
+    "D205",  # Breaks if summary is larger than one line due to wrapping or if no summary exists
+    "D212",  # Enforce docstring summary line on the next line after quotes (D213)
+    "D400",  # First line of docstrings may not end in period
+    "D401",  # Docstrings should be written in present tense (not imperative)
+    "D415",  # First line of docstrings may not end in a period, question mark, or exclamation point
+    "FBT",  # Allow bool positional parameters since other value positions are allowed
+    "FIX002",  # Allow todo statements
+    "PERF401",  # Allow for loops when creating lists
+    "PERF403",  # Allow for loops when creating dicts
+    "S311",  # Allow usage of `random` package
+    "SIM102",  # Allow collapsible if statements for readability
+    "TD002",  # Author unnecessary for todo statement
+    "TD003",  # Issue link unnecessary for todo statement
+    "UP015",  # Explicit open modes are helpful
+]
+isort.order-by-type = false
+
+[format]
+docstring-code-format = true
+docstring-code-line-length = 100

exports/ystdlib-py/pyproject.toml

@@ -19,9 +19,13 @@ dev = [
 ]
 
 [tool.mypy]
-pretty = true
 strict = true
-warn_unused_ignores = true
+
+# Additional output
+pretty = true
+show_error_code_links = true
+show_error_context = true
+show_error_end = true
 
 [tool.ruff]
 line-length = 100

taskfile.yaml

@@ -8,7 +8,14 @@ set: ["u", "pipefail"]
 shopt: ["globstar"]
 
 vars:
+  # Directories
+  G_EXPORTS_DIR: "{{.ROOT_DIR}}/exports"
+  G_LINT_CONFIGS_DIR: "{{.G_EXPORTS_DIR}}/lint-configs"
   G_OUTPUT_DIR: "{{.ROOT_DIR}}/build"
+  G_YSTDLIB_PY_DIR: "{{.G_EXPORTS_DIR}}/ystdlib-py"
+
+  # Utility commands
+  G_PYFIND_CMD: "uv run --project '{{.G_YSTDLIB_PY_DIR}}' pyfind"
 
 tasks:
   clean:

taskfiles/lint/main.yaml

@@ -1,6 +1,9 @@
 version: "3"
 
 includes:
+  py:
+    flatten: true
+    taskfile: "./python.yaml"
   utils: "../../exports/taskfiles/utils/utils.yaml"
   yaml:
     flatten: true
@@ -14,6 +17,7 @@ tasks:
   check:
     desc: "Runs all linters to identify any violations."
     cmds:
+      - task: "check-py"
       - task: "check-yaml"
 
   venv:
@@ -24,7 +28,7 @@ tasks:
       OUTPUT_DIR: "{{.G_LINT_VENV_DIR}}"
     sources:
       - "{{.LINT_REQUIREMENTS_FILE}}"
-      - "{{.ROOT_DIR}}/exports/taskfiles/**/*.yaml"
+      - "{{.G_EXPORTS_DIR}}/taskfiles/**/*.yaml"
       - "{{.ROOT_DIR}}/taskfile.yaml"
       - "{{.TASKFILE_DIR}}/**/*.yaml"
     generates: ["{{.CHECKSUM_FILE}}"]

taskfiles/lint/python.yaml

@@ -0,0 +1,22 @@
+version: "3"
+
+tasks:
+  check-py:
+    cmds:
+      - task: "py"
+        vars:
+          RUFF_FORMAT_FLAGS: "--diff"
+
+  fix-py:
+    cmds:
+      - task: "py"
+        vars:
+          RUFF_CHECK_FLAGS: "--fix"
+
+  py:
+    internal: true
+    cmd: |-
+      cd "{{.G_YSTDLIB_PY_DIR}}"
+      uv run mypy "./src"
+      uv run ruff check {{.RUFF_CHECK_FLAGS}} "./src"
+      uv run ruff format {{.RUFF_FORMAT_FLAGS}} "./src"

taskfiles/ystdlib-py/test-pyfind.yaml

@@ -107,7 +107,7 @@ tasks:
       FIND_OUTPUT:
         sh: |
           cd "{{.G_TEST_DIR}}"
-          uv run --project "{{.ROOT_DIR}}/exports/ystdlib-py" pyfind \
+          {{.G_PYFIND_CMD}} \
             {{- range .FIND_ROOT_PATHS}}
               "{{.}}" \
             {{- end}}