Locale pt_BR

faker.providers.address

class faker.providers.address.pt_BR.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()
...
'Área Luiz Henrique Silva, 56\nProvidencia\n93824-219 Teixeira Grande / MA'
'Viela Melo, 28\nMaria Helena\n59387-784 Vieira / AC'
"Viaduto Letícia Almeida, 475\nVila Olhos D'água\n13933-287 Cardoso / MT"
'Sítio Nathan Costa\nSão Salvador\n83989-471 Lopes Verde / ES'
'Estação Azevedo, 247\nBrasil Industrial\n20186848 da Rosa / RO'
administrative_unit() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.administrative_unit()
...
'Minas Gerais'
'São Paulo'
'Pará'
'Alagoas'
'Goiás'
bairro() → str

Randomly returns a bairro (neighborhood) name. The names were taken from the city of Belo Horizonte - Minas Gerais

:example ‘Serra’

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.bairro()
...
'Bandeirantes'
'Mirante'
'Vila Santa Monica 2ª Seção'
'Fernão Dias'
'Nova Pampulha'
building_number() → str

:example ‘791’

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.building_number()
...
'16'
'88'
'84'
'49'
'324'
city() → str

:example ‘Sashabury’

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.city()
...
'Peixoto do Norte'
'Silva do Amparo'
'Jesus do Amparo'
'da Rosa do Galho'
'Gomes'
city_suffix() → str

:example ‘town’

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.city_suffix()
...
'das Flores'
'das Pedras'
'do Norte'
'Paulista'
'do Galho'
country() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.country()
...
'Sérvia'
'Guernsey'
'Quiribáti'
'Tailândia'
'Iêmen'
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()
...
'Brazil'
'Brazil'
'Brazil'
'Brazil'
'Brazil'
current_country_code() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.current_country_code()
...
'BR'
'BR'
'BR'
'BR'
'BR'
estado() → Tuple[str, str]

Randomly returns a Brazilian State (‘sigla’ , ‘nome’). :example (‘MG’ . ‘Minas Gerais’)

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.estado()
...
('MG', 'Minas Gerais')
('SP', 'São Paulo')
('PA', 'Pará')
('AL', 'Alagoas')
('GO', 'Goiás')
estado_nome() → str

Randomly returns a Brazilian State Name :example ‘Minas Gerais’

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.estado_nome()
...
'Minas Gerais'
'São Paulo'
'Pará'
'Alagoas'
'Goiás'
estado_sigla() → str

Randomly returns the abbreviation of a Brazilian State

:example ‘MG’

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.estado_sigla()
...
'MG'
'SP'
'PA'
'AL'
'GO'
neighborhood() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.neighborhood()
...
'Bandeirantes'
'Mirante'
'Vila Santa Monica 2ª Seção'
'Fernão Dias'
'Nova Pampulha'
postcode(formatted: bool = True) → str

Randomly returns a postcode. :param formatted: True to allow formatted postcodes, else False (default True) :example formatted: ‘41224-212’ ‘83992-291’ ‘12324322’ :example raw: ‘43920231’ ‘34239530’

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.postcode()
...
'60487-647'
'93824-219'
'89241-157'
'56593877'
'08016-097'
state() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.state()
...
'Minas Gerais'
'São Paulo'
'Pará'
'Alagoas'
'Goiás'
state_abbr() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.state_abbr()
...
'MG'
'SP'
'PA'
'AL'
'GO'
street_address() → str

:example ‘791 Crist Parks’

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.street_address()
...
'Pátio Bruno Ferreira, 576'
'Trecho Leandro Santos, 34'
'Vale Fernandes, 592'
'Campo de Melo'
'Colônia de Moraes, 45'
street_name() → str

:example ‘Crist Parks’

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.street_name()
...
'Pátio Bruno Ferreira'
'Residencial de Nunes'
'Recanto Theo da Rosa'
'Conjunto de Gomes'
'Colônia Fernandes'
street_prefix() → str

:example ‘rua’

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.street_prefix()
...
'Parque'
'Pátio'
'Área'
'Jardim'
'Rodovia'
street_suffix() → str

