build: ubuntu-24.04, more ruff rules

Author: kiyoon

.github/workflows/apply-pip-compile.yml

@@ -5,7 +5,7 @@ on: workflow_dispatch
 jobs:
   apply-pip-compile:
     name: Apply pip compile
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
       - uses: deargen/workflows/actions/apply-pip-compile@master

.github/workflows/check-docs.yml

@@ -4,7 +4,7 @@ on: pull_request
 
 jobs:
   mkdocs:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
 
     steps:
       - uses: actions/checkout@v4

.github/workflows/check-pip-compile.yml

@@ -14,7 +14,7 @@ concurrency:
 jobs:
   check-pip-compile:
     name: Check pip compile
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
       - uses: deargen/workflows/actions/check-pip-compile@master

.github/workflows/deploy.yml

@@ -33,7 +33,7 @@ jobs:
   publish-to-pypi:
     if: ${{ github.event.inputs.dry-run == 'false' }}
     needs: commit-changelog-and-release
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
         with:

.github/workflows/gen-init-py.yml

@@ -11,7 +11,7 @@ on:
 jobs:
   generate-init-py:
     name: Generate __init__.py files
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
       - uses: deargen/workflows/actions/gen-init-py@master

.github/workflows/tests.yml

@@ -13,65 +13,63 @@ concurrency:
 
 jobs:
   pytest:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     defaults:
       run:
-        shell: bash -el {0} # setup-miniconda requires bash
+        shell: bash -leo pipefail {0} # required by setup-micromamba
     steps:
       - uses: actions/checkout@v4
-      - name: Setup conda
-        uses: deargen/workflows/actions/setup-conda-and-uv@master
-      - name: Cache Conda environment
-        id: cache-conda
+      - name: Setup micromamba and uv
+        uses: deargen/workflows/actions/setup-micromamba-and-uv@master
+      - name: Cache Micromamba environment
+        id: cache-micromamba
         uses: actions/cache@v4
         env:
-          cache-name: cache-conda
+          cache-name: cache-micromamba
         with:
-          path: ~/miniconda3/envs/test
-          key: ${{ runner.os }}-conda-${{ env.cache-name }}-${{ hashFiles('deps/lock/x86_64-manylinux_2_28/requirements_dev.txt') }}
+          path: ~/micromamba/envs/test
+          key: ${{ runner.os }}-micromamba-${{ env.cache-name }}-${{ hashFiles('deps/lock/x86_64-manylinux_2_28/requirements_dev.txt', '.github/workflows/tests.yml', 'pyproject.toml') }}
           # restore-keys: |
-          #   ${{ runner.os }}-conda-${{ env.cache-name }}-
-          #   ${{ runner.os }}-conda-
+          #   ${{ runner.os }}-micromamba-${{ env.cache-name }}-
+          #   ${{ runner.os }}-micromamba-
           #   ${{ runner.os }}-
-      - if: steps.cache-conda.outputs.cache-hit == 'true'
-        run: echo 'conda cache hit!'
+      - if: steps.cache-micromamba.outputs.cache-hit == 'true'
+        run: echo 'micromamba cache hit!'
       - name: Install dependencies
-        if: steps.cache-conda.outputs.cache-hit != 'true'
+        if: steps.cache-micromamba.outputs.cache-hit != 'true'
         run: |
-          # python -m pip install --upgrade pip
           uv pip install -r deps/lock/x86_64-manylinux_2_28/requirements_dev.txt
           uv pip install -e .
           bash scripts/install_binaries.sh
       - name: Run pytest
         uses: deargen/workflows/actions/run-pytest@master
 
   doctest:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     defaults:
       run:
-        shell: bash -el {0} # setup-miniconda requires bash
+        shell: bash -leo pipefail {0} # required by setup-micromamba
     steps:
       - uses: actions/checkout@v4
-      - name: Setup conda
-        uses: deargen/workflows/actions/setup-conda-and-uv@master
-      - name: Cache Conda environment
-        id: cache-conda
+      - name: Setup micromamba and uv
+        uses: deargen/workflows/actions/setup-micromamba-and-uv@master
+      - name: Cache Micromamba environment
+        id: cache-micromamba
         uses: actions/cache@v4
         env:
-          cache-name: cache-conda
+          cache-name: cache-micromamba
         with:
