datamodel-code-generator 0.28.3__tar.gz → 0.28.4__tar.gz

{datamodel_code_generator-0.28.3 → datamodel_code_generator-0.28.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: datamodel-code-generator
-Version: 0.28.3
+Version: 0.28.4
 Summary: Datamodel Code Generator
 Project-URL: Homepage, https://github.com/koxudaxi/datamodel-code-generator
 Project-URL: Source, https://github.com/koxudaxi/datamodel-code-generator
@@ -34,12 +34,15 @@ Requires-Dist: httpx>=0.24.1; extra == 'all'
 Requires-Dist: openapi-spec-validator<0.7,>=0.2.8; extra == 'all'
 Requires-Dist: prance>=0.18.2; extra == 'all'
 Requires-Dist: pysnooper<2,>=0.4.1; extra == 'all'
+Requires-Dist: ruff>=0.9.10; extra == 'all'
 Provides-Extra: debug
 Requires-Dist: pysnooper<2,>=0.4.1; extra == 'debug'
 Provides-Extra: graphql
 Requires-Dist: graphql-core>=3.2.3; extra == 'graphql'
 Provides-Extra: http
 Requires-Dist: httpx>=0.24.1; extra == 'http'
+Provides-Extra: ruff
+Requires-Dist: ruff>=0.9.10; extra == 'ruff'
 Provides-Extra: validation
 Requires-Dist: openapi-spec-validator<0.7,>=0.2.8; extra == 'validation'
 Requires-Dist: prance>=0.18.2; extra == 'validation'
@@ -403,6 +406,8 @@ Options:
                         "datetime.date,datetime.datetime"
   --custom-formatters CUSTOM_FORMATTERS
                         List of modules with custom formatter (delimited list input).
+  --formatters {black,isort,ruff-check,ruff-format} [{black,isort,ruff-check,ruff-format} ...]
+                        Formatters for output (default: [black, isort])
   --http-headers HTTP_HEADER [HTTP_HEADER ...]
                         Set headers in HTTP requests to the remote host. (example:
                         "Authorization: Basic dXNlcjpwYXNz")

{datamodel_code_generator-0.28.3 → datamodel_code_generator-0.28.4}/README.md

@@ -356,6 +356,8 @@ Options:
                         "datetime.date,datetime.datetime"
   --custom-formatters CUSTOM_FORMATTERS
                         List of modules with custom formatter (delimited list input).
+  --formatters {black,isort,ruff-check,ruff-format} [{black,isort,ruff-check,ruff-format} ...]
+                        Formatters for output (default: [black, isort])
   --http-headers HTTP_HEADER [HTTP_HEADER ...]
                         Set headers in HTTP requests to the remote host. (example:
                         "Authorization: Basic dXNlcjpwYXNz")

{datamodel_code_generator-0.28.3 → datamodel_code_generator-0.28.4}/pyproject.toml

@@ -44,6 +44,7 @@ optional-dependencies.all = [
   "datamodel-code-generator[debug]",
   "datamodel-code-generator[graphql]",
   "datamodel-code-generator[http]",
+  "datamodel-code-generator[ruff]",
   "datamodel-code-generator[validation]",
 ]
 optional-dependencies.debug = [
@@ -55,6 +56,9 @@ optional-dependencies.graphql = [
 optional-dependencies.http = [
   "httpx>=0.24.1",
 ]
+optional-dependencies.ruff = [
+  "ruff>=0.9.10",
+]
 optional-dependencies.validation = [
   "openapi-spec-validator>=0.2.8,<0.7",
   "prance>=0.18.2",

{datamodel_code_generator-0.28.3 → datamodel_code_generator-0.28.4}/src/datamodel_code_generator/__init__.py

@@ -22,7 +22,13 @@ from urllib.parse import ParseResult
 import yaml
 
 import datamodel_code_generator.pydantic_patch  # noqa: F401
-from datamodel_code_generator.format import DatetimeClassType, PythonVersion, PythonVersionMin
+from datamodel_code_generator.format import (
+    DEFAULT_FORMATTERS,
+    DatetimeClassType,
+    Formatter,
+    PythonVersion,
+    PythonVersionMin,
+)
 from datamodel_code_generator.parser import DefaultPutDict, LiteralType
 from datamodel_code_generator.util import SafeLoader
 
@@ -280,6 +286,7 @@ def generate(  # noqa: PLR0912, PLR0913, PLR0914, PLR0915
     output_datetime_class: DatetimeClassType | None = None,
     keyword_only: bool = False,
     no_alias: bool = False,
+    formatters: list[Formatter] = DEFAULT_FORMATTERS,
 ) -> None:
     remote_text_cache: DefaultPutDict[str, str] = DefaultPutDict()
     if isinstance(input_, str):
@@ -474,6 +481,7 @@ def generate(  # noqa: PLR0912, PLR0913, PLR0914, PLR0915
         target_datetime_class=output_datetime_class,
         keyword_only=keyword_only,
         no_alias=no_alias,
+        formatters=formatters,
         **kwargs,
     )
 

{datamodel_code_generator-0.28.3 → datamodel_code_generator-0.28.4}/src/datamodel_code_generator/__main__.py

@@ -36,7 +36,9 @@ from datamodel_code_generator import (
 )
 from datamodel_code_generator.arguments import DEFAULT_ENCODING, arg_parser, namespace
 from datamodel_code_generator.format import (
+    DEFAULT_FORMATTERS,
     DatetimeClassType,
+    Formatter,
     PythonVersion,
     PythonVersionMin,
     is_supported_in_black,
@@ -311,6 +313,7 @@ class Config(BaseModel):
     output_datetime_class: Optional[DatetimeClassType] = None  # noqa: UP045
     keyword_only: bool = False
     no_alias: bool = False
+    formatters: list[Formatter] = DEFAULT_FORMATTERS
 
     def merge_args(self, args: Namespace) -> None:
         set_args = {f: getattr(args, f) for f in self.get_fields() if getattr(args, f) is not None}
@@ -519,6 +522,7 @@ def main(args: Sequence[str] | None = None) -> Exit:  # noqa: PLR0911, PLR0912,
             output_datetime_class=config.output_datetime_class,
             keyword_only=config.keyword_only,
             no_alias=config.no_alias,
+            formatters=config.formatters,
         )
     except InvalidClassNameError as e:
         print(f"{e} You have to set `--class-name` option", file=sys.stderr)  # noqa: T201

{datamodel_code_generator-0.28.3 → datamodel_code_generator-0.28.4}/src/datamodel_code_generator/arguments.py

@@ -6,7 +6,7 @@ from operator import attrgetter
 from typing import TYPE_CHECKING
 
 from datamodel_code_generator import DataModelType, InputFileType, OpenAPIScope
-from datamodel_code_generator.format import DatetimeClassType, PythonVersion
+from datamodel_code_generator.format import DatetimeClassType, Formatter, PythonVersion
 from datamodel_code_generator.model.pydantic_v2 import UnionMode
 from datamodel_code_generator.parser import LiteralType
 from datamodel_code_generator.types import StrictTypes
@@ -440,6 +440,13 @@ base_options.add_argument(
     type=str,
     default=None,
 )
+base_options.add_argument(
+    "--formatters",
+    help="Formatters for output (default: [black, isort])",
+    choices=[f.value for f in Formatter],
+    nargs="+",
+    default=None,
+)
 base_options.add_argument(
     "--custom-formatters",
     help="List of modules with custom formatter (delimited list input).",

{datamodel_code_generator-0.28.3 → datamodel_code_generator-0.28.4}/src/datamodel_code_generator/format.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import subprocess  # noqa: S404
 from enum import Enum
 from functools import cached_property
 from importlib import import_module
@@ -89,6 +90,16 @@ def black_find_project_root(sources: Sequence[Path]) -> Path:
     return project_root
 
 
+class Formatter(Enum):
+    BLACK = "black"
+    ISORT = "isort"
+    RUFF_CHECK = "ruff-check"
+    RUFF_FORMAT = "ruff-format"
+
+
+DEFAULT_FORMATTERS = [Formatter.BLACK, Formatter.ISORT]
+
+
 class CodeFormatter:
     def __init__(  # noqa: PLR0912, PLR0913, PLR0917
         self,
@@ -99,6 +110,8 @@ class CodeFormatter:
         known_third_party: list[str] | None = None,
         custom_formatters: list[str] | None = None,
         custom_formatters_kwargs: dict[str, Any] | None = None,
+        encoding: str = "utf-8",
+        formatters: list[Formatter] = DEFAULT_FORMATTERS,
     ) -> None:
         if not settings_path:
             settings_path = Path.cwd()
@@ -158,6 +171,8 @@ class CodeFormatter:
 
         self.custom_formatters_kwargs = custom_formatters_kwargs or {}
         self.custom_formatters = self._check_custom_formatters(custom_formatters)
+        self.encoding = encoding
+        self.formatters = formatters
 
     def _load_custom_formatter(self, custom_formatter_import: str) -> CustomCodeFormatter:
         import_ = import_module(custom_formatter_import)
@@ -184,8 +199,16 @@ class CodeFormatter:
         self,
         code: str,
     ) -> str:
-        code = self.apply_isort(code)
-        code = self.apply_black(code)
+        if Formatter.ISORT in self.formatters:
+            code = self.apply_isort(code)
+        if Formatter.BLACK in self.formatters:
+            code = self.apply_black(code)
+
+        if Formatter.RUFF_CHECK in self.formatters:
+            code = self.apply_ruff_lint(code)
+
+        if Formatter.RUFF_FORMAT in self.formatters:
+            code = self.apply_ruff_formatter(code)
 
         for formatter in self.custom_formatters:
             code = formatter.apply(code)
@@ -198,6 +221,24 @@ class CodeFormatter:
             mode=self.black_mode,
         )
 
+    def apply_ruff_lint(self, code: str) -> str:
+        result = subprocess.run(  # noqa: S603
+            ("ruff", "check", "--fix", "-"),
+            input=code.encode(self.encoding),
+            capture_output=True,
+            check=False,
+        )
+        return result.stdout.decode(self.encoding)
+
+    def apply_ruff_formatter(self, code: str) -> str:
+        result = subprocess.run(  # noqa: S603
+            ("ruff", "format", "-"),
+            input=code.encode(self.encoding),
+            capture_output=True,
+            check=False,
+        )
+        return result.stdout.decode(self.encoding)
+
     if TYPE_CHECKING:
 
         def apply_isort(self, code: str) -> str: ...

{datamodel_code_generator-0.28.3 → datamodel_code_generator-0.28.4}/src/datamodel_code_generator/parser/base.py

@@ -12,7 +12,14 @@ from urllib.parse import ParseResult
 
 from pydantic import BaseModel
 
-from datamodel_code_generator.format import CodeFormatter, DatetimeClassType, PythonVersion, PythonVersionMin
+from datamodel_code_generator.format import (
+    DEFAULT_FORMATTERS,
+    CodeFormatter,
+    DatetimeClassType,
+    Formatter,
+    PythonVersion,
+    PythonVersionMin,
+)
 from datamodel_code_generator.imports import (
     IMPORT_ANNOTATIONS,
     IMPORT_LITERAL,
@@ -369,6 +376,7 @@ class Parser(ABC):
         target_datetime_class: DatetimeClassType | None = DatetimeClassType.Datetime,
         keyword_only: bool = False,
         no_alias: bool = False,
+        formatters: list[Formatter] = DEFAULT_FORMATTERS,
     ) -> None:
         self.keyword_only = keyword_only
         self.data_type_manager: DataTypeManager = data_type_manager_type(
@@ -476,6 +484,7 @@ class Parser(ABC):
         self.custom_formatters_kwargs = custom_formatters_kwargs
         self.treat_dots_as_module = treat_dots_as_module
         self.default_field_extras: dict[str, Any] | None = default_field_extras
+        self.formatters: list[Formatter] = formatters
 
     @property
     def iter_source(self) -> Iterator[Source]:
@@ -1173,6 +1182,8 @@ class Parser(ABC):
                 known_third_party=self.known_third_party,
                 custom_formatters=self.custom_formatter,
                 custom_formatters_kwargs=self.custom_formatters_kwargs,
+                encoding=self.encoding,
+                formatters=self.formatters,
             )
         else:
             code_formatter = None

{datamodel_code_generator-0.28.3 → datamodel_code_generator-0.28.4}/src/datamodel_code_generator/parser/graphql.py

@@ -36,7 +36,7 @@ except ImportError as exc:  # pragma: no cover
     raise Exception(msg) from exc  # noqa: TRY002
 
 
-from datamodel_code_generator.format import DatetimeClassType
+from datamodel_code_generator.format import DEFAULT_FORMATTERS, DatetimeClassType, Formatter
 
 if TYPE_CHECKING:
     from collections import defaultdict
@@ -153,6 +153,7 @@ class GraphQLParser(Parser):
         target_datetime_class: DatetimeClassType = DatetimeClassType.Datetime,
         keyword_only: bool = False,
         no_alias: bool = False,
+        formatters: list[Formatter] = DEFAULT_FORMATTERS,
     ) -> None:
         super().__init__(
             source=source,
@@ -226,6 +227,7 @@ class GraphQLParser(Parser):
             target_datetime_class=target_datetime_class,
             keyword_only=keyword_only,
             no_alias=no_alias,
+            formatters=formatters,
         )
 
         self.data_model_scalar_type = data_model_scalar_type

{datamodel_code_generator-0.28.3 → datamodel_code_generator-0.28.4}/src/datamodel_code_generator/parser/jsonschema.py

@@ -19,7 +19,7 @@ from datamodel_code_generator import (
     load_yaml_from_path,
     snooper_to_methods,
 )
-from datamodel_code_generator.format import PythonVersion, PythonVersionMin
+from datamodel_code_generator.format import DEFAULT_FORMATTERS, Formatter, PythonVersion, PythonVersionMin
 from datamodel_code_generator.model import DataModel, DataModelFieldBase
 from datamodel_code_generator.model import pydantic as pydantic_model
 from datamodel_code_generator.model.base import UNDEFINED, get_module_name
@@ -422,6 +422,7 @@ class JsonSchemaParser(Parser):
         target_datetime_class: DatetimeClassType = DatetimeClassType.Datetime,
         keyword_only: bool = False,
         no_alias: bool = False,
+        formatters: list[Formatter] = DEFAULT_FORMATTERS,
     ) -> None:
         super().__init__(
             source=source,
@@ -495,6 +496,7 @@ class JsonSchemaParser(Parser):
             target_datetime_class=target_datetime_class,
             keyword_only=keyword_only,
             no_alias=no_alias,
+            formatters=formatters,
         )
 
         self.remote_object_cache: DefaultPutDict[str, dict[str, Any]] = DefaultPutDict()

{datamodel_code_generator-0.28.3 → datamodel_code_generator-0.28.4}/src/datamodel_code_generator/parser/openapi.py

@@ -18,7 +18,7 @@ from datamodel_code_generator import (
     load_yaml,
     snooper_to_methods,
 )
-from datamodel_code_generator.format import DatetimeClassType
+from datamodel_code_generator.format import DEFAULT_FORMATTERS, DatetimeClassType, Formatter
 from datamodel_code_generator.model import DataModel, DataModelFieldBase
 from datamodel_code_generator.model import pydantic as pydantic_model
 from datamodel_code_generator.parser import DefaultPutDict  # noqa: TC001 # needed for type check
@@ -215,6 +215,7 @@ class OpenAPIParser(JsonSchemaParser):
         target_datetime_class: DatetimeClassType = DatetimeClassType.Datetime,
         keyword_only: bool = False,
         no_alias: bool = False,
+        formatters: list[Formatter] = DEFAULT_FORMATTERS,
     ) -> None:
         super().__init__(
             source=source,
@@ -288,6 +289,7 @@ class OpenAPIParser(JsonSchemaParser):
             target_datetime_class=target_datetime_class,
             keyword_only=keyword_only,
             no_alias=no_alias,
+            formatters=formatters,
         )
         self.open_api_scopes: list[OpenAPIScope] = openapi_scopes or [OpenAPIScope.Schemas]
 

