Merge branch 'main' into required-nullable-annotated

Author: koxudaxi

.github/workflows/test.yaml

@@ -16,7 +16,7 @@ concurrency:
 jobs:
   test:
     name: >-
-      ${{ matrix.py || matrix.tox_env }} on
+      ${{ matrix.py || matrix.name }} on
       ${{ matrix.os == 'windows-latest' && 'Windows' || (matrix.os == 'macos-latest' && 'macOS' || 'Ubuntu') }}
     strategy:
       fail-fast: false
@@ -25,13 +25,20 @@ jobs:
         os: [ubuntu-24.04, windows-latest, macos-latest]
         tox_env: ['']
         include:
-          - tox_env: py3.12-black24
-          - tox_env: py3.12-black23
-          - tox_env: py3.12-black22
-          - tox_env: py3.12-isort7
-          - tox_env: py3.12-isort6
-          - tox_env: py3.12-isort5
-          - tox_env: py3.12-pydantic1
+          - tox_env: py3.12-black24-parallel
+            name: py3.12-black24
+          - tox_env: py3.12-black23-parallel
+            name: py3.12-black23
+          - tox_env: py3.12-black22-parallel
+            name: py3.12-black22
+          - tox_env: py3.12-isort7-parallel
+            name: py3.12-isort7
+          - tox_env: py3.12-isort6-parallel
+            name: py3.12-isort6
+          - tox_env: py3.12-isort5-parallel
+            name: py3.12-isort5
+          - tox_env: py3.12-pydantic1-parallel
+            name: py3.12-pydantic1
     runs-on: ${{ matrix.os == '' && 'ubuntu-24.04' || matrix.os }}
     env:
       OS: ${{ matrix.os == '' && 'ubuntu-24.04' || matrix.os}}
@@ -47,17 +54,19 @@ jobs:
     - name: Install tox
       run: uv tool install --python-preference only-managed --python 3.13 tox --with tox-uv
     - name: Setup Python test environment
-      run: tox run -vv --notest --skip-missing-interpreters false -e ${{ matrix.py || matrix.tox_env }}
+      run: tox run -vv --notest --skip-missing-interpreters false -e ${{ matrix.py && format('{0}-parallel', matrix.py) || matrix.tox_env }}
       env:
         UV_PYTHON_PREFERENCE: "only-managed"
     - name: Run test suite
-      run: tox run --skip-uv-sync --skip-pkg-install -e ${{ matrix.py || matrix.tox_env }}
+      run: tox run --skip-uv-sync --skip-pkg-install -e ${{ matrix.py && format('{0}-parallel', matrix.py) || matrix.tox_env }}
       env:
         UV_PYTHON_PREFERENCE: "only-managed"
     - name: Rename coverage report file
       run: |
         import os; import sys
-        os.rename(f".tox/.coverage.${{ matrix.py || matrix.tox_env }}", f".tox/.coverage.${{ matrix.py || matrix.tox_env}}-${{ matrix.os }}")
+        env_name = "${{ matrix.py && format('{0}-parallel', matrix.py) || matrix.tox_env }}"
+        base_name = "${{ matrix.py || matrix.tox_env }}"
+        os.rename(f".tox/.coverage.{env_name}", f".tox/.coverage.{base_name}-${{ matrix.os }}")
       shell: python
     - name: Upload coverage data
       uses: actions/upload-artifact@v4

README.md

@@ -431,6 +431,8 @@ Field customization:
   --strip-default-none  Strip default None on fields
   --union-mode {smart,left_to_right}
                         Union mode for only pydantic v2 field
+  --use-attribute-docstrings
+                        Set use_attribute_docstrings=True in Pydantic v2 ConfigDict
   --use-default         Use default value even if a field is required
   --use-default-kwarg   Use `default=` instead of a positional argument for Fields that have
                         default values.

docs/index.md

@@ -423,6 +423,8 @@ Field customization:
   --strip-default-none  Strip default None on fields
   --union-mode {smart,left_to_right}
                         Union mode for only pydantic v2 field
+  --use-attribute-docstrings
+                        Set use_attribute_docstrings=True in Pydantic v2 ConfigDict
   --use-default         Use default value even if a field is required
   --use-default-kwarg   Use `default=` instead of a positional argument for Fields that have
                         default values.

src/datamodel_code_generator/__init__.py

