Locale fa_IR

faker.providers.address

class faker.providers.address.fa_IR.Provider(generator: Any)

Bases: faker.providers.address.Provider

address() → str

Example:‘791 Crist Parks, Sashabury, IL 86039-9874’ Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.address()
...
'48764 ربانی بن بست سوئیت 421\nشهرستان آراد, بوشهر 11578'
'5938 عباسی جنب سوئیت 801\nاستان آرمين, آذربایجان شرقی 7535139332'
'58714 علی پور دره\nشهرستان زهرا, سیستان و بلوچستان 196593'
'20947 سارینا میدان\nشمال فاطمه زهرا, گلستان 4833969477'
'9179 خسروجردی بلوار\nبندر كیانا, خراسان شمالی 25601'

administrative_unit() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.administrative_unit()
...
'کهگیلویه و بویراحمد'
'لرستان'
'اردبیل'
'زنجان'
'یزد'

building_number() → str

Example:‘791’ Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.building_number()
...
'6048'
'6475'
'382'
'2194'
'924'

city() → str

Example:‘Sashabury’ Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.city()
...
'روستای ریحانه'
'شهرستان آرش'
'بندر سجاد'
'باغات مبينا'
'بندر آوا'

city_prefix() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.city_prefix()
...
'روستای'
'روستای'
'شمال'
'بندر'
'شهرستان'

city_suffix() → str

Example:‘town’ Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.city_suffix()
...
'Ville'
'Ville'
'Ville'
'Ville'
'Ville'

country() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.country()
...
'سنت وینسنت و گرنادین\u200cها'
'هائیتی'
'سوریه'
'اتیوپی'
'ترینیداد و توباگو'

country_code(representation: str = 'alpha-2') → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.country_code()
...
'MV'
'PS'
'NL'
'BB'
'IL'

current_country() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.current_country()
...
'Iran'
'Iran'
'Iran'
'Iran'
'Iran'

current_country_code() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.current_country_code()
...
'IR'
'IR'
'IR'
'IR'
'IR'

postcode() → str

Example:86039-9874 Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.postcode()
...
'604876'
'75938'
'4219'
'89241'
'578'

secondary_address() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.secondary_address()
...
'واحد 604'
'واحد 647'
'واحد 938'
'سوئیت 421'
'واحد 892'

state() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.state()
...
'کهگیلویه و بویراحمد'
'لرستان'
'اردبیل'
'زنجان'
'یزد'

street_address() → str

Example:‘791 Crist Parks’ Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.street_address()
...
'0487 رودگر تقاطع واحد 593'
'2194 هستي دره'
'578 کيانا کوه'
'387 دادفر جنب سوئیت 801'
'097 سمسار آزاد راه سوئیت 393'

street_name() → str

Example:‘Crist Parks’ Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.street_name()
...
'گلپایگانی کوه'
'رها تونل'
'رودگر تقاطع'
'ربانی بن بست'
'مريم میدان'

street_suffix() → str

Example:‘Avenue’ Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.street_suffix()
...
'جزیره'
'کوه'
'خیابان'
'جنب'
'تونل'

faker.providers.bank

class faker.providers.bank.fa_IR.Provider(generator: Any)

Bases: faker.providers.bank.Provider

Implement bank provider for fa_IR locale.

aba() → str

Generate an ABA routing transit number.

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.aba()
...
'076048766'
'057593829'
'052194896'
'034115783'
'025659384'

bank() → str

Generate a bank name.

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.bank()
...
'بانک انصار'
'بانک سینا'
'بانک گردشگری'
'بانک سرمایه'
'بانک توسعه صادرات ایران'

bank_country() → str

Generate the bank provider’s ISO 3166-1 alpha-2 country code.

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.bank_country()
...
'IR'
'IR'
'IR'
'IR'
'IR'

bban() → str

Generate a Basic Bank Account Number (BBAN).

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.bban()
...
'IR660487647593824219489241'
'IR157815659387784080160975'
'IR351393328711587148418583'
'IR989471965934232094711220'
'IR186848339694775159179533'

iban() → str

Generate an International Bank Account Number (IBAN).

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.iban()
...
'IR77IR660487647593824219489241'
'IR61IR157815659387784080160975'
'IR67IR351393328711587148418583'
'IR73IR989471965934232094711220'
'IR80IR186848339694775159179533'

