chore: use @generated as defined at https://generated.at

Add the marker to "generated" at the file header to make it easier for tooling to identify generated files as such. Closes: koxudaxi#1604 Signed-off-by: Patrick Jungermann <[email protected]>
pjungermann · Dec 11, 2023 · 5adcf59 · 5adcf59
1 parent ef15441
commit 5adcf59
Show file tree

Hide file tree

Showing 384 changed files with 386 additions and 386 deletions.
diff --git a/README.md b/README.md
@@ -190,7 +190,7 @@ components:
 <summary>model.py</summary>
 
 ```python
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: api.yaml
 # timestamp: 2020-06-02T05:28:24+00:00
 

diff --git a/datamodel_code_generator/__init__.py b/datamodel_code_generator/__init__.py
@@ -491,7 +491,7 @@ def get_header_and_first_line(csv_file: IO[str]) -> Dict[str, Any]:
  custom_file_header = custom_file_header_path.read_text(encoding=encoding)
 
  header = """\
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: {}"""
  if not disable_timestamp:
  header += f'\n# timestamp: {timestamp}'

diff --git a/docs/custom_template.md b/docs/custom_template.md
@@ -38,7 +38,7 @@ The generated `person.py` file will now include your custom comment at the top:
 
 **person.py**
 ```python
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: person.json
 # timestamp: 2023-04-09T05:36:24+00:00
 

diff --git a/docs/field-constraints.md b/docs/field-constraints.md
@@ -36,7 +36,7 @@ Generated Model
 
 `model.py` 
 ```py
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: model.json
 # timestamp: 2020-07-20T15:37:56+00:00
 
@@ -70,7 +70,7 @@ Generated Model
 
 `model.py` 
 ```py
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: model.json
 # timestamp: 2020-07-20T15:47:21+00:00
 

