diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/orms.rst | 5 | ||||
| -rw-r--r-- | docs/reference.rst | 13 |
2 files changed, 16 insertions, 2 deletions
diff --git a/docs/orms.rst b/docs/orms.rst index eae31d9..d6ff3c3 100644 --- a/docs/orms.rst +++ b/docs/orms.rst @@ -32,5 +32,6 @@ All factories for a Django :class:`~django.db.models.Model` should use the * :func:`~Factory.create()` uses :meth:`Model.objects.create() <django.db.models.query.QuerySet.create>` * :func:`~Factory._setup_next_sequence()` selects the next unused primary key value - * When using :class:`~factory.RelatedFactory` attributes, the base object will be - :meth:`saved <django.db.models.Model.save>` once all post-generation hooks have run. + * When using :class:`~factory.RelatedFactory` or :class:`~factory.PostGeneration` + attributes, the base object will be :meth:`saved <django.db.models.Model.save>` + once all post-generation hooks have run. diff --git a/docs/reference.rst b/docs/reference.rst index e2246aa..d100b40 100644 --- a/docs/reference.rst +++ b/docs/reference.rst @@ -189,6 +189,19 @@ The :class:`Factory` class .. OHAI_VIM* + .. classmethod:: _after_postgeneration(cls, obj, create, results=None) + + :arg object obj: The object just generated + :arg bool create: Whether the object was 'built' or 'created' + :arg dict results: Map of post-generation declaration name to call + result + + The :meth:`_after_postgeneration` is called once post-generation + declarations have been handled. + + Its arguments allow to handle specifically some post-generation return + values, for instance. + .. _strategies: |