swift(length: Optional[int] = None, primary: bool = False, use_dataset: bool = False) → str

Generate a SWIFT code.

SWIFT codes, reading from left to right, are composed of a 4 alphabet character bank code, a 2 alphabet character country code, a 2 alphanumeric location code, and an optional 3 alphanumeric branch code. This means SWIFT codes can only have 8 or 11 characters, so the value of length can only be None or the integers 8 or 11. If the value is None, then a value of 8 or 11 will randomly be assigned.

Because all 8-digit SWIFT codes already refer to the primary branch or office, the primary argument only has an effect if the value of length is 11. If primary is True and length is 11, the 11-digit SWIFT codes generated will always end in 'XXX' to denote that they belong to primary branches/offices.

For extra authenticity, localized providers may opt to include SWIFT bank codes, location codes, and branch codes used in their respective locales. If use_dataset is True, this method will generate SWIFT codes based on those locale-specific codes if included. If those codes were not included, then it will behave as if use_dataset were False, and in that mode, all those codes will just be randomly generated as per the specification.

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.swift()
...
'YNBIIR65ZT4'
'SGQEIRSIGQ8'
'JDXCIRV4'
'LNKTIRN9'
'OQIBIR9AFZA'

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.swift(length=8)
...
'MYNBIRQ6'
'PMZJIR4W'
'SGQEIRSI'
'YDTZIRQ8'
'WZTEIRTG'

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.swift(length=8, use_dataset=True)
...
'IVBBIRTH'
'BEGNIRTH'
'KIBOIRTH'
'IVBBIRTH'
'KBIDIRTH'

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.swift(length=11)
...
'MYNBIRQ65ZT'
'PLSGIR6ISIG'
'TZIRIRJTGEV'
'PRDLIR1UN94'
'OQIBIR9AFZA'

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.swift(length=11, primary=True)
...
'MYNBIRQ6XXX'
'PMZJIR4WXXX'
'SGQEIRSIXXX'
'YDTZIRQ8XXX'
'WZTEIRTGXXX'

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.swift(length=11, use_dataset=True)
...
'IVBBIRTHBSH'
'CIYBIRTHTIR'
'CIYBIRTHBIC'
'KHMIIRTHFOR'
'BKMNIRTHtIR'

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.swift(length=11, primary=True, use_dataset=True)
...
'IVBBIRTHXXX'
'BEGNIRTHXXX'
'KIBOIRTHXXX'
'IVBBIRTHXXX'
'KBIDIRTHXXX'

swift11(primary: bool = False, use_dataset: bool = False) → str

Generate an 11-digit SWIFT code.

This method uses swift() under the hood with the length argument set to 11. If primary is set to True, the SWIFT code will always end with 'XXX'. All 11-digit SWIFT codes use this convention to refer to the primary branch/office.

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.swift11()
...
'MYNBIRQ65ZT'
'PLSGIR6ISIG'
'TZIRIRJTGEV'
'PRDLIR1UN94'
'OQIBIR9AFZA'

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.swift11(use_dataset=True)
...
'IVBBIRTHBSH'
'CIYBIRTHTIR'
'CIYBIRTHBIC'
'KHMIIRTHFOR'
'BKMNIRTHtIR'

swift8(use_dataset: bool = False) → str

Generate an 8-digit SWIFT code.

This method uses swift() under the hood with the length argument set to 8 and with the primary argument omitted. All 8-digit SWIFT codes already refer to the primary branch/office.

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.swift8()
...
'MYNBIRQ6'
'PMZJIR4W'
'SGQEIRSI'
'YDTZIRQ8'
'WZTEIRTG'

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.swift8(use_dataset=True)
...
'IVBBIRTH'
'BEGNIRTH'
'KIBOIRTH'
'IVBBIRTH'
'KBIDIRTH'

faker.providers.color

class faker.providers.color.fa_IR.Provider(generator: Any)

Bases: faker.providers.color.Provider

Implement color provider for fa_IR locale.

Sources: - https://www.seyedrezabazyar.com/fa/name-and-code-of-colors/ - https://bit.ly/353BBiY

color(hue: Optional[HueType] = None, luminosity: Optional[str] = None, color_format: str = 'hex') → str

Generate a color in a human-friendly way.