:example ‘Avenue’

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.street_suffix()
...
'Street'
'Street'
'Street'
'Street'
'Street'

faker.providers.automotive

class faker.providers.automotive.pt_BR.Provider(generator: Any)

Bases: faker.providers.automotive.Provider

Implement automotive provider for pt_BR locale.

license_plate() → str

Generate a license plate.

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.license_plate()
...
'YNB-4876'
'PLS-3824'
'YDT-4892'
'DXC-5781'
'NKT-3877'

faker.providers.color

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

Bases: faker.providers.color.Provider

Implement color provider for pt_BR locale.

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()
...
'Vermelho enegrecido'
'Dourado escuro'
'Turquesa média'
'Feldspato'
'Amarelo ouro claro'
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()
...
'amarelo'
'magenta'
'marrom'
'azul'
'branco'
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.pt_BR.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 ‘a segurança de evoluir sem preocupação’

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.catch_phrase()
...
'O poder de conseguir com toda a tranquilidade'
'O poder de inovar sem preocupação'
'A vantagem de mudar em estado puro'
'A certeza de evoluir mais rapidamente'
'A possibilidade de evoluir com toda a tranquilidade'
catch_phrase_attribute() → str

Returns a random catch phrase attribute.

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.catch_phrase_attribute()
...
'naturalmente'
'naturalmente'
'de maneira eficaz'
'com toda a tranquilidade'
'em estado puro'
catch_phrase_noun() → str

Returns a random catch phrase noun.

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.catch_phrase_noun()
...
'o poder'
'o poder'
'a segurança'
'a certeza'
'a possibilidade'
catch_phrase_verb() → str

Returns a random catch phrase verb.

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.catch_phrase_verb()
...
'de atingir seus objetivos'
'de atingir seus objetivos'
'de conseguir'
'de inovar'
'de realizar seus sonhos'
cnpj() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.cnpj()
...
'69.024.351/0001-39'
'75.341.280/0001-09'
'94.270.561/0001-54'
'81.532.497/0001-90'
'79.408.652/0001-10'
company() → str

:example ‘Acme Ltd’

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.company()
...
'Peixoto'
'Ferreira - EI'
'Nunes'
'Rocha'
'da Rosa'
company_id() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.company_id()
...
'69024351000139'
'75341280000109'
'94270561000154'
'81532497000190'
'79408652000110'
company_suffix() → str

:example ‘Ltd’

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.company_suffix()
...
'- ME'
'- ME'
'S/A'
'Ltda.'
'- EI'

faker.providers.currency

class faker.providers.currency.pt_BR.Provider(generator: Any)

Bases: faker.providers.currency.Provider

cryptocurrency() → Tuple[str, str]
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.cryptocurrency()
...
('XRP', 'Ripple')
('STC', 'SwiftCoin')
('BC', 'BlackCoin')
('NXT', 'Nxt')
('IOTA', 'IOTA')
cryptocurrency_code() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.cryptocurrency_code()
...
'XRP'
'STC'
'BC'
'NXT'
'IOTA'
cryptocurrency_name() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.cryptocurrency_name()
...
'Ripple'
'SwiftCoin'
'BlackCoin'
'Nxt'
'IOTA'
currency() → Tuple[str, str]
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.currency()
...
('MWK', 'Malawian kwacha')
('NZD', 'New Zealand dollar')
('BAM', 'Bosnia and Herzegovina convertible mark')
('IRR', 'Iranian rial')
('SPL', 'Seborga luigino')
currency_code() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.currency_code()
...
'MWK'
'NZD'
'BAM'
'IRR'
'SPL'
currency_name() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.currency_name()
...
'Malawian kwacha'
'New Zealand dollar'
'Bosnia and Herzegovina convertible mark'
'Iranian rial'
'Seborga luigino'
currency_symbol(code: Optional[str] = None) → str
Example:$
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.currency_symbol()
...
'$'
'₨'
'$'
'₹'
'£'
pricetag() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.pricetag()
...
'R$7.604,87'
'R$975,93'
'R$54,21'
'R$89.241,15'
'R$91.565,93'

faker.providers.date_time

