Faker: providers M–P

This reference covers 151 facade names in the M-P range. The whole catalog contains 675 typed methods (694 signatures including overloads) and 7 backend helpers accessible at runtime, organized alphabetically. Availability was checked against the installed backend’s 110 locales; some methods only exist for specific locales.

Preparing examples

Examples generate values in memory. They neither create tables nor insert records. Define this factory once, then use snippets inside its definition(), a seeder or a service/controller as shown in Faker and simulated data.

from orionis.orm import Integer, Model, String
from orionis.orm.factories import Factory


class SampleRecord(Model):
    id = Integer().primary().autoIncrement()
    value = String(180)
    timestamps = False
    fillable = ["value"]


class SampleFactory(Factory[SampleRecord]):
    model = SampleRecord

    def definition(self):
        return {"value": self.fake.word()}

Each entry selects a verified compatible locale, presents the typed contract and the backend’s actual defaults. ... in a typed signature means the stub does not specify that default, not a value to pass. Runtime signatures show concrete defaults. Locale variants are distinguished when they differ; examples retain native parameter names while facade methods use camelCase.

Types T and TEnum preserve received value/Enum types; Callable, Iterable, Sequence, Collection, Any, Decimal, UUID and datetime types belong to the provider’s Python contract. Optional permits None and Literal restricts concrete values. Results are not automatically converted to ORM attributes or JSON: apply the appropriate cast/encoder.

Methods ordinarily propagate backend parameter errors (TypeError, ValueError, formatting errors). If a locale does not publish a name, the facade raises AttributeError. image and xml need specific dependencies explained in their entries. See the usage guide for unique and optional; unhashable results can prevent uniqueness checks. No claim is made that every method exists for every locale.

Catalog index

A-D · E-H · I-L · M-P · Q-T · U-Z

macAddress

macAddress generates Internet addresses and formats for test data; generating a string does not open a connection.

Orionis typed contract:

def macAddress(multicast: bool=...) -> str

Actual signature for en_US:

fake.macAddress(multicast: bool = False) -> str

Parameter	Purpose
multicast	Controls the MAC multicast bit.

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.macAddress()

macPlatformToken

macPlatformToken generates User-Agent strings and components for simulated clients.

Orionis typed contract:

def macPlatformToken() -> str

Actual signature for en_US:

fake.macPlatformToken() -> str

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.macPlatformToken()

macProcessor

macProcessor generates User-Agent strings and components for simulated clients.

Orionis typed contract:

def macProcessor() -> str

Actual signature for en_US:

fake.macProcessor() -> str

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.macProcessor()

md5

MD5 digest of random data for fixtures; does not replace the Hash facade for passwords.

Orionis typed contract:

def md5() -> str
def md5(raw_output: Literal[True]) -> bytes
def md5(raw_output: Literal[False]) -> str

Actual signature for en_US:

fake.md5(raw_output: bool = False) -> bytes | str

Parameter	Purpose
raw_output	Requests binary/native output rather than usual text.

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.md5()

metroManilaAddress

metroManilaAddress generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def metroManilaAddress() -> str

Actual signature for en_PH:

fake.metroManilaAddress() -> str

Verified availability: 3 locales. Example locales: en_PH, fil_PH, tl_PH.

fake = SampleFactory(locale="en_PH", seed=7).fake
value = fake.metroManilaAddress()

metroManilaLgu

metroManilaLgu generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def metroManilaLgu() -> str

Actual signature for en_PH:

fake.metroManilaLgu() -> str

Verified availability: 3 locales. Example locales: en_PH, fil_PH, tl_PH.

fake = SampleFactory(locale="en_PH", seed=7).fake
value = fake.metroManilaLgu()

metroManilaPostcode

metroManilaPostcode generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def metroManilaPostcode() -> str

Actual signature for en_PH:

fake.metroManilaPostcode() -> str

Verified availability: 3 locales. Example locales: en_PH, fil_PH, tl_PH.

fake = SampleFactory(locale="en_PH", seed=7).fake
value = fake.metroManilaPostcode()

metropolitanCity

metropolitanCity generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def metropolitanCity() -> str

Actual signature for ko_KR:

fake.metropolitanCity() -> str

Verified availability: 1 locales. Example locales: ko_KR.

fake = SampleFactory(locale="ko_KR", seed=7).fake
value = fake.metropolitanCity()

middleName

middleName generates names and identity components for test profiles.

Orionis typed contract:

def middleName() -> str

Actual signature for is_IS:

fake.middleName() -> str

Verified availability: 5 locales. Example locales: is_IS, or_IN, ru_RU, uk_UA, vi_VN.

fake = SampleFactory(locale="is_IS", seed=7).fake
value = fake.middleName()

middleNameFemale

middleNameFemale generates names and identity components for test profiles.

Orionis typed contract:

def middleNameFemale() -> str

Actual signature for ru_RU:

fake.middleNameFemale() -> str

Verified availability: 2 locales. Example locales: ru_RU, uk_UA.

fake = SampleFactory(locale="ru_RU", seed=7).fake
value = fake.middleNameFemale()

middleNameMale

middleNameMale generates names and identity components for test profiles.

Orionis typed contract:

def middleNameMale() -> str

Actual signature for ru_RU:

fake.middleNameMale() -> str

Verified availability: 2 locales. Example locales: ru_RU, uk_UA.

fake = SampleFactory(locale="ru_RU", seed=7).fake
value = fake.middleNameMale()

militaryApo

militaryApo generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def militaryApo() -> str

Actual signature for en_US:

fake.militaryApo() -> str

Verified availability: 45 locales. Example locales: en_US, am_ET, ar_AA, ar_AE, ar_BH, ar_EG, ar_JO, ar_PS.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.militaryApo()

militaryDpo

militaryDpo generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def militaryDpo() -> str

Actual signature for en_US:

fake.militaryDpo() -> str

Verified availability: 45 locales. Example locales: en_US, am_ET, ar_AA, ar_AE, ar_BH, ar_EG, ar_JO, ar_PS.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.militaryDpo()

militaryShip

militaryShip generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def militaryShip() -> str

Actual signature for en_US:

fake.militaryShip() -> str

Verified availability: 45 locales. Example locales: en_US, am_ET, ar_AA, ar_AE, ar_BH, ar_EG, ar_JO, ar_PS.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.militaryShip()

militaryState

militaryState generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def militaryState() -> str

Actual signature for en_US:

fake.militaryState() -> str

Verified availability: 45 locales. Example locales: en_US, am_ET, ar_AA, ar_AE, ar_BH, ar_EG, ar_JO, ar_PS.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.militaryState()

mimeType

mimeType generates fictional filenames, paths and media types; it does not create files on disk.

Orionis typed contract:

def mimeType(category: str | None=...) -> str

Actual signature for en_US:

fake.mimeType(category: str | None = None) -> str

Parameter	Purpose
category	Provider data category.

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.mimeType()

mindanaoProvince

mindanaoProvince generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def mindanaoProvince() -> str

Actual signature for en_PH:

fake.mindanaoProvince() -> str

Verified availability: 3 locales. Example locales: en_PH, fil_PH, tl_PH.

fake = SampleFactory(locale="en_PH", seed=7).fake
value = fake.mindanaoProvince()

mindanaoProvinceAddress

mindanaoProvinceAddress generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def mindanaoProvinceAddress() -> str

Actual signature for en_PH:

fake.mindanaoProvinceAddress() -> str

Verified availability: 3 locales. Example locales: en_PH, fil_PH, tl_PH.

fake = SampleFactory(locale="en_PH", seed=7).fake
value = fake.mindanaoProvinceAddress()

mindanaoProvincePostcode

mindanaoProvincePostcode generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def mindanaoProvincePostcode() -> str

Actual signature for en_PH:

fake.mindanaoProvincePostcode() -> str

Verified availability: 3 locales. Example locales: en_PH, fil_PH, tl_PH.

fake = SampleFactory(locale="en_PH", seed=7).fake
value = fake.mindanaoProvincePostcode()

minguoYear

minguoYear generates dates, times and intervals for temporal fixtures.

Orionis typed contract:

def minguoYear() -> str

Actual signature for zh_TW:

fake.minguoYear() -> str

Verified availability: 1 locales. Example locales: zh_TW.

fake = SampleFactory(locale="zh_TW", seed=7).fake
value = fake.minguoYear()

miscArea2LandlineNumber

miscArea2LandlineNumber generates fictional telephone numbers in local formats.

Orionis typed contract:

def miscArea2LandlineNumber() -> str

Actual signature for en_PH:

fake.miscArea2LandlineNumber() -> str

Verified availability: 3 locales. Example locales: en_PH, fil_PH, tl_PH.

fake = SampleFactory(locale="en_PH", seed=7).fake
value = fake.miscArea2LandlineNumber()

miscLandlineIdentifier

miscLandlineIdentifier generates fictional telephone numbers in local formats.

Orionis typed contract:

def miscLandlineIdentifier() -> str

Actual signature for en_PH:

fake.miscLandlineIdentifier() -> str

Verified availability: 3 locales. Example locales: en_PH, fil_PH, tl_PH.

fake = SampleFactory(locale="en_PH", seed=7).fake
value = fake.miscLandlineIdentifier()

mobileNumber

mobileNumber generates fictional telephone numbers in local formats.

Orionis typed contract:

def mobileNumber() -> str

Actual signature for en_PH:

fake.mobileNumber() -> str

Verified availability: 3 locales. Example locales: en_PH, fil_PH, tl_PH.

fake = SampleFactory(locale="en_PH", seed=7).fake
value = fake.mobileNumber()

mobileOperator

mobileOperator generates fictional telephone numbers in local formats.

Orionis typed contract:

def mobileOperator() -> str

Actual signature for ar_DZ:

fake.mobileOperator() -> str

Verified availability: 2 locales. Example locales: ar_DZ, fr_DZ.

fake = SampleFactory(locale="ar_DZ", seed=7).fake
value = fake.mobileOperator()

month

month generates dates, times and intervals for temporal fixtures.

Orionis typed contract:

def month() -> str

Actual signature for en_US:

fake.month() -> str

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.month()

monthInGuj

monthInGuj generates dates, times and intervals for temporal fixtures.

Orionis typed contract:

def monthInGuj() -> str

Actual signature for gu_IN:

fake.monthInGuj() -> str

Verified availability: 1 locales. Example locales: gu_IN.

fake = SampleFactory(locale="gu_IN", seed=7).fake
value = fake.monthInGuj()

monthName

monthName generates dates, times and intervals for temporal fixtures.

Orionis typed contract:

def monthName() -> str

Actual signature for en_US:

fake.monthName() -> str

Actual locale variants:

en_US, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ and 80 more:

fake.monthName() -> str

az_AZ, cs_CZ, da_DK, de, de_AT, de_DE and 18 more:

fake.monthName()

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.monthName()

monthNameInGuj

monthNameInGuj generates dates, times and intervals for temporal fixtures.

Orionis typed contract:

def monthNameInGuj() -> str

Actual signature for gu_IN:

fake.monthNameInGuj() -> str

Verified availability: 1 locales. Example locales: gu_IN.

fake = SampleFactory(locale="gu_IN", seed=7).fake
value = fake.monthNameInGuj()

motorcycleLicensePlate

motorcycleLicensePlate generates vehicle plates and identifiers for examples and fixtures.

Orionis typed contract:

def motorcycleLicensePlate() -> str

Actual signature for en_PH:

fake.motorcycleLicensePlate() -> str

Verified availability: 4 locales. Example locales: en_PH, es_MX, fil_PH, tl_PH.

fake = SampleFactory(locale="en_PH", seed=7).fake
value = fake.motorcycleLicensePlate()

motorcycleLicensePlateCdmx

motorcycleLicensePlateCdmx generates vehicle plates and identifiers for examples and fixtures.

Orionis typed contract:

def motorcycleLicensePlateCdmx() -> str

Actual signature for es_MX:

fake.motorcycleLicensePlateCdmx() -> str

Verified availability: 1 locales. Example locales: es_MX.

fake = SampleFactory(locale="es_MX", seed=7).fake
value = fake.motorcycleLicensePlateCdmx()

motorcycleLicensePlateNational

motorcycleLicensePlateNational generates vehicle plates and identifiers for examples and fixtures.

Orionis typed contract:

def motorcycleLicensePlateNational() -> str

Actual signature for es_MX:

fake.motorcycleLicensePlateNational() -> str

Verified availability: 1 locales. Example locales: es_MX.

fake = SampleFactory(locale="es_MX", seed=7).fake
value = fake.motorcycleLicensePlateNational()

mountainName

mountainName generates auxiliary test values and structures; return shape depends on the method.

Orionis typed contract:

def mountainName() -> str

Actual signature for en_PH:

fake.mountainName() -> str

Verified availability: 3 locales. Example locales: en_PH, fil_PH, tl_PH.

fake = SampleFactory(locale="en_PH", seed=7).fake
value = fake.mountainName()

msisdn

msisdn generates fictional telephone numbers in local formats.

Orionis typed contract:

def msisdn() -> str

Actual signature for en_US:

fake.msisdn() -> str

Verified availability: 107 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.msisdn()

municipality

municipality generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def municipality() -> str

Actual signature for es_CO:

fake.municipality() -> str

Verified availability: 2 locales. Example locales: es_CO, es_AR.

fake = SampleFactory(locale="es_CO", seed=7).fake
value = fake.municipality()

municipalityCode

municipalityCode generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def municipalityCode() -> str

Actual signature for es_CO:

fake.municipalityCode() -> str

Verified availability: 2 locales. Example locales: es_CO, es_AR.

fake = SampleFactory(locale="es_CO", seed=7).fake
value = fake.municipalityCode()

name

name generates names and identity components for test profiles.

Orionis typed contract:

def name() -> str

Actual signature for en_US:

fake.name() -> str

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.name()

nameFemale

nameFemale generates names and identity components for test profiles.

Orionis typed contract:

def nameFemale() -> str

Actual signature for en_US:

fake.nameFemale() -> str

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.nameFemale()

nameMale

nameMale generates names and identity components for test profiles.

Orionis typed contract:

def nameMale() -> str

Actual signature for en_US:

fake.nameMale() -> str

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.nameMale()

nameNonbinary

nameNonbinary generates names and identity components for test profiles.

Orionis typed contract:

def nameNonbinary() -> str

Actual signature for en_US:

fake.nameNonbinary() -> str

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.nameNonbinary()

nationality

nationality generates coordinates and locations for geographic fixtures.

Orionis typed contract:

def nationality() -> str

Actual signature for pt_PT:

fake.nationality() -> str

Verified availability: 1 locales. Example locales: pt_PT.

fake = SampleFactory(locale="pt_PT", seed=7).fake
value = fake.nationality()

naturalPersonNit

naturalPersonNit generates fictional administrative or tax identifiers; format depends on country.

Orionis typed contract:

def naturalPersonNit() -> str

Actual signature for es_CO:

fake.naturalPersonNit() -> str

Verified availability: 1 locales. Example locales: es_CO.

fake = SampleFactory(locale="es_CO", seed=7).fake
value = fake.naturalPersonNit()

naturalPersonNitWithCheckDigit

naturalPersonNitWithCheckDigit generates fictional administrative or tax identifiers; format depends on country.

Orionis typed contract:

def naturalPersonNitWithCheckDigit() -> str

Actual signature for es_CO:

fake.naturalPersonNitWithCheckDigit() -> str

Verified availability: 1 locales. Example locales: es_CO.

fake = SampleFactory(locale="es_CO", seed=7).fake
value = fake.naturalPersonNitWithCheckDigit()

neighborhood

neighborhood generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def neighborhood() -> str

Actual signature for pt_BR:

fake.neighborhood() -> str

Verified availability: 1 locales. Example locales: pt_BR.

fake = SampleFactory(locale="pt_BR", seed=7).fake
value = fake.neighborhood()

nicHandle

nicHandle generates Internet addresses and formats for test data; generating a string does not open a connection.

Orionis typed contract:

def nicHandle(suffix: str=...) -> str

Actual signature for en_US:

fake.nicHandle(suffix: str = 'FAKE') -> str

Parameter	Purpose
suffix	Generated string suffix.

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.nicHandle()

nicHandles

nicHandles generates Internet addresses and formats for test data; generating a string does not open a connection.

Orionis typed contract:

def nicHandles(count: int=..., suffix: str=...) -> list[str]

Actual signature for en_US:

fake.nicHandles(count: int = 1, suffix: str = '????') -> List[str]

Parameter	Purpose
count	Number of items or structures produced by the provider.
suffix	Generated string suffix.

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.nicHandles()

nie

nie generates fictional administrative or tax identifiers; format depends on country.

Orionis typed contract:

def nie() -> str

Actual signature for es_ES:

fake.nie() -> str

Verified availability: 3 locales. Example locales: es_ES, es, es_CA.

fake = SampleFactory(locale="es_ES", seed=7).fake
value = fake.nie()

nif

nif generates fictional administrative or tax identifiers; format depends on country.

Orionis typed contract:

def nif() -> str

Actual signature for es_ES:

fake.nif() -> str

Verified availability: 3 locales. Example locales: es_ES, es, es_CA.

fake = SampleFactory(locale="es_ES", seed=7).fake
value = fake.nif()

nip

nip generates names and identity components for test profiles.

Orionis typed contract:

def nip() -> str

Actual signature for pl_PL:

fake.nip() -> str

Verified availability: 1 locales. Example locales: pl_PL.

fake = SampleFactory(locale="pl_PL", seed=7).fake
value = fake.nip()

nonArea2LandlineAreaCode

nonArea2LandlineAreaCode generates fictional telephone numbers in local formats.

Orionis typed contract:

def nonArea2LandlineAreaCode() -> str

Actual signature for en_PH:

fake.nonArea2LandlineAreaCode() -> str

Verified availability: 3 locales. Example locales: en_PH, fil_PH, tl_PH.

fake = SampleFactory(locale="en_PH", seed=7).fake
value = fake.nonArea2LandlineAreaCode()

nonArea2LandlineNumber

nonArea2LandlineNumber generates fictional telephone numbers in local formats.

Orionis typed contract:

def nonArea2LandlineNumber() -> str

Actual signature for en_PH:

fake.nonArea2LandlineNumber() -> str

Verified availability: 3 locales. Example locales: en_PH, fil_PH, tl_PH.

fake = SampleFactory(locale="en_PH", seed=7).fake
value = fake.nonArea2LandlineNumber()

nonprofitPrefix

nonprofitPrefix generates company names and expressions for test entities.

Orionis typed contract:

def nonprofitPrefix() -> str

Actual signature for th_TH:

fake.nonprofitPrefix() -> str

Verified availability: 2 locales. Example locales: th, th_TH.

fake = SampleFactory(locale="th_TH", seed=7).fake
value = fake.nonprofitPrefix()

nuip

nuip generates fictional administrative or tax identifiers; format depends on country.

Orionis typed contract:

def nuip() -> str

Actual signature for es_CO:

fake.nuip() -> str

Verified availability: 1 locales. Example locales: es_CO.

fake = SampleFactory(locale="es_CO", seed=7).fake
value = fake.nuip()

nullBoolean

nullBoolean generates auxiliary test values and structures; return shape depends on the method.

Orionis typed contract:

def nullBoolean() -> bool | None

Actual signature for en_US:

fake.nullBoolean() -> bool | None

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.nullBoolean()

numberedStreet

numberedStreet generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def numberedStreet() -> str

Actual signature for vi_VN:

fake.numberedStreet() -> str

Verified availability: 1 locales. Example locales: vi_VN.

fake = SampleFactory(locale="vi_VN", seed=7).fake
value = fake.numberedStreet()

numerify

Replaces numeric placeholders in text; each placeholder follows the native provider rule.

Orionis typed contract:

def numerify(text: str=...) -> str

Actual signature for en_US:

fake.numerify(text: str = '###') -> str

Parameter	Purpose
text	Template or text processed by the provider.

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.numerify()

nuss

nuss generates fictional administrative or tax identifiers; format depends on country.

Orionis typed contract:

def nuss(company: bool=...) -> str

Actual signature for es_ES:

fake.nuss(company: bool = False) -> str

Parameter	Purpose
company	Generates a company NUSS when enabled.

Verified availability: 3 locales. Example locales: es_ES, es, es_CA.

fake = SampleFactory(locale="es_ES", seed=7).fake
value = fake.nuss()

oldPostalCode

oldPostalCode generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def oldPostalCode() -> str

Actual signature for ko_KR:

fake.oldPostalCode() -> str

Verified availability: 1 locales. Example locales: ko_KR.

fake = SampleFactory(locale="ko_KR", seed=7).fake
value = fake.oldPostalCode()

opera

opera generates User-Agent strings and components for simulated clients.

Orionis typed contract:

def opera() -> str

Actual signature for en_US:

fake.opera() -> str

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.opera()

operatorId

operatorId generates fictional telephone numbers in local formats.

Orionis typed contract:

def operatorId() -> str

Actual signature for ar_JO:

fake.operatorId() -> str

Verified availability: 1 locales. Example locales: ar_JO.

fake = SampleFactory(locale="ar_JO", seed=7).fake
value = fake.operatorId()

ordinalFloorNumber

ordinalFloorNumber generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def ordinalFloorNumber() -> str

Actual signature for en_PH:

fake.ordinalFloorNumber() -> str

Verified availability: 3 locales. Example locales: en_PH, fil_PH, tl_PH.

fake = SampleFactory(locale="en_PH", seed=7).fake
value = fake.ordinalFloorNumber()

ordinalStreetNumber

ordinalStreetNumber generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def ordinalStreetNumber() -> str

Actual signature for en_PH:

fake.ordinalStreetNumber() -> str

Verified availability: 3 locales. Example locales: en_PH, fil_PH, tl_PH.

fake = SampleFactory(locale="en_PH", seed=7).fake
value = fake.ordinalStreetNumber()

orgAndVatId

orgAndVatId generates fictional administrative or tax identifiers; format depends on country.

Orionis typed contract:

def orgAndVatId(long: bool=..., dash: bool=...) -> tuple[str, str]

Actual signature for sv_SE:

fake.orgAndVatId(long: bool = False, dash: bool = True) -> Tuple[str, str]

Parameter	Purpose
long	Requests the long localized identifier variant.
dash	Includes a hyphen in the identifier representation.

Verified availability: 1 locales. Example locales: sv_SE.

fake = SampleFactory(locale="sv_SE", seed=7).fake
value = fake.orgAndVatId()

orgId

orgId generates fictional administrative or tax identifiers; format depends on country.

Orionis typed contract:

def orgId(long: bool=..., dash: bool=...) -> str

Actual signature for sv_SE:

fake.orgId(long: bool = False, dash: bool = True) -> str

Parameter	Purpose
long	Requests the long localized identifier variant.
dash	Includes a hyphen in the identifier representation.

Verified availability: 1 locales. Example locales: sv_SE.