Under the hood, this method first creates a color represented in the HSV color model and then converts it to the desired color_format. The argument hue controls the H value according to the following rules:

• If the value is a number from 0 to 360, it will serve as the H value of the generated color.
• If the value is a tuple/list of 2 numbers from 0 to 360, the color’s H value will be randomly selected from that range.
• If the value is a valid string, the color’s H value will be randomly selected from the H range corresponding to the supplied string. Valid values are 'monochrome', 'red', 'orange', 'yellow', 'green', 'blue', 'purple', and 'pink'.

The argument luminosity influences both S and V values and is partially affected by hue as well. The finer details of this relationship are somewhat involved, so please refer to the source code instead if you wish to dig deeper. To keep the interface simple, this argument either can be omitted or can accept the following string values:'bright', 'dark', 'light', or 'random'.

The argument color_format controls in which color model the color is represented. Valid values are 'hsv', 'hsl', 'rgb', or 'hex' (default).

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.color(hue='red')
...
'#af2f33'
'#e02141'
'#ef6466'
'#a80a14'
'#ed9e95'

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.color(luminosity='light')
...
'#79c3e0'
'#89ffa1'
'#96cbf7'
'#aafaff'
'#e3f495'

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.color(hue=(100, 200), color_format='rgb')
...
'rgb(26, 155, 88)'
'rgb(9, 193, 49)'
'rgb(73, 229, 154)'
'rgb(107, 249, 166)'
'rgb(76, 204, 69)'

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.color(hue='orange', luminosity='bright')
...
'#efc332'
'#edae65'
'#d1861d'
'#ffcc42'
'#e09533'

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.color(hue=135, luminosity='dark', color_format='hsv')
...
'hsv(135, 96, 45)'
'hsv(135, 98, 57)'
'hsv(135, 94, 61)'
'hsv(135, 99, 47)'
'hsv(135, 94, 50)'

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.color(hue=(300, 20), luminosity='random', color_format='hsl')
...
'hsl(217, 94, 27)'
'hsl(40, 23, 54)'
'hsl(268, 100, 74)'
'hsl(175, 43, 31)'
'hsl(131, 47, 11)'

color_name() → str

Generate a color name.

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.color_name()
...
'فیروزه\u200cای کدر'
'قرمز'
'آبی-بنفش سیر'
'کرم نارنجی'
'خاکستری محو'

hex_color() → str

Generate a color formatted as a hex triplet.

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.hex_color()
...
'#d82c08'
'#629f70'
'#c2094d'
'#e3e707'
'#6baa95'

rgb_color() → str

Generate a color formatted as a comma-separated RGB value.

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.rgb_color()
...
'197,215,20'
'132,248,207'
'155,244,183'
'111,71,144'
'71,48,128'

rgb_css_color() → str

Generate a color formatted as a CSS rgb() function.

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.rgb_css_color()
...
'rgb(197,215,20)'
'rgb(132,248,207)'
'rgb(155,244,183)'
'rgb(111,71,144)'
'rgb(71,48,128)'

safe_color_name() → str

Generate a web-safe color name.

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.safe_color_name()
...
'فیروزه\u200cای'
'سبز دودی'
'ارغوانی'
'سفید'
'سبز دودی'

safe_hex_color() → str

Generate a web-safe color formatted as a hex triplet.

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.safe_hex_color()
...
'#ccdd11'
'#88ffcc'
'#99ffbb'
'#664499'
'#443388'

faker.providers.company

class faker.providers.company.fa_IR.Provider(generator: Any)

Bases: faker.providers.company.Provider

bs() → str

Example:‘integrate extensible convergence’ Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.bs()
...
'iterate integrated e-markets'
'integrate back-end mindshare'
'synthesize wireless content'
'syndicate synergistic applications'
'productize killer mindshare'

catch_phrase() → str

Example:‘Robust full-range hub’ Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.catch_phrase()
...
'Networked well-modulated instruction set'
'Balanced empowering migration'
'Pre-emptive impactful toolset'
'Innovative mission-critical help-desk'
'Reduced didactic middleware'

company() → str

Example:‘Acme Ltd’ Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.company()
...
'چینی سازی البرز'
'مجتمع دامداری بیجین'
'سیمان جوین'
'تولید مواد دارویی درسا دارو'
'نئوپان 22 بهمن'