class faker.providers.date_time.pt_BR.Provider(generator: Any)

Bases: faker.providers.date_time.Provider

am_pm() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.am_pm()
...
'AM'
'AM'
'AM'
'AM'
'AM'
century() → str

:example ‘XVII’

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.century()
...
'XIII'
'XIV'
'II'
'IX'
'XVII'
date(pattern: str = '%Y-%m-%d', end_datetime: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int, None] = None) → str

Get a date string between January 1, 1970 and now :param pattern format :example ‘2008-11-27’

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date()
...
'1996-03-20'
'2021-07-31'
'1998-08-15'
'1972-10-03'
'1987-08-15'
date_between(start_date: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int] = '-30y', end_date: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int] = 'today') → datetime.date

Get a Date object based on a random date between two given dates. Accepts date strings that can be recognized by strtotime().

:param start_date Defaults to 30 years ago :param end_date Defaults to “today” :example Date(‘1999-02-02’) :return Date

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_between()
...
datetime.date(2020, 7, 18)
datetime.date(2004, 12, 2)
datetime.date(2017, 8, 8)
datetime.date(2006, 2, 14)
datetime.date(1993, 3, 11)
date_between_dates(date_start: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int, None] = None, date_end: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int, None] = None) → datetime.date

Takes two Date objects and returns a random date between the two given dates. Accepts Date or datetime objects

Parameters:
  • date_start – Date
  • date_end – Date

:return Date

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_between_dates()
...
datetime.date(2021, 10, 25)
datetime.date(2021, 10, 25)
datetime.date(2021, 10, 25)
datetime.date(2021, 10, 25)
datetime.date(2021, 10, 25)
date_object(end_datetime: datetime.datetime = None) → datetime.date

Get a date object between January 1, 1970 and now :example datetime.date(2016, 9, 20)

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_object()
...
datetime.date(1996, 3, 20)
datetime.date(2021, 7, 31)
datetime.date(1998, 8, 15)
datetime.date(1972, 10, 3)
datetime.date(1987, 8, 15)
date_of_birth(tzinfo: Optional[datetime.tzinfo] = None, minimum_age: int = 0, maximum_age: int = 115) → datetime.date

Generate a random date of birth represented as a Date object, constrained by optional miminimum_age and maximum_age parameters.

:param tzinfo Defaults to None. :param minimum_age Defaults to 0. :param maximum_age Defaults to 115.

:example Date(‘1979-02-02’) :return Date

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_of_birth()
...
datetime.date(2020, 9, 27)
datetime.date(1958, 3, 31)
datetime.date(2008, 12, 21)
datetime.date(1963, 1, 20)
datetime.date(1911, 4, 29)
date_this_century(before_today: bool = True, after_today: bool = False) → datetime.date

Gets a Date object for the current century.

Parameters:
  • before_today – include days in current century before today
  • after_today – include days in current century after today

:example Date(‘2012-04-04’) :return Date

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_century()
...
datetime.date(2013, 2, 8)
datetime.date(2014, 4, 23)
datetime.date(2001, 5, 18)
datetime.date(2008, 10, 22)
datetime.date(2017, 5, 24)
date_this_decade(before_today: bool = True, after_today: bool = False) → datetime.date

Gets a Date object for the decade year.

Parameters:
  • before_today – include days in current decade before today
  • after_today – include days in current decade after today

:example Date(‘2012-04-04’) :return Date

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_decade()
...
datetime.date(2021, 10, 17)
datetime.date(2020, 10, 26)
datetime.date(2021, 8, 11)
datetime.date(2020, 11, 22)
datetime.date(2020, 2, 1)
date_this_month(before_today: bool = True, after_today: bool = False) → datetime.date

Gets a Date object for the current month.

Parameters:
  • before_today – include days in current month before today
  • after_today – include days in current month after today

:example dtdate(‘2012-04-04’) :return dtdate

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_month()
...
datetime.date(2021, 10, 21)
datetime.date(2021, 10, 10)
datetime.date(2021, 10, 19)
datetime.date(2021, 10, 22)
datetime.date(2021, 10, 11)
date_this_year(before_today: bool = True, after_today: bool = False) → datetime.date