fake = SampleFactory(locale="sv_SE", seed=7).fake
value = fake.orgId()

pagibig

pagibig generates fictional administrative or tax identifiers; format depends on country.

Orionis typed contract:

def pagibig() -> str

Actual signature for en_PH:

fake.pagibig() -> str

Verified availability: 3 locales. Example locales: en_PH, fil_PH, tl_PH.

fake = SampleFactory(locale="en_PH", seed=7).fake
value = fake.pagibig()

pan

pan generates fictional administrative or tax identifiers; format depends on country.

Orionis typed contract:

def pan() -> str

Actual signature for en_IN:

fake.pan() -> str

Verified availability: 1 locales. Example locales: en_IN.

fake = SampleFactory(locale="en_IN", seed=7).fake
value = fake.pan()

paragraph

paragraph generates placeholder text for content and forms.

Orionis typed contract:

def paragraph(nb_sentences: int=..., variable_nb_sentences: bool=..., ext_word_list: Sequence[str] | None=...) -> str

Actual signature for en_US:

fake.paragraph(nb_sentences: int = 3, variable_nb_sentences: bool = True, ext_word_list: Sequence[str] | None = None) -> str

Parameter	Purpose
nb_sentences	Target sentence count.
variable_nb_sentences	Allows variation around target sentence count.
ext_word_list	Alternative vocabulary or None for native data.

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.paragraph()

paragraphs

paragraphs generates placeholder text for content and forms.

Orionis typed contract:

def paragraphs(nb: int=..., ext_word_list: Sequence[str] | None=...) -> list[str]

Actual signature for en_US:

fake.paragraphs(nb: int = 3, ext_word_list: Sequence[str] | None = None) -> List[str]

Parameter	Purpose
nb	Requested result count.
ext_word_list	Alternative vocabulary or None for native data.

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.paragraphs()

parse

Replaces {{provider}} and {{provider:group}} tokens. Tokens use NATIVE backend names such as first_name; the Python facade method remains camelCase. Unknown tokens raise AttributeError.

Helper accessible through dynamic facade dispatch; not declared in _ProviderMethods.

Actual signature for en_US:

fake.parse(text: str) -> str

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
fake.setArguments("small", {"min_value": 1, "max_value": 3})
value = fake.parse("{{first_name}} / {{pyint:small}}")

partitionedBuildingNumber

partitionedBuildingNumber generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def partitionedBuildingNumber() -> str

Actual signature for en_PH:

fake.partitionedBuildingNumber() -> str

Verified availability: 3 locales. Example locales: en_PH, fil_PH, tl_PH.

fake = SampleFactory(locale="en_PH", seed=7).fake
value = fake.partitionedBuildingNumber()

passportDates

passportDates generates fictional passport formats for fixtures, not valid travel documents.

Orionis typed contract:

def passportDates(birthday: datetime.date=...) -> tuple[str, str, str]

Actual signature for en_US:

fake.passportDates(birthday: datetime.date = datetime.date(2026, 10, 22)) -> Tuple[str, str, str]

Parameter	Purpose
birthday	Reference birth date for the passport.

Verified availability: 106 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.passportDates()

passportDob

passportDob generates fictional passport formats for fixtures, not valid travel documents.

Orionis typed contract:

def passportDob() -> datetime.date

Actual signature for en_US:

fake.passportDob() -> datetime.date

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.passportDob()

passportFull

passportFull generates fictional passport formats for fixtures, not valid travel documents.

Orionis typed contract:

def passportFull() -> str

Actual signature for en_US:

fake.passportFull() -> str

Verified availability: 106 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.passportFull()

passportGender

passportGender generates fictional passport formats for fixtures, not valid travel documents.

Orionis typed contract:

def passportGender(seed: int=...) -> Literal['M', 'F', 'X']

Actual signature for en_US:

fake.passportGender(seed: int = 0) -> Literal['M', 'F', 'X']

Parameter	Purpose
seed	Provider-specific seed.

Verified availability: 106 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.passportGender()

passportNumber

passportNumber generates fictional passport formats for fixtures, not valid travel documents.

Orionis typed contract:

def passportNumber() -> str

Actual signature for en_US:

fake.passportNumber() -> str

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.passportNumber()

passportOwner

passportOwner generates fictional passport formats for fixtures, not valid travel documents.

Orionis typed contract:

def passportOwner(gender: Literal['M', 'F', 'X']=...) -> tuple[str, str]

Actual signature for en_US:

fake.passportOwner(gender: Literal['M', 'F', 'X'] = 'X') -> Tuple[str, str]

Parameter	Purpose
gender	Gender selection using supported locale-specific values.

Actual locale variants:

en_US, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ and 103 more:

fake.passportOwner(gender: Literal['M', 'F', 'X'] = 'X') -> Tuple[str, str]

ru_RU:

fake.passportOwner(gender: Literal['M', 'F', 'X'] = 'M') -> Tuple[str, str]

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.passportOwner()

password

Generates a fictional password with configurable character classes for fixtures; does not compute an authentication hash.

Orionis typed contract:

def password(length: int=..., special_chars: bool=..., digits: bool=..., upper_case: bool=..., lower_case: bool=...) -> str

Actual signature for en_US:

fake.password(length: int = 10, special_chars: bool = True, digits: bool = True, upper_case: bool = True, lower_case: bool = True) -> str

Parameter	Purpose
length	Value length/size; units depend on this provider.
special_chars	Includes special characters in the fictional password.
digits	Number of result digits.
upper_case	Includes uppercase password characters.
lower_case	Includes lowercase password characters.

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.password(length=16)

pastDate

pastDate generates dates, times and intervals for temporal fixtures.

Orionis typed contract:

def pastDate(start_date: datetime.date | datetime.datetime | datetime.timedelta | str | int=..., tzinfo: datetime.tzinfo | None=...) -> datetime.date

Actual signature for en_US:

fake.pastDate(start_date: datetime.date | datetime.datetime | datetime.timedelta | str | int = '-30d', tzinfo: datetime.tzinfo | None = None) -> datetime.date

Parameter	Purpose
start_date	Start boundary: date/time, relative interval or provider-supported format.
tzinfo	Timezone for generated datetime; None uses native behavior.

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.pastDate()

pastDatetime

pastDatetime generates dates, times and intervals for temporal fixtures.

Orionis typed contract:

def pastDatetime(start_date: datetime.date | datetime.datetime | datetime.timedelta | str | int=..., tzinfo: datetime.tzinfo | None=...) -> datetime.datetime

Actual signature for en_US:

fake.pastDatetime(start_date: datetime.date | datetime.datetime | datetime.timedelta | str | int = '-30d', tzinfo: datetime.tzinfo | None = None) -> datetime.datetime

Parameter	Purpose
start_date	Start boundary: date/time, relative interval or provider-supported format.
tzinfo	Timezone for generated datetime; None uses native behavior.

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.pastDatetime()

personRut

personRut generates fictional administrative or tax identifiers; format depends on country.

Orionis typed contract:

def personRut() -> str

Actual signature for es_CL:

fake.personRut() -> str

Verified availability: 1 locales. Example locales: es_CL.

fake = SampleFactory(locale="es_CL", seed=7).fake
value = fake.personRut()

pesel

pesel generates names and identity components for test profiles.

Orionis typed contract:

def pesel(date_of_birth: datetime.datetime | None=..., sex: str | None=...) -> str

Actual signature for pl_PL:

fake.pesel(date_of_birth: datetime.datetime | None = None, sex: str | None = None) -> str

Parameter	Purpose
date_of_birth	Birth date used to build the identifier.
sex	Sex selection using supported locale-specific values.

Verified availability: 1 locales. Example locales: pl_PL.

fake = SampleFactory(locale="pl_PL", seed=7).fake
value = fake.pesel()

peselComputeCheckDigit

