feat: Optional __model__ type (#452)

Co-authored-by: Jacob Coffee <[email protected]> Co-authored-by: guacs <[email protected]>
litestar-org · Dec 15, 2023 · 623d8c9 · 623d8c9
1 parent a371d7f
commit 623d8c9
Show file tree

Hide file tree

Showing 38 changed files with 224 additions and 63 deletions.
diff --git a/README.md b/README.md
@@ -44,7 +44,7 @@ class Person:
 
 
 class PersonFactory(DataclassFactory[Person]):
-    __model__ = Person
+    ...
 
 
 def test_is_person() -> None:

diff --git a/docs/PYPI_README.md b/docs/PYPI_README.md
@@ -44,7 +44,7 @@ class Person:
 
 
 class PersonFactory(DataclassFactory[Person]):
-    __model__ = Person
+    ...
 
 
 def test_is_person() -> None:

diff --git a/docs/examples/configuration/test_example_1.py b/docs/examples/configuration/test_example_1.py
@@ -12,7 +12,6 @@ class Person:
 
 
 class PersonFactory(DataclassFactory[Person]):
-    __model__ = Person
     __random_seed__ = 1
 
     @classmethod

diff --git a/docs/examples/configuration/test_example_2.py b/docs/examples/configuration/test_example_2.py
@@ -13,7 +13,6 @@ class Person:
 
 
 class PersonFactory(DataclassFactory[Person]):
-    __model__ = Person
     __random__ = Random(10)
 
     @classmethod

diff --git a/docs/examples/configuration/test_example_3.py b/docs/examples/configuration/test_example_3.py
@@ -14,7 +14,6 @@ class Person:
 
 
 class PersonFactory(DataclassFactory[Person]):
-    __model__ = Person
     __faker__ = Faker(locale="es_ES")
 
     __random_seed__ = 10

diff --git a/docs/examples/configuration/test_example_4.py b/docs/examples/configuration/test_example_4.py
@@ -50,7 +50,6 @@ async def save_many(self, data: List[Person]) -> List[Person]:
 
 
 class PersonFactory(DataclassFactory[Person]):
-    __model__ = Person
     __sync_persistence__ = SyncPersistenceHandler
     __async_persistence__ = AsyncPersistenceHandler
 

diff --git a/docs/examples/configuration/test_example_5.py b/docs/examples/configuration/test_example_5.py
@@ -32,14 +32,13 @@ class Person:
 
 
 class PetFactory(DataclassFactory[Pet]):
-    __model__ = Pet
     __set_as_default_factory_for_type__ = True
 
     name = Use(DataclassFactory.__random__.choice, ["Roxy", "Spammy", "Moshe"])
 
 
 class PersonFactory(DataclassFactory[Person]):
-    __model__ = Person
+    ...
 
 
 def test_default_pet_factory() -> None:

diff --git a/docs/examples/configuration/test_example_6.py b/docs/examples/configuration/test_example_6.py
@@ -10,8 +10,6 @@ class Owner:
 
 
 class OwnerFactory(DataclassFactory[Owner]):
-    __model__ = Owner
-
     __randomize_collection_length__ = True
     __min_collection_length__ = 2
     __max_collection_length__ = 5

diff --git a/docs/examples/configuration/test_example_7.py b/docs/examples/configuration/test_example_7.py
@@ -12,7 +12,6 @@ class Person:
 
 
 class PersonFactory(DataclassFactory[Person]):
-    __model__ = Person
     __allow_none_optionals__ = False
 
 

diff --git a/docs/examples/configuration/test_example_8.py b/docs/examples/configuration/test_example_8.py
@@ -19,6 +19,5 @@ def test_check_factory_fields() -> None:
     ):
 
         class PersonFactory(DataclassFactory[Person]):
-            __model__ = Person
             __check_model__ = True
             unknown_field = PostGenerated(lambda: "foo")
diff --git a/docs/examples/declaring_factories/test_example_2.py b/docs/examples/declaring_factories/test_example_2.py
@@ -11,7 +11,7 @@ class Person(TypedDict):
 
 
 class PersonFactory(TypedDictFactory[Person]):