Gets a Date object for the current year.

Parameters:
  • before_today – include days in current year before today
  • after_today – include days in current year after today

:example Date(‘2012-04-04’) :return Date

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_this_year()
...
datetime.date(2021, 5, 30)
datetime.date(2021, 10, 22)
datetime.date(2021, 6, 13)
datetime.date(2021, 1, 16)
datetime.date(2021, 4, 11)
date_time(tzinfo: Optional[datetime.tzinfo] = None, end_datetime: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int, None] = None) → datetime.datetime

Get a datetime object for a date between January 1, 1970 and now :param tzinfo: timezone, instance of datetime.tzinfo subclass :example datetime(‘2005-08-16 20:39:21’) :return datetime

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time()
...
datetime.datetime(1996, 3, 20, 7, 46, 39)
datetime.datetime(2021, 7, 31, 1, 24, 38)
datetime.datetime(1998, 8, 15, 8, 43, 22)
datetime.datetime(1972, 10, 3, 5, 52, 26)
datetime.datetime(1987, 8, 15, 9, 51, 25)
date_time_ad(tzinfo: Optional[datetime.tzinfo] = None, end_datetime: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int, None] = None, start_datetime: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int, None] = None) → datetime.datetime

Get a datetime object for a date between January 1, 001 and now :param tzinfo: timezone, instance of datetime.tzinfo subclass :example datetime(‘1265-03-22 21:15:52’) :return datetime

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_ad()
...
datetime.datetime(932, 7, 17, 1, 20, 13)
datetime.datetime(2009, 8, 3, 21, 25)
datetime.datetime(58, 3, 29, 17, 26, 45)
datetime.datetime(1023, 4, 21, 11, 47, 46)
datetime.datetime(1961, 7, 18, 3, 50, 16)
date_time_between(start_date: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int] = '-30y', end_date: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int] = 'now', tzinfo: Optional[datetime.tzinfo] = None) → datetime.datetime

Get a datetime object based on a random date between two given dates. Accepts date strings that can be recognized by strtotime().

:param start_date Defaults to 30 years ago :param end_date Defaults to “now” :param tzinfo: timezone, instance of datetime.tzinfo subclass :example datetime(‘1999-02-02 11:42:52’) :return datetime

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_between()
...
datetime.datetime(2020, 7, 19, 14, 48, 30)
datetime.datetime(2004, 12, 4, 4, 4, 10)
datetime.datetime(2017, 8, 10, 0, 53, 10)
datetime.datetime(2006, 2, 16, 4, 32, 32)
datetime.datetime(1993, 3, 12, 15, 7, 4)
date_time_between_dates(datetime_start: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int, None] = None, datetime_end: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int, None] = None, tzinfo: Optional[datetime.tzinfo] = None) → datetime.datetime

Takes two datetime objects and returns a random datetime between the two given datetimes. Accepts datetime objects.

Parameters:
  • datetime_start – datetime
  • datetime_end – datetime
  • tzinfo – timezone, instance of datetime.tzinfo subclass

:example datetime(‘1999-02-02 11:42:52’) :return datetime

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_between_dates()
...
datetime.datetime(2021, 10, 25, 16, 58, 51)
datetime.datetime(2021, 10, 25, 16, 58, 51)
datetime.datetime(2021, 10, 25, 16, 58, 51)
datetime.datetime(2021, 10, 25, 16, 58, 51)
datetime.datetime(2021, 10, 25, 16, 58, 51)
date_time_this_century(before_now: bool = True, after_now: bool = False, tzinfo: Optional[datetime.tzinfo] = None) → datetime.datetime

Gets a datetime object for the current century.

Parameters:
  • before_now – include days in current century before today
  • after_now – include days in current century after today
  • tzinfo – timezone, instance of datetime.tzinfo subclass

