API¶
This part of the documentation covers all the public interfaces of Mimesis.
Random module¶
- class mimesis.random.Random(x=None)[source]¶
A custom random class.
It is a subclass of the
random.Randomclass from the standard library’s random module. The class incorporates additional custom methods.This class can be extended according to specific requirements.
- custom_code(mask='@###', char='@', digit='#')[source]¶
Generate custom code using ascii uppercase and random integers.
Keys module¶
The module mimesis.keys provides a set of key functions.
Key functions can be applied to fields and fieldsets using the key argument. These functions are applied after the field’s value is generated and before the field is returned to the caller.
- mimesis.keys.maybe(value, probability=0.5)[source]¶
Return a closure (a key function).
The returned closure itself returns either value or the first argument passed to closure with a certain probability (0.5 by default).
Builtin Data Providers¶
BrazilSpecProvider¶
DenmarkSpecProvider¶
NetherlandsSpecProvider¶
RussiaSpecProvider¶
- class mimesis.builtins.RussiaSpecProvider(seed=<mimesis.types._MissingSeed object>)[source]¶
Class that provides special data for Russia (ru).
- passport_number()[source]¶
Generate random passport number.
- Return type:
- Returns:
Number.
- Example:
560430
UkraineSpecProvider¶
USASpecProvider¶
PolandSpecProvider¶
Shortcuts¶
This module provides internal util functions.
Custom Exceptions¶
Custom exceptions which are used in Mimesis.
Base Providers¶
BaseProvider¶
- class mimesis.providers.BaseProvider(*, seed=<mimesis.types._MissingSeed object>, random=None)[source]¶
This is a base class for all providers.
- Attr:
random: Instance of
mimesis.random.Random.
- __init__(*, seed=<mimesis.types._MissingSeed object>, random=None)[source]¶
Initialize attributes.
Keep in mind, that locale-independent data providers will work only with keyword-only arguments since version 5.0.0.
BaseDataProvider¶
- class mimesis.providers.BaseDataProvider(locale=Locale.EN, seed=<mimesis.types._MissingSeed object>, *args, **kwargs)[source]¶
This is a base class for all data providers.
- __init__(locale=Locale.EN, seed=<mimesis.types._MissingSeed object>, *args, **kwargs)[source]¶
Initialize attributes for data providers.
Generic Providers¶
Generic¶
- class mimesis.Generic(locale=Locale.EN, seed=<mimesis.types._MissingSeed object>)[source]¶
Class which contain all providers at one.
- __init__(locale=Locale.EN, seed=<mimesis.types._MissingSeed object>)[source]¶
Initialize attributes lazily.
- add_provider(cls, **kwargs)[source]¶
Add a custom provider to Generic() object.
- Parameters:
cls (
Type[BaseProvider]) – Custom provider.kwargs (
Any) – Keyword arguments for provider.
- Raises:
TypeError – if cls is Generic, if cls is not class or is not a subclass of BaseProvider.
- Return type:
- Returns:
Absolutely none.
- add_providers(*providers)[source]¶
Add numerous custom providers to the
Genericobject.This method is a convenience method for adding multiple providers at once. It is equivalent to calling
add_provider()for each provider in the list of providers.Example:
>>> from mimesis import Generic >>> from myproviders import ProviderA, ProviderB >>> g = Generic() >>> g.add_providers(ProviderA, ProviderB) >>> g.providera.never() >>> g.providerb.gonna()
If you want to pass keyword arguments to the providers, you can do so by using
add_provider()instead.- Parameters:
providers (
Type[BaseProvider]) – Custom providers.- Return type:
- Returns:
None
Locale-Dependent Providers¶
Address¶
- class mimesis.Address(locale=Locale.EN, seed=<mimesis.types._MissingSeed object>, *args, **kwargs)[source]¶
Class for generate fake address data.
This object provides all the data related to geographical location.
- calling_code()[source]¶
Get a random calling code of random country.
- Return type:
- Returns:
Calling code.
- country_code(code=CountryCode.A2)[source]¶
Get a random code of country.
Default format is
A2(ISO 3166-1-alpha2), you can change it by passing parameterfmtwith enum objectCountryCode.- Parameters:
code (
Optional[CountryCode]) – Enum object CountryCode.- Return type:
- Returns:
Country code in selected format.
- Raises:
KeyError – if fmt is not supported.
- default_country()[source]¶
Get the country associated with the current locale.
- Return type:
- Returns:
The country associated with current locale.
- postal_code()[source]¶
Generate a postal code for current locale.
- Return type:
- Returns:
Postal code.
- zip_code()[source]¶
Generate a zip code.
An alias for
postal_code().- Return type:
- Returns:
Zip code.
Finance¶
- class mimesis.Finance(locale=Locale.EN, seed=<mimesis.types._MissingSeed object>, *args, **kwargs)[source]¶
Class for generating finance data.
- cryptocurrency_iso_code()[source]¶
Get symbol of random cryptocurrency.
- Return type:
- Returns:
Symbol of cryptocurrency.
- cryptocurrency_symbol()[source]¶
Get a cryptocurrency symbol.
- Return type:
- Returns:
Symbol of cryptocurrency.
- currency_symbol()[source]¶
Get a currency symbol for current locale.
- Return type:
- Returns:
Currency symbol.
Datetime¶
- class mimesis.Datetime(locale=Locale.EN, seed=<mimesis.types._MissingSeed object>, *args, **kwargs)[source]¶
Class for generating data related to the date and time.
- static bulk_create_datetimes(date_start, date_end, **kwargs)[source]¶
Bulk create datetime objects.
This method creates list of datetime objects from
date_starttodate_end.You can use the following keyword arguments:
dayshoursminutessecondsmicroseconds
Warning
Empty
**kwargsproduces timedelta(0) which obviously cannot be used as step, so you have to pass valid**kwargsfordatetime.timedeltawhich will be used as a step by whichdate_startwill be incremented until it reachesdate_endto avoid infinite loop which eventually leads toOverflowError.See
datetime.timedeltafor more details.- Parameters:
date_start (
datetime) – Begin of the range.date_end (
datetime) – End of the range.kwargs (
Any) – Keyword arguments fordatetime.timedelta
- Return type:
- Returns:
List of datetime objects
- Raises:
ValueError: When
date_start/date_endnot passed, whendate_startlarger thandate_endor when the given keywords for datetime.timedelta represent a non-positive timedelta.
- day_of_month()[source]¶
Generate a random day of month, from 1 to 31.
- Return type:
- Returns:
Random value from 1 to 31.
- formatted_datetime(fmt='', **kwargs)[source]¶
Generate datetime string in human-readable format.
- Parameters:
fmt (
str) – Custom format (default is format for current locale)kwargs (
Any) – Keyword arguments fordatetime()
- Return type:
- Returns:
Formatted datetime string.
- timestamp(fmt=TimestampFormat.POSIX, **kwargs)[source]¶
Generate random timestamp in given format.
Supported formats are:
TimestampFormat.POSIX
TimestampFormat.RFC_3339
TimestampFormat.ISO_8601
Example:
>>> from mimesis import Datetime >>> from mimesis.enums import TimestampFormat >>> dt = Datetime() >>> dt.timestamp(fmt=TimestampFormat.POSIX) 1697322442 >>> dt.timestamp(fmt=TimestampFormat.RFC_3339) '2023-12-08T18:46:34' >>> dt.timestamp(fmt=TimestampFormat.ISO_8601) '2009-05-30T21:45:57.328600'
- Parameters:
fmt (
TimestampFormat) – Format of timestamp (Default is TimestampFormat.POSIX).kwargs (
Any) – Kwargs fordatetime().
- Return type:
- Returns:
Timestamp.
- timezone(region=None)[source]¶
Get a random timezone.
- Parameters:
region (
Optional[TimezoneRegion]) – Timezone region.- Return type:
- Returns:
Timezone.
Food¶
- class mimesis.Food(locale=Locale.EN, seed=<mimesis.types._MissingSeed object>, *args, **kwargs)[source]¶
Class for generating data related to food.
Person¶
- class mimesis.Person(*args, **kwargs)[source]¶
Class for generating personal data.
- __init__(*args, **kwargs)[source]¶
Initialize attributes.
- Parameters:
locale – Current locale.
seed – Seed.
- academic_degree()[source]¶
Get a random academic degree.
- Return type:
- Returns:
Degree.
- Example:
Bachelor.
- blood_type()[source]¶
Get a random blood type.
- Return type:
- Returns:
Blood type (blood group).
- Example:
A+
- email(domains=None, unique=False)[source]¶
Generate a random email.
- Parameters:
- Return type:
- Returns:
Email address.
- Raises:
ValueError – if «unique» is True and the provider was seeded.
- Example:
- gender(iso5218=False, symbol=False)[source]¶
Get a random gender.
Get a random title of gender, code for the representation of human sexes is an international standard that defines a representation of human sexes through a language-neutral single-digit code or symbol of gender.
- identifier(mask='##-##/##')[source]¶
Generate a random identifier by mask.
With this method you can generate any identifiers that you need. Simply select the mask that you need.
- political_views()[source]¶
Get a random political views.
- Return type:
- Returns:
Political views.
- Example:
Liberal.
- sex(*args, **kwargs)[source]¶
An alias for method self.gender().
See docstrings of method self.gender() for details.
- title(gender=None, title_type=None)[source]¶
Generate a random title for name.
You can generate random prefix or suffix for name using this method.
- username(mask=None, drange=(1800, 2100))[source]¶
Generate username by mask.
Masks allow you to generate a variety of usernames.
C stands for capitalized username.
U stands for uppercase username.
l stands for lowercase username.
d stands for digits in the username.
You can also use symbols to separate the different parts of the username: . _ -
- Parameters:
- Raises:
ValueError – If template is not supported.
- Return type:
- Returns:
Username as string.
- Example:
>>> username(mask='C_C_d') Cotte_Article_1923 >>> username(mask='U.l.d') ELKINS.wolverine.2013 >>> username(mask='l_l_d', drange=(1900, 2021)) plasmic_blockader_1907
Text¶
- class mimesis.Text(locale=Locale.EN, seed=<mimesis.types._MissingSeed object>, *args, **kwargs)[source]¶
Class for generating text data.
- answer()[source]¶
Get a random answer in current language.
- Return type:
- Returns:
An answer.
- Example:
No
- level()[source]¶
Generate a random level of danger or something else.
- Return type:
- Returns:
Level.
- Example:
critical.
- quote()[source]¶
Get a random quote.
- Return type:
- Returns:
Quote from movie.
- Example:
“Bond… James Bond.”
Locale-Independent Providers¶
BinaryFile¶
- class mimesis.BinaryFile(*args, **kwargs)[source]¶
Class for generating binary data
- __init__(*args, **kwargs)[source]¶
Initialize attributes.
- Parameters:
locale – Current locale.
seed – Seed.
- audio(*, file_type=AudioFile.MP3)[source]¶
Generates audio file of given format and returns it as bytes.
Note
This method accepts keyword-only arguments.
- compressed(*, file_type=CompressedFile.ZIP)[source]¶
Generates compressed file of given format and returns it as bytes.
Note
This method accepts keyword-only arguments.
- Parameters:
file_type (
CompressedFile) – File extension.- Return type:
- Returns:
File as a sequence of bytes.
- document(*, file_type=DocumentFile.PDF)[source]¶
Generates document of given format and returns it as bytes.
Note
This method accepts keyword-only arguments.
- Parameters:
file_type (
DocumentFile) – File extension.- Return type:
- Returns:
File as a sequence of bytes.
Code¶
- class mimesis.Code(*, seed=<mimesis.types._MissingSeed object>, random=None)[source]¶
A class, which provides methods for generating codes.
- ean(fmt=None)[source]¶
Generate EAN.
To change EAN format, pass parameter
codewith needed value of the enum objectEANFormat.- Parameters:
- Return type:
- Returns:
EAN.
- Raises:
NonEnumerableError – if code is not enum EANFormat.
- isbn(fmt=None, locale=Locale.EN)[source]¶
Generate ISBN for current locale.
To change ISBN format, pass parameter
codewith needed value of the enum objectISBNFormat- Parameters:
fmt (
Optional[ISBNFormat]) – ISBN format.locale (
Locale) – Locale code.
- Return type:
- Returns:
ISBN.
- Raises:
NonEnumerableError – if code is not enum ISBNFormat.
Choice¶
Cryptographic¶
- class mimesis.Cryptographic(*, seed=<mimesis.types._MissingSeed object>, random=None)[source]¶
Class that provides cryptographic data.
- hash(algorithm=None)[source]¶
Generate random hash.
To change hashing algorithm, pass parameter
algorithmwith needed value of the enum objectAlgorithmWarning
Seed is not applicable to this method, because of its cryptographic-safe nature.
- Parameters:
- Return type:
- Returns:
Hash.
- Raises:
NonEnumerableError – When algorithm is unsupported.
- mnemonic_phrase()[source]¶
Generate BIP-39-compatible mnemonic phrase.
- Return type:
- Returns:
Mnemonic phrase.
- static token_bytes(entropy=32)[source]¶
Generate byte string containing
entropybytes.The string has
entropyrandom bytes, each byte converted to two hex digits.Warning
Seed is not applicable to this method, because of its cryptographic-safe nature.
- static token_hex(entropy=32)[source]¶
Return a random text string, in hexadecimal.
The string has entropy random bytes, each byte converted to two hex digits. If entropy is
Noneor not supplied, a reasonable default is used.Warning
Seed is not applicable to this method, because of its cryptographic-safe nature.
Development¶
- class mimesis.Development(*args, **kwargs)[source]¶
Class for getting fake data for Developers.
- __init__(*args, **kwargs)[source]¶
Initialize attributes.
Keep in mind, that locale-independent data providers will work only with keyword-only arguments since version 5.0.0.
- Parameters:
seed – Seed for random. When set to None the current system time is used.
random – Custom random. See https://github.com/lk-geimfari/mimesis/issues/1313 for details.
- ility()[source]¶
Get a random system quality attribute.
An alias for system_quality_attribute().
- Return type:
- os()[source]¶
Get a random operating system or distributive name.
- Return type:
- Returns:
The name of OS.
- Example:
Gentoo
- programming_language()[source]¶
Get a random programming language from the list.
- Return type:
- Returns:
Programming language.
- Example:
Erlang.
- software_license()[source]¶
Get a random software license.
- Return type:
- Returns:
License name.
- Example:
The BSD 3-Clause License.
- system_quality_attribute()[source]¶
Get a random system quality attribute.
Within systems engineering, quality attributes are realized non-functional requirements used to evaluate the performance of a system. These are sometimes named “ilities” after the suffix many of the words share.
- Return type:
- Returns:
System quality attribute.
File¶
- class mimesis.File(*, seed=<mimesis.types._MissingSeed object>, random=None)[source]¶
Class for generate data related to files.
Hardware¶
- class mimesis.Hardware(*, seed=<mimesis.types._MissingSeed object>, random=None)[source]¶
Class for generate data related to hardware.
- cpu_codename()[source]¶
Get a random CPU code name.
- Return type:
- Returns:
CPU code name.
- Example:
Cannonlake.
- cpu_frequency()[source]¶
Get a random frequency of CPU.
- Return type:
- Returns:
Frequency of CPU.
- Example:
4.0 GHz.
- generation()[source]¶
Get a random generation.
- Return type:
- Returns:
Generation of something.
- Example:
6th Generation.
- graphics()[source]¶
Get a random graphics.
- Return type:
- Returns:
Graphics.
- Example:
Intel® Iris™ Pro Graphics 6200.
- manufacturer()[source]¶
Get a random manufacturer.
- Return type:
- Returns:
Manufacturer.
- Example:
Dell.
- phone_model()[source]¶
Get a random phone model.
- Return type:
- Returns:
Phone model.
- Example:
Nokia Lumia 920.
- resolution()[source]¶
Get a random screen resolution.
- Return type:
- Returns:
Resolution of screen.
- Example:
1280x720.
Internet¶
- class mimesis.Internet(*args, **kwargs)[source]¶
Class for generating data related to the internet.
- content_type(mime_type=None)[source]¶
Get a random HTTP content type.
- Return type:
- Returns:
Content type.
- Example:
application/json
- emoji()[source]¶
Get a random emoji shortcut code.
- Return type:
- Returns:
Emoji code.
- Example:
- kissing:
- hashtags(quantity=4)[source]¶
Generate a list of hashtags.
- Parameters:
quantity (
int) – The quantity of hashtags.- Return type:
- Returns:
The list of hashtags.
- Raises:
NonEnumerableError – if category is not in Hashtag.
- Example:
[‘#love’, ‘#sky’, ‘#nice’]
- http_request_headers()[source]¶
Generates a random HTTP request headers.
The following headers are included:
Referer
Authorization
Cookie
User-Agent
X-CSRF-Token
Content-Type
Content-Length
Connection
Cache-Control
Accept
Host
Accept-Language
- http_response_headers()[source]¶
Generate a random HTTP response headers.
The following headers are included:
Allow
Age
Server
Content-Type
X-Request-ID
Content-Language
Content-Location
Set-Cookie
Upgrade-Insecure-Requests
X-Content-Type-Options
X-XSS-Protection
Connection
X-Frame-Options
Content-Encoding
Cross-Origin-Opener-Policy
Cross-Origin-Resource-Policy
Strict-Transport-Security
- http_status_code()[source]¶
Get a random HTTP status code.
- Return type:
- Returns:
HTTP status.
- Example:
200
- http_status_message()[source]¶
Get a random HTTP status message.
- Return type:
- Returns:
HTTP status message.
- Example:
200 OK
- ip_v4_object()[source]¶
Generate random
ipaddress.IPv4Addressobject.- Return type:
- Returns:
ipaddress.IPv4Addressobject.
- ip_v6()[source]¶
Generate a random IPv6 address as string.
- Return type:
- Returns:
IPv6 address string.
- Example:
2001:c244:cf9d:1fb1:c56d:f52c:8a04:94f3
- ip_v6_object()[source]¶
Generate random
ipaddress.IPv6Addressobject.- Return type:
- Returns:
ipaddress.IPv6Addressobject.
- mac_address()[source]¶
Generate a random MAC address.
- Return type:
- Returns:
Random MAC address.
- Example:
00:16:3e:25:e7:f1
- port(port_range=PortRange.ALL)[source]¶
Generate random port.
- Parameters:
port_range (
PortRange) – PortRange enum object.- Return type:
- Returns:
Port number.
- Raises:
NonEnumerableError – if port_range is not in PortRange.
- Example:
8080
- static stock_image_url(width=1920, height=1080, keywords=None)[source]¶
Generate a random stock image URL hosted on Unsplash.
See «Random search term» on https://source.unsplash.com/ for more details.
- tld(*args, **kwargs)[source]¶
Generates random top level domain.
An alias for
top_level_domain()- Return type:
- top_level_domain(tld_type=TLDType.CCTLD)[source]¶
Generates random top level domain.
- Parameters:
tld_type (
TLDType) – Enum objectenums.TLDType- Return type:
- Returns:
Top level domain.
- Raises:
NonEnumerableError – if tld_type not in
enums.TLDType.
- uri(scheme=URLScheme.HTTPS, tld_type=None, subdomains=None, query_params_count=None)[source]¶
Generate a random URI.
Numeric¶
- class mimesis.Numeric(*args, **kwargs)[source]¶
A provider for generating numeric data.
- __init__(*args, **kwargs)[source]¶
Initialize attributes.
Keep in mind, that locale-independent data providers will work only with keyword-only arguments since version 5.0.0.
- Parameters:
seed – Seed for random. When set to None the current system time is used.
random – Custom random. See https://github.com/lk-geimfari/mimesis/issues/1313 for details.
- complex_number(start_real=0.0, end_real=1.0, start_imag=0.0, end_imag=1.0, precision_real=15, precision_imag=15)[source]¶
Generate a random complex number.
- Parameters:
start_real (
float) – Start real range.end_real (
float) – End real range.start_imag (
float) – Start imaginary range.end_imag (
float) – End imaginary range.precision_real (
int) – Round a real part of number to a given precision.precision_imag (
int) – Round the imaginary part of number to a given precision.
- Return type:
- Returns:
Complex numbers.
- complexes(start_real=0, end_real=1, start_imag=0, end_imag=1, precision_real=15, precision_imag=15, n=10)[source]¶
Generate a list of random complex numbers.
- Parameters:
start_real (
float) – Start real range.end_real (
float) – End real range.start_imag (
float) – Start imaginary range.end_imag (
float) – End imaginary range.precision_real (
int) – Round a real part of number to a given precision.precision_imag (
int) – Round the imaginary part of number to a given precision.n (
int) – Length of the list.
- Return type:
- Returns:
A list of random complex numbers.
- decimal_number(start=-1000.0, end=1000.0)[source]¶
Generate random decimal number.
- Parameters:
- Return type:
- Returns:
decimal.Decimalobject.
- decimals(start=0.0, end=1000.0, n=10)[source]¶
Generate a decimal number as
decimal.Decimalobjects.
- float_number(start=-1000.0, end=1000.0, precision=15)[source]¶
Generate random float number in range [start, end].
- increment(accumulator=None)[source]¶
Generate incremental number.
Each call of this method returns an incrementing number (with the step of +1).
If accumulator passed then increments number associated with it.
- Example:
>>> self.increment() 1 >>> self.increment(accumulator="a") 1 >>> self.increment() 2 >>> self.increment(accumulator="a") 2 >>> self.increment(accumulator="b") 1 >>> self.increment(accumulator="a") 3
- integers(start=0, end=10, n=10)[source]¶
Generate a list of random integers.
Integers can be negative or positive numbers. .. note: You can use both positive and negative numbers.
Path¶
- class mimesis.Path(platform='linux', *args, **kwargs)[source]¶
Class that provides methods and property for generate paths.
- __init__(platform='linux', *args, **kwargs)[source]¶
Initialize attributes.
Supported platforms: ‘linux’, ‘darwin’, ‘win32’, ‘win64’.
- Parameters:
platform (
str) – Required platform type.
- dev_dir()[source]¶
Generate a random path to development directory.
- Return type:
- Returns:
Path.
- Example:
/home/sherrell/Development/Python
- project_dir()[source]¶
Generate a random path to project directory.
- Return type:
- Returns:
Path to project.
- Example:
/home/sherika/Development/Falcon/mercenary
Payment¶
- class mimesis.Payment(*args, **kwargs)[source]¶
Class that provides data related to payments.
- bitcoin_address()[source]¶
Generate a random bitcoin address.
Keep in mind that although it generates valid-looking addresses, it does not mean that they are actually valid.
- Return type:
- Returns:
Bitcoin address.
- Example:
3EktnHQD7RiAE6uzMj2ZifT9YgRrkSgzQX
- credit_card_expiration_date(minimum=16, maximum=25)[source]¶
Generate a random expiration date for credit card.
- credit_card_network()[source]¶
Generate a random credit card network.
- Return type:
- Returns:
Credit card network
- Example:
MasterCard
- credit_card_number(card_type=None)[source]¶
Generate a random credit card number.
- Parameters:
card_type (
Optional[CardType]) – Issuing Network. Default is Visa.- Return type:
- Returns:
Credit card number.
- Raises:
NotImplementedError – if card_type not supported.
- Example:
4455 5299 1152 2450
- ethereum_address()[source]¶
Generate a random Ethereum address.
..note: The address will look like Ethereum address, but keep in mind that it is not the valid address.
- Return type:
- Returns:
Ethereum address.
- Example:
0xe8ece9e6ff7dba52d4c07d37418036a89af9698d
Transport¶
- class mimesis.Transport(*, seed=<mimesis.types._MissingSeed object>, random=None)[source]¶
Class for generating data related to transports.
- airplane()[source]¶
Generate a dummy airplane model.
- Return type:
- Returns:
Airplane model.
- Example:
Boeing 727.
Science¶
- class mimesis.Science(*, seed=<mimesis.types._MissingSeed object>, random=None)[source]¶
Class for generating pseudo-scientific data.
- measure_unit(name=None, symbol=False)[source]¶
Get unit name from International System of Units.
- Parameters:
name (
Optional[MeasureUnit]) – Enum object UnitName.symbol (
bool) – Return only symbol
- Return type:
- Returns:
Unit.
- metric_prefix(sign=None, symbol=False)[source]¶
Get a random prefix for the International System of Units.
- Parameters:
sign (
Optional[MetricPrefixSign]) – Sing of prefix (positive/negative).symbol (
bool) – Return the symbol of the prefix.
- Return type:
- Returns:
Metric prefix for SI measure units.
- Raises:
NonEnumerableError – if sign is not supported.
- Example:
mega
Schema-based Generators¶
BaseField¶
- class mimesis.schema.BaseField(locale=Locale.EN, seed=<mimesis.types._MissingSeed object>, providers=None)[source]¶
-
- perform(name=None, key=None, **kwargs)[source]¶
Performs the value of the field by its name.
It takes any string which represents the name of any method of any supported data provider and the
**kwargsof this method.Note
Some data providers have methods with the same names and in such cases, you can explicitly define that the method belongs to data-provider
name='provider.name'otherwise it will return the data from the first provider which has a methodname.Allowed delimiters:
.,:,/and space:provider.nameprovider:nameprovider/nameprovider name
You can apply a key function to the result returned by the method, by passing a parameter key with a callable object which returns the final result.
The key function has the option to accept two parameters: result and random. In case you require access to a random instance within the key function, you must modify the function to accept both of them, where the first corresponds to the method result and the second corresponds to the instance of random.
- Parameters:
- Return type:
- Returns:
Value which represented by method.
- Raises:
ValueError – if provider not supported or if field not defined.
Field¶
- class mimesis.schema.Field(locale=Locale.EN, seed=<mimesis.types._MissingSeed object>, providers=None)[source]¶
Greedy field.
The field which evaluates immediately.
Warning
There is no case when you need to instance field in loops.
If you are doing this:
>>> for i in range(1000): ... field = Field()
You’re doing it wrong! It is a terrible idea that will lead to a memory leak.
Forewarned is forearmed.
Here is an example of how to use it:
>>> _ = Field() >>> _('username') Dogtag_1836
Fieldset¶
- class mimesis.schema.Fieldset(*args, **kwargs)[source]¶
Greedy fieldset (evaluates immediately).
Works like a field, but returns a list of values.
Here is an example:
>>> fieldset = Fieldset(i=100) >>> fieldset('username') ['pot_1821', 'vhs_1915', ..., 'reviewed_1849']
You may also specify the number of iterations by passing the i keyword argument to the callable instance of fieldset:
>>> fieldset = Fieldset() >>> fieldset('username', i=2) ['pot_1821', 'vhs_1915']
When i is not specified, the reasonable default is used — 10.
See “Field vs Fieldset” section of documentation for more details.
- Variables:
fieldset_default_iterations – Default iterations. Default is 10.
fieldset_iterations_kwarg – Keyword argument for iterations. Default is i.
Schema¶
- class mimesis.schema.Schema(schema, iterations=10)[source]¶
Class which return list of filled schemas.
- create()[source]¶
Creates a list of a fulfilled schemas.
Note
This method evaluates immediately, so be careful when creating large datasets otherwise you’re risking running out of memory.
If you need a lazy version of this method, see
iterator().
- to_csv(file_path, **kwargs)[source]¶
Export a schema as a CSV file.
- Parameters:
file_path (
str) – File path.kwargs (
Any) – The keyword arguments forcsv.DictWriterclass.
- Return type:
New in version 5.3.0
- to_json(file_path, **kwargs)[source]¶
Export a schema as a JSON file.
- Parameters:
file_path (
str) – File path.kwargs (
Any) – Extra keyword arguments forjson.dump()class.
- Return type:
New in version 5.3.0
Enums¶
Implements enums for a lot of methods.
Enums from this module are used in a lot of methods. You should always import enums from this module if you want behavior for the methods that differ from the default behavior.
You should never use your own enums in methods because in this case, there no guarantee that you will get the result which you actually expected.
Below you can see an example of usage enums in methods of data providers.
- class mimesis.enums.Algorithm(value)[source]¶
Provides algorithms which available.
An argument for
hash().- BLAKE2B = 'blake2b'¶
- BLAKE2S = 'blake2s'¶
- MD5 = 'md5'¶
- SHA1 = 'sha1'¶
- SHA224 = 'sha224'¶
- SHA256 = 'sha256'¶
- SHA384 = 'sha384'¶
- SHA512 = 'sha512'¶
- class mimesis.enums.AudioFile(value)[source]¶
Provides the audio file types.
An argument for
audio()- AAC = 'aac'¶
- MP3 = 'mp3'¶
- class mimesis.enums.CardType(value)[source]¶
Provides credit card types.
An argument for
credit_card_number().- AMERICAN_EXPRESS = 'American Express'¶
- MASTER_CARD = 'MasterCard'¶
- VISA = 'Visa'¶
- class mimesis.enums.CompressedFile(value)[source]¶
Provides the compressed file types.
An argument for
compressed()- GZIP = 'gz'¶
- ZIP = 'zip'¶
- class mimesis.enums.CountryCode(value)[source]¶
Provides types of country codes.
An argument for
country_code().- A2 = 'a2'¶
- A3 = 'a3'¶
- FIFA = 'fifa'¶
- IOC = 'ioc'¶
- NUMERIC = 'numeric'¶
- class mimesis.enums.DSNType(value)[source]¶
An enumeration.
- COUCHBASE = ('couchbase', 8092)¶
- MEMCACHED = ('memcached', 11211)¶
- MONGODB = ('mongodb', 27017)¶
- MYSQL = ('mysql', 3306)¶
- POSTGRES = ('postgres', 5432)¶
- RABBITMQ = ('rabbitmq', 5672)¶
- REDIS = ('redis', 6379)¶
- class mimesis.enums.DocumentFile(value)[source]¶
Provides the document file types.
An argument for
document()- DOCX = 'docx'¶
- PDF = 'pdf'¶
- PPTX = 'pptx'¶
- XLSX = 'xlsx'¶
- class mimesis.enums.EANFormat(value)[source]¶
Provides formats of EAN.
An argument for
ean().- EAN13 = 'ean-13'¶
- EAN8 = 'ean-8'¶
- class mimesis.enums.FileType(value)[source]¶
Provides file types.
An argument for
extension()andfile_name().- AUDIO = 'audio'¶
- COMPRESSED = 'compressed'¶
- DATA = 'data'¶
- EXECUTABLE = 'executable'¶
- IMAGE = 'image'¶
- SOURCE = 'source'¶
- TEXT = 'text'¶
- VIDEO = 'video'¶
- class mimesis.enums.Gender(value)[source]¶
Represents genders.
An argument for a lot of methods which are taking parameter
gender.- FEMALE = 'female'¶
- MALE = 'male'¶
- class mimesis.enums.ISBNFormat(value)[source]¶
Provides formats of ISBN.
An argument for
isbn().- ISBN10 = 'isbn-10'¶
- ISBN13 = 'isbn-13'¶
- class mimesis.enums.ImageFile(value)[source]¶
Provides the image file types.
An argument for
image()- GIF = 'gif'¶
- JPG = 'jpg'¶
- PNG = 'png'¶
- class mimesis.enums.Locale(value)[source]¶
This class provides access to the supported locales from one place.
An argument for all locale-depend providers.
- CS = 'cs'¶
- DA = 'da'¶
- DE = 'de'¶
- DEFAULT = 'en'¶
- DE_AT = 'de-at'¶
- DE_CH = 'de-ch'¶
- EL = 'el'¶
- EN = 'en'¶
- EN_AU = 'en-au'¶
- EN_CA = 'en-ca'¶
- EN_GB = 'en-gb'¶
- ES = 'es'¶
- ES_MX = 'es-mx'¶
- ET = 'et'¶
- FA = 'fa'¶
- FI = 'fi'¶
- FR = 'fr'¶
- HU = 'hu'¶
- IS = 'is'¶
- IT = 'it'¶
- JA = 'ja'¶
- KK = 'kk'¶
- KO = 'ko'¶
- NL = 'nl'¶
- NL_BE = 'nl-be'¶
- NO = 'no'¶
- PL = 'pl'¶
- PT = 'pt'¶
- PT_BR = 'pt-br'¶
- RU = 'ru'¶
- SK = 'sk'¶
- SV = 'sv'¶
- TR = 'tr'¶
- UK = 'uk'¶
- ZH = 'zh'¶
- class mimesis.enums.MeasureUnit(value)[source]¶
Provide unit names.
An argument for
measure_unit().- AMOUNT_OF_SUBSTANCE = ('mole', 'mol')¶
- ANGLE = ('radian', 'r')¶
- ELECTRICAL_CONDUCTANCE = ('siemens', 'S')¶
- ELECTRIC_CAPACITANCE = ('farad', 'F')¶
- ELECTRIC_CHARGE = ('coulomb', 'C')¶
- ELECTRIC_RESISTANCE = ('ohm', 'Ω')¶
- ENERGY = ('joule', 'J')¶
- FLUX = ('watt', 'W')¶
- FORCE = ('newton', 'N')¶
- FREQUENCY = ('hertz', 'Hz')¶
- INDUCTANCE = ('henry', 'H')¶
- INFORMATION = ('byte', 'b')¶
- MAGNETIC_FLUX = ('weber', 'Wb')¶
- MAGNETIC_FLUX_DENSITY = ('tesla', 'T')¶
- MASS = ('gram', 'gr')¶
- POWER = ('watt', 'W')¶
- PRESSURE = ('pascal', 'P')¶
- RADIOACTIVITY = ('becquerel', 'Bq')¶
- SOLID_ANGLE = ('steradian', '㏛')¶
- TEMPERATURE = ('Celsius', '°C')¶
- THERMODYNAMIC_TEMPERATURE = ('kelvin', 'K')¶
- VOLTAGE = ('volt', 'V')¶
- class mimesis.enums.MetricPrefixSign(value)[source]¶
Provides prefix signs.
An argument for
metric_prefix()`().- NEGATIVE = 'negative'¶
- POSITIVE = 'positive'¶
- class mimesis.enums.MimeType(value)[source]¶
Provides common mime types.
An argument for
mime_type().- APPLICATION = 'application'¶
- AUDIO = 'audio'¶
- IMAGE = 'image'¶
- MESSAGE = 'message'¶
- TEXT = 'text'¶
- VIDEO = 'video'¶
- class mimesis.enums.NumType(value)[source]¶
Provides the number types.
An argument for
matrix().- COMPLEX = 'complexes'¶
- DECIMAL = 'decimals'¶
- FLOAT = 'floats'¶
- INTEGER = 'integers'¶
- class mimesis.enums.PortRange(value)[source]¶
Represents port ranges.
An argument for
port().- ALL = (1, 65535)¶
- EPHEMERAL = (49152, 65535)¶
- REGISTERED = (1024, 49151)¶
- WELL_KNOWN = (1, 1023)¶
- class mimesis.enums.TLDType(value)[source]¶
Provides top level domain types.
An argument for a few methods which are taking parameter tld_type.
- CCTLD = 'cctld'¶
- GEOTLD = 'geotld'¶
- GTLD = 'gtld'¶
- STLD = 'stld'¶
- UTLD = 'utld'¶
- class mimesis.enums.TimestampFormat(value)[source]¶
An enumeration.
- ISO_8601 = 2¶
- POSIX = 1¶
- RFC_3339 = 3¶
- class mimesis.enums.TimezoneRegion(value)[source]¶
Provides regions of timezones.
An argument for
timezone().- AFRICA = 'Africa'¶
- AMERICA = 'America'¶
- ANTARCTICA = 'Antarctica'¶
- ARCTIC = 'Arctic'¶
- ASIA = 'Asia'¶
- ATLANTIC = 'Atlantic'¶
- AUSTRALIA = 'Australia'¶
- EUROPE = 'Europe'¶
- INDIAN = 'Indian'¶
- PACIFIC = 'Pacific'¶
- class mimesis.enums.TitleType(value)[source]¶
Represents title types.
An argument for
title().- ACADEMIC = 'academic'¶
- TYPICAL = 'typical'¶
