Add more ruff checks and use defaults (#2318)

* More ruff

Signed-off-by: Bernát Gábor <[email protected]>

* Handle test suite

Signed-off-by: Bernát Gábor <[email protected]>

* Format tests

Signed-off-by: Bernát Gábor <[email protected]>

* Fix config

Signed-off-by: Bernát Gábor <[email protected]>

* Automatic fixes

Signed-off-by: Bernát Gábor <[email protected]>

* Manual test fixes

Signed-off-by: Bernát Gábor <[email protected]>

* Batch 1 src fixes

Signed-off-by: Bernát Gábor <[email protected]>

* Fix type annotations

Signed-off-by: Bernát Gábor <[email protected]>

* Finish type checks

Signed-off-by: Bernát Gábor <[email protected]>

* Restore 3.8 support

Signed-off-by: Bernát Gábor <[email protected]>

* Add future imports

Signed-off-by: Bernát Gábor <[email protected]>

---------

Signed-off-by: Bernát Gábor <[email protected]>

Author: gaborbernat

.github/workflows/test.yaml

@@ -26,7 +26,7 @@ jobs:
           - tox_env: py3.12-black24
           - tox_env: py3.12-black23
           - tox_env: py3.12-black22
-          - tox_env: py3.9-black19
+          - tox_env: py3.8-black19
           - tox_env: py3.8-pydantic18
           - tox_env: py3.8-isort4
     runs-on: ${{ matrix.os == '' && 'ubuntu-24.04' || matrix.os }}
@@ -38,6 +38,9 @@ jobs:
         fetch-depth: 0
     - name: Install the latest version of uv
       uses: astral-sh/setup-uv@v5
+      with:
+        enable-cache: true
+        cache-suffix: "${{ matrix.py || matrix.tox_env }}"
     - name: Install tox
       run: uv tool install --python-preference only-managed --python 3.13 tox --with tox-uv
     - name: Setup Python test environment

.pre-commit-config.yaml

@@ -16,15 +16,12 @@ repos:
 - repo: https://github.com/astral-sh/ruff-pre-commit
   rev: 'v0.9.6'
   hooks:
-  - id: ruff
-    files: "^datamodel_code_generator|^tests"
-    exclude: "^tests/data"
-    args: [ --fix ]
   - id: ruff-format
-    files: "^datamodel_code_generator|^tests"
     exclude: "^tests/data"
+  - id: ruff
+    exclude: "^tests/data"
+    args: ["--exit-non-zero-on-fix"]
 - repo: https://github.com/codespell-project/codespell
-  # Configuration for codespell is in pyproject.toml
   rev: v2.4.1
   hooks:
   - id: codespell

pyproject.toml

@@ -83,7 +83,7 @@ test = [
   "pytest-cov>=5",
   "pytest-mock>=3.14",
   "pytest-xdist>=3.3.1",
-  "setuptools; python_version<'3.9'",
+  "setuptools; python_version<'3.10'", # PyCharm debugger needs it
   { include-group = "coverage" },
 ]
 type = [
@@ -123,13 +123,44 @@ version.source = "vcs"
 [tool.ruff]
 line-length = 120
 extend-exclude = [ "tests/data" ]
-format.indent-style = "space"
-format.quote-style = "single"
-format.line-ending = "auto"
-format.skip-magic-trailing-comma = false
-lint.extend-select = [ "C4", "I", "Q", "RUF100", "UP" ]
-lint.ignore = [ "E501", "Q000", "Q003", "UP006", "UP007" ]
-lint.flake8-quotes = { inline-quotes = 'single', multiline-quotes = 'double' }
+format.preview = true
+format.docstring-code-format = true
+lint.select = [
+  "ALL",
+]
+lint.ignore = [
+  "ANN401", # Any as type annotation is allowed
+  "C901",   # complex structure
+  "COM812", # Conflict with formatter
+  "CPY",    # No copyright statements
+  "D",      # limited documentation
+  "DOC",    # limited documentation
+  "FIX002", # line contains to do
+  "ISC001", # Conflict with formatter
+  "S101",   # can use assert
+  "TD002",  # missing to do author
+  "TD003",  # missing to do link
+  "TD004",  # missing colon in to do
+]
+lint.per-file-ignores."tests/**/*.py" = [
+  "FBT",     # don't care about booleans as positional arguments in tests
+  "INP001",  # no implicit namespace
+  "PLC2701", # private import is fine
+  "PLR0913", # as many arguments as want
+  "PLR0915", # can have longer test methods
+  "PLR0917", # as many arguments as want
+  "PLR2004", # Magic value used in comparison, consider replacing with a constant variable
+  "S",       # no safety concerns
+  "SLF001",  # can test private methods
+]
+lint.isort = { known-first-party = [
+  "datamodel_code_generator",
+  "tests",
+], required-imports = [
+  "from __future__ import annotations",
+] }
+
+lint.preview = true
 
 [tool.codespell]
 skip = '.git,*.lock,tests'
@@ -150,6 +181,7 @@ filterwarnings = [
   "ignore:^.*`experimental string processing` has been included in `preview` and deprecated. Use `preview` instead..*",
 ]
 norecursedirs = "tests/data/*"
+verbosity_assertions = 2
 
 [tool.coverage]
 html.skip_covered = false
@@ -168,7 +200,7 @@ paths.other = [
 ]
 run.dynamic_context = "none"
 run.omit = [ "tests/data/*" ]
-report.fail_under = 94
+report.fail_under = 88
 run.parallel = true
 run.plugins = [
   "covdefaults",

scripts/update_command_help_on_markdown.py

@@ -1,39 +1,41 @@
+from __future__ import annotations  # noqa: INP001
+
 import io
 import os
 import re
 import sys
 from pathlib import Path
 
-from datamodel_code_generator.__main__ import Exit, arg_parser
+from datamodel_code_generator.__main__ import Exit, arg_parser  # noqa: PLC2701
 
-os.environ['COLUMNS'] = '94'
-os.environ['LINES'] = '24'
+os.environ["COLUMNS"] = "94"
+os.environ["LINES"] = "24"
 
-START_MARK: str = '<!-- start command help -->'
-END_MARK: str = '<!-- end command help -->'
-BASH_CODE_BLOCK: str = '```bash'
-CODE_BLOCK_END: str = '```'
+START_MARK: str = "<!-- start command help -->"
+END_MARK: str = "<!-- end command help -->"
+BASH_CODE_BLOCK: str = "```bash"
+CODE_BLOCK_END: str = "```"
 
 CURRENT_DIR = Path(__file__).parent
 PROJECT_DIR = CURRENT_DIR.parent
-DOC_DIR = PROJECT_DIR / 'docs'
+DOC_DIR = PROJECT_DIR / "docs"
 
 TARGET_MARKDOWN_FILES: list[Path] = [
-    DOC_DIR / 'index.md',
-    PROJECT_DIR / 'README.md',
+    DOC_DIR / "index.md",
+    PROJECT_DIR / "README.md",
 ]
 
-REPLACE_MAP = {'(default: UTF-8)': '(default: utf-8)', "'": r"''"}
+REPLACE_MAP = {"(default: UTF-8)": "(default: utf-8)", "'": r"''"}
 
 
-def get_help():
+def get_help() -> str:
     with io.StringIO() as f:
         arg_parser.print_help(file=f)
         output = f.getvalue()
     for k, v in REPLACE_MAP.items():
         output = output.replace(k, v)
     # Remove any terminal codes
-    return re.sub(r'\x1b\[[0-?]*[ -/]*[@-~]', '', output)
+    return re.sub(r"\x1b\[[0-?]*[ -/]*[@-~]", "", output)
 
 
 def inject_help(markdown_text: str, help_text: str) -> str:
@@ -43,43 +45,40 @@ def inject_help(markdown_text: str, help_text: str) -> str:
     start_pos = markdown_text.find(START_MARK)
     end_pos = markdown_text.find(END_MARK)
     if start_pos == -1 or end_pos == -1:
-        raise ValueError(f'Could not find {START_MARK} or {END_MARK} in markdown_text')
+        msg = f"Could not find {START_MARK} or {END_MARK} in markdown_text"
+        raise ValueError(msg)
     return (
         markdown_text[: start_pos + len(START_MARK)]
-        + '\n'
+        + "\n"
         + BASH_CODE_BLOCK
-        + '\n'
+        + "\n"
         + help_text
         + CODE_BLOCK_END
-        + '\n'
+        + "\n"
         + markdown_text[end_pos:]
     )
 
 
 def main() -> Exit:
     help_text = get_help()
     arg_parser.add_argument(
-        '--validate',
-        action='store_true',
-        help='Validate the file content is up to date',
+        "--validate",
+        action="store_true",
+        help="Validate the file content is up to date",
     )
     args = arg_parser.parse_args()
     validate: bool = args.validate
 
     for file_path in TARGET_MARKDOWN_FILES:
-        with file_path.open('r') as f:
+        with file_path.open("r") as f:
             markdown_text = f.read()
         new_markdown_text = inject_help(markdown_text, help_text)
         if validate and new_markdown_text != markdown_text:
-            print(
-                f'{file_path} is not up to date. Run `python update_command_help_on_markdown.py`',
-                file=sys.stderr,
-            )
             return Exit.ERROR
-        with file_path.open('w') as f:
+        with file_path.open("w") as f:
             f.write(new_markdown_text)
     return Exit.OK
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     sys.exit(main())