Calculates a PESEL check digit from the initial digit string; does not generate the whole identifier.

Orionis typed contract:

def peselComputeCheckDigit(pesel: str) -> int

Actual signature for pl_PL:

fake.peselComputeCheckDigit(pesel: str) -> int

Parameter	Purpose
pesel	Initial PESEL digits used to compute its check digit.

Verified availability: 1 locales. Example locales: pl_PL.

fake = SampleFactory(locale="pl_PL", seed=7).fake
value = fake.peselComputeCheckDigit(pesel="4405140145")

philhealth

philhealth generates fictional administrative or tax identifiers; format depends on country.

Orionis typed contract:

def philhealth() -> str

Actual signature for en_PH:

fake.philhealth() -> str

Verified availability: 3 locales. Example locales: en_PH, fil_PH, tl_PH.

fake = SampleFactory(locale="en_PH", seed=7).fake
value = fake.philhealth()

phoneNumber

phoneNumber generates fictional telephone numbers in local formats.

Orionis typed contract:

def phoneNumber() -> str

Actual signature for en_US:

fake.phoneNumber() -> str

Verified availability: 107 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.phoneNumber()

phonenumberPrefix

phonenumberPrefix generates fictional telephone numbers in local formats.

Orionis typed contract:

def phonenumberPrefix() -> int

Actual signature for zh_CN:

fake.phonenumberPrefix() -> int

Verified availability: 1 locales. Example locales: zh_CN.

fake = SampleFactory(locale="zh_CN", seed=7).fake
value = fake.phonenumberPrefix()

pincodeInArmy

pincodeInArmy generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def pincodeInArmy() -> int

Actual signature for en_IN:

fake.pincodeInArmy() -> int

Verified availability: 1 locales. Example locales: en_IN.

fake = SampleFactory(locale="en_IN", seed=7).fake
value = fake.pincodeInArmy()

pincodeInMilitary

pincodeInMilitary generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def pincodeInMilitary() -> int

Actual signature for en_IN:

fake.pincodeInMilitary() -> int

Verified availability: 1 locales. Example locales: en_IN.

fake = SampleFactory(locale="en_IN", seed=7).fake
value = fake.pincodeInMilitary()

pincodeInState

pincodeInState generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def pincodeInState(state_abbr: str | None=..., include_union_territories: bool=...) -> int

Actual signature for en_IN:

fake.pincodeInState(state_abbr: str | None = None, include_union_territories: bool = False) -> int

Parameter	Purpose
state_abbr	State abbreviation restricting localized output.
include_union_territories	Includes Indian Union Territories in postal codes.

Verified availability: 1 locales. Example locales: en_IN.

fake = SampleFactory(locale="en_IN", seed=7).fake
value = fake.pincodeInState()

placeName

placeName generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def placeName() -> str

Actual signature for pt_PT:

fake.placeName() -> str

Verified availability: 1 locales. Example locales: pt_PT.

fake = SampleFactory(locale="pt_PT", seed=7).fake
value = fake.placeName()

plantName

plantName generates auxiliary test values and structures; return shape depends on the method.

Orionis typed contract:

def plantName() -> str

Actual signature for en_PH:

fake.plantName() -> str

Verified availability: 3 locales. Example locales: en_PH, fil_PH, tl_PH.

fake = SampleFactory(locale="en_PH", seed=7).fake
value = fake.plantName()

plantStreetName

plantStreetName generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def plantStreetName() -> str

Actual signature for es_CL:

fake.plantStreetName() -> str

Verified availability: 1 locales. Example locales: es_CL.

fake = SampleFactory(locale="es_CL", seed=7).fake
value = fake.plantStreetName()

plateLetter

plateLetter generates vehicle plates and identifiers for examples and fixtures.

Orionis typed contract:

def plateLetter() -> str

Actual signature for ru_RU:

fake.plateLetter() -> str

Verified availability: 1 locales. Example locales: ru_RU.

fake = SampleFactory(locale="ru_RU", seed=7).fake
value = fake.plateLetter()

plateLetterPrefix

plateLetterPrefix generates vehicle plates and identifiers for examples and fixtures.

Orionis typed contract:

def plateLetterPrefix(region_name: str | None=...) -> str

Actual signature for uk_UA:

fake.plateLetterPrefix(region_name: str | None = None) -> str

Parameter	Purpose
region_name	Region name used to form the local license plate.

Verified availability: 1 locales. Example locales: uk_UA.

fake = SampleFactory(locale="uk_UA", seed=7).fake
value = fake.plateLetterPrefix()

plateLetterSuffix

plateLetterSuffix generates vehicle plates and identifiers for examples and fixtures.

Orionis typed contract:

def plateLetterSuffix() -> str

Actual signature for uk_UA:

fake.plateLetterSuffix() -> str

Verified availability: 1 locales. Example locales: uk_UA.

fake = SampleFactory(locale="uk_UA", seed=7).fake
value = fake.plateLetterSuffix()

plateNumber

plateNumber generates vehicle plates and identifiers for examples and fixtures.

Orionis typed contract:

def plateNumber() -> str

Actual signature for ru_RU:

fake.plateNumber() -> str

Verified availability: 2 locales. Example locales: ru_RU, uk_UA.

fake = SampleFactory(locale="ru_RU", seed=7).fake
value = fake.plateNumber()

plateNumberExtra

plateNumberExtra generates vehicle plates and identifiers for examples and fixtures.

Orionis typed contract:

def plateNumberExtra() -> str

Actual signature for ru_RU:

fake.plateNumberExtra() -> str

Verified availability: 1 locales. Example locales: ru_RU.

fake = SampleFactory(locale="ru_RU", seed=7).fake
value = fake.plateNumberExtra()

plateNumberSpecial

plateNumberSpecial generates vehicle plates and identifiers for examples and fixtures.

Orionis typed contract:

def plateNumberSpecial() -> str

Actual signature for ru_RU:

fake.plateNumberSpecial() -> str

Verified availability: 1 locales. Example locales: ru_RU.

fake = SampleFactory(locale="ru_RU", seed=7).fake
value = fake.plateNumberSpecial()

plateRegionCode

plateRegionCode generates vehicle plates and identifiers for examples and fixtures.

Orionis typed contract:

def plateRegionCode(region_name: str | None=...) -> str

Actual signature for uk_UA:

fake.plateRegionCode(region_name: str | None = None) -> str

Parameter	Purpose
region_name	Region name used to form the local license plate.

Verified availability: 1 locales. Example locales: uk_UA.

fake = SampleFactory(locale="uk_UA", seed=7).fake
value = fake.plateRegionCode()

plateSuffix

plateSuffix generates vehicle plates and identifiers for examples and fixtures.

Orionis typed contract:

def plateSuffix() -> str

Actual signature for ru_RU:

fake.plateSuffix() -> str

Verified availability: 1 locales. Example locales: ru_RU.

fake = SampleFactory(locale="ru_RU", seed=7).fake
value = fake.plateSuffix()

pldtArea2LandlineNumber

pldtArea2LandlineNumber generates fictional telephone numbers in local formats.

Orionis typed contract:

def pldtArea2LandlineNumber() -> str

Actual signature for en_PH:

fake.pldtArea2LandlineNumber() -> str

Verified availability: 3 locales. Example locales: en_PH, fil_PH, tl_PH.

fake = SampleFactory(locale="en_PH", seed=7).fake
value = fake.pldtArea2LandlineNumber()

policeId

policeId generates fictional administrative or tax identifiers; format depends on country.

Orionis typed contract:

def policeId() -> str

Actual signature for el_GR:

fake.policeId() -> str

Verified availability: 1 locales. Example locales: el_GR.

fake = SampleFactory(locale="el_GR", seed=7).fake
value = fake.policeId()

portNumber

