Skip to content
Orionis Framework

Faker: providers E–H

This reference covers 83 facade names in the E-H 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

Section titled “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

Section titled “Catalog index”

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

ean

Section titled “ean”

ean generates product codes and check digits for test catalogs.

Orionis typed contract:

def ean(length: int=..., prefixes: tuple[int | str | tuple[int | str, ...], ...]=...) -> str

Actual signature for en_US:

fake.ean(length: int = 13, prefixes: Tuple[int | str | Tuple[int | str, ...], ...] = ()) -> str
ParameterPurpose
lengthValue length/size; units depend on this provider.
prefixesAccepted barcode prefixes.

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.ean()

ean13

Section titled “ean13”

ean13 generates product codes and check digits for test catalogs.

Orionis typed contract:

def ean13(prefixes: tuple[int | str | tuple[int | str, ...], ...]=..., leading_zero: bool | None=...) -> str

Actual signature for en_US:

fake.ean13(prefixes: Tuple[int | str | Tuple[int | str, ...], ...] = (), leading_zero: bool | None = None) -> str
ParameterPurpose
prefixesAccepted barcode prefixes.
leading_zeroControls the leading EAN-13 zero where supported by the locale.

Actual locale variants:

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

fake.ean13(prefixes: Tuple[int | str | Tuple[int | str, ...], ...] = (), leading_zero: bool | None = None) -> str

es, es_ES, ja_JP:

fake.ean13(prefixes: Tuple[int | str | Tuple[int | 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.ean13()

ean8

Section titled “ean8”

ean8 generates product codes and check digits for test catalogs.

Orionis typed contract:

def ean8(prefixes: tuple[int | str | tuple[int | str, ...], ...]=...) -> str

Actual signature for en_US:

fake.ean8(prefixes: Tuple[int | str | Tuple[int | str, ...], ...] = ()) -> str
ParameterPurpose
prefixesAccepted barcode prefixes.

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.ean8()

ein

Section titled “ein”

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

Orionis typed contract:

def ein() -> str

Actual signature for en_US:

fake.ein() -> str

Verified availability: 52 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.ein()

electorCode

Section titled “electorCode”

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

Orionis typed contract:

def electorCode(gender: Literal['H', 'M'] | None=...) -> str

Actual signature for es_MX:

fake.electorCode(gender: Literal['H', 'M'] | None = None) -> str
ParameterPurpose
genderGender selection using supported locale-specific values.

Verified availability: 1 locales. Example locales: es_MX.

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

email

Section titled “email”

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

Orionis typed contract:

def email(safe: bool=..., domain: str | None=...) -> str

Actual signature for en_US:

fake.email(safe: bool = True, domain: str | None = None) -> str
ParameterPurpose
safeGenerates a safe sample-domain email when enabled.
domainExplicit domain or None for automatic generation.

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.email()

emoji

Section titled “emoji”

emoji generates emoji for sample content.

Orionis typed contract:

def emoji() -> str

Actual signature for en_US:

fake.emoji() -> 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.emoji()

englishCatchPhrase

Section titled “englishCatchPhrase”

englishCatchPhrase generates company names and expressions for test entities.

Orionis typed contract:

def englishCatchPhrase() -> str

Actual signature for fil_PH:

fake.englishCatchPhrase() -> str

Verified availability: 2 locales. Example locales: fil_PH, tl_PH.

fake = SampleFactory(locale="fil_PH", seed=7).fake
value = fake.englishCatchPhrase()

englishParagraph

Section titled “englishParagraph”

englishParagraph generates placeholder text for content and forms.

Orionis typed contract:

def englishParagraph(nb_sentences: int=..., variable_nb_sentences: bool=...) -> str

Actual signature for en_PH:

fake.englishParagraph(nb_sentences: int = 3, variable_nb_sentences: bool = True) -> str
ParameterPurpose
nb_sentencesTarget sentence count.
variable_nb_sentencesAllows variation around target sentence count.

Verified availability: 1 locales. Example locales: en_PH.

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

englishParagraphs

Section titled “englishParagraphs”

englishParagraphs generates placeholder text for content and forms.

Orionis typed contract:

def englishParagraphs(nb: int=...) -> list[str]

Actual signature for en_PH:

fake.englishParagraphs(nb: int = 3) -> List[str]
ParameterPurpose
nbRequested result count.

Verified availability: 1 locales. Example locales: en_PH.

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

englishSentence

Section titled “englishSentence”

englishSentence generates placeholder text for content and forms.

Orionis typed contract:

def englishSentence(nb_words: int=..., variable_nb_words: bool=...) -> str

Actual signature for en_PH:

fake.englishSentence(nb_words: int = 6, variable_nb_words: bool = True) -> str
ParameterPurpose
nb_wordsTarget word count.
variable_nb_wordsAllows variation around target word count.

Verified availability: 1 locales. Example locales: en_PH.

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

englishSentences

Section titled “englishSentences”

englishSentences generates placeholder text for content and forms.

Orionis typed contract:

def englishSentences(nb: int=...) -> list[str]

Actual signature for en_PH:

fake.englishSentences(nb: int = 3) -> List[str]
ParameterPurpose
nbRequested result count.

Verified availability: 1 locales. Example locales: en_PH.

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

englishText

Section titled “englishText”

englishText generates placeholder text for content and forms.

Orionis typed contract:

def englishText(max_nb_chars: int=...) -> str

Actual signature for en_PH:

fake.englishText(max_nb_chars: int = 200) -> str
ParameterPurpose
max_nb_charsMaximum requested text character count.

Verified availability: 1 locales. Example locales: en_PH.

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

englishTexts

Section titled “englishTexts”

englishTexts generates placeholder text for content and forms.

Orionis typed contract:

def englishTexts(nb_texts: int=..., max_nb_chars: int=...) -> list[str]

Actual signature for en_PH:

fake.englishTexts(nb_texts: int = 3, max_nb_chars: int = 200) -> List[str]
ParameterPurpose
nb_textsNumber of texts to return.
max_nb_charsMaximum requested text character count.

Verified availability: 1 locales. Example locales: en_PH.

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

englishWord

Section titled “englishWord”

englishWord generates placeholder text for content and forms.

Orionis typed contract:

def englishWord() -> str

Actual signature for en_PH:

fake.englishWord() -> str

Verified availability: 1 locales. Example locales: en_PH.

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

englishWords

Section titled “englishWords”

englishWords generates placeholder text for content and forms.

Orionis typed contract:

def englishWords(nb: int=..., unique: bool=...) -> list[str]

Actual signature for en_PH:

fake.englishWords(nb: int = 3, unique: bool = False) -> List[str]
ParameterPurpose
nbRequested result count.
uniqueRequests nonrepeating selections within this call.

Verified availability: 1 locales. Example locales: en_PH.

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

enum

Section titled “enum”

Selects a member of the supplied Enum class rather than only its value.

Orionis typed contract:

def enum(enum_cls: type[TEnum]) -> TEnum

Actual signature for en_US:

fake.enum(enum_cls: Type[~TEnum]) -> ~TEnum
ParameterPurpose
enum_clsEnum class from which to select a member.

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

from enum import Enum




class Status(Enum):
    DRAFT = "draft"
    PUBLISHED = "published"




fake = SampleFactory(locale="en_US", seed=7).fake
value = fake.enum(enum_cls=Status)

estado

Section titled “estado”

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

Orionis typed contract:

def estado() -> tuple[str, str]

Actual signature for pt_BR:

fake.estado() -> Tuple[str, str]

Verified availability: 1 locales. Example locales: pt_BR.

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

estadoNome

Section titled “estadoNome”

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

Orionis typed contract:

def estadoNome() -> str

Actual signature for pt_BR:

fake.estadoNome() -> str

Verified availability: 1 locales. Example locales: pt_BR.

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

estadoSigla

Section titled “estadoSigla”

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

Orionis typed contract:

def estadoSigla() -> str

Actual signature for pt_BR:

fake.estadoSigla() -> str

Verified availability: 1 locales. Example locales: pt_BR.

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

fileExtension

Section titled “fileExtension”

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

Orionis typed contract:

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

Actual signature for en_US:

fake.fileExtension(category: str | None = None) -> str
ParameterPurpose
categoryProvider 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.fileExtension()

fileName

Section titled “fileName”

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

Orionis typed contract:

def fileName(category: str | None=..., extension: str | None=...) -> str

Actual signature for en_US:

fake.fileName(category: str | None = None, extension: str | None = None) -> str
ParameterPurpose
categoryProvider data category.
extensionFilename/path extension.

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.fileName()

filePath

Section titled “filePath”

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

Orionis typed contract:

def filePath(depth: int=..., category: str | None=..., extension: str | Sequence[str] | None=..., absolute: bool | None=..., file_system_rule: Literal['linux', 'windows']=..., allowed_path_traversal_elements: Sequence[str] | None=...) -> str

Actual signature for en_US:

fake.filePath(depth: int = 1, category: str | None = None, extension: str | Sequence[str] | None = None, absolute: bool | None = True, file_system_rule: Literal['linux', 'windows'] = 'linux', allowed_path_traversal_elements: Sequence[str] | None = None) -> str
ParameterPurpose
depthDirectory level count of the fictional path.
categoryProvider data category.
extensionFilename/path extension.
absoluteGenerates an absolute rather than relative path.
file_system_rulelinux or windows path convention; does not operate on that filesystem.
allowed_path_traversal_elementsSegments such as . or .. allowed for path-handling tests; None omits them.

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.filePath()

firefox

Section titled “firefox”

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

Orionis typed contract:

def firefox() -> str

Actual signature for en_US:

fake.firefox() -> 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.firefox()

firstKanaName

Section titled “firstKanaName”

firstKanaName generates names and identity components for test profiles.

Orionis typed contract:

def firstKanaName() -> str

Actual signature for ja_JP:

fake.firstKanaName() -> str

Verified availability: 1 locales. Example locales: ja_JP.

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

firstKanaNameFemale

Section titled “firstKanaNameFemale”

firstKanaNameFemale generates names and identity components for test profiles.

Orionis typed contract:

def firstKanaNameFemale() -> str

Actual signature for ja_JP:

fake.firstKanaNameFemale() -> str

Verified availability: 1 locales. Example locales: ja_JP.

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

firstKanaNameMale

Section titled “firstKanaNameMale”

firstKanaNameMale generates names and identity components for test profiles.

Orionis typed contract:

def firstKanaNameMale() -> str

Actual signature for ja_JP:

fake.firstKanaNameMale() -> str

Verified availability: 1 locales. Example locales: ja_JP.

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

firstName

Section titled “firstName”

firstName generates names and identity components for test profiles.

Orionis typed contract:

def firstName() -> str

Actual signature for en_US:

fake.firstName() -> 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.firstName()

firstNameEst

Section titled “firstNameEst”

firstNameEst generates names and identity components for test profiles.

Orionis typed contract:

def firstNameEst() -> str

Actual signature for et_EE:

fake.firstNameEst() -> str

Verified availability: 1 locales. Example locales: et_EE.

fake = SampleFactory(locale="et_EE", seed=7).fake
value = fake.firstNameEst()

firstNameFemale

Section titled “firstNameFemale”

firstNameFemale generates names and identity components for test profiles.

Orionis typed contract:

def firstNameFemale() -> str

Actual signature for en_US:

fake.firstNameFemale() -> 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.firstNameFemale()

firstNameFemaleAbbreviated

Section titled “firstNameFemaleAbbreviated”

firstNameFemaleAbbreviated generates names and identity components for test profiles.

Orionis typed contract:

def firstNameFemaleAbbreviated() -> str

Actual signature for hu_HU:

fake.firstNameFemaleAbbreviated() -> str

Verified availability: 1 locales. Example locales: hu_HU.

fake = SampleFactory(locale="hu_HU", seed=7).fake
value = fake.firstNameFemaleAbbreviated()

firstNameFemaleCommon

Section titled “firstNameFemaleCommon”

firstNameFemaleCommon generates names and identity components for test profiles.

Orionis typed contract:

def firstNameFemaleCommon() -> str

Actual signature for bn_BD:

fake.firstNameFemaleCommon() -> str

Verified availability: 1 locales. Example locales: bn_BD.

fake = SampleFactory(locale="bn_BD", seed=7).fake
value = fake.firstNameFemaleCommon()

firstNameFemaleEst

Section titled “firstNameFemaleEst”

firstNameFemaleEst generates names and identity components for test profiles.

Orionis typed contract:

def firstNameFemaleEst() -> str

Actual signature for et_EE:

fake.firstNameFemaleEst() -> str

Verified availability: 1 locales. Example locales: et_EE.

fake = SampleFactory(locale="et_EE", seed=7).fake
value = fake.firstNameFemaleEst()

firstNameFemaleHinduism

Section titled “firstNameFemaleHinduism”

firstNameFemaleHinduism generates names and identity components for test profiles.

Orionis typed contract:

def firstNameFemaleHinduism() -> str

Actual signature for bn_BD:

fake.firstNameFemaleHinduism() -> str

Verified availability: 1 locales. Example locales: bn_BD.

fake = SampleFactory(locale="bn_BD", seed=7).fake
value = fake.firstNameFemaleHinduism()

firstNameFemaleIslamic

Section titled “firstNameFemaleIslamic”

firstNameFemaleIslamic generates names and identity components for test profiles.

Orionis typed contract:

def firstNameFemaleIslamic() -> str

Actual signature for bn_BD:

fake.firstNameFemaleIslamic() -> str

Verified availability: 1 locales. Example locales: bn_BD.

fake = SampleFactory(locale="bn_BD", seed=7).fake
value = fake.firstNameFemaleIslamic()

firstNameFemalePair

Section titled “firstNameFemalePair”

firstNameFemalePair generates names and identity components for test profiles.

Orionis typed contract:

def firstNameFemalePair() -> tuple[str, str, str]

Actual signature for ja_JP:

fake.firstNameFemalePair() -> Tuple[str, str, str]

Verified availability: 1 locales. Example locales: ja_JP.

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

firstNameFemaleRus

Section titled “firstNameFemaleRus”

firstNameFemaleRus generates names and identity components for test profiles.

Orionis typed contract:

def firstNameFemaleRus() -> str

Actual signature for et_EE:

fake.firstNameFemaleRus() -> str

Verified availability: 1 locales. Example locales: et_EE.

fake = SampleFactory(locale="et_EE", seed=7).fake
value = fake.firstNameFemaleRus()

firstNameMale

Section titled “firstNameMale”

firstNameMale generates names and identity components for test profiles.

Orionis typed contract:

def firstNameMale() -> str

Actual signature for en_US:

fake.firstNameMale() -> 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.firstNameMale()

firstNameMaleAbbreviated

Section titled “firstNameMaleAbbreviated”

firstNameMaleAbbreviated generates names and identity components for test profiles.

Orionis typed contract:

def firstNameMaleAbbreviated() -> str

Actual signature for hu_HU:

fake.firstNameMaleAbbreviated() -> str

Verified availability: 1 locales. Example locales: hu_HU.

fake = SampleFactory(locale="hu_HU", seed=7).fake
value = fake.firstNameMaleAbbreviated()

firstNameMaleCommon

Section titled “firstNameMaleCommon”

firstNameMaleCommon generates names and identity components for test profiles.

Orionis typed contract:

def firstNameMaleCommon() -> str

Actual signature for bn_BD:

fake.firstNameMaleCommon() -> str

Verified availability: 1 locales. Example locales: bn_BD.

fake = SampleFactory(locale="bn_BD", seed=7).fake
value = fake.firstNameMaleCommon()

firstNameMaleEst

Section titled “firstNameMaleEst”

firstNameMaleEst generates names and identity components for test profiles.

Orionis typed contract:

def firstNameMaleEst() -> str

Actual signature for et_EE:

fake.firstNameMaleEst() -> str

Verified availability: 1 locales. Example locales: et_EE.

fake = SampleFactory(locale="et_EE", seed=7).fake
value = fake.firstNameMaleEst()

firstNameMaleHinduism

Section titled “firstNameMaleHinduism”

firstNameMaleHinduism generates names and identity components for test profiles.

Orionis typed contract:

def firstNameMaleHinduism() -> str

Actual signature for bn_BD:

fake.firstNameMaleHinduism() -> str

Verified availability: 1 locales. Example locales: bn_BD.

fake = SampleFactory(locale="bn_BD", seed=7).fake
value = fake.firstNameMaleHinduism()

firstNameMaleIslamic

Section titled “firstNameMaleIslamic”

firstNameMaleIslamic generates names and identity components for test profiles.

Orionis typed contract:

def firstNameMaleIslamic() -> str

Actual signature for bn_BD:

fake.firstNameMaleIslamic() -> str

Verified availability: 1 locales. Example locales: bn_BD.

fake = SampleFactory(locale="bn_BD", seed=7).fake
value = fake.firstNameMaleIslamic()

firstNameMalePair

Section titled “firstNameMalePair”

firstNameMalePair generates names and identity components for test profiles.

Orionis typed contract:

def firstNameMalePair() -> tuple[str, str, str]

Actual signature for ja_JP:

fake.firstNameMalePair() -> Tuple[str, str, str]

Verified availability: 1 locales. Example locales: ja_JP.

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

firstNameMaleRus

Section titled “firstNameMaleRus”

firstNameMaleRus generates names and identity components for test profiles.

Orionis typed contract:

def firstNameMaleRus() -> str

Actual signature for et_EE:

fake.firstNameMaleRus() -> str

Verified availability: 1 locales. Example locales: et_EE.

fake = SampleFactory(locale="et_EE", seed=7).fake
value = fake.firstNameMaleRus()

firstNameNonbinary

Section titled “firstNameNonbinary”

firstNameNonbinary generates names and identity components for test profiles.

Orionis typed contract:

def firstNameNonbinary() -> str

Actual signature for en_US:

fake.firstNameNonbinary() -> 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.firstNameNonbinary()

firstNamePair

Section titled “firstNamePair”

firstNamePair generates names and identity components for test profiles.

Orionis typed contract:

def firstNamePair() -> tuple[str, str, str]

Actual signature for ja_JP:

fake.firstNamePair() -> Tuple[str, str, str]

Verified availability: 1 locales. Example locales: ja_JP.

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

firstNameRus

Section titled “firstNameRus”

firstNameRus generates names and identity components for test profiles.

Orionis typed contract:

def firstNameRus() -> str

Actual signature for et_EE:

fake.firstNameRus() -> str

Verified availability: 1 locales. Example locales: et_EE.

fake = SampleFactory(locale="et_EE", seed=7).fake
value = fake.firstNameRus()

firstNameUnisex

Section titled “firstNameUnisex”

firstNameUnisex generates names and identity components for test profiles.

Orionis typed contract:

def firstNameUnisex() -> str

Actual signature for or_IN:

fake.firstNameUnisex() -> str

Verified availability: 2 locales. Example locales: or_IN, vi_VN.

fake = SampleFactory(locale="or_IN", seed=7).fake
value = fake.firstNameUnisex()

firstRomanizedName

Section titled “firstRomanizedName”

firstRomanizedName generates names and identity components for test profiles.

Orionis typed contract:

def firstRomanizedName() -> str

Actual signature for ja_JP:

fake.firstRomanizedName() -> str

Verified availability: 3 locales. Example locales: ja_JP, zh_CN, zh_TW.

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

firstRomanizedNameFemale

Section titled “firstRomanizedNameFemale”

firstRomanizedNameFemale generates names and identity components for test profiles.

Orionis typed contract:

def firstRomanizedNameFemale() -> str

Actual signature for ja_JP:

fake.firstRomanizedNameFemale() -> str

Verified availability: 2 locales. Example locales: ja_JP, zh_TW.

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

firstRomanizedNameMale

Section titled “firstRomanizedNameMale”

firstRomanizedNameMale generates names and identity components for test profiles.

Orionis typed contract:

def firstRomanizedNameMale() -> str

Actual signature for ja_JP:

fake.firstRomanizedNameMale() -> str

Verified availability: 2 locales. Example locales: ja_JP, zh_TW.

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

fixedWidth

Section titled “fixedWidth”

Returns fixed-width text using (width, definition, optional arguments) tuples in data_columns.

Orionis typed contract:

def fixedWidth(data_columns: list[tuple[int, str] | tuple[int, str, dict[str, Any]]] | None=..., num_rows: int=..., align: str=...) -> str

Actual signature for en_US:

fake.fixedWidth(data_columns: List[Tuple[int, str] | Tuple[int, str, Dict[str, Any]]] | None = None, num_rows: int = 10, align: str = 'left') -> str
ParameterPurpose
data_columnsStructure, column or generator-token definition.
num_rowsNumber of serialized data rows.
alignFixed-width field alignment: left, middle or right.

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.fixedWidth(num_rows=2)

floorNumber

Section titled “floorNumber”

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

Orionis typed contract:

def floorNumber() -> str

Actual signature for en_PH:

fake.floorNumber() -> str

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

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

floorUnitNumber

Section titled “floorUnitNumber”

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

Orionis typed contract:

def floorUnitNumber() -> str

Actual signature for en_PH:

fake.floorUnitNumber() -> str

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

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

freeEmail

Section titled “freeEmail”

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

Orionis typed contract:

def freeEmail() -> str

Actual signature for en_US:

fake.freeEmail() -> 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.freeEmail()

freeEmailDomain

Section titled “freeEmailDomain”

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

Orionis typed contract:

def freeEmailDomain() -> str

Actual signature for en_US:

fake.freeEmailDomain() -> 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.freeEmailDomain()

freguesia

Section titled “freguesia”

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

Orionis typed contract:

def freguesia() -> str

Actual signature for pt_PT:

fake.freguesia() -> str

Verified availability: 1 locales. Example locales: pt_PT.

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

frequentStreetName

Section titled “frequentStreetName”

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

Orionis typed contract:

def frequentStreetName() -> str

Actual signature for hu_HU:

fake.frequentStreetName() -> str

Verified availability: 1 locales. Example locales: hu_HU.

fake = SampleFactory(locale="hu_HU", seed=7).fake
value = fake.frequentStreetName()

fullName

Section titled “fullName”

fullName generates names and identity components for test profiles.

Orionis typed contract:

def fullName(gender: Literal['M', 'F', 'X'] | None=..., short: bool | None=...) -> str

Actual signature for uk_UA:

fake.fullName(gender: Literal['M', 'F', 'X'] | None = None, short: bool | None = False) -> str
ParameterPurpose
genderGender selection using supported locale-specific values.
shortRequests the localized abbreviated full name.

Verified availability: 1 locales. Example locales: uk_UA.

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

futureDate

Section titled “futureDate”

futureDate generates dates, times and intervals for temporal fixtures.

Orionis typed contract:

def futureDate(end_date: datetime.date | datetime.datetime | datetime.timedelta | str | int=...) -> datetime.date

Actual signature for en_US:

fake.futureDate(end_date: datetime.date | datetime.datetime | datetime.timedelta | str | int = '+30d') -> datetime.date
ParameterPurpose
end_dateEnd date/time boundary or relative interval.

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.futureDate()

futureDatetime

Section titled “futureDatetime”

futureDatetime generates dates, times and intervals for temporal fixtures.

Orionis typed contract:

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

Actual signature for en_US:

fake.futureDatetime(end_date: datetime.date | datetime.datetime | datetime.timedelta | str | int = '+30d', tzinfo: datetime.tzinfo | None = None) -> datetime.datetime
ParameterPurpose
end_dateEnd date/time boundary or relative interval.
tzinfoTimezone 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.futureDatetime()

gemstoneName

Section titled “gemstoneName”

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

Orionis typed contract:

def gemstoneName() -> str

Actual signature for en_PH:

fake.gemstoneName() -> str

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

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

getArguments

Section titled “getArguments”

Reads an argument or the group dict; missing groups/arguments return None. Returned dictionaries are native configuration objects.

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

Actual signature for en_US:

fake.getArguments(group: str, argument: str | None = None) -> Any

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.getArguments("small")

getProviders

Section titled “getProviders”

Returns registered provider instances. This is backend introspection rather than data generation; it is not a locale-independent method catalog.

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

Actual signature for en_US:

fake.getProviders() -> List[ForwardRef('BaseProvider')]

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.getProviders()

getWordsList

Section titled “getWordsList”

getWordsList generates placeholder text for content and forms.

Orionis typed contract:

def getWordsList(part_of_speech: str | None=..., ext_word_list: Sequence[str] | None=...) -> list[str]

Actual signature for en_US:

fake.getWordsList(part_of_speech: str | None = None, ext_word_list: Sequence[str] | None = None) -> List[str]
ParameterPurpose
part_of_speechVocabulary grammatical category where supported by the locale.
ext_word_listAlternative 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.getWordsList()

givenName

Section titled “givenName”

givenName generates names and identity components for test profiles.

Orionis typed contract:

def givenName() -> str

Actual signature for es_CL:

fake.givenName() -> str

Verified availability: 1 locales. Example locales: es_CL.

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

givenNameFemale

Section titled “givenNameFemale”

givenNameFemale generates names and identity components for test profiles.

Orionis typed contract:

def givenNameFemale() -> str

Actual signature for es_CL:

fake.givenNameFemale() -> str

Verified availability: 1 locales. Example locales: es_CL.

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

givenNameMale

Section titled “givenNameMale”

givenNameMale generates names and identity components for test profiles.

Orionis typed contract:

def givenNameMale() -> str

Actual signature for es_CL:

fake.givenNameMale() -> str

Verified availability: 1 locales. Example locales: es_CL.

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

globeArea2LandlineNumber

Section titled “globeArea2LandlineNumber”

globeArea2LandlineNumber generates fictional telephone numbers in local formats.

Orionis typed contract:

def globeArea2LandlineNumber() -> str

Actual signature for en_PH:

fake.globeArea2LandlineNumber() -> str

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

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

globeMobileNumber

Section titled “globeMobileNumber”

globeMobileNumber generates fictional telephone numbers in local formats.

Orionis typed contract:

def globeMobileNumber() -> str

Actual signature for en_PH:

fake.globeMobileNumber() -> str

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

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

globeMobileNumberPrefix

Section titled “globeMobileNumberPrefix”

globeMobileNumberPrefix generates fictional telephone numbers in local formats.

Orionis typed contract:

def globeMobileNumberPrefix() -> str

Actual signature for en_PH:

fake.globeMobileNumberPrefix() -> str

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

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

gou

Section titled “gou”

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

Orionis typed contract:

def gou() -> str

Actual signature for ja_JP:

fake.gou() -> str

Verified availability: 1 locales. Example locales: ja_JP.

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

gsis

Section titled “gsis”

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

Orionis typed contract:

def gsis() -> str

Actual signature for en_PH:

fake.gsis() -> str

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

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

gstin

Section titled “gstin”

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

Orionis typed contract:

def gstin() -> str

Actual signature for en_IN:

fake.gstin() -> str

Verified availability: 1 locales. Example locales: en_IN.

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

hexColor

Section titled “hexColor”

hexColor generates colors and representations for interface data.

Orionis typed contract:

def hexColor() -> str

Actual signature for en_US:

fake.hexColor() -> 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.hexColor()

hexify

Section titled “hexify”

Replaces template placeholders with hexadecimal digits; upper controls case.

Orionis typed contract:

def hexify(text: str=..., upper: bool=...) -> str

Actual signature for en_US:

fake.hexify(text: str = '^^^^', upper: bool = False) -> str
ParameterPurpose
textTemplate or text processed by the provider.
upperUses uppercase hexadecimal letters.

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.hexify()

highwayName

Section titled “highwayName”

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

Orionis typed contract:

def highwayName() -> str

Actual signature for es_CL:

fake.highwayName() -> str

Verified availability: 1 locales. Example locales: es_CL.

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

historicPeopleStreetName

Section titled “historicPeopleStreetName”

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

Orionis typed contract:

def historicPeopleStreetName() -> str

Actual signature for es_CL:

fake.historicPeopleStreetName() -> str

Verified availability: 1 locales. Example locales: es_CL.

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

hostname

Section titled “hostname”

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

Orionis typed contract:

def hostname(levels: int=...) -> str

Actual signature for en_US:

fake.hostname(levels: int = 1) -> str
ParameterPurpose
levelsNumber of domain/hostname levels.

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.hostname()

houseNumber

Section titled “houseNumber”

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

Orionis typed contract:

def houseNumber() -> str

Actual signature for az_AZ:

fake.houseNumber() -> str

Verified availability: 1 locales. Example locales: az_AZ.

fake = SampleFactory(locale="az_AZ", seed=7).fake
value = fake.houseNumber()

httpMethod

Section titled “httpMethod”

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

Orionis typed contract:

def httpMethod() -> str

Actual signature for en_US:

fake.httpMethod() -> 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.httpMethod()

httpStatusCode

Section titled “httpStatusCode”

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

Orionis typed contract:

def httpStatusCode(include_unassigned: bool=...) -> int

Actual signature for en_US:

fake.httpStatusCode(include_unassigned: bool = True) -> int
ParameterPurpose
include_unassignedIncludes unassigned or unused HTTP status codes.

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.httpStatusCode()