| Name | google-i18n-address JSON |
| Version |
3.1.1
JSON |
| download |
| home_page | None |
| Summary | Address validation helpers for Google's i18n address database |
| upload_time | 2024-09-04 08:53:07 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | BSD 3-Clause License Copyright (c) 2016, MIRUMEE SOFTWARE SP. Z O.O. SP.K. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Google i18n address
This package contains a copy of [Google's i18n address](https://chromium-i18n.appspot.com/ssl-address) metadata repository that contains great data but comes with no uptime guarantees.
Contents of this package will allow you to programmatically build address forms that adhere to rules of a particular region or country, validate local addresses, and format them to produce a valid address label for delivery.
The package also contains a Python interface for address validation.
## Addresses validation
The `normalize_address` function checks the address and either returns its canonical form (suitable for storage and use in addressing envelopes) or raises an `InvalidAddressError` exception that contains a list of errors.
### Address fields
Here is the list of recognized fields:
- `country_code` is a two-letter ISO 3166-1 country code
- `country_area` is a designation of a region, province, or state. Recognized values include official names, designated abbreviations, official translations, and Latin transliterations
- `city` is a city or town name. Recognized values include official names, official translations, and Latin transliterations
- `city_area` is a sublocality like a district. Recognized values include official names, official translations, and Latin transliterations
- `street_address` is the (possibly multiline) street address
- `postal_code` is a postal code or zip code
- `sorting_code` is a sorting code
- `name` is a person's name
- `company_name` is a name of a company or organization
### Errors
Address validation with only country code:
```python
from i18naddress import InvalidAddressError, normalize_address
try:
address = normalize_address({'country_code': 'US'})
except InvalidAddressError as e:
print(e.errors)
```
Output:
```python
{'city': 'required',
'country_area': 'required',
'postal_code': 'required',
'street_address': 'required'}
```
With correct address:
```python
from i18naddress import normalize_address
address = normalize_address({
'country_code': 'US',
'country_area': 'California',
'city': 'Mountain View',
'postal_code': '94043',
'street_address': '1600 Amphitheatre Pkwy'
})
print(address)
```
Output:
```python
{'city': 'MOUNTAIN VIEW',
'city_area': '',
'country_area': 'CA',
'country_code': 'US',
'postal_code': '94043',
'sorting_code': '',
'street_address': '1600 Amphitheatre Pkwy'}
```
Postal code/zip code validation example:
```python
from i18naddress import InvalidAddressError, normalize_address
try:
address = normalize_address({
'country_code': 'US',
'country_area': 'California',
'city': 'Mountain View',
'postal_code': '74043',
'street_address': '1600 Amphitheatre Pkwy'
})
except InvalidAddressError as e:
print(e.errors)
```
Output:
```python
{'postal_code': 'invalid'}
```
## Address latinization
In some cases, it may be useful to display foreign addresses in a more accessible format. You can use the `latinize_address` function to obtain a more verbose, Latinized version of an address.
This version is suitable for display and useful for full-text search indexing, but the normalized form is what should be stored in the database and used when printing address labels.
```python
from i18naddress import latinize_address
address = {
'country_code': 'CN',
'country_area': '云南省',
'postal_code': '677400',
'city': '临沧市',
'city_area': '凤庆县',
'street_address': '中关村东路1号'
}
latinize_address(address)
```
Output:
```python
{'country_code': 'CN',
'country_area': 'Yunnan Sheng',
'city': 'Lincang Shi',
'city_area': 'Lincang Shi',
'sorting_code': '',
'postal_code': '677400',
'street_address': '中关村东路1号'}
```
It will also return expanded names for area types that normally use codes and abbreviations such as state names in the US:
```python
from i18naddress import latinize_address
address = {
'country_code': 'US',
'country_area': 'CA',
'postal_code': '94037',
'city': 'Mountain View',
'street_address': '1600 Charleston Rd.'
}
latinize_address(address)
```
Output:
```python
{'country_code': 'US',
'country_area': 'California',
'city': 'Mountain View',
'city_area': '',
'sorting_code': '',
'postal_code': '94037',
'street_address': '1600 Charleston Rd.'}
```
## Address formatting
You can use the `format_address` function to format the address following the destination country's post office regulations:
```python
address = {
'country_code': 'CN',
'country_area': '云南省',
'postal_code': '677400',
'city': '临沧市',
'city_area': '凤庆县',
'street_address': '中关村东路1号'
}
print(format_address(address))
```
Output:
```plaintext
677400
云南省临沧市凤庆县
中关村东路1号
CHINA
```
You can also ask for a Latin-friendly version:
```python
address = {
'country_code': 'CN',
'country_area': '云南省',
'postal_code': '677400',
'city': '临沧市',
'city_area': '凤庆县',
'street_address': '中关村东路1号'
}
print(format_address(address, latin=True))
```
Output:
```plaintext
中关村东路1号
凤庆县
临沧市
云南省, 677400
CHINA
```
## Validation rules
You can use the `get_validation_rules` function to obtain validation data useful for constructing address forms specific for a particular country:
```python
from i18naddress import get_validation_rules
get_validation_rules({'country_code': 'US', 'country_area': 'CA'})
```
Output:
```python
ValidationRules(
country_code='US',
country_name='UNITED STATES',
address_format='%N%n%O%n%A%n%C, %S %Z',
address_latin_format='%N%n%O%n%A%n%C, %S %Z',
allowed_fields={'street_address', 'company_name', 'city', 'name', 'country_area', 'postal_code'},
required_fields={'street_address', 'city', 'country_area', 'postal_code'},
upper_fields={'city', 'country_area'},
country_area_type='state',
country_area_choices=[('AL', 'Alabama'), ..., ('WY', 'Wyoming')],
city_type='city',
city_choices=[],
city_area_type='suburb',
city_area_choices=[],
postal_code_type='zip',
postal_code_matchers=[re.compile('^(\\d{5})(?:[ \\-](\\d{4}))?$'), re.compile('^9[0-5]|96[01]')],
postal_code_examples=['90000', '96199'],
postal_code_prefix=''
)
```
## All known fields
You can use the `KNOWN_FIELDS` set, to render optional address fields as hidden elements of your form:
```python
from i18naddress import get_validation_rules, KNOWN_FIELDS
rules = get_validation_rules({'country_code': 'US'})
KNOWN_FIELDS - rules.allowed_fields
```
Output:
```python
{'city_area', 'sorting_code'}
```
## Raw i18n data
Raw data is stored in a dict:
```python
from i18naddress import load_validation_data
i18n_country_data = load_validation_data()
i18n_country_data['US']
```
Output:
```python
{'fmt': '%N%n%O%n%A%n%C, %S %Z',
'id': 'data/US',
'key': 'US',
'lang': 'en',
'languages': 'en',
'name': 'UNITED STATES',
'posturl': 'https://tools.usps.com/go/ZipLookupAction!input.action',
'require': 'ACSZ',
'state_name_type': 'state',
'sub_keys': 'AL~AK~AS~AZ~AR~AA~AE~AP~CA~CO~CT~DE~DC~FL~GA~GU~HI~ID~IL~IN~IA~KS~KY~LA~ME~MH~MD~MA~MI~FM~MN~MS~MO~MT~NE~NV~NH~NJ~NM~NY~NC~ND~MP~OH~OK~OR~PW~
PA~PR~RI~SC~SD~TN~TX~UT~VT~VI~VA~WA~WV~WI~WY',
'sub_names': 'Alabama~Alaska~American Samoa~Arizona~Arkansas~Armed Forces (AA)~Armed Forces (AE)~Armed Forces (AP)~California~Colorado~Connecticut~Delaware~District of Columbia~Florida~Georgia~Guam~Hawaii~Idaho~Illinois~Indiana~Iowa~Kansas~Kentucky~Louisiana~Maine~Marshall Islands~Maryland~Massachusetts~Michigan~Micronesia~Minnesota~Mississippi~Missouri~Montana~Nebraska~Nevada~New Hampshire~New Jersey~New Mexico~New York~North Carolina~North Dakota~Northern Mariana Islands~Ohio~Oklahoma~Oregon~Palau~Pennsylvania~Puerto Rico~Rhode Island~South Carolina~South Dakota~Tennessee~Texas~Utah~Vermont~Virgin Islands~Virginia~Washington~West Virginia~Wisconsin~Wyoming',
'sub_zipexs': '35000,36999~99500,99999~96799~85000,86999~71600,72999~34000,34099~09000,09999~96200,96699~90000,96199~80000,81999~06000,06999~19700,19999~20000,20099:20200,20599:56900,56999~32000,33999:34100,34999~30000,31999:39800,39899:39901~96910,96932~96700,96798:96800,96899~83200,83999~60000,62999~46000,47999~50000,52999~66000,67999~40000,42799~70000,71599~03900,04999~96960,96979~20600,21999~01000,02799:05501:05544~48000,49999~96941,96944~55000,56799~38600,39799~63000,65999~59000,59999~68000,69999~88900,89999~03000,03899~07000,08999~87000,88499~10000,14999:06390:00501:00544~27000,28999~58000,58999~96950,96952~43000,45999~73000,74999~97000,97999~96940~15000,19699~00600,00799:00900,00999~02800,02999~29000,29999~57000,57999~37000,38599~75000,79999:88500,88599:73301:73344~84000,84999~05000,05999~00800,00899~20100,20199:22000,24699~98000,99499~24700,26999~53000,54999~82000,83199:83414',
'sub_zips': '3[56]~99[5-9]~96799~8[56]~71[6-9]|72~340~09~96[2-6]~9[0-5]|96[01]~8[01]~06~19[7-9]~20[02-5]|569~3[23]|34[1-9]~3[01]|398|39901~969([1-2]\\d|3[12])~967[0-8]|9679[0-8]|968~83[2-9]~6[0-2]~4[67]~5[0-2]~6[67]~4[01]|42[0-7]~70|71[0-5]~039|04~969[67]~20[6-9]|21~01|02[0-7]|05501|05544~4[89]~9694[1-4]~55|56[0-7]~38[6-9]|39[0-7]~6[3-5]~59~6[89]~889|89~03[0-8]~0[78]~87|88[0-4]~1[0-4]|06390|00501|00544~2[78]~58~9695[0-2]~4[3-5]~7[34]~97~969(39|40)~1[5-8]|19[0-6]~00[679]~02[89]~29~57~37|38[0-5]~7[5-9]|885|73301|73344~84~05~008~201|2[23]|24[0-6]~98|99[0-4]~24[7-9]|2[56]~5[34]~82|83[01]|83414',
'upper': 'CS',
'zip': '(\\d{5})(?:[ \\-](\\d{4}))?',
'zip_name_type': 'zip',
'zipex': '95014,22162-1010'}
```
## Used with Django form
Django forms will return only required address fields in `form.cleaned_data` dict. So addresses in the database will be normalized.
```python
from django import forms
from i18naddress import InvalidAddressError, normalize_address, get_validation_rules
class AddressForm(forms.Form):
COUNTRY_CHOICES = [
('PL', 'Poland'),
('AE', 'United Arab Emirates'),
('US', 'United States of America')
]
ERROR_MESSAGES = {
'required': 'This field is required',
'invalid': 'Enter a valid name'
}
name = forms.CharField(required=True)
company_name = forms.CharField(required=False)
street_address = forms.CharField(required=False)
city = forms.CharField(required=False)
city_area = forms.CharField(required=False)
country_code = forms.ChoiceField(required=True, choices=COUNTRY_CHOICES)
country_area = forms.CharField(required=False)
postal_code = forms.CharField(required=False)
def clean(self):
clean_data = super(AddressForm, self).clean()
validation_rules = get_validation_rules(clean_data)
try:
valid_address = normalize_address(clean_data)
except InvalidAddressError as e:
errors = e.errors
valid_address = None
for field, error_code in errors.items():
if field == 'postal_code':
examples = validation_rules.postal_code_examples
msg = 'Invalid value, use format like %s' % examples
else:
msg = self.ERROR_MESSAGES[error_code]
self.add_error(field, msg)
return valid_address or clean_data
```
Raw data
{
"_id": null,
"home_page": null,
"name": "google-i18n-address",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Mirumee Software <hello@mirumee.com>",
"download_url": "https://files.pythonhosted.org/packages/fe/52/d00c490e19a727ee67e97ff04fd2ed7003088b0e28f40604784c97c4c946/google_i18n_address-3.1.1.tar.gz",
"platform": null,
"description": "# Google i18n address\n\n\n\n\n\n\n\nThis package contains a copy of [Google's i18n address](https://chromium-i18n.appspot.com/ssl-address) metadata repository that contains great data but comes with no uptime guarantees.\n\nContents of this package will allow you to programmatically build address forms that adhere to rules of a particular region or country, validate local addresses, and format them to produce a valid address label for delivery.\n\nThe package also contains a Python interface for address validation.\n\n## Addresses validation\n\nThe `normalize_address` function checks the address and either returns its canonical form (suitable for storage and use in addressing envelopes) or raises an `InvalidAddressError` exception that contains a list of errors.\n\n### Address fields\n\nHere is the list of recognized fields:\n\n- `country_code` is a two-letter ISO 3166-1 country code\n- `country_area` is a designation of a region, province, or state. Recognized values include official names, designated abbreviations, official translations, and Latin transliterations\n- `city` is a city or town name. Recognized values include official names, official translations, and Latin transliterations\n- `city_area` is a sublocality like a district. Recognized values include official names, official translations, and Latin transliterations\n- `street_address` is the (possibly multiline) street address\n- `postal_code` is a postal code or zip code\n- `sorting_code` is a sorting code\n- `name` is a person's name\n- `company_name` is a name of a company or organization\n\n### Errors\n\nAddress validation with only country code:\n\n```python\nfrom i18naddress import InvalidAddressError, normalize_address\n\ntry:\n address = normalize_address({'country_code': 'US'})\nexcept InvalidAddressError as e:\n print(e.errors)\n```\n\nOutput:\n```python\n{'city': 'required',\n 'country_area': 'required',\n 'postal_code': 'required',\n 'street_address': 'required'}\n```\n\nWith correct address:\n\n```python\nfrom i18naddress import normalize_address\n\naddress = normalize_address({\n 'country_code': 'US',\n 'country_area': 'California',\n 'city': 'Mountain View',\n 'postal_code': '94043',\n 'street_address': '1600 Amphitheatre Pkwy'\n})\nprint(address)\n```\n\nOutput:\n```python\n{'city': 'MOUNTAIN VIEW',\n 'city_area': '',\n 'country_area': 'CA',\n 'country_code': 'US',\n 'postal_code': '94043',\n 'sorting_code': '',\n 'street_address': '1600 Amphitheatre Pkwy'}\n```\n\nPostal code/zip code validation example:\n\n```python\nfrom i18naddress import InvalidAddressError, normalize_address\n\ntry:\n address = normalize_address({\n 'country_code': 'US',\n 'country_area': 'California',\n 'city': 'Mountain View',\n 'postal_code': '74043',\n 'street_address': '1600 Amphitheatre Pkwy'\n })\nexcept InvalidAddressError as e:\n print(e.errors)\n```\n\nOutput:\n```python\n{'postal_code': 'invalid'}\n```\n\n## Address latinization\n\nIn some cases, it may be useful to display foreign addresses in a more accessible format. You can use the `latinize_address` function to obtain a more verbose, Latinized version of an address.\n\nThis version is suitable for display and useful for full-text search indexing, but the normalized form is what should be stored in the database and used when printing address labels.\n\n```python\nfrom i18naddress import latinize_address\n\naddress = {\n 'country_code': 'CN',\n 'country_area': '\u4e91\u5357\u7701',\n 'postal_code': '677400',\n 'city': '\u4e34\u6ca7\u5e02',\n 'city_area': '\u51e4\u5e86\u53bf',\n 'street_address': '\u4e2d\u5173\u6751\u4e1c\u8def1\u53f7'\n}\nlatinize_address(address)\n```\n\nOutput:\n```python\n{'country_code': 'CN',\n 'country_area': 'Yunnan Sheng',\n 'city': 'Lincang Shi',\n 'city_area': 'Lincang Shi',\n 'sorting_code': '',\n 'postal_code': '677400',\n 'street_address': '\u4e2d\u5173\u6751\u4e1c\u8def1\u53f7'}\n```\n\nIt will also return expanded names for area types that normally use codes and abbreviations such as state names in the US:\n\n```python\nfrom i18naddress import latinize_address\n\naddress = {\n 'country_code': 'US',\n 'country_area': 'CA',\n 'postal_code': '94037',\n 'city': 'Mountain View',\n 'street_address': '1600 Charleston Rd.'\n}\nlatinize_address(address)\n```\n\nOutput:\n```python\n{'country_code': 'US',\n 'country_area': 'California',\n 'city': 'Mountain View',\n 'city_area': '',\n 'sorting_code': '',\n 'postal_code': '94037',\n 'street_address': '1600 Charleston Rd.'}\n```\n\n## Address formatting\n\nYou can use the `format_address` function to format the address following the destination country's post office regulations:\n\n```python\naddress = {\n 'country_code': 'CN',\n 'country_area': '\u4e91\u5357\u7701',\n 'postal_code': '677400',\n 'city': '\u4e34\u6ca7\u5e02',\n 'city_area': '\u51e4\u5e86\u53bf',\n 'street_address': '\u4e2d\u5173\u6751\u4e1c\u8def1\u53f7'\n}\nprint(format_address(address))\n```\n\nOutput:\n```plaintext\n677400\n\u4e91\u5357\u7701\u4e34\u6ca7\u5e02\u51e4\u5e86\u53bf\n\u4e2d\u5173\u6751\u4e1c\u8def1\u53f7\nCHINA\n```\n\nYou can also ask for a Latin-friendly version:\n\n```python\naddress = {\n 'country_code': 'CN',\n 'country_area': '\u4e91\u5357\u7701',\n 'postal_code': '677400',\n 'city': '\u4e34\u6ca7\u5e02',\n 'city_area': '\u51e4\u5e86\u53bf',\n 'street_address': '\u4e2d\u5173\u6751\u4e1c\u8def1\u53f7'\n}\nprint(format_address(address, latin=True))\n```\n\nOutput:\n```plaintext\n\u4e2d\u5173\u6751\u4e1c\u8def1\u53f7\n\u51e4\u5e86\u53bf\n\u4e34\u6ca7\u5e02\n\u4e91\u5357\u7701, 677400\nCHINA\n```\n\n## Validation rules\n\nYou can use the `get_validation_rules` function to obtain validation data useful for constructing address forms specific for a particular country:\n\n```python\nfrom i18naddress import get_validation_rules\n\nget_validation_rules({'country_code': 'US', 'country_area': 'CA'})\n```\n\nOutput:\n```python\nValidationRules(\n country_code='US',\n country_name='UNITED STATES',\n address_format='%N%n%O%n%A%n%C, %S %Z',\n address_latin_format='%N%n%O%n%A%n%C, %S %Z',\n allowed_fields={'street_address', 'company_name', 'city', 'name', 'country_area', 'postal_code'},\n required_fields={'street_address', 'city', 'country_area', 'postal_code'},\n upper_fields={'city', 'country_area'},\n country_area_type='state',\n country_area_choices=[('AL', 'Alabama'), ..., ('WY', 'Wyoming')],\n city_type='city',\n city_choices=[],\n city_area_type='suburb',\n city_area_choices=[],\n postal_code_type='zip',\n postal_code_matchers=[re.compile('^(\\\\d{5})(?:[ \\\\-](\\\\d{4}))?$'), re.compile('^9[0-5]|96[01]')],\n postal_code_examples=['90000', '96199'],\n postal_code_prefix=''\n)\n```\n\n## All known fields\n\nYou can use the `KNOWN_FIELDS` set, to render optional address fields as hidden elements of your form:\n\n```python\nfrom i18naddress import get_validation_rules, KNOWN_FIELDS\n\nrules = get_validation_rules({'country_code': 'US'})\nKNOWN_FIELDS - rules.allowed_fields\n```\n\nOutput:\n```python\n{'city_area', 'sorting_code'}\n```\n\n## Raw i18n data\n\nRaw data is stored in a dict:\n\n```python\nfrom i18naddress import load_validation_data\n\ni18n_country_data = load_validation_data()\ni18n_country_data['US']\n```\n\nOutput:\n```python\n{'fmt': '%N%n%O%n%A%n%C, %S %Z',\n 'id': 'data/US',\n 'key': 'US',\n 'lang': 'en',\n 'languages': 'en',\n 'name': 'UNITED STATES',\n 'posturl': 'https://tools.usps.com/go/ZipLookupAction!input.action',\n 'require': 'ACSZ',\n 'state_name_type': 'state',\n 'sub_keys': 'AL~AK~AS~AZ~AR~AA~AE~AP~CA~CO~CT~DE~DC~FL~GA~GU~HI~ID~IL~IN~IA~KS~KY~LA~ME~MH~MD~MA~MI~FM~MN~MS~MO~MT~NE~NV~NH~NJ~NM~NY~NC~ND~MP~OH~OK~OR~PW~\n\nPA~PR~RI~SC~SD~TN~TX~UT~VT~VI~VA~WA~WV~WI~WY',\n 'sub_names': 'Alabama~Alaska~American Samoa~Arizona~Arkansas~Armed Forces (AA)~Armed Forces (AE)~Armed Forces (AP)~California~Colorado~Connecticut~Delaware~District of Columbia~Florida~Georgia~Guam~Hawaii~Idaho~Illinois~Indiana~Iowa~Kansas~Kentucky~Louisiana~Maine~Marshall Islands~Maryland~Massachusetts~Michigan~Micronesia~Minnesota~Mississippi~Missouri~Montana~Nebraska~Nevada~New Hampshire~New Jersey~New Mexico~New York~North Carolina~North Dakota~Northern Mariana Islands~Ohio~Oklahoma~Oregon~Palau~Pennsylvania~Puerto Rico~Rhode Island~South Carolina~South Dakota~Tennessee~Texas~Utah~Vermont~Virgin Islands~Virginia~Washington~West Virginia~Wisconsin~Wyoming',\n 'sub_zipexs': '35000,36999~99500,99999~96799~85000,86999~71600,72999~34000,34099~09000,09999~96200,96699~90000,96199~80000,81999~06000,06999~19700,19999~20000,20099:20200,20599:56900,56999~32000,33999:34100,34999~30000,31999:39800,39899:39901~96910,96932~96700,96798:96800,96899~83200,83999~60000,62999~46000,47999~50000,52999~66000,67999~40000,42799~70000,71599~03900,04999~96960,96979~20600,21999~01000,02799:05501:05544~48000,49999~96941,96944~55000,56799~38600,39799~63000,65999~59000,59999~68000,69999~88900,89999~03000,03899~07000,08999~87000,88499~10000,14999:06390:00501:00544~27000,28999~58000,58999~96950,96952~43000,45999~73000,74999~97000,97999~96940~15000,19699~00600,00799:00900,00999~02800,02999~29000,29999~57000,57999~37000,38599~75000,79999:88500,88599:73301:73344~84000,84999~05000,05999~00800,00899~20100,20199:22000,24699~98000,99499~24700,26999~53000,54999~82000,83199:83414',\n 'sub_zips': '3[56]~99[5-9]~96799~8[56]~71[6-9]|72~340~09~96[2-6]~9[0-5]|96[01]~8[01]~06~19[7-9]~20[02-5]|569~3[23]|34[1-9]~3[01]|398|39901~969([1-2]\\\\d|3[12])~967[0-8]|9679[0-8]|968~83[2-9]~6[0-2]~4[67]~5[0-2]~6[67]~4[01]|42[0-7]~70|71[0-5]~039|04~969[67]~20[6-9]|21~01|02[0-7]|05501|05544~4[89]~9694[1-4]~55|56[0-7]~38[6-9]|39[0-7]~6[3-5]~59~6[89]~889|89~03[0-8]~0[78]~87|88[0-4]~1[0-4]|06390|00501|00544~2[78]~58~9695[0-2]~4[3-5]~7[34]~97~969(39|40)~1[5-8]|19[0-6]~00[679]~02[89]~29~57~37|38[0-5]~7[5-9]|885|73301|73344~84~05~008~201|2[23]|24[0-6]~98|99[0-4]~24[7-9]|2[56]~5[34]~82|83[01]|83414',\n 'upper': 'CS',\n 'zip': '(\\\\d{5})(?:[ \\\\-](\\\\d{4}))?',\n 'zip_name_type': 'zip',\n 'zipex': '95014,22162-1010'}\n```\n\n## Used with Django form\n\nDjango forms will return only required address fields in `form.cleaned_data` dict. So addresses in the database will be normalized.\n\n```python\nfrom django import forms\n\nfrom i18naddress import InvalidAddressError, normalize_address, get_validation_rules\n\nclass AddressForm(forms.Form):\n\n COUNTRY_CHOICES = [\n ('PL', 'Poland'),\n ('AE', 'United Arab Emirates'),\n ('US', 'United States of America')\n ]\n\n ERROR_MESSAGES = {\n 'required': 'This field is required',\n 'invalid': 'Enter a valid name'\n }\n\n name = forms.CharField(required=True)\n company_name = forms.CharField(required=False)\n street_address = forms.CharField(required=False)\n city = forms.CharField(required=False)\n city_area = forms.CharField(required=False)\n country_code = forms.ChoiceField(required=True, choices=COUNTRY_CHOICES)\n country_area = forms.CharField(required=False)\n postal_code = forms.CharField(required=False)\n\n def clean(self):\n clean_data = super(AddressForm, self).clean()\n validation_rules = get_validation_rules(clean_data)\n try:\n valid_address = normalize_address(clean_data)\n except InvalidAddressError as e:\n errors = e.errors\n valid_address = None\n for field, error_code in errors.items():\n if field == 'postal_code':\n examples = validation_rules.postal_code_examples\n msg = 'Invalid value, use format like %s' % examples\n else:\n msg = self.ERROR_MESSAGES[error_code]\n self.add_error(field, msg)\n return valid_address or clean_data\n```\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2016, MIRUMEE SOFTWARE SP. Z O.O. SP.K. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "Address validation helpers for Google's i18n address database",
"version": "3.1.1",
"project_urls": {
"Bug Tracker": "https://github.com/mirumee/google-i18n-address/issues",
"Homepage": "https://github.com/mirumee/google-i18n-address",
"Repository": "https://github.com/mirumee/google-i18n-address"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3775c4dadb4845c8c930b94c8ff9d2dfa9855c0a005366af539fee8095e30765",
"md5": "51339757c2f00bc27a5a2eaa81cd8e87",
"sha256": "f66f4fd2b75d1cd371fc0a7678a1d656da4aa3b32932279e78dd6cae776fc23d"
},
"downloads": -1,
"filename": "google_i18n_address-3.1.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "51339757c2f00bc27a5a2eaa81cd8e87",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 772645,
"upload_time": "2024-09-04T08:53:05",
"upload_time_iso_8601": "2024-09-04T08:53:05.506072Z",
"url": "https://files.pythonhosted.org/packages/37/75/c4dadb4845c8c930b94c8ff9d2dfa9855c0a005366af539fee8095e30765/google_i18n_address-3.1.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fe52d00c490e19a727ee67e97ff04fd2ed7003088b0e28f40604784c97c4c946",
"md5": "2ad8bed45d85ea46eb6a3466df4ceee2",
"sha256": "c9ea70e35cb312948651fbbbe4ad4ba97781e129096502fab6ed4e94f629ab0e"
},
"downloads": -1,
"filename": "google_i18n_address-3.1.1.tar.gz",
"has_sig": false,
"md5_digest": "2ad8bed45d85ea46eb6a3466df4ceee2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 721615,
"upload_time": "2024-09-04T08:53:07",
"upload_time_iso_8601": "2024-09-04T08:53:07.683092Z",
"url": "https://files.pythonhosted.org/packages/fe/52/d00c490e19a727ee67e97ff04fd2ed7003088b0e28f40604784c97c4c946/google_i18n_address-3.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-04 08:53:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mirumee",
"github_project": "google-i18n-address",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "google-i18n-address"
}