company_suffix() → str

Example:‘Ltd’ Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.company_suffix()
...
'Group'
'Group'
'Inc'
'LLC'
'PLC'

faker.providers.credit_card

class faker.providers.credit_card.fa_IR.Provider(generator: Any)

Bases: faker.providers.credit_card.Provider

Implement credit card provider for fa_IR locale.

For all methods that take card_type as an argument, a random card type will be used if the supplied value is None. The list of valid card types includes 'ansar', 'bim', 'day', 'eghtesad_novin', 'ghavamin', 'hekmat', 'iran_zamin', 'kar_afarin', 'keshavarzi', 'kosar', 'maskan', 'mehre_ghtesad', 'meli', 'mellal', 'mellat', 'parsian', 'pasargad', 'post_bank', 'refah', 'saderat', 'saman', 'sarmayeh', 'sepah', 'shahr', 'sina', 'tat', 'tejarat', 'tose', and 'tourism_bank'.

Sources:

• https://way2pay.ir/21653

credit_card_expire(start: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int] = 'now', end: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int] = '+10y', date_format: str = '%m/%y') → str

Generate a credit card expiry date.

This method uses date_time_between() under the hood to generate the expiry date, so the start and end arguments work in the same way here as it would in that method. For the actual formatting of the expiry date, strftime() is used and date_format is simply passed to that method.

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.credit_card_expire()
...
'08/28'
'03/29'
'09/22'
'06/26'
'09/30'

credit_card_full(card_type: Optional[CardType] = None) → str

Generate a set of credit card details.

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.credit_card_full()
...
'پارسیان\nبهار گلپایگانی\n6221060487647590 10/25\nCVV2: 824\n'
'شهر\nعباس ابوطالبی\n5028068924115789 10/23\nCVV2: 565\n'
'کوثر\nاميرمحمد مهدیان\n5058017840801603 06/30\nCVV2: 535\n'
'تات\nثنا خسروجردی\n6219863287115872 11/23\nCVV2: 484\n'
'تات\nهانیه میردامادی\n6219868398947196 08/28\nCVV2: 593\n'

credit_card_number(card_type: Optional[CardType] = None) → str

Generate a valid credit card number.

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.credit_card_number()
...
'6221066048764758'
'6219868242194896'
'6279614115781568'
'6037998778408012'
'6393460975351394'

credit_card_provider(card_type: Optional[CardType] = None) → str

Generate a credit card provider name.

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.credit_card_provider()
...
'پارسیان'
'گردشگری'
'کار آفرین'
'صنعت و معدن'
'قوامین'

credit_card_security_code(card_type: Optional[CardType] = None) → str

Generate a credit card security code.

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.credit_card_security_code()
...
'660'
'876'
'475'
'382'
'219'

faker.providers.internet

class faker.providers.internet.fa_IR.Provider(generator: Any)

Bases: faker.providers.internet.Provider

ascii_company_email() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.ascii_company_email()
...
'aglpygny@symn.org'
'yrswly@khymy.ir'
'myrly38@twsh.org'
'bsbwtlby@lyzyng.com'
'aylyn15@sny.com'

ascii_email() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.ascii_email()
...
'qdyy@yahoo.com'
'trwdgr@hotmail.com'
'mhmdmynhnry@gmail.com'
'hwshyrbrn@yrnsl.com'
'mwswymrym@gmail.com'

ascii_free_email() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.ascii_free_email()
...
'aglpygny@chmail.ir'
'mbyn76@gmail.com'
'lrbny@mailfa.com'
'mrymhnry@chmail.ir'
'aryn92@gmail.com'

ascii_safe_email() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.ascii_safe_email()
...
'aglpygny@example.org'
'mbyn76@example.com'
'lrbny@example.org'
'mrymhnry@example.org'
'aryn92@example.com'

company_email() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.company_email()
...
'aglpygny@symn.org'
'yrswly@khymy.ir'
'myrly38@twsh.org'
'bsbwtlby@lyzyng.com'
'aylyn15@sny.com'

dga(year: Optional[int] = None, month: Optional[int] = None, day: Optional[int] = None, tld: Optional[str] = None, length: Optional[int] = None) → str

Generates a domain name by given date https://en.wikipedia.org/wiki/Domain_generation_algorithm

