Skip to content

Commit

Permalink
refactor: Change Pydantic properties names
Browse files Browse the repository at this point in the history
pawamoy committed Jun 8, 2020
1 parent 9e07e25 commit fa8d2e7
Showing 2 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions src/pytkdocs/loader.py
Original file line number Diff line number Diff line change
@@ -380,7 +380,7 @@ def get_class_documentation(self, node: ObjectNode, select_members=None) -> Clas

# First check if this is Pydantic compatible
if "__fields__" in direct_members or (self.select_inherited_members and "__fields__" in all_members):
root_object.properties = ["pydantic"]
root_object.properties = ["pydantic-model"]
for field_name, model_field in all_members["__fields__"].items():
if self.select(field_name, select_members) and ( # type: ignore
self.select_inherited_members
@@ -497,7 +497,7 @@ def get_pydantic_field_documentation(node: ObjectNode) -> Attribute:
"""
prop = node.obj
path = node.dotted_path
properties = ["field", "pydantic"]
properties = ["pydantic-field"]
if prop.required:
properties.append("required")

6 changes: 3 additions & 3 deletions tests/test_loader.py
Original file line number Diff line number Diff line change
@@ -145,15 +145,15 @@ def test_loading_pydantic_model():
loader = Loader()
obj = loader.get_object_documentation("tests.fixtures.pydantic.Person")
assert obj.docstring == "Simple Pydantic Model for a person's information"
assert "pydantic" in obj.properties
assert "pydantic-model" in obj.properties
name_attr = next(attr for attr in obj.attributes if attr.name == "name")
assert name_attr.type == str
assert name_attr.docstring == "The person's name"
assert "pydantic" in name_attr.properties
assert "pydantic-field" in name_attr.properties
age_attr = next(attr for attr in obj.attributes if attr.name == "age")
assert age_attr.type == int
assert age_attr.docstring == "The person's age which must be at minimum 18"
assert "pydantic" in age_attr.properties
assert "pydantic-field" in age_attr.properties


def test_loading_nested_class():

0 comments on commit fa8d2e7

Please sign in to comment.