portNumber generates Internet addresses and formats for test data; generating a string does not open a connection.

Orionis typed contract:

def portNumber(is_system: bool=..., is_user: bool=..., is_dynamic: bool=...) -> int

Actual signature for en_US:

fake.portNumber(is_system: bool = False, is_user: bool = False, is_dynamic: bool = False) -> int

Parameter	Purpose
is_system	Selects system or well-known ports.
is_user	Selects user or registered ports.
is_dynamic	Selects dynamic/private/ephemeral ports.

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.portNumber()

postalCode

postalCode generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def postalCode() -> str

Actual signature for ko_KR:

fake.postalCode() -> str

Verified availability: 1 locales. Example locales: ko_KR.

fake = SampleFactory(locale="ko_KR", seed=7).fake
value = fake.postalCode()

postalCodeLetter

postalCodeLetter generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def postalCodeLetter() -> str

Actual signature for en_CA:

fake.postalCodeLetter() -> str

Verified availability: 2 locales. Example locales: en_CA, fr_CA.

fake = SampleFactory(locale="en_CA", seed=7).fake
value = fake.postalCodeLetter()

postalcode

postalcode generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def postalcode() -> str

Actual signature for en_US:

fake.postalcode() -> str

Verified availability: 49 locales. Example locales: en_US, am_ET, ar_AA, ar_AE, ar_BH, ar_EG, ar_JO, ar_PS.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.postalcode()

postalcodeInProvince

postalcodeInProvince generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def postalcodeInProvince(province_abbr: str | None=...) -> str

Actual signature for en_CA:

fake.postalcodeInProvince(province_abbr: str | None = None) -> str

Parameter	Purpose
province_abbr	Locale-supported province abbreviation.

Verified availability: 2 locales. Example locales: en_CA, fr_CA.

fake = SampleFactory(locale="en_CA", seed=7).fake
value = fake.postalcodeInProvince()

postalcodeInState

postalcodeInState generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def postalcodeInState(state_abbr: str | None=...) -> str

Actual signature for en_US:

fake.postalcodeInState(state_abbr: str | None = None) -> str

Parameter	Purpose
state_abbr	State abbreviation restricting localized output.

Verified availability: 45 locales. Example locales: en_US, am_ET, ar_AA, ar_AE, ar_BH, ar_EG, ar_JO, ar_PS.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.postalcodeInState()

postalcodePlus4

postalcodePlus4 generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def postalcodePlus4() -> str

Actual signature for en_US:

fake.postalcodePlus4() -> str

Verified availability: 45 locales. Example locales: en_US, am_ET, ar_AA, ar_AE, ar_BH, ar_EG, ar_JO, ar_PS.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.postalcodePlus4()

postcode

postcode generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def postcode() -> str

Actual signature for en_US:

fake.postcode() -> str

Parameter	Purpose
formatted	Controls postal-code presentation in supporting locales.

Actual locale variants:

en_US, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ and 103 more:

fake.postcode() -> str

pt_BR:

fake.postcode(formatted: bool = True) -> str

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.postcode()

postcodeCityProvince

postcodeCityProvince generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def postcodeCityProvince() -> str

Actual signature for it_IT:

fake.postcodeCityProvince() -> str

Verified availability: 1 locales. Example locales: it_IT.

fake = SampleFactory(locale="it_IT", seed=7).fake
value = fake.postcodeCityProvince()

postcodeInArmy

postcodeInArmy generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def postcodeInArmy() -> int

Actual signature for en_IN:

fake.postcodeInArmy() -> int

Verified availability: 1 locales. Example locales: en_IN.

fake = SampleFactory(locale="en_IN", seed=7).fake
value = fake.postcodeInArmy()

postcodeInMilitary

postcodeInMilitary generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def postcodeInMilitary() -> int

Actual signature for en_IN:

fake.postcodeInMilitary() -> int

Verified availability: 1 locales. Example locales: en_IN.

fake = SampleFactory(locale="en_IN", seed=7).fake
value = fake.postcodeInMilitary()

postcodeInProvince

postcodeInProvince generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def postcodeInProvince(province_abbr: str | None=...) -> str

Actual signature for en_CA:

fake.postcodeInProvince(province_abbr: str | None = None) -> str

Parameter	Purpose
province_abbr	Locale-supported province abbreviation.

Verified availability: 2 locales. Example locales: en_CA, fr_CA.

fake = SampleFactory(locale="en_CA", seed=7).fake
value = fake.postcodeInProvince()

postcodeInState

postcodeInState generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def postcodeInState(state_abbr: str | None=...) -> str

Actual signature for en_US:

fake.postcodeInState(state_abbr: str | None = None) -> str

Parameter	Purpose
state_abbr	State abbreviation restricting localized output.
include_union_territories	Includes Indian Union Territories in postal codes.

Actual locale variants:

en_US, am_ET, ar_AA, ar_AE, ar_BH, ar_EG and 42 more:

fake.postcodeInState(state_abbr: str | None = None) -> str

en_IN:

fake.postcodeInState(state_abbr: str | None = None, include_union_territories: bool = False) -> int

Verified availability: 49 locales. Example locales: en_US, am_ET, ar_AA, ar_AE, ar_BH, ar_EG, ar_JO, ar_PS.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.postcodeInState()

prefecture

prefecture generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def prefecture() -> str

Actual signature for ja_JP:

fake.prefecture() -> str

Verified availability: 1 locales. Example locales: ja_JP.

fake = SampleFactory(locale="ja_JP", seed=7).fake
value = fake.prefecture()

prefix

prefix generates names and identity components for test profiles.

Orionis typed contract:

def prefix() -> str

Actual signature for en_US:

fake.prefix() -> str

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.prefix()

prefixFemale

prefixFemale generates names and identity components for test profiles.

Orionis typed contract:

def prefixFemale() -> str

Actual signature for en_US:

fake.prefixFemale() -> str

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.prefixFemale()

prefixMale

prefixMale generates names and identity components for test profiles.

Orionis typed contract:

def prefixMale() -> str

Actual signature for en_US:

fake.prefixMale() -> str

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.prefixMale()

prefixNonbinary

prefixNonbinary generates names and identity components for test profiles.

Orionis typed contract:

def prefixNonbinary() -> str

Actual signature for en_US:

fake.prefixNonbinary() -> str

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.prefixNonbinary()

pricetag

pricetag generates currency names, symbols and codes for catalogs.

Orionis typed contract:

def pricetag() -> str

Actual signature for en_US:

fake.pricetag() -> str

Actual locale variants:

en_US, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ and 95 more:

fake.pricetag() -> str

az_AZ, da_DK, de, de_CH, de_DE, en_CA and 3 more:

fake.pricetag()

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.pricetag()

profile

profile generates composite profiles for fixtures.

Orionis typed contract:

def profile(fields: list[str] | None=..., sex: Literal['M', 'F', 'X'] | None=...) -> dict[str, str | tuple[Decimal, Decimal] | list[str] | datetime.date]

Actual signature for en_US:

fake.profile(fields: List[str] | None = None, sex: Literal['M', 'F', 'X'] | None = None) -> Dict[str, str | Tuple[decimal.Decimal, decimal.Decimal] | List[str] | datetime.date]

Parameter	Purpose
fields	Profile field names included in the result.
sex	Sex selection using supported locale-specific values.

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.profile()

protocolLicensePlate

protocolLicensePlate generates vehicle plates and identifiers for examples and fixtures.

Orionis typed contract:

def protocolLicensePlate() -> str

Actual signature for en_PH:

fake.protocolLicensePlate() -> str

Verified availability: 3 locales. Example locales: en_PH, fil_PH, tl_PH.

fake = SampleFactory(locale="en_PH", seed=7).fake
value = fake.protocolLicensePlate()

provider