:example datetime(‘2012-04-04 11:02:02’) :return datetime

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_century()
...
datetime.datetime(2013, 2, 8, 15, 53, 19)
datetime.datetime(2014, 4, 23, 16, 21, 41)
datetime.datetime(2001, 5, 18, 2, 56, 13)
datetime.datetime(2008, 10, 22, 16, 55, 42)
datetime.datetime(2017, 5, 24, 21, 37, 28)
date_time_this_decade(before_now: bool = True, after_now: bool = False, tzinfo: Optional[datetime.tzinfo] = None) → datetime.datetime

Gets a datetime object for the decade year.

Parameters:
  • before_now – include days in current decade before today
  • after_now – include days in current decade after today
  • tzinfo – timezone, instance of datetime.tzinfo subclass

:example datetime(‘2012-04-04 11:02:02’) :return datetime

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_decade()
...
datetime.datetime(2021, 10, 17, 21, 9, 51)
datetime.datetime(2020, 10, 26, 5, 29, 34)
datetime.datetime(2021, 8, 11, 17, 17, 38)
datetime.datetime(2020, 11, 22, 16, 1, 21)
datetime.datetime(2020, 2, 1, 10, 41)
date_time_this_month(before_now: bool = True, after_now: bool = False, tzinfo: Optional[datetime.tzinfo] = None) → datetime.datetime

Gets a datetime object for the current month.

Parameters:
  • before_now – include days in current month before today
  • after_now – include days in current month after today
  • tzinfo – timezone, instance of datetime.tzinfo subclass

:example datetime(‘2012-04-04 11:02:02’) :return datetime

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_month()
...
datetime.datetime(2021, 10, 19, 16, 50, 35)
datetime.datetime(2021, 10, 21, 10, 0, 5)
datetime.datetime(2021, 10, 2, 23, 10, 3)
datetime.datetime(2021, 10, 13, 13, 39, 35)
datetime.datetime(2021, 10, 24, 14, 8, 48)
date_time_this_year(before_now: bool = True, after_now: bool = False, tzinfo: Optional[datetime.tzinfo] = None) → datetime.datetime

Gets a datetime object for the current year.

Parameters:
  • before_now – include days in current year before today
  • after_now – include days in current year after today
  • tzinfo – timezone, instance of datetime.tzinfo subclass

:example datetime(‘2012-04-04 11:02:02’) :return datetime

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.date_time_this_year()
...
datetime.datetime(2021, 5, 30, 14, 44, 47)
datetime.datetime(2021, 10, 22, 8, 38, 49)
datetime.datetime(2021, 6, 13, 8, 0, 40)
datetime.datetime(2021, 1, 16, 17, 20, 30)
datetime.datetime(2021, 4, 11, 13, 16, 44)
day_of_month() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.day_of_month()
...
'20'
'31'
'15'
'03'
'15'
day_of_week()
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.day_of_week()
...
'quarta-feira'
'sábado'
'sábado'
'terça-feira'
'sábado'
future_date(end_date: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int] = '+30d', tzinfo: Optional[datetime.tzinfo] = None) → datetime.date

Get a Date object based on a random date between 1 day from now and a given date. Accepts date strings that can be recognized by strtotime().

:param end_date Defaults to “+30d” :param tzinfo: timezone, instance of datetime.tzinfo subclass :example dtdate(‘2030-01-01’) :return dtdate

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_date()
...
datetime.date(2021, 11, 13)
datetime.date(2021, 11, 15)
datetime.date(2021, 10, 27)
datetime.date(2021, 11, 7)
datetime.date(2021, 11, 19)
future_datetime(end_date: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int] = '+30d', tzinfo: Optional[datetime.tzinfo] = None) → datetime.datetime

Get a datetime object based on a random date between 1 second form now and a given date. Accepts date strings that can be recognized by strtotime().

:param end_date Defaults to “+30d” :param tzinfo: timezone, instance of datetime.tzinfo subclass :example datetime(‘1999-02-02 11:42:52’) :return datetime

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.future_datetime()
...
datetime.datetime(2021, 11, 13, 9, 49, 27)
datetime.datetime(2021, 11, 15, 2, 58, 57)
datetime.datetime(2021, 10, 27, 16, 8, 55)
datetime.datetime(2021, 11, 7, 6, 38, 27)
datetime.datetime(2021, 11, 19, 12, 39, 33)
iso8601(tzinfo: Optional[datetime.tzinfo] = None, end_datetime: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int, None] = None) → str
Parameters:tzinfo – timezone, instance of datetime.tzinfo subclass

