factory_boy API reference
64 public APIs from factory_boy (FactoryBoy/factory_boy) — 52 classes, 3 functions, 9 methods. Signatures extracted by static analysis of the actual source.
Repository: FactoryBoy/factory_boy
| Kind | Count |
|---|---|
| Classes | 52 |
| Functions | 3 |
| Methods | 9 |
API list
class
factory.alchemy.SQLAlchemyModelFactoryFactory for SQLAlchemy models.
class
factory.base.BaseDictFactoryFactory for dictionary-like classes.
class
factory.base.BaseFactoryFactory base support for sequences, attributes and stubs.
method
factory.base.BaseFactory.generate(strategy, **kwargs)Generate a new instance.
method
factory.base.BaseFactory.generate_batch(strategy, size, **kwargs)Generate a batch of instances.
method
factory.base.BaseFactory.reset_sequence(value=None, force=False)Reset the sequence counter.
method
factory.base.BaseFactory.simple_generate(create, **kwargs)Generate a new instance.
class
factory.base.BaseListFactoryFactory for list-like classes.
class
factory.base.FactoryFactory base with build and create support.
class
factory.base.FactoryMetaClassFactory metaclass for handling ordered declarations.
class
factory.base.OptionDefaultThe default for an option.
class
factory.base.StubObjectA generic container.
func
factory.base.use_strategy(new_strategy)Force the use of a different strategy.
class
factory.builder.DeclarationSetA set of declarations, including the recursive parameters.
class
factory.builder.ResolverResolve a set of declarations.
class
factory.builder.StepBuilderA factory instantiation step.
method
factory.builder.StepBuilder.build(parent_step=None, force_sequence=None)Build a factory instance.
method
factory.builder.StepBuilder.recurse(factory_meta, extras)Recurse into a sub-factory call.
class
factory.declarations.BaseDeclarationA factory declaration.
method
factory.declarations.BaseDeclaration.evaluate(instance, step, extra)Evaluate this declaration.
class
factory.declarations.DictFill a dict with usual declarations.
class
factory.declarations.IteratorFill this value using the values returned by an iterator.
method
factory.declarations.Iterator.reset()Reset the internal iterator.
class
factory.declarations.LazyAttributeSpecific BaseDeclaration computed using a lambda.
class
factory.declarations.LazyAttributeSequenceComposite of a LazyAttribute and a Sequence.
class
factory.declarations.ListFill a list with standard declarations.
class
factory.declarations.OrderedDeclarationCompatibility
class
factory.declarations.ParameterA complex parameter, to be used in a Factory.Params section.
class
factory.declarations.ParameteredAttributeBase class for attributes expecting parameters.
class
factory.declarations.PostGenerationCalls a given function once the object has been generated.
class
factory.declarations.PostGenerationMethodCallCalls a method of the generated object.
class
factory.declarations.RelatedFactoryCalls a factory once the object has been generated.
class
factory.declarations.SelfAttributeSpecific BaseDeclaration copying values from other fields.
class
factory.declarations.SequenceSpecific BaseDeclaration to use for 'sequenced' fields.
class
factory.declarations.SubFactoryBase class for attributes based upon a sub-factory.
class
factory.declarations.Transformer.ForceBypass a transformer's transformation.
class
factory.django.DjangoModelFactoryFactory for Django models.
class
factory.django.FileFieldHelper to fill in django.db.models.FileField from a Factory.
method
factory.django.FileField.evaluate(instance, step, extra)Fill in the field.
func
factory.django.get_model(app, model)Wrapper around django's get_model.
class
factory.django.mute_signalsTemporarily disables and then restores any django signals.
class
factory.errors.AssociatedClassErrorException for Factory subclasses lacking Meta.model.
class
factory.errors.CyclicDefinitionErrorRaised when a cyclical declaration occurs.
class
factory.errors.FactoryErrorAny exception raised by factory_boy.
class
factory.errors.InvalidDeclarationErrorRaised when a sub-declaration has no related declaration.
class
factory.errors.UnknownStrategyRaised when a factory uses an unknown strategy.
class
factory.faker.FakerWrapper for 'faker' values.
class
factory.fuzzy.BaseFuzzyAttributeBase class for fuzzy attributes.
class
factory.fuzzy.BaseFuzzyDateTimeBase class for fuzzy datetime-related attributes.
class
factory.fuzzy.FuzzyAttributeSimilar to LazyAttribute, but yields random values.
class
factory.fuzzy.FuzzyChoiceHandles fuzzy choice of an attribute.
class
factory.fuzzy.FuzzyDateRandom date within a given date range.
class
factory.fuzzy.FuzzyDateTimeRandom timezone-aware datetime within a given range.
class
factory.fuzzy.FuzzyDecimalRandom decimal within a given range.
class
factory.fuzzy.FuzzyFloatRandom float within a given range.
class
factory.fuzzy.FuzzyIntegerRandom integer within a given range.
class
factory.fuzzy.FuzzyNaiveDateTimeRandom naive datetime within a given range.
class
factory.fuzzy.FuzzyTextRandom string with a given prefix.
class
factory.mogo.MogoFactoryFactory for mogo objects.
class
factory.mongoengine.MongoEngineFactoryFactory for mongoengine objects.
class
factory.utils.OrderedBaseMarks a class as being ordered.
class
factory.utils.ResetableIteratorAn iterator wrapper that can be 'reset()' to its start.
class
factory.utils.log_pprintHelper for properly printing args / kwargs passed to an object.
func
factory.utils.sort_ordered_objects(items, getter=lambda x: x)Sort an iterable of OrderedBase instances.
About this data
These signatures were extracted from the public source of FactoryBoy/factory_boy
using Python's ast module. Argument names, default values,
type annotations and return types are taken verbatim from the code.
Implementation bodies are never stored. See
how it works for details.