{datamodel_code_generator-0.28.3 → datamodel_code_generator-0.28.4}/tests/test_format.py

@@ -2,10 +2,11 @@ from __future__ import annotations
 
 import sys
 from pathlib import Path
+from unittest import mock
 
 import pytest
 
-from datamodel_code_generator.format import CodeFormatter, PythonVersion, PythonVersionMin
+from datamodel_code_generator.format import CodeFormatter, Formatter, PythonVersion, PythonVersionMin
 
 EXAMPLE_LICENSE_FILE = str(Path(__file__).parent / "data/python/custom_formatters/license_example.txt")
 
@@ -125,3 +126,29 @@ x = 1
 y = 2
 """
     )
+
+
+def test_format_code_ruff_format_formatter() -> None:
+    formatter = CodeFormatter(
+        PythonVersionMin,
+        formatters=[Formatter.RUFF_FORMAT],
+    )
+    with mock.patch("subprocess.run") as mock_run:
+        mock_run.return_value.stdout = b"output"
+        formatted_code = formatter.format_code("input")
+
+    assert formatted_code == "output"
+    mock_run.assert_called_once_with(("ruff", "format", "-"), input=b"input", capture_output=True, check=False)
+
+
+def test_format_code_ruff_check_formatter() -> None:
+    formatter = CodeFormatter(
+        PythonVersionMin,
+        formatters=[Formatter.RUFF_CHECK],
+    )
+    with mock.patch("subprocess.run") as mock_run:
+        mock_run.return_value.stdout = b"output"
+        formatted_code = formatter.format_code("input")
+
+    assert formatted_code == "output"
+    mock_run.assert_called_once_with(("ruff", "check", "--fix", "-"), input=b"input", capture_output=True, check=False)