-    __model__ = Person
+    ...
 
 
 def test_is_person() -> None:

diff --git a/docs/examples/declaring_factories/test_example_3.py b/docs/examples/declaring_factories/test_example_3.py
@@ -11,7 +11,7 @@ class Person(BaseModel):
 
 
 class PersonFactory(ModelFactory[Person]):
-    __model__ = Person
+    ...
 
 
 def test_is_person() -> None:

diff --git a/docs/examples/declaring_factories/test_example_4.py b/docs/examples/declaring_factories/test_example_4.py
@@ -12,7 +12,7 @@ class Person:
 
 
 class PersonFactory(DataclassFactory[Person]):
-    __model__ = Person
+    ...
 
 
 def test_is_person() -> None:

diff --git a/docs/examples/declaring_factories/test_example_5.py b/docs/examples/declaring_factories/test_example_5.py
@@ -31,7 +31,7 @@ class Person:
 
 
 class PersonFactory(DataclassFactory[Person]):
-    __model__ = Person
+    ...
 
 
 def test_dynamic_factory_generation() -> None:

diff --git a/docs/examples/declaring_factories/test_example_7.py b/docs/examples/declaring_factories/test_example_7.py
@@ -20,7 +20,7 @@ class Person:
 
 
 class PersonFactory(AttrsFactory[Person]):
-    __model__ = Person
+    ...
 
 
 def test_person_factory() -> None:

diff --git a/docs/examples/decorators/test_example_1.py b/docs/examples/decorators/test_example_1.py
@@ -13,8 +13,6 @@ class DatetimeRange:
 
 
 class DatetimeRangeFactory(DataclassFactory[DatetimeRange]):
-    __model__ = DatetimeRange
-
     @post_generated
     @classmethod
     def to_dt(cls, from_dt: datetime) -> datetime:

diff --git a/docs/examples/fields/test_example_1.py b/docs/examples/fields/test_example_1.py
@@ -34,8 +34,6 @@ class Person:
 
 
 class PersonFactory(DataclassFactory[Person]):
-    __model__ = Person
-
     pets = [pet_instance]
 
 

diff --git a/docs/examples/fields/test_example_2.py b/docs/examples/fields/test_example_2.py
@@ -32,15 +32,11 @@ class Person:
 
 
 class PetFactory(DataclassFactory[Pet]):
-    __model__ = Pet
-
     name = Use(DataclassFactory.__random__.choice, ["Ralph", "Roxy"])
     species = Use(DataclassFactory.__random__.choice, list(Species))
 
 
 class PersonFactory(DataclassFactory[Person]):
-    __model__ = Person
-
     pets = Use(PetFactory.batch, size=2)
 
 

diff --git a/docs/examples/fields/test_example_3.py b/docs/examples/fields/test_example_3.py
@@ -32,15 +32,11 @@ class Person:
 
 
 class PetFactory(DataclassFactory[Pet]):
-    __model__ = Pet
-
     name = lambda: DataclassFactory.__random__.choice(["Ralph", "Roxy"])
     species = lambda: DataclassFactory.__random__.choice(list(Species))
 
 
 class PersonFactory(DataclassFactory[Person]):
-    __model__ = Person
-
     pets = Use(PetFactory.batch, size=2)
 
 

diff --git a/docs/examples/fields/test_example_4.py b/docs/examples/fields/test_example_4.py
@@ -32,8 +32,6 @@ class Person:
 
 
 class PetFactory(DataclassFactory[Pet]):
-    __model__ = Pet
-
     @classmethod
     def name(cls) -> str:
         return cls.__random__.choice(["Ralph", "Roxy"])
@@ -44,8 +42,6 @@ def species(cls) -> str:
 
 
 class PersonFactory(DataclassFactory[Person]):
-    __model__ = Person
-
     pets = Use(PetFactory.batch, size=2)
 
 