diff --git a/docs/graphql.md b/docs/graphql.md
@@ -41,7 +41,7 @@ type Query {
 
 **model.py**
 ```python
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: schema.graphql
 # timestamp: 2023-11-20T17:04:42+00:00
 
@@ -161,7 +161,7 @@ type A {
 
 **model.py**
 ```python
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: custom-scalar-types.graphql
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/docs/index.md b/docs/index.md
@@ -186,7 +186,7 @@ components:
 <summary>model.py</summary>
 
 ```py
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: api.yaml
 # timestamp: 2020-06-02T05:28:24+00:00
 

diff --git a/docs/jsondata.md b/docs/jsondata.md
@@ -33,7 +33,7 @@ $ datamodel-codegen --input pets.json --input-file-type json --output model.py
 
 **model.py**
 ```py
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: pets.json
 # timestamp: 2020-04-27T16:08:21+00:00
 

diff --git a/docs/jsonschema.md b/docs/jsonschema.md
@@ -41,7 +41,7 @@ $ datamodel-codegen --input person.json --input-file-type jsonschema --output m
 
 **model.py**
 ```py
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: person.json
 # timestamp: 2020-04-27T16:12:27+00:00
 

diff --git a/docs/openapi.md b/docs/openapi.md
@@ -166,7 +166,7 @@ components:
 
 **model.py**
 ```py
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: api.yaml
 # timestamp: 2020-06-02T05:28:24+00:00
 

diff --git a/docs/using_as_module.md b/docs/using_as_module.md
@@ -50,7 +50,7 @@ print(model)
 
 The result of `print(model)`:
 ```python
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: example.json
 # timestamp: 2020-12-21T08:01:06+00:00
 

diff --git a/tests/data/expected/main/all_of_ref/output.py b/tests/data/expected/main/all_of_ref/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: test.json
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/all_of_with_object/output.py b/tests/data/expected/main/all_of_with_object/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: all_of_with_object.json
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/allow_extra_fields/output.py b/tests/data/expected/main/allow_extra_fields/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: api.yaml
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/allow_extra_fields_pydantic_v2/output.py b/tests/data/expected/main/allow_extra_fields_pydantic_v2/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: api.yaml
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/allow_population_by_field_name/output.py b/tests/data/expected/main/allow_population_by_field_name/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: api.yaml
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/allow_population_by_field_name_pydantic_v2/output.py b/tests/data/expected/main/allow_population_by_field_name_pydantic_v2/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: api.yaml
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/combined_array/output.py b/tests/data/expected/main/combined_array/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: combined_array.json
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/csv_file_simple/output.py b/tests/data/expected/main/csv_file_simple/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: simple.csv
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/csv_stdin_simple/output.py b/tests/data/expected/main/csv_stdin_simple/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: <stdin>
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/disable_timestamp/output.py b/tests/data/expected/main/disable_timestamp/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: api.yaml
 
 from __future__ import annotations

diff --git a/tests/data/expected/main/duplicate_field_constraints/common.py b/tests/data/expected/main/duplicate_field_constraints/common.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: common.yml
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/duplicate_field_constraints/test.py b/tests/data/expected/main/duplicate_field_constraints/test.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: test.yml
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/duplicate_field_constraints_msgspec/common.py b/tests/data/expected/main/duplicate_field_constraints_msgspec/common.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: common.yml
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/duplicate_field_constraints_msgspec/test.py b/tests/data/expected/main/duplicate_field_constraints_msgspec/test.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: test.yml
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/...ata/expected/main/duplicate_field_constraints_msgspec_py38_collapse_root_models/common.py b/...ata/expected/main/duplicate_field_constraints_msgspec_py38_collapse_root_models/common.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: common.yml
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/.../data/expected/main/duplicate_field_constraints_msgspec_py38_collapse_root_models/test.py b/.../data/expected/main/duplicate_field_constraints_msgspec_py38_collapse_root_models/test.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: test.yml
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/enable_faux_immutability/output.py b/tests/data/expected/main/enable_faux_immutability/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: api.yaml
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/enable_faux_immutability_pydantic_v2/output.py b/tests/data/expected/main/enable_faux_immutability_pydantic_v2/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: api.yaml
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/enable_version_header/output.py b/tests/data/expected/main/enable_version_header/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: api.yaml
 # timestamp: 2019-07-26T00:00:00+00:00
 # version: 0.0.0

diff --git a/tests/data/expected/main/external_relative_ref/module.openapi/__init__.py b/tests/data/expected/main/external_relative_ref/module.openapi/__init__.py
@@ -1,3 +1,3 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: model_b
 # timestamp: 2019-07-26T00:00:00+00:00
diff --git a/tests/data/expected/main/external_relative_ref/module.openapi/model_a.py b/tests/data/expected/main/external_relative_ref/module.openapi/model_a.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: module.openapi.yaml
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/external_relative_ref/module.openapi/modules/__init__.py b/tests/data/expected/main/external_relative_ref/module.openapi/modules/__init__.py
@@ -1,3 +1,3 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: model_b
 # timestamp: 2019-07-26T00:00:00+00:00
diff --git a/tests/data/expected/main/external_relative_ref/module.openapi/modules/quality_evaluation.py b/tests/data/expected/main/external_relative_ref/module.openapi/modules/quality_evaluation.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: module.openapi.yaml
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/force_optional/output.py b/tests/data/expected/main/force_optional/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: api.yaml
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/has_default_value/output.py b/tests/data/expected/main/has_default_value/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: has_default_value.json
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/main/output.py b/tests/data/expected/main/main/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: api.yaml
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/main_all_of_any_of/__init__.py b/tests/data/expected/main/main_all_of_any_of/__init__.py
@@ -1,3 +1,3 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: all_of_any_of
 # timestamp: 2019-07-26T00:00:00+00:00
diff --git a/tests/data/expected/main/main_all_of_any_of/direct.py b/tests/data/expected/main/main_all_of_any_of/direct.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: direct.json
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/main_all_of_any_of/reference.py b/tests/data/expected/main/main_all_of_any_of/reference.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: reference.json
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/main_all_of_one_of/__init__.py b/tests/data/expected/main/main_all_of_one_of/__init__.py
@@ -1,3 +1,3 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: all_of_one_of
 # timestamp: 2019-07-26T00:00:00+00:00
diff --git a/tests/data/expected/main/main_all_of_one_of/direct.py b/tests/data/expected/main/main_all_of_one_of/direct.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: direct.json
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/main_all_of_one_of/reference.py b/tests/data/expected/main/main_all_of_one_of/reference.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: reference.json
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/main_all_of_ref_self/output.py b/tests/data/expected/main/main_all_of_ref_self/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: all_of_ref_self.json
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/main_all_of_use_default/output.py b/tests/data/expected/main/main_all_of_use_default/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: all_of_default.json
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/main_all_of_with_relative_ref/output.py b/tests/data/expected/main/main_all_of_with_relative_ref/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: openapi.yaml
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/main_array_field_constraints/output.py b/tests/data/expected/main/main_array_field_constraints/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: array_field_constraints.json
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/main_autodetect/output.py b/tests/data/expected/main/main_autodetect/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: person.json
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/main_base_class/output.py b/tests/data/expected/main/main_base_class/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: api.yaml
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/main_circular_reference/output.py b/tests/data/expected/main/main_circular_reference/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: circular_reference.json
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/main_collapse_root_models/output.py b/tests/data/expected/main/main_collapse_root_models/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: not_real_string.json
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/main_collapse_root_models_field_constraints/output.py b/tests/data/expected/main/main_collapse_root_models_field_constraints/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: not_real_string.json
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/main_collapse_root_models_with_references_to_flat_types/output.py b/tests/data/expected/main/main_collapse_root_models_with_references_to_flat_types/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: flat_type.jsonschema
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/main_complicated_enum_default_member/output.py b/tests/data/expected/main/main_complicated_enum_default_member/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: complicated_enum.json
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/main_complicated_enum_default_member_dataclass/output.py b/tests/data/expected/main/main_complicated_enum_default_member_dataclass/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: complicated_enum.json
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/main_custom_template_dir/output.py b/tests/data/expected/main/main_custom_template_dir/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: api.yaml
 # timestamp: 1985-10-26T08:21:00+00:00
 

diff --git a/tests/data/expected/main/main_dataclass/output.py b/tests/data/expected/main/main_dataclass/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: api.yaml
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/main_dataclass_base_class/output.py b/tests/data/expected/main/main_dataclass_base_class/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: api.yaml
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/main_dataclass_field/output.py b/tests/data/expected/main/main_dataclass_field/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: user.json
 # timestamp: 2019-07-26T00:00:00+00:00
 

diff --git a/tests/data/expected/main/main_dataclass_field_default/output.py b/tests/data/expected/main/main_dataclass_field_default/output.py
@@ -1,4 +1,4 @@
-# generated by datamodel-codegen:
+# @generated by datamodel-codegen:
 # filename: user_default.json
 # timestamp: 2019-07-26T00:00:00+00:00