"""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 is no guarantee that you will get the result which you actually expected.
Below, you can see an example of using enums in methods of data providers.
"""
from enum import Enum, auto
[docs]
class IPv4Purpose(Enum):
"""Provides IPv4 address ranges for different purposes.
An argument for :meth:`~mimesis.Internet.special_ip_v4_object()`.
We use integer representation of IP addresses instead of
IPv4Network objects for better performance.
"""
THIS_NETWORK = (0, 16_777_215)
AMT = (3_224_682_752, 3_224_683_007)
LOOBACK = (2_130_706_432, 2_147_483_647)
AS112_V4 = (3_223_307_264, 3_223_307_519)
LINK_LOCAL = (2_851_995_648, 2_852_061_183)
TEST_NET_1 = (3_221_225_984, 3_221_226_239)
TEST_NET_2 = (3_325_256_704, 3_325_256_959)
TEST_NET_3 = (3_405_803_776, 3_405_804_031)
BENCHMARKING = (3_323_068_416, 3_323_199_487)
PRIVATE_USE_1 = (167_772_160, 184_549_375)
PRIVATE_USE_2 = (2_886_729_728, 2_887_778_303)
PRIVATE_USE_3 = (3_232_235_520, 3_232_301_055)
RESERVED = (4_026_531_840, 4_294_967_295)
SHARE_ADDRESS_SPACE = (1_681_915_904, 1_686_110_207)
LIMITED_BROADCAST = (4_294_967_295, 4_294_967_295)
IPV4_DUMMY_ADDRESS = (3_221_225_480, 3_221_225_480)
TURN_RELAY_ANYCAST = (3_221_225_482, 3_221_225_482)
IETF_PROTOCOL_ASSIGNMENTS = (3_221_225_472, 3_221_225_727)
PORT_CONTROL_PROTOCOL_ANYCAST = (3_221_225_481, 3_221_225_481)
IPV4_SERVICE_CONTINUITY_PREFIX = (3_221_225_472, 3_221_225_479)
DIRECT_DELEGATION_AS112_SERVICE = (3_232_706_560, 3_232_706_815)
[docs]
class DurationUnit(Enum):
"""Provides duration units.
An argument for :meth:`~mimesis.Datetime.duration()`.
"""
WEEKS = "weeks"
DAYS = "days"
HOURS = "hours"
MINUTES = "minutes"
SECONDS = "seconds"
MILLISECONDS = "milliseconds"
MICROSECONDS = "microseconds"
[docs]
class Locale(Enum):
"""This class provides access to the supported locales from one place.
An argument for all locale-dependent providers.
"""
AR_AE = "ar-ae"
AR_DZ = "ar-dz"
AR_EG = "ar-eg"
AR_JO = "ar-jo"
AR_OM = "ar-om"
AR_KW = "ar-kw"
AR_MA = "ar-ma"
AR_QA = "ar-qa"
AR_SA = "ar-sa"
AR_SY = "ar-sy"
AR_TN = "ar-tn"
AR_YE = "ar-ye"
AZ = "az"
CS = "cs"
DA = "da"
DE = "de"
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"
HR = "hr"
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"
DEFAULT = EN
[docs]
@classmethod
def values(cls) -> list[str]:
"""Return a list of all locale values."""
return [i.value for i in cls.__members__.values()]
[docs]
class PortRange(Enum):
"""Represents port ranges.
An argument for :meth:`~mimesis.Internet.port()`.
"""
ALL = (1, 65535)
WELL_KNOWN = (1, 1023)
EPHEMERAL = (49152, 65535)
REGISTERED = (1024, 49151)
[docs]
class Gender(Enum):
"""Represents genders.
An argument for a lot of methods which take the parameter ``gender``.
"""
MALE = "male"
FEMALE = "female"
[docs]
class TitleType(Enum):
"""Represents title types.
An argument for :meth:`~mimesis.Person.title()`.
"""
TYPICAL = "typical"
ACADEMIC = "academic"
[docs]
class CardType(Enum):
"""Provides credit card types.
An argument for :meth:`~mimesis.Payment.credit_card_number()`.
"""
VISA = "Visa"
MASTER_CARD = "MasterCard"
AMERICAN_EXPRESS = "American Express"
[docs]
class Algorithm(Enum):
"""Provides algorithms that are available.
An argument for :meth:`~mimesis.Cryptographic.hash()`.
"""
MD5 = "md5"
SHA1 = "sha1"
SHA224 = "sha224"
SHA256 = "sha256"
SHA384 = "sha384"
SHA512 = "sha512"
BLAKE2B = "blake2b"
BLAKE2S = "blake2s"
SHA3_224 = "sha3_224"
SHA3_256 = "sha3_256"
SHA3_384 = "sha3_384"
SHA3_512 = "sha3_512"
SHAKE128 = "shake_128"
SHAKE256 = "shake_256"
[docs]
class TLDType(Enum):
"""Provides top level domain types.
An argument for a few methods which take the parameter **tld_type**.
"""
CCTLD = "cctld"
GTLD = "gtld"
GEOTLD = "geotld"
UTLD = "utld"
STLD = "stld"
[docs]
class FileType(Enum):
"""Provides file types.
An argument for :meth:`~mimesis.File.extension()`
and :meth:`~mimesis.File.file_name()`.
"""
SOURCE = "source"
TEXT = "text"
DATA = "data"
AUDIO = "audio"
VIDEO = "video"
IMAGE = "image"
EXECUTABLE = "executable"
COMPRESSED = "compressed"
[docs]
class MimeType(Enum):
"""Provides common mime types.
An argument for :meth:`~mimesis.File.mime_type()`.
"""
APPLICATION = "application"
AUDIO = "audio"
IMAGE = "image"
MESSAGE = "message"
TEXT = "text"
VIDEO = "video"
[docs]
class MetricPrefixSign(Enum):
"""Provides prefix signs.
An argument for :meth:`~mimesis.Science.metric_prefix()``.
"""
POSITIVE = "positive"
NEGATIVE = "negative"
[docs]
class CountryCode(Enum):
"""Provides types of country codes.
An argument for :meth:`~mimesis.Address.country_code()`.
"""
A2 = "a2"
A3 = "a3"
NUMERIC = "numeric"
IOC = "ioc"
FIFA = "fifa"
[docs]
class MeasureUnit(Enum):
"""Provides unit names.
An argument for :meth:`~mimesis.Science.measure_unit()`.
"""
MASS = ("gram", "gr")
INFORMATION = ("byte", "b")
THERMODYNAMIC_TEMPERATURE = ("kelvin", "K")
AMOUNT_OF_SUBSTANCE = ("mole", "mol")
ANGLE = ("radian", "r")
SOLID_ANGLE = ("steradian", "㏛")
FREQUENCY = ("hertz", "Hz")
FORCE = ("newton", "N")
PRESSURE = ("pascal", "P")
ENERGY = ("joule", "J")
POWER = ("watt", "W")
FLUX = ("watt", "W") # noqa: PIE796
ELECTRIC_CHARGE = ("coulomb", "C")
VOLTAGE = ("volt", "V")
ELECTRIC_CAPACITANCE = ("farad", "F")
ELECTRIC_RESISTANCE = ("ohm", "Ω")
ELECTRICAL_CONDUCTANCE = ("siemens", "S")
MAGNETIC_FLUX = ("weber", "Wb")
MAGNETIC_FLUX_DENSITY = ("tesla", "T")
INDUCTANCE = ("henry", "H")
TEMPERATURE = ("Celsius", "°C")
RADIOACTIVITY = ("becquerel", "Bq")
[docs]
class NumType(Enum):
"""Provides the number types.
An argument for :meth:`~mimesis.Numeric.matrix()`.
"""
FLOAT = "floats"
INTEGER = "integers"
COMPLEX = "complexes"
DECIMAL = "decimals"
[docs]
class VideoFile(Enum):
"""Provides the video file types.
An argument for :meth:`~mimesis.BinaryFile.video()`
"""
MP4 = "mp4"
MOV = "mov"
[docs]
class AudioFile(Enum):
"""Provides the audio file types.
An argument for :meth:`~mimesis.BinaryFile.audio()`
"""
MP3 = "mp3"
AAC = "aac"
[docs]
class ImageFile(Enum):
"""Provides the image file types.
An argument for :meth:`~mimesis.BinaryFile.image()`
"""
JPG = "jpg"
PNG = "png"
GIF = "gif"
[docs]
class DocumentFile(Enum):
"""Provides the document file types.
An argument for :meth:`~mimesis.BinaryFile.document()`
"""
PDF = "pdf"
DOCX = "docx"
PPTX = "pptx"
XLSX = "xlsx"
[docs]
class CompressedFile(Enum):
"""Provides the compressed file types.
An argument for :meth:`~mimesis.BinaryFile.compressed()`
"""
ZIP = "zip"
GZIP = "gz"
[docs]
class URLScheme(Enum):
"""Provides URL schemes.
An argument for some methods of :class:`~mimesis.Internet()`.
"""
WS = "ws"
WSS = "wss"
FTP = "ftp"
SFTP = "sftp"
HTTP = "http"
HTTPS = "https"
[docs]
class TimezoneRegion(Enum):
"""Provides regions of timezones.
An argument for :meth:`~mimesis.Datetime.timezone()`.
"""
AFRICA = "Africa"
AMERICA = "America"
ANTARCTICA = "Antarctica"
ARCTIC = "Arctic"
ASIA = "Asia"
ATLANTIC = "Atlantic"
AUSTRALIA = "Australia"
EUROPE = "Europe"
INDIAN = "Indian"
PACIFIC = "Pacific"
[docs]
class DSNType(Enum):
"""Provides DSN types for database connections.
An argument for :meth:`~mimesis.Internet.dsn()`.
"""
POSTGRES = ("postgres", 5432)
MYSQL = ("mysql", 3306)
MONGODB = ("mongodb", 27017)
REDIS = ("redis", 6379)
COUCHBASE = ("couchbase", 8092)
MEMCACHED = ("memcached", 11211)
RABBITMQ = ("rabbitmq", 5672)
[docs]
class EmojiCategory(Enum):
"""Provides emoji categories.
An argument for :meth:`~mimesis.Internet.emoji()`.
"""
DEFAULT = "smileys_and_emotion"
SMILEYS_AND_EMOTION = "smileys_and_emotion" # noqa: PIE796
PEOPLE_AND_BODY = "people_and_body"
ANIMALS_AND_NATURE = "animals_and_nature"
FOOD_AND_DRINK = "food_and_drink"
TRAVEL_AND_PLACES = "travel_and_places"
ACTIVITIES = "activities"
OBJECTS = "objects"
SYMBOLS = "symbols"
FLAGS = "flags"
EmojyCategory = EmojiCategory