/usr/lib/python2.7/dist-packages/factory/declarations.py is in python-factory-boy 2.8.1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 | # -*- coding: utf-8 -*-
# Copyright (c) 2010 Mark Sandstrom
# Copyright (c) 2011-2015 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 unicode_literals
import itertools
import logging
from . import compat
from . import utils
logger = logging.getLogger('factory.generate')
class OrderedDeclaration(object):
"""A factory declaration.
Ordered declarations mark an attribute as needing lazy evaluation.
This allows them to refer to attributes defined by other OrderedDeclarations
in the same factory.
"""
def evaluate(self, sequence, obj, create, extra=None, containers=()):
"""Evaluate this declaration.
Args:
sequence (int): the current sequence counter to use when filling
the current instance
obj (containers.LazyStub): The object holding currently computed
attributes
containers (list of containers.LazyStub): The chain of SubFactory
which led to building this object.
create (bool): whether the model class should be 'built' or
'created'
extra (DeclarationDict or None): extracted key/value extracted from
the attribute prefix
"""
raise NotImplementedError('This is an abstract method')
class LazyFunction(OrderedDeclaration):
"""Simplest OrderedDeclaration computed by calling the given function.
Attributes:
function (function): a function without arguments and
returning the computed value.
"""
def __init__(self, function, *args, **kwargs):
super(LazyFunction, self).__init__(*args, **kwargs)
self.function = function
def evaluate(self, sequence, obj, create, extra=None, containers=()):
logger.debug("LazyFunction: Evaluating %s on %s", utils.log_repr(self.function), utils.log_repr(obj))
return self.function()
class LazyAttribute(OrderedDeclaration):
"""Specific OrderedDeclaration computed using a lambda.
Attributes:
function (function): a function, expecting the current LazyStub and
returning the computed value.
"""
def __init__(self, function, *args, **kwargs):
super(LazyAttribute, self).__init__(*args, **kwargs)
self.function = function
def evaluate(self, sequence, obj, create, extra=None, containers=()):
logger.debug("LazyAttribute: Evaluating %s on %s", utils.log_repr(self.function), utils.log_repr(obj))
return self.function(obj)
class _UNSPECIFIED(object):
pass
def deepgetattr(obj, name, default=_UNSPECIFIED):
"""Try to retrieve the given attribute of an object, digging on '.'.
This is an extended getattr, digging deeper if '.' is found.
Args:
obj (object): the object of which an attribute should be read
name (str): the name of an attribute to look up.
default (object): the default value to use if the attribute wasn't found
Returns:
the attribute pointed to by 'name', splitting on '.'.
Raises:
AttributeError: if obj has no 'name' attribute.
"""
try:
if '.' in name:
attr, subname = name.split('.', 1)
return deepgetattr(getattr(obj, attr), subname, default)
else:
return getattr(obj, name)
except AttributeError:
if default is _UNSPECIFIED:
raise
else:
return default
class SelfAttribute(OrderedDeclaration):
"""Specific OrderedDeclaration copying values from other fields.
If the field name starts with two dots or more, the lookup will be anchored
in the related 'parent'.
Attributes:
depth (int): the number of steps to go up in the containers chain
attribute_name (str): the name of the attribute to copy.
default (object): the default value to use if the attribute doesn't
exist.
"""
def __init__(self, attribute_name, default=_UNSPECIFIED, *args, **kwargs):
super(SelfAttribute, self).__init__(*args, **kwargs)
depth = len(attribute_name) - len(attribute_name.lstrip('.'))
attribute_name = attribute_name[depth:]
self.depth = depth
self.attribute_name = attribute_name
self.default = default
def evaluate(self, sequence, obj, create, extra=None, containers=()):
if self.depth > 1:
# Fetching from a parent
target = containers[self.depth - 2]
else:
target = obj
logger.debug("SelfAttribute: Picking attribute %r on %s", self.attribute_name, utils.log_repr(target))
return deepgetattr(target, self.attribute_name, self.default)
def __repr__(self):
return '<%s(%r, default=%r)>' % (
self.__class__.__name__,
self.attribute_name,
self.default,
)
class Iterator(OrderedDeclaration):
"""Fill this value using the values returned by an iterator.
Warning: the iterator should not end !
Attributes:
iterator (iterable): the iterator whose value should be used.
getter (callable or None): a function to parse returned values
"""
def __init__(self, iterator, cycle=True, getter=None):
super(Iterator, self).__init__()
self.getter = getter
self.iterator = None
if cycle:
self.iterator_builder = lambda: utils.ResetableIterator(itertools.cycle(iterator))
else:
self.iterator_builder = lambda: utils.ResetableIterator(iterator)
def evaluate(self, sequence, obj, create, extra=None, containers=()):
# Begin unrolling as late as possible.
# This helps with ResetableIterator(MyModel.objects.all())
if self.iterator is None:
self.iterator = self.iterator_builder()
logger.debug("Iterator: Fetching next value from %s", utils.log_repr(self.iterator))
value = next(iter(self.iterator))
if self.getter is None:
return value
return self.getter(value)
def reset(self):
"""Reset the internal iterator."""
self.iterator.reset()
class Sequence(OrderedDeclaration):
"""Specific OrderedDeclaration to use for 'sequenced' fields.
These fields are typically used to generate increasing unique values.
Attributes:
function (function): A function, expecting the current sequence counter
and returning the computed value.
type (function): A function converting an integer into the expected kind
of counter for the 'function' attribute.
"""
def __init__(self, function, type=int):
super(Sequence, self).__init__()
self.function = function
self.type = type
def evaluate(self, sequence, obj, create, extra=None, containers=()):
logger.debug("Sequence: Computing next value of %r for seq=%s", self.function, sequence)
return self.function(self.type(sequence))
class LazyAttributeSequence(Sequence):
"""Composite of a LazyAttribute and a Sequence.
Attributes:
function (function): A function, expecting the current LazyStub and the
current sequence counter.
type (function): A function converting an integer into the expected kind
of counter for the 'function' attribute.
"""
def evaluate(self, sequence, obj, create, extra=None, containers=()):
logger.debug(
"LazyAttributeSequence: Computing next value of %r for seq=%s, obj=%s",
self.function, sequence, utils.log_repr(obj))
return self.function(obj, self.type(sequence))
class ContainerAttribute(OrderedDeclaration):
"""Variant of LazyAttribute, also receives the containers of the object.
Attributes:
function (function): A function, expecting the current LazyStub and the
(optional) object having a subfactory containing this attribute.
strict (bool): Whether evaluating should fail when the containers are
not passed in (i.e used outside a SubFactory).
"""
def __init__(self, function, strict=True, *args, **kwargs):
super(ContainerAttribute, self).__init__(*args, **kwargs)
self.function = function
self.strict = strict
def evaluate(self, sequence, obj, create, extra=None, containers=()):
"""Evaluate the current ContainerAttribute.
Args:
obj (LazyStub): a lazy stub of the object being constructed, if
needed.
containers (list of LazyStub): a list of lazy stubs of factories
being evaluated in a chain, each item being a future field of
next one.
"""
if self.strict and not containers:
raise TypeError(
"A ContainerAttribute in 'strict' mode can only be used "
"within a SubFactory.")
return self.function(obj, containers)
class ParameteredAttribute(OrderedDeclaration):
"""Base class for attributes expecting parameters.
Attributes:
defaults (dict): Default values for the paramters.
May be overridden by call-time parameters.
Class attributes:
CONTAINERS_FIELD (str): name of the field, if any, where container
information (e.g for SubFactory) should be stored. If empty,
containers data isn't merged into generate() parameters.
"""
CONTAINERS_FIELD = '__containers'
# Whether to add the current object to the stack of containers
EXTEND_CONTAINERS = False
def __init__(self, **kwargs):
super(ParameteredAttribute, self).__init__()
self.defaults = kwargs
def _prepare_containers(self, obj, containers=()):
if self.EXTEND_CONTAINERS:
return (obj,) + tuple(containers)
return containers
def evaluate(self, sequence, obj, create, extra=None, containers=()):
"""Evaluate the current definition and fill its attributes.
Uses attributes definition in the following order:
- values defined when defining the ParameteredAttribute
- additional values defined when instantiating the containing factory
Args:
create (bool): whether the parent factory is being 'built' or
'created'
extra (containers.DeclarationDict): extra values that should
override the defaults
containers (list of LazyStub): List of LazyStub for the chain of
factories being evaluated, the calling stub being first.
"""
defaults = dict(self.defaults)
if extra:
defaults.update(extra)
if self.CONTAINERS_FIELD:
containers = self._prepare_containers(obj, containers)
defaults[self.CONTAINERS_FIELD] = containers
return self.generate(sequence, obj, create, defaults)
def generate(self, sequence, obj, create, params): # pragma: no cover
"""Actually generate the related attribute.
Args:
sequence (int): the current sequence number
obj (LazyStub): the object being constructed
create (bool): whether the calling factory was in 'create' or
'build' mode
params (dict): parameters inherited from init and evaluation-time
overrides.
Returns:
Computed value for the current declaration.
"""
raise NotImplementedError()
class _FactoryWrapper(object):
"""Handle a 'factory' arg.
Such args can be either a Factory subclass, or a fully qualified import
path for that subclass (e.g 'myapp.factories.MyFactory').
"""
def __init__(self, factory_or_path):
self.factory = None
self.module = self.name = ''
if isinstance(factory_or_path, type):
self.factory = factory_or_path
else:
if not (compat.is_string(factory_or_path) and '.' in factory_or_path):
raise ValueError(
"A factory= argument must receive either a class "
"or the fully qualified path to a Factory subclass; got "
"%r instead." % factory_or_path)
self.module, self.name = factory_or_path.rsplit('.', 1)
def get(self):
if self.factory is None:
self.factory = utils.import_object(
self.module,
self.name,
)
return self.factory
def __repr__(self):
if self.factory is None:
return '<_FactoryImport: %s.%s>' % (self.module, self.name)
else:
return '<_FactoryImport: %s>' % self.factory.__class__
class SubFactory(ParameteredAttribute):
"""Base class for attributes based upon a sub-factory.
Attributes:
defaults (dict): Overrides to the defaults defined in the wrapped
factory
factory (base.Factory): the wrapped factory
"""
EXTEND_CONTAINERS = True
def __init__(self, factory, **kwargs):
super(SubFactory, self).__init__(**kwargs)
self.factory_wrapper = _FactoryWrapper(factory)
def get_factory(self):
"""Retrieve the wrapped factory.Factory subclass."""
return self.factory_wrapper.get()
def generate(self, sequence, obj, create, params):
"""Evaluate the current definition and fill its attributes.
Args:
create (bool): whether the subfactory should call 'build' or
'create'
params (containers.DeclarationDict): extra values that should
override the wrapped factory's defaults
"""
subfactory = self.get_factory()
logger.debug(
"SubFactory: Instantiating %s.%s(%s), create=%r",
subfactory.__module__, subfactory.__name__,
utils.log_pprint(kwargs=params),
create,
)
return subfactory.simple_generate(create, **params)
class Dict(SubFactory):
"""Fill a dict with usual declarations."""
def __init__(self, params, dict_factory='factory.DictFactory'):
super(Dict, self).__init__(dict_factory, **dict(params))
def generate(self, sequence, obj, create, params):
dict_factory = self.get_factory()
logger.debug("Dict: Building dict(%s)", utils.log_pprint(kwargs=params))
return dict_factory.simple_generate(
create,
__sequence=sequence,
**params)
class List(SubFactory):
"""Fill a list with standard declarations."""
def __init__(self, params, list_factory='factory.ListFactory'):
params = dict((str(i), v) for i, v in enumerate(params))
super(List, self).__init__(list_factory, **params)
def generate(self, sequence, obj, create, params):
list_factory = self.get_factory()
logger.debug(
"List: Building list(%s)",
utils.log_pprint(args=[v for _i, v in sorted(params.items())]),
)
return list_factory.simple_generate(
create,
__sequence=sequence,
**params)
# Parameters
# ==========
class ComplexParameter(object):
"""A complex parameter, to be used in a Factory.Params section.
Must implement:
- A "compute" function, performing the actual declaration override
- Optionally, a get_revdeps() function (to compute other parameters it may alter)
"""
def compute(self, field_name, declarations):
"""Compute the overrides for this parameter.
Args:
- field_name (str): the field this parameter is installed at
- declarations (dict): the global factory declarations
Returns:
dict: the declarations to override
"""
raise NotImplementedError()
def get_revdeps(self, parameters):
"""Retrieve the list of other parameters modified by this one."""
return []
class Trait(ComplexParameter):
"""The simplest complex parameter, it enables a bunch of new declarations based on a boolean flag."""
def __init__(self, **overrides):
self.overrides = overrides
def compute(self, field_name, declarations):
if declarations.get(field_name):
return self.overrides
else:
return {}
def get_revdeps(self, parameters):
"""This might alter fields it's injecting."""
return [param for param in parameters if param in self.overrides]
# Post-generation
# ===============
class ExtractionContext(object):
"""Private class holding all required context from extraction to postgen."""
def __init__(self, value=None, did_extract=False, extra=None, for_field=''):
self.value = value
self.did_extract = did_extract
self.extra = extra or {}
self.for_field = for_field
def __repr__(self):
return 'ExtractionContext(%r, %r, %r)' % (
self.value,
self.did_extract,
self.extra,
)
class PostGenerationDeclaration(object):
"""Declarations to be called once the model object has been generated."""
creation_counter = 0
"""Global creation counter of the declaration."""
def __init__(self, *args, **kwargs):
self.creation_counter = PostGenerationDeclaration.creation_counter
PostGenerationDeclaration.creation_counter += 1
def extract(self, name, attrs):
"""Extract relevant attributes from a dict.
Args:
name (str): the name at which this PostGenerationDeclaration was
defined in the declarations
attrs (dict): the attribute dict from which values should be
extracted
Returns:
(object, dict): a tuple containing the attribute at 'name' (if
provided) and a dict of extracted attributes
"""
try:
extracted = attrs.pop(name)
did_extract = True
except KeyError:
extracted = None
did_extract = False
kwargs = utils.extract_dict(name, attrs)
return ExtractionContext(extracted, did_extract, kwargs, name)
def call(self, obj, create, extraction_context): # pragma: no cover
"""Call this hook; no return value is expected.
Args:
obj (object): the newly generated object
create (bool): whether the object was 'built' or 'created'
extraction_context: An ExtractionContext containing values
extracted from the containing factory's declaration
"""
raise NotImplementedError()
class PostGeneration(PostGenerationDeclaration):
"""Calls a given function once the object has been generated."""
def __init__(self, function):
super(PostGeneration, self).__init__()
self.function = function
def call(self, obj, create, extraction_context):
logger.debug(
"PostGeneration: Calling %s.%s(%s)",
self.function.__module__,
self.function.__name__,
utils.log_pprint(
(obj, create, extraction_context.value),
extraction_context.extra,
),
)
return self.function(
obj, create,
extraction_context.value, **extraction_context.extra)
class RelatedFactory(PostGenerationDeclaration):
"""Calls a factory once the object has been generated.
Attributes:
factory (Factory): the factory to call
defaults (dict): extra declarations for calling the related factory
name (str): the name to use to refer to the generated object when
calling the related factory
"""
def __init__(self, factory, factory_related_name='', **defaults):
super(RelatedFactory, self).__init__()
self.name = factory_related_name
self.defaults = defaults
self.factory_wrapper = _FactoryWrapper(factory)
def get_factory(self):
"""Retrieve the wrapped factory.Factory subclass."""
return self.factory_wrapper.get()
def call(self, obj, create, extraction_context):
factory = self.get_factory()
if extraction_context.did_extract:
# The user passed in a custom value
logger.debug(
"RelatedFactory: Using provided %s instead of generating %s.%s.",
utils.log_repr(extraction_context.value),
factory.__module__, factory.__name__,
)
return extraction_context.value
passed_kwargs = dict(self.defaults)
passed_kwargs.update(extraction_context.extra)
if self.name:
passed_kwargs[self.name] = obj
logger.debug(
"RelatedFactory: Generating %s.%s(%s)",
factory.__module__,
factory.__name__,
utils.log_pprint((create,), passed_kwargs),
)
return factory.simple_generate(create, **passed_kwargs)
class PostGenerationMethodCall(PostGenerationDeclaration):
"""Calls a method of the generated object.
Attributes:
method_name (str): the method to call
method_args (list): arguments to pass to the method
method_kwargs (dict): keyword arguments to pass to the method
Example:
class UserFactory(factory.Factory):
...
password = factory.PostGenerationMethodCall('set_pass', password='')
"""
def __init__(self, method_name, *args, **kwargs):
super(PostGenerationMethodCall, self).__init__()
self.method_name = method_name
self.method_args = args
self.method_kwargs = kwargs
def call(self, obj, create, extraction_context):
if not extraction_context.did_extract:
passed_args = self.method_args
elif len(self.method_args) <= 1:
# Max one argument expected
passed_args = (extraction_context.value,)
else:
passed_args = tuple(extraction_context.value)
passed_kwargs = dict(self.method_kwargs)
passed_kwargs.update(extraction_context.extra)
method = getattr(obj, self.method_name)
logger.debug(
"PostGenerationMethodCall: Calling %s.%s(%s)",
utils.log_repr(obj),
self.method_name,
utils.log_pprint(passed_args, passed_kwargs),
)
return method(*passed_args, **passed_kwargs)
|