-          path: ~/miniconda3/envs/test
-          key: ${{ runner.os }}-conda-${{ env.cache-name }}-${{ hashFiles('deps/lock/x86_64-manylinux_2_28/requirements_dev.txt') }}
+          path: ~/micromamba/envs/test
+          key: ${{ runner.os }}-micromamba-${{ env.cache-name }}-${{ hashFiles('deps/lock/x86_64-manylinux_2_28/requirements_dev.txt', '.github/workflows/tests.yml', 'pyproject.toml') }}
           # restore-keys: |
-          #   ${{ runner.os }}-conda-${{ env.cache-name }}-
-          #   ${{ runner.os }}-conda-
+          #   ${{ runner.os }}-micromamba-${{ env.cache-name }}-
+          #   ${{ runner.os }}-micromamba-
           #   ${{ runner.os }}-
-      - if: steps.cache-conda.outputs.cache-hit == 'true'
-        run: echo 'conda cache hit!'
+      - if: steps.cache-micromamba.outputs.cache-hit == 'true'
+        run: echo 'micromamba cache hit!'
       - name: Install dependencies
-        if: steps.cache-conda.outputs.cache-hit != 'true'
+        if: steps.cache-micromamba.outputs.cache-hit != 'true'
         run: |
-          # python -m pip install --upgrade pip
           uv pip install -r deps/lock/x86_64-manylinux_2_28/requirements_dev.txt
           uv pip install -e .
           bash scripts/install_binaries.sh

pyproject.toml

@@ -52,6 +52,7 @@ src = ["src"]  # for ruff isort
 extend-exclude = [
   "src/slack_helpers/_version.py",  # CHANGE
 ]
+namespace-packages = ["tools", "scripts"]  # for INP rule, suppress on these directories
 
 [tool.ruff.lint]
 # OPTIONALLY ADD MORE LATER
