Skip to content

Commit aac3ca1

Browse files
committed
style: Reformat model docstrings a bit and use Attributes instead of Properties (per Sphinx guide)
1 parent 3799213 commit aac3ca1

32 files changed

+116
-224
lines changed

end_to_end_tests/golden-record/my_test_api_client/models/a_form_data.py

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,9 @@
1010
@attr.s(auto_attribs=True)
1111
class AFormData:
1212
"""
13-
14-
15-
Properties:
13+
Attributes:
1614
an_required_field (str):
1715
an_optional_field (Union[Unset, str]):
18-
1916
"""
2017

2118
an_required_field: str

end_to_end_tests/golden-record/my_test_api_client/models/a_model.py

Lines changed: 25 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -16,39 +16,31 @@
1616

1717
@attr.s(auto_attribs=True)
1818
class AModel:
19-
"""
20-
A Model for testing all the ways custom objects can be used
21-
22-
Properties:
23-
an_enum_value (AnEnum): For testing Enums in all the ways they can be
24-
used
25-
an_allof_enum_with_overridden_default (AnAllOfEnum): Default:
26-
AnAllOfEnum.OVERRIDDEN_DEFAULT.
27-
a_camel_date_time (Union[datetime.date, datetime.datetime]):
28-
a_date (datetime.date):
29-
required_not_nullable (str):
30-
one_of_models (Union[Any, FreeFormModel, ModelWithUnionProperty]):
31-
model (ModelWithUnionProperty):
32-
any_value (Union[Unset, Any]):
33-
an_optional_allof_enum (Union[Unset, AnAllOfEnum]):
34-
nested_list_of_enums (Union[Unset, List[List[DifferentEnum]]]):
35-
a_nullable_date (Optional[datetime.date]):
36-
a_not_required_date (Union[Unset, datetime.date]):
37-
attr_1_leading_digit (Union[Unset, str]):
38-
required_nullable (Optional[str]):
39-
not_required_nullable (Union[Unset, None, str]):
40-
not_required_not_nullable (Union[Unset, str]):
41-
nullable_one_of_models (Union[FreeFormModel, ModelWithUnionProperty,
42-
None]):
43-
not_required_one_of_models (Union[FreeFormModel, ModelWithUnionProperty,
44-
Unset]):
45-
not_required_nullable_one_of_models (Union[FreeFormModel,
46-
ModelWithUnionProperty, None, Unset, str]):
47-
nullable_model (Optional[ModelWithUnionProperty]):
48-
not_required_model (Union[Unset, ModelWithUnionProperty]):
49-
not_required_nullable_model (Union[Unset, None,
50-
ModelWithUnionProperty]):
51-
19+
"""A Model for testing all the ways custom objects can be used
20+
21+
Attributes:
22+
an_enum_value (AnEnum): For testing Enums in all the ways they can be used
23+
an_allof_enum_with_overridden_default (AnAllOfEnum): Default: AnAllOfEnum.OVERRIDDEN_DEFAULT.
24+
a_camel_date_time (Union[datetime.date, datetime.datetime]):
25+
a_date (datetime.date):
26+
required_not_nullable (str):
27+
one_of_models (Union[Any, FreeFormModel, ModelWithUnionProperty]):
28+
model (ModelWithUnionProperty):
29+
any_value (Union[Unset, Any]):
30+
an_optional_allof_enum (Union[Unset, AnAllOfEnum]):
31+
nested_list_of_enums (Union[Unset, List[List[DifferentEnum]]]):
32+
a_nullable_date (Optional[datetime.date]):
33+
a_not_required_date (Union[Unset, datetime.date]):
34+
attr_1_leading_digit (Union[Unset, str]):
35+
required_nullable (Optional[str]):
36+
not_required_nullable (Union[Unset, None, str]):
37+
not_required_not_nullable (Union[Unset, str]):
38+
nullable_one_of_models (Union[FreeFormModel, ModelWithUnionProperty, None]):
39+
not_required_one_of_models (Union[FreeFormModel, ModelWithUnionProperty, Unset]):
40+
not_required_nullable_one_of_models (Union[FreeFormModel, ModelWithUnionProperty, None, Unset, str]):
41+
nullable_model (Optional[ModelWithUnionProperty]):
42+
not_required_model (Union[Unset, ModelWithUnionProperty]):
43+
not_required_nullable_model (Union[Unset, None, ModelWithUnionProperty]):
5244
"""
5345

5446
an_enum_value: AnEnum

end_to_end_tests/golden-record/my_test_api_client/models/a_model_with_properties_reference_that_are_not_object.py

Lines changed: 31 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -14,41 +14,37 @@
1414
@attr.s(auto_attribs=True)
1515
class AModelWithPropertiesReferenceThatAreNotObject:
1616
"""
17-
18-
19-
Properties:
20-
enum_properties_ref (List[AnEnum]):
21-
str_properties_ref (List[str]):
22-
date_properties_ref (List[datetime.date]):
23-
datetime_properties_ref (List[datetime.datetime]):
24-
int32_properties_ref (List[int]):
25-
int64_properties_ref (List[int]):
26-
float_properties_ref (List[float]):
27-
double_properties_ref (List[float]):
28-
file_properties_ref (List[File]):
29-
bytestream_properties_ref (List[str]):
30-
enum_properties (List[AnEnum]):
31-
str_properties (List[str]):
32-
date_properties (List[datetime.date]):
33-
datetime_properties (List[datetime.datetime]):
34-
int32_properties (List[int]):
35-
int64_properties (List[int]):
36-
float_properties (List[float]):
37-
double_properties (List[float]):
38-
file_properties (List[File]):
39-
bytestream_properties (List[str]):
40-
enum_property_ref (AnEnum): For testing Enums in all the ways they can
41-
be used
42-
str_property_ref (str):
43-
date_property_ref (datetime.date):
44-
datetime_property_ref (datetime.datetime):
45-
int32_property_ref (int):
46-
int64_property_ref (int):
47-
float_property_ref (float):
48-
double_property_ref (float):
49-
file_property_ref (File):
50-
bytestream_property_ref (str):
51-
17+
Attributes:
18+
enum_properties_ref (List[AnEnum]):
19+
str_properties_ref (List[str]):
20+
date_properties_ref (List[datetime.date]):
21+
datetime_properties_ref (List[datetime.datetime]):
22+
int32_properties_ref (List[int]):
23+
int64_properties_ref (List[int]):
24+
float_properties_ref (List[float]):
25+
double_properties_ref (List[float]):
26+
file_properties_ref (List[File]):
27+
bytestream_properties_ref (List[str]):
28+
enum_properties (List[AnEnum]):
29+
str_properties (List[str]):
30+
date_properties (List[datetime.date]):
31+
datetime_properties (List[datetime.datetime]):
32+
int32_properties (List[int]):
33+
int64_properties (List[int]):
34+
float_properties (List[float]):
35+
double_properties (List[float]):
36+
file_properties (List[File]):
37+
bytestream_properties (List[str]):
38+
enum_property_ref (AnEnum): For testing Enums in all the ways they can be used
39+
str_property_ref (str):
40+
date_property_ref (datetime.date):
41+
datetime_property_ref (datetime.datetime):
42+
int32_property_ref (int):
43+
int64_property_ref (int):
44+
float_property_ref (float):
45+
double_property_ref (float):
46+
file_property_ref (File):
47+
bytestream_property_ref (str):
5248
"""
5349

5450
enum_properties_ref: List[AnEnum]

end_to_end_tests/golden-record/my_test_api_client/models/all_of_sub_model.py

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,10 @@
1111
@attr.s(auto_attribs=True)
1212
class AllOfSubModel:
1313
"""
14-
15-
16-
Properties:
14+
Attributes:
1715
a_sub_property (Union[Unset, str]):
1816
type (Union[Unset, str]):
1917
type_enum (Union[Unset, AllOfSubModelTypeEnum]):
20-
2118
"""
2219

2320
a_sub_property: Union[Unset, str] = UNSET

end_to_end_tests/golden-record/my_test_api_client/models/another_all_of_sub_model.py

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,10 @@
1212
@attr.s(auto_attribs=True)
1313
class AnotherAllOfSubModel:
1414
"""
15-
16-
17-
Properties:
15+
Attributes:
1816
another_sub_property (Union[Unset, str]):
1917
type (Union[Unset, AnotherAllOfSubModelType]):
2018
type_enum (Union[Unset, AnotherAllOfSubModelTypeEnum]):
21-
2219
"""
2320

2421
another_sub_property: Union[Unset, str] = UNSET

end_to_end_tests/golden-record/my_test_api_client/models/body_upload_file_tests_upload_post.py

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -23,21 +23,16 @@
2323
@attr.s(auto_attribs=True)
2424
class BodyUploadFileTestsUploadPost:
2525
"""
26-
27-
28-
Properties:
29-
some_file (File):
30-
some_object (BodyUploadFileTestsUploadPostSomeObject):
31-
some_optional_file (Union[Unset, File]):
32-
some_string (Union[Unset, str]): Default: 'some_default_string'.
33-
some_number (Union[Unset, float]):
34-
some_array (Union[Unset, List[float]]):
35-
some_optional_object (Union[Unset,
36-
BodyUploadFileTestsUploadPostSomeOptionalObject]):
37-
some_nullable_object
38-
(Optional[BodyUploadFileTestsUploadPostSomeNullableObject]):
39-
some_enum (Union[Unset, DifferentEnum]): An enumeration.
40-
26+
Attributes:
27+
some_file (File):
28+
some_object (BodyUploadFileTestsUploadPostSomeObject):
29+
some_optional_file (Union[Unset, File]):
30+
some_string (Union[Unset, str]): Default: 'some_default_string'.
31+
some_number (Union[Unset, float]):
32+
some_array (Union[Unset, List[float]]):
33+
some_optional_object (Union[Unset, BodyUploadFileTestsUploadPostSomeOptionalObject]):
34+
some_nullable_object (Optional[BodyUploadFileTestsUploadPostSomeNullableObject]):
35+
some_enum (Union[Unset, DifferentEnum]): An enumeration.
4136
"""
4237

4338
some_file: File

end_to_end_tests/golden-record/my_test_api_client/models/body_upload_file_tests_upload_post_additional_property.py

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,8 @@
1010
@attr.s(auto_attribs=True)
1111
class BodyUploadFileTestsUploadPostAdditionalProperty:
1212
"""
13-
14-
15-
Properties:
13+
Attributes:
1614
foo (Union[Unset, str]):
17-
1815
"""
1916

2017
foo: Union[Unset, str] = UNSET

end_to_end_tests/golden-record/my_test_api_client/models/body_upload_file_tests_upload_post_some_nullable_object.py

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,8 @@
1010
@attr.s(auto_attribs=True)
1111
class BodyUploadFileTestsUploadPostSomeNullableObject:
1212
"""
13-
14-
15-
Properties:
13+
Attributes:
1614
bar (Union[Unset, str]):
17-
1815
"""
1916

2017
bar: Union[Unset, str] = UNSET

end_to_end_tests/golden-record/my_test_api_client/models/body_upload_file_tests_upload_post_some_object.py

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,9 @@
88
@attr.s(auto_attribs=True)
99
class BodyUploadFileTestsUploadPostSomeObject:
1010
"""
11-
12-
13-
Properties:
11+
Attributes:
1412
num (float):
1513
text (str):
16-
1714
"""
1815

1916
num: float

end_to_end_tests/golden-record/my_test_api_client/models/body_upload_file_tests_upload_post_some_optional_object.py

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,8 @@
88
@attr.s(auto_attribs=True)
99
class BodyUploadFileTestsUploadPostSomeOptionalObject:
1010
"""
11-
12-
13-
Properties:
11+
Attributes:
1412
foo (str):
15-
1613
"""
1714

1815
foo: str

end_to_end_tests/golden-record/my_test_api_client/models/free_form_model.py

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,7 @@
77

88
@attr.s(auto_attribs=True)
99
class FreeFormModel:
10-
"""
11-
12-
13-
Properties:
14-
15-
"""
10+
""" """
1611

1712
additional_properties: Dict[str, Any] = attr.ib(init=False, factory=dict)
1813

end_to_end_tests/golden-record/my_test_api_client/models/http_validation_error.py

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,8 @@
1111
@attr.s(auto_attribs=True)
1212
class HTTPValidationError:
1313
"""
14-
15-
16-
Properties:
14+
Attributes:
1715
detail (Union[Unset, List[ValidationError]]):
18-
1916
"""
2017

2118
detail: Union[Unset, List[ValidationError]] = UNSET

end_to_end_tests/golden-record/my_test_api_client/models/import_.py

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,7 @@
77

88
@attr.s(auto_attribs=True)
99
class Import:
10-
"""
11-
12-
13-
Properties:
14-
15-
"""
10+
""" """
1611

1712
additional_properties: Dict[str, Any] = attr.ib(init=False, factory=dict)
1813

end_to_end_tests/golden-record/my_test_api_client/models/model_from_all_of.py

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,11 @@
1212
@attr.s(auto_attribs=True)
1313
class ModelFromAllOf:
1414
"""
15-
16-
17-
Properties:
15+
Attributes:
1816
a_sub_property (Union[Unset, str]):
1917
type (Union[Unset, AnotherAllOfSubModelType]):
2018
type_enum (Union[Unset, AnotherAllOfSubModelTypeEnum]):
2119
another_sub_property (Union[Unset, str]):
22-
2320
"""
2421

2522
a_sub_property: Union[Unset, str] = UNSET

end_to_end_tests/golden-record/my_test_api_client/models/model_name.py

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,7 @@
77

88
@attr.s(auto_attribs=True)
99
class ModelName:
10-
"""
11-
12-
13-
Properties:
14-
15-
"""
10+
""" """
1611

1712
additional_properties: Dict[str, Any] = attr.ib(init=False, factory=dict)
1813

end_to_end_tests/golden-record/my_test_api_client/models/model_with_additional_properties_inlined.py

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,8 @@
1313
@attr.s(auto_attribs=True)
1414
class ModelWithAdditionalPropertiesInlined:
1515
"""
16-
17-
18-
Properties:
16+
Attributes:
1917
a_number (Union[Unset, float]):
20-
2118
"""
2219

2320
a_number: Union[Unset, float] = UNSET

end_to_end_tests/golden-record/my_test_api_client/models/model_with_additional_properties_inlined_additional_property.py

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,8 @@
1010
@attr.s(auto_attribs=True)
1111
class ModelWithAdditionalPropertiesInlinedAdditionalProperty:
1212
"""
13-
14-
15-
Properties:
13+
Attributes:
1614
extra_props_prop (Union[Unset, str]):
17-
1815
"""
1916

2017
extra_props_prop: Union[Unset, str] = UNSET

end_to_end_tests/golden-record/my_test_api_client/models/model_with_additional_properties_refed.py

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,7 @@
99

1010
@attr.s(auto_attribs=True)
1111
class ModelWithAdditionalPropertiesRefed:
12-
"""
13-
14-
15-
Properties:
16-
17-
"""
12+
""" """
1813

1914
additional_properties: Dict[str, AnEnum] = attr.ib(init=False, factory=dict)
2015

end_to_end_tests/golden-record/my_test_api_client/models/model_with_any_json_properties.py

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,7 @@
1111

1212
@attr.s(auto_attribs=True)
1313
class ModelWithAnyJsonProperties:
14-
"""
15-
16-
17-
Properties:
18-
19-
"""
14+
""" """
2015

2116
additional_properties: Dict[
2217
str, Union[List[str], ModelWithAnyJsonPropertiesAdditionalPropertyType0, bool, float, int, str]

0 commit comments

Comments
 (0)