:example ‘2003-10-21T16:05:52+0000’

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.iso8601()
...
'1996-03-20T07:46:39'
'2021-07-31T01:24:38'
'1998-08-15T08:43:22'
'1972-10-03T05:52:26'
'1987-08-15T09:51:25'
month() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.month()
...
'03'
'07'
'08'
'10'
'08'
month_name()
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.month_name()
...
'março'
'julho'
'agosto'
'outubro'
'agosto'
past_date(start_date: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int] = '-30d', tzinfo: Optional[datetime.tzinfo] = None) → datetime.date

Get a Date object based on a random date between a given date and 1 day ago. Accepts date strings that can be recognized by strtotime().

:param start_date Defaults to “-30d” :param tzinfo: timezone, instance of datetime.tzinfo subclass :example dtdate(‘1999-02-02’) :return dtdate

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.past_date()
...
datetime.date(2021, 10, 13)
datetime.date(2021, 10, 15)
datetime.date(2021, 9, 26)
datetime.date(2021, 10, 7)
datetime.date(2021, 10, 19)
past_datetime(start_date: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int] = '-30d', tzinfo: Optional[datetime.tzinfo] = None) → datetime.datetime

Get a datetime object based on a random date between a given date and 1 second ago. Accepts date strings that can be recognized by strtotime().

:param start_date Defaults to “-30d” :param tzinfo: timezone, instance of datetime.tzinfo subclass :example datetime(‘1999-02-02 11:42:52’) :return datetime

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.past_datetime()
...
datetime.datetime(2021, 10, 14, 9, 49, 26)
datetime.datetime(2021, 10, 16, 2, 58, 56)
datetime.datetime(2021, 9, 27, 16, 8, 54)
datetime.datetime(2021, 10, 8, 6, 38, 26)
datetime.datetime(2021, 10, 20, 12, 39, 32)
pytimezone(*args, **kwargs) → Optional[datetime.tzinfo]

Generate a random timezone (see faker.timezone for any args) and return as a python object usable as a tzinfo to datetime or other fakers.

:example faker.pytimezone() :return dateutil.tz.tz.tzfile

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.pytimezone()
...
tzfile('/usr/share/zoneinfo/Indian/Maldives')
tzfile('/usr/share/zoneinfo/America/Barbados')
tzfile('/usr/share/zoneinfo/Europe/Stockholm')
tzfile('/usr/share/zoneinfo/Africa/Windhoek')
tzfile('/usr/share/zoneinfo/Asia/Qatar')
time(pattern: str = '%H:%M:%S', end_datetime: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int, None] = None) → str

Get a time string (24h format by default) :param pattern format :example ‘15:02:34’

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time()
...
'07:46:39'
'01:24:38'
'08:43:22'
'05:52:26'
'09:51:25'
time_delta(end_datetime: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int, None] = None) → datetime.timedelta

Get a timedelta object

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time_delta()
...
datetime.timedelta(0)
datetime.timedelta(0)
datetime.timedelta(0)
datetime.timedelta(0)
datetime.timedelta(0)
time_object(end_datetime: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int, None] = None) → datetime.time

Get a time object :example datetime.time(15, 56, 56, 772876)

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time_object()
...
datetime.time(7, 46, 39)
datetime.time(1, 24, 38)
datetime.time(8, 43, 22)
datetime.time(5, 52, 26)
datetime.time(9, 51, 25)
time_series(start_date: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int] = '-30d', end_date: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int] = 'now', precision: Optional[float] = None, distrib: Optional[Callable[[datetime.datetime], float]] = None, tzinfo: Optional[datetime.tzinfo] = None) → Iterator[Tuple[datetime.datetime, Any]]

Returns a generator yielding tuples of (<datetime>, <value>).

