# Locale pt_BR

## `faker.providers.address`

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

  Bases: `Provider`

  address() → str
    Example:

      ‘791 Crist Parks, Sashabury, IL 86039-9874’

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.address()
        ...
        'Área Valentim Moraes, 56\nProvidencia\n93824-219 Nascimento Grande / MA'
        'Viela Farias, 28\nMaria Helena\n59387-784 Novaes / AC'
        "Viaduto Alexandre Pimenta, 45\nVila Olhos D'água\n13933-287 Barros / MT"
        'Sítio Ana Santos\nCasa Branca\n83989-471 Dias Verde / ES'
        'Estação Andrade, 247\nBrasil Industrial\n20186848 Cunha / 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()
        ...
        'Teixeira das Pedras'
        'da Luz'
        'Guerra de Viana'
        'Mendes da Praia'
        'Montenegro'

  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'

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

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.country_code(representation='alpha-3')
        ...
        'MDV'
        'PSE'
        'NLD'
        'BRB'
        'ISR'

  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 da Luz, 576'
        'Trecho Pedro Henrique Montenegro, 34'
        'Vale da Cunha, 592'
        'Campo de Rodrigues'
        'Sítio Guilherme Fogaça, 45'

  street_name() → str
    Example:

      ‘Crist Parks’

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.street_name()
        ...
        'Pátio Bruno da Luz'
        'Residencial de Guerra'
        'Recanto Elisa Pacheco'
        'Rodovia Carvalho'
        'Conjunto Gabriel Pinto'

  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: `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-8I76'
        'PLS-8G24'
        'YDT-4Z89'
        'JDX-5C78'
        'LNK-3T87'

  vin() → str

    Generate vin number.

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.vin()
        ...
        'RT3GZYSK4Z9J97593'
        '7G0K75MX5LDXV8156'
        'G416S1YM2EF0V3513'
        '66LZY7KJ7DJV61858'
        'RLFJBCB3669039471'

## `faker.providers.color`

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

  Bases: `Provider`

  Implement color provider for `pt_BR` locale.

  color(hue: str | float | int | Sequence[int] | None = None, luminosity: str | None = 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_hsl(hue: str | float | int | Sequence[int] | None = None, luminosity: str | None = None) → Tuple[int, int, int]

    Generate a HSL color tuple.

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.color_hsl()
        ...
        (197, 57, 32)
        (132, 90, 39)
        (207, 76, 65)
        (183, 88, 33)
        (258, 62, 73)

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.color_hsl(hue='red', luminosity='dark')
        ...
        (358, 92, 27)
        (350, 96, 33)
        (359, 88, 36)
        (356, 98, 28)
        (6, 85, 34)

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.color_hsl(hue=(100, 200), luminosity='random')
        ...
        (149, 94, 27)
        (105, 23, 54)
        (162, 100, 74)
        (138, 43, 31)
        (174, 19, 55)

  color_hsv(hue: str | float | int | Sequence[int] | None = None, luminosity: str | None = None) → Tuple[int, int, int]

    Generate a HSV color tuple.

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.color_hsv()
        ...
        (197, 73, 51)
        (132, 95, 76)
        (207, 58, 92)
        (183, 94, 64)
        (258, 37, 90)

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.color_hsv(hue='red', luminosity='dark')
        ...
        (358, 96, 53)
        (350, 98, 66)
        (359, 94, 68)
        (356, 99, 56)
        (6, 92, 63)

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.color_hsv(hue=(100, 200), luminosity='random')
        ...
        (149, 97, 53)
        (105, 33, 65)
        (162, 51, 100)
        (138, 61, 45)
        (174, 27, 64)

  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'

  color_rgb(hue: str | float | int | Sequence[int] | None = None, luminosity: str | None = None) → Tuple[int, int, int]

    Generate a RGB color tuple of integers.

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.color_rgb()
        ...
        (35, 103, 130)
        (9, 193, 46)
        (98, 173, 234)
        (9, 155, 163)
        (170, 144, 229)

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.color_rgb(hue='red', luminosity='dark')
        ...
        (135, 5, 9)
        (168, 3, 30)
        (173, 10, 13)
        (142, 1, 10)
        (160, 27, 12)

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.color_rgb(hue=(100, 200), luminosity='random')
        ...
        (4, 135, 67)
        (124, 165, 111)
        (124, 255, 215)
        (44, 114, 65)
        (119, 163, 158)

  color_rgb_float(hue: str | float | int | Sequence[int] | None = None, luminosity: str | None = None) → Tuple[float, float, float]

    Generate a RGB color tuple of floats.

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.color_rgb_float()
        ...
        (0.13770000000000002, 0.4045149999999999, 0.51)
        (0.038000000000000034, 0.76, 0.18239999999999984)
        (0.3864000000000001, 0.6798800000000002, 0.92)
        (0.03840000000000004, 0.6099200000000001, 0.64)
        (0.6668999999999999, 0.5670000000000001, 0.9)

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.color_rgb_float(hue='red', luminosity='dark')
        ...
        (0.53, 0.02120000000000002, 0.03815999999999998)
        (0.66, 0.013200000000000012, 0.12100000000000023)
        (0.68, 0.04080000000000004, 0.05145333333333333)
        (0.56, 0.005600000000000005, 0.042559999999999855)
        (0.63, 0.10835999999999996, 0.05039999999999997)

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.color_rgb_float(hue=(100, 200), luminosity='random')
        ...
        (0.015900000000000015, 0.53, 0.2643816666666667)
        (0.489125, 0.65, 0.43549999999999994)
        (0.49, 1.0, 0.8470000000000001)
        (0.17550000000000002, 0.45, 0.2578500000000001)
        (0.4672, 0.64, 0.62272)

  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: `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()
        ...
        'Teixeira'
        'Aparecida'
        'Moraes'
        'Guerra'
        'Mendes'

  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: `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: str | None = None) → str
    Example:

      $

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.currency_symbol()
        ...
        '$'
        '$'
        'KM'
        'kr'
        'L'

  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: `Provider`

  am_pm() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.am_pm()
        ...
        'AM'
        'AM'
        'PM'
        'AM'
        'AM'

  century() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.century()
        ...
        'XIII'
        'XIV'
        'II'
        'IX'
        'XVII'

  date(pattern: str = '%Y-%m-%d', end_datetime: date | datetime | timedelta | str | int | None = None) → str

    Get a date string between January 1, 1970 and now.

    Parameters:

      - pattern – Format of the date (year-month-day by default)

      - end_datetime – A `DateParseType`. Defaults to the current date and time

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date()
        ...
        '2017-04-10'
        '2012-06-07'
        '1993-07-18'
        '1984-06-30'
        '1998-08-16'

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date(pattern='%m/%d/%Y')
        ...
        '04/10/2017'
        '06/07/2012'
        '07/18/1993'
        '06/30/1984'
        '08/16/1998'

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date(end_datetime='+1w')
        ...
        '2017-04-15'
        '2012-06-12'
        '1993-07-21'
        '1984-07-01'
        '1998-08-19'

  date_between(start_date: date | datetime | timedelta | str | int = '-30y', end_date: date | datetime | timedelta | str | int = 'today') → date

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

    Parameters:

      - start_date – A `DateParseType`. Defaults to 30 years ago

      - end_date – A `DateParseType`. Defaults to `"today"`

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date_between()
        ...
        datetime.date(2021, 4, 25)
        datetime.date(2018, 9, 20)
        datetime.date(2008, 8, 6)
        datetime.date(2003, 10, 1)
        datetime.date(2011, 4, 27)

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date_between(start_date='-1w')
        ...
        datetime.date(2025, 12, 23)
        datetime.date(2025, 12, 23)
        datetime.date(2025, 12, 20)
        datetime.date(2025, 12, 19)
        datetime.date(2025, 12, 21)

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date_between(start_date="-1y", end_date="+1w")
        ...
        datetime.date(2025, 11, 3)
        datetime.date(2025, 10, 2)
        datetime.date(2025, 5, 29)
        datetime.date(2025, 3, 30)
        datetime.date(2025, 7, 2)

  date_between_dates(date_start: date | datetime | timedelta | str | int | None = None, date_end: date | datetime | timedelta | str | int | None = None) → date

    Get a random date between the two given dates.

    Parameters:

      - date_start – A `DateParseType`. Defaults to the UNIX epoch

      - date_end – A `DateParseType`. Defaults to the current date and time

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date_between_dates()
        ...
        datetime.date(2025, 12, 25)
        datetime.date(2025, 12, 25)
        datetime.date(2025, 12, 25)
        datetime.date(2025, 12, 25)
        datetime.date(2025, 12, 25)

  date_object(end_datetime: datetime | None = None) → date

    Get a date object between January 1, 1970 and now

    Parameters:

      end_datetime – A `DateParseType`. Defaults to the current date and time

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date_object()
        ...
        datetime.date(2017, 4, 10)
        datetime.date(2012, 6, 7)
        datetime.date(1993, 7, 18)
        datetime.date(1984, 6, 30)
        datetime.date(1998, 8, 16)

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date_object(end_datetime='+1w')
        ...
        datetime.date(2017, 4, 15)
        datetime.date(2012, 6, 12)
        datetime.date(1993, 7, 21)
        datetime.date(1984, 7, 1)
        datetime.date(1998, 8, 19)

  date_of_birth(tzinfo: tzinfo | None = None, minimum_age: int = 0, maximum_age: int = 115) → date

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

    Parameters:

      - tzinfo – Defaults to None.

      - minimum_age – Defaults to `0`.

      - maximum_age – Defaults to `115`.

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date_of_birth()
        ...
        datetime.date(2007, 12, 8)
        datetime.date(1997, 11, 26)
        datetime.date(1958, 10, 8)
        datetime.date(1940, 1, 7)
        datetime.date(1969, 4, 16)

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date_of_birth(minimum_age=30, maximum_age=50)
        ...
        datetime.date(1992, 9, 17)
        datetime.date(1990, 11, 24)
        datetime.date(1983, 10, 24)
        datetime.date(1980, 6, 1)
        datetime.date(1985, 9, 19)

  date_this_century(before_today: bool = True, after_today: bool = False) → date

    Gets a Date object for the current century.

    Parameters:

      - before_today – include days in current century before today. Defaults to True

      - after_today – include days in current century after today. Defaults to False

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date_this_century()
        ...
        datetime.date(2021, 12, 9)
        datetime.date(2019, 9, 10)
        datetime.date(2010, 12, 5)
        datetime.date(2006, 9, 23)
        datetime.date(2013, 4, 13)

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date_this_century(before_today=False, after_today=True)
        ...
        datetime.date(2088, 6, 25)
        datetime.date(2082, 1, 31)
        datetime.date(2057, 2, 10)
        datetime.date(2045, 2, 22)
        datetime.date(2063, 10, 29)

  date_this_decade(before_today: bool = True, after_today: bool = False) → date

    Gets a Date object for the decade year.

    Parameters:

      - before_today – include days in current decade before today. Defaults to True

      - after_today – include days in current decade after today. Defaults to False

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date_this_decade()
        ...
        datetime.date(2025, 1, 19)
        datetime.date(2024, 7, 14)
        datetime.date(2022, 7, 7)
        datetime.date(2021, 7, 19)
        datetime.date(2023, 1, 22)

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date_this_decade(before_today=False, after_today=True)
        ...
        datetime.date(2029, 5, 17)
        datetime.date(2029, 1, 10)
        datetime.date(2027, 9, 3)
        datetime.date(2027, 1, 9)
        datetime.date(2028, 1, 14)

  date_this_month(before_today: bool = True, after_today: bool = False) → date

    Gets a Date object for the current month.

    Parameters:

      - before_today – include days in current month before today. Defaults to True

      - after_today – include days in current month after today. Defaults to False

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date_this_month()
        ...
        datetime.date(2025, 12, 21)
        datetime.date(2025, 12, 19)
        datetime.date(2025, 12, 11)
        datetime.date(2025, 12, 7)
        datetime.date(2025, 12, 13)

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date_this_month(before_today=False, after_today=True)
        ...
        datetime.date(2025, 12, 30)
        datetime.date(2025, 12, 30)
        datetime.date(2025, 12, 27)
        datetime.date(2025, 12, 26)
        datetime.date(2025, 12, 28)

  date_this_year(before_today: bool = True, after_today: bool = False) → date

    Gets a Date object for the current year.

    Parameters:

      - before_today – include days in current year before today. Defaults to True

      - after_today – include days in current year after today. Defaults to False

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date_this_year()
        ...
        datetime.date(2025, 10, 30)
        datetime.date(2025, 9, 29)
        datetime.date(2025, 5, 31)
        datetime.date(2025, 4, 3)
        datetime.date(2025, 7, 3)

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date_this_year(before_today=False, after_today=True)
        ...
        datetime.date(2025, 12, 30)
        datetime.date(2025, 12, 30)
        datetime.date(2025, 12, 27)
        datetime.date(2025, 12, 26)
        datetime.date(2025, 12, 28)

  date_time(tzinfo: tzinfo | None = None, end_datetime: date | datetime | timedelta | str | int | None = None) → datetime

    Get a datetime object for a date between January 1, 1970 and a specified end_datetime

    Parameters:

      - tzinfo – timezone, instance of datetime.tzinfo subclass

      - end_datetime – A `DateParseType`. Defaults to the current date and time

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date_time()
        ...
        datetime.datetime(2017, 4, 10, 2, 4, 10, 433355)
        datetime.datetime(2012, 6, 7, 1, 35, 52, 967201)
        datetime.datetime(1993, 7, 18, 12, 33, 12, 50510)
        datetime.datetime(1984, 6, 30, 3, 6, 59, 785103)
        datetime.datetime(1998, 8, 16, 3, 37, 14, 508747)

  date_time_ad(tzinfo: tzinfo | None = None, end_datetime: date | datetime | timedelta | str | int | None = None, start_datetime: date | datetime | timedelta | str | int | None = None) → datetime

    Get a datetime object for a date between January 1, 0001 and now

    Parameters:

      - tzinfo – timezone, instance of datetime.tzinfo subclass

      - end_datetime – A `DateParseType`. Defaults to the current date and time

      - start_datetime – A `DateParseType`. Defaults to UNIX timestamp `-62135596800`,

    equivalent to 0001-01-01 00:00:00 UTC

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date_time_ad()
        ...
        datetime.datetime(1710, 12, 10, 4, 39, 5, 903214)
        datetime.datetime(1535, 11, 6, 1, 42, 6, 850571)
        datetime.datetime(852, 8, 25, 14, 56, 4, 94505)
        datetime.datetime(525, 4, 21, 5, 13, 40, 754959)
        datetime.datetime(1036, 4, 28, 12, 2, 55, 500950)

  date_time_between(start_date: date | datetime | timedelta | str | int = '-30y', end_date: date | datetime | timedelta | str | int = 'now', tzinfo: tzinfo | None = None) → datetime

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

    Parameters:

      - start_date – A `DateParseType`. Defaults to 30 years ago

      - end_date – A `DateParseType`. Defaults to `"now"`

      - tzinfo – timezone, instance of datetime.tzinfo subclass

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date_time_between()
        ...
        datetime.datetime(2021, 4, 25, 12, 39, 13, 236214)
        datetime.datetime(2018, 9, 21, 2, 3, 59, 808743)
        datetime.datetime(2008, 8, 7, 7, 33, 40, 361449)
        datetime.datetime(2003, 10, 2, 0, 44, 16, 49189)
        datetime.datetime(2011, 4, 28, 4, 1, 12, 171082)

  date_time_between_dates(datetime_start: date | datetime | timedelta | str | int | None = None, datetime_end: date | datetime | timedelta | str | int | None = None, tzinfo: tzinfo | None = None) → datetime

    Get a random datetime between the two given datetimes.

    Parameters:

      - datetime_start – A `DateParseType`. Defaults to the UNIX epoch

      - datetime_end – A `DateParseType`. Defaults to the current date and time

      - tzinfo – timezone, instance of datetime.tzinfo subclass

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date_time_between_dates()
        ...
        datetime.datetime(2025, 12, 25, 5, 28, 30)
        datetime.datetime(2025, 12, 25, 5, 28, 30)
        datetime.datetime(2025, 12, 25, 5, 28, 30)
        datetime.datetime(2025, 12, 25, 5, 28, 30)
        datetime.datetime(2025, 12, 25, 5, 28, 30)

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date_time_between_dates(datetime_start='-30y', datetime_end='now')
        ...
        datetime.datetime(2021, 4, 25, 12, 39, 13, 236214)
        datetime.datetime(2018, 9, 21, 2, 3, 59, 808743)
        datetime.datetime(2008, 8, 7, 7, 33, 40, 361449)
        datetime.datetime(2003, 10, 2, 0, 44, 16, 49189)
        datetime.datetime(2011, 4, 28, 4, 1, 12, 171082)

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date_time_between_dates(datetime_start='now', datetime_end='+1y')
        ...
        datetime.datetime(2026, 10, 29, 15, 28, 27, 441207)
        datetime.datetime(2026, 9, 28, 1, 31, 16, 993625)
        datetime.datetime(2026, 5, 27, 20, 6, 16, 345382)
        datetime.datetime(2026, 3, 29, 19, 4, 37, 534973)
        datetime.datetime(2026, 6, 29, 23, 11, 11, 405703)

  date_time_this_century(before_now: bool = True, after_now: bool = False, tzinfo: tzinfo | None = None) → datetime

    Gets a datetime object for the current century.

    Parameters:

      - before_now – include days in current century before today. Defaults to True

      - after_now – include days in current century after today. Defaults to False

      - tzinfo – timezone, instance of datetime.tzinfo subclass

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date_time_this_century()
        ...
        datetime.datetime(2021, 12, 9, 18, 8, 38, 806736)
        datetime.datetime(2019, 9, 11, 3, 50, 40, 610542)
        datetime.datetime(2010, 12, 5, 7, 41, 9, 165978)
        datetime.datetime(2006, 9, 23, 4, 17, 47, 817359)
        datetime.datetime(2013, 4, 14, 2, 43, 47, 164850)

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date_time_this_century(before_now=False, after_now=True)
        ...
        datetime.datetime(2088, 6, 25, 23, 31, 33, 361950)
        datetime.datetime(2082, 1, 31, 8, 27, 36, 12347)
        datetime.datetime(2057, 2, 10, 6, 50, 12, 756770)
        datetime.datetime(2045, 2, 22, 23, 36, 6, 87162)
        datetime.datetime(2063, 10, 29, 10, 9, 57, 541350)

  date_time_this_decade(before_now: bool = True, after_now: bool = False, tzinfo: tzinfo | None = None) → datetime

    Gets a datetime object for the decade year.

    Parameters:

      - before_now – include days in current decade before today. Defaults to True

      - after_now – include days in current decade after today. Defaults to False

      - tzinfo – timezone, instance of datetime.tzinfo subclass

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date_time_this_decade()
        ...
        datetime.datetime(2025, 1, 19, 6, 6, 18, 372998)
        datetime.datetime(2024, 7, 14, 7, 16, 43, 285964)
        datetime.datetime(2022, 7, 8, 1, 4, 34, 781428)
        datetime.datetime(2021, 7, 19, 19, 0, 43, 36455)
        datetime.datetime(2023, 1, 22, 6, 2, 44, 223609)

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date_time_this_decade(before_now=False, after_now=True)
        ...
        datetime.datetime(2029, 5, 17, 15, 31, 20, 867856)
        datetime.datetime(2029, 1, 10, 17, 34, 29, 6532)
        datetime.datetime(2027, 9, 3, 12, 45, 1, 103138)
        datetime.datetime(2027, 1, 9, 6, 12, 44, 557610)
        datetime.datetime(2028, 1, 14, 15, 54, 24, 314974)

  date_time_this_month(before_now: bool = True, after_now: bool = False, tzinfo: tzinfo | None = None) → datetime

    Gets a datetime object for the current month.

    Parameters:

      - before_now – include days in current month before today. Defaults to True

      - after_now – include days in current month after today. Defaults to False

      - tzinfo – timezone, instance of datetime.tzinfo subclass

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date_time_this_month()
        ...
        datetime.datetime(2025, 12, 21, 11, 0, 36, 706016)
        datetime.datetime(2025, 12, 19, 8, 43, 53, 531219)
        datetime.datetime(2025, 12, 11, 4, 33, 6, 695869)
        datetime.datetime(2025, 12, 7, 6, 33, 13, 22556)
        datetime.datetime(2025, 12, 13, 9, 17, 36, 486988)

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date_time_this_month(before_now=False, after_now=True)
        ...
        datetime.datetime(2025, 12, 30, 22, 42, 52, 781109)
        datetime.datetime(2025, 12, 30, 8, 39, 41, 541616)
        datetime.datetime(2025, 12, 28, 1, 49, 42, 226228)
        datetime.datetime(2025, 12, 26, 23, 33, 19, 601429)
        datetime.datetime(2025, 12, 28, 16, 34, 11, 726726)

  date_time_this_year(before_now: bool = True, after_now: bool = False, tzinfo: tzinfo | None = None) → datetime

    Gets a datetime object for the current year.

    Parameters:

      - before_now – include days in current year before today. Defaults to True

      - after_now – include days in current year after today. Defaults to False

      - tzinfo – timezone, instance of datetime.tzinfo subclass

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date_time_this_year()
        ...
        datetime.datetime(2025, 10, 30, 11, 53, 44, 728585)
        datetime.datetime(2025, 9, 29, 12, 29, 38, 509509)
        datetime.datetime(2025, 5, 31, 15, 51, 13, 146853)
        datetime.datetime(2025, 4, 3, 18, 1, 49, 35810)
        datetime.datetime(2025, 7, 3, 3, 40, 17, 886355)

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.date_time_this_year(before_now=False, after_now=True)
        ...
        datetime.datetime(2025, 12, 30, 22, 42, 52, 781109)
        datetime.datetime(2025, 12, 30, 8, 39, 41, 541616)
        datetime.datetime(2025, 12, 28, 1, 49, 42, 226228)
        datetime.datetime(2025, 12, 26, 23, 33, 19, 601429)
        datetime.datetime(2025, 12, 28, 16, 34, 11, 726726)

  day_of_month() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.day_of_month()
        ...
        '10'
        '07'
        '18'
        '30'
        '16'

  day_of_week()
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.day_of_week()
        ...
        'segunda-feira'
        'quinta-feira'
        'domingo'
        'sábado'
        'domingo'

  future_date(end_date: date | datetime | timedelta | str | int = '+30d') → date

    Get a Date object based on a random date between 1 day from now and a given date.

    Parameters:

      - end_date – A `DateParseType`. Defaults to `"+30d"`

      - tzinfo – timezone, instance of datetime.tzinfo subclass

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.future_date()
        ...
        datetime.date(2026, 1, 19)
        datetime.date(2026, 1, 16)
        datetime.date(2026, 1, 7)
        datetime.date(2026, 1, 2)
        datetime.date(2026, 1, 9)

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.future_date(end_date='+1y')
        ...
        datetime.date(2026, 10, 29)
        datetime.date(2026, 9, 27)
        datetime.date(2026, 5, 28)
        datetime.date(2026, 3, 30)
        datetime.date(2026, 6, 30)

  future_datetime(end_date: date | datetime | timedelta | str | int = '+30d', tzinfo: tzinfo | None = None) → datetime

    Get a datetime object based on a random date between 1 second form now and a given date.

    Parameters:

      - end_date – A `DateParseType`. Defaults to `"+30d"`

      - tzinfo – timezone, instance of datetime.tzinfo subclass

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.future_datetime()
        ...
        datetime.datetime(2026, 1, 19, 13, 27, 31, 594731)
        datetime.datetime(2026, 1, 16, 23, 12, 8, 54467)
        datetime.datetime(2026, 1, 6, 20, 17, 12, 116942)
        datetime.datetime(2026, 1, 1, 23, 53, 42, 957843)
        datetime.datetime(2026, 1, 9, 13, 35, 34, 566513)

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.future_datetime(end_date='+1y')
        ...
        datetime.datetime(2026, 10, 29, 15, 28, 27, 596785)
        datetime.datetime(2026, 9, 28, 1, 31, 17, 235670)
        datetime.datetime(2026, 5, 27, 20, 6, 16, 924810)
        datetime.datetime(2026, 3, 29, 19, 4, 38, 276056)
        datetime.datetime(2026, 6, 29, 23, 11, 11, 894428)

  iso8601(tzinfo: tzinfo | None = None, end_datetime: date | datetime | timedelta | str | int | None = None, sep: str = 'T', timespec: str = 'auto') → str

    Get an ISO 8601 string for a datetime between the UNIX epoch and now.

    Parameters:

      - tzinfo – timezone, instance of datetime.tzinfo subclass

      - end_datetime – A `DateParseType`. Defaults to the current date and time

      - sep – separator between date and time, defaults to ‘T’

      - timespec – format specifier for the time part, defaults to ‘auto’ - see datetime.isoformat() documentation

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.iso8601()
        ...
        '2017-04-10T02:04:10.433355'
        '2012-06-07T01:35:52.967201'
        '1993-07-18T12:33:12.050510'
        '1984-06-30T03:06:59.785103'
        '1998-08-16T03:37:14.508747'

  month() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.month()
        ...
        '04'
        '06'
        '07'
        '06'
        '08'

  month_name()
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.month_name()
        ...
        'abril'
        'junho'
        'julho'
        'junho'
        'agosto'

  past_date(start_date: date | datetime | timedelta | str | int = '-30d', tzinfo: tzinfo | None = None) → date

    Get a Date object based on a random date between a given date and 1 day ago.

    Parameters:

      - start_date – A `DateParseType`. Defaults to `"-30d"`

      - tzinfo – timezone, instance of datetime.tzinfo subclass

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.past_date()
        ...
        datetime.date(2025, 12, 19)
        datetime.date(2025, 12, 16)
        datetime.date(2025, 12, 7)
        datetime.date(2025, 12, 2)
        datetime.date(2025, 12, 9)

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.past_date(start_date='-1y')
        ...
        datetime.date(2025, 10, 28)
        datetime.date(2025, 9, 26)
        datetime.date(2025, 5, 26)
        datetime.date(2025, 3, 28)
        datetime.date(2025, 6, 28)

  past_datetime(start_date: date | datetime | timedelta | str | int = '-30d', tzinfo: tzinfo | None = None) → datetime

    Get a datetime object based on a random date between a given date and 1 second ago.

    Parameters:

      - start_date – A `DateParseType`. Defaults to `"-30d"`

      - tzinfo – timezone, instance of datetime.tzinfo subclass

    Example:

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

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.past_datetime()
        ...
        datetime.datetime(2025, 12, 20, 13, 27, 30, 594731)
        datetime.datetime(2025, 12, 17, 23, 12, 7, 54467)
        datetime.datetime(2025, 12, 7, 20, 17, 11, 116942)
        datetime.datetime(2025, 12, 2, 23, 53, 41, 957843)
        datetime.datetime(2025, 12, 10, 13, 35, 33, 566513)

  pytimezone(*args: Any, **kwargs: Any) → tzinfo | None

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

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.pytimezone()
        ...
        zoneinfo.ZoneInfo(key='Indian/Maldives')
        zoneinfo.ZoneInfo(key='America/Barbados')
        zoneinfo.ZoneInfo(key='Europe/Stockholm')
        zoneinfo.ZoneInfo(key='Africa/Windhoek')
        zoneinfo.ZoneInfo(key='Asia/Qatar')

  time(pattern: str = '%H:%M:%S', end_datetime: date | datetime | timedelta | str | int | None = None) → str

    Get a time string (24h format by default)

    Parameters:

      - pattern – format

      - end_datetime – A `DateParseType`. Defaults to the current date and time

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.time()
        ...
        '02:04:10'
        '01:35:52'
        '12:33:12'
        '03:06:59'
        '03:37:14'

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.time(pattern='%I:%M %p')
        ...
        '02:04 AM'
        '01:35 AM'
        '12:33 PM'
        '03:06 AM'
        '03:37 AM'

  time_delta(end_datetime: date | datetime | timedelta | str | int | None = None) → timedelta

    Get a random timedelta object of duration between the current date and time and end_datetime

    Parameters:

      end_datetime – A `DateParseType`. Defaults to the current date and time

    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)

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.time_delta(end_datetime='+30h')
        ...
        datetime.timedelta(days=1, seconds=4797, microseconds=559965)
        datetime.timedelta(seconds=81859, microseconds=75518)
        datetime.timedelta(seconds=45421, microseconds=730730)
        datetime.timedelta(seconds=27963, microseconds=9032)
        datetime.timedelta(seconds=55217, microseconds=669908)

  time_object(end_datetime: date | datetime | timedelta | str | int | None = None) → time

    Get a time object

    Parameters:

      end_datetime – A `DateParseType`. Defaults to the current date and time

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.time_object()
        ...
        datetime.time(2, 4, 10, 433355)
        datetime.time(1, 35, 52, 967201)
        datetime.time(12, 33, 12, 50510)
        datetime.time(3, 6, 59, 785103)
        datetime.time(3, 37, 14, 508747)

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.time_object(end_datetime='+1h')
        ...
        datetime.time(2, 54, 50, 352021)
        datetime.time(2, 21, 21, 603052)
        datetime.time(12, 58, 26, 108201)
        datetime.time(3, 22, 31, 885404)
        datetime.time(4, 7, 55, 97743)

  time_series(start_date: date | datetime | timedelta | str | int = '-30d', end_date: date | datetime | timedelta | str | int = 'now', precision: float | None = None, distrib: Callable[[datetime], float] | None = None, tzinfo: tzinfo | None = None) → Iterator[Tuple[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`.

    Parameters:

      - start_date – A `DateParseType`. Defaults to `"-30d"`

      - end_date – A `DateParseType`. Defaults to `"now"`

      - precision – A float representing the time interval between data points.

    Defaults to 1/30th of the time :param distrib: A callable that accepts a datetime object and returns a value. Defaults to a uniform distribution :param tzinfo: timezone, instance of datetime.tzinfo subclass

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.time_series()
        ...
        <generator object Provider.time_series at 0x7d660458d7e0>
        <generator object Provider.time_series at 0x7d660458d7e0>
        <generator object Provider.time_series at 0x7d660458d7e0>
        <generator object Provider.time_series at 0x7d660458d7e0>
        <generator object Provider.time_series at 0x7d660458d7e0>

  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: date | datetime | timedelta | str | int | None = None, start_datetime: date | datetime | timedelta | str | int | None = None) → float

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

    On Windows, the decimal part is always 0.

    Parameters:

      - end_datetime – A `DateParseType`. Defaults to the UNIX epoch

      - start_datetime – A `DateParseType`. Defaults to the current date and time

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.unix_time()
        ...
        1491789850.4333553
        1339032952.9672015
        742998792.0505103
        457412819.78510344
        903238634.5087465

  year() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.year()
        ...
        '2017'
        '2012'
        '1993'
        '1984'
        '1998'

