feat(sqla_factory): added __set_association_proxy__ attribute #629
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adhtruong
reviewed
Jan 16, 2025
|
|
||
| from polyfactory.factories.sqlalchemy_factory import SQLAlchemyFactory | ||
|
|
||
| if __version__.startswith("2"): |
There was a problem hiding this comment.
Is this required? It would be great to test this syntax for both 1 and 2
|
|
||
| By default, relationships will not be set. This can be overridden via ``__set_relationships__``. | ||
| By default, ``__set_relationships__`` is set to ``False``. If it is ``True``, all fields with the SQLAlchemy `relationship() <relationship()_>`_ will be included in the resulting mock dictionary created by ``build`` method. |
There was a problem hiding this comment.
Suggested change
| By default, ``__set_relationships__`` is set to ``False``. If it is ``True``, all fields with the SQLAlchemy `relationship() <relationship()_>`_ will be included in the resulting mock dictionary created by ``build`` method. | |
| By default, ``__set_relationships__`` is set to ``False``. If it is ``True``, all fields with the SQLAlchemy `relationship() <relationship()_>`_ will be included in the result created by ``build`` method. |
|
|
||
| .. literalinclude:: /examples/library_factories/sqlalchemy_factory/test_example_2.py | ||
| :caption: Setting relationships | ||
| :language: python | ||
|
|
||
| .. note:: | ||
| In general, foreign keys are not automatically generated by ``.build``. This can be resolved by setting the fields yourself and/or using ``create_sync``/ ``create_async`` so models can be added to a SQLA session so these are set. | ||
| In general, ForeignKey fields are automatically generated by ``build`` method because :class:`__set_foreign_keys__ <polyfactory.factories.sqlalchemy_factory.SQLAlchemyFactory.__set_foreign_keys__>` is set to ``True`` by default. But their values can be overwritten by using ``create_sync``/ ``create_async`` methods, so SQLAlchemy ORM creates them. |
There was a problem hiding this comment.
Is the last sentence correct always? Would that only be the case if a relationship is present?
|
Documentation preview will be available shortly at https://litestar-org.github.io/polyfactory-docs-preview/629 |
adhtruong
approved these changes
Jan 17, 2025
|
Hi, @adhtruong! More detailed about #629 (comment): I have rewritten this part more clearly. |
|
Thanks for updating! LGTM |
|
@all-contributors add @nisemenov for code doc |
|
I've put up a pull request to add @nisemenov! 🎉 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Closes