Skip to content

docs: add migration guide #704

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,7 @@ where you can pledge an amount towards an issue or feature you would like to see

getting-started
usage/index
migration_guide/index
reference/index

.. toctree::
Expand Down
70 changes: 70 additions & 0 deletions docs/migration_guide/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
Migration Guide
===============

.. note::
This guide is for an unrelease version of polyfactory.

For v2 to v3 migration, this is largely deprecation internal parameters and updating defaults to be more aligned with common use cases.

SQLAlchemyFactory Default Changes
---------------------------------

In the latest version, we've made changes to the default behavior of SQLAlchemyFactory to better align with common use cases. Here are the key changes and how to migrate:

Default Relationship Behavior
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

**Before:**

- ``__set_relationships__`` defaulted to ``False``
- Relationships were not automatically populated unless explicitly enabled

**After:**

- ``__set_relationships__`` now defaults to ``True``
- Relationships are automatically populated by default

To maintain the previous behavior, explicitly set ``__set_relationships__ = False`` in your factory:

Default Association Proxy Behavior
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

**Before:**

- ``__set_association_proxy__`` defaulted to ``False``
- Association proxies were not automatically populated unless explicitly enabled

**After:**

- ``__set_association_proxy__`` now defaults to ``True``
- Association proxies are automatically populated by default

To maintain the previous behavior, explicitly set ``__set_association_proxy__ = False`` in your factory:

Model Validation Behavior
-------------------------

**Before:**

- ``__check_model__`` defaulted to ``False``
- Model structure validation was disabled by default

**After:**

- ``__check_model__`` now defaults to ``True``
- Model structure validation is enabled by default
- This helps catch potential issues with model definitions early

To maintain the previous behavior, explicitly set ``__check_model__ = False`` in your factory:

Fixture Field Removal
---------------------

The ``polyfactory.fields.Fixture`` field has been removed in v3. This was a legacy field that was used to define factory behavior through a separate ``pytest`` fixture.

Instead, all factories can be used directly as `factories as fields <https://polyfactory.litestar.dev/latest/usage/fields.html#factories-as-fields>`_. For batch usage, this can be combined with ``Use`` or similar.

Internal Parameter Changes
--------------------------

Several internal parameters have been removed or changed in v3 to simplify ``FieldMeta`` and typing utils to be deterministic. Usage of ``random.Random`` parameters should be removed as per warning emitted.
Loading