@@ -73,6 +74,7 @@ select = [
   "RET503",  # return
   "PTH",  # path
   "NPY",  # numpy
+  "PD",   # pandas
   "PYI",  # type stubs for pyright/pylance
   "PT",   # pytest
   "PIE",  #
@@ -82,6 +84,21 @@ select = [
   "DTZ",  # datetime
   "YTT",
   "ASYNC",
+  "FBT",  # boolean trap
+  "A",    # Shadowing python builtins
+  "EXE",  # executable (shebang)
+  "FA",   # future annotations
+  "ISC",  # Implicit string concatenation
+  "ICN",  # Import convention 
+  "INP",  # Implicit namespace package (no __init__.py)
+  "Q",    # Quotes
+  "RSE",  # raise
+  "SLOT", # __slots__
+  "PL",   # Pylint
+  "TRY",  # try
+  "FAST", # FastAPI
+  "AIR",  # airflow
+  "DOC",  # docstring
 
   # Not important
   "T10",  # debug statements
@@ -97,12 +114,14 @@ ignore = [
   "D212",    # Multi-line docstring summary should start at the first line
   "D417",    # require documentation for every function parameter.
   "D401",    # require an imperative mood for all docstrings.
+  "DOC201",  # missing Return field in docstring
   "PTH123",  # Path.open should be used instead of built-in open
   "PT006",   # Pytest parameterize style
   "N812",    # Lowercase `functional` imported as non-lowercase `F` (import torch.nn.functional as F)
   "NPY002",  # legacy numpy random
   "UP017",   # datetime.timezone.utc -> datetime.UTC
   "SIM108",  # use ternary operator instead of if-else
+  "TRY003",  # long message in except
 ]
 
 [tool.ruff.lint.pydocstyle]
@@ -128,6 +147,11 @@ known-third-party = ["wandb"]
 # NOTE: Ruff code TID is currently disabled, so this settings doesn't do anything.
 banned-module-level-imports = ["torch", "tensorflow"]
 
+[tool.ruff.lint.pylint]
+max-args = 10
+max-bool-expr = 10
+max-statements = 100
+
 [tool.pyright]
 include = ["src"]
 

src/slack_helpers/cli/main.py

@@ -6,17 +6,18 @@
 )
 
 
-def version_callback(value: bool):
+def version_callback(*, value: bool):
     if value:
         from .. import __version__
 
         print(__version__)
-        raise typer.Exit()
+        raise typer.Exit
 
 
 @app.callback()
 def common(
     ctx: typer.Context,
+    *,
     version: bool = typer.Option(
         None, "-v", "--version", callback=version_callback, help="Show version"
     ),

src/slack_helpers/health/font.py

@@ -5,7 +5,9 @@
 
 
 class FontNotInstalledError(Exception):
-    pass
+    def __init__(self, font_name: str):
+        self.message = f"Font {font_name} is not installed."
+        super().__init__(self.message)
 
 
 def verify_fonts_installed():
@@ -30,11 +32,12 @@ def verify_fonts_installed():
 def verify_fonts_bool():
     try:
         verify_fonts_installed()
-        logger.info("✅ FiraCode font is installed.")
-        return True
     except FontNotInstalledError:
-        logger.error("😡 FiraCode font is not installed.")
+        logger.exception("😡")
         return False
+    else:
+        logger.info("✅ FiraCode font is installed.")
+        return True
 
 
 if __name__ == "__main__":

src/slack_helpers/health/slack.py

@@ -6,7 +6,7 @@
 logger = logging.getLogger(__name__)
 
 
-def check_one_env(env_var, secret=False, secret_show_first_n=0):
+def check_one_env(env_var, *, secret=False, secret_show_first_n=0):
     value = os.environ.get(env_var)
     if value is None:
         logger.error(f"😡 Please set the environment variable {env_var}.")
@@ -24,16 +24,24 @@ def check_one_env(env_var, secret=False, secret_show_first_n=0):
     return True
 
 
-def check_many_env(env_vars, secret=False, secret_show_first_n=0):
+def check_many_env(env_vars, *, secret=False, secret_show_first_n=0):
     ret = True
     for env_var in env_vars:
-        if not check_one_env(env_var, secret, secret_show_first_n):
+        if not check_one_env(
+            env_var,
+            secret=secret,
+            secret_show_first_n=secret_show_first_n,
+        ):
             ret = False
     return ret
 
 
 def check_env():
-    secrets_checked = check_many_env(["SLACK_BOT_TOKEN", "SLACK_APP_TOKEN"], True, 5)
+    secrets_checked = check_many_env(
+        ["SLACK_BOT_TOKEN", "SLACK_APP_TOKEN"],
+        secret=True,
+        secret_show_first_n=5,
+    )
     normal_checked = check_many_env(["SLACK_CHANNEL_ID"])
 
     return secrets_checked and normal_checked

src/slack_helpers/send_only.py

@@ -14,7 +14,7 @@
 
 
 def warn_once():
-    global warned
+    global warned  # noqa: PLW0603
     if not warned:
         logger.warning(
             "You tried to send messages on Slack, but the token is not set. All messages will be ignored."
@@ -57,7 +57,7 @@ def send_text_as_file(
     Send a text as a file to the default client and channel (if not specified).
 
     Slack is stupid and having special characters in the file makes it think it's a binary file.
-    If ensure_preview is True, then we append `""" "dear-viewer" """` at the beginning of the file so Slack thinks
+    If ensure_preview is True, then we append `\"\"\"\"dear-viewer\"\"\"\"` at the beginning of the file so Slack thinks
     it's a python file and will preview it.
 
     Note:
@@ -71,12 +71,12 @@ def send_text_as_file(
         filename:
         content:
         title:
-        ensure_preview: If True, append `""" "dear-viewer" """` at the beginning of the file to ensure that
+        ensure_preview: If True, append `\"\"\"\"dear-viewer\"\"\"\"` at the beginning of the file to ensure that
                         Slack will preview it.
         initial_comment:
         channel_id:
         client:
-    """
+    """  # noqa: D301
     if client is None:
         client = default_client
     if client is None:
@@ -255,7 +255,7 @@ def send_svg_as_pdf(
     elif isinstance(svg_file, IOBase):
         cairosvg.svg2pdf(file_obj=svg_file, write_to=pdf_buf)
     else:
-        raise ValueError(f"Unsupported type {type(svg_file)}")
+        raise TypeError(f"Unsupported type {type(svg_file)}")
 
     pdf_buf.seek(0)
 

src/slack_helpers/utils/log.py

@@ -122,7 +122,7 @@ def setup_logging(
 
 def main():
     logger.info("Hello, world!")
-    raise Exception("Test exception")
+    raise Exception("Test exception")  # noqa: TRY002
 
 
 if __name__ == "__main__":

tools/examples/send_traceback.py

@@ -26,7 +26,7 @@
 def main():
     try:
         setup_logging()
-        raise Exception("This is an exception")
+        raise Exception("This is an exception")  # noqa: TRY301 TRY002
     except Exception:
         logger.exception("Exception occurred")
         slack_text = f"Exception occurred from host {socket.gethostname()}\n\n```{traceback.format_exc()}```"