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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
|
Fuzzy attributes
================
.. module:: factory.fuzzy
Some tests may be interested in testing with fuzzy, random values.
This is handled by the :mod:`factory.fuzzy` module, which provides a few
random declarations.
FuzzyAttribute
--------------
.. class:: FuzzyAttribute
The :class:`FuzzyAttribute` uses an arbitrary callable as fuzzer.
It is expected that successive calls of that function return various
values.
.. attribute:: fuzzer
The callable that generates random values
FuzzyText
---------
.. class:: FuzzyText(length=12, chars=string.ascii_letters, prefix='')
The :class:`FuzzyText` fuzzer yields random strings beginning with
the given :attr:`prefix`, followed by :attr:`length` charactes chosen
from the :attr:`chars` character set,
and ending with the given :attr:`suffix`.
.. attribute:: length
int, the length of the random part
.. attribute:: prefix
text, an optional prefix to prepend to the random part
.. attribute:: suffix
text, an optional suffix to append to the random part
.. attribute:: chars
char iterable, the chars to choose from; defaults to the list of ascii
letters and numbers.
FuzzyChoice
-----------
.. class:: FuzzyChoice(choices)
The :class:`FuzzyChoice` fuzzer yields random choices from the given
iterable.
.. note:: The passed in :attr:`choices` will be converted into a list at
declaration time.
.. attribute:: choices
The list of choices to select randomly
FuzzyInteger
------------
.. class:: FuzzyInteger(low[, high[, step]])
The :class:`FuzzyInteger` fuzzer generates random integers within a given
inclusive range.
The :attr:`low` bound may be omitted, in which case it defaults to 0:
.. code-block:: pycon
>>> fi = FuzzyInteger(0, 42)
>>> fi.low, fi.high
0, 42
>>> fi = FuzzyInteger(42)
>>> fi.low, fi.high
0, 42
.. attribute:: low
int, the inclusive lower bound of generated integers
.. attribute:: high
int, the inclusive higher bound of generated integers
.. attribute:: step
int, the step between values in the range; for instance, a ``FuzzyInteger(0, 42, step=3)``
might only yield values from ``[0, 3, 6, 9, 12, 15, 18, 21, 24, 27, 30, 33, 36, 39, 42]``.
FuzzyDecimal
------------
.. class:: FuzzyDecimal(low[, high[, precision=2]])
The :class:`FuzzyDecimal` fuzzer generates random :class:`decimals <decimal.Decimal>` within a given
inclusive range.
The :attr:`low` bound may be omitted, in which case it defaults to 0:
.. code-block:: pycon
>>> FuzzyDecimal(0.5, 42.7)
>>> fi.low, fi.high
0.5, 42.7
>>> fi = FuzzyDecimal(42.7)
>>> fi.low, fi.high
0.0, 42.7
>>> fi = FuzzyDecimal(0.5, 42.7, 3)
>>> fi.low, fi.high, fi.precision
0.5, 42.7, 3
.. attribute:: low
decimal, the inclusive lower bound of generated decimals
.. attribute:: high
decimal, the inclusive higher bound of generated decimals
.. attribute:: precision
int, the number of digits to generate after the dot. The default is 2 digits.
FuzzyFloat
----------
.. class:: FuzzyFloat(low[, high])
The :class:`FuzzyFloat` fuzzer provides random :class:`float` objects within a given inclusive range.
.. code-block:: pycon
>>> FuzzyFloat(0.5, 42.7)
>>> fi.low, fi.high
0.5, 42.7
>>> fi = FuzzyFloat(42.7)
>>> fi.low, fi.high
0.0, 42.7
.. attribute:: low
decimal, the inclusive lower bound of generated floats
.. attribute:: high
decimal, the inclusive higher bound of generated floats
FuzzyDate
---------
.. class:: FuzzyDate(start_date[, end_date])
The :class:`FuzzyDate` fuzzer generates random dates within a given
inclusive range.
The :attr:`end_date` bound may be omitted, in which case it defaults to the current date:
.. code-block:: pycon
>>> fd = FuzzyDate(datetime.date(2008, 1, 1))
>>> fd.start_date, fd.end_date
datetime.date(2008, 1, 1), datetime.date(2013, 4, 16)
.. attribute:: start_date
:class:`datetime.date`, the inclusive lower bound of generated dates
.. attribute:: end_date
:class:`datetime.date`, the inclusive higher bound of generated dates
FuzzyDateTime
-------------
.. class:: FuzzyDateTime(start_dt[, end_dt], tz=UTC, force_year=None, force_month=None, force_day=None, force_hour=None, force_minute=None, force_second=None, force_microsecond=None)
The :class:`FuzzyDateTime` fuzzer generates random timezone-aware datetime within a given
inclusive range.
The :attr:`end_dt` bound may be omitted, in which case it defaults to ``datetime.datetime.now()``
localized into the UTC timezone.
.. code-block:: pycon
>>> fdt = FuzzyDateTime(datetime.datetime(2008, 1, 1, tzinfo=UTC))
>>> fdt.start_dt, fdt.end_dt
datetime.datetime(2008, 1, 1, tzinfo=UTC), datetime.datetime(2013, 4, 21, 19, 13, 32, 458487, tzinfo=UTC)
The ``force_XXX`` keyword arguments force the related value of generated datetimes:
.. code-block:: pycon
>>> fdt = FuzzyDateTime(datetime.datetime(2008, 1, 1, tzinfo=UTC), datetime.datetime(2009, 1, 1, tzinfo=UTC),
... force_day=3, force_second=42)
>>> fdt.evaluate(2, None, False) # Actual code used by ``SomeFactory.build()``
datetime.datetime(2008, 5, 3, 12, 13, 42, 124848, tzinfo=UTC)
.. attribute:: start_dt
:class:`datetime.datetime`, the inclusive lower bound of generated datetimes
.. attribute:: end_dt
:class:`datetime.datetime`, the inclusive upper bound of generated datetimes
.. attribute:: force_year
int or None; if set, forces the :attr:`~datetime.datetime.year` of generated datetime.
.. attribute:: force_month
int or None; if set, forces the :attr:`~datetime.datetime.month` of generated datetime.
.. attribute:: force_day
int or None; if set, forces the :attr:`~datetime.datetime.day` of generated datetime.
.. attribute:: force_hour
int or None; if set, forces the :attr:`~datetime.datetime.hour` of generated datetime.
.. attribute:: force_minute
int or None; if set, forces the :attr:`~datetime.datetime.minute` of generated datetime.
.. attribute:: force_second
int or None; if set, forces the :attr:`~datetime.datetime.second` of generated datetime.
.. attribute:: force_microsecond
int or None; if set, forces the :attr:`~datetime.datetime.microsecond` of generated datetime.
FuzzyNaiveDateTime
------------------
.. class:: FuzzyNaiveDateTime(start_dt[, end_dt], force_year=None, force_month=None, force_day=None, force_hour=None, force_minute=None, force_second=None, force_microsecond=None)
The :class:`FuzzyNaiveDateTime` fuzzer generates random naive datetime within a given
inclusive range.
The :attr:`end_dt` bound may be omitted, in which case it defaults to ``datetime.datetime.now()``:
.. code-block:: pycon
>>> fdt = FuzzyNaiveDateTime(datetime.datetime(2008, 1, 1))
>>> fdt.start_dt, fdt.end_dt
datetime.datetime(2008, 1, 1), datetime.datetime(2013, 4, 21, 19, 13, 32, 458487)
The ``force_XXX`` keyword arguments force the related value of generated datetimes:
.. code-block:: pycon
>>> fdt = FuzzyNaiveDateTime(datetime.datetime(2008, 1, 1), datetime.datetime(2009, 1, 1),
... force_day=3, force_second=42)
>>> fdt.evaluate(2, None, False) # Actual code used by ``SomeFactory.build()``
datetime.datetime(2008, 5, 3, 12, 13, 42, 124848)
.. attribute:: start_dt
:class:`datetime.datetime`, the inclusive lower bound of generated datetimes
.. attribute:: end_dt
:class:`datetime.datetime`, the inclusive upper bound of generated datetimes
.. attribute:: force_year
int or None; if set, forces the :attr:`~datetime.datetime.year` of generated datetime.
.. attribute:: force_month
int or None; if set, forces the :attr:`~datetime.datetime.month` of generated datetime.
.. attribute:: force_day
int or None; if set, forces the :attr:`~datetime.datetime.day` of generated datetime.
.. attribute:: force_hour
int or None; if set, forces the :attr:`~datetime.datetime.hour` of generated datetime.
.. attribute:: force_minute
int or None; if set, forces the :attr:`~datetime.datetime.minute` of generated datetime.
.. attribute:: force_second
int or None; if set, forces the :attr:`~datetime.datetime.second` of generated datetime.
.. attribute:: force_microsecond
int or None; if set, forces the :attr:`~datetime.datetime.microsecond` of generated datetime.
Custom fuzzy fields
-------------------
Alternate fuzzy fields may be defined.
They should inherit from the :class:`BaseFuzzyAttribute` class, and override its
:meth:`~BaseFuzzyAttribute.fuzz` method.
.. class:: BaseFuzzyAttribute
Base class for all fuzzy attributes.
.. method:: fuzz(self)
The method responsible for generating random values.
*Must* be overridden in subclasses.
|