@@ -302,6 +302,7 @@ def generate(  # noqa: PLR0912, PLR0913, PLR0914, PLR0915
     use_standard_collections: bool = False,
     use_schema_description: bool = False,
     use_field_description: bool = False,
+    use_attribute_docstrings: bool = False,
     use_inline_field_description: bool = False,
     use_default_kwarg: bool = False,
     reuse_model: bool = False,
@@ -531,6 +532,7 @@ def get_header_and_first_line(csv_file: IO[str]) -> dict[str, Any]:
         base_path=input_.parent if isinstance(input_, Path) and input_.is_file() else None,
         use_schema_description=use_schema_description,
         use_field_description=use_field_description,
+        use_attribute_docstrings=use_attribute_docstrings,
         use_inline_field_description=use_inline_field_description,
         use_default_kwarg=use_default_kwarg,
         reuse_model=reuse_model,

src/datamodel_code_generator/__main__.py

@@ -353,6 +353,7 @@ def validate_root(cls, values: dict[str, Any]) -> dict[str, Any]:  # noqa: N805
     use_standard_collections: bool = False
     use_schema_description: bool = False
     use_field_description: bool = False
+    use_attribute_docstrings: bool = False
     use_inline_field_description: bool = False
     use_default_kwarg: bool = False
     reuse_model: bool = False
@@ -610,6 +611,7 @@ def main(args: Sequence[str] | None = None) -> Exit:  # noqa: PLR0911, PLR0912,
             use_standard_collections=config.use_standard_collections,
             use_schema_description=config.use_schema_description,
             use_field_description=config.use_field_description,
+            use_attribute_docstrings=config.use_attribute_docstrings,
             use_inline_field_description=config.use_inline_field_description,
             use_default_kwarg=config.use_default_kwarg,
             reuse_model=config.reuse_model,

src/datamodel_code_generator/arguments.py

@@ -465,6 +465,12 @@ def start_section(self, heading: str | None) -> None:
     action="store_true",
     default=None,
 )
+field_options.add_argument(
+    "--use-attribute-docstrings",
+    help="Set use_attribute_docstrings=True in Pydantic v2 ConfigDict",
+    action="store_true",
+    default=None,
+)
 field_options.add_argument(
     "--use-inline-field-description",
     help="Use schema description to populate field docstring as inline docstring",

src/datamodel_code_generator/model/pydantic_v2/__init__.py

@@ -38,6 +38,7 @@ class ConfigDict(_BaseModel):
     regex_engine: Optional[str] = None  # noqa: UP045
     use_enum_values: Optional[bool] = None  # noqa: UP045
     coerce_numbers_to_str: Optional[bool] = None  # noqa: UP045
+    use_attribute_docstrings: Optional[bool] = None  # noqa: UP045
 
 
 __all__ = [

src/datamodel_code_generator/model/pydantic_v2/base_model.py

@@ -181,6 +181,7 @@ class BaseModel(BaseModelBase):
         ConfigAttribute("populate_by_name", "populate_by_name", False),  # noqa: FBT003
         ConfigAttribute("allow_mutation", "frozen", True),  # noqa: FBT003
         ConfigAttribute("frozen", "frozen", False),  # noqa: FBT003
+        ConfigAttribute("use_attribute_docstrings", "use_attribute_docstrings", False),  # noqa: FBT003
     ]
 
     def __init__(  # noqa: PLR0913

src/datamodel_code_generator/parser/base.py

@@ -401,6 +401,7 @@ def __init__(  # noqa: PLR0913, PLR0915
         base_path: Path | None = None,
         use_schema_description: bool = False,
         use_field_description: bool = False,
+        use_attribute_docstrings: bool = False,
         use_inline_field_description: bool = False,
         use_default_kwarg: bool = False,
         reuse_model: bool = False,
@@ -537,6 +538,9 @@ def __init__(  # noqa: PLR0913, PLR0915
         if enable_faux_immutability:
             self.extra_template_data[ALL_MODEL]["allow_mutation"] = False
 
+        if use_attribute_docstrings:
+            self.extra_template_data[ALL_MODEL]["use_attribute_docstrings"] = True
+
         self.model_resolver = ModelResolver(
             base_url=source.geturl() if isinstance(source, ParseResult) else None,
             singular_name_suffix="" if disable_appending_item_suffix else None,

src/datamodel_code_generator/parser/graphql.py

@@ -122,6 +122,7 @@ def __init__(  # noqa: PLR0913
         base_path: Path | None = None,
         use_schema_description: bool = False,
         use_field_description: bool = False,
+        use_attribute_docstrings: bool = False,
         use_inline_field_description: bool = False,
         use_default_kwarg: bool = False,
         reuse_model: bool = False,
@@ -205,6 +206,7 @@ def __init__(  # noqa: PLR0913
             base_path=base_path,
             use_schema_description=use_schema_description,
             use_field_description=use_field_description,
+            use_attribute_docstrings=use_attribute_docstrings,
             use_inline_field_description=use_inline_field_description,
             use_default_kwarg=use_default_kwarg,
             reuse_model=reuse_model,