Update tools

.github/workflows/on_push.yml

@@ -35,21 +35,14 @@ jobs:
       - name: Code style
         if: ${{ matrix.check-formatting }}
         run: |
-          poetry run black --check awscliv2
-          poetry run isort -c awscliv2
+          poetry run ruff format --check
       - name: Lint
+        if: ${{ matrix.check-formatting }}
         run: |
-          poetry run flake8 awscliv2
-      - name: Set up Node
-        uses: actions/setup-node@v4
-        with:
-          node-version: "20"
-      - name: Install Node.js dependencies
-        run: |
-          npm install -g pyright
+          poetry run ruff check
       - name: Typing
         run: |
-          poetry run npx pyright awscliv2
+          poetry run pyright awscliv2
       - name: Test
         run: |
           poetry run pytest

awscliv2/__init__.py

@@ -1,3 +1,3 @@
 """
-This is the main module of the awscliv2 package.
+Main module of the awscliv2 package.
 """

awscliv2/exceptions.py

@@ -14,6 +14,9 @@ def __init__(self, msg: str = "", returncode: int = 1) -> None:
         self.returncode = returncode
 
     def __str__(self) -> str:
+        """
+        Represent as a string.
+        """
         return self.msg
 
 

awscliv2/main.py

@@ -14,7 +14,7 @@
 
 def main(args: Sequence[str]) -> int:
     """
-    Main program entrypoint.
+    Entrypoint for API.
     """
     namespace = parse_args(args)
     runner = AWSAPI(encoding=namespace.encoding, output=sys.stdout)
@@ -58,7 +58,7 @@ def main(args: Sequence[str]) -> int:
 
 def main_cli() -> None:
     """
-    Main entrypoint for CLI.
+    Entrypoint for CLI.
     """
     try:
         sys.exit(main(sys.argv[1:]))

pyproject.toml

@@ -58,14 +58,8 @@ pip = "*"
 importlib-metadata = { version = "*", python = "<3.8" }
 
 [tool.poetry.dev-dependencies]
-isort = { version = "*", python = ">=3.10" }
-black = { version = "*", python = ">=3.10" }
-flake8 = { version = "*", python = ">=3.10" }
-flake8-bugbear = { version = "*", python = ">=3.10" }
-flake8-comprehensions = { version = "*", python = ">=3.10" }
-flake8-docstrings = { version = "*", python = ">=3.10" }
-flake8-simplify = { version = "*", python = ">=3.10" }
-flake8-string-format = { version = "*", python = ">=3.10" }
+ruff = { version = "*", python = ">=3.10" }
+pyright = { version = "*", python = ">=3.10" }
 rope = { version = "*", python = ">=3.10" }
 handsdown = { version = "*", python = ">=3.10" }
 pytest = { version = "*", python = ">=3.10" }
@@ -98,3 +92,49 @@ reportIncompatibleMethodOverride = "error"
 reportIncompatibleVariableOverride = "error"
 reportUnknownParameterType = "error"
 pythonVersion = "3.7"
+
+[tool.ruff]
+exclude = [
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".mypy_cache",
+    ".pytest_cache",
+    ".ruff_cache",
+    ".venv",
+    ".vscode",
+    "build",
+    "dist",
+]
+
+line-length = 100
+indent-width = 4
+target-version = "py37"
+
+[tool.ruff.lint]
+select = ["E4", "E7", "E9", "F", "B", "I", "N", "D", "C4", "C90", "RUF"]
+ignore = [
+    "E501",
+    "N803",
+    "N818",
+    "D107",
+    "D200",
+    "D203",
+    "D212",
+    "D406",
+    "D407",
+    "D413",
+    "D417",
+]
+fixable = ["ALL"]
+unfixable = ["B"]
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+exclude = ["test_*.py", "*.pyi"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+docstring-code-format = false
+docstring-code-line-length = "dynamic"

scripts/before_commit.sh

@@ -4,8 +4,7 @@ set -e
 ROOT_PATH=$(dirname $(dirname $(realpath $0)))
 cd $ROOT_PATH
 
-poetry run black .
-poetry run isort .
-poetry run flake8 awscliv2
+poetry run ruff check
+poetry run ruff format --check
 poetry run pytest --cov-report term --cov=awscliv2
 poetry run npx pyright

scripts/example.py

@@ -1,3 +1,7 @@
+"""
+Example script.
+"""
+
 import json
 import shlex
 

tests/__init__.py

@@ -0,0 +1,3 @@
+"""
+Tests.
+"""