## `faker.providers.internet`

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

  Bases: `Provider`

  ascii_company_email() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.ascii_company_email()
        ...
        'ateixeira@da.br'
        'tviana@fogaca.net'
        'alexiacarvalho@pinto.com'
        'gael-henrique15@novais.com'
        'luara59@novaes.org'

  ascii_email() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.ascii_email()
        ...
        'qaparecida@bol.com.br'
        'tviana@uol.com.br'
        'mirellacarvalho@yahoo.com.br'
        'pintotheodoro@das.com'
        'gnovais@yahoo.com.br'

  ascii_free_email() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.ascii_free_email()
        ...
        'ateixeira@gmail.com'
        'nina76@yahoo.com.br'
        'lfogaca@hotmail.com'
        'alexiacarvalho@gmail.com'
        'sophia92@yahoo.com.br'

  ascii_safe_email() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.ascii_safe_email()
        ...
        'ateixeira@example.org'
        'nina76@example.com'
        'lfogaca@example.org'
        'alexiacarvalho@example.org'
        'sophia92@example.com'

  company_email() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.company_email()
        ...
        'ateixeira@da.br'
        'tviana@fogaca.net'
        'alexiacarvalho@pinto.com'
        'gael-henrique15@novais.com'
        'luara59@novaes.org'

  dga(year: int | None = None, month: int | None = None, day: int | None = None, tld: str | None = None, length: int | None = 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()
        ...
        'teixeira.br'
        'da.br'
        'viana.org'
        'fogaca.net'
        'da.org'

  domain_word() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.domain_word()
        ...
        'teixeira'
        'aparecida'
        'moraes'
        'guerra'
        'mendes'

  email(safe: bool = True, domain: str | None = None) → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.email()
        ...
        'ateixeira@example.org'
        'nina76@example.com'
        'lfogaca@example.org'
        'alexiacarvalho@example.org'
        'sophia92@example.com'

  free_email() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.free_email()
        ...
        'ateixeira@gmail.com'
        'nina76@yahoo.com.br'
        'lfogaca@hotmail.com'
        'alexiacarvalho@gmail.com'
        'sophia92@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.da.br'
        'laptop-47.pacheco.net'
        'lt-24.sa.org'
        'lt-92.brito.com'
        'web-57.fogaca.br'

  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'

  http_status_code(include_unassigned: bool = True) → int

    Returns random HTTP status code https://www.rfc-editor.org/rfc/rfc9110#name-status-codes :param include_unassigned: Whether to include status codes which have

    > not yet been assigned or are unused

    Returns:

      a random three digit status code

    Return type:

      int

    Example:

      404

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.http_status_code()
        ...
        532
        297
        488
        555
        315

  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: int | None = None, height: int | None = None, placeholder_url: str | None = 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://dummyimage.com/530x995'
        'https://dummyimage.com/621x976'
        'https://dummyimage.com/447x285'
        'https://placekitten.com/286/194'

  ipv4(network: bool = False, address_class: str | None = None, private: str | None = 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: str | None = 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: str | None = 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(multicast: bool = False) → str

    Returns a random MAC address.

    Parameters:

      multicast – Multicast address

    Returns:

      MAC Address

    Examples:

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

  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()
        ...
        'ateixeira@example.org'
        'nina76@example.com'
        'lfogaca@example.org'
        'alexiacarvalho@example.org'
        'sophia92@example.com'

  slug(value: str | None = None) → str

    Django algorithm

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.slug()
        ...
        'three-image-son'
        'kitchen-amount'
        'much-mention'
        'why-step-themselves'
        'me-help-past-wait'

  tld() → str
    Examples:

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

  uri(schemes: List[str] | None = None, deep: int | None = None) → str
    Parameters:

      - schemes – a list of strings to use as schemes, one will chosen randomly. If None, it will generate http and https uris. Passing an empty list will result in schemeless uri generation like “://domain.com/index.html”.

      - deep – an integer specifying how many path components the URI should have..

    Returns:

      a random url string.

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.uri()
        ...
        'https://viana.org/categorylogin.jsp'
        'https://nascimento.com/list/wp-content/mainsearch.html'
        'https://www.lopes.br/app/list/searchlogin.html'
        'http://borges.br/list/searchprivacy.asp'
        'http://nunes.com/wp-content/searchauthor.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: int | None = None) → str
    Examples:

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

  url(schemes: List[str] | None = 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://da.br/'
        'https://fogaca.net/'
        'http://sa.org/'
        'http://siqueira.br/'
        'https://www.lopes.br/'

  user_name() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.user_name()
        ...
        'ateixeira'
        'da-luznina'
        'yguerra'
        'maria-liz59'
        'mirellacarvalho'

## `faker.providers.job`

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

  Bases: `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'

  job_female() → str
    Examples:

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

  job_male() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.job_male()
        ...
        '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: `Provider`

  first_name() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.first_name()
        ...
        'Helena'
        'Laura'
        'Bruno'
        'Valentim'
        'Nina'

  first_name_female() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.first_name_female()
        ...
        'Maria Isis'
        'Mariah'
        'Ana Cecília'
        'Joana'
        'Sophia'

  first_name_male() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.first_name_male()
        ...
        'Matheus'
        'Otto'
        'Asafe'
        'José Pedro'
        'Thomas'

  first_name_nonbinary() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.first_name_nonbinary()
        ...
        'Helena'
        'Laura'
        'Bruno'
        'Valentim'
        'Nina'

  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()
        ...
        'Gomes'
        'Teixeira'
        'Leão'
        'Aparecida'
        'da Luz'

  last_name_female() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.last_name_female()
        ...
        'Gomes'
        'Teixeira'
        'Leão'
        'Aparecida'
        'da Luz'

  last_name_male() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.last_name_male()
        ...
        'Gomes'
        'Teixeira'
        'Leão'
        'Aparecida'
        'da Luz'

  last_name_nonbinary() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.last_name_nonbinary()
        ...
        'Gomes'
        'Teixeira'
        'Leão'
        'Aparecida'
        'da Luz'

  name() → str
    Example:

      ‘John Doe’

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.name()
        ...
        'Mariah Aparecida'
        'Thomas Mendonça'
        'Liz Mendes'
        'Sr. Thiago Carvalho'
        'Davi Miguel Sá'

  name_female() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.name_female()
        ...
        'Mariah Aparecida'
        'Sophia Mendonça'
        'Liz Mendes'
        'Helena Montenegro'
        'Larissa Carvalho'

  name_male() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.name_male()
        ...
        'Otto Aparecida'
        'Thomas Mendonça'
        'Kevin Mendes'
        'Henrique Montenegro'
        'João Miguel Carvalho'

  name_nonbinary() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.name_nonbinary()
        ...
        'Mariah Aparecida'
        'Thomas Mendonça'
        'Liz Mendes'
        'Sr. Thiago Carvalho'
        'Davi Miguel Sá'

  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: `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: `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'