1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
factory_boy
===========
.. image:: https://secure.travis-ci.org/rbarrois/factory_boy.png?branch=master
:target: http://travis-ci.org/rbarrois/factory_boy/
factory_boy is a fixtures replacement based on thoughtbot's `factory_girl <http://github.com/thoughtbot/factory_girl>`_.
Its features include:
- Straightforward syntax
- Support for multiple build strategies (saved/unsaved instances, attribute dicts, stubbed objects)
- Powerful helpers for common cases (sequences, sub-factories, reverse dependencies, circular factories, ...)
- Multiple factories per class support, including inheritance
- Support for various ORMs (currently Django, Mogo)
The official repository is at http://github.com/rbarrois/factory_boy; the documentation at http://readthedocs.org/docs/factoryboy/.
factory_boy supports Python 2.6 and 2.7 (Python 3 is in the works), and requires only the standard Python library.
Download
--------
PyPI: http://pypi.python.org/pypi/factory_boy/
.. code-block:: sh
$ pip install factory_boy
Source: http://github.com/rbarrois/factory_boy/
.. code-block:: sh
$ git clone git://github.com/rbarrois/factory_boy/
$ python setup.py install
Usage
-----
.. note:: This section provides a quick summary of factory_boy features.
A more detailed listing is available in the full documentation.
Defining factories
""""""""""""""""""
Factories declare a set of attributes used to instantiate an object. The class of the object must be defined in the FACTORY_FOR attribute:
.. code-block:: python
import factory
from . import models
class UserFactory(factory.Factory):
FACTORY_FOR = models.User
first_name = 'John'
last_name = 'Doe'
admin = False
# Another, different, factory for the same object
class AdminFactory(factory.Factory):
FACTORY_FOR = models.User
first_name = 'Admin'
last_name = 'User'
admin = True
Using factories
"""""""""""""""
factory_boy supports several different build strategies: build, create, attributes and stub:
.. code-block:: python
# Returns a User instance that's not saved
user = UserFactory.build()
# Returns a saved User instance
user = UserFactory.create()
# Returns a dict of attributes that can be used to build a User instance
attributes = UserFactory.attributes()
You can use the Factory class as a shortcut for the default build strategy:
.. code-block:: python
# Same as UserFactory.create()
user = UserFactory()
No matter which strategy is used, it's possible to override the defined attributes by passing keyword arguments:
.. code-block:: pycon
# Build a User instance and override first_name
>>> user = UserFactory.build(first_name='Joe')
>>> user.first_name
"Joe"
Lazy Attributes
"""""""""""""""
Most factory attributes can be added using static values that are evaluated when the factory is defined,
but some attributes (such as fields whose value is computed from other elements)
will need values assigned each time an instance is generated.
These "lazy" attributes can be added as follows:
.. code-block:: python
class UserFactory(factory.Factory):
FACTORY_FOR = models.User
first_name = 'Joe'
last_name = 'Blow'
email = factory.LazyAttribute(lambda a: '{0}.{1}@example.com'.format(a.first_name, a.last_name).lower())
.. code-block:: pycon
>>> UserFactory().email
"joe.blow@example.com"
Sequences
"""""""""
Unique values in a specific format (for example, e-mail addresses) can be generated using sequences. Sequences are defined by using ``Sequence`` or the decorator ``sequence``:
.. code-block:: python
class UserFactory(factory.Factory):
FACTORY_FOR = models.User
email = factory.Sequence(lambda n: 'person{0}@example.com'.format(n))
>>> UserFactory().email
'person0@example.com'
>>> UserFactory().email
'person1@example.com'
Associations
""""""""""""
Some objects have a complex field, that should itself be defined from a dedicated factories.
This is handled by the ``SubFactory`` helper:
.. code-block:: python
class PostFactory(factory.Factory):
FACTORY_FOR = models.Post
author = factory.SubFactory(UserFactory)
The associated object's strategy will be used:
.. code-block:: python
# Builds and saves a User and a Post
>>> post = PostFactory()
>>> post.id is None # Post has been 'saved'
False
>>> post.author.id is None # post.author has been saved
False
# Builds but does not save a User, and then builds but does not save a Post
>>> post = PostFactory.build()
>>> post.id is None
True
>>> post.author.id is None
True
Contributing
------------
factory_boy is distributed under the MIT License.
Issues should be opened through `GitHub Issues <http://github.com/rbarrois/factory_boy/issues/>`_; whenever possible, a pull request should be included.
All pull request should pass the test suite, which can be launched simply with:
.. code-block:: sh
$ python setup.py test
In order to test coverage, please use:
.. code-block:: sh
$ pip install coverage
$ coverage erase; coverage run --branch setup.py test; coverage report
Contents, indices and tables
----------------------------
.. toctree::
:maxdepth: 2
introduction
reference
orms
recipes
examples
internals
changelog
ideas
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
|