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
|
# Copyright: See the LICENSE file.
"""Additional declarations for "fuzzy" attribute definitions."""
import datetime
import decimal
import string
import warnings
from . import declarations, random
random_seed_warning = (
"Setting a specific random seed for {} can still have varying results "
"unless you also set a specific end date. For details and potential solutions "
"see https://github.com/FactoryBoy/factory_boy/issues/331"
)
class BaseFuzzyAttribute(declarations.BaseDeclaration):
"""Base class for fuzzy attributes.
Custom fuzzers should override the `fuzz()` method.
"""
def fuzz(self): # pragma: no cover
raise NotImplementedError()
def evaluate(self, instance, step, extra):
return self.fuzz()
class FuzzyAttribute(BaseFuzzyAttribute):
"""Similar to LazyAttribute, but yields random values.
Attributes:
function (callable): function taking no parameters and returning a
random value.
"""
def __init__(self, fuzzer):
super().__init__()
self.fuzzer = fuzzer
def fuzz(self):
return self.fuzzer()
class FuzzyText(BaseFuzzyAttribute):
"""Random string with a given prefix.
Generates a random string of the given length from chosen chars.
If a prefix or a suffix are supplied, they will be prepended / appended
to the generated string.
Args:
prefix (text): An optional prefix to prepend to the random string
length (int): the length of the random part
suffix (text): An optional suffix to append to the random string
chars (str list): the chars to choose from
Useful for generating unique attributes where the exact value is
not important.
"""
def __init__(self, prefix='', length=12, suffix='', chars=string.ascii_letters):
super().__init__()
self.prefix = prefix
self.suffix = suffix
self.length = length
self.chars = tuple(chars) # Unroll iterators
def fuzz(self):
chars = [random.randgen.choice(self.chars) for _i in range(self.length)]
return self.prefix + ''.join(chars) + self.suffix
class FuzzyChoice(BaseFuzzyAttribute):
"""Handles fuzzy choice of an attribute.
Args:
choices (iterable): An iterable yielding options; will only be unrolled
on the first call.
getter (callable or None): a function to parse returned values
"""
def __init__(self, choices, getter=None):
self.choices = None
self.choices_generator = choices
self.getter = getter
super().__init__()
def fuzz(self):
if self.choices is None:
self.choices = list(self.choices_generator)
value = random.randgen.choice(self.choices)
if self.getter is None:
return value
return self.getter(value)
class FuzzyInteger(BaseFuzzyAttribute):
"""Random integer within a given range."""
def __init__(self, low, high=None, step=1):
if high is None:
high = low
low = 0
self.low = low
self.high = high
self.step = step
super().__init__()
def fuzz(self):
return random.randgen.randrange(self.low, self.high + 1, self.step)
class FuzzyDecimal(BaseFuzzyAttribute):
"""Random decimal within a given range."""
def __init__(self, low, high=None, precision=2):
if high is None:
high = low
low = 0.0
self.low = low
self.high = high
self.precision = precision
super().__init__()
def fuzz(self):
base = decimal.Decimal(str(random.randgen.uniform(self.low, self.high)))
return base.quantize(decimal.Decimal(10) ** -self.precision)
class FuzzyFloat(BaseFuzzyAttribute):
"""Random float within a given range."""
def __init__(self, low, high=None, precision=15):
if high is None:
high = low
low = 0
self.low = low
self.high = high
self.precision = precision
super().__init__()
def fuzz(self):
base = random.randgen.uniform(self.low, self.high)
return float(format(base, '.%dg' % self.precision))
class FuzzyDate(BaseFuzzyAttribute):
"""Random date within a given date range."""
def __init__(self, start_date, end_date=None):
super().__init__()
if end_date is None:
if random.randgen.state_set:
cls_name = self.__class__.__name__
warnings.warn(random_seed_warning.format(cls_name), stacklevel=2)
end_date = datetime.date.today()
if start_date > end_date:
raise ValueError(
"FuzzyDate boundaries should have start <= end; got %r > %r."
% (start_date, end_date))
self.start_date = start_date.toordinal()
self.end_date = end_date.toordinal()
def fuzz(self):
return datetime.date.fromordinal(random.randgen.randint(self.start_date, self.end_date))
class BaseFuzzyDateTime(BaseFuzzyAttribute):
"""Base class for fuzzy datetime-related attributes.
Provides fuzz() computation, forcing year/month/day/hour/...
"""
def _check_bounds(self, start_dt, end_dt):
if start_dt > end_dt:
raise ValueError(
"""%s boundaries should have start <= end, got %r > %r""" % (
self.__class__.__name__, start_dt, end_dt))
def _now(self):
raise NotImplementedError()
def __init__(self, start_dt, end_dt=None,
force_year=None, force_month=None, force_day=None,
force_hour=None, force_minute=None, force_second=None,
force_microsecond=None):
super().__init__()
if end_dt is None:
if random.randgen.state_set:
cls_name = self.__class__.__name__
warnings.warn(random_seed_warning.format(cls_name), stacklevel=2)
end_dt = self._now()
self._check_bounds(start_dt, end_dt)
self.start_dt = start_dt
self.end_dt = end_dt
self.force_year = force_year
self.force_month = force_month
self.force_day = force_day
self.force_hour = force_hour
self.force_minute = force_minute
self.force_second = force_second
self.force_microsecond = force_microsecond
def fuzz(self):
delta = self.end_dt - self.start_dt
microseconds = delta.microseconds + 1000000 * (delta.seconds + (delta.days * 86400))
offset = random.randgen.randint(0, microseconds)
result = self.start_dt + datetime.timedelta(microseconds=offset)
if self.force_year is not None:
result = result.replace(year=self.force_year)
if self.force_month is not None:
result = result.replace(month=self.force_month)
if self.force_day is not None:
result = result.replace(day=self.force_day)
if self.force_hour is not None:
result = result.replace(hour=self.force_hour)
if self.force_minute is not None:
result = result.replace(minute=self.force_minute)
if self.force_second is not None:
result = result.replace(second=self.force_second)
if self.force_microsecond is not None:
result = result.replace(microsecond=self.force_microsecond)
return result
class FuzzyNaiveDateTime(BaseFuzzyDateTime):
"""Random naive datetime within a given range.
If no upper bound is given, will default to datetime.datetime.now().
"""
def _now(self):
return datetime.datetime.now()
def _check_bounds(self, start_dt, end_dt):
if start_dt.tzinfo is not None:
raise ValueError(
"FuzzyNaiveDateTime only handles naive datetimes, got start=%r"
% start_dt)
if end_dt.tzinfo is not None:
raise ValueError(
"FuzzyNaiveDateTime only handles naive datetimes, got end=%r"
% end_dt)
super()._check_bounds(start_dt, end_dt)
class FuzzyDateTime(BaseFuzzyDateTime):
"""Random timezone-aware datetime within a given range.
If no upper bound is given, will default to datetime.datetime.now()
If no timezone is given, will default to utc.
"""
def _now(self):
return datetime.datetime.now(tz=datetime.timezone.utc)
def _check_bounds(self, start_dt, end_dt):
if start_dt.tzinfo is None:
raise ValueError(
"FuzzyDateTime requires timezone-aware datetimes, got start=%r"
% start_dt)
if end_dt.tzinfo is None:
raise ValueError(
"FuzzyDateTime requires timezone-aware datetimes, got end=%r"
% end_dt)
super()._check_bounds(start_dt, end_dt)
|