diff options
| author | Raphaël Barrois <raphael.barrois@polytechnique.org> | 2013-03-11 22:36:30 +0100 |
|---|---|---|
| committer | Raphaël Barrois <raphael.barrois@polytechnique.org> | 2013-03-11 22:36:30 +0100 |
| commit | 60f0969406bd349a8a8b88fcaec819fa5c0525cb (patch) | |
| tree | 6cf85cd478335d196d87bf4051986e007abc05a4 /docs | |
| parent | 16e1a65f5b93615d946b74e3fb4d0b61c99ae0d2 (diff) | |
| download | factory-boy-60f0969406bd349a8a8b88fcaec819fa5c0525cb.tar factory-boy-60f0969406bd349a8a8b88fcaec819fa5c0525cb.tar.gz | |
Remove extract_prefix from post-generation hooks.
Magic abuse is bad.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/changelog.rst | 1 | ||||
| -rw-r--r-- | docs/reference.rst | 16 |
2 files changed, 3 insertions, 14 deletions
diff --git a/docs/changelog.rst b/docs/changelog.rst index 518ab9e..b73e33b 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -17,6 +17,7 @@ ChangeLog - Remove associated class discovery - Remove :class:`~factory.InfiniteIterator` and :func:`~factory.infinite_iterator` - Remove :class:`~factory.CircularSubFactory` + - Remove ``extract_prefix`` kwarg to post-generation hooks. - Stop defaulting to Django's ``Foo.objects.create()`` when "creating" instances - Remove STRATEGY_* - Remove :meth:`~factory.Factory.set_building_function` / :meth:`~factory.Factory.set_creation_function` diff --git a/docs/reference.rst b/docs/reference.rst index 955d3c5..d5b14a9 100644 --- a/docs/reference.rst +++ b/docs/reference.rst @@ -944,10 +944,6 @@ has been generated. Its sole argument is a callable, that will be called once the base object has been generated. -.. note:: Previous versions of factory_boy supported an extra ``extract_prefix`` - argument, to use an alternate argument prefix. - This feature is deprecated in 1.3.0 and will be removed in 2.0.0. - Once the base object has been generated, the provided callable will be called as ``callable(obj, create, extracted, **kwargs)``, where: @@ -973,7 +969,7 @@ as ``callable(obj, create, extracted, **kwargs)``, where: Decorator ~~~~~~~~~ -.. function:: post_generation(extract_prefix=None) +.. function:: post_generation A decorator is also provided, decorating a single method accepting the same ``obj``, ``created``, ``extracted`` and keyword arguments as :class:`PostGeneration`. @@ -1007,7 +1003,7 @@ A decorator is also provided, decorating a single method accepting the same PostGenerationMethodCall """""""""""""""""""""""" -.. class:: PostGenerationMethodCall(method_name, extract_prefix=None, *args, **kwargs) +.. class:: PostGenerationMethodCall(method_name, *args, **kwargs) .. OHAI_VIM* @@ -1020,14 +1016,6 @@ PostGenerationMethodCall The name of the method to call on the :attr:`~Factory.FACTORY_FOR` object - .. attribute:: extract_prefix - - If a string, the keyword argument prefix by which the field will get its - overriding arguments. If ``None``, defaults to the name of the attribute. - - .. deprecated:: 1.3.0 - Will be removed in 2.0.0 - .. attribute:: args The default set of unnamed arguments to pass to the method given in |