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
|
# -*- coding: utf-8 -*-
# Copyright (c) 2010 Mark Sandstrom
# Copyright (c) 2011-2013 Raphaël Barrois
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
from __future__ import absolute_import
from __future__ import unicode_literals
import os
"""factory_boy extensions for use with the Django framework."""
try:
from django.core import files as django_files
except ImportError as e: # pragma: no cover
django_files = None
import_failure = e
from . import base
from . import declarations
class DjangoModelFactory(base.Factory):
"""Factory for Django models.
This makes sure that the 'sequence' field of created objects is a new id.
Possible improvement: define a new 'attribute' type, AutoField, which would
handle those for non-numerical primary keys.
"""
ABSTRACT_FACTORY = True
FACTORY_DJANGO_GET_OR_CREATE = ()
@classmethod
def _get_manager(cls, target_class):
try:
return target_class._default_manager # pylint: disable=W0212
except AttributeError:
return target_class.objects
@classmethod
def _setup_next_sequence(cls):
"""Compute the next available PK, based on the 'pk' database field."""
model = cls._associated_class # pylint: disable=E1101
manager = cls._get_manager(model)
try:
return 1 + manager.values_list('pk', flat=True
).order_by('-pk')[0]
except (IndexError, TypeError):
# IndexError: No instance exist yet
# TypeError: pk isn't an integer type
return 1
@classmethod
def _get_or_create(cls, target_class, *args, **kwargs):
"""Create an instance of the model through objects.get_or_create."""
manager = cls._get_manager(target_class)
assert 'defaults' not in cls.FACTORY_DJANGO_GET_OR_CREATE, (
"'defaults' is a reserved keyword for get_or_create "
"(in %s.FACTORY_DJANGO_GET_OR_CREATE=%r)"
% (cls, cls.FACTORY_DJANGO_GET_OR_CREATE))
key_fields = {}
for field in cls.FACTORY_DJANGO_GET_OR_CREATE:
key_fields[field] = kwargs.pop(field)
key_fields['defaults'] = kwargs
obj, _created = manager.get_or_create(*args, **key_fields)
return obj
@classmethod
def _create(cls, target_class, *args, **kwargs):
"""Create an instance of the model, and save it to the database."""
manager = cls._get_manager(target_class)
if cls.FACTORY_DJANGO_GET_OR_CREATE:
return cls._get_or_create(target_class, *args, **kwargs)
return manager.create(*args, **kwargs)
@classmethod
def _after_postgeneration(cls, obj, create, results=None):
"""Save again the instance if creating and at least one hook ran."""
if create and results:
# Some post-generation hooks ran, and may have modified us.
obj.save()
class FileField(declarations.PostGenerationDeclaration):
"""Helper to fill in django.db.models.FileField from a Factory."""
def __init__(self, *args, **kwargs):
if django_files is None: # pragma: no cover
raise import_failure
super(FileField, self).__init__(*args, **kwargs)
def _make_content(self, extraction_context):
path = ''
params = extraction_context.extra
if params.get('from_path') and params.get('from_file'):
raise ValueError(
"At most one argument from 'from_file' and 'from_path' should "
"be non-empty when calling factory.django.FileField."
)
if extraction_context.did_extract:
# Should be a django.core.files.File
content = extraction_context.value
path = content.name
elif params.get('from_path'):
path = params['from_path']
f = open(path, 'rb')
content = django_files.File(f, name=path)
elif params.get('from_file'):
f = params['from_file']
content = django_files.File(f)
path = content.name
else:
data = params.get('data', '')
content = django_files.base.ContentFile(data)
if path:
default_filename = os.path.basename(path)
else:
default_filename = 'example.dat'
filename = params.get('filename', default_filename)
return filename, content
def call(self, obj, create, extraction_context):
"""Fill in the field."""
if extraction_context.did_extract and extraction_context.value is None:
# User passed an empty value, don't fill
return
filename, content = self._make_content(extraction_context)
field_file = getattr(obj, extraction_context.for_field)
try:
field_file.save(filename, content, save=create)
finally:
content.file.close()
return field_file
|