diff --git a/docs/examples/fields/test_example_5.py b/docs/examples/fields/test_example_5.py
@@ -10,8 +10,6 @@ class Person(TypedDict):
 
 
 class PersonFactory(TypedDictFactory[Person]):
-    __model__ = Person
-
     id = Ignore()
 
 

diff --git a/docs/examples/fields/test_example_6.py b/docs/examples/fields/test_example_6.py
@@ -13,8 +13,6 @@ class Person(TypedDict):
 
 
 class PersonFactory(TypedDictFactory[Person]):
-    __model__ = Person
-
     id = Require()
 
 

diff --git a/docs/examples/fields/test_example_7.py b/docs/examples/fields/test_example_7.py
@@ -18,8 +18,6 @@ class DatetimeRange:
 
 
 class DatetimeRangeFactory(DataclassFactory[DatetimeRange]):
-    __model__ = DatetimeRange
-
     to_dt = PostGenerated(add_timedelta)
 
 

diff --git a/docs/examples/fields/test_example_8.py b/docs/examples/fields/test_example_8.py
@@ -31,14 +31,10 @@ class Person:
 
 
 class PetFactory(DataclassFactory[Pet]):
-    __model__ = Pet
-
     name = lambda: DataclassFactory.__random__.choice(["Ralph", "Roxy"])
 
 
 class PersonFactory(DataclassFactory[Person]):
-    __model__ = Person
-
     pet = PetFactory
 
 

diff --git a/docs/examples/fixtures/test_example_1.py b/docs/examples/fixtures/test_example_1.py
@@ -19,7 +19,7 @@ class Person:
 
 @register_fixture
 class PersonFactory(DataclassFactory[Person]):
-    __model__ = Person
+    ...
 
 
 def test_person_factory(person_factory: PersonFactory) -> None:

diff --git a/docs/examples/fixtures/test_example_2.py b/docs/examples/fixtures/test_example_2.py
@@ -18,7 +18,7 @@ class Person:
 
 
 class PersonFactory(DataclassFactory[Person]):
-    __model__ = Person
+    ...
 
 
 person_factory_fixture = register_fixture(PersonFactory)

diff --git a/docs/examples/fixtures/test_example_3.py b/docs/examples/fixtures/test_example_3.py
@@ -18,7 +18,7 @@ class Person:
 
 
 class PersonFactory(DataclassFactory[Person]):
-    __model__ = Person
+    ...
 
 
 person_factory_fixture = register_fixture(PersonFactory, name="aliased_person_factory")

diff --git a/docs/examples/fixtures/test_example_4.py b/docs/examples/fixtures/test_example_4.py
@@ -26,12 +26,10 @@ class ClassRoom:
 
 @register_fixture
 class PersonFactory(DataclassFactory[Person]):
-    __model__ = Person
+    ...
 
 
 class ClassRoomFactory(DataclassFactory[ClassRoom]):
-    __model__ = ClassRoom
-
     teacher = Fixture(PersonFactory, name="Ludmilla Newman")
     pupils = Fixture(PersonFactory, size=20)
 

diff --git a/docs/examples/handling_custom_types/test_example_1.py b/docs/examples/handling_custom_types/test_example_1.py
@@ -26,8 +26,6 @@ class Person:
 # by default the factory class cannot handle unknown types,
 # so we need to override the provider map to add it:
 class PersonFactory(DataclassFactory[Person]):
-    __model__ = Person
-
     @classmethod
     def get_provider_map(cls) -> Dict[Type, Any]:
         providers_map = super().get_provider_map()

diff --git a/docs/examples/handling_custom_types/test_example_2.py b/docs/examples/handling_custom_types/test_example_2.py
@@ -42,7 +42,7 @@ class Person:
 
 # we use our CustomDataclassFactory as a base for the PersonFactory
 class PersonFactory(CustomDataclassFactory[Person]):
-    __model__ = Person
+    ...
 
 
 def test_custom_dataclass_base_factory() -> None:

