ORIONIS API REFERENCE

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

Explore modules View classes

orionis.orm.factories.Fake

class documentation

class Fake(_ProviderView): (source)

Constructor: Fake(backend)

View In Hierarchy

Undocumented

Method __getitem__ Select a configured locale without exposing the native generator.
Method __init__ Wrap an independently configured backend without changing its seed.
Method addProvider Register a custom provider and invalidate cached bound methods.
Method format Generate a value from a named camelCase formatter.
Method getFormatter Resolve a provider callable using its public camelCase name.
Method seedInstance Reseed this generator without touching other factory instances.
Method seedLocale Reseed a configured locale's independent generator.
Method setFormatter Install a formatter under its public camelCase provider name.
Class Variable __slots__ Undocumented
Instance Variable _optional Undocumented
Instance Variable _unique Undocumented
Property locales Return the configured backend locales.
Property optional Return the typed camelCase optional-value view.
Property random Return the instance's independent standard-library random generator.
Property unique Return the typed camelCase uniqueness view.

Inherited from _ProviderView:

Method __dir__ List camelCase provider methods available for the selected locale.
Method __getattr__ Return a bound camelCase provider method.
Instance Variable _backend Undocumented
Instance Variable _cache Undocumented
Instance Variable _revision Undocumented
Instance Variable _state Undocumented
def __getitem__(self, locale: str) -> Fake: (source)

Select a configured locale without exposing the native generator.

Parameters
locale:strLocale already configured on this instance.
Returns
FakeThis facade when its single configured locale is selected.
def __init__(self, backend: object): (source)
overrides orionis.orm.factories.fake._ProviderView.__init__

Wrap an independently configured backend without changing its seed.

Parameters
backend:objectFaker-compatible provider instance created by factory infrastructure.
Returns
NoneApply the described operation.
def addProvider(self, provider: object): (source)

Register a custom provider and invalidate cached bound methods.

Parameters
provider:objectProvider class or instance accepted by the data backend.
Returns
NoneApply the described operation.
def format(self, formatter: str, *args: Any, **kwargs: Any) -> Any: (source)

Generate a value from a named camelCase formatter.

Parameters
formatter:strPublic provider method name.
*args:AnyPositional provider arguments.
**kwargs:AnyProvider keyword arguments, retaining snake_case names.
Returns
AnyValue produced by the requested provider method.
def getFormatter(self, name: str) -> Callable[..., Any]: (source)

Resolve a provider callable using its public camelCase name.

Parameters
name:strPublic provider name.
Returns
CallableBound provider callable.
def seedInstance(self, seed: int | None = None): (source)

Reseed this generator without touching other factory instances.

Parameters
seed:int or None, optionalDeterministic integer seed or system entropy.
Returns
NoneApply the described operation.
def seedLocale(self, locale: str, seed: int | None = None): (source)

Reseed a configured locale's independent generator.

Parameters
locale:strConfigured locale to reseed.
seed:int or None, optionalDeterministic integer seed or system entropy.
Returns
NoneApply the described operation.
def setFormatter(self, name: str, formatter: Callable[..., Any]): (source)

Install a formatter under its public camelCase provider name.

Parameters
name:strPublic camelCase name, with no underscores.
formatter:CallableCallable accepting the desired provider arguments.
Returns
NoneApply the described operation.
Raises
ValueErrorIf the name is not a public camelCase identifier.
TypeErrorIf formatter is not callable.
__slots__: tuple[str, ...] = (source)
overrides orionis.orm.factories.fake._ProviderView.__slots__

Undocumented

_optional: OptionalFake | None = (source)

Undocumented

_unique: UniqueFake | None = (source)

Undocumented

locales: list[str] = (source)

Return the configured backend locales.

Returns
list of strDetached list of configured locales.
optional: OptionalFake = (source)

Return the typed camelCase optional-value view.

Returns
OptionalFakeStable view accepting a prob keyword on provider calls.
random: Random = (source)

Return the instance's independent standard-library random generator.

Returns
RandomRandom generator owned by this backend instance.
unique: UniqueFake = (source)

Return the typed camelCase uniqueness view.

Returns
UniqueFakeStable view retaining the instance's unique history.