The data points will start at start_date, and be at every time interval specified by precision. distrib is a callable that accepts <datetime> and returns <value>

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.time_series()
...
<generator object Provider.time_series at 0x7f426ddecc50>
<generator object Provider.time_series at 0x7f426ddecc50>
<generator object Provider.time_series at 0x7f426ddecc50>
<generator object Provider.time_series at 0x7f426ddecc50>
<generator object Provider.time_series at 0x7f426ddecc50>
timezone() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.timezone()
...
'Indian/Maldives'
'America/Barbados'
'Europe/Stockholm'
'Africa/Windhoek'
'Asia/Qatar'
unix_time(end_datetime: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int, None] = None, start_datetime: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int, None] = None) → int

Get a timestamp between January 1, 1970 and now, unless passed explicit start_datetime or end_datetime values. :example 1061306726

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.unix_time()
...
827307999
1627694678
903170602
86939546
556019485
year() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.year()
...
'1996'
'2021'
'1998'
'1972'
'1987'

faker.providers.internet

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

Bases: faker.providers.internet.Provider

ascii_company_email() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.ascii_company_email()
...
'cpeixoto@silva.br'
'ejesus@da.com'
'guilherme19@teixeira.com'
'eduardo15@castro.br'
'nlopes@vieira.org'
ascii_email() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.ascii_email()
...
'qbarbosa@bol.com.br'
'ejesus@yahoo.com.br'
'miguelcunha@fernandes.com'
'cardosomaria-luiza@yahoo.com.br'
'moraesana-julia@yahoo.com.br'
ascii_free_email() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.ascii_free_email()
...
'cpeixoto@yahoo.com.br'
'ynunes@yahoo.com.br'
'lmoraes@hotmail.com'
'miguelcunha@gmail.com'
'emilly92@yahoo.com.br'
ascii_safe_email() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.ascii_safe_email()
...
'cpeixoto@example.com'
'ynunes@example.com'
'lmoraes@example.org'
'miguelcunha@example.org'
'emilly92@example.com'
company_email() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.company_email()
...
'cpeixoto@silva.br'
'ejesus@da.com'
'guilherme19@teixeira.com'
'eduardo15@castro.br'
'nlopes@vieira.org'
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()
...
'peixoto.com'
'silva.br'
'jesus.br'
'da.com'
'cunha.com'
domain_word() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.domain_word()
...
'peixoto'
'ferreira'
'nunes'
'rocha'
'da'
email(safe: bool = True, domain: Optional[str] = None) → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.email()
...
'cpeixoto@example.com'
'ynunes@example.com'
'lmoraes@example.org'
'miguelcunha@example.org'
'emilly92@example.com'
free_email() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.free_email()
...
'cpeixoto@yahoo.com.br'
'ynunes@yahoo.com.br'
'lmoraes@hotmail.com'
'miguelcunha@gmail.com'
'emilly92@yahoo.com.br'
free_email_domain() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.free_email_domain()
...
'uol.com.br'
'uol.com.br'
'gmail.com'
'yahoo.com.br'
'bol.com.br'
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.ferreira.br'
'laptop-47.da.com'
'desktop-21.teixeira.com'
'desktop-11.ribeiro.com'
'desktop-65.vieira.org'
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) → str

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

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.image_url()
...
'https://www.lorempixel.com/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()
...
'cpeixoto@example.com'
'ynunes@example.com'
'lmoraes@example.org'
'miguelcunha@example.org'
'emilly92@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()
...
'br'
'br'
'com'
'org'
'br'
uri() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.uri()
...
'https://www.silva.br/explore/posts/register/'
'http://www.cunha.com/faq.htm'
'http://cardoso.br/categories/category/homepage.htm'
'https://caldeira.com/explore/author.php'
'https://martins.net/'
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://ferreira.br/'
'https://moraes.net/'
'http://castro.com/'
'https://www.melo.com/'
'https://da.br/'
user_name() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.user_name()
...
'cpeixoto'
'daniela76'
'barbara59'
'claricecunha'
'guilherme19'

faker.providers.job

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

Bases: faker.providers.job.Provider

job() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.job()
...
'Jogador de golfe'
'Lutador de luta livre'
'Armador'
'Engenheiro de produto ou produção'
'Paparazzo'

faker.providers.person

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