Return type:str Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.dga()
...
'hxqvaffcmfsccynscisxeajjagjahtnfcmfsccynscisxeajjagjahtnfcmfscc.org'
'meydkrgdcvulautulqvjofrrnbjkfmvrewtpfttqcjafdhxckmyfamohcpnldug.org'
'iiulfpgbvqcdaehnqkbxmaqgkykorlxnwy.net'
'cpyhexmtvewxpwiiaxtgdfajuhbsyaaykvgkgreki.com'
'uqniukqjckmjabijnuqho.com'

domain_name(levels: int = 1) → str

Produce an Internet domain name with the specified number of subdomain levels.

>>> domain_name()
nichols-phillips.com
>>> domain_name(2)
williamson-hopkins.jackson.com

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.domain_name()
...
'chyny.ir'
'symn.org'
'nywpn.ir'
'mhndsy.org'
'ptrwshymy.ir'

domain_word() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.domain_word()
...
'chyny'
'mjtm'
'symn'
'twlyd'
'nywpn'

email(safe: bool = True, domain: Optional[str] = None) → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.email()
...
'aglpygny@example.org'
'mbyn76@example.com'
'lrbny@example.org'
'mrymhnry@example.org'
'aryn92@example.com'

free_email() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.free_email()
...
'aglpygny@chmail.ir'
'mbyn76@gmail.com'
'lrbny@mailfa.com'
'mrymhnry@chmail.ir'
'aryn92@gmail.com'

free_email_domain() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.free_email_domain()
...
'hotmail.com'
'hotmail.com'
'chmail.ir'
'gmail.com'
'yahoo.com'

hostname(levels: int = 1) → str

Produce a hostname with specified number of subdomain levels.

>>> hostname()
db-01.nichols-phillips.com
>>> hostname(0)
laptop-56
>>> hostname(2)
web-12.williamson-hopkins.jackson.com

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.hostname()
...
'web-66.symn.org'
'lt-76.khymy.ir'
'desktop-93.krkhnjt.com'
'desktop-21.lyzyng.com'
'desktop-11.sny.ir'

http_method() → str

Returns random HTTP method https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods

Return type:str Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.http_method()
...
'OPTIONS'
'OPTIONS'
'GET'
'DELETE'
'PATCH'

iana_id() → str

Returns IANA Registrar ID https://www.iana.org/assignments/registrar-ids/registrar-ids.xhtml

Return type:str Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.iana_id()
...
'6463344'
'7056021'
'679216'
'4343903'
'8577767'

image_url(width: Optional[int] = None, height: Optional[int] = None, placeholder_url: Optional[str] = None) → str

Returns URL to placeholder image Example: http://placehold.it/640x480

Parameters:

• width – Optional image width
• height – Optional image height
• placeholder_url – Optional template string of image URLs from custom placeholder service. String must contain {width} and {height} placeholders, eg: https:/example.com/{width}/{height}.

Return type:

str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.image_url()
...
'https://picsum.photos/788/861'
'https://placeimg.com/530/995/any'
'https://placekitten.com/621/976'
'https://placekitten.com/447/285'
'https://placekitten.com/286/194'

ipv4(network: bool = False, address_class: Optional[str] = None, private: Optional[str] = None) → str

Returns a random IPv4 address or network with a valid CIDR.

Parameters:

• network – Network address
• address_class – IPv4 address class (a, b, or c)
• private – Public or private

Returns:

IPv4

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.ipv4()
...
'171.174.170.81'
'95.25.112.121'
'51.105.121.194'
'195.110.164.126'
'141.250.247.54'

ipv4_network_class() → str

Returns a IPv4 network class ‘a’, ‘b’ or ‘c’.

Returns:IPv4 network class Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.ipv4_network_class()
...
'b'
'b'
'a'
'b'
'c'

ipv4_private(network: bool = False, address_class: Optional[str] = None) → str

Returns a private IPv4.

Parameters:

• network – Network address
• address_class – IPv4 address class (a, b, or c)

Returns:

Private IPv4

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.ipv4_private()
...
'172.29.117.82'
'10.248.203.131'
'172.25.180.188'
'172.22.253.123'
'192.168.71.140'

ipv4_public(network: bool = False, address_class: Optional[str] = None) → str

