{   'faker.providers.address.en_US': {   'address': {   'docs': '\n'
                                                                '        :example: '
                                                                "'791 Crist Parks, "
                                                                'Sashabury, IL '
                                                                "86039-9874'\n"
                                                                '        ',
                                                        'example': '154 Lloyd Route '
                                                                   'Apt. 182\n'
                                                                   'Johnsonport, ME '
                                                                   '80075',
                                                        'type': 'str'},
                                         'administrative_unit': {   'docs': None,
                                                                    'example': 'Massachusetts',
                                                                    'type': 'str'},
                                         'building_number': {   'docs': '\n'
                                                                        '        '
                                                                        ':example: '
                                                                        "'791'\n"
                                                                        '        ',
                                                                'example': '0025',
                                                                'type': 'str'},
                                         'city': {   'docs': '\n'
                                                             '        :example: '
                                                             "'Sashabury'\n"
                                                             '        ',
                                                     'example': 'Nicholastown',
                                                     'type': 'str'},
                                         'city_prefix': {   'docs': None,
                                                            'example': 'North',
                                                            'type': 'str'},
                                         'city_suffix': {   'docs': '\n'
                                                                    '        '
                                                                    ':example: '
                                                                    "'town'\n"
                                                                    '        ',
                                                            'example': 'stad',
                                                            'type': 'str'},
                                         'country': {   'docs': '\n'
                                                                '        :sample:\n'
                                                                '        ',
                                                        'example': 'Serbia',
                                                        'type': 'str'},
                                         'country_code': {   'docs': '\n'
                                                                     '        '
                                                                     ':sample:\n'
                                                                     '        '
                                                                     ':sample: '
                                                                     "representation='alpha-2'\n"
                                                                     '        '
                                                                     ':sample: '
                                                                     "representation='alpha-3'\n"
                                                                     '        ',
                                                             'example': 'GA',
                                                             'type': 'str'},
                                         'current_country': {   'docs': '\n'
                                                                        '        '
                                                                        ':sample:\n'
                                                                        '        ',
                                                                'example': 'United '
                                                                           'States',
                                                                'type': 'str'},
                                         'current_country_code': {   'docs': '\n'
                                                                             '        '
                                                                             ':sample:\n'
                                                                             '        ',
                                                                     'example': 'US',
                                                                     'type': 'str'},
                                         'military_apo': {   'docs': '\n'
                                                                     '        '
                                                                     ':example: '
                                                                     "'PSC 5394 Box "
                                                                     '3492\n'
                                                                     '        ',
                                                             'example': 'PSC 6177, '
                                                                        'Box 1309',
                                                             'type': 'str'},
                                         'military_dpo': {   'docs': '\n'
                                                                     '        '
                                                                     ':example: '
                                                                     "'Unit 3333 "
                                                                     "Box 9342'\n"
                                                                     '        ',
                                                             'example': 'Unit 0959 '
                                                                        'Box 6070',
                                                             'type': 'str'},
                                         'military_ship': {   'docs': '\n'
                                                                      '        '
                                                                      ':example: '
                                                                      "'USS'\n"
                                                                      '        ',
                                                              'example': 'USNV',
                                                              'type': 'str'},
                                         'military_state': {   'docs': '\n'
                                                                       '        '
                                                                       ':example: '
                                                                       "'APO'\n"
                                                                       '        ',
                                                               'example': 'AP',
                                                               'type': 'str'},
                                         'postalcode': {   'docs': None,
                                                           'example': '35635',
                                                           'type': 'str'},
                                         'postalcode_in_state': {   'docs': None,
                                                                    'example': '08752',
                                                                    'type': 'str'},
                                         'postalcode_plus4': {   'docs': None,
                                                                 'example': '39940-6239',
                                                                 'type': 'str'},
                                         'postcode': {   'docs': None,
                                                         'example': '22140',
                                                         'type': 'str'},
                                         'postcode_in_state': {   'docs': '\n'
                                                                          '        '
                                                                          ':returns: '
                                                                          'A random '
                                                                          'postcode '
                                                                          'within '
                                                                          'the '
                                                                          'provided '
                                                                          'state '
                                                                          'abbreviation\n'
                                                                          '\n'
                                                                          '        '
                                                                          ':param '
                                                                          'state_abbr: '
                                                                          'A state '
                                                                          'abbreviation\n'
                                                                          '        ',
                                                                  'example': '02438',
                                                                  'type': 'str'},
                                         'secondary_address': {   'docs': None,
                                                                  'example': 'Apt. '
                                                                             '892',
                                                                  'type': 'str'},
                                         'state': {   'docs': None,
                                                      'example': 'Minnesota',
                                                      'type': 'str'},
                                         'state_abbr': {   'docs': '\n'
                                                                   '        '
                                                                   ':returns: A '
                                                                   'random '
                                                                   'two-letter USPS '
                                                                   'postal code\n'
                                                                   '\n'
                                                                   '        By '
                                                                   'default, the '
                                                                   'resulting code '
                                                                   'may abbreviate '
                                                                   'any of the '
                                                                   'fifty states,\n'
                                                                   '        five US '
                                                                   'territories, or '
                                                                   'three '
                                                                   'freely-associating '
                                                                   'sovereign '
                                                                   'states.\n'
                                                                   '\n'
                                                                   '        :param '
                                                                   'include_territories: '
                                                                   'If True, '
                                                                   'territories '
                                                                   'will be '
                                                                   'included.\n'
                                                                   '            If '
                                                                   'False, US '
                                                                   'territories '
                                                                   'will be '
                                                                   'excluded.\n'
                                                                   '        :param '
                                                                   'include_freely_associated_states: '
                                                                   'If True, '
                                                                   'freely-associated '
                                                                   'states will be '
                                                                   'included.\n'
                                                                   '            If '
                                                                   'False, '
                                                                   'sovereign '
                                                                   'states in free '
                                                                   'association '
                                                                   'with the US '
                                                                   'will be '
                                                                   'excluded.\n'
                                                                   '        ',
                                                           'example': 'CT',
                                                           'type': 'str'},
                                         'street_address': {   'docs': '\n'
                                                                       '        '
                                                                       ':example: '
                                                                       "'791 Crist "
                                                                       "Parks'\n"
                                                                       '        ',
                                                               'example': '1854 '
                                                                          'Thomas '
                                                                          'Dale',
                                                               'type': 'str'},
                                         'street_name': {   'docs': '\n'
                                                                    '        '
                                                                    ':example: '
                                                                    "'Crist Parks'\n"
                                                                    '        ',
                                                            'example': 'Welch Parks',
                                                            'type': 'str'},
                                         'street_suffix': {   'docs': '\n'
                                                                      '        '
                                                                      ':example: '
                                                                      "'Avenue'\n"
                                                                      '        ',
                                                              'example': 'Loaf',
                                                              'type': 'str'},
                                         'zipcode': {   'docs': None,
                                                        'example': '73127',
                                                        'type': 'str'},
                                         'zipcode_in_state': {   'docs': None,
                                                                 'example': '02711',
                                                                 'type': 'str'},
                                         'zipcode_plus4': {   'docs': None,
                                                              'example': '56266-3788',
                                                              'type': 'str'}},
    'faker.providers.automotive.en_US': {   'license_plate': {   'docs': 'Generate '
                                                                         'a license '
                                                                         'plate.',
                                                                 'example': '1MO0055',
                                                                 'type': 'str'},
                                            'vin': {   'docs': 'Generate vin '
                                                               'number.',
                                                       'example': 'RTU3D7WM6DM9Z4772',
                                                       'type': 'str'}},
    'faker.providers.bank.en_GB': {   'aba': {   'docs': 'Generate an ABA routing '
                                                         'transit number.',
                                                 'example': '077636520',
                                                 'type': 'str'},
                                      'bank_country': {   'docs': 'Generate the '
                                                                  "bank provider's "
                                                                  'ISO 3166-1 '
                                                                  'alpha-2 country '
                                                                  'code.',
                                                          'example': 'GB',
                                                          'type': 'str'},
                                      'bban': {   'docs': 'Generate a Basic Bank '
                                                          'Account Number (BBAN).',
                                                  'example': 'HLPS20840932298647',
                                                  'type': 'str'},
                                      'iban': {   'docs': 'Generate an '
                                                          'International Bank '
                                                          'Account Number (IBAN).',
                                                  'example': 'GB60YWXV72565842665294',
                                                  'type': 'str'},
                                      'swift': {   'docs': 'Generate a SWIFT code.\n'
                                                           '\n'
                                                           '        SWIFT codes, '
                                                           'reading from left to '
                                                           'right, are composed of '
                                                           'a 4 alphabet\n'
                                                           '        character bank '
                                                           'code, a 2 alphabet '
                                                           'character country code, '
                                                           'a 2\n'
                                                           '        alphanumeric '
                                                           'location code, and an '
                                                           'optional 3 alphanumeric '
                                                           'branch code.\n'
                                                           '        This means '
                                                           'SWIFT codes can only '
                                                           'have 8 or 11 '
                                                           'characters, so the '
                                                           'value of\n'
                                                           '        ``length`` can '
                                                           'only be ``None`` or the '
                                                           'integers ``8`` or '
                                                           '``11``. If the\n'
                                                           '        value is '
                                                           '``None``, then a value '
                                                           'of ``8`` or ``11`` will '
                                                           'randomly be\n'
                                                           '        assigned.\n'
                                                           '\n'
                                                           '        Because all '
                                                           '8-digit SWIFT codes '
                                                           'already refer to the '
                                                           'primary branch or\n'
                                                           '        office, the '
                                                           '``primary`` argument '
                                                           'only has an effect if '
                                                           'the value of\n'
                                                           '        ``length`` is '
                                                           '``11``. If ``primary`` '
                                                           'is ``True`` and '
                                                           '``length`` is\n'
                                                           '        ``11``, the '
                                                           '11-digit SWIFT codes '
                                                           'generated will always '
                                                           "end in ``'XXX'``\n"
                                                           '        to denote that '
                                                           'they belong to primary '
                                                           'branches/offices.\n'
                                                           '\n'
                                                           '        For extra '
                                                           'authenticity, localized '
                                                           'providers may opt to '
                                                           'include SWIFT\n'
                                                           '        bank codes, '
                                                           'location codes, and '
                                                           'branch codes used in '
                                                           'their respective\n'
                                                           '        locales. If '
                                                           '``use_dataset`` is '
                                                           '``True``, this method '
                                                           'will generate SWIFT\n'
                                                           '        codes based on '
                                                           'those locale-specific '
                                                           'codes if included. If '
                                                           'those codes\n'
                                                           '        were not '
                                                           'included, then it will '
                                                           'behave as if '
                                                           '``use_dataset`` were\n'
                                                           '        ``False``, and '
                                                           'in that mode, all those '
                                                           'codes will just be '
                                                           'randomly\n'
                                                           '        generated as '
                                                           'per the specification.\n'
                                                           '\n'
                                                           '        :sample:\n'
                                                           '        :sample: '
                                                           'length=8\n'
                                                           '        :sample: '
                                                           'length=8, '
                                                           'use_dataset=True\n'
                                                           '        :sample: '
                                                           'length=11\n'
                                                           '        :sample: '
                                                           'length=11, '
                                                           'primary=True\n'
                                                           '        :sample: '
                                                           'length=11, '
                                                           'use_dataset=True\n'
                                                           '        :sample: '
                                                           'length=11, '
                                                           'primary=True, '
                                                           'use_dataset=True\n'
                                                           '        ',
                                                   'example': 'VASUGBFCAGO',
                                                   'type': 'str'},
                                      'swift11': {   'docs': 'Generate an 11-digit '
                                                             'SWIFT code.\n'
                                                             '\n'
                                                             '        This method '
                                                             'uses |swift| under '
                                                             'the hood with the '
                                                             '``length`` argument '
                                                             'set\n'
                                                             '        to ``11``. If '
                                                             '``primary`` is set to '
                                                             '``True``, the SWIFT '
                                                             'code will always\n'
                                                             '        end with '
                                                             "``'XXX'``. All "
                                                             '11-digit SWIFT codes '
                                                             'use this convention '
                                                             'to\n'
                                                             '        refer to the '
                                                             'primary '
                                                             'branch/office.\n'
                                                             '\n'
                                                             '        :sample:\n'
                                                             '        :sample: '
                                                             'use_dataset=True\n'
                                                             '        ',
                                                     'example': 'PKMYGB1PMGR',
                                                     'type': 'str'},
                                      'swift8': {   'docs': 'Generate an 8-digit '
                                                            'SWIFT code.\n'
                                                            '\n'
                                                            '        This method '
                                                            'uses |swift| under the '
                                                            'hood with the '
                                                            '``length`` argument '
                                                            'set\n'
                                                            '        to ``8`` and '
                                                            'with the ``primary`` '
                                                            'argument omitted. All '
                                                            '8-digit SWIFT\n'
                                                            '        codes already '
                                                            'refer to the primary '
                                                            'branch/office.\n'
                                                            '\n'
                                                            '        :sample:\n'
                                                            '        :sample: '
                                                            'use_dataset=True\n'
                                                            '        ',
                                                    'example': 'GJLZGB3C',
                                                    'type': 'str'}},
    'faker.providers.barcode.en_US': {   'ean': {   'docs': 'Generate an EAN '
                                                            'barcode of the '
                                                            'specified ``length``.\n'
                                                            '\n'
                                                            '        The value of '
                                                            '``length`` can only be '
                                                            '``8`` or ``13`` '
                                                            '(default) which will\n'
                                                            '        create an '
                                                            'EAN-8 or an EAN-13 '
                                                            'barcode respectively.\n'
                                                            '\n'
                                                            '        If a value for '
                                                            '``prefixes`` is '
                                                            'specified, the result '
                                                            'will begin with one\n'
                                                            '        of the '
                                                            'sequences in '
                                                            '``prefixes``.\n'
                                                            '\n'
                                                            '        :sample: '
                                                            'length=13\n'
                                                            '        :sample: '
                                                            'length=8\n'
                                                            '        :sample: '
                                                            "prefixes=('00',)\n"
                                                            '        :sample: '
                                                            "prefixes=('45', '49')\n"
                                                            '        ',
                                                    'example': '9325699444289',
                                                    'type': 'str'},
                                         'ean13': {   'docs': 'Generate an EAN-13 '
                                                              'barcode.\n'
                                                              '\n'
                                                              '        If '
                                                              '``leading_zero`` is '
                                                              '``True``, the '
                                                              'leftmost digit of '
                                                              'the barcode will\n'
                                                              '        be set to '
                                                              '``0``. If ``False``, '
                                                              'the leftmost digit '
                                                              'cannot be ``0``. If\n'
                                                              '        ``None`` '
                                                              '(default), the '
                                                              'leftmost digit can '
                                                              'be any digit.\n'
                                                              '\n'
                                                              '        If a value '
                                                              'for ``prefixes`` is '
                                                              'specified, the '
                                                              'result will begin '
                                                              'with one\n'
                                                              '        of the '
                                                              'sequences in '
                                                              '``prefixes`` and '
                                                              'will ignore '
                                                              '``leading_zero``.\n'
                                                              '\n'
                                                              '        This method '
                                                              'uses the standard '
                                                              "barcode provider's "
                                                              '|ean13| under the\n'
                                                              '        hood with '
                                                              'the ``prefixes`` '
                                                              'argument set to the '
                                                              'correct value to '
                                                              'attain\n'
                                                              '        the behavior '
                                                              'described above.\n'
                                                              '\n'
                                                              '        .. note::\n'
                                                              '           EAN-13 '
                                                              'barcode that starts '
                                                              'with a zero can be '
                                                              'converted to UPC-A\n'
                                                              '           by '
                                                              'dropping the leading '
                                                              'zero. This may cause '
                                                              'problems with '
                                                              'readers\n'
                                                              '           that '
                                                              'treat all of these '
                                                              'code as UPC-A codes '
                                                              'and drop the first '
                                                              'digit\n'
                                                              '           when '
                                                              'reading it.\n'
                                                              '\n'
                                                              '           You can '
                                                              'set the argument '
                                                              '``prefixes`` ( or '
                                                              '``leading_zero`` '
                                                              'for\n'
                                                              '           '
                                                              'convenience) '
                                                              'explicitly to avoid '
                                                              'or to force the '
                                                              'generated barcode '
                                                              'to\n'
                                                              '           start '
                                                              'with a zero. You can '
                                                              'also generate actual '
                                                              'UPC-A barcode with\n'
                                                              '           '
                                                              '|EnUsBarcodeProvider.upc_a|.\n'
                                                              '\n'
                                                              '        :sample:\n'
                                                              '        :sample: '
                                                              'leading_zero=False\n'
                                                              '        :sample: '
                                                              'leading_zero=True\n'
                                                              '        :sample: '
                                                              "prefixes=('00',)\n"
                                                              '        :sample: '
                                                              "prefixes=('45', "
                                                              "'49')\n"
                                                              '        ',
                                                      'example': '1822709220621',
                                                      'type': 'str'},
                                         'ean8': {   'docs': 'Generate an EAN-8 '
                                                             'barcode.\n'
                                                             '\n'
                                                             '        This method '
                                                             'uses |ean| under the '
                                                             'hood with the '
                                                             '``length`` argument\n'
                                                             '        explicitly '
                                                             'set to ``8``.\n'
                                                             '\n'
                                                             '        If a value '
                                                             'for ``prefixes`` is '
                                                             'specified, the result '
                                                             'will begin with one\n'
                                                             '        of the '
                                                             'sequences in '
                                                             '``prefixes``.\n'
                                                             '\n'
                                                             '        :sample:\n'
                                                             '        :sample: '
                                                             "prefixes=('00',)\n"
                                                             '        :sample: '
                                                             "prefixes=('45', "
                                                             "'49')\n"
                                                             '        ',
                                                     'example': '00259866',
                                                     'type': 'str'},
                                         'localized_ean': {   'docs': 'Generate a '
                                                                      'localized '
                                                                      'EAN barcode '
                                                                      'of the '
                                                                      'specified '
                                                                      '``length``.\n'
                                                                      '\n'
                                                                      '        The '
                                                                      'value of '
                                                                      '``length`` '
                                                                      'can only be '
                                                                      '``8`` or '
                                                                      '``13`` '
                                                                      '(default) '
                                                                      'which will\n'
                                                                      '        '
                                                                      'create an '
                                                                      'EAN-8 or an '
                                                                      'EAN-13 '
                                                                      'barcode '
                                                                      'respectively.\n'
                                                                      '\n'
                                                                      '        This '
                                                                      'method uses '
                                                                      'the standard '
                                                                      'barcode '
                                                                      "provider's "
                                                                      '|ean| under '
                                                                      'the hood\n'
                                                                      '        with '
                                                                      'the '
                                                                      '``prefixes`` '
                                                                      'argument '
                                                                      'explicitly '
                                                                      'set to '
                                                                      '``local_prefixes`` '
                                                                      'of\n'
                                                                      '        a '
                                                                      'localized '
                                                                      'barcode '
                                                                      'provider '
                                                                      'implementation.\n'
                                                                      '\n'
                                                                      '        '
                                                                      ':sample:\n'
                                                                      '        '
                                                                      ':sample: '
                                                                      'length=13\n'
                                                                      '        '
                                                                      ':sample: '
                                                                      'length=8\n'
                                                                      '        ',
                                                              'example': '0292254297842',
                                                              'type': 'str'},
                                         'localized_ean13': {   'docs': 'Generate a '
                                                                        'localized '
                                                                        'EAN-13 '
                                                                        'barcode.\n'
                                                                        '\n'
                                                                        '        '
                                                                        'This '
                                                                        'method '
                                                                        'uses '
                                                                        '|localized_ean| '
                                                                        'under the '
                                                                        'hood with '
                                                                        'the '
                                                                        '``length``\n'
                                                                        '        '
                                                                        'argument '
                                                                        'explicitly '
                                                                        'set to '
                                                                        '``13``.\n'
                                                                        '        ',
                                                                'example': '1189390764125',
                                                                'type': 'str'},
                                         'localized_ean8': {   'docs': 'Generate a '
                                                                       'localized '
                                                                       'EAN-8 '
                                                                       'barcode.\n'
                                                                       '\n'
                                                                       '        '
                                                                       'This method '
                                                                       'uses '
                                                                       '|localized_ean| '
                                                                       'under the '
                                                                       'hood with '
                                                                       'the '
                                                                       '``length``\n'
                                                                       '        '
                                                                       'argument '
                                                                       'explicitly '
                                                                       'set to '
                                                                       '``8``.\n'
                                                                       '        ',
                                                               'example': '03484050',
                                                               'type': 'str'},
                                         'upc_a': {   'docs': 'Generate a 12-digit '
                                                              'UPC-A barcode.\n'
                                                              '\n'
                                                              '        The value of '
                                                              '``upc_ae_mode`` '
                                                              'controls how '
                                                              'barcodes will be '
                                                              'generated. If\n'
                                                              '        ``False`` '
                                                              '(default), barcodes '
                                                              'are not guaranteed '
                                                              'to have a UPC-E\n'
                                                              '        equivalent. '
                                                              'In this mode, the '
                                                              'method uses '
                                                              '|EnUsBarcodeProvider.ean13|\n'
                                                              '        under the '
                                                              'hood, and the values '
                                                              'of ``base`` and '
                                                              '``number_system_digit``\n'
                                                              '        will be '
                                                              'ignored.\n'
                                                              '\n'
                                                              '        If '
                                                              '``upc_ae_mode`` is '
                                                              '``True``, the '
                                                              'resulting barcodes '
                                                              'are guaranteed to\n'
                                                              '        have a UPC-E '
                                                              'equivalent, and the '
                                                              'values of ``base`` '
                                                              'and\n'
                                                              '        '
                                                              '``number_system_digit`` '
                                                              'will be used to '
                                                              'control what is '
                                                              'generated.\n'
                                                              '\n'
                                                              '        Under this '
                                                              'mode, ``base`` is '
                                                              'expected to have a '
                                                              '6-digit string '
                                                              'value. If\n'
                                                              '        any other '
                                                              'value is supplied, a '
                                                              'random 6-digit '
                                                              'string will be used\n'
                                                              '        instead. As '
                                                              'for '
                                                              '``number_system_digit``, '
                                                              'the expected value '
                                                              'is a ``0``\n'
                                                              '        or a ``1``. '
                                                              'If any other value '
                                                              'is provided, this '
                                                              'method will '
                                                              'randomly\n'
                                                              '        choose from '
                                                              'the two.\n'
                                                              '\n'
                                                              '        .. '
                                                              'important::\n'
                                                              '           When '
                                                              '``upc_ae_mode`` is '
                                                              'enabled, you might '
                                                              'encounter instances '
                                                              'where\n'
                                                              '           different '
                                                              'values of ``base`` '
                                                              "(e.g. ``'120003'`` "
                                                              "and ``'120004'``)\n"
                                                              '           produce '
                                                              'the same UPC-A '
                                                              'barcode. This is '
                                                              'normal, and the '
                                                              'reason lies\n'
                                                              '           within '
                                                              'the whole conversion '
                                                              'process. To learn '
                                                              'more about this and\n'
                                                              '           what '
                                                              '``base`` and '
                                                              '``number_system_digit`` '
                                                              'actually represent, '
                                                              'please\n'
                                                              '           refer to '
                                                              '|EnUsBarcodeProvider.upc_e|.\n'
                                                              '\n'
                                                              '        :sample:\n'
                                                              '        :sample: '
                                                              'upc_ae_mode=True, '
                                                              'number_system_digit=0\n'
                                                              '        :sample: '
                                                              'upc_ae_mode=True, '
                                                              'number_system_digit=1\n'
                                                              '        :sample: '
                                                              'upc_ae_mode=True, '
                                                              "base='123456', "
                                                              'number_system_digit=0\n'
                                                              '        :sample: '
                                                              'upc_ae_mode=True, '
                                                              "base='120003', "
                                                              'number_system_digit=0\n'
                                                              '        :sample: '
                                                              'upc_ae_mode=True, '
                                                              "base='120004', "
                                                              'number_system_digit=0\n'
                                                              '        ',
                                                      'example': '193018542379',
                                                      'type': 'str'},
                                         'upc_e': {   'docs': 'Generate an 8-digit '
                                                              'UPC-E barcode.\n'
                                                              '\n'
                                                              '        UPC-E '
                                                              'barcodes can be '
                                                              'expressed in 6, 7, '
                                                              'or 8-digit formats, '
                                                              'but this\n'
                                                              '        method uses '
                                                              'the 8 digit format, '
                                                              'since it is trivial '
                                                              'to convert to the\n'
                                                              '        other two '
                                                              'formats. The first '
                                                              'digit (starting from '
                                                              'the left) is\n'
                                                              '        controlled '
                                                              'by '
                                                              '``number_system_digit``, '
                                                              'and it can only be a '
                                                              '``0`` or a\n'
                                                              '        ``1``. The '
                                                              'last digit is the '
                                                              'check digit that is '
                                                              'inherited from the\n'
                                                              '        UPC-E '
                                                              "barcode's UPC-A "
                                                              'equivalent. The '
                                                              'middle six digits '
                                                              'are collectively\n'
                                                              '        referred to '
                                                              'as the ``base`` (for '
                                                              'a lack of a better '
                                                              'term).\n'
                                                              '\n'
                                                              '        On that '
                                                              'note, this method '
                                                              'uses ``base`` and '
                                                              '``number_system_digit`` '
                                                              'to\n'
                                                              '        first '
                                                              'generate a UPC-A '
                                                              'barcode for the '
                                                              'check digit, and '
                                                              'what happens\n'
                                                              '        next depends '
                                                              'on the value of '
                                                              '``safe_mode``. The '
                                                              'argument '
                                                              '``safe_mode``\n'
                                                              '        exists, '
                                                              'because there are '
                                                              'some UPC-E values '
                                                              'that share the same '
                                                              'UPC-A\n'
                                                              '        equivalent. '
                                                              'For example, any '
                                                              'UPC-E barcode of the '
                                                              'form ``abc0000d``,\n'
                                                              '        '
                                                              '``abc0003d``, and '
                                                              '``abc0004d`` share '
                                                              'the same UPC-A '
                                                              'value\n'
                                                              '        '
                                                              '``abc00000000d``, '
                                                              'but that UPC-A value '
                                                              'will only convert to '
                                                              '``abc0000d``\n'
                                                              '        because of '
                                                              '(a) how UPC-E is '
                                                              'just a '
                                                              'zero-suppressed '
                                                              'version of UPC-A '
                                                              'and\n'
                                                              '        (b) the '
                                                              'rules around the '
                                                              'conversion.\n'
                                                              '\n'
                                                              '        If '
                                                              '``safe_mode`` is '
                                                              '``True`` (default), '
                                                              'this method performs '
                                                              'another set\n'
                                                              '        of '
                                                              'conversions to '
                                                              'guarantee that the '
                                                              'UPC-E barcodes '
                                                              'generated can be\n'
                                                              '        converted to '
                                                              'UPC-A, and that '
                                                              'UPC-A barcode can be '
                                                              'converted back to '
                                                              'the\n'
                                                              '        original '
                                                              'UPC-E barcode. Using '
                                                              'the example above, '
                                                              'even if the bases\n'
                                                              '        ``120003`` '
                                                              'or ``120004`` are '
                                                              'used, the resulting '
                                                              'UPC-E barcode will\n'
                                                              '        always use '
                                                              'the base '
                                                              '``120000``.\n'
                                                              '\n'
                                                              '        If '
                                                              '``safe_mode`` is '
                                                              '``False``, then the '
                                                              '``number_system_digit``,\n'
                                                              '        ``base``, '
                                                              'and the computed '
                                                              'check digit will '
                                                              'just be '
                                                              'concatenated\n'
                                                              '        together to '
                                                              'produce the UPC-E '
                                                              'barcode, and '
                                                              'attempting to '
                                                              'convert the\n'
                                                              '        barcode to '
                                                              'UPC-A and back again '
                                                              'to UPC-E will '
                                                              'exhibit the '
                                                              'behavior\n'
                                                              '        described '
                                                              'above.\n'
                                                              '\n'
                                                              '        :sample:\n'
                                                              '        :sample: '
                                                              "base='123456'\n"
                                                              '        :sample: '
                                                              "base='123456', "
                                                              'number_system_digit=0\n'
                                                              '        :sample: '
                                                              "base='123456', "
                                                              'number_system_digit=1\n'
                                                              '        :sample: '
                                                              "base='120000', "
                                                              'number_system_digit=0\n'
                                                              '        :sample: '
                                                              "base='120003', "
                                                              'number_system_digit=0\n'
                                                              '        :sample: '
                                                              "base='120004', "
                                                              'number_system_digit=0\n'
                                                              '        :sample: '
                                                              "base='120000', "
                                                              'number_system_digit=0, '
                                                              'safe_mode=False\n'
                                                              '        :sample: '
                                                              "base='120003', "
                                                              'number_system_digit=0, '
                                                              'safe_mode=False\n'
                                                              '        :sample: '
                                                              "base='120004', "
                                                              'number_system_digit=0, '
                                                              'safe_mode=False\n'
                                                              '        ',
                                                      'example': '19319104',
                                                      'type': 'str'}},
    'faker.providers.color.en_US': {   'color': {   'docs': 'Generate a color in a '
                                                            'human-friendly way.\n'
                                                            '\n'
                                                            '        Under the '
                                                            'hood, this method '
                                                            'first creates a color '
                                                            'represented in the '
                                                            'HSV\n'
                                                            '        color model '
                                                            'and then converts it '
                                                            'to the desired '
                                                            '``color_format``. The\n'
                                                            '        argument '
                                                            '``hue`` controls the H '
                                                            'value according to the '
                                                            'following\n'
                                                            '        rules:\n'
                                                            '\n'
                                                            '        - If the value '
                                                            'is a number from ``0`` '
                                                            'to ``360``, it will '
                                                            'serve as the H\n'
                                                            '          value of the '
                                                            'generated color.\n'
                                                            '        - If the value '
                                                            'is a tuple/list of 2 '
                                                            'numbers from 0 to 360, '
                                                            "the color's H\n"
                                                            '          value will '
                                                            'be randomly selected '
                                                            'from that range.\n'
                                                            '        - If the value '
                                                            'is a valid string, the '
                                                            "color's H value will "
                                                            'be randomly\n'
                                                            '          selected '
                                                            'from the H range '
                                                            'corresponding to the '
                                                            'supplied string. '
                                                            'Valid\n'
                                                            '          values are '
                                                            "``'monochrome'``, "
                                                            "``'red'``, "
                                                            "``'orange'``, "
                                                            "``'yellow'``,\n"
                                                            "          ``'green'``, "
                                                            "``'blue'``, "
                                                            "``'purple'``, and "
                                                            "``'pink'``.\n"
                                                            '\n'
                                                            '        The argument '
                                                            '``luminosity`` '
                                                            'influences both S and '
                                                            'V values and is\n'
                                                            '        partially '
                                                            'affected by ``hue`` as '
                                                            'well. The finer '
                                                            'details of this\n'
                                                            '        relationship '
                                                            'are somewhat involved, '
                                                            'so please refer to the '
                                                            'source code\n'
                                                            '        instead if you '
                                                            'wish to dig deeper. To '
                                                            'keep the interface '
                                                            'simple, this\n'
                                                            '        argument '
                                                            'either can be omitted '
                                                            'or can accept the '
                                                            'following string\n'
                                                            '        '
                                                            "values:``'bright'``, "
                                                            "``'dark'``, "
                                                            "``'light'``, or "
                                                            "``'random'``.\n"
                                                            '\n'
                                                            '        The argument '
                                                            '``color_format`` '
                                                            'controls in which '
                                                            'color model the color '
                                                            'is\n'
                                                            '        represented. '
                                                            'Valid values are '
                                                            "``'hsv'``, ``'hsl'``, "
                                                            "``'rgb'``, or\n"
                                                            "        ``'hex'`` "
                                                            '(default).\n'
                                                            '\n'
                                                            '        :sample: '
                                                            "hue='red'\n"
                                                            '        :sample: '
                                                            "luminosity='light'\n"
                                                            '        :sample: '
                                                            'hue=(100, 200), '
                                                            "color_format='rgb'\n"
                                                            '        :sample: '
                                                            "hue='orange', "
                                                            "luminosity='bright'\n"
                                                            '        :sample: '
                                                            'hue=135, '
                                                            "luminosity='dark', "
                                                            "color_format='hsv'\n"
                                                            '        :sample: '
                                                            'hue=(300, 20), '
                                                            "luminosity='random', "
                                                            "color_format='hsl'\n"
                                                            '        ',
                                                    'example': '#4bd17e',
                                                    'type': 'str'},
                                       'color_hsl': {   'docs': '\n'
                                                                '        Generate a '
                                                                'HSL color tuple.\n'
                                                                '\n'
                                                                '        :sample:\n'
                                                                '        :sample: '
                                                                "hue='red', "
                                                                "luminosity='dark'\n"
                                                                '        :sample: '
                                                                'hue=(100, 200), '
                                                                "luminosity='random'\n"
                                                                '        ',
                                                        'example': (167, 63, 64),
                                                        'type': 'tuple'},
                                       'color_hsv': {   'docs': '\n'
                                                                '        Generate a '
                                                                'HSV color tuple.\n'
                                                                '\n'
                                                                '        :sample:\n'
                                                                '        :sample: '
                                                                "hue='red', "
                                                                "luminosity='dark'\n"
                                                                '        :sample: '
                                                                'hue=(100, 200), '
                                                                "luminosity='random'\n"
                                                                '        ',
                                                        'example': (63, 94, 61),
                                                        'type': 'tuple'},
                                       'color_name': {   'docs': '\n'
                                                                 '        Generate '
                                                                 'a color name.\n'
                                                                 '\n'
                                                                 '        :sample:\n'
                                                                 '        ',
                                                         'example': 'Silver',
                                                         'type': 'str'},
                                       'color_rgb': {   'docs': '\n'
                                                                '        Generate a '
                                                                'RGB color tuple of '
                                                                'integers.\n'
                                                                '\n'
                                                                '        :sample:\n'
                                                                '        :sample: '
                                                                "hue='red', "
                                                                "luminosity='dark'\n"
                                                                '        :sample: '
                                                                'hue=(100, 200), '
                                                                "luminosity='random'\n"
                                                                '        ',
                                                        'example': (83, 81, 181),
                                                        'type': 'tuple'},
                                       'color_rgb_float': {   'docs': '\n'
                                                                      '        '
                                                                      'Generate a '
                                                                      'RGB color '
                                                                      'tuple of '
                                                                      'floats.\n'
                                                                      '\n'
                                                                      '        '
                                                                      ':sample:\n'
                                                                      '        '
                                                                      ':sample: '
                                                                      "hue='red', "
                                                                      "luminosity='dark'\n"
                                                                      '        '
                                                                      ':sample: '
                                                                      'hue=(100, '
                                                                      '200), '
                                                                      "luminosity='random'\n"
                                                                      '        ',
                                                              'example': (   0.96,
                                                                             0.64176,
                                                                             0.4704),
                                                              'type': 'tuple'},
                                       'hex_color': {   'docs': '\n'
                                                                '        Generate a '
                                                                'color formatted as '
                                                                'a hex triplet.\n'
                                                                '\n'
                                                                '        :sample:\n'
                                                                '        ',
                                                        'example': '#0055eb',
                                                        'type': 'str'},
                                       'rgb_color': {   'docs': '\n'
                                                                '        Generate a '
                                                                'color formatted as '
                                                                'a comma-separated '
                                                                'RGB value.\n'
                                                                '\n'
                                                                '        :sample:\n'
                                                                '        ',
                                                        'example': '160,254,187',
                                                        'type': 'str'},
                                       'rgb_css_color': {   'docs': '\n'
                                                                    '        '
                                                                    'Generate a '
                                                                    'color '
                                                                    'formatted as a '
                                                                    'CSS rgb() '
                                                                    'function.\n'
                                                                    '\n'
                                                                    '        '
                                                                    ':sample:\n'
                                                                    '        ',
                                                            'example': 'rgb(158,153,106)',
                                                            'type': 'str'},
                                       'safe_color_name': {   'docs': '\n'
                                                                      '        '
                                                                      'Generate a '
                                                                      'web-safe '
                                                                      'color name.\n'
                                                                      '\n'
                                                                      '        '
                                                                      ':sample:\n'
                                                                      '        ',
                                                              'example': 'maroon',
                                                              'type': 'str'},
                                       'safe_hex_color': {   'docs': '\n'
                                                                     '        '
                                                                     'Generate a '
                                                                     'web-safe '
                                                                     'color '
                                                                     'formatted as '
                                                                     'a hex '
                                                                     'triplet.\n'
                                                                     '\n'
                                                                     '        '
                                                                     ':sample:\n'
                                                                     '        ',
                                                             'example': '#aa4499',
                                                             'type': 'str'}},
    'faker.providers.company.en_US': {   'bs': {   'docs': '\n'
                                                           '        :example: '
                                                           "'integrate extensible "
                                                           "convergence'\n"
                                                           '        ',
                                                   'example': 'transition '
                                                              'user-centric content',
                                                   'type': 'str'},
                                         'catch_phrase': {   'docs': '\n'
                                                                     '        '
                                                                     ':example: '
                                                                     "'Robust "
                                                                     'full-range '
                                                                     "hub'\n"
                                                                     '        ',
                                                             'example': 'Realigned '
                                                                        'actuating '
                                                                        'extranet',
                                                             'type': 'str'},
                                         'company': {   'docs': '\n'
                                                                '        :example: '
                                                                "'Acme Ltd'\n"
                                                                '        ',
                                                        'example': 'Chambers-Hodge',
                                                        'type': 'str'},
                                         'company_suffix': {   'docs': '\n'
                                                                       '        '
                                                                       ':example: '
                                                                       "'Ltd'\n"
                                                                       '        ',
                                                               'example': 'PLC',
                                                               'type': 'str'}},
    'faker.providers.credit_card.en_US': {   'credit_card_expire': {   'docs': 'Generate '
                                                                               'a '
                                                                               'credit '
                                                                               'card '
                                                                               'expiry '
                                                                               'date.\n'
                                                                               '\n'
                                                                               '        '
                                                                               'This '
                                                                               'method '
                                                                               'uses '
                                                                               '|date_time_between| '
                                                                               'under '
                                                                               'the '
                                                                               'hood '
                                                                               'to '
                                                                               'generate '
                                                                               'the\n'
                                                                               '        '
                                                                               'expiry '
                                                                               'date, '
                                                                               'so '
                                                                               'the '
                                                                               '``start`` '
                                                                               'and '
                                                                               '``end`` '
                                                                               'arguments '
                                                                               'work '
                                                                               'in '
                                                                               'the '
                                                                               'same '
                                                                               'way\n'
                                                                               '        '
                                                                               'here '
                                                                               'as '
                                                                               'it '
                                                                               'would '
                                                                               'in '
                                                                               'that '
                                                                               'method. '
                                                                               'For '
                                                                               'the '
                                                                               'actual '
                                                                               'formatting '
                                                                               'of '
                                                                               'the '
                                                                               'expiry\n'
                                                                               '        '
                                                                               'date, '
                                                                               '|strftime| '
                                                                               'is '
                                                                               'used '
                                                                               'and '
                                                                               '``date_format`` '
                                                                               'is '
                                                                               'simply '
                                                                               'passed\n'
                                                                               '        '
                                                                               'to '
                                                                               'that '
                                                                               'method.\n'
                                                                               '        ',
                                                                       'example': '03/29',
                                                                       'type': 'str'},
                                             'credit_card_full': {   'docs': 'Generate '
                                                                             'a set '
                                                                             'of '
                                                                             'credit '
                                                                             'card '
                                                                             'details.',
                                                                     'example': 'JCB '
                                                                                '16 '
                                                                                'digit\n'
                                                                                'Sabrina '
                                                                                'Kelly\n'
                                                                                '3534324863933175 '
                                                                                '05/30\n'
                                                                                'CVC: '
                                                                                '071\n',
                                                                     'type': 'str'},
                                             'credit_card_number': {   'docs': 'Generate '
                                                                               'a '
                                                                               'valid '
                                                                               'credit '
                                                                               'card '
                                                                               'number.',
                                                                       'example': '4614337746002902',
                                                                       'type': 'str'},
                                             'credit_card_provider': {   'docs': 'Generate '
                                                                                 'a '
                                                                                 'credit '
                                                                                 'card '
                                                                                 'provider '
                                                                                 'name.',
                                                                         'example': 'JCB '
                                                                                    '16 '
                                                                                    'digit',
                                                                         'type': 'str'},
                                             'credit_card_security_code': {   'docs': 'Generate '
                                                                                      'a '
                                                                                      'credit '
                                                                                      'card '
                                                                                      'security '
                                                                                      'code.',
                                                                              'example': '545',
                                                                              'type': 'str'}},
    'faker.providers.currency.en_US': {   'cryptocurrency': {   'docs': None,
                                                                'example': (   'POT',
                                                                               'PotCoin'),
                                                                'type': 'tuple'},
                                          'cryptocurrency_code': {   'docs': None,
                                                                     'example': 'FTH',
                                                                     'type': 'str'},
                                          'cryptocurrency_name': {   'docs': None,
                                                                     'example': 'Omni',
                                                                     'type': 'str'},
                                          'currency': {   'docs': None,
                                                          'example': (   'GIP',
                                                                         'Gibraltar '
                                                                         'pound'),
                                                          'type': 'tuple'},
                                          'currency_code': {   'docs': None,
                                                               'example': 'RWF',
                                                               'type': 'str'},
                                          'currency_name': {   'docs': None,
                                                               'example': 'Burundian '
                                                                          'franc',
                                                               'type': 'str'},
                                          'currency_symbol': {   'docs': '\n'
                                                                         '        '
                                                                         ':example: '
                                                                         '$\n'
                                                                         '        ',
                                                                 'example': 'kr',
                                                                 'type': 'str'},
                                          'pricetag': {   'docs': None,
                                                          'example': '$81,807.72',
                                                          'type': 'str'}},
    'faker.providers.date_time.en_US': {   'am_pm': {   'docs': '\n'
                                                                '        :sample:\n'
                                                                '        ',
                                                        'example': 'PM',
                                                        'type': 'str'},
                                           'century': {   'docs': '\n'
                                                                  '        '
                                                                  ':sample:\n'
                                                                  '        ',
                                                          'example': 'III',
                                                          'type': 'str'},
                                           'date': {   'docs': '\n'
                                                               '        Get a date '
                                                               'string between '
                                                               'January 1, 1970 and '
                                                               'now.\n'
                                                               '\n'
                                                               '        :param '
                                                               'pattern: Format of '
                                                               'the date '
                                                               '(year-month-day by '
                                                               'default)\n'
                                                               '        :param '
                                                               'end_datetime: A '
                                                               '``DateParseType``. '
                                                               'Defaults to the '
                                                               'current date and '
                                                               'time\n'
                                                               '\n'
                                                               '        :sample:\n'
                                                               '        :sample: '
                                                               "pattern='%m/%d/%Y'\n"
                                                               '        :sample: '
                                                               "end_datetime='+1w'\n"
                                                               '        ',
                                                       'example': '2005-01-22',
                                                       'type': 'str'},
                                           'date_between': {   'docs': '\n'
                                                                       '        Get '
                                                                       'a Date '
                                                                       'object '
                                                                       'based on a '
                                                                       'random date '
                                                                       'between two '
                                                                       'given '
                                                                       'dates.\n'
                                                                       '        '
                                                                       'Accepts '
                                                                       'date '
                                                                       'strings '
                                                                       'that can be '
                                                                       'recognized '
                                                                       'by '
                                                                       'strtotime().\n'
                                                                       '\n'
                                                                       '        '
                                                                       ':param '
                                                                       'start_date: '
                                                                       'A '
                                                                       '``DateParseType``. '
                                                                       'Defaults to '
                                                                       '30 years '
                                                                       'ago\n'
                                                                       '        '
                                                                       ':param '
                                                                       'end_date: A '
                                                                       '``DateParseType``. '
                                                                       'Defaults to '
                                                                       '``"today"``\n'
                                                                       '\n'
                                                                       '        '
                                                                       ':sample:\n'
                                                                       '        '
                                                                       ':sample: '
                                                                       "start_date='-1w'\n"
                                                                       '        '
                                                                       ':sample: '
                                                                       'start_date="-1y", '
                                                                       'end_date="+1w"\n'
                                                                       '        ',
                                                               'example': datetime.date(2000, 10, 11),
                                                               'type': 'date'},
                                           'date_between_dates': {   'docs': '\n'
                                                                             '        '
                                                                             'Get a '
                                                                             'random '
                                                                             'date '
                                                                             'between '
                                                                             'the '
                                                                             'two '
                                                                             'given '
                                                                             'dates.\n'
                                                                             '\n'
                                                                             '        '
                                                                             ':param '
                                                                             'date_start: '
                                                                             'A '
                                                                             '``DateParseType``. '
                                                                             'Defaults '
                                                                             'to '
                                                                             'the '
                                                                             'UNIX '
                                                                             'epoch\n'
                                                                             '        '
                                                                             ':param '
                                                                             'date_end: '
                                                                             'A '
                                                                             '``DateParseType``. '
                                                                             'Defaults '
                                                                             'to '
                                                                             'the '
                                                                             'current '
                                                                             'date '
                                                                             'and '
                                                                             'time\n'
                                                                             '\n'
                                                                             '        '
                                                                             ':sample:\n'
                                                                             '        ',
                                                                     'example': datetime.date(2025, 9, 19),
                                                                     'type': 'date'},
                                           'date_object': {   'docs': '\n'
                                                                      '        Get '
                                                                      'a date '
                                                                      'object '
                                                                      'between '
                                                                      'January 1, '
                                                                      '1970 and '
                                                                      'now\n'
                                                                      '\n'
                                                                      '        '
                                                                      ':param '
                                                                      'end_datetime: '
                                                                      'A '
                                                                      '``DateParseType``. '
                                                                      'Defaults to '
                                                                      'the current '
                                                                      'date and '
                                                                      'time\n'
                                                                      '\n'
                                                                      '        '
                                                                      ':sample:\n'
                                                                      '        '
                                                                      ':sample: '
                                                                      "end_datetime='+1w'\n"
                                                                      '        ',
                                                              'example': datetime.date(1989, 12, 2),
                                                              'type': 'date'},
                                           'date_of_birth': {   'docs': '\n'
                                                                        '        '
                                                                        'Generate a '
                                                                        'random '
                                                                        'date of '
                                                                        'birth '
                                                                        'represented '
                                                                        'as a Date '
                                                                        'object,\n'
                                                                        '        '
                                                                        'constrained '
                                                                        'by '
                                                                        'optional '
                                                                        'miminimum_age '
                                                                        'and '
                                                                        'maximum_age\n'
                                                                        '        '
                                                                        'parameters.\n'
                                                                        '\n'
                                                                        '        '
                                                                        ':param '
                                                                        'tzinfo: '
                                                                        'Defaults '
                                                                        'to None.\n'
                                                                        '        '
                                                                        ':param '
                                                                        'minimum_age: '
                                                                        'Defaults '
                                                                        'to ``0``.\n'
                                                                        '        '
                                                                        ':param '
                                                                        'maximum_age: '
                                                                        'Defaults '
                                                                        'to '
                                                                        '``115``.\n'
                                                                        '\n'
                                                                        '        '
                                                                        ':sample:\n'
                                                                        '        '
                                                                        ':sample: '
                                                                        'minimum_age=30, '
                                                                        'maximum_age=50\n'
                                                                        '        ',
                                                                'example': datetime.date(1921, 4, 28),
                                                                'type': 'date'},
                                           'date_this_century': {   'docs': '\n'
                                                                            '        '
                                                                            'Gets a '
                                                                            'Date '
                                                                            'object '
                                                                            'for '
                                                                            'the '
                                                                            'current '
                                                                            'century.\n'
                                                                            '\n'
                                                                            '        '
                                                                            ':param '
                                                                            'before_today: '
                                                                            'include '
                                                                            'days '
                                                                            'in '
                                                                            'current '
                                                                            'century '
                                                                            'before '
                                                                            'today. '
                                                                            'Defaults '
                                                                            'to '
                                                                            'True\n'
                                                                            '        '
                                                                            ':param '
                                                                            'after_today: '
                                                                            'include '
                                                                            'days '
                                                                            'in '
                                                                            'current '
                                                                            'century '
                                                                            'after '
                                                                            'today. '
                                                                            'Defaults '
                                                                            'to '
                                                                            'False\n'
                                                                            '\n'
                                                                            '        '
                                                                            ':sample:\n'
                                                                            '        '
                                                                            ':sample: '
                                                                            'before_today=False, '
                                                                            'after_today=True\n'
                                                                            '        ',
                                                                    'example': datetime.date(2023, 3, 31),
                                                                    'type': 'date'},
                                           'date_this_decade': {   'docs': '\n'
                                                                           '        '
                                                                           'Gets a '
                                                                           'Date '
                                                                           'object '
                                                                           'for the '
                                                                           'decade '
                                                                           'year.\n'
                                                                           '\n'
                                                                           '        '
                                                                           ':param '
                                                                           'before_today: '
                                                                           'include '
                                                                           'days in '
                                                                           'current '
                                                                           'decade '
                                                                           'before '
                                                                           'today. '
                                                                           'Defaults '
                                                                           'to '
                                                                           'True\n'
                                                                           '        '
                                                                           ':param '
                                                                           'after_today: '
                                                                           'include '
                                                                           'days in '
                                                                           'current '
                                                                           'decade '
                                                                           'after '
                                                                           'today. '
                                                                           'Defaults '
                                                                           'to '
                                                                           'False\n'
                                                                           '\n'
                                                                           '        '
                                                                           ':sample:\n'
                                                                           '        '
                                                                           ':sample: '
                                                                           'before_today=False, '
                                                                           'after_today=True\n'
                                                                           '        ',
                                                                   'example': datetime.date(2023, 11, 2),
                                                                   'type': 'date'},
                                           'date_this_month': {   'docs': '\n'
                                                                          '        '
                                                                          'Gets a '
                                                                          'Date '
                                                                          'object '
                                                                          'for the '
                                                                          'current '
                                                                          'month.\n'
                                                                          '\n'
                                                                          '        '
                                                                          ':param '
                                                                          'before_today: '
                                                                          'include '
                                                                          'days in '
                                                                          'current '
                                                                          'month '
                                                                          'before '
                                                                          'today. '
                                                                          'Defaults '
                                                                          'to True\n'
                                                                          '        '
                                                                          ':param '
                                                                          'after_today: '
                                                                          'include '
                                                                          'days in '
                                                                          'current '
                                                                          'month '
                                                                          'after '
                                                                          'today. '
                                                                          'Defaults '
                                                                          'to '
                                                                          'False\n'
                                                                          '\n'
                                                                          '        '
                                                                          ':sample:\n'
                                                                          '        '
                                                                          ':sample: '
                                                                          'before_today=False, '
                                                                          'after_today=True\n'
                                                                          '        ',
                                                                  'example': datetime.date(2025, 9, 12),
                                                                  'type': 'date'},
                                           'date_this_year': {   'docs': '\n'
                                                                         '        '
                                                                         'Gets a '
                                                                         'Date '
                                                                         'object '
                                                                         'for the '
                                                                         'current '
                                                                         'year.\n'
                                                                         '\n'
                                                                         '        '
                                                                         ':param '
                                                                         'before_today: '
                                                                         'include '
                                                                         'days in '
                                                                         'current '
                                                                         'year '
                                                                         'before '
                                                                         'today. '
                                                                         'Defaults '
                                                                         'to True\n'
                                                                         '        '
                                                                         ':param '
                                                                         'after_today: '
                                                                         'include '
                                                                         'days in '
                                                                         'current '
                                                                         'year '
                                                                         'after '
                                                                         'today. '
                                                                         'Defaults '
                                                                         'to False\n'
                                                                         '\n'
                                                                         '        '
                                                                         ':sample:\n'
                                                                         '        '
                                                                         ':sample: '
                                                                         'before_today=False, '
                                                                         'after_today=True\n'
                                                                         '        ',
                                                                 'example': datetime.date(2025, 8, 4),
                                                                 'type': 'date'},
                                           'date_time': {   'docs': '\n'
                                                                    '        Get a '
                                                                    'datetime '
                                                                    'object for a '
                                                                    'date between '
                                                                    'January 1, '
                                                                    '1970 and a '
                                                                    'specified '
                                                                    'end_datetime\n'
                                                                    '\n'
                                                                    '        :param '
                                                                    'tzinfo: '
                                                                    'timezone, '
                                                                    'instance of '
                                                                    'datetime.tzinfo '
                                                                    'subclass\n'
                                                                    '        :param '
                                                                    'end_datetime: '
                                                                    'A '
                                                                    '``DateParseType``. '
                                                                    'Defaults to '
                                                                    'the current '
                                                                    'date and time\n'
                                                                    '\n'
                                                                    '        '
                                                                    ':sample:\n'
                                                                    '        ',
                                                            'example': datetime.datetime(1972, 11, 26, 13, 13, 2, 298792),
                                                            'type': 'datetime'},
                                           'date_time_ad': {   'docs': '\n'
                                                                       '        Get '
                                                                       'a datetime '
                                                                       'object for '
                                                                       'a date '
                                                                       'between '
                                                                       'January 1, '
                                                                       '0001 and '
                                                                       'now\n'
                                                                       '\n'
                                                                       '        '
                                                                       ':param '
                                                                       'tzinfo: '
                                                                       'timezone, '
                                                                       'instance of '
                                                                       'datetime.tzinfo '
                                                                       'subclass\n'
                                                                       '        '
                                                                       ':param '
                                                                       'end_datetime: '
                                                                       'A '
                                                                       '``DateParseType``. '
                                                                       'Defaults to '
                                                                       'the current '
                                                                       'date and '
                                                                       'time\n'
                                                                       '        '
                                                                       ':param '
                                                                       'start_datetime: '
                                                                       'A '
                                                                       '``DateParseType``. '
                                                                       'Defaults to '
                                                                       'UNIX '
                                                                       'timestamp '
                                                                       '``-62135596800``,\n'
                                                                       '        '
                                                                       'equivalent '
                                                                       'to '
                                                                       '0001-01-01 '
                                                                       '00:00:00 '
                                                                       'UTC\n'
                                                                       '\n'
                                                                       '        '
                                                                       ':sample:\n'
                                                                       '        ',
                                                               'example': datetime.datetime(751, 1, 22, 21, 3, 9, 133087),
                                                               'type': 'datetime'},
                                           'date_time_between': {   'docs': '\n'
                                                                            '        '
                                                                            'Get a '
                                                                            'datetime '
                                                                            'object '
                                                                            'based '
                                                                            'on a '
                                                                            'random '
                                                                            'date '
                                                                            'between '
                                                                            'two '
                                                                            'given '
                                                                            'dates.\n'
                                                                            '        '
                                                                            'Accepts '
                                                                            'date '
                                                                            'strings '
                                                                            'that '
                                                                            'can be '
                                                                            'recognized '
                                                                            'by '
                                                                            'strtotime().\n'
                                                                            '\n'
                                                                            '        '
                                                                            ':param '
                                                                            'start_date: '
                                                                            'A '
                                                                            '``DateParseType``. '
                                                                            'Defaults '
                                                                            'to 30 '
                                                                            'years '
                                                                            'ago\n'
                                                                            '        '
                                                                            ':param '
                                                                            'end_date: '
                                                                            'A '
                                                                            '``DateParseType``. '
                                                                            'Defaults '
                                                                            'to '
                                                                            '``"now"``\n'
                                                                            '        '
                                                                            ':param '
                                                                            'tzinfo: '
                                                                            'timezone, '
                                                                            'instance '
                                                                            'of '
                                                                            'datetime.tzinfo '
                                                                            'subclass\n'
                                                                            '\n'
                                                                            '        '
                                                                            ':sample:\n'
                                                                            '        ',
                                                                    'example': datetime.datetime(2013, 3, 17, 20, 24, 3, 11398),
                                                                    'type': 'datetime'},
                                           'date_time_between_dates': {   'docs': '\n'
                                                                                  '        '
                                                                                  'Get '
                                                                                  'a '
                                                                                  'random '
                                                                                  'datetime '
                                                                                  'between '
                                                                                  'the '
                                                                                  'two '
                                                                                  'given '
                                                                                  'datetimes.\n'
                                                                                  '\n'
                                                                                  '        '
                                                                                  ':param '
                                                                                  'datetime_start: '
                                                                                  'A '
                                                                                  '``DateParseType``. '
                                                                                  'Defaults '
                                                                                  'to '
                                                                                  'the '
                                                                                  'UNIX '
                                                                                  'epoch\n'
                                                                                  '        '
                                                                                  ':param '
                                                                                  'datetime_end: '
                                                                                  'A '
                                                                                  '``DateParseType``. '
                                                                                  'Defaults '
                                                                                  'to '
                                                                                  'the '
                                                                                  'current '
                                                                                  'date '
                                                                                  'and '
                                                                                  'time\n'
                                                                                  '        '
                                                                                  ':param '
                                                                                  'tzinfo: '
                                                                                  'timezone, '
                                                                                  'instance '
                                                                                  'of '
                                                                                  'datetime.tzinfo '
                                                                                  'subclass\n'
                                                                                  '\n'
                                                                                  '        '
                                                                                  ':sample:\n'
                                                                                  '        '
                                                                                  ':sample: '
                                                                                  "datetime_start='-30y', "
                                                                                  "datetime_end='now'\n"
                                                                                  '        '
                                                                                  ':sample: '
                                                                                  "datetime_start='now', "
                                                                                  "datetime_end='+1y'\n"
                                                                                  '\n'
                                                                                  '        ',
                                                                          'example': datetime.datetime(2025, 9, 19, 16, 23, 44),
                                                                          'type': 'datetime'},
                                           'date_time_this_century': {   'docs': '\n'
                                                                                 '        '
                                                                                 'Gets '
                                                                                 'a '
                                                                                 'datetime '
                                                                                 'object '
                                                                                 'for '
                                                                                 'the '
                                                                                 'current '
                                                                                 'century.\n'
                                                                                 '\n'
                                                                                 '        '
                                                                                 ':param '
                                                                                 'before_now: '
                                                                                 'include '
                                                                                 'days '
                                                                                 'in '
                                                                                 'current '
                                                                                 'century '
                                                                                 'before '
                                                                                 'today. '
                                                                                 'Defaults '
                                                                                 'to '
                                                                                 'True\n'
                                                                                 '        '
                                                                                 ':param '
                                                                                 'after_now: '
                                                                                 'include '
                                                                                 'days '
                                                                                 'in '
                                                                                 'current '
                                                                                 'century '
                                                                                 'after '
                                                                                 'today. '
                                                                                 'Defaults '
                                                                                 'to '
                                                                                 'False\n'
                                                                                 '        '
                                                                                 ':param '
                                                                                 'tzinfo: '
                                                                                 'timezone, '
                                                                                 'instance '
                                                                                 'of '
                                                                                 'datetime.tzinfo '
                                                                                 'subclass\n'
                                                                                 '\n'
                                                                                 '        '
                                                                                 ':sample:\n'
                                                                                 '        '
                                                                                 ':sample: '
                                                                                 'before_now=False, '
                                                                                 'after_now=True\n'
                                                                                 '        ',
                                                                         'example': datetime.datetime(2015, 3, 13, 2, 55, 58, 832501),
                                                                         'type': 'datetime'},
                                           'date_time_this_decade': {   'docs': '\n'
                                                                                '        '
                                                                                'Gets '
                                                                                'a '
                                                                                'datetime '
                                                                                'object '
                                                                                'for '
                                                                                'the '
                                                                                'decade '
                                                                                'year.\n'
                                                                                '\n'
                                                                                '        '
                                                                                ':param '
                                                                                'before_now: '
                                                                                'include '
                                                                                'days '
                                                                                'in '
                                                                                'current '
                                                                                'decade '
                                                                                'before '
                                                                                'today. '
                                                                                'Defaults '
                                                                                'to '
                                                                                'True\n'
                                                                                '        '
                                                                                ':param '
                                                                                'after_now: '
                                                                                'include '
                                                                                'days '
                                                                                'in '
                                                                                'current '
                                                                                'decade '
                                                                                'after '
                                                                                'today. '
                                                                                'Defaults '
                                                                                'to '
                                                                                'False\n'
                                                                                '        '
                                                                                ':param '
                                                                                'tzinfo: '
                                                                                'timezone, '
                                                                                'instance '
                                                                                'of '
                                                                                'datetime.tzinfo '
                                                                                'subclass\n'
                                                                                '\n'
                                                                                '        '
                                                                                ':sample:\n'
                                                                                '        '
                                                                                ':sample: '
                                                                                'before_now=False, '
                                                                                'after_now=True\n'
                                                                                '        ',
                                                                        'example': datetime.datetime(2025, 7, 9, 11, 16, 32, 590302),
                                                                        'type': 'datetime'},
                                           'date_time_this_month': {   'docs': '\n'
                                                                               '        '
                                                                               'Gets '
                                                                               'a '
                                                                               'datetime '
                                                                               'object '
                                                                               'for '
                                                                               'the '
                                                                               'current '
                                                                               'month.\n'
                                                                               '\n'
                                                                               '        '
                                                                               ':param '
                                                                               'before_now: '
                                                                               'include '
                                                                               'days '
                                                                               'in '
                                                                               'current '
                                                                               'month '
                                                                               'before '
                                                                               'today. '
                                                                               'Defaults '
                                                                               'to '
                                                                               'True\n'
                                                                               '        '
                                                                               ':param '
                                                                               'after_now: '
                                                                               'include '
                                                                               'days '
                                                                               'in '
                                                                               'current '
                                                                               'month '
                                                                               'after '
                                                                               'today. '
                                                                               'Defaults '
                                                                               'to '
                                                                               'False\n'
                                                                               '        '
                                                                               ':param '
                                                                               'tzinfo: '
                                                                               'timezone, '
                                                                               'instance '
                                                                               'of '
                                                                               'datetime.tzinfo '
                                                                               'subclass\n'
                                                                               '\n'
                                                                               '        '
                                                                               ':sample:\n'
                                                                               '        '
                                                                               ':sample: '
                                                                               'before_now=False, '
                                                                               'after_now=True\n'
                                                                               '        ',
                                                                       'example': datetime.datetime(2025, 9, 18, 21, 10, 49, 347080),
                                                                       'type': 'datetime'},
                                           'date_time_this_year': {   'docs': '\n'
                                                                              '        '
                                                                              'Gets '
                                                                              'a '
                                                                              'datetime '
                                                                              'object '
                                                                              'for '
                                                                              'the '
                                                                              'current '
                                                                              'year.\n'
                                                                              '\n'
                                                                              '        '
                                                                              ':param '
                                                                              'before_now: '
                                                                              'include '
                                                                              'days '
                                                                              'in '
                                                                              'current '
                                                                              'year '
                                                                              'before '
                                                                              'today. '
                                                                              'Defaults '
                                                                              'to '
                                                                              'True\n'
                                                                              '        '
                                                                              ':param '
                                                                              'after_now: '
                                                                              'include '
                                                                              'days '
                                                                              'in '
                                                                              'current '
                                                                              'year '
                                                                              'after '
                                                                              'today. '
                                                                              'Defaults '
                                                                              'to '
                                                                              'False\n'
                                                                              '        '
                                                                              ':param '
                                                                              'tzinfo: '
                                                                              'timezone, '
                                                                              'instance '
                                                                              'of '
                                                                              'datetime.tzinfo '
                                                                              'subclass\n'
                                                                              '\n'
                                                                              '        '
                                                                              ':sample:\n'
                                                                              '        '
                                                                              ':sample: '
                                                                              'before_now=False, '
                                                                              'after_now=True\n'
                                                                              '        ',
                                                                      'example': datetime.datetime(2025, 7, 9, 9, 9, 41, 593097),
                                                                      'type': 'datetime'},
                                           'day_of_month': {   'docs': '\n'
                                                                       '        '
                                                                       ':sample:\n'
                                                                       '        ',
                                                               'example': '11',
                                                               'type': 'str'},
                                           'day_of_week': {   'docs': '\n'
                                                                      '        '
                                                                      ':sample:\n'
                                                                      '        ',
                                                              'example': 'Monday',
                                                              'type': 'str'},
                                           'future_date': {   'docs': '\n'
                                                                      '        Get '
                                                                      'a Date '
                                                                      'object based '
                                                                      'on a random '
                                                                      'date between '
                                                                      '1 day from '
                                                                      'now and a\n'
                                                                      '        '
                                                                      'given date.\n'
                                                                      '\n'
                                                                      '        '
                                                                      ':param '
                                                                      'end_date: A '
                                                                      '``DateParseType``. '
                                                                      'Defaults to '
                                                                      '``"+30d"``\n'
                                                                      '        '
                                                                      ':param '
                                                                      'tzinfo: '
                                                                      'timezone, '
                                                                      'instance of '
                                                                      'datetime.tzinfo '
                                                                      'subclass\n'
                                                                      '\n'
                                                                      '        '
                                                                      ':sample:\n'
                                                                      '        '
                                                                      ':sample: '
                                                                      "end_date='+1y'\n"
                                                                      '        ',
                                                              'example': datetime.date(2025, 10, 10),
                                                              'type': 'date'},
                                           'future_datetime': {   'docs': '\n'
                                                                          '        '
                                                                          'Get a '
                                                                          'datetime '
                                                                          'object '
                                                                          'based on '
                                                                          'a random '
                                                                          'date '
                                                                          'between '
                                                                          '1 second '
                                                                          'form '
                                                                          'now\n'
                                                                          '        '
                                                                          'and a '
                                                                          'given '
                                                                          'date.\n'
                                                                          '\n'
                                                                          '        '
                                                                          ':param '
                                                                          'end_date: '
                                                                          'A '
                                                                          '``DateParseType``. '
                                                                          'Defaults '
                                                                          'to '
                                                                          '``"+30d"``\n'
                                                                          '        '
                                                                          ':param '
                                                                          'tzinfo: '
                                                                          'timezone, '
                                                                          'instance '
                                                                          'of '
                                                                          'datetime.tzinfo '
                                                                          'subclass\n'
                                                                          '\n'
                                                                          '        '
                                                                          ':sample:\n'
                                                                          '        '
                                                                          ':sample: '
                                                                          "end_date='+1y'\n"
                                                                          '        ',
                                                                  'example': datetime.datetime(2025, 9, 30, 22, 54, 25, 808416),
                                                                  'type': 'datetime'},
                                           'iso8601': {   'docs': '\n'
                                                                  '        Get an '
                                                                  'ISO 8601 string '
                                                                  'for a datetime '
                                                                  'between the UNIX '
                                                                  'epoch and now.\n'
                                                                  '\n'
                                                                  '        :param '
                                                                  'tzinfo: '
                                                                  'timezone, '
                                                                  'instance of '
                                                                  'datetime.tzinfo '
                                                                  'subclass\n'
                                                                  '        :param '
                                                                  'end_datetime: A '
                                                                  '``DateParseType``. '
                                                                  'Defaults to the '
                                                                  'current date and '
                                                                  'time\n'
                                                                  '        :param '
                                                                  'sep: separator '
                                                                  'between date and '
                                                                  'time, defaults '
                                                                  "to 'T'\n"
                                                                  '        :param '
                                                                  'timespec: format '
                                                                  'specifier for '
                                                                  'the time part, '
                                                                  'defaults to '
                                                                  "'auto' - see "
                                                                  'datetime.isoformat() '
                                                                  'documentation\n'
                                                                  '\n'
                                                                  '        '
                                                                  ':sample:\n'
                                                                  '        ',
                                                          'example': '2013-07-29T09:59:23.144604',
                                                          'type': 'str'},
                                           'month': {   'docs': '\n'
                                                                '        :sample:\n'
                                                                '        ',
                                                        'example': '11',
                                                        'type': 'str'},
                                           'month_name': {   'docs': '\n'
                                                                     '        '
                                                                     ':sample:\n'
                                                                     '        ',
                                                             'example': 'March',
                                                             'type': 'str'},
                                           'past_date': {   'docs': '\n'
                                                                    '        Get a '
                                                                    'Date object '
                                                                    'based on a '
                                                                    'random date '
                                                                    'between a '
                                                                    'given date and '
                                                                    '1 day\n'
                                                                    '        ago.\n'
                                                                    '\n'
                                                                    '        :param '
                                                                    'start_date: A '
                                                                    '``DateParseType``. '
                                                                    'Defaults to '
                                                                    '``"-30d"``\n'
                                                                    '        :param '
                                                                    'tzinfo: '
                                                                    'timezone, '
                                                                    'instance of '
                                                                    'datetime.tzinfo '
                                                                    'subclass\n'
                                                                    '\n'
                                                                    '        '
                                                                    ':sample:\n'
                                                                    '        '
                                                                    ':sample: '
                                                                    "start_date='-1y'\n"
                                                                    '        ',
                                                            'example': datetime.date(2025, 9, 11),
                                                            'type': 'date'},
                                           'past_datetime': {   'docs': '\n'
                                                                        '        '
                                                                        'Get a '
                                                                        'datetime '
                                                                        'object '
                                                                        'based on a '
                                                                        'random '
                                                                        'date '
                                                                        'between a '
                                                                        'given date '
                                                                        'and 1\n'
                                                                        '        '
                                                                        'second '
                                                                        'ago.\n'
                                                                        '\n'
                                                                        '        '
                                                                        ':param '
                                                                        'start_date: '
                                                                        'A '
                                                                        '``DateParseType``. '
                                                                        'Defaults '
                                                                        'to '
                                                                        '``"-30d"``\n'
                                                                        '        '
                                                                        ':param '
                                                                        'tzinfo: '
                                                                        'timezone, '
                                                                        'instance '
                                                                        'of '
                                                                        'datetime.tzinfo '
                                                                        'subclass\n'
                                                                        '        '
                                                                        ':example: '
                                                                        "datetime('1999-02-02 "
                                                                        "11:42:52')\n"
                                                                        '\n'
                                                                        '        '
                                                                        ':sample:\n'
                                                                        '        '
                                                                        ':sample: '
                                                                        "end_date='+1y'\n"
                                                                        '        ',
                                                                'example': datetime.datetime(2025, 9, 11, 2, 21, 4, 505208),
                                                                'type': 'datetime'},
                                           'pytimezone': {   'docs': '\n'
                                                                     '        '
                                                                     'Generate a '
                                                                     'random '
                                                                     'timezone (see '
                                                                     '``faker.timezone`` '
                                                                     'for any '
                                                                     'args)\n'
                                                                     '        and '
                                                                     'return a '
                                                                     'Python object '
                                                                     'usable as a '
                                                                     '``tzinfo`` '
                                                                     'for '
                                                                     '``datetime``\n'
                                                                     '        or '
                                                                     'other '
                                                                     'fakers.\n'
                                                                     '\n'
                                                                     '        '
                                                                     ':sample:\n'
                                                                     '        ',
                                                             'example': zoneinfo.ZoneInfo(key='Pacific/Auckland'),
                                                             'type': 'ZoneInfo'},
                                           'time': {   'docs': '\n'
                                                               '        Get a time '
                                                               'string (24h format '
                                                               'by default)\n'
                                                               '\n'
                                                               '        :param '
                                                               'pattern: format\n'
                                                               '        :param '
                                                               'end_datetime: A '
                                                               '``DateParseType``. '
                                                               'Defaults to the '
                                                               'current date and '
                                                               'time\n'
                                                               '\n'
                                                               '        :sample:\n'
                                                               '        :sample: '
                                                               "pattern='%I:%M %p'\n"
                                                               '        ',
                                                       'example': '06:47:54',
                                                       'type': 'str'},
                                           'time_delta': {   'docs': '\n'
                                                                     '        Get a '
                                                                     'random '
                                                                     'timedelta '
                                                                     'object of '
                                                                     'duration '
                                                                     'between the '
                                                                     'current date '
                                                                     'and time and '
                                                                     '`end_datetime`\n'
                                                                     '\n'
                                                                     '        '
                                                                     ':param '
                                                                     'end_datetime: '
                                                                     'A '
                                                                     '``DateParseType``. '
                                                                     'Defaults to '
                                                                     'the current '
                                                                     'date and '
                                                                     'time\n'
                                                                     '\n'
                                                                     '        '
                                                                     ':sample:\n'
                                                                     '        '
                                                                     ':sample: '
                                                                     "end_datetime='+30h'\n"
                                                                     '        ',
                                                             'example': datetime.timedelta(0),
                                                             'type': 'timedelta'},
                                           'time_object': {   'docs': '\n'
                                                                      '        Get '
                                                                      'a time '
                                                                      'object\n'
                                                                      '\n'
                                                                      '        '
                                                                      ':param '
                                                                      'end_datetime: '
                                                                      'A '
                                                                      '``DateParseType``. '
                                                                      'Defaults to '
                                                                      'the current '
                                                                      'date and '
                                                                      'time\n'
                                                                      '\n'
                                                                      '        '
                                                                      ':sample:\n'
                                                                      '        '
                                                                      ':sample: '
                                                                      "end_datetime='+1h'\n"
                                                                      '        ',
                                                              'example': datetime.time(6, 49, 35, 656170),
                                                              'type': 'time'},
                                           'time_series': {   'docs': '\n'
                                                                      '        '
                                                                      'Returns a '
                                                                      'generator '
                                                                      'yielding '
                                                                      'tuples of '
                                                                      '``(<datetime>, '
                                                                      '<value>)``.\n'
                                                                      '\n'
                                                                      '        The '
                                                                      'data points '
                                                                      'will start '
                                                                      'at '
                                                                      '``start_date``, '
                                                                      'and be at '
                                                                      'every time '
                                                                      'interval '
                                                                      'specified '
                                                                      'by\n'
                                                                      '        '
                                                                      '``precision``.\n'
                                                                      '\n'
                                                                      '        '
                                                                      ':param '
                                                                      'start_date: '
                                                                      'A '
                                                                      '``DateParseType``. '
                                                                      'Defaults to '
                                                                      '``"-30d"``\n'
                                                                      '        '
                                                                      ':param '
                                                                      'end_date: A '
                                                                      '``DateParseType``. '
                                                                      'Defaults to '
                                                                      '``"now"``\n'
                                                                      '        '
                                                                      ':param '
                                                                      'precision: A '
                                                                      'float '
                                                                      'representing '
                                                                      'the time '
                                                                      'interval '
                                                                      'between data '
                                                                      'points.\n'
                                                                      '        '
                                                                      'Defaults to '
                                                                      '1/30th of '
                                                                      'the time\n'
                                                                      '        '
                                                                      ':param '
                                                                      'distrib: A '
                                                                      'callable '
                                                                      'that accepts '
                                                                      'a datetime '
                                                                      'object and '
                                                                      'returns a '
                                                                      'value.\n'
                                                                      '        '
                                                                      'Defaults to '
                                                                      'a uniform '
                                                                      'distribution\n'
                                                                      '        '
                                                                      ':param '
                                                                      'tzinfo: '
                                                                      'timezone, '
                                                                      'instance of '
                                                                      'datetime.tzinfo '
                                                                      'subclass\n'
                                                                      '\n'
                                                                      '        '
                                                                      ':sample:\n'
                                                                      '        ',
                                                              'example': <generator object Provider.time_series at 0x76cbb64bfd00>,
                                                              'type': 'generator'},
                                           'timezone': {   'docs': '\n'
                                                                   '        '
                                                                   ':sample:\n'
                                                                   '        ',
                                                           'example': 'America/El_Salvador',
                                                           'type': 'str'},
                                           'unix_time': {   'docs': '\n'
                                                                    '        Get a '
                                                                    'timestamp '
                                                                    'between '
                                                                    'January 1, '
                                                                    '1970 and now, '
                                                                    'unless passed\n'
                                                                    '        '
                                                                    'explicit '
                                                                    '``start_datetime`` '
                                                                    'or '
                                                                    '`end_datetime` '
                                                                    'values.\n'
                                                                    '\n'
                                                                    '        On '
                                                                    'Windows, the '
                                                                    'decimal part '
                                                                    'is always 0.\n'
                                                                    '\n'
                                                                    '        :param '
                                                                    'end_datetime: '
                                                                    'A '
                                                                    '``DateParseType``. '
                                                                    'Defaults to '
                                                                    'the UNIX '
                                                                    'epoch\n'
                                                                    '        :param '
                                                                    'start_datetime: '
                                                                    'A '
                                                                    '``DateParseType``. '
                                                                    'Defaults to '
                                                                    'the current '
                                                                    'date and time\n'
                                                                    '\n'
                                                                    '        '
                                                                    ':sample:\n'
                                                                    '        ',
                                                            'example': 1545243492.604621,
                                                            'type': 'float'},
                                           'year': {   'docs': '\n'
                                                               '        :sample:\n'
                                                               '        ',
                                                       'example': '2008',
                                                       'type': 'str'}},
    'faker.providers.doi': {   'doi': {   'docs': '\n'
                                                  '        Generate a valid Digital '
                                                  'Object Identifier (DOI).\n'
                                                  '        Format: 10.{4-9 '
                                                  'digits}/{alphanumeric string}\n'
                                                  '        Eg: 10.1000/xyz123\n'
                                                  '\n'
                                                  '        :sample:\n'
                                                  '        ',
                                          'example': '10.18924207/d3y6b83',
                                          'type': 'str'}},
    'faker.providers.emoji': {   'emoji': {   'docs': '\n'
                                                      "        :example: '😉'\n"
                                                      '        ',
                                              'example': '🦚',
                                              'type': 'str'}},
    'faker.providers.file': {   'file_extension': {   'docs': 'Generate a file '
                                                              'extension under the '
                                                              'specified '
                                                              '``category``.\n'
                                                              '\n'
                                                              '        If '
                                                              '``category`` is '
                                                              '``None``, a random '
                                                              'category will be '
                                                              'used. The list of\n'
                                                              '        valid '
                                                              'categories include: '
                                                              "``'audio'``, "
                                                              "``'image'``, "
                                                              "``'office'``,\n"
                                                              "        ``'text'``, "
                                                              "and ``'video'``.\n"
                                                              '\n'
                                                              '        :sample:\n'
                                                              '        :sample: '
                                                              "category='image'\n"
                                                              '        ',
                                                      'example': 'mp4',
                                                      'type': 'str'},
                                'file_name': {   'docs': 'Generate a random file '
                                                         'name with extension.\n'
                                                         '\n'
                                                         '        If ``extension`` '
                                                         'is ``None``, a random '
                                                         'extension will be '
                                                         'created\n'
                                                         '        under the hood '
                                                         'using |file_extension| '
                                                         'with the specified\n'
                                                         '        ``category``. If '
                                                         'a value for ``extension`` '
                                                         'is provided, the\n'
                                                         '        value will be '
                                                         'used instead, and '
                                                         '``category`` will be '
                                                         'ignored.\n'
                                                         '        The actual name '
                                                         'part itself is generated '
                                                         'using |word|. If\n'
                                                         '        extension is an '
                                                         'empty string then no '
                                                         'extension will be added,\n'
                                                         '        and file_name '
                                                         'will be the same as '
                                                         '|word|.\n'
                                                         '\n'
                                                         '        :sample: size=10\n'
                                                         '        :sample: '
                                                         "category='audio'\n"
                                                         '        :sample: '
                                                         "extension='abcdef'\n"
                                                         '        :sample: '
                                                         "category='audio', "
                                                         "extension='abcdef'\n"
                                                         '        :sample: '
                                                         "extension=''\n"
                                                         '        ',
                                                 'example': 'price.numbers',
                                                 'type': 'str'},
                                'file_path': {   'docs': 'Generate an pathname to a '
                                                         'file.\n'
                                                         '\n'
                                                         '        This method uses '
                                                         '|file_name| under the '
                                                         'hood to generate the '
                                                         'file\n'
                                                         '        name itself, and '
                                                         '``depth`` controls the '
                                                         'depth of the directory\n'
                                                         '        path, and |word| '
                                                         'is used under the hood to '
                                                         'generate the\n'
                                                         '        different '
                                                         'directory names.\n'
                                                         '\n'
                                                         '        If ``absolute`` '
                                                         'is ``True`` (default), '
                                                         'the generated path '
                                                         'starts\n'
                                                         '        with ``/`` and is '
                                                         'absolute. Otherwise, the '
                                                         'generated path is\n'
                                                         '        relative.\n'
                                                         '\n'
                                                         '        If used, '
                                                         '``extension`` can be '
                                                         'either a string, forcing '
                                                         'that\n'
                                                         '        extension, a '
                                                         'sequence of strings (one '
                                                         'will be picked at '
                                                         'random),\n'
                                                         '        or an empty '
                                                         'sequence (the path will '
                                                         'have no extension). '
                                                         'Default\n'
                                                         '        behaviour is the '
                                                         'same as |file_name|\n'
                                                         '\n'
                                                         '        if '
                                                         '``file_system`` is set '
                                                         '(default="linux"), the '
                                                         'generated path uses\n'
                                                         '        specified file '
                                                         'system path standard, the '
                                                         'list of valid file '
                                                         'systems include:\n'
                                                         "        ``'windows'``, "
                                                         "``'linux'``.\n"
                                                         '\n'
                                                         '        :sample: size=10\n'
                                                         '        :sample: depth=3\n'
                                                         '        :sample: depth=5, '
                                                         "category='video'\n"
                                                         '        :sample: depth=5, '
                                                         "category='video', "
                                                         "extension='abcdef'\n"
                                                         '        :sample: '
                                                         'extension=[]\n'
                                                         '        :sample: '
                                                         "extension=''\n"
                                                         '        :sample: '
                                                         'extension=["a", "bc", '
                                                         '"def"]\n'
                                                         '        :sample: depth=5, '
                                                         "category='video', "
                                                         "extension='abcdef', "
                                                         "file_system='windows'\n"
                                                         '        ',
                                                 'example': '/certainly/begin.jpg',
                                                 'type': 'str'},
                                'mime_type': {   'docs': 'Generate a mime type '
                                                         'under the specified '
                                                         '``category``.\n'
                                                         '\n'
                                                         '        If ``category`` '
                                                         'is ``None``, a random '
                                                         'category will be used. '
                                                         'The list of\n'
                                                         '        valid categories '
                                                         'include '
                                                         "``'application'``, "
                                                         "``'audio'``, "
                                                         "``'image'``,\n"
                                                         "        ``'message'``, "
                                                         "``'model'``, "
                                                         "``'multipart'``, "
                                                         "``'text'``, and\n"
                                                         "        ``'video'``.\n"
                                                         '\n'
                                                         '        :sample:\n'
                                                         '        :sample: '
                                                         "category='application'\n"
                                                         '        ',
                                                 'example': 'multipart/related',
                                                 'type': 'str'},
                                'unix_device': {   'docs': 'Generate a Unix device '
                                                           'file name.\n'
                                                           '\n'
                                                           '        If ``prefix`` '
                                                           'is ``None``, a random '
                                                           'prefix will be used. '
                                                           'The list of\n'
                                                           '        valid prefixes '
                                                           "include: ``'sd'``, "
                                                           "``'vd'``, and "
                                                           "``'xvd'``.\n"
                                                           '\n'
                                                           '        :sample:\n'
                                                           '        :sample: '
                                                           "prefix='mmcblk'\n"
                                                           '        ',
                                                   'example': '/dev/sdw',
                                                   'type': 'str'},
                                'unix_partition': {   'docs': 'Generate a Unix '
                                                              'partition name.\n'
                                                              '\n'
                                                              '        This method '
                                                              'uses |unix_device| '
                                                              'under the hood to '
                                                              'create a device '
                                                              'file\n'
                                                              '        name with '
                                                              'the specified '
                                                              '``prefix``.\n'
                                                              '\n'
                                                              '        :sample:\n'
                                                              '        :sample: '
                                                              "prefix='mmcblk'\n"
                                                              '        ',
                                                      'example': '/dev/xvds7',
                                                      'type': 'str'}},
    'faker.providers.geo.en_US': {   'coordinate': {   'docs': '\n'
                                                               '        Optionally '
                                                               'center the coord '
                                                               'and pick a point '
                                                               'within radius.\n'
                                                               '        ',
                                                       'example': Decimal('85.350991'),
                                                       'type': 'Decimal'},
                                     'latitude': {   'docs': None,
                                                     'example': Decimal('-5.5173675'),
                                                     'type': 'Decimal'},
                                     'latlng': {   'docs': None,
                                                   'example': (   Decimal('-75.365827'),
                                                                  Decimal('47.005484')),
                                                   'type': 'tuple'},
                                     'local_latlng': {   'docs': 'Returns a '
                                                                 'location known to '
                                                                 'exist on land in '
                                                                 'a country '
                                                                 'specified by '
                                                                 '`country_code`.\n'
                                                                 '        Defaults '
                                                                 "to 'en_US'. See "
                                                                 'the `land_coords` '
                                                                 'list for '
                                                                 'available '
                                                                 'locations/countries.\n'
                                                                 '        ',
                                                         'example': (   '40.67705',
                                                                        '-73.89125',
                                                                        'Cypress '
                                                                        'Hills',
                                                                        'US',
                                                                        'America/New_York'),
                                                         'type': 'tuple'},
                                     'location_on_land': {   'docs': 'Returns a '
                                                                     'random tuple '
                                                                     'specifying a '
                                                                     'coordinate '
                                                                     'set '
                                                                     'guaranteed to '
                                                                     'exist on '
                                                                     'land.\n'
                                                                     '        '
                                                                     'Format is '
                                                                     '`(latitude, '
                                                                     'longitude, '
                                                                     'place name, '
                                                                     'two-letter '
                                                                     'country code, '
                                                                     'timezone)`\n'
                                                                     '        Pass '
                                                                     '`coords_only` '
                                                                     'to return '
                                                                     'coordinates '
                                                                     'without '
                                                                     'metadata.\n'
                                                                     '        ',
                                                             'example': (   '37.31065',
                                                                            '13.57661',
                                                                            'Agrigento',
                                                                            'IT',
                                                                            'Europe/Rome'),
                                                             'type': 'tuple'},
                                     'longitude': {   'docs': None,
                                                      'example': Decimal('152.190015'),
                                                      'type': 'Decimal'}},
    'faker.providers.internet.en_US': {   'ascii_company_email': {   'docs': None,
                                                                     'example': 'No '
                                                                                'example '
                                                                                '(method '
                                                                                'has '
                                                                                'non-default '
                                                                                'args)',
                                                                     'type': None},
                                          'ascii_email': {   'docs': None,
                                                             'example': 'No example '
                                                                        '(method '
                                                                        'has '
                                                                        'non-default '
                                                                        'args)',
                                                             'type': None},
                                          'ascii_free_email': {   'docs': None,
                                                                  'example': 'No '
                                                                             'example '
                                                                             '(method '
                                                                             'has '
                                                                             'non-default '
                                                                             'args)',
                                                                  'type': None},
                                          'ascii_safe_email': {   'docs': None,
                                                                  'example': 'No '
                                                                             'example '
                                                                             '(method '
                                                                             'has '
                                                                             'non-default '
                                                                             'args)',
                                                                  'type': None},
                                          'company_email': {   'docs': None,
                                                               'example': 'No '
                                                                          'example '
                                                                          '(method '
                                                                          'has '
                                                                          'non-default '
                                                                          'args)',
                                                               'type': None},
                                          'dga': {   'docs': 'Generates a domain '
                                                             'name by given date\n'
                                                             '        '
                                                             'https://en.wikipedia.org/wiki/Domain_generation_algorithm\n'
                                                             '\n'
                                                             '        :type year: '
                                                             'int\n'
                                                             '        :type month: '
                                                             'int\n'
                                                             '        :type day: '
                                                             'int\n'
                                                             '        :type tld: '
                                                             'str\n'
                                                             '        :type length: '
                                                             'int\n'
                                                             '        :rtype: str\n'
                                                             '        ',
                                                     'example': 'fktgitlqjxkuebrtoqmxwnifpqxdeuufndfxxnbgiyqqcxb.com',
                                                     'type': 'str'},
                                          'domain_name': {   'docs': '\n'
                                                                     '        '
                                                                     'Produce an '
                                                                     'Internet '
                                                                     'domain name '
                                                                     'with the '
                                                                     'specified '
                                                                     'number of\n'
                                                                     '        '
                                                                     'subdomain '
                                                                     'levels.\n'
                                                                     '\n'
                                                                     '        >>> '
                                                                     'domain_name()\n'
                                                                     '        '
                                                                     'nichols-phillips.com\n'
                                                                     '        >>> '
                                                                     'domain_name(2)\n'
                                                                     '        '
                                                                     'williamson-hopkins.jackson.com\n'
                                                                     '        ',
                                                             'example': 'No example '
                                                                        '(method '
                                                                        'has '
                                                                        'non-default '
                                                                        'args)',
                                                             'type': None},
                                          'domain_word': {   'docs': None,
                                                             'example': 'No example '
                                                                        '(method '
                                                                        'has '
                                                                        'non-default '
                                                                        'args)',
                                                             'type': None},
                                          'email': {   'docs': None,
                                                       'example': 'No example '
                                                                  '(method has '
                                                                  'non-default '
                                                                  'args)',
                                                       'type': None},
                                          'free_email': {   'docs': None,
                                                            'example': 'No example '
                                                                       '(method has '
                                                                       'non-default '
                                                                       'args)',
                                                            'type': None},
                                          'free_email_domain': {   'docs': None,
                                                                   'example': 'No '
                                                                              'example '
                                                                              '(method '
                                                                              'has '
                                                                              'non-default '
                                                                              'args)',
                                                                   'type': None},
                                          'hostname': {   'docs': '\n'
                                                                  '        Produce '
                                                                  'a hostname with '
                                                                  'specified number '
                                                                  'of subdomain '
                                                                  'levels.\n'
                                                                  '\n'
                                                                  '        >>> '
                                                                  'hostname()\n'
                                                                  '        '
                                                                  'db-01.nichols-phillips.com\n'
                                                                  '        >>> '
                                                                  'hostname(0)\n'
                                                                  '        '
                                                                  'laptop-56\n'
                                                                  '        >>> '
                                                                  'hostname(2)\n'
                                                                  '        '
                                                                  'web-12.williamson-hopkins.jackson.com\n'
                                                                  '        ',
                                                          'example': 'No example '
                                                                     '(method has '
                                                                     'non-default '
                                                                     'args)',
                                                          'type': None},
                                          'http_method': {   'docs': 'Returns '
                                                                     'random HTTP '
                                                                     'method\n'
                                                                     '        '
                                                                     'https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods\n'
                                                                     '\n'
                                                                     '        '
                                                                     ':rtype: str\n'
                                                                     '        ',
                                                             'example': 'PATCH',
                                                             'type': 'str'},
                                          'http_status_code': {   'docs': 'Returns '
                                                                          'random '
                                                                          'HTTP '
                                                                          'status '
                                                                          'code\n'
                                                                          '        '
                                                                          'https://www.rfc-editor.org/rfc/rfc9110#name-status-codes\n'
                                                                          '        '
                                                                          ':param '
                                                                          'include_unassigned: '
                                                                          'Whether '
                                                                          'to '
                                                                          'include '
                                                                          'status '
                                                                          'codes '
                                                                          'which '
                                                                          'have\n'
                                                                          '            '
                                                                          'not yet '
                                                                          'been '
                                                                          'assigned '
                                                                          'or are '
                                                                          'unused\n'
                                                                          '\n'
                                                                          '        '
                                                                          ':return: '
                                                                          'a random '
                                                                          'three '
                                                                          'digit '
                                                                          'status '
                                                                          'code\n'
                                                                          '        '
                                                                          ':rtype: '
                                                                          'int\n'
                                                                          '\n'
                                                                          '        '
                                                                          ':example: '
                                                                          '404\n'
                                                                          '\n'
                                                                          '        ',
                                                                  'example': 409,
                                                                  'type': 'int'},
                                          'iana_id': {   'docs': 'Returns IANA '
                                                                 'Registrar ID\n'
                                                                 '        '
                                                                 'https://www.iana.org/assignments/registrar-ids/registrar-ids.xhtml\n'
                                                                 '\n'
                                                                 '        :rtype: '
                                                                 'str\n'
                                                                 '        ',
                                                         'example': '5096243',
                                                         'type': 'str'},
                                          'image_url': {   'docs': '\n'
                                                                   '        Returns '
                                                                   'URL to '
                                                                   'placeholder '
                                                                   'image\n'
                                                                   '        '
                                                                   'Example: '
                                                                   'http://placehold.it/640x480\n'
                                                                   '\n'
                                                                   '        :param '
                                                                   'width: Optional '
                                                                   'image width\n'
                                                                   '        :param '
                                                                   'height: '
                                                                   'Optional image '
                                                                   'height\n'
                                                                   '        :param '
                                                                   'placeholder_url: '
                                                                   'Optional '
                                                                   'template string '
                                                                   'of image URLs '
                                                                   'from custom\n'
                                                                   '            '
                                                                   'placeholder '
                                                                   'service. String '
                                                                   'must contain '
                                                                   '``{width}`` and '
                                                                   '``{height}``\n'
                                                                   '            '
                                                                   'placeholders, '
                                                                   'eg: '
                                                                   '``https:/example.com/{width}/{height}``.\n'
                                                                   '        :rtype: '
                                                                   'str\n'
                                                                   '        ',
                                                           'example': 'https://placekitten.com/130/853',
                                                           'type': 'str'},
                                          'ipv4': {   'docs': '\n'
                                                              '        Returns a '
                                                              'random IPv4 address '
                                                              'or network with a '
                                                              'valid CIDR.\n'
                                                              '\n'
                                                              '        :param '
                                                              'network: Network '
                                                              'address\n'
                                                              '        :param '
                                                              'address_class: IPv4 '
                                                              'address class (a, b, '
                                                              'or c)\n'
                                                              '        :param '
                                                              'private: Public or '
                                                              'private\n'
                                                              '        :returns: '
                                                              'IPv4\n'
                                                              '        ',
                                                      'example': '181.132.248.30',
                                                      'type': 'str'},
                                          'ipv4_network_class': {   'docs': '\n'
                                                                            '        '
                                                                            'Returns '
                                                                            'a IPv4 '
                                                                            'network '
                                                                            'class '
                                                                            "'a', "
                                                                            "'b' or "
                                                                            "'c'.\n"
                                                                            '\n'
                                                                            '        '
                                                                            ':returns: '
                                                                            'IPv4 '
                                                                            'network '
                                                                            'class\n'
                                                                            '        ',
                                                                    'example': 'c',
                                                                    'type': 'str'},
                                          'ipv4_private': {   'docs': '\n'
                                                                      '        '
                                                                      'Returns a '
                                                                      'private '
                                                                      'IPv4.\n'
                                                                      '\n'
                                                                      '        '
                                                                      ':param '
                                                                      'network: '
                                                                      'Network '
                                                                      'address\n'
                                                                      '        '
                                                                      ':param '
                                                                      'address_class: '
                                                                      'IPv4 address '
                                                                      'class (a, b, '
                                                                      'or c)\n'
                                                                      '        '
                                                                      ':returns: '
                                                                      'Private '
                                                                      'IPv4\n'
                                                                      '        ',
                                                              'example': '10.113.114.111',
                                                              'type': 'str'},
                                          'ipv4_public': {   'docs': '\n'
                                                                     '        '
                                                                     'Returns a '
                                                                     'public IPv4 '
                                                                     'excluding '
                                                                     'private '
                                                                     'blocks.\n'
                                                                     '\n'
                                                                     '        '
                                                                     ':param '
                                                                     'network: '
                                                                     'Network '
                                                                     'address\n'
                                                                     '        '
                                                                     ':param '
                                                                     'address_class: '
                                                                     'IPv4 address '
                                                                     'class (a, b, '
                                                                     'or c)\n'
                                                                     '        '
                                                                     ':returns: '
                                                                     'Public IPv4\n'
                                                                     '        ',
                                                             'example': '145.134.139.82',
                                                             'type': 'str'},
                                          'ipv6': {   'docs': 'Produce a random '
                                                              'IPv6 address or '
                                                              'network with a valid '
                                                              'CIDR',
                                                      'example': '2f19:5ff2:6067:5b06:6f6b:22fe:5d1a:d939',
                                                      'type': 'str'},
                                          'mac_address': {   'docs': '\n'
                                                                     '        '
                                                                     'Returns a '
                                                                     'random MAC '
                                                                     'address.\n'
                                                                     '\n'
                                                                     '        '
                                                                     ':param '
                                                                     'multicast: '
                                                                     'Multicast '
                                                                     'address\n'
                                                                     '        '
                                                                     ':returns: MAC '
                                                                     'Address\n'
                                                                     '        ',
                                                             'example': '4e:9d:10:c4:32:11',
                                                             'type': 'str'},
                                          'nic_handle': {   'docs': 'Returns NIC '
                                                                    'Handle ID\n'
                                                                    '        '
                                                                    'https://www.apnic.net/manage-ip/using-whois/guide/person/\n'
                                                                    '\n'
                                                                    '        '
                                                                    ':rtype: str\n'
                                                                    '        ',
                                                            'example': 'MW6891-FAKE',
                                                            'type': 'str'},
                                          'nic_handles': {   'docs': 'Returns NIC '
                                                                     'Handle ID '
                                                                     'list\n'
                                                                     '\n'
                                                                     '        '
                                                                     ':rtype: '
                                                                     'list[str]\n'
                                                                     '        ',
                                                             'example': [   'MZKF1-VSNC'],
                                                             'type': 'list'},
                                          'port_number': {   'docs': 'Returns a '
                                                                     'network port '
                                                                     'number\n'
                                                                     '        '
                                                                     'https://tools.ietf.org/html/rfc6335\n'
                                                                     '\n'
                                                                     '        '
                                                                     ':param '
                                                                     'is_system: '
                                                                     'System or '
                                                                     'well-known '
                                                                     'ports\n'
                                                                     '        '
                                                                     ':param '
                                                                     'is_user: User '
                                                                     'or registered '
                                                                     'ports\n'
                                                                     '        '
                                                                     ':param '
                                                                     'is_dynamic: '
                                                                     'Dynamic / '
                                                                     'private / '
                                                                     'ephemeral '
                                                                     'ports\n'
                                                                     '        '
                                                                     ':rtype: int\n'
                                                                     '        ',
                                                             'example': 54792,
                                                             'type': 'int'},
                                          'ripe_id': {   'docs': 'Returns RIPE '
                                                                 'Organization ID\n'
                                                                 '        '
                                                                 'https://www.ripe.net/manage-ips-and-asns/db/support/organisation-object-in-the-ripe-database\n'
                                                                 '\n'
                                                                 '        :rtype: '
                                                                 'str\n'
                                                                 '        ',
                                                         'example': 'ORG-AHN732-RIPE',
                                                         'type': 'str'},
                                          'safe_domain_name': {   'docs': None,
                                                                  'example': 'No '
                                                                             'example '
                                                                             '(method '
                                                                             'has '
                                                                             'non-default '
                                                                             'args)',
                                                                  'type': None},
                                          'safe_email': {   'docs': None,
                                                            'example': 'No example '
                                                                       '(method has '
                                                                       'non-default '
                                                                       'args)',
                                                            'type': None},
                                          'slug': {   'docs': 'Django algorithm',
                                                      'example': 'No example '
                                                                 '(method has '
                                                                 'non-default args)',
                                                      'type': None},
                                          'tld': {   'docs': None,
                                                     'example': 'org',
                                                     'type': 'str'},
                                          'uri': {   'docs': '\n'
                                                             '        :param '
                                                             'schemes: a list of '
                                                             'strings to use as '
                                                             'schemes, one will '
                                                             'chosen randomly.\n'
                                                             '            If None, '
                                                             'it will generate http '
                                                             'and https uris.\n'
                                                             '            Passing '
                                                             'an empty list will '
                                                             'result in schemeless '
                                                             'uri generation like '
                                                             '"://domain.com/index.html".\n'
                                                             '        :param deep: '
                                                             'an integer specifying '
                                                             'how many path '
                                                             'components the URI '
                                                             'should have..\n'
                                                             '        :return: a '
                                                             'random url string.\n'
                                                             '        ',
                                                     'example': 'https://roth.com/category/explore/mainsearch.asp',
                                                     'type': 'str'},
                                          'uri_extension': {   'docs': None,
                                                               'example': '.php',
                                                               'type': 'str'},
                                          'uri_page': {   'docs': None,
                                                          'example': 'faq',
                                                          'type': 'str'},
                                          'uri_path': {   'docs': None,
                                                          'example': 'list/categories',
                                                          'type': 'str'},
                                          'url': {   'docs': '\n'
                                                             '        :param '
                                                             'schemes: a list of '
                                                             'strings to use as '
                                                             'schemes, one will '
                                                             'chosen randomly.\n'
                                                             '            If None, '
                                                             'it will generate http '
                                                             'and https urls.\n'
                                                             '            Passing '
                                                             'an empty list will '
                                                             'result in schemeless '
                                                             'url generation like '
                                                             '"://domain.com".\n'
                                                             '        :return: a '
                                                             'random url string.\n'
                                                             '\n'
                                                             '        ',
                                                     'example': 'http://oliver.info/',
                                                     'type': 'str'},
                                          'user_name': {   'docs': None,
                                                           'example': 'No example '
                                                                      '(method has '
                                                                      'non-default '
                                                                      'args)',
                                                           'type': None}},
    'faker.providers.isbn.en_US': {   'isbn10': {   'docs': '\n'
                                                            '        :sample:\n'
                                                            '        ',
                                                    'example': '0-522-05879-5',
                                                    'type': 'str'},
                                      'isbn13': {   'docs': '\n'
                                                            '        :sample:\n'
                                                            '        ',
                                                    'example': '978-0-9611968-4-4',
                                                    'type': 'str'}},
    'faker.providers.job.en_US': {   'job': {   'docs': None,
                                                'example': 'Engineer, materials',
                                                'type': 'str'},
                                     'job_female': {   'docs': None,
                                                       'example': 'Location manager',
                                                       'type': 'str'},
                                     'job_male': {   'docs': None,
                                                     'example': 'Chartered '
                                                                'certified '
                                                                'accountant',
                                                     'type': 'str'}},
    'faker.providers.lorem.en_US': {   'get_words_list': {   'docs': 'Get list of '
                                                                     'words.\n'
                                                                     '\n'
                                                                     '        '
                                                                     '``ext_word_list`` '
                                                                     'is a '
                                                                     'parameter '
                                                                     'that allows '
                                                                     'the user to '
                                                                     'provide a '
                                                                     'list\n'
                                                                     '        of '
                                                                     'words to be '
                                                                     'used instead '
                                                                     'of the '
                                                                     'built-in word '
                                                                     'list. If '
                                                                     '``ext_word_list``\n'
                                                                     '        is '
                                                                     'provided, '
                                                                     'then the '
                                                                     'value of '
                                                                     '``part_of_speech`` '
                                                                     'is ignored.\n'
                                                                     '\n'
                                                                     '        '
                                                                     '``part_of_speech`` '
                                                                     'is a '
                                                                     'parameter '
                                                                     'that defines '
                                                                     'to what part '
                                                                     'of speech\n'
                                                                     '        the '
                                                                     'returned word '
                                                                     'belongs. If '
                                                                     '``ext_word_list`` '
                                                                     'is not '
                                                                     '``None``, '
                                                                     'then\n'
                                                                     '        '
                                                                     '``part_of_speech`` '
                                                                     'is ignored. '
                                                                     'If the value '
                                                                     'of '
                                                                     '``part_of_speech`` '
                                                                     'does\n'
                                                                     '        not '
                                                                     'correspond to '
                                                                     'an existent '
                                                                     'part of '
                                                                     'speech '
                                                                     'according to '
                                                                     'the set '
                                                                     'locale,\n'
                                                                     '        then '
                                                                     'an exception '
                                                                     'is raised.\n'
                                                                     '\n'
                                                                     '        '
                                                                     ':sample: '
                                                                     'part_of_speech="abc", '
                                                                     "ext_word_list=['abc', "
                                                                     "'def', 'ghi', "
                                                                     "'jkl']\n"
                                                                     '        '
                                                                     ':sample: '
                                                                     'part_of_speech="abc"\n'
                                                                     '        '
                                                                     ':sample: '
                                                                     "ext_word_list=['abc', "
                                                                     "'def', 'ghi', "
                                                                     "'jkl']\n"
                                                                     '\n'
                                                                     '        .. '
                                                                     'warning::\n'
                                                                     '            '
                                                                     'Depending on '
                                                                     'the length of '
                                                                     'a locale '
                                                                     "provider's "
                                                                     'built-in word '
                                                                     'list or\n'
                                                                     '            '
                                                                     'on the length '
                                                                     'of '
                                                                     '``ext_word_list`` '
                                                                     'if provided, '
                                                                     'a large '
                                                                     '``nb`` can\n'
                                                                     '            '
                                                                     'exhaust said '
                                                                     'lists if '
                                                                     '``unique`` is '
                                                                     '``True``, '
                                                                     'raising an '
                                                                     'exception.\n'
                                                                     '        ',
                                                             'example': 'No example '
                                                                        '(output '
                                                                        'too long)',
                                                             'type': None},
                                       'paragraph': {   'docs': 'Generate a '
                                                                'paragraph.\n'
                                                                '\n'
                                                                '        The '
                                                                '``nb_sentences`` '
                                                                'argument controls '
                                                                'how many sentences '
                                                                'the paragraph\n'
                                                                '        will '
                                                                'contain, and '
                                                                'setting '
                                                                '``variable_nb_sentences`` '
                                                                'to ``False`` will\n'
                                                                '        generate '
                                                                'the exact amount, '
                                                                'while setting it '
                                                                'to ``True`` '
                                                                '(default) will\n'
                                                                '        generate a '
                                                                'random amount '
                                                                '(+/-40%, minimum '
                                                                'of 1) using\n'
                                                                '        '
                                                                '|randomize_nb_elements|.\n'
                                                                '\n'
                                                                '        Under the '
                                                                'hood, |sentences| '
                                                                'is used to '
                                                                'generate the '
                                                                'sentences, so the\n'
                                                                '        argument '
                                                                '``ext_word_list`` '
                                                                'works in the same '
                                                                'way here as it '
                                                                'would in\n'
                                                                '        that '
                                                                'method.\n'
                                                                '\n'
                                                                '        :sample: '
                                                                'nb_sentences=5\n'
                                                                '        :sample: '
                                                                'nb_sentences=5, '
                                                                'variable_nb_sentences=False\n'
                                                                '        :sample: '
                                                                'nb_sentences=5, '
                                                                "ext_word_list=['abc', "
                                                                "'def', 'ghi', "
                                                                "'jkl']\n"
                                                                '        :sample: '
                                                                'nb_sentences=5, '
                                                                'variable_nb_sentences=False,\n'
                                                                '                 '
                                                                "ext_word_list=['abc', "
                                                                "'def', 'ghi', "
                                                                "'jkl']\n"
                                                                '        ',
                                                        'example': 'Billion body '
                                                                   'nothing school. '
                                                                   'Under message '
                                                                   'evidence.',
                                                        'type': 'str'},
                                       'paragraphs': {   'docs': 'Generate a list '
                                                                 'of paragraphs.\n'
                                                                 '\n'
                                                                 '        This '
                                                                 'method uses '
                                                                 '|paragraph| under '
                                                                 'the hood to '
                                                                 'generate '
                                                                 'paragraphs, and\n'
                                                                 '        the '
                                                                 '``nb`` argument '
                                                                 'controls exactly '
                                                                 'how many '
                                                                 'sentences the '
                                                                 'list will\n'
                                                                 '        contain. '
                                                                 'The '
                                                                 '``ext_word_list`` '
                                                                 'argument works in '
                                                                 'exactly the same '
                                                                 'way\n'
                                                                 '        as well.\n'
                                                                 '\n'
                                                                 '        :sample: '
                                                                 'nb=5\n'
                                                                 '        :sample: '
                                                                 'nb=5, '
                                                                 "ext_word_list=['abc', "
                                                                 "'def', 'ghi', "
                                                                 "'jkl']\n"
                                                                 '        ',
                                                         'example': [   'Field '
                                                                        'picture '
                                                                        'note tell '
                                                                        'left free. '
                                                                        'Enjoy live '
                                                                        'put your '
                                                                        'break '
                                                                        'sister '
                                                                        'produce.',
                                                                        'Total '
                                                                        'relationship '
                                                                        'child '
                                                                        'production '
                                                                        'prevent '
                                                                        'mean.',
                                                                        'International '
                                                                        'physical '
                                                                        'bar. '
                                                                        'Source '
                                                                        'role '
                                                                        'establish '
                                                                        'bag '
                                                                        'floor.'],
                                                         'type': 'list'},
                                       'sentence': {   'docs': 'Generate a '
                                                               'sentence.\n'
                                                               '\n'
                                                               '        The '
                                                               '``nb_words`` '
                                                               'argument controls '
                                                               'how many words the '
                                                               'sentence will\n'
                                                               '        contain, '
                                                               'and setting '
                                                               '``variable_nb_words`` '
                                                               'to ``False`` will '
                                                               'generate\n'
                                                               '        the exact '
                                                               'amount, while '
                                                               'setting it to '
                                                               '``True`` (default) '
                                                               'will generate\n'
                                                               '        a random '
                                                               'amount (+/-40%, '
                                                               'minimum of 1) using '
                                                               '|randomize_nb_elements|.\n'
                                                               '\n'
                                                               '        Under the '
                                                               'hood, |words| is '
                                                               'used to generate '
                                                               'the words, so the '
                                                               'argument\n'
                                                               '        '
                                                               '``ext_word_list`` '
                                                               'works in the same '
                                                               'way here as it '
                                                               'would in that '
                                                               'method.\n'
                                                               '\n'
                                                               '        :sample: '
                                                               'nb_words=10\n'
                                                               '        :sample: '
                                                               'nb_words=10, '
                                                               'variable_nb_words=False\n'
                                                               '        :sample: '
                                                               'nb_words=10, '
                                                               "ext_word_list=['abc', "
                                                               "'def', 'ghi', "
                                                               "'jkl']\n"
                                                               '        :sample: '
                                                               'nb_words=10, '
                                                               'variable_nb_words=True,\n'
                                                               '                 '
                                                               "ext_word_list=['abc', "
                                                               "'def', 'ghi', "
                                                               "'jkl']\n"
                                                               '        ',
                                                       'example': 'Return movement '
                                                                  'fear attorney '
                                                                  'onto yes '
                                                                  'mention.',
                                                       'type': 'str'},
                                       'sentences': {   'docs': 'Generate a list of '
                                                                'sentences.\n'
                                                                '\n'
                                                                '        This '
                                                                'method uses '
                                                                '|sentence| under '
                                                                'the hood to '
                                                                'generate '
                                                                'sentences, and\n'
                                                                '        the ``nb`` '
                                                                'argument controls '
                                                                'exactly how many '
                                                                'sentences the list '
                                                                'will\n'
                                                                '        contain. '
                                                                'The '
                                                                '``ext_word_list`` '
                                                                'argument works in '
                                                                'exactly the same '
                                                                'way\n'
                                                                '        as well.\n'
                                                                '\n'
                                                                '        :sample:\n'
                                                                '        :sample: '
                                                                'nb=5\n'
                                                                '        :sample: '
                                                                'nb=5, '
                                                                "ext_word_list=['abc', "
                                                                "'def', 'ghi', "
                                                                "'jkl']\n"
                                                                '        ',
                                                        'example': [   'Loss city '
                                                                       'near '
                                                                       'husband '
                                                                       'before '
                                                                       'decision '
                                                                       'lay.',
                                                                       'Stuff '
                                                                       'soldier '
                                                                       'especially '
                                                                       'newspaper.',
                                                                       'Evening put '
                                                                       'time '
                                                                       'computer '
                                                                       'guess life '
                                                                       'leg.'],
                                                        'type': 'list'},
                                       'text': {   'docs': 'Generate a text '
                                                           'string.\n'
                                                           '\n'
                                                           '        The '
                                                           '``max_nb_chars`` '
                                                           'argument controls the '
                                                           'approximate number of\n'
                                                           '        characters the '
                                                           'text string will have, '
                                                           'and depending on its '
                                                           'value, this\n'
                                                           '        method may use '
                                                           'either |words|, '
                                                           '|sentences|, or '
                                                           '|paragraphs| for text\n'
                                                           '        generation. The '
                                                           '``ext_word_list`` '
                                                           'argument works in '
                                                           'exactly the same way\n'
                                                           '        it would in any '
                                                           'of those methods.\n'
                                                           '\n'
                                                           '        :sample: '
                                                           'max_nb_chars=20\n'
                                                           '        :sample: '
                                                           'max_nb_chars=80\n'
                                                           '        :sample: '
                                                           'max_nb_chars=160\n'
                                                           '        :sample: '
                                                           "ext_word_list=['abc', "
                                                           "'def', 'ghi', 'jkl']\n"
                                                           '        ',
                                                   'example': 'Happen agency beat '
                                                              'international so. '
                                                              'Speak feel us '
                                                              'short.\n'
                                                              'Grow drug election '
                                                              'market. On account '
                                                              'success production '
                                                              'program character '
                                                              'tough. Most ago it '
                                                              'small.',
                                                   'type': 'str'},
                                       'texts': {   'docs': 'Generate a list of '
                                                            'text strings.\n'
                                                            '\n'
                                                            '        The '
                                                            '``nb_texts`` argument '
                                                            'controls how many text '
                                                            'strings the list will\n'
                                                            '        contain, and '
                                                            'this method uses '
                                                            '|text| under the hood '
                                                            'for text generation,\n'
                                                            '        so the two '
                                                            'remaining arguments, '
                                                            '``max_nb_chars`` and '
                                                            '``ext_word_list``\n'
                                                            '        will work in '
                                                            'exactly the same way '
                                                            'as well.\n'
                                                            '\n'
                                                            '        :sample: '
                                                            'nb_texts=5\n'
                                                            '        :sample: '
                                                            'nb_texts=5, '
                                                            'max_nb_chars=50\n'
                                                            '        :sample: '
                                                            'nb_texts=5, '
                                                            'max_nb_chars=50,\n'
                                                            '                 '
                                                            "ext_word_list=['abc', "
                                                            "'def', 'ghi', 'jkl']\n"
                                                            '        ',
                                                    'example': [   'Bar news ask '
                                                                   'letter realize '
                                                                   'run. Both son '
                                                                   'another whom. '
                                                                   'Always house '
                                                                   'likely improve '
                                                                   'professional '
                                                                   'the wish.',
                                                                   'During worker '
                                                                   'behind after '
                                                                   'outside able '
                                                                   'approach their. '
                                                                   'Else right meet '
                                                                   'have particular '
                                                                   'page. Civil '
                                                                   'fight tend '
                                                                   'reveal be '
                                                                   'campaign. '
                                                                   'Anything these '
                                                                   'ground security '
                                                                   'light.',
                                                                   'Most employee '
                                                                   'attention '
                                                                   'shoulder. Sign '
                                                                   'subject church '
                                                                   'true must '
                                                                   'visit.'],
                                                    'type': 'list'},
                                       'word': {   'docs': 'Generate a word.\n'
                                                           '\n'
                                                           '        This method '
                                                           'uses |words| under the '
                                                           'hood with the ``nb`` '
                                                           'argument set to\n'
                                                           '        ``1`` to '
                                                           'generate the result.\n'
                                                           '\n'
                                                           '        :sample:\n'
                                                           '        :sample: '
                                                           "ext_word_list=['abc', "
                                                           "'def', 'ghi', 'jkl']\n"
                                                           '        ',
                                                   'example': 'quality',
                                                   'type': 'str'},
                                       'words': {   'docs': 'Generate a tuple of '
                                                            'words.\n'
                                                            '\n'
                                                            '        The ``nb`` '
                                                            'argument controls the '
                                                            'number of words in the '
                                                            'resulting list,\n'
                                                            '        and if '
                                                            '``ext_word_list`` is '
                                                            'provided, words from '
                                                            'that list will be '
                                                            'used\n'
                                                            '        instead of '
                                                            'those from the locale '
                                                            "provider's built-in "
                                                            'word list.\n'
                                                            '\n'
                                                            '        if '
                                                            '``word_list`` is not '
                                                            'provided, the method '
                                                            'will use a default '
                                                            'value of None,\n'
                                                            '        which will '
                                                            'result in the method '
                                                            'calling the '
                                                            '``get_words_list`` '
                                                            'method to get the\n'
                                                            '        word list. If '
                                                            '``word_list`` is '
                                                            'provided, the method '
                                                            'will use the provided '
                                                            'list.\n'
                                                            '\n'
                                                            '        If ``unique`` '
                                                            'is ``True``, this '
                                                            'method will return a '
                                                            'list containing\n'
                                                            '        unique words. '
                                                            'Under the hood, '
                                                            '|random_sample| will '
                                                            'be used for sampling\n'
                                                            '        without '
                                                            'replacement. If '
                                                            '``unique`` is '
                                                            '``False``, '
                                                            '|random_choices| is\n'
                                                            '        used instead, '
                                                            'and the list returned '
                                                            'may contain '
                                                            'duplicates.\n'
                                                            '\n'
                                                            '        :sample:\n'
                                                            '        :sample: nb=5\n'
                                                            '        :sample: nb=5, '
                                                            "ext_word_list=['abc', "
                                                            "'def', 'ghi', 'jkl']\n"
                                                            '        :sample: nb=4, '
                                                            "ext_word_list=['abc', "
                                                            "'def', 'ghi', 'jkl'], "
                                                            'unique=True\n'
                                                            '        ',
                                                    'example': [   'yard',
                                                                   'public',
                                                                   'career'],
                                                    'type': 'list'}},
    'faker.providers.misc.en_US': {   'binary': {   'docs': 'Generate a random '
                                                            'binary blob of '
                                                            '``length`` bytes.\n'
                                                            '\n'
                                                            '        If this faker '
                                                            'instance has been '
                                                            'seeded, performance '
                                                            'will be signficiantly '
                                                            'reduced, to conform\n'
                                                            '        to the '
                                                            'seeding.\n'
                                                            '\n'
                                                            '        :sample: '
                                                            'length=64\n'
                                                            '        ',
                                                    'example': 'No example (output '
                                                               'too long)',
                                                    'type': None},
                                      'boolean': {   'docs': 'Generate a random '
                                                             'boolean value based '
                                                             'on '
                                                             '``chance_of_getting_true``.\n'
                                                             '\n'
                                                             '        :sample: '
                                                             'chance_of_getting_true=25\n'
                                                             '        :sample: '
                                                             'chance_of_getting_true=50\n'
                                                             '        :sample: '
                                                             'chance_of_getting_true=75\n'
                                                             '        ',
                                                     'example': False,
                                                     'type': 'bool'},
                                      'csv': {   'docs': 'Generate random '
                                                         'comma-separated values.\n'
                                                         '\n'
                                                         '        For more '
                                                         'information on the '
                                                         'different arguments of '
                                                         'this method, please refer '
                                                         'to\n'
                                                         '        :meth:`dsv() '
                                                         '<faker.providers.misc.Provider.dsv>` '
                                                         'which is used under the '
                                                         'hood.\n'
                                                         '\n'
                                                         '        :sample: '
                                                         "data_columns=('{{name}}', "
                                                         "'{{address}}'), "
                                                         'num_rows=10, '
                                                         'include_row_ids=False\n'
                                                         '        :sample: '
                                                         "header=('Name', "
                                                         "'Address', 'Favorite "
                                                         "Color'),\n"
                                                         '                '
                                                         "data_columns=('{{name}}', "
                                                         "'{{address}}', "
                                                         "'{{safe_color_name}}'),\n"
                                                         '                '
                                                         'num_rows=10, '
                                                         'include_row_ids=True\n'
                                                         '        ',
                                                 'example': '"Eric Davidson","161 '
                                                            'Duncan Lodge\n'
                                                            'Lake Peggy, TX '
                                                            '78786"\r\n'
                                                            '"Rebecca '
                                                            'Johnson","9630 Ferrell '
                                                            'Squares\n'
                                                            'South Manuelport, VA '
                                                            '98823"\r\n'
                                                            '"Pamela Brown","35213 '
                                                            'Rachel Ridges\n'
                                                            'North Anthonymouth, WV '
                                                            '09893"\r\n'
                                                            '"Charles '
                                                            'Robinson","88037 '
                                                            'Bradshaw Shore Apt. '
                                                            '559\n'
                                                            'Armstrongland, AZ '
                                                            '93836"\r\n'
                                                            '"John Phillips","3869 '
                                                            'Thomas Ridges Suite '
                                                            '016\n'
                                                            'Pamelaberg, NE '
                                                            '49312"\r\n'
                                                            '"Courtney Day","15750 '
                                                            'Timothy Prairie Suite '
                                                            '051\n'
                                                            'Kingshire, VI '
                                                            '61733"\r\n'
                                                            '"Nancy Clark","989 '
                                                            'Cochran Ferry Suite '
                                                            '709\n'
                                                            'Jessicaville, AL '
                                                            '22915"\r\n'
                                                            '"Amy Clay","Unit 1598 '
                                                            'Box 5878\n'
                                                            'DPO AA 72502"\r\n'
                                                            '"Kristy Johnson","3482 '
                                                            'Adkins Estate\n'
                                                            'Lake Charleshaven, NM '
                                                            '42408"\r\n'
                                                            '"Mr. William '
                                                            'Williamson","7702 '
                                                            'Suzanne Locks Suite '
                                                            '851\n'
                                                            'Lake Robinmouth, PW '
                                                            '93683"\r\n',
                                                 'type': 'str'},
                                      'dsv': {   'docs': 'Generate random '
                                                         'delimiter-separated '
                                                         'values.\n'
                                                         '\n'
                                                         "        This method's "
                                                         'behavior share some '
                                                         'similarities with '
                                                         '``csv.writer``. The '
                                                         '``dialect`` and\n'
                                                         '        ``**fmtparams`` '
                                                         'arguments are the same '
                                                         'arguments expected by '
                                                         '``csv.writer`` to control '
                                                         'its\n'
                                                         '        behavior, and '
                                                         'instead of expecting a '
                                                         'file-like object to where '
                                                         'output will be written, '
                                                         'the\n'
                                                         '        output is '
                                                         'controlled by additional '
                                                         'keyword arguments and is '
                                                         'returned as a string.\n'
                                                         '\n'
                                                         '        The ``dialect`` '
                                                         'argument defaults to '
                                                         "``'faker-csv'`` which is "
                                                         'the name of a '
                                                         '``csv.excel``\n'
                                                         '        subclass with '
                                                         'full quoting enabled.\n'
                                                         '\n'
                                                         '        The ``header`` '
                                                         'argument expects a list '
                                                         'or a tuple of strings '
                                                         'that will serve as the '
                                                         'header row\n'
                                                         '        if supplied. The '
                                                         '``data_columns`` argument '
                                                         'expects a list or a tuple '
                                                         'of string tokens, and '
                                                         'these\n'
                                                         '        string tokens '
                                                         'will be passed to  '
                                                         ':meth:`pystr_format() '
                                                         '<faker.providers.python.Provider.pystr_format>`\n'
                                                         '        for data '
                                                         'generation. Argument '
                                                         'Groups are used to pass '
                                                         'arguments to the provider '
                                                         'methods.\n'
                                                         '        Both ``header`` '
                                                         'and ``data_columns`` must '
                                                         'be of the same length.\n'
                                                         '\n'
                                                         '        Example:\n'
                                                         '            '
                                                         "fake.set_arguments('top_half', "
                                                         "{'min_value': 50, "
                                                         "'max_value': 100})\n"
                                                         '            '
                                                         "fake.dsv(data_columns=('{{ "
                                                         "name }}', '{{ "
                                                         "pyint:top_half }}'))\n"
                                                         '\n'
                                                         '        The ``num_rows`` '
                                                         'argument controls how '
                                                         'many rows of data to '
                                                         'generate, and the '
                                                         '``include_row_ids``\n'
                                                         '        argument may be '
                                                         'set to ``True`` to '
                                                         'include a sequential row '
                                                         'ID column.\n'
                                                         '\n'
                                                         '        :sample: '
                                                         "dialect='excel', "
                                                         "data_columns=('{{name}}', "
                                                         "'{{address}}')\n"
                                                         '        :sample: '
                                                         "dialect='excel-tab', "
                                                         "data_columns=('{{name}}', "
                                                         "'{{address}}'), "
                                                         'include_row_ids=True\n'
                                                         '        :sample: '
                                                         "data_columns=('{{name}}', "
                                                         "'{{address}}'), "
                                                         'num_rows=5, '
                                                         "delimiter='$'\n"
                                                         '        ',
                                                 'example': '"Jimmy Hansen","497 '
                                                            'Anderson Squares Suite '
                                                            '073\n'
                                                            'Marcusport, MI '
                                                            '20554"\r\n'
                                                            '"Daniel Maxwell","555 '
                                                            'Phillip Pines Apt. '
                                                            '865\n'
                                                            'Conradside, NM '
                                                            '72233"\r\n'
                                                            '"Mark Kent","Unit 6314 '
                                                            'Box 1709\n'
                                                            'DPO AE 94152"\r\n'
                                                            '"Kathy James","304 '
                                                            'Chen Junction Suite '
                                                            '459\n'
                                                            'Ericaville, UT '
                                                            '59071"\r\n'
                                                            '"Miguel '
                                                            'Williamson","558 Sheri '
                                                            'Grove\n'
                                                            'Josefurt, IN 79354"\r\n'
                                                            '"Melissa '
                                                            'Ellison","1784 Wagner '
                                                            'Mountains\n'
                                                            'Dawnburgh, NY '
                                                            '98285"\r\n'
                                                            '"Julie Bush","77859 '
                                                            'Marissa Extensions '
                                                            'Suite 388\n'
                                                            'Lake Jasonmouth, NE '
                                                            '47091"\r\n'
                                                            '"Christine '
                                                            'Smith","0694 Audrey '
                                                            'Lodge\n'
                                                            'Hamiltonfort, HI '
                                                            '10699"\r\n'
                                                            '"Dustin Lopez","6151 '
                                                            'Bradley Field\n'
                                                            'South Ronald, MA '
                                                            '84586"\r\n'
                                                            '"Bailey Calderon","157 '
                                                            'Cheryl Tunnel Suite '
                                                            '308\n'
                                                            'Austinfurt, MO '
                                                            '88229"\r\n',
                                                 'type': 'str'},
                                      'fixed_width': {   'docs': '\n'
                                                                 '        Generate '
                                                                 'random fixed '
                                                                 'width values.\n'
                                                                 '\n'
                                                                 '        Using a '
                                                                 'list of tuple '
                                                                 'records that is '
                                                                 'passed as '
                                                                 '``data_columns``, '
                                                                 'that\n'
                                                                 '        defines '
                                                                 'the structure '
                                                                 'that will be '
                                                                 'generated. '
                                                                 'Arguments within '
                                                                 'the\n'
                                                                 '        record '
                                                                 'are provider '
                                                                 'specific, and '
                                                                 'should be a '
                                                                 'dictionary that '
                                                                 'will be\n'
                                                                 '        passed to '
                                                                 'the provider '
                                                                 'method.\n'
                                                                 '\n'
                                                                 '        Data '
                                                                 'Column List '
                                                                 'format\n'
                                                                 '            '
                                                                 "[('field width', "
                                                                 "'definition', "
                                                                 "{'arguments'})]\n"
                                                                 '\n'
                                                                 '        The '
                                                                 'definition can be '
                                                                 "'provider', "
                                                                 "'provider:argument_group', "
                                                                 'tokenized\n'
                                                                 "        'string "
                                                                 '{{ '
                                                                 'provider:argument_group '
                                                                 "}}' that is "
                                                                 'passed to the '
                                                                 'python\n'
                                                                 '        provider '
                                                                 'method '
                                                                 'pystr_format() '
                                                                 'for generation, '
                                                                 'or a fixed '
                                                                 "'@word'.\n"
                                                                 '        Using '
                                                                 'Lists, Tuples, '
                                                                 'and Dicts as a '
                                                                 'definition for '
                                                                 'structure.\n'
                                                                 '\n'
                                                                 '        Argument '
                                                                 'Groups can be '
                                                                 'used to pass '
                                                                 'arguments to the '
                                                                 'provider '
                                                                 'methods,\n'
                                                                 '        but will '
                                                                 'override the '
                                                                 'arguments '
                                                                 'supplied in the '
                                                                 'tuple record.\n'
                                                                 '\n'
                                                                 '        Example:\n'
                                                                 '            '
                                                                 "fake.set_arguments('top_half', "
                                                                 "{'min_value': 50, "
                                                                 "'max_value': "
                                                                 '100})\n'
                                                                 '            '
                                                                 'fake.fixed_width(data_columns=[(20, '
                                                                 "'name'), (3, "
                                                                 "'pyint:top_half')])\n"
                                                                 '\n'
                                                                 '        :param '
                                                                 'data_columns: '
                                                                 'specification for '
                                                                 'the data '
                                                                 'structure\n'
                                                                 '        :type '
                                                                 'data_columns: '
                                                                 'list\n'
                                                                 '        :param '
                                                                 'num_rows: number '
                                                                 'of rows the '
                                                                 'generator will '
                                                                 'yield\n'
                                                                 '        :type '
                                                                 'num_rows: int\n'
                                                                 '        :param '
                                                                 'align: '
                                                                 'positioning of '
                                                                 'the value. (left, '
                                                                 'middle, right)\n'
                                                                 '        :type '
                                                                 'align: str\n'
                                                                 '        :return: '
                                                                 'Serialized Fixed '
                                                                 'Width data\n'
                                                                 '        :rtype: '
                                                                 'str\n'
                                                                 '\n'
                                                                 '        :sample: '
                                                                 'data_columns=[(20, '
                                                                 "'name'), (3, "
                                                                 "'pyint', "
                                                                 "{'min_value': "
                                                                 '50,\n'
                                                                 '                '
                                                                 "'max_value': "
                                                                 '100})], '
                                                                 "align='right', "
                                                                 'num_rows=2\n'
                                                                 '        ',
                                                         'example': 'Patricia '
                                                                    'Peterson   '
                                                                    '12 \n'
                                                                    'Christina '
                                                                    'Wilson    0  \n'
                                                                    'Carolyn '
                                                                    'Robertson   '
                                                                    '16 \n'
                                                                    'Jeffrey '
                                                                    'Wright      '
                                                                    '1  \n'
                                                                    'Bonnie '
                                                                    'Erickson     '
                                                                    '4  \n'
                                                                    'Cody '
                                                                    'Torres         '
                                                                    '0  \n'
                                                                    'James '
                                                                    'Nelson        '
                                                                    '0  \n'
                                                                    'Alyssa '
                                                                    'Riley        '
                                                                    '6  \n'
                                                                    'Brittany '
                                                                    'Smith      '
                                                                    '9  \n'
                                                                    'David '
                                                                    'Wright        '
                                                                    '19 ',
                                                         'type': 'str'},
                                      'image': {   'docs': 'Generate an image and '
                                                           'draw a random polygon '
                                                           'on it using the Python '
                                                           'Image Library.\n'
                                                           '        Without it '
                                                           'installed, this '
                                                           "provider won't be "
                                                           'functional. Returns the '
                                                           'bytes representing\n'
                                                           '        the image in a '
                                                           'given format.\n'
                                                           '\n'
                                                           '        The argument '
                                                           '``size`` must be a '
                                                           '2-tuple containing '
                                                           '(width, height) in '
                                                           'pixels. Defaults to '
                                                           '256x256.\n'
                                                           '\n'
                                                           '        The argument '
                                                           '``image_format`` can be '
                                                           'any valid format to the '
                                                           'underlying library like '
                                                           "``'tiff'``,\n"
                                                           "        ``'jpeg'``, "
                                                           "``'pdf'`` or ``'png'`` "
                                                           '(default). Note that '
                                                           'some formats need '
                                                           'present system '
                                                           'libraries\n'
                                                           '        prior to '
                                                           'building the Python '
                                                           'Image Library.\n'
                                                           '        Refer to '
                                                           'https://pillow.readthedocs.io/en/stable/handbook/image-file-formats.html '
                                                           'for details.\n'
                                                           '\n'
                                                           '        The arguments '
                                                           '``hue`` and '
                                                           '``luminosity`` are the '
                                                           'same as in the color '
                                                           'provider and are simply '
                                                           'forwarded to\n'
                                                           '        it to generate '
                                                           'both the background and '
                                                           'the shape colors. '
                                                           'Therefore, you can ask '
                                                           'for a "dark blue" '
                                                           'image, etc.\n'
                                                           '\n'
                                                           '        :sample: '
                                                           'size=(2, 2), '
                                                           "hue='purple', "
                                                           "luminosity='bright', "
                                                           "image_format='pdf'\n"
                                                           '        :sample: '
                                                           'size=(16, 16), '
                                                           'hue=[90,270], '
                                                           "image_format='ico'\n"
                                                           '        ',
                                                   'example': 'No example (module '
                                                              'not found)',
                                                   'type': None},
                                      'json': {   'docs': '\n'
                                                          '        Generate random '
                                                          'JSON structure values.\n'
                                                          '\n'
                                                          '        Using a '
                                                          'dictionary or list of '
                                                          'records that is passed '
                                                          'as ``data_columns``,\n'
                                                          '        define the '
                                                          'structure that is used '
                                                          'to build JSON '
                                                          'structures.  For '
                                                          'complex\n'
                                                          '        data structures '
                                                          'it is recommended to use '
                                                          'the dictionary format.\n'
                                                          '\n'
                                                          '        Data Column '
                                                          'Dictionary format:\n'
                                                          "            {'key name': "
                                                          "'definition'}\n"
                                                          '\n'
                                                          '        The definition '
                                                          "can be 'provider', "
                                                          "'provider:argument_group', "
                                                          'tokenized\n'
                                                          "        'string {{ "
                                                          'provider:argument_group '
                                                          "}}' that is passed to "
                                                          'the python\n'
                                                          '        provider method '
                                                          'pystr_format() for '
                                                          'generation, or a fixed '
                                                          "'@word'.\n"
                                                          '        Using Lists, '
                                                          'Tuples, and Dicts as a '
                                                          'definition for '
                                                          'structure.\n'
                                                          '\n'
                                                          '        Example:\n'
                                                          '            '
                                                          "fake.set_arguments('top_half', "
                                                          "{'min_value': 50, "
                                                          "'max_value': 100})\n"
                                                          '            '
                                                          "fake.json(data_columns={'Name': "
                                                          "'name', 'Score': "
                                                          "'pyint:top_half'})\n"
                                                          '\n'
                                                          '        Data Column List '
                                                          'format:\n'
                                                          "            [('key "
                                                          "name', 'definition', "
                                                          "{'arguments'})]\n"
                                                          '\n'
                                                          '        With the list '
                                                          'format the definition '
                                                          'can be a list of '
                                                          'records, to create\n'
                                                          '        a list within '
                                                          'the structure data.  For '
                                                          'literal entries within '
                                                          'the list,\n'
                                                          '        set the '
                                                          "'field_name' to None.\n"
                                                          '\n'
                                                          '        :param '
                                                          'data_columns: '
                                                          'specification for the '
                                                          'data structure\n'
                                                          '        :type '
                                                          'data_columns: dict\n'
                                                          '        :param num_rows: '
                                                          'number of rows the '
                                                          'returned\n'
                                                          '        :type num_rows: '
                                                          'int\n'
                                                          '        :param indent: '
                                                          'number of spaces to '
                                                          'indent the fields\n'
                                                          '        :type indent: '
                                                          'int\n'
                                                          '        :param cls: '
                                                          'optional json encoder to '
                                                          'use for non-standard '
                                                          'objects such as '
                                                          'datetimes\n'
                                                          '        :type cls: '
                                                          'json.JSONEncoder\n'
                                                          '        :return: '
                                                          'Serialized JSON data\n'
                                                          '        :rtype: str\n'
                                                          '\n'
                                                          '        :sample: '
                                                          "data_columns={'Spec': "
                                                          "'@1.0.1', 'ID': "
                                                          "'pyint',\n"
                                                          '                '
                                                          "'Details': {'Name': "
                                                          "'name', 'Address': "
                                                          "'address'}}, num_rows=2\n"
                                                          '        :sample: '
                                                          "data_columns={'Candidates': "
                                                          "['name', 'name', "
                                                          "'name']},\n"
                                                          '                '
                                                          'num_rows=1\n'
                                                          '        :sample: '
                                                          "data_columns=[('Name', "
                                                          "'name'), ('Points', "
                                                          "'pyint',\n"
                                                          '                '
                                                          "{'min_value': 50, "
                                                          "'max_value': 100})], "
                                                          'num_rows=1\n'
                                                          '        ',
                                                  'example': '[{"name": "Michael '
                                                             'Johnson", '
                                                             '"residency": "USCGC '
                                                             'Morgan\\nFPO AP '
                                                             '96813"}, {"name": '
                                                             '"Katherine Shaw", '
                                                             '"residency": "4165 '
                                                             'Tammie Pike Suite '
                                                             '368\\nEast '
                                                             'Kennethmouth, OK '
                                                             '73552"}, {"name": '
                                                             '"Erica Griffin MD", '
                                                             '"residency": "2861 '
                                                             'Boyd '
                                                             'Burgs\\nCastanedafurt, '
                                                             'MI 41326"}, {"name": '
                                                             '"Amber Velez", '
                                                             '"residency": "48919 '
                                                             'Pearson Flats Apt. '
                                                             '672\\nLake Jamie, NC '
                                                             '05994"}, {"name": '
                                                             '"Jenna Bullock", '
                                                             '"residency": "2752 '
                                                             'Wells Canyon Apt. '
                                                             '593\\nLynnhaven, KS '
                                                             '95682"}, {"name": '
                                                             '"Jaime Jones", '
                                                             '"residency": "807 '
                                                             'Christine '
                                                             'Walk\\nMoranchester, '
                                                             'MP 33847"}, {"name": '
                                                             '"Anthony King", '
                                                             '"residency": "7320 '
                                                             'Castro Mountains Apt. '
                                                             '664\\nPort Emily, KY '
                                                             '20089"}, {"name": '
                                                             '"Teresa Adams", '
                                                             '"residency": "468 '
                                                             'Mosley Cliff\\nLake '
                                                             'Lindaberg, NY '
                                                             '43676"}, {"name": '
                                                             '"Virginia Orozco", '
                                                             '"residency": "Unit '
                                                             '9411 Box 4720\\nDPO '
                                                             'AE 30079"}, {"name": '
                                                             '"Nancy Cooper", '
                                                             '"residency": "03476 '
                                                             'Mckinney Motorway '
                                                             'Apt. '
                                                             '406\\nSophialand, MT '
                                                             '33641"}]',
                                                  'type': 'str'},
                                      'json_bytes': {   'docs': '\n'
                                                                '        Generate '
                                                                'random JSON '
                                                                'structure and '
                                                                'return as bytes.\n'
                                                                '\n'
                                                                '        For more '
                                                                'information on the '
                                                                'different '
                                                                'arguments of this '
                                                                'method, refer to\n'
                                                                '        '
                                                                ':meth:`json() '
                                                                '<faker.providers.misc.Provider.json>` '
                                                                'which is used '
                                                                'under the hood.\n'
                                                                '        ',
                                                        'example': b'[{"name": "M'
                                                                   b'elissa Hughe'
                                                                   b's", "residen'
                                                                   b'cy": "543 Er'
                                                                   b'ic Locks Sui'
                                                                   b'te 067\\nEast'
                                                                   b' Brian, ME 0'
                                                                   b'9216"}, {"na'
                                                                   b'me": "David '
                                                                   b'Johnson", "r'
                                                                   b'esidency": "'
                                                                   b'660 Eric Squ'
                                                                   b'ares Apt. 68'
                                                                   b'2\\nZamorache'
                                                                   b'ster, NV 273'
                                                                   b'05"}, {"name'
                                                                   b'": "Marc Mur'
                                                                   b'ray", "resid'
                                                                   b'ency": "2300'
                                                                   b' Alyssa Pass'
                                                                   b'age\\nJohnvil'
                                                                   b'le, ND 70305'
                                                                   b'"}, {"name":'
                                                                   b' "Aaron Nava'
                                                                   b'rro", "resid'
                                                                   b'ency": "PSC '
                                                                   b'3772, Box 01'
                                                                   b'26\\nAPO AE 6'
                                                                   b'0410"}, {"na'
                                                                   b'me": "Lauren'
                                                                   b' Newman", "r'
                                                                   b'esidency": "'
                                                                   b'5227 Griffin'
                                                                   b' Brooks Apt.'
                                                                   b' 132\\nEast D'
                                                                   b'aniel, MD 80'
                                                                   b'656"}, {"nam'
                                                                   b'e": "Wyatt L'
                                                                   b'am II", "res'
                                                                   b'idency": "US'
                                                                   b'CGC Reyes\\nF'
                                                                   b'PO AE 38638"'
                                                                   b'}, {"name": '
                                                                   b'"Robert Smit'
                                                                   b'h", "residen'
                                                                   b'cy": "18238 '
                                                                   b'Jacqueline L'
                                                                   b'odge Suite 6'
                                                                   b'90\\nAprilber'
                                                                   b'g, OK 87951"'
                                                                   b'}, {"name": '
                                                                   b'"Michael Joh'
                                                                   b'nson", "resi'
                                                                   b'dency": "714'
                                                                   b'81 Shannon S'
                                                                   b'hoals Apt. 1'
                                                                   b'74\\nWest Cat'
                                                                   b'hyshire, GU '
                                                                   b'46469"}, {"n'
                                                                   b'ame": "Antho'
                                                                   b'ny Jackson",'
                                                                   b' "residency"'
                                                                   b': "38794 Mar'
                                                                   b'k Circles\\nW'
                                                                   b'est Elizabet'
                                                                   b'h, WI 49087"'
                                                                   b'}, {"name": '
                                                                   b'"Jonathan Co'
                                                                   b'llins", "res'
                                                                   b'idency": "20'
                                                                   b'927 Harold B'
                                                                   b'ypass Suite '
                                                                   b'241\\nBarbara'
                                                                   b'ton, WA 3407'
                                                                   b'7"}]',
                                                        'type': 'bytes'},
                                      'md5': {   'docs': 'Generate a random MD5 '
                                                         'hash.\n'
                                                         '\n'
                                                         '        If ``raw_output`` '
                                                         'is ``False`` (default), a '
                                                         'hexadecimal string '
                                                         'representation of the MD5 '
                                                         'hash\n'
                                                         '        will be returned. '
                                                         'If ``True``, a ``bytes`` '
                                                         'object representation '
                                                         'will be returned '
                                                         'instead.\n'
                                                         '\n'
                                                         '        :sample: '
                                                         'raw_output=False\n'
                                                         '        :sample: '
                                                         'raw_output=True\n'
                                                         '        ',
                                                 'example': 'c55729f84a9951c969ba38b0e4ad6077',
                                                 'type': 'str'},
                                      'null_boolean': {   'docs': 'Generate '
                                                                  '``None``, '
                                                                  '``True``, or '
                                                                  '``False``, each '
                                                                  'with equal '
                                                                  'probability.',
                                                          'example': True,
                                                          'type': 'bool'},
                                      'password': {   'docs': 'Generate a random '
                                                              'password of the '
                                                              'specified '
                                                              '``length``.\n'
                                                              '\n'
                                                              '        The '
                                                              'arguments '
                                                              '``special_chars``, '
                                                              '``digits``, '
                                                              '``upper_case``, and '
                                                              '``lower_case`` '
                                                              'control\n'
                                                              '        what '
                                                              'category of '
                                                              'characters will '
                                                              'appear in the '
                                                              'generated password. '
                                                              'If set to ``True``\n'
                                                              '        (default), '
                                                              'at least one '
                                                              'character from the '
                                                              'corresponding '
                                                              'category is '
                                                              'guaranteed to '
                                                              'appear.\n'
                                                              '        Special '
                                                              'characters are '
                                                              'characters from '
                                                              '``!@#$%^&*()_+``, '
                                                              'digits are '
                                                              'characters from\n'
                                                              '        '
                                                              '``0123456789``, and '
                                                              'uppercase and '
                                                              'lowercase characters '
                                                              'are characters from '
                                                              'the ASCII set of\n'
                                                              '        letters.\n'
                                                              '\n'
                                                              '        :sample: '
                                                              'length=12\n'
                                                              '        :sample: '
                                                              'length=40, '
                                                              'special_chars=False, '
                                                              'upper_case=False\n'
                                                              '        ',
                                                      'example': 'o^3ZPd%FJc',
                                                      'type': 'str'},
                                      'psv': {   'docs': 'Generate random '
                                                         'pipe-separated values.\n'
                                                         '\n'
                                                         '        For more '
                                                         'information on the '
                                                         'different arguments of '
                                                         'this method, please refer '
                                                         'to\n'
                                                         '        :meth:`dsv() '
                                                         '<faker.providers.misc.Provider.dsv>` '
                                                         'which is used under the '
                                                         'hood.\n'
                                                         '\n'
                                                         '        :sample: '
                                                         "data_columns=('{{name}}', "
                                                         "'{{address}}'), "
                                                         'num_rows=10, '
                                                         'include_row_ids=False\n'
                                                         '        :sample: '
                                                         "header=('Name', "
                                                         "'Address', 'Favorite "
                                                         "Color'),\n"
                                                         '                '
                                                         "data_columns=('{{name}}', "
                                                         "'{{address}}', "
                                                         "'{{safe_color_name}}'),\n"
                                                         '                '
                                                         'num_rows=10, '
                                                         'include_row_ids=True\n'
                                                         '        ',
                                                 'example': '"Rachael '
                                                            'Williams"|"29069 '
                                                            'English Oval Apt. 470\n'
                                                            'North Rhondafort, MI '
                                                            '09801"\r\n'
                                                            '"Richard Terry"|"230 '
                                                            'Jackson Estate\n'
                                                            'Sheilafurt, FM '
                                                            '10591"\r\n'
                                                            '"Duane Bell"|"3150 '
                                                            'Aaron Divide Apt. 739\n'
                                                            'Arroyoshire, MI '
                                                            '71112"\r\n'
                                                            '"Shannon '
                                                            'Atkinson"|"PSC 2436, '
                                                            'Box 3363\n'
                                                            'APO AP 26149"\r\n'
                                                            '"Randy Robinson"|"8832 '
                                                            'Jermaine Fort\n'
                                                            'Danachester, VT '
                                                            '83040"\r\n'
                                                            '"Mark Diaz"|"63582 '
                                                            'Robertson Union Suite '
                                                            '096\n'
                                                            'East Michele, NC '
                                                            '42727"\r\n'
                                                            '"Johnathan '
                                                            'Davies"|"1689 Pittman '
                                                            'Extension Apt. 870\n'
                                                            'East Leahfort, MI '
                                                            '16086"\r\n'
                                                            '"Stacy Sanchez"|"52818 '
                                                            'Kenneth Dale\n'
                                                            'Clinefort, OK '
                                                            '40288"\r\n'
                                                            '"Brenda Miller"|"9786 '
                                                            'Moore Valleys Apt. '
                                                            '900\n'
                                                            'Ronaldton, AL '
                                                            '07971"\r\n'
                                                            '"Maria Meyers"|"Unit '
                                                            '4793 Box 6761\n'
                                                            'DPO AP 38457"\r\n',
                                                 'type': 'str'},
                                      'sha1': {   'docs': 'Generate a random SHA-1 '
                                                          'hash.\n'
                                                          '\n'
                                                          '        If '
                                                          '``raw_output`` is '
                                                          '``False`` (default), a '
                                                          'hexadecimal string '
                                                          'representation of the '
                                                          'SHA-1 hash\n'
                                                          '        will be '
                                                          'returned. If ``True``, a '
                                                          '``bytes`` object '
                                                          'representation will be '
                                                          'returned instead.\n'
                                                          '\n'
                                                          '        :sample: '
                                                          'raw_output=False\n'
                                                          '        :sample: '
                                                          'raw_output=True\n'
                                                          '        ',
                                                  'example': '40c4e33255ca98193401dd6d6c0529e90c00771a',
                                                  'type': 'str'},
                                      'sha256': {   'docs': 'Generate a random '
                                                            'SHA-256 hash.\n'
                                                            '\n'
                                                            '        If '
                                                            '``raw_output`` is '
                                                            '``False`` (default), a '
                                                            'hexadecimal string '
                                                            'representation of the '
                                                            'SHA-256 hash\n'
                                                            '        will be '
                                                            'returned. If ``True``, '
                                                            'a ``bytes`` object '
                                                            'representation will be '
                                                            'returned instead.\n'
                                                            '\n'
                                                            '        :sample: '
                                                            'raw_output=False\n'
                                                            '        :sample: '
                                                            'raw_output=True\n'
                                                            '        ',
                                                    'example': 'f9c7a87bb0c5642a6bc819ae504fe2062f9c35f14765c5d8e3010f77b019960f',
                                                    'type': 'str'},
                                      'tar': {   'docs': 'Generate a bytes object '
                                                         'containing a random valid '
                                                         'tar file.\n'
                                                         '\n'
                                                         '        The number and '
                                                         'sizes of files contained '
                                                         'inside the resulting '
                                                         'archive can be '
                                                         'controlled\n'
                                                         '        using the '
                                                         'following arguments:\n'
                                                         '\n'
                                                         '        - '
                                                         '``uncompressed_size`` - '
                                                         'the total size of files '
                                                         'before compression, 16 '
                                                         'KiB by default\n'
                                                         '        - ``num_files`` - '
                                                         'the number of files '
                                                         'archived in resulting zip '
                                                         'file, 1 by default\n'
                                                         '        - '
                                                         '``min_file_size`` - the '
                                                         'minimum size of each file '
                                                         'before compression, 4 KiB '
                                                         'by default\n'
                                                         '\n'
                                                         '        No compression is '
                                                         'used by default, but '
                                                         'setting ``compression`` '
                                                         'to one of the values '
                                                         'listed\n'
                                                         '        below will use '
                                                         'the corresponding '
                                                         'compression type.\n'
                                                         '\n'
                                                         "        - ``'bzip2'`` or "
                                                         "``'bz2'`` for BZIP2\n"
                                                         "        - ``'lzma'`` or "
                                                         "``'xz'`` for LZMA\n"
                                                         "        - ``'gzip'`` or "
                                                         "``'gz'`` for GZIP\n"
                                                         '\n'
                                                         '        :sample: '
                                                         'uncompressed_size=256, '
                                                         'num_files=4, '
                                                         'min_file_size=32\n'
                                                         '        :sample: '
                                                         'uncompressed_size=256, '
                                                         'num_files=32, '
                                                         'min_file_size=4, '
                                                         "compression='bz2'\n"
                                                         '        ',
                                                 'example': 'No example (output too '
                                                            'long)',
                                                 'type': None},
                                      'tsv': {   'docs': 'Generate random '
                                                         'tab-separated values.\n'
                                                         '\n'
                                                         '        For more '
                                                         'information on the '
                                                         'different arguments of '
                                                         'this method, please refer '
                                                         'to\n'
                                                         '        :meth:`dsv() '
                                                         '<faker.providers.misc.Provider.dsv>` '
                                                         'which is used under the '
                                                         'hood.\n'
                                                         '\n'
                                                         '        :sample: '
                                                         "data_columns=('{{name}}', "
                                                         "'{{address}}'), "
                                                         'num_rows=10, '
                                                         'include_row_ids=False\n'
                                                         '        :sample: '
                                                         "header=('Name', "
                                                         "'Address', 'Favorite "
                                                         "Color'),\n"
                                                         '                '
                                                         "data_columns=('{{name}}', "
                                                         "'{{address}}', "
                                                         "'{{safe_color_name}}'),\n"
                                                         '                '
                                                         'num_rows=10, '
                                                         'include_row_ids=True\n'
                                                         '        ',
                                                 'example': '"Ann Sanders"\t"362 '
                                                            'Richard Harbors Suite '
                                                            '878\n'
                                                            'New Keithshire, WA '
                                                            '69900"\r\n'
                                                            '"Jackie Boyd"\t"77690 '
                                                            'Dana Rue\n'
                                                            'Hicksside, DC '
                                                            '65982"\r\n'
                                                            '"Christine Hall"\t'
                                                            '"7017 Angel Roads\n'
                                                            'Silvaland, GU '
                                                            '41327"\r\n'
                                                            '"Michael Johnson"\t'
                                                            '"4217 Goodwin Canyon\n'
                                                            'Lake Jacqueline, MA '
                                                            '84870"\r\n'
                                                            '"James Johnson"\t'
                                                            '"17905 Eric Groves '
                                                            'Apt. 547\n'
                                                            'West Mauricebury, KY '
                                                            '52477"\r\n'
                                                            '"Mark Mendez"\t"733 '
                                                            'Alexandra Knoll Suite '
                                                            '813\n'
                                                            'New Joseburgh, FM '
                                                            '70191"\r\n'
                                                            '"Duane Ellison"\t"616 '
                                                            'Gill Ramp\n'
                                                            'North Jessica, VI '
                                                            '95588"\r\n'
                                                            '"Morgan Wolf"\t"2137 '
                                                            'Joshua Bridge\n'
                                                            'Jacobtown, NV '
                                                            '25763"\r\n'
                                                            '"Zoe Adkins"\t"8531 '
                                                            'Shelia Locks\n'
                                                            'South Scott, PA '
                                                            '67070"\r\n'
                                                            '"Jay Lewis"\t"5716 Roy '
                                                            'Club Apt. 575\n'
                                                            'East Anthonyton, NV '
                                                            '43469"\r\n',
                                                 'type': 'str'},
                                      'uuid4': {   'docs': 'Generate a random UUID4 '
                                                           'object and cast it to '
                                                           'another type if '
                                                           'specified using a '
                                                           'callable ``cast_to``.\n'
                                                           '\n'
                                                           '        By default, '
                                                           '``cast_to`` is set to '
                                                           '``str``.\n'
                                                           '\n'
                                                           '        May be called '
                                                           'with ``cast_to=None`` '
                                                           'to return a '
                                                           'full-fledged ``UUID``.\n'
                                                           '\n'
                                                           '        :sample:\n'
                                                           '        :sample: '
                                                           'cast_to=None\n'
                                                           '        ',
                                                   'example': 'ce1b135a-1d21-4baf-824b-a0bae9ad6486',
                                                   'type': 'str'},
                                      'xml': {   'docs': '\n'
                                                         '        Returns some '
                                                         'XML.\n'
                                                         '\n'
                                                         '        :nb_elements: '
                                                         'number of elements for '
                                                         'dictionary\n'
                                                         '        '
                                                         ':variable_nb_elements: is '
                                                         'use variable number of '
                                                         'elements for dictionary\n'
                                                         '        :value_types: '
                                                         'type of dictionary '
                                                         'values\n'
                                                         '\n'
                                                         '        Note: this '
                                                         'provider required '
                                                         'xmltodict library '
                                                         'installed\n'
                                                         '        ',
                                                 'example': 'No example (module not '
                                                            'found)',
                                                 'type': None},
                                      'zip': {   'docs': 'Generate a bytes object '
                                                         'containing a random valid '
                                                         'zip archive file.\n'
                                                         '\n'
                                                         '        The number and '
                                                         'sizes of files contained '
                                                         'inside the resulting '
                                                         'archive can be '
                                                         'controlled\n'
                                                         '        using the '
                                                         'following arguments:\n'
                                                         '\n'
                                                         '        - '
                                                         '``uncompressed_size`` - '
                                                         'the total size of files '
                                                         'before compression, 16 '
                                                         'KiB by default\n'
                                                         '        - ``num_files`` - '
                                                         'the number of files '
                                                         'archived in resulting zip '
                                                         'file, 1 by default\n'
                                                         '        - '
                                                         '``min_file_size`` - the '
                                                         'minimum size of each file '
                                                         'before compression, 4 KiB '
                                                         'by default\n'
                                                         '\n'
                                                         '        No compression is '
                                                         'used by default, but '
                                                         'setting ``compression`` '
                                                         'to one of the values '
                                                         'listed\n'
                                                         '        below will use '
                                                         'the corresponding '
                                                         'compression type.\n'
                                                         '\n'
                                                         "        - ``'bzip2'`` or "
                                                         "``'bz2'`` for BZIP2\n"
                                                         "        - ``'lzma'`` or "
                                                         "``'xz'`` for LZMA\n"
                                                         "        - ``'deflate'``, "
                                                         "``'gzip'``, or ``'gz'`` "
                                                         'for GZIP\n'
                                                         '\n'
                                                         '        :sample: '
                                                         'uncompressed_size=256, '
                                                         'num_files=4, '
                                                         'min_file_size=32\n'
                                                         '        :sample: '
                                                         'uncompressed_size=256, '
                                                         'num_files=32, '
                                                         'min_file_size=4, '
                                                         "compression='bz2'\n"
                                                         '        ',
                                                 'example': 'No example (output too '
                                                            'long)',
                                                 'type': None}},
    'faker.providers.passport.en_US': {   'passport_dates': {   'docs': 'Generates '
                                                                        'a '
                                                                        'formatted '
                                                                        'date of '
                                                                        'birth, '
                                                                        'issue, and '
                                                                        'expiration '
                                                                        'dates.\n'
                                                                        '        '
                                                                        'issue and '
                                                                        'expiration '
                                                                        'dates are '
                                                                        'conditioned '
                                                                        'to fall '
                                                                        'within '
                                                                        'U.S. '
                                                                        'standards '
                                                                        'of 5 and '
                                                                        '10 year '
                                                                        'expirations\n'
                                                                        '\n'
                                                                        '\n'
                                                                        '        '
                                                                        'The '
                                                                        '``birthday`` '
                                                                        'argument '
                                                                        'is a '
                                                                        'datetime.date '
                                                                        'object '
                                                                        'representing '
                                                                        'a date of '
                                                                        'birth.\n'
                                                                        '\n'
                                                                        '        '
                                                                        'Sources:\n'
                                                                        '\n'
                                                                        '        '
                                                                        '-https://travel.state.gov/content/travel/en/passports/passport-help/faqs.html\n'
                                                                        '        ',
                                                                'example': (   '19 '
                                                                               'Sep '
                                                                               '2025',
                                                                               '19 '
                                                                               'Sep '
                                                                               '2025',
                                                                               '19 '
                                                                               'Sep '
                                                                               '2030'),
                                                                'type': 'tuple'},
                                          'passport_dob': {   'docs': 'Generate a '
                                                                      'datetime '
                                                                      'date of '
                                                                      'birth.',
                                                              'example': datetime.date(1926, 4, 17),
                                                              'type': 'date'},
                                          'passport_full': {   'docs': 'Generates a '
                                                                       'formatted '
                                                                       'sting with '
                                                                       'US Passport '
                                                                       'information',
                                                               'example': 'Samuel\n'
                                                                          'Beltran\n'
                                                                          'M\n'
                                                                          '15 Aug '
                                                                          '1918\n'
                                                                          '21 Apr '
                                                                          '2024\n'
                                                                          '21 Apr '
                                                                          '2034\n'
                                                                          '100536730\n',
                                                               'type': 'str'},
                                          'passport_gender': {   'docs': 'Generates '
                                                                         'a string '
                                                                         'representing '
                                                                         'the '
                                                                         'gender '
                                                                         'displayed '
                                                                         'on a '
                                                                         'passport\n'
                                                                         '\n'
                                                                         '        '
                                                                         'Sources:\n'
                                                                         '\n'
                                                                         '        - '
                                                                         'https://williamsinstitute.law.ucla.edu/publications/x-gender-markers-passports/\n'
                                                                         '        ',
                                                                 'example': 'M',
                                                                 'type': 'str'},
                                          'passport_number': {   'docs': 'Generate '
                                                                         'a '
                                                                         'passport '
                                                                         'number by '
                                                                         'replacing '
                                                                         'tokens to '
                                                                         'be '
                                                                         'alphanumeric',
                                                                 'example': 'W51864095',
                                                                 'type': 'str'},
                                          'passport_owner': {   'docs': 'Generate a '
                                                                        'given_name '
                                                                        'and '
                                                                        'surname '
                                                                        'for a '
                                                                        'passport '
                                                                        'owner\n'
                                                                        '        '
                                                                        'The '
                                                                        '``gender`` '
                                                                        'argument '
                                                                        'is the '
                                                                        'gender '
                                                                        'marker of '
                                                                        'a passport '
                                                                        'owner, '
                                                                        'which is a '
                                                                        'one '
                                                                        'character '
                                                                        'string\n'
                                                                        '        '
                                                                        'that is '
                                                                        'either '
                                                                        'male, '
                                                                        'female, or '
                                                                        'non-binary.\n'
                                                                        '        ',
                                                                'example': (   'Jennifer',
                                                                               'Hammond'),
                                                                'type': 'tuple'}},
    'faker.providers.person.en_US': {   'first_name': {   'docs': None,
                                                          'example': 'Joseph',
                                                          'type': 'str'},
                                        'first_name_female': {   'docs': None,
                                                                 'example': 'Paige',
                                                                 'type': 'str'},
                                        'first_name_male': {   'docs': None,
                                                               'example': 'Daniel',
                                                               'type': 'str'},
                                        'first_name_nonbinary': {   'docs': None,
                                                                    'example': 'Joel',
                                                                    'type': 'str'},
                                        'language_name': {   'docs': 'Generate a '
                                                                     'random i18n '
                                                                     'language name '
                                                                     '(e.g. '
                                                                     'English).',
                                                             'example': 'Slovenian',
                                                             'type': 'str'},
                                        'last_name': {   'docs': None,
                                                         'example': 'Baker',
                                                         'type': 'str'},
                                        'last_name_female': {   'docs': None,
                                                                'example': 'Lucero',
                                                                'type': 'str'},
                                        'last_name_male': {   'docs': None,
                                                              'example': 'Johnson',
                                                              'type': 'str'},
                                        'last_name_nonbinary': {   'docs': None,
                                                                   'example': 'Holt',
                                                                   'type': 'str'},
                                        'name': {   'docs': '\n'
                                                            '        :example: '
                                                            "'John Doe'\n"
                                                            '        ',
                                                    'example': 'Jerome Rowland',
                                                    'type': 'str'},
                                        'name_female': {   'docs': None,
                                                           'example': 'Rachel '
                                                                      'Johnston',
                                                           'type': 'str'},
                                        'name_male': {   'docs': None,
                                                         'example': 'Trevor Tucker',
                                                         'type': 'str'},
                                        'name_nonbinary': {   'docs': None,
                                                              'example': 'Ronald '
                                                                         'Rivera',
                                                              'type': 'str'},
                                        'prefix': {   'docs': None,
                                                      'example': 'Mrs.',
                                                      'type': 'str'},
                                        'prefix_female': {   'docs': None,
                                                             'example': 'Mrs.',
                                                             'type': 'str'},
                                        'prefix_male': {   'docs': None,
                                                           'example': 'Mr.',
                                                           'type': 'str'},
                                        'prefix_nonbinary': {   'docs': None,
                                                                'example': 'Mx.',
                                                                'type': 'str'},
                                        'suffix': {   'docs': None,
                                                      'example': 'PhD',
                                                      'type': 'str'},
                                        'suffix_female': {   'docs': None,
                                                             'example': 'PhD',
                                                             'type': 'str'},
                                        'suffix_male': {   'docs': None,
                                                           'example': 'III',
                                                           'type': 'str'},
                                        'suffix_nonbinary': {   'docs': None,
                                                                'example': 'DDS',
                                                                'type': 'str'}},
    'faker.providers.phone_number.en_US': {   'basic_phone_number': {   'docs': None,
                                                                        'example': '(380)640-0999',
                                                                        'type': 'str'},
                                              'country_calling_code': {   'docs': None,
                                                                          'example': '+966',
                                                                          'type': 'str'},
                                              'msisdn': {   'docs': 'https://en.wikipedia.org/wiki/MSISDN',
                                                            'example': '8501167069485',
                                                            'type': 'str'},
                                              'phone_number': {   'docs': None,
                                                                  'example': '476.752.4578x170',
                                                                  'type': 'str'}},
    'faker.providers.profile': {   'profile': {   'docs': '\n'
                                                          '        Generates a '
                                                          'complete profile.\n'
                                                          '        If "fields" is '
                                                          'not empty, only the '
                                                          'fields in the list will '
                                                          'be returned\n'
                                                          '        ',
                                                  'example': {   'address': '0844 '
                                                                            'Carpenter '
                                                                            'Row '
                                                                            'Suite '
                                                                            '840\n'
                                                                            'North '
                                                                            'Jamesmouth, '
                                                                            'VT '
                                                                            '67247',
                                                                 'birthdate': datetime.date(1911, 4, 12),
                                                                 'blood_group': 'AB+',
                                                                 'company': 'Nielsen '
                                                                            'Ltd',
                                                                 'current_location': (   Decimal('11.396665'),
                                                                                         Decimal('166.581197')),
                                                                 'job': 'Librarian, '
                                                                        'public',
                                                                 'mail': 'gutierrezdonna@hotmail.com',
                                                                 'name': 'Kevin '
                                                                         'Dickson',
                                                                 'residence': '54812 '
                                                                              'Pratt '
                                                                              'Inlet '
                                                                              'Apt. '
                                                                              '885\n'
                                                                              'Kellyview, '
                                                                              'FM '
                                                                              '00544',
                                                                 'sex': 'M',
                                                                 'ssn': '756-87-8888',
                                                                 'username': 'alyssa59',
                                                                 'website': [   'http://robertson.com/',
                                                                                'http://mcclain.com/',
                                                                                'http://www.reyes-gonzalez.com/']},
                                                  'type': 'dict'},
                                   'simple_profile': {   'docs': '\n'
                                                                 '        Generates '
                                                                 'a basic profile '
                                                                 'with personal '
                                                                 'information\n'
                                                                 '        ',
                                                         'example': {   'address': '167 '
                                                                                   'Wayne '
                                                                                   'Mountains\n'
                                                                                   'Catherineport, '
                                                                                   'MS '
                                                                                   '53757',
                                                                        'birthdate': datetime.date(1955, 4, 2),
                                                                        'mail': 'michael27@yahoo.com',
                                                                        'name': 'Shannon '
                                                                                'Lawrence',
                                                                        'sex': 'F',
                                                                        'username': 'nicole14'},
                                                         'type': 'dict'}},
    'faker.providers.python': {   'enum': {   'docs': '\n'
                                                      '        Returns a random '
                                                      'enum of the provided input '
                                                      '`Enum` type.\n'
                                                      '\n'
                                                      '        :param enum_cls: The '
                                                      '`Enum` type to produce the '
                                                      'value for.\n'
                                                      '        :returns: A randomly '
                                                      'selected enum value.\n'
                                                      '        ',
                                              'example': 'No example (method has '
                                                         'non-default args)',
                                              'type': None},
                                  'pybool': {   'docs': '\n'
                                                        '        Generates a random '
                                                        'boolean, optionally biased '
                                                        'towards `True` or '
                                                        '`False`.\n'
                                                        '\n'
                                                        '        '
                                                        ':truth_probability: '
                                                        'Probability of generating '
                                                        'a `True` value. Must be '
                                                        'between `0` and `100` '
                                                        "inclusive'.\n"
                                                        '        :return: Random '
                                                        'boolean.\n'
                                                        '        :raises '
                                                        'ValueError: If invalid '
                                                        '`truth_probability` is '
                                                        'provided.\n'
                                                        '        ',
                                                'example': True,
                                                'type': 'bool'},
                                  'pydecimal': {   'docs': None,
                                                   'example': Decimal('-6563317845903354450790463153023791534196252443202030054713488645391341321014883746534722950.271093647005646312049038605876951901302629335721465775071334677798783724927602850298'),
                                                   'type': 'Decimal'},
                                  'pydict': {   'docs': '\n'
                                                        '        Returns a '
                                                        'dictionary.\n'
                                                        '\n'
                                                        '        :nb_elements: '
                                                        'number of elements for '
                                                        'dictionary\n'
                                                        '        '
                                                        ':variable_nb_elements: is '
                                                        'use variable number of '
                                                        'elements for dictionary\n'
                                                        '        :value_types: type '
                                                        'of dictionary values\n'
                                                        '        ',
                                                'example': {   'Mrs': 'rMilbMhBFfXodNpNoKlk',
                                                               'Republican': 'KyuuTjtnlFhLJnHbwkVW',
                                                               'add': 'http://www.rhodes-mcdonald.com/search/categoriespost.jsp',
                                                               'attention': 'NGIofldrdCivKyufLvGL',
                                                               'experience': 1080,
                                                               'other': 1113,
                                                               'partner': 4348,
                                                               'possible': 'UienvtAudFiaJieCIQBo',
                                                               'respond': Decimal('2192165514830290877313333340.241754110752542432694800886606569665215230057289903097906058315')},
                                                'type': 'dict'},
                                  'pyfloat': {   'docs': None,
                                                 'example': 392867.989998741,
                                                 'type': 'float'},
                                  'pyint': {   'docs': None,
                                               'example': 867,
                                               'type': 'int'},
                                  'pyiterable': {   'docs': None,
                                                    'example': {   -1.60455957198707,
                                                                   1895,
                                                                   5483.18885087683,
                                                                   Decimal('43069634230756536.61436310575753205899162576412282441475183150819513911863674'),
                                                                   'WiOwIWxJDYdxwkRrtWNI',
                                                                   'gzWnmMfmQuybmUftIBwd',
                                                                   'nNIjBBPCZMRYadcCOkKU'},
                                                    'type': 'set'},
                                  'pylist': {   'docs': None,
                                                'example': [   datetime.datetime(2001, 2, 22, 16, 59, 59, 813978),
                                                               7898,
                                                               1884,
                                                               'http://medina.com/wp-content/bloghomepage.php',
                                                               'lTLIulZeBpYwvWFcUWpM',
                                                               'bross@example.org',
                                                               'http://martinez.com/app/category/categorycategory.php',
                                                               'hubbardjason@example.com',
                                                               76,
                                                               'RxjviFDpXUDvfKpqhNwL',
                                                               'http://www.wu-lopez.net/posts/explorefaq.php',
                                                               'rwySwReACveLZJpvtxXX'],
                                                'type': 'list'},
                                  'pyobject': {   'docs': '\n'
                                                          '        Generates a '
                                                          'random object passing '
                                                          'the type desired.\n'
                                                          '\n'
                                                          '        :object_type: '
                                                          'the type of the object '
                                                          'to generate.\n'
                                                          '        :return: the '
                                                          'random object '
                                                          'generated.\n'
                                                          '        :raises '
                                                          'ValueError: if the '
                                                          'object type passed is '
                                                          'not supported\n'
                                                          '        ',
                                                  'example': None,
                                                  'type': 'NoneType'},
                                  'pyset': {   'docs': None,
                                               'example': {   datetime.datetime(1979, 5, 31, 18, 12, 14, 255684),
                                                              datetime.datetime(1979, 8, 15, 12, 52, 17, 709098),
                                                              410,
                                                              4341,
                                                              6499,
                                                              'FjlPgZkalsDddRhjVpZL',
                                                              'JKNALyqJAUanyDxDLhdg',
                                                              'OweUWHwhkCtCjrYrwnCE',
                                                              'rhobbs@example.net'},
                                               'type': 'set'},
                                  'pystr': {   'docs': '\n'
                                                       '        Generates a random '
                                                       'string of upper and '
                                                       'lowercase letters.\n'
                                                       '\n'
                                                       '        :param min_chars: '
                                                       'minimum length of the '
                                                       'random part.\n'
                                                       '        :param max_chars: '
                                                       'maximum length of the '
                                                       'random part.\n'
                                                       '        :param prefix: an '
                                                       'optional prefix to prepend '
                                                       'to the random string.\n'
                                                       '        :param suffix: an '
                                                       'optional suffix to append '
                                                       'to the random string.\n'
                                                       '        :return: Random of '
                                                       'random length between min '
                                                       'and max characters.\n'
                                                       '        ',
                                               'example': 'XBTGSERRFOeoOhbKszhn',
                                               'type': 'str'},
                                  'pystr_format': {   'docs': None,
                                                      'example': 'w3-9803643f',
                                                      'type': 'str'},
                                  'pystruct': {   'docs': None,
                                                  'example': (   [   'http://www.fox-thomas.info/list/tag/appcategory.asp',
                                                                     Decimal('-747954933717757072587990290574395471668879422533977950810050405819467000743442169458262245002871'),
                                                                     'lUzWHuZSZrZStvABXTOd',
                                                                     355,
                                                                     -7216889145.91708,
                                                                     'ZfYTjPvZraaBlsYwNOYH',
                                                                     2455,
                                                                     'UmrxwPosQoMbEhaeAuXS',
                                                                     'https://brown.com/app/list/exploresearch.htm',
                                                                     Decimal('852955828189748428479858311677393959881363346025293759512915685303521755375178899442007986932.029039704314626034611')],
                                                                 {   'buy': 'mtFIAIqPaWCXSmBLbabD',
                                                                     'face': 'https://murray-coleman.com/posts/wp-content/blogindex.php',
                                                                     'industry': 'bQCIrzxBRaVlnYhyriqa',
                                                                     'late': 'ncGtbnirkgiqgPZMYMKv',
                                                                     'or': datetime.datetime(2001, 11, 19, 23, 43, 21, 227818),
                                                                     'police': 'WkxGsEKhOPsGRquZHOTa',
                                                                     'race': 9060,
                                                                     'religious': datetime.datetime(1983, 11, 16, 9, 26, 16, 761038),
                                                                     'she': datetime.datetime(1985, 5, 3, 20, 58, 44, 97503),
                                                                     'something': 'zBYNDSQTHwIktOhRjmSv'},
                                                                 {   'among': {   0: datetime.datetime(2004, 2, 7, 0, 48, 30, 993116),
                                                                                  1: [   'WtIbKqITesQrqerTkmFw',
                                                                                         'jMdxZouUrOXbWcVIOZQB',
                                                                                         'http://www.mitchell.net/tagslogin.php'],
                                                                                  2: {   0: 1637,
                                                                                         1: 3132,
                                                                                         2: [   -37.5496710743769,
                                                                                                9162]}},
                                                                     'candidate': {   5: 'rMLQmsMiwTPvDgokCyUw',
                                                                                      6: [   'fdkUHvXMtcjsTdGVtuVy',
                                                                                             'http://www.odonnell-curtis.biz/category/explore/postshome.html',
                                                                                             'pjEPNlUcpLsalJKIuBsb'],
                                                                                      7: {   5: 'YXEfxbtxjYHoMNrHCkJe',
                                                                                             6: 'rsWeZbswdYRCkFyqmYQa',
                                                                                             7: [   'kaitlyn63@example.net',
                                                                                                    'hEktafJVtpawNXIAZZpP']}},
                                                                     'challenge': {   9: -90763.5774005788,
                                                                                      10: [   'YZIFqmbkchfWndlIBIKG',
                                                                                              -78.26061070009,
                                                                                              -9593.44438203211],
                                                                                      11: {   9: 'JOZLOoUYNbhtDEnMbYzX',
                                                                                              10: 6319,
                                                                                              11: [   5737435.6008459,
                                                                                                      8877]}},
                                                                     'exist': {   7: 'OZcVDSOTGOnJiWbpfFyV',
                                                                                  8: [   Decimal('20915335751856425966371945288917582309253948544258.5562592317463860'),
                                                                                         'hAMDIJgsJfhwnKvPZBAt',
                                                                                         -9.23200051473617],
                                                                                  9: {   7: 'SJhLJYGVgWTVRcSIYknF',
                                                                                         8: 4781,
                                                                                         9: [   datetime.datetime(1973, 5, 29, 10, 14, 34, 759255),
                                                                                                8307]}},
                                                                     'face': {   1: 'UjbzBjIpIHsjhksCtLqX',
                                                                                 2: [   Decimal('-43266021243179032718099843124871994312056212366074339391696089770.69028614178548341654129812360303880617'),
                                                                                        9304,
                                                                                        703],
                                                                                 3: {   1: datetime.datetime(1973, 6, 22, 22, 41, 14, 331761),
                                                                                        2: 'iiGmAmfTRKnNdAzpkmut',
                                                                                        3: [   Decimal('3208151447304364100836202925253260340162194891920239716172.88011436270497700179690781392183312481460155288280470568816287517718'),
                                                                                               datetime.datetime(2004, 10, 29, 10, 34, 55, 65230)]}},
                                                                     'firm': {   4: 342,
                                                                                 5: [   'BqMzwQbsUdBeHMrTwNgd',
                                                                                        'xwatson@example.org',
                                                                                        datetime.datetime(1972, 7, 18, 18, 29, 35, 852676)],
                                                                                 6: {   4: Decimal('-284108636640374045117717551430847185650273589208065791754836605875958537528072701.552211113729602556966886037102459753472149851612924177268638984655032434413481252378729079390215'),
                                                                                        5: 6244,
                                                                                        6: [   'BbyIPWEjEatWocZOcoxr',
                                                                                               'https://walker-miller.com/app/apphome.htm']}},
                                                                     'need': {   2: 9559,
                                                                                 3: [   -95612516.3426768,
                                                                                        'https://may-sloan.com/listprivacy.htm',
                                                                                        'AVxWKfBKHVcdIcwFQyvV'],
                                                                                 4: {   2: 'acHhfKyGBNzGwyQNMJZV',
                                                                                        3: 121,
                                                                                        4: [   'https://www.johnson.org/appabout.htm',
                                                                                               -44648116465921.4]}},
                                                                     'page': {   3: 'WxORnRRtjQGRlqRpBPCJ',
                                                                                 4: [   7156,
                                                                                        'zVRmUyneXlsExxxlrTbY',
                                                                                        1304],
                                                                                 5: {   3: 4861325171450.28,
                                                                                        4: 'gskkfFPnuqPfMgolEAwE',
                                                                                        5: [   Decimal('139277792553237108205495498401532599059451556.51404943640758'),
                                                                                               datetime.datetime(2024, 7, 24, 14, 24, 43, 931779)]}},
                                                                     'real': {   8: Decimal('4575068444063.781442099290139656255289736308'),
                                                                                 9: [   'http://johnson-flowers.com/categoryprivacy.htm',
                                                                                        datetime.datetime(2021, 4, 30, 15, 15, 56, 357910),
                                                                                        'http://diaz.com/category/poststerms.jsp'],
                                                                                 10: {   8: 'PIxvEJUyLULnBPoqjGEL',
                                                                                         9: 8817,
                                                                                         10: [   'ymySGtNcNDSxPmFPJiYe',
                                                                                                 2034]}},
                                                                     'standard': {   6: 'EgvdJqKZqsMpxrbXPFGu',
                                                                                     7: [   2054.89260817631,
                                                                                            datetime.datetime(1979, 10, 27, 13, 37, 43, 955206),
                                                                                            'BvLobYqSqQKdbYfvVHGj'],
                                                                                     8: {   6: 8215,
                                                                                            7: 'tBtrYRsANSrxggOuehwa',
                                                                                            8: [   'psWDaRzeKKAOwNCqwgYI',
                                                                                                   'https://www.miller.com/blogindex.php']}}}),
                                                  'type': 'tuple'},
                                  'pytuple': {   'docs': None,
                                                 'example': (   'oGyJwSkqMaBFOsBCnqOO',
                                                                'melissa77@example.com',
                                                                'YxJhMeIeizrRReKVRCvX',
                                                                'ulsCWZoCBVKuVnFvCiNC',
                                                                'RGietFfERuiAugfHqrMI',
                                                                'pRQCQyBVZGVYMcEklnPU',
                                                                'WtNcGqjfFclPvjqOSrLr'),
                                                 'type': 'tuple'}},
    'faker.providers.sbn': {   'sbn9': {   'docs': None,
                                           'example': '15-890677-3',
                                           'type': 'str'}},
    'faker.providers.ssn.en_US': {   'ein': {   'docs': 'Generate a random United '
                                                        'States Employer '
                                                        'Identification Number '
                                                        '(EIN).\n'
                                                        '\n'
                                                        '        An United States '
                                                        'An Employer Identification '
                                                        'Number (EIN) is\n'
                                                        '        also known as a '
                                                        'Federal Tax Identification '
                                                        'Number, and is\n'
                                                        '        used to identify a '
                                                        'business entity. EINs '
                                                        'follow a format of a\n'
                                                        '        two-digit prefix '
                                                        'followed by a hyphen and a '
                                                        'seven-digit sequence:\n'
                                                        '        ##-######\n'
                                                        '\n'
                                                        '        '
                                                        'https://www.irs.gov/businesses/small-businesses-self-employed/employer-id-numbers\n'
                                                        '        ',
                                                'example': '59-6589959',
                                                'type': 'str'},
                                     'invalid_ssn': {   'docs': 'Generate a random '
                                                                'invalid United '
                                                                'States Social '
                                                                'Security '
                                                                'Identification '
                                                                'Number (SSN).\n'
                                                                '\n'
                                                                '        Invalid '
                                                                'SSNs have the '
                                                                'following '
                                                                'characteristics:\n'
                                                                '        Cannot '
                                                                'begin with the '
                                                                'number 9\n'
                                                                '        Cannot '
                                                                'begin with 666 in '
                                                                'positions 1 - 3\n'
                                                                '        Cannot '
                                                                'begin with 000 in '
                                                                'positions 1 - 3\n'
                                                                '        Cannot '
                                                                'contain 00 in '
                                                                'positions 4 - 5\n'
                                                                '        Cannot '
                                                                'contain 0000 in '
                                                                'positions 6 - 9\n'
                                                                '\n'
                                                                '        '
                                                                'https://www.ssa.gov/kc/SSAFactSheet--IssuingSSNs.pdf\n'
                                                                '\n'
                                                                '        '
                                                                'Additionally, '
                                                                'return an invalid '
                                                                'SSN that is NOT a '
                                                                'valid ITIN by '
                                                                'excluding certain '
                                                                'ITIN related '
                                                                '"group" values\n'
                                                                '        ',
                                                        'example': '627-00-3522',
                                                        'type': 'str'},
                                     'itin': {   'docs': 'Generate a random United '
                                                         'States Individual '
                                                         'Taxpayer Identification '
                                                         'Number (ITIN).\n'
                                                         '\n'
                                                         '        An United States '
                                                         'Individual Taxpayer '
                                                         'Identification Number\n'
                                                         '        (ITIN) is a tax '
                                                         'processing number issued '
                                                         'by the Internal\n'
                                                         '        Revenue Service. '
                                                         'It is a nine-digit number '
                                                         'that always begins\n'
                                                         '        with the number 9 '
                                                         'and has a range of 70-88 '
                                                         'in the fourth and\n'
                                                         '        fifth digit. '
                                                         'Effective April 12, 2011, '
                                                         'the range was extended\n'
                                                         '        to include '
                                                         '900-70-0000 through '
                                                         '999-88-9999, 900-90-0000\n'
                                                         '        through '
                                                         '999-92-9999 and '
                                                         '900-94-0000 through '
                                                         '999-99-9999.\n'
                                                         '        '
                                                         'https://www.irs.gov/individuals/international-taxpayers/general-itin-information\n'
                                                         '        ',
                                                 'example': '968-84-0690',
                                                 'type': 'str'},
                                     'ssn': {   'docs': 'Generate a random United '
                                                        'States Taxpayer '
                                                        'Identification Number of '
                                                        'the specified type.\n'
                                                        '\n'
                                                        '        If no type is '
                                                        'specified, a US SSN is '
                                                        'returned.\n'
                                                        '        ',
                                                'example': '880-65-4026',
                                                'type': 'str'}},
    'faker.providers.user_agent': {   'android_platform_token': {   'docs': 'Generate '
                                                                            'an '
                                                                            'Android '
                                                                            'platform '
                                                                            'token '
                                                                            'used '
                                                                            'in '
                                                                            'user '
                                                                            'agent '
                                                                            'strings.',
                                                                    'example': 'Android '
                                                                               '4.4.4',
                                                                    'type': 'str'},
                                      'chrome': {   'docs': 'Generate a Chrome web '
                                                            'browser user agent '
                                                            'string.',
                                                    'example': 'Mozilla/5.0 '
                                                               '(Windows NT 11.0) '
                                                               'AppleWebKit/535.2 '
                                                               '(KHTML, like Gecko) '
                                                               'Chrome/35.0.896.0 '
                                                               'Safari/535.2',
                                                    'type': 'str'},
                                      'firefox': {   'docs': 'Generate a Mozilla '
                                                             'Firefox web browser '
                                                             'user agent string.',
                                                     'example': 'Mozilla/5.0 '
                                                                '(iPhone; CPU '
                                                                'iPhone OS 15_8_2 '
                                                                'like Mac OS X) '
                                                                'AppleWebKit/531.0 '
                                                                '(KHTML, like '
                                                                'Gecko) '
                                                                'FxiOS/17.6n3249.0 '
                                                                'Mobile/97Z144 '
                                                                'Safari/531.0',
                                                     'type': 'str'},
                                      'internet_explorer': {   'docs': 'Generate an '
                                                                       'IE web '
                                                                       'browser '
                                                                       'user agent '
                                                                       'string.',
                                                               'example': 'Mozilla/5.0 '
                                                                          '(compatible; '
                                                                          'MSIE '
                                                                          '6.0; '
                                                                          'Windows '
                                                                          'NT 11.0; '
                                                                          'Trident/3.1)',
                                                               'type': 'str'},
                                      'ios_platform_token': {   'docs': 'Generate '
                                                                        'an iOS '
                                                                        'platform '
                                                                        'token used '
                                                                        'in user '
                                                                        'agent '
                                                                        'strings.',
                                                                'example': 'iPad; '
                                                                           'CPU '
                                                                           'iPad OS '
                                                                           '7_1_2 '
                                                                           'like '
                                                                           'Mac OS '
                                                                           'X',
                                                                'type': 'str'},
                                      'linux_platform_token': {   'docs': 'Generate '
                                                                          'a Linux '
                                                                          'platform '
                                                                          'token '
                                                                          'used in '
                                                                          'user '
                                                                          'agent '
                                                                          'strings.',
                                                                  'example': 'X11; '
                                                                             'Linux '
                                                                             'x86_64',
                                                                  'type': 'str'},
                                      'linux_processor': {   'docs': 'Generate a '
                                                                     'Linux '
                                                                     'processor '
                                                                     'token used in '
                                                                     'user agent '
                                                                     'strings.',
                                                             'example': 'i686',
                                                             'type': 'str'},
                                      'mac_platform_token': {   'docs': 'Generate a '
                                                                        'MacOS '
                                                                        'platform '
                                                                        'token used '
                                                                        'in user '
                                                                        'agent '
                                                                        'strings.',
                                                                'example': 'Macintosh; '
                                                                           'U; '
                                                                           'Intel '
                                                                           'Mac OS '
                                                                           'X '
                                                                           '10_10_6',
                                                                'type': 'str'},
                                      'mac_processor': {   'docs': 'Generate a '
                                                                   'MacOS processor '
                                                                   'token used in '
                                                                   'user agent '
                                                                   'strings.',
                                                           'example': 'PPC',
                                                           'type': 'str'},
                                      'opera': {   'docs': 'Generate an Opera web '
                                                           'browser user agent '
                                                           'string.',
                                                   'example': 'Opera/9.97.(Windows '
                                                              'NT 5.01; nds-DE) '
                                                              'Presto/2.9.179 '
                                                              'Version/10.00',
                                                   'type': 'str'},
                                      'safari': {   'docs': 'Generate a Safari web '
                                                            'browser user agent '
                                                            'string.',
                                                    'example': 'Mozilla/5.0 '
                                                               '(Macintosh; U; PPC '
                                                               'Mac OS X 10_7_6 '
                                                               'rv:2.0; wo-SN) '
                                                               'AppleWebKit/531.38.6 '
                                                               '(KHTML, like Gecko) '
                                                               'Version/5.0.3 '
                                                               'Safari/531.38.6',
                                                    'type': 'str'},
                                      'user_agent': {   'docs': 'Generate a random '
                                                                'web browser user '
                                                                'agent string.',
                                                        'example': 'Mozilla/5.0 '
                                                                   '(X11; Linux '
                                                                   'x86_64; '
                                                                   'rv:1.9.5.20) '
                                                                   'Gecko/5054-07-31 '
                                                                   '20:18:49.459427 '
                                                                   'Firefox/3.8',
                                                        'type': 'str'},
                                      'windows_platform_token': {   'docs': 'Generate '
                                                                            'a '
                                                                            'Windows '
                                                                            'platform '
                                                                            'token '
                                                                            'used '
                                                                            'in '
                                                                            'user '
                                                                            'agent '
                                                                            'strings.',
                                                                    'example': 'Windows '
                                                                               '95',
                                                                    'type': 'str'}}}