Looks up a provider by its case-insensitive provider identifier, or returns None. Receiving a native object neither registers it nor adds methods.

Helper accessible through dynamic facade dispatch; not declared in _ProviderMethods.

Actual signature for en_US:

fake.provider(name: str) -> ForwardRef('BaseProvider') | None

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.provider("person")

providerCode

providerCode generates fictional telephone numbers in local formats.

Orionis typed contract:

def providerCode() -> str

Actual signature for ar_PS:

fake.providerCode() -> str

Verified availability: 2 locales. Example locales: ar_PS, az_AZ.

fake = SampleFactory(locale="ar_PS", seed=7).fake
value = fake.providerCode()

province

province generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def province() -> str

Actual signature for en_CA:

fake.province() -> str

Actual locale variants:

en_CA, en_PH, es_AR, es_CL, fil_PH, fr_CA and 9 more:

fake.province() -> str

vi_VN:

fake.province()

Verified availability: 16 locales. Example locales: en_CA, en_PH, es_AR, es_CL, fil_PH, fr_CA, ko_KR, ne_NP.

fake = SampleFactory(locale="en_CA", seed=7).fake
value = fake.province()

provinceAbbr

provinceAbbr generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def provinceAbbr() -> str

Actual signature for en_CA:

fake.provinceAbbr() -> str

Verified availability: 2 locales. Example locales: en_CA, fr_CA.

fake = SampleFactory(locale="en_CA", seed=7).fake
value = fake.provinceAbbr()

provinceCode

provinceCode generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def provinceCode() -> str

Actual signature for es_CL:

fake.provinceCode() -> str

Verified availability: 1 locales. Example locales: es_CL.

fake = SampleFactory(locale="es_CL", seed=7).fake
value = fake.provinceCode()

provinceLgu

provinceLgu generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def provinceLgu() -> str

Actual signature for en_PH:

fake.provinceLgu() -> str

Verified availability: 3 locales. Example locales: en_PH, fil_PH, tl_PH.

fake = SampleFactory(locale="en_PH", seed=7).fake
value = fake.provinceLgu()

provinceName

provinceName generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def provinceName() -> str

Actual signature for vi_VN:

fake.provinceName() -> str

Verified availability: 1 locales. Example locales: vi_VN.

fake = SampleFactory(locale="vi_VN", seed=7).fake
value = fake.provinceName()

provincePrefix

provincePrefix generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def provincePrefix() -> str

Actual signature for vi_VN:

fake.provincePrefix() -> str

Verified availability: 1 locales. Example locales: vi_VN.

fake = SampleFactory(locale="vi_VN", seed=7).fake
value = fake.provincePrefix()

provincesCode

provincesCode generates addresses and geographic subdivisions for test forms, deliveries and profiles.

Orionis typed contract:

def provincesCode() -> str

Actual signature for es_AR:

fake.provincesCode() -> str

Verified availability: 1 locales. Example locales: es_AR.

fake = SampleFactory(locale="es_AR", seed=7).fake
value = fake.provincesCode()

psv

psv generates auxiliary test values and structures; return shape depends on the method.

Orionis typed contract:

def psv(header: Sequence[str] | None=..., data_columns: tuple[str, str]=..., num_rows: int=..., include_row_ids: bool=...) -> str

Actual signature for en_US:

fake.psv(header: Sequence[str] | None = None, data_columns: Tuple[str, str] = ('{{name}}', '{{address}}'), num_rows: int = 10, include_row_ids: bool = False) -> str

Parameter	Purpose
header	Column headings or None to omit them.
data_columns	Structure, column or generator-token definition.
num_rows	Number of serialized data rows.
include_row_ids	Adds a sequential row identifier.

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.psv(num_rows=2)

publicTransportLicensePlate

publicTransportLicensePlate generates vehicle plates and identifiers for examples and fixtures.

Orionis typed contract:

def publicTransportLicensePlate() -> str

Actual signature for es_MX:

fake.publicTransportLicensePlate() -> str

Verified availability: 1 locales. Example locales: es_MX.

fake = SampleFactory(locale="es_MX", seed=7).fake
value = fake.publicTransportLicensePlate()

publicTransportLicensePlateLettered

publicTransportLicensePlateLettered generates vehicle plates and identifiers for examples and fixtures.

Orionis typed contract:

def publicTransportLicensePlateLettered() -> str

Actual signature for es_MX:

fake.publicTransportLicensePlateLettered() -> str

Verified availability: 1 locales. Example locales: es_MX.

fake = SampleFactory(locale="es_MX", seed=7).fake
value = fake.publicTransportLicensePlateLettered()

publicTransportLicensePlateNumbered

publicTransportLicensePlateNumbered generates vehicle plates and identifiers for examples and fixtures.

Orionis typed contract:

def publicTransportLicensePlateNumbered() -> str

Actual signature for es_MX:

fake.publicTransportLicensePlateNumbered() -> str

Verified availability: 1 locales. Example locales: es_MX.

fake = SampleFactory(locale="es_MX", seed=7).fake
value = fake.publicTransportLicensePlateNumbered()

pwzDoctor

pwzDoctor generates names and identity components for test profiles.

Orionis typed contract:

def pwzDoctor() -> str

Actual signature for pl_PL:

fake.pwzDoctor() -> str

Verified availability: 1 locales. Example locales: pl_PL.

fake = SampleFactory(locale="pl_PL", seed=7).fake
value = fake.pwzDoctor()

pwzDoctorComputeCheckDigit

Calculates the Polish doctor identifier check digit from its digit sequence.

Orionis typed contract:

def pwzDoctorComputeCheckDigit(x: Sequence[int]) -> int

Actual signature for pl_PL:

fake.pwzDoctorComputeCheckDigit(x: Sequence[int]) -> int

Parameter	Purpose
x	Digit sequence used for check-digit calculation.

Verified availability: 1 locales. Example locales: pl_PL.

fake = SampleFactory(locale="pl_PL", seed=7).fake
value = fake.pwzDoctorComputeCheckDigit(x=[1, 2, 3, 4, 5, 6])

pwzNurse

pwzNurse generates names and identity components for test profiles.

Orionis typed contract:

def pwzNurse(kind: str=...) -> str

Actual signature for pl_PL:

fake.pwzNurse(kind: str = 'nurse') -> str

Parameter	Purpose
kind	Nursing profession kind for a PWZ identifier; defaults to nurse.

Verified availability: 1 locales. Example locales: pl_PL.

fake = SampleFactory(locale="pl_PL", seed=7).fake
value = fake.pwzNurse()

pybool

Boolean with truth_probability between 0 and 100.

Orionis typed contract:

def pybool(truth_probability: int=...) -> bool

Actual signature for en_US:

fake.pybool(truth_probability: int = 50) -> bool

Parameter	Purpose
truth_probability	True percentage (0 to 100).

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.pybool()

pydecimal

Returns Decimal with digit/value limits and sign, without automatically converting it to float/text.

Orionis typed contract:

def pydecimal(left_digits: int | None=..., right_digits: int | None=..., positive: bool | None=..., min_value: float | int | Decimal | None=..., max_value: float | int | Decimal | None=...) -> Decimal

Actual signature for en_US:

fake.pydecimal(left_digits: int | None = None, right_digits: int | None = None, positive: bool | None = None, min_value: float | int | decimal.Decimal | None = None, max_value: float | int | decimal.Decimal | None = None) -> decimal.Decimal

Parameter	Purpose
left_digits	Digit count to the left of the decimal separator.
right_digits	Fractional digit count.
positive	Restricts sign when not None.
min_value	Minimum permitted numeric value.
max_value	Maximum permitted numeric value.

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.pydecimal(left_digits=3, right_digits=2, positive=True)

pydict

pydict generates Python values and containers for test attributes.

Orionis typed contract:

def pydict(nb_elements: int=..., variable_nb_elements: bool=..., value_types: list[type] | tuple[type, ...] | None=..., allowed_types: list[type] | tuple[type, ...] | None=...) -> dict[Any, Any]

Actual signature for en_US:

fake.pydict(nb_elements: int = 10, variable_nb_elements: bool = True, value_types: List[Type] | Tuple[Type, ...] | None = None, allowed_types: List[Type] | Tuple[Type, ...] | None = None) -> Dict[Any, Any]

Parameter	Purpose
nb_elements	Number of elements to generate.
variable_nb_elements	Allows count variation around its target.
value_types	Python types of generated values.
allowed_types	Python types the container may select.

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.pydict()

pyfloat

Returns float with digit, sign and value limits.

Orionis typed contract:

def pyfloat(left_digits: int | None=..., right_digits: int | None=..., positive: bool | None=..., min_value: float | int | None=..., max_value: float | int | None=...) -> float

Actual signature for en_US:

fake.pyfloat(left_digits: int | None = None, right_digits: int | None = None, positive: bool | None = None, min_value: float | int | None = None, max_value: float | int | None = None) -> float

Parameter	Purpose
left_digits	Digit count to the left of the decimal separator.
right_digits	Fractional digit count.
positive	Restricts sign when not None.
min_value	Minimum permitted numeric value.
max_value	Maximum permitted numeric value.

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.pyfloat(left_digits=2, right_digits=2, positive=True)

pyint

pyint generates Python values and containers for test attributes.

Orionis typed contract:

def pyint(min_value: int=..., max_value: int=..., step: int=...) -> int

Actual signature for en_US:

fake.pyint(min_value: int = 0, max_value: int = 9999, step: int = 1) -> int

Parameter	Purpose
min_value	Minimum permitted numeric value.
max_value	Maximum permitted numeric value.
step	Integer selection step.

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.pyint()

pyiterable

pyiterable generates Python values and containers for test attributes.

Orionis typed contract:

def pyiterable(nb_elements: int=..., variable_nb_elements: bool=..., value_types: list[type] | tuple[type, ...] | None=..., allowed_types: list[type] | tuple[type, ...] | None=...) -> Iterable[Any]

Actual signature for en_US:

fake.pyiterable(nb_elements: int = 10, variable_nb_elements: bool = True, value_types: List[Type] | Tuple[Type, ...] | None = None, allowed_types: List[Type] | Tuple[Type, ...] | None = None) -> Iterable[Any]

Parameter	Purpose
nb_elements	Number of elements to generate.
variable_nb_elements	Allows count variation around its target.
value_types	Python types of generated values.
allowed_types	Python types the container may select.

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.pyiterable()

pylist

pylist generates Python values and containers for test attributes.

Orionis typed contract:

def pylist(nb_elements: int=..., variable_nb_elements: bool=..., value_types: list[type] | tuple[type, ...] | None=..., allowed_types: list[type] | tuple[type, ...] | None=...) -> list[Any]

Actual signature for en_US:

fake.pylist(nb_elements: int = 10, variable_nb_elements: bool = True, value_types: List[Type] | Tuple[Type, ...] | None = None, allowed_types: List[Type] | Tuple[Type, ...] | None = None) -> List[Any]

Parameter	Purpose
nb_elements	Number of elements to generate.
variable_nb_elements	Allows count variation around its target.
value_types	Python types of generated values.
allowed_types	Python types the container may select.

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.pylist()

pyobject

pyobject generates Python values and containers for test attributes.

Orionis typed contract:

def pyobject(object_type: type[bool | str | float | int | tuple | set | list | Iterable | dict] | None=...) -> bool | str | float | int | tuple | set | list | Iterable | dict | None

Actual signature for en_US:

fake.pyobject(object_type: Type[bool | str | float | int | tuple | set | list | Iterable | dict] | None = None) -> bool | str | float | int | tuple | set | list | Iterable | dict | None

Parameter	Purpose
object_type	Python type of the generated object.

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.pyobject()

pyset

pyset generates Python values and containers for test attributes.

Orionis typed contract:

def pyset(nb_elements: int=..., variable_nb_elements: bool=..., value_types: list[type] | tuple[type, ...] | None=..., allowed_types: list[type] | tuple[type, ...] | None=...) -> set[Any]

Actual signature for en_US:

fake.pyset(nb_elements: int = 10, variable_nb_elements: bool = True, value_types: List[Type] | Tuple[Type, ...] | None = None, allowed_types: List[Type] | Tuple[Type, ...] | None = None) -> Set[Any]

Parameter	Purpose
nb_elements	Number of elements to generate.
variable_nb_elements	Allows count variation around its target.
value_types	Python types of generated values.
allowed_types	Python types the container may select.

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.pyset()

pystr

pystr generates Python values and containers for test attributes.

Orionis typed contract:

def pystr(min_chars: int | None=..., max_chars: int=..., prefix: str=..., suffix: str=...) -> str

Actual signature for en_US:

fake.pystr(min_chars: int | None = None, max_chars: int = 20, prefix: str = '', suffix: str = '') -> str

Parameter	Purpose
min_chars	Minimum string length.
max_chars	Maximum string length.
prefix	Generated string prefix.
suffix	Generated string suffix.

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.pystr(min_chars=6, max_chars=12)

pystrFormat

pystrFormat generates Python values and containers for test attributes.

Orionis typed contract:

def pystrFormat(string_format: str=..., letters: str=...) -> str

Actual signature for en_US:

fake.pystrFormat(string_format: str = '?#-###{{random_int}}{{random_letter}}', letters: str = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ') -> str

Parameter	Purpose
string_format	Template with tokens for formatted text generation.
letters	Alphabetic character population.

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.pystrFormat()

pystruct

pystruct generates Python values and containers for test attributes.

Orionis typed contract:

def pystruct(count: int=..., value_types: list[type] | tuple[type, ...] | None=..., allowed_types: list[type] | tuple[type, ...] | None=...) -> tuple[list, dict, dict]

Actual signature for en_US:

fake.pystruct(count: int = 10, value_types: List[Type] | Tuple[Type, ...] | None = None, allowed_types: List[Type] | Tuple[Type, ...] | None = None) -> Tuple[List, Dict, Dict]

Parameter	Purpose
count	Number of items or structures produced by the provider.
value_types	Python types of generated values.
allowed_types	Python types the container may select.

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.pystruct()

pytimezone

pytimezone generates dates, times and intervals for temporal fixtures.

Orionis typed contract:

def pytimezone(*args: Any, **kwargs: Any) -> datetime.tzinfo | None

Actual signature for en_US:

fake.pytimezone(*args: Any, **kwargs: Any) -> datetime.tzinfo | None

Parameter	Purpose
args	Positional arguments for generated Python types.
kwargs	Keyword arguments for generated Python types.

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.pytimezone()

pytuple

pytuple generates Python values and containers for test attributes.

Orionis typed contract:

def pytuple(nb_elements: int=..., variable_nb_elements: bool=..., value_types: list[type] | tuple[type, ...] | None=..., allowed_types: list[type] | tuple[type, ...] | None=...) -> tuple[Any, ...]

Actual signature for en_US:

fake.pytuple(nb_elements: int = 10, variable_nb_elements: bool = True, value_types: List[Type] | Tuple[Type, ...] | None = None, allowed_types: List[Type] | Tuple[Type, ...] | None = None) -> Tuple[Any, ...]

Parameter	Purpose
nb_elements	Number of elements to generate.
variable_nb_elements	Allows count variation around its target.
value_types	Python types of generated values.
allowed_types	Python types the container may select.

Verified availability: 110 locales. Example locales: en_US, es_CO, es_ES, am_ET, ar_AA, ar_AE, ar_BH, ar_DZ.

fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.pytuple()