Returns a public IPv4 excluding private blocks.

Parameters:

• network – Network address
• address_class – IPv4 address class (a, b, or c)

Returns:

Public IPv4

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.ipv4_public()
...
'166.186.169.69'
'111.198.92.30'
'168.155.75.206'
'141.250.247.54'
'212.120.204.37'

ipv6(network: bool = False) → str

Produce a random IPv6 address or network with a valid CIDR

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.ipv6()
...
'e3e7:682:c209:4cac:629f:6fbf:d82c:7cd'
'f728:b4fa:4248:5e3a:a5d:2f35:6baa:9455'
'eb11:67b3:67a9:c378:7c65:c1e6:82e2:e662'
'f7c1:bd87:4da5:e709:d471:3d61:c8a7:639'
'e443:df78:9558:867f:5ba9:1fb0:7a02:4204'

mac_address() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.mac_address()
...
'c5:d7:14:84:f8:cf'
'9b:f4:b7:6f:47:90'
'47:30:80:4b:9e:32'
'25:a9:f1:33:b5:de'
'a1:68:f4:e2:85:1f'

nic_handle(suffix: str = 'FAKE') → str

Returns NIC Handle ID https://www.apnic.net/manage-ip/using-whois/guide/person/

Return type:str Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.nic_handle()
...
'ZYT1598-FAKE'
'SIW493-FAKE'
'UE59352-FAKE'
'WBUN892-FAKE'
'CHQD98-FAKE'

nic_handles(count: int = 1, suffix: str = '????') → List[str]

Returns NIC Handle ID list

Return type:list[str] Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.nic_handles()
...
['ZYT1598-EWLN']
['WGNZ53-QITZ']
['UERV52-EJGW']
['CHQ498-DZJA']
['UU1864-TEMK']

port_number(is_system: bool = False, is_user: bool = False, is_dynamic: bool = False) → int

Returns a network port number https://tools.ietf.org/html/rfc6335

Parameters:

• is_system – System or well-known ports
• is_user – User or registered ports
• is_dynamic – Dynamic / private / ephemeral ports

Return type:

int

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.port_number()
...
50494
55125
5306
33936
63691

ripe_id() → str

Returns RIPE Organization ID https://www.ripe.net/manage-ips-and-asns/db/support/organisation-object-in-the-ripe-database

Return type:str Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.ripe_id()
...
'ORG-ZYT1598-RIPE'
'ORG-SIW493-RIPE'
'ORG-UE59352-RIPE'
'ORG-WBUN892-RIPE'
'ORG-CHQD98-RIPE'

safe_domain_name() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.safe_domain_name()
...
'example.com'
'example.com'
'example.org'
'example.com'
'example.net'

safe_email() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.safe_email()
...
'aglpygny@example.org'
'mbyn76@example.com'
'lrbny@example.org'
'mrymhnry@example.org'
'aryn92@example.com'

slug(value: Optional[str] = None) → str

Django algorithm

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.slug()
...
'molestiae-nihil'
'facilis-quaerat'
'necessitatibus'
'perferendis-magnam'
'esse-quae-deserunt'

tld() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.tld()
...
'ir'
'ir'
'com'
'org'
'ir'

uri() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.uri()
...
'https://www.twlyd.ir/explore/posts/register/'
'http://www.prs.com/privacy.html'
'https://www.grwh.com/app/list/search/login.html'
'https://twlyd.ir/register.asp'
'http://www.sng.ir/terms.html'

uri_extension() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.uri_extension()
...
'.php'
'.php'
'.html'
'.htm'
'.asp'

uri_page() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.uri_page()
...
'author'
'category'
'privacy'
'category'
'index'

uri_path(deep: Optional[int] = None) → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.uri_path()
...
'posts/tag'
'explore/tag'
'explore/category'
'blog'
'category'

url(schemes: Optional[List[str]] = None) → str

Parameters:schemes – a list of strings to use as schemes, one will chosen randomly. If None, it will generate http and https urls. Passing an empty list will result in schemeless url generation like “://domain.com”. Returns:a random url string. Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.url()
...
'https://symn.org/'
'https://khymy.ir/'
'https://www.krkhnjt.com/'
'https://www.skht.org/'
'http://syb.com/'

