Merge pull request #176 from python-discord/ruff-migration

Ruff migration

Author: ChrisLovering

.github/workflows/docs.yaml

@@ -11,20 +11,19 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Install Python Dependencies
-        uses: HassanAbouelela/actions/setup-python@setup-python_v1.3.2
+        uses: HassanAbouelela/actions/setup-python@setup-python_v1.4.0
         with:
-          dev: true
           python_version: "3.11"
           install_args: "--extras async-rediscache --only main --only doc"
 
       - name: Generate HTML Site
         run: sphinx-build -nW -j auto -b html docs docs/build
 
       - name: Upload Build Artifact
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: docs-latest
           path: docs/build/*
@@ -34,14 +33,13 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           fetch-depth: 0  # We need to check out the entire repository to find all tags
 
       - name: Install Python Dependencies
-        uses: HassanAbouelela/actions/setup-python@setup-python_v1.3.2
+        uses: HassanAbouelela/actions/setup-python@setup-python_v1.4.0
         with:
-          dev: true
           python_version: "3.11"
           install_args: "--extras async-rediscache"
 
@@ -57,13 +55,13 @@ jobs:
           rm -r docs/build/**/.doctrees
 
       - name: Upload Build Artifact
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: docs
           path: docs/build/*
 
       - name: Deploy To GitHub Pages
-        uses: JamesIves/github-pages-deploy-action@4.1.7
+        uses: JamesIves/github-pages-deploy-action@v4
         with:
           branch: docs
           folder: docs/build

.github/workflows/lint-test.yaml

@@ -13,29 +13,17 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Install Python Dependencies
-        uses: HassanAbouelela/actions/setup-python@setup-python_v1.3.2
+        uses: HassanAbouelela/actions/setup-python@setup-python_v1.4.0
         with:
-          # Set dev=true to run pre-commit which is a dev dependency
-          dev: true
           python_version: ${{ matrix.python_version }}
           install_args: "--extras async-rediscache --only main --only lint --only test"
 
-      # We will not run `flake8` here, as we will use a separate flake8
-      # action.
       - name: Run pre-commit hooks
-        run: SKIP=flake8 pre-commit run --all-files
+        run: SKIP=ruff pre-commit run --all-files
 
-      # Run flake8 and have it format the linting errors in the format of
-      # the GitHub Workflow command to register error annotations. This
-      # means that our flake8 output is automatically added as an error
-      # annotation to both the run result and in the "Files" tab of a
-      # pull request.
-      #
-      # Format used:
-      # ::error file={filename},line={line},col={col}::{message}
-      - name: Run flake8
-        run: "flake8 \
-        --format='::error file=%(path)s,line=%(row)d,col=%(col)d::[flake8] %(code)s: %(text)s'"
+      # Run `ruff` using github formatting to enable automatic inline annotations.
+      - name: Run ruff
+        run: "ruff check --format=github ."
 
       - name: Run tests and generate coverage report
         run: python -m pytest -n auto --cov pydis_core -q
@@ -60,7 +48,7 @@ jobs:
       - name: Upload a Build Artifact
         if: always() && steps.prepare-artifact.outcome == 'success'
         continue-on-error: true
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: pull-request-payload
           path: pull_request_payload.json

.pre-commit-config.yaml

@@ -5,20 +5,25 @@ repos:
       - id: check-merge-conflict
       - id: check-toml
       - id: check-yaml
-        args: [--unsafe] # Required due to custom constructors (e.g. !ENV)
       - id: end-of-file-fixer
       - id: trailing-whitespace
         args: [--markdown-linebreak-ext=md]
-  - repo: https://github.com/pre-commit/pygrep-hooks
-    rev: v1.9.0
-    hooks:
-      - id: python-check-blanket-noqa
+
   - repo: local
     hooks:
-      - id: flake8
-        name: Flake8
-        description: This hook runs flake8 within our project's poetry environment.
-        entry: poetry run flake8
+      - id: isort
+        name: isort
+        description: This hook runs isort within our project's environment.
+        entry: poetry run isort
         language: system
         types: [python]
         require_serial: true
+
+      - id: ruff
+        name: ruff
+        description: Run ruff linting
+        entry: poetry run ruff check --force-exclude
+        language: system
+        'types_or': [python, pyi]
+        require_serial: true
+        args: [--fix, --exit-non-zero-on-fix]

dev/bot/__init__.py

@@ -21,4 +21,4 @@ class Bot(pydis_core.BotBase):
     async def setup_hook(self) -> None:
         """Load extensions on startup."""
         await super().setup_hook()
-        asyncio.create_task(self.load_extensions(sys.modules[__name__]))
+        await self.load_extensions(sys.modules[__name__])

dev/bot/__main__.py

@@ -7,6 +7,7 @@
 from discord.ext import commands
 
 import pydis_core
+
 from . import Bot
 
 dotenv.load_dotenv()
@@ -17,7 +18,7 @@
 
 bot = Bot(
     guild_id=int(os.getenv("GUILD_ID")),
-    http_session=None,  # type: ignore # We need to instantiate the session in an async context
+    http_session=None,  # type: ignore We need to instantiate the session in an async context
     allowed_roles=roles,
     command_prefix=commands.when_mentioned_or(os.getenv("PREFIX", "!")),
     intents=discord.Intents.all(),

dev/bot/cog.py

@@ -12,7 +12,7 @@ def __init__(self, _bot: Bot):
     @commands.Cog.listener()
     async def on_ready(self) -> None:
         """Print a message when the client (re)connects."""
-        print("Client is ready.")
+        print("Client is ready.")  # noqa: T201
 
     @commands.command()
     async def reload(self, ctx: commands.Context) -> None:

docs/changelog.rst

@@ -3,6 +3,9 @@
 
 Changelog
 =========
+- :feature:`176` Migrate repo to use ruff for linting
+
+
 - :release:`9.6.0 <6th May 2023>`
 - :feature:`175` Log when waiting for the guild to be available before loading cogs
 - :support:`175` Bump Discord.py to :literal-url:`2.2.3 <https://github.com/Rapptz/discord.py/releases/tag/v2.2.3>`.

docs/conf.py

@@ -1,6 +1,7 @@
 # Configuration file for the Sphinx documentation builder.
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
+import contextlib
 import functools
 import os.path
 import shutil
@@ -16,7 +17,7 @@
 logger = sphinx.util.logging.getLogger(__name__)
 
 # Handle the path not being set correctly in actions.
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath(".."))
 
 from docs import utils  # noqa: E402
 
@@ -209,10 +210,9 @@ def _releases_setup(app: Sphinx) -> dict:
 smv_branch_whitelist = "main"
 if os.getenv("BUILD_DOCS_FOR_HEAD", "False").lower() == "true":
     if not (branch := os.getenv("BRANCH_NAME")):
-        try:
+        with contextlib.suppress(git.InvalidGitRepositoryError):
             branch = git.Repo(PROJECT_ROOT).active_branch.name
-        except git.InvalidGitRepositoryError:
-            pass
+
 
     if branch:
         logger.info(f"Adding branch {branch} to build whitelist.")

docs/netlify_build.py

@@ -22,5 +22,5 @@
 
 if __name__ == "__main__":
     # Run the build script
-    print("Build started")
-    subprocess.run([sys.executable, OUTPUT.absolute()])
+    print("Build started")  # noqa: T201
+    subprocess.run([sys.executable, OUTPUT.absolute()])  # noqa: S603

docs/utils.py

@@ -30,16 +30,15 @@ def get_build_root() -> Path:
 def is_attribute(module: types.ModuleType, parameter: str) -> bool:
     """Returns true if `parameter` is an attribute of `module`."""
     docs = docstring_parser.parse(inspect.getdoc(module), docstring_parser.DocstringStyle.GOOGLE)
-    for param in docs.params:
+    for param in docs.params:  # noqa: SIM110
         # The docstring_parser library can mis-parse arguments like `arg (:obj:`str`)` as `arg (`
         # which would create a false-negative below, so we just strip away the extra parenthesis.
         if param.args[0] == "attribute" and param.arg_name.rstrip(" (") == parameter:
             return True
-
     return False
 
 
-def linkcode_resolve(repo_link: str, domain: str, info: dict[str, str]) -> typing.Optional[str]:
+def linkcode_resolve(repo_link: str, domain: str, info: dict[str, str]) -> str | None:
     """
     Function called by linkcode to get the URL for a given resource.
 
@@ -79,8 +78,7 @@ def linkcode_resolve(repo_link: str, domain: str, info: dict[str, str]) -> typin
             # This could be caused by trying to link a class attribute
             if is_attribute(symbol[-1], name):
                 break
-            else:
-                raise e
+            raise e
 
         symbol_name = name
 
@@ -97,8 +95,8 @@ def linkcode_resolve(repo_link: str, domain: str, info: dict[str, str]) -> typin
         pos = _global_assign_pos(source, symbol_name)
         if pos is None:
             raise Exception(f"Could not find symbol `{symbol_name}` in {module.__name__}.")
-        else:
-            start, end = pos
+
+        start, end = pos
         _, offset = inspect.getsourcelines(symbol[-2])
         if offset != 0:
             offset -= 1
@@ -126,7 +124,7 @@ class NodeWithBody(typing.Protocol):
     body: list[ast.AST]
 
 
-def _global_assign_pos(ast_: NodeWithBody, name: str) -> typing.Union[tuple[int, int], None]:
+def _global_assign_pos(ast_: NodeWithBody, name: str) -> tuple[int, int] | None:
     """
     Find the first instance where the `name` global is defined in `ast_`.
 
@@ -149,6 +147,7 @@ def _global_assign_pos(ast_: NodeWithBody, name: str) -> typing.Union[tuple[int,
             pos_in_if = _global_assign_pos(ast_obj, name)
             if pos_in_if is not None:
                 return pos_in_if
+    return None
 
 
 def cleanup() -> None:
@@ -200,7 +199,7 @@ def build_api_doc() -> None:
         logger.info(f"Skipping api-doc for {output_folder.as_posix()} as it already exists.")
         return
 
-    result = subprocess.run(cmd, cwd=build_root, stdout=subprocess.PIPE, check=True, env=os.environ)
+    result = subprocess.run(cmd, cwd=build_root, stdout=subprocess.PIPE, check=True, env=os.environ)  # noqa: S603
     logger.debug("api-doc Output:\n" + result.stdout.decode(encoding="utf-8") + "\n")
 
     cleanup()