from typing import List, Optional from .form_address_address_format import is_uk_family, lookup_country, trim_ascii, upper_ascii from .form_address_types import Address, AddressCheck, AddressError from .text_pattern_match import matches_pattern from .validation_uk_postcode import validate_uk_postcode MAX_LENGTH = 100 def _in_sentence(label: str) -> str: # "Enter postcode", but "Enter ZIP code" and "Enter Eircode": only the two # ordinary labels are common nouns. if label in ("Postcode", "Postal code"): return label[0].lower() + label[1:] return label def _plausible_postcode(value: str) -> bool: # Without a known format: 1 to 12 letters, digits, spaces and hyphens. if not 1 <= len(value) <= 12: return False return all("A" <= ch <= "Z" or "0" <= ch <= "9" or ch in " -" for ch in value) def validate_address(address: Address) -> AddressCheck: """A postal address checked field by field: the GOV.UK address pattern for the UK, the country's own postcode format and labels elsewhere. Never raises: an unknown country is the country field's error.""" errors: List[AddressError] = [] row = lookup_country(address.country) region_label = row.region_label if row is not None else "Region" postcode_label = row.postcode_label if row is not None else "Postal code" line1 = trim_ascii(address.line1) if line1 == "": errors.append(AddressError(field="line1", message="Enter address line 1, typically the building and street")) elif len(line1) > MAX_LENGTH: errors.append(AddressError(field="line1", message="Address line 1 must be %d characters or less" % MAX_LENGTH)) line2 = trim_ascii(address.line2 or "") if len(line2) > MAX_LENGTH: errors.append(AddressError(field="line2", message="Address line 2 must be %d characters or less" % MAX_LENGTH)) town = trim_ascii(address.town) if town == "": errors.append(AddressError(field="town", message="Enter town or city")) elif len(town) > MAX_LENGTH: errors.append(AddressError(field="town", message="Town or city must be %d characters or less" % MAX_LENGTH)) region = trim_ascii(address.region or "") if len(region) > MAX_LENGTH: errors.append(AddressError(field="region", message="%s must be %d characters or less" % (region_label, MAX_LENGTH))) typed = trim_ascii(address.postcode or "") postcode: Optional[str] = None if typed == "": if row is not None and row.postcode_required: errors.append(AddressError(field="postcode", message="Enter %s" % _in_sentence(postcode_label))) elif row is not None and is_uk_family(row.code): uk = validate_uk_postcode(typed) if uk.valid: postcode = uk.normalised else: errors.append(AddressError(field="postcode", message="Enter a real %s" % _in_sentence(postcode_label))) else: upper = upper_ascii(typed) pattern = row.postcode_pattern if row is not None else None ok = matches_pattern(pattern, upper) if pattern is not None else _plausible_postcode(upper) if ok: postcode = upper else: errors.append(AddressError(field="postcode", message="Enter a real %s" % _in_sentence(postcode_label))) if row is None: errors.append(AddressError(field="country", message="Select a country")) if errors or row is None: return AddressCheck(valid=False, address=None, errors=errors) return AddressCheck( valid=True, address=Address( line1=line1, line2=line2 if line2 != "" else None, town=town, region=region if region != "" else None, postcode=postcode, country=row.code, ), errors=[], )