user_name() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.user_name()
...
'aglpygny'
'shkhrymbyn'
'yrswly'
'sjd59'
'mhmdmynhnry'

faker.providers.job

class faker.providers.job.fa_IR.Provider(generator: Any)

Bases: faker.providers.job.Provider

job() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.job()
...
'معاون'
'سرتیپ'
'باغ\u200cدار'
'تاجر'
'پاسدار'

faker.providers.person

class faker.providers.person.fa_IR.Provider(generator: Any)

Bases: faker.providers.person.Provider

first_name() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.first_name()
...
'بهار'
'پارسا'
'محمد'
'ریحانه'
'رها'

first_name_female() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.first_name_female()
...
'یاسمین'
'نيايش'
'مائده'
'النا'
'مهدیس'

first_name_male() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.first_name_male()
...
'بنیامین'
'کيان'
'محمدپارسا'
'متین'
'یوسف'

first_name_nonbinary() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.first_name_nonbinary()
...
'بهار'
'پارسا'
'محمد'
'ریحانه'
'رها'

language_name() → str

Generate a random i18n language name (e.g. English).

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.language_name()
...
'Luba-Katanga'
'Malay'
'Aymara'
'Interlingue'
'Quechua'

last_name() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.last_name()
...
'سرخوشیان'
'گلپایگانی'
'کریمی'
'دایی'
'شاکری'

last_name_female() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.last_name_female()
...
'سرخوشیان'
'گلپایگانی'
'کریمی'
'دایی'
'شاکری'

last_name_male() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.last_name_male()
...
'سرخوشیان'
'گلپایگانی'
'کریمی'
'دایی'
'شاکری'

last_name_nonbinary() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.last_name_nonbinary()
...
'سرخوشیان'
'گلپایگانی'
'کریمی'
'دایی'
'شاکری'

name() → str

:example ‘John Doe’

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.name()
...
'کيان کریمی'
'مهدیس چنگیزی'
'ايليا رودگر'
'هليا ربانی'
'نیما اشتری'

name_female() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.name_female()
...
'نيايش کریمی'
'مهدیس چنگیزی'
'ستايش رودگر'
'هليا ربانی'
'حنانه اشتری'

name_male() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.name_male()
...
'کيان کریمی'
'یوسف چنگیزی'
'ايليا رودگر'
'آرمين ربانی'
'نیما اشتری'

name_nonbinary() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.name_nonbinary()
...
'کيان کریمی'
'مهدیس چنگیزی'
'ايليا رودگر'
'هليا ربانی'
'نیما اشتری'

prefix() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.prefix()
...
'سرکار خانم دکتر'
'جناب آقای دکتر'
'سرکار خانم دکتر'
'سرکار خانم دکتر'
'سرکار خانم'

prefix_female() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.prefix_female()
...
'سرکار خانم دکتر'
'سرکار خانم دکتر'
'سرکار خانم'
'سرکار خانم دکتر'
'سرکار خانم دکتر'

prefix_male() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.prefix_male()
...
'جناب آقای دکتر'
'جناب آقای دکتر'
'جناب آقای'
'جناب آقای دکتر'
'جناب آقای دکتر'

prefix_nonbinary() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.prefix_nonbinary()
...
'سرکار خانم دکتر'
'جناب آقای دکتر'
'سرکار خانم دکتر'
'سرکار خانم دکتر'
'سرکار خانم'

suffix() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.suffix()
...
''
''
''
''
''

suffix_female() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.suffix_female()
...
''
''
''
''
''

suffix_male() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.suffix_male()
...
''
''
''
''
''

suffix_nonbinary() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.suffix_nonbinary()
...
''
''
''
''
''

faker.providers.phone_number

class faker.providers.phone_number.fa_IR.Provider(generator: Any)

Bases: faker.providers.phone_number.Provider

country_calling_code() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.country_calling_code()
...
'+687'
'+595'
'+880'
'+964'
'+41'

msisdn() → str

https://en.wikipedia.org/wiki/MSISDN

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.msisdn()
...
'6048764759382'
'2194892411578'
'5659387784080'
'6097535139332'
'1158714841858'

phone_number() → str

Examples:

>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.phone_number()
...
'083 6048 7647'
'011 9382 4219'
'+98 24 8924 1157'
'013 1565 9387'
'+98 41 8408 0160'