diff --git a/docs/examples/library_factories/sqlalchemy_factory/test_example_1.py b/docs/examples/library_factories/sqlalchemy_factory/test_example_1.py
@@ -15,7 +15,7 @@ class Author(Base):
 
 
 class AuthorFactory(SQLAlchemyFactory[Author]):
-    __model__ = Author
+    ...
 
 
 def test_sqla_factory() -> None:

diff --git a/docs/examples/library_factories/sqlalchemy_factory/test_example_2.py b/docs/examples/library_factories/sqlalchemy_factory/test_example_2.py
@@ -27,11 +27,10 @@ class Book(Base):
 
 
 class AuthorFactory(SQLAlchemyFactory[Author]):
-    __model__ = Author
+    ...
 
 
 class AuthorFactoryWithRelationship(SQLAlchemyFactory[Author]):
-    __model__ = Author
     __set_relationships__ = True
 
 

diff --git a/docs/examples/library_factories/sqlalchemy_factory/test_example_3.py b/docs/examples/library_factories/sqlalchemy_factory/test_example_3.py
@@ -27,7 +27,6 @@ class Book(Base):
 
 
 class AuthorFactory(SQLAlchemyFactory[Author]):
-    __model__ = Author
     __set_relationships__ = True
 
 

diff --git a/docs/examples/model_coverage/test_example_1.py b/docs/examples/model_coverage/test_example_1.py
@@ -24,7 +24,7 @@ class Profile:
 
 
 class ProfileFactory(DataclassFactory[Profile]):
-    __model__ = Profile
+    ...
 
 
 def test_profile_coverage() -> None:

diff --git a/docs/examples/model_coverage/test_example_2.py b/docs/examples/model_coverage/test_example_2.py
@@ -29,7 +29,7 @@ class SocialGroup:
 
 
 class SocialGroupFactory(DataclassFactory[SocialGroup]):
-    __model__ = SocialGroup
+    ...
 
 
 def test_social_group_coverage() -> None:

diff --git a/docs/usage/declaring_factories.rst b/docs/usage/declaring_factories.rst
@@ -8,6 +8,24 @@ base factories.
     :caption: Declaring a factory for a dataclass
     :language: python
 
+You can also specify the model type by only specifying the factory generic type parameter.
+
+.. code-block:: python
+
+    @dataclass
+    class Person:
+        name: str
+        age: float
+        height: float
+        weight: float
+
+    class PersonFactory(DataclassFactory[Person]):
+        ...
+
+.. note::
+   The syntax with the ``__model__`` class attribute omitting
+   is only available since version 2.13.0.
+
 The same applies to the other factories exported by this library, for example:
 
 .. literalinclude:: /examples/declaring_factories/test_example_2.py
-Original file line number
+Diff line change
@@ Expand Up / @@ -44,7 +44,7 @@ class Person: @@
     class PersonFactory(DataclassFactory[Person]):
-        __model__ = Person
+        ...
     def test_is_person() -> None:
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
Expand Up		@@ -12,7 +12,6 @@ class Person:


		class PersonFactory(DataclassFactory[Person]):
		__model__ = Person
		__allow_none_optionals__ = False


Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -34,8 +34,6 @@ class Person:


		class PersonFactory(DataclassFactory[Person]):
		__model__ = Person

		pets = [pet_instance]


Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -10,8 +10,6 @@ class Person(TypedDict):


		class PersonFactory(TypedDictFactory[Person]):
		__model__ = Person

		id = Ignore()


Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -13,8 +13,6 @@ class Person(TypedDict):


		class PersonFactory(TypedDictFactory[Person]):
		__model__ = Person

		id = Require()


Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -18,8 +18,6 @@ class DatetimeRange:


		class DatetimeRangeFactory(DataclassFactory[DatetimeRange]):
		__model__ = DatetimeRange

		to_dt = PostGenerated(add_timedelta)


Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -27,7 +27,6 @@ class Book(Base):


		class AuthorFactory(SQLAlchemyFactory[Author]):
		__model__ = Author
		__set_relationships__ = True


Expand Down