Bases: faker.providers.person.Provider

first_name() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.first_name()
...
'Vitor'
'Sabrina'
'Ana Beatriz'
'Bruno'
'Luiz Henrique'
first_name_female() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.first_name_female()
...
'Joana'
'Sophie'
'Kamilly'
'Amanda'
'Emanuella'
first_name_male() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.first_name_male()
...
'João Pedro'
'Vitor Hugo'
'Kaique'
'Augusto'
'Francisco'
first_name_nonbinary() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.first_name_nonbinary()
...
'Vitor'
'Sabrina'
'Ana Beatriz'
'Bruno'
'Luiz Henrique'
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()
...
'Nogueira'
'Peixoto'
'Barbosa'
'Ferreira'
'Silva'
last_name_female() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.last_name_female()
...
'Nogueira'
'Peixoto'
'Barbosa'
'Ferreira'
'Silva'
last_name_male() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.last_name_male()
...
'Nogueira'
'Peixoto'
'Barbosa'
'Ferreira'
'Silva'
last_name_nonbinary() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.last_name_nonbinary()
...
'Nogueira'
'Peixoto'
'Barbosa'
'Ferreira'
'Silva'
name() → str

:example ‘John Doe’

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.name()
...
'Sophie Peixoto'
'Francisco Silva'
'Juliana Jesus'
'Isabella da Rosa'
'Beatriz Gomes'
name_female() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.name_female()
...
'Sophie Peixoto'
'Emanuella Silva'
'Juliana Jesus'
'Isabella da Rosa'
'Beatriz Gomes'
name_male() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.name_male()
...
'Vitor Hugo Peixoto'
'Francisco Silva'
'João Jesus'
'João Gabriel da Rosa'
'Daniel Gomes'
name_nonbinary() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.name_nonbinary()
...
'Sophie Peixoto'
'Francisco Silva'
'Juliana Jesus'
'Isabella da Rosa'
'Beatriz Gomes'
prefix() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.prefix()
...
'Sra.'
'Dr.'
'Sra.'
'Sra.'
'Dra.'
prefix_female() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.prefix_female()
...
'Sra.'
'Sra.'
'Srta.'
'Sra.'
'Dra.'
prefix_male() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.prefix_male()
...
'Dr.'
'Dr.'
'Sr.'
'Dr.'
'Dr.'
prefix_nonbinary() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.prefix_nonbinary()
...
'Sra.'
'Dr.'
'Sra.'
'Sra.'
'Dra.'
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.pt_BR.Provider(generator: Any)

Bases: faker.providers.phone_number.Provider

cellphone_number() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.cellphone_number()
...
'+55 60 9 4876-4759'
'+55 (82) 94219 4892'
'+55 (11) 9 5781 5659'
'+55 (87) 97840 8016'
'+55 97 95351 3933'
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()
...
'5571960487647'
'5561993824219'
'5551989241157'
'5584915659387'
'5581984080160'
phone_number() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.phone_number()
...
'51 6048 7647'
'11 9382 4219'
'+55 61 8924-1157'
'84 1565-9387'
'(031) 8408-0160'
service_phone_number() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.service_phone_number()
...
'192'
'193'
'128'
'185'
'198'

faker.providers.ssn

class faker.providers.ssn.pt_BR.Provider(generator: Any)

Bases: faker.providers.ssn.Provider

Provider for Brazilian SSN also known in Brazil as CPF. There are two methods Provider.ssn and Provider.cpf The snn returns a valid number with numbers only The cpf return a valid number formatted with brazilian mask. eg nnn.nnn.nnn-nn

cpf() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.cpf()
...
'690.243.518-98'
'532.710.684-53'
'418.652.390-89'
'569.471.382-64'
'089.753.621-59'
rg() → str

Brazilian RG, return plain numbers. Check: https://www.ngmatematica.com/2014/02/como-determinar-o-digito-verificador-do.html

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.rg()
...
'68024315X'
'75416830X'
'147568304'
'153402866'
'378420562'
ssn() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.ssn()
...
'69024351898'
'53271068453'
'41865239089'
'56947138264'
'08975362159'