574 lines
21 KiB
Python
574 lines
21 KiB
Python
# -*- coding: utf-8 -*-
|
|
import copy
|
|
import os
|
|
import pystache
|
|
import re
|
|
import six
|
|
import subprocess
|
|
import yaml
|
|
|
|
from geodata.address_formatting.aliases import Aliases
|
|
from geodata.configs.utils import nested_get, recursive_merge
|
|
from geodata.math.floats import isclose
|
|
from geodata.math.sampling import weighted_choice, cdf
|
|
from geodata.text.tokenize import tokenize, tokenize_raw, token_types
|
|
from geodata.encoding import safe_decode
|
|
from collections import OrderedDict
|
|
from itertools import ifilter
|
|
|
|
FORMATTER_GIT_REPO = 'https://github.com/OpenCageData/address-formatting'
|
|
|
|
this_dir = os.path.realpath(os.path.dirname(__file__))
|
|
|
|
FORMATTER_CONFIG = os.path.join(this_dir, os.pardir, os.pardir, os.pardir,
|
|
'resources', 'formatting', 'global.yaml')
|
|
|
|
|
|
class AddressFormatter(object):
|
|
'''
|
|
Approximate Python port of lokku's Geo::Address::Formatter
|
|
|
|
Usage:
|
|
address_formatter = AddressFormatter()
|
|
components = {
|
|
'house': u'Anticafé',
|
|
'addr:housenumber': '2',
|
|
'addr:street': u'Calle de la Unión',
|
|
'addr:postcode': '28013',
|
|
'addr:city': u'Madrid',
|
|
}
|
|
address_formatter.format_address('es', components)
|
|
'''
|
|
|
|
whitespace_component_regex = re.compile('[\r\n]+[\s\r\n]*')
|
|
|
|
splitter = ' | '
|
|
|
|
separator_tag = 'SEP'
|
|
field_separator_tag = 'FSEP'
|
|
|
|
CATEGORY = 'category'
|
|
NEAR = 'near'
|
|
HOUSE = 'house'
|
|
HOUSE_NUMBER = 'house_number'
|
|
PO_BOX = 'po_box'
|
|
CARE_OF = 'care_of'
|
|
BLOCK = 'block'
|
|
BUILDING = 'building'
|
|
LEVEL = 'level'
|
|
UNIT = 'unit'
|
|
INTERSECTION = 'intersection'
|
|
ROAD = 'road'
|
|
SUBDIVISION = 'subdivision'
|
|
SUBURB = 'suburb'
|
|
CITY_DISTRICT = 'city_district'
|
|
CITY = 'city'
|
|
ISLAND = 'island'
|
|
STATE = 'state'
|
|
STATE_DISTRICT = 'state_district'
|
|
POSTCODE = 'postcode'
|
|
COUNTRY = 'country'
|
|
|
|
address_formatter_fields = set([
|
|
CATEGORY,
|
|
NEAR,
|
|
HOUSE,
|
|
HOUSE_NUMBER,
|
|
PO_BOX,
|
|
CARE_OF,
|
|
BLOCK,
|
|
BUILDING,
|
|
LEVEL,
|
|
UNIT,
|
|
INTERSECTION,
|
|
ROAD,
|
|
SUBURB,
|
|
SUBDIVISION,
|
|
CITY,
|
|
CITY_DISTRICT,
|
|
ISLAND,
|
|
STATE,
|
|
STATE_DISTRICT,
|
|
POSTCODE,
|
|
COUNTRY,
|
|
])
|
|
|
|
aliases = Aliases(
|
|
OrderedDict([
|
|
('street', ROAD),
|
|
('street_name', ROAD),
|
|
('hamlet', CITY),
|
|
('village', CITY),
|
|
('neighborhood', SUBURB),
|
|
('neighbourhood', SUBURB),
|
|
('city_district', CITY_DISTRICT),
|
|
('county', STATE_DISTRICT),
|
|
('state_code', STATE),
|
|
('country_name', COUNTRY),
|
|
('postal_code', POSTCODE),
|
|
('post_code', POSTCODE),
|
|
])
|
|
)
|
|
|
|
template_address_parts = [HOUSE, HOUSE_NUMBER, ROAD]
|
|
template_admin_parts = [CITY, STATE, COUNTRY]
|
|
|
|
template_address_parts_re = re.compile('|'.join(['\{{{key}\}}'.format(key=key) for key in template_address_parts]))
|
|
template_admin_parts_re = re.compile('|'.join(['\{{{key}\}}'.format(key=key) for key in template_admin_parts]))
|
|
|
|
MINIMAL_COMPONENT_KEYS = [
|
|
(ROAD, HOUSE_NUMBER),
|
|
(ROAD, HOUSE),
|
|
(ROAD, POSTCODE)
|
|
]
|
|
|
|
FIRST, BEFORE, AFTER, LAST = range(4)
|
|
|
|
def __init__(self, scratch_dir='/tmp', splitter=None):
|
|
if splitter is not None:
|
|
self.splitter = splitter
|
|
|
|
self.formatter_repo_path = os.path.join(scratch_dir, 'address-formatting')
|
|
self.clone_repo()
|
|
|
|
self.load_config()
|
|
self.load_country_config()
|
|
|
|
self.setup_insertion_probabilities()
|
|
|
|
self.template_cache = {}
|
|
|
|
def clone_repo(self):
|
|
subprocess.check_call(['rm', '-rf', self.formatter_repo_path])
|
|
subprocess.check_call(['git', 'clone', FORMATTER_GIT_REPO, self.formatter_repo_path])
|
|
|
|
def load_country_config(self):
|
|
config = yaml.load(open(os.path.join(self.formatter_repo_path,
|
|
'conf', 'countries', 'worldwide.yaml')))
|
|
for key in list(config):
|
|
country = key
|
|
language = None
|
|
if '_' in key:
|
|
country, language = country.split('_', 1)
|
|
value = config[country]
|
|
if hasattr(value, 'items'):
|
|
address_template = value.get('address_template')
|
|
if not address_template and 'use_country' in value:
|
|
# Temporary fix for Norway territories (NO unquoted is a boolean) and recursive references
|
|
if value['use_country'] in (country, False):
|
|
continue
|
|
address_template = config[value['use_country']]['address_template']
|
|
|
|
if address_template:
|
|
value['address_template'] = self.add_postprocessing_tags(address_template, country, language=language)
|
|
|
|
post_format_replacements = value.get('postformat_replace')
|
|
if post_format_replacements:
|
|
value['postformat_replace'] = [[pattern, replacement.replace('$', '\\')] for pattern, replacement in post_format_replacements]
|
|
else:
|
|
address_template = value
|
|
config[country] = self.add_postprocessing_tags(value, country, language=language)
|
|
self.country_formats = config
|
|
|
|
def load_config(self):
|
|
config = yaml.load(open(FORMATTER_CONFIG))
|
|
self.config = config.get('global', {})
|
|
language_configs = config.get('languages', {})
|
|
|
|
self.language_configs = {}
|
|
for language in language_configs:
|
|
language_config = language_configs[language]
|
|
config_copy = copy.deepcopy(self.config)
|
|
self.language_configs[language] = recursive_merge(config_copy, language_config)
|
|
|
|
country_configs = config.get('countries', {})
|
|
|
|
self.country_configs = {}
|
|
for country in country_configs:
|
|
country_config = country_configs[country]
|
|
config_copy = copy.deepcopy(self.config)
|
|
self.country_configs[country] = recursive_merge(config_copy, country_config)
|
|
|
|
def get_property(self, keys, country, language=None, default=None):
|
|
if isinstance(keys, six.string_types):
|
|
keys = keys.split('.')
|
|
keys = tuple(keys)
|
|
value = nested_get(self.language_configs, (language,) + keys, default=default)
|
|
if not value:
|
|
value = nested_get(self.country_configs, (country,) + keys, default=default)
|
|
if not value:
|
|
value = nested_get(self.config, keys, default=default)
|
|
return value
|
|
|
|
def get_admin_components(self, country, language=None):
|
|
admin_components = self.get_property('admin_components', country, language=language, default={})
|
|
return [(key, value.get('after', ()), value.get('before', ())) for key, value in six.iteritems(admin_components)]
|
|
|
|
def insertion_probs(self, config):
|
|
component_insertions = {}
|
|
for component, insertions in six.iteritems(config):
|
|
values = []
|
|
probs = []
|
|
for k, v in six.iteritems(insertions):
|
|
if 'before' in v:
|
|
val = (self.BEFORE, v['before'])
|
|
elif 'after' in v:
|
|
val = (self.AFTER, v['after'])
|
|
elif 'last' in v:
|
|
val = (self.LAST, None)
|
|
elif 'first' in v:
|
|
val = (self.FIRST, None)
|
|
else:
|
|
raise ValueError('Insertions must contain one of {first, before, after, last}')
|
|
|
|
prob = v['probability']
|
|
values.append(val)
|
|
probs.append(prob)
|
|
|
|
# If the probabilities don't sum to 1, add a "do nothing" action
|
|
if not isclose(sum(probs), 1.0):
|
|
probs.append(1.0 - sum(probs))
|
|
values.append((None, None))
|
|
|
|
component_insertions[component] = values, cdf(probs)
|
|
return component_insertions
|
|
|
|
def setup_insertion_probabilities(self):
|
|
self.global_insertions = self.insertion_probs(self.config['insertions'])
|
|
|
|
self.country_insertions = {}
|
|
|
|
for country, config in six.iteritems(self.country_configs):
|
|
if 'insertions' in config:
|
|
self.country_insertions[country.lower()] = self.insertion_probs(config['insertions'])
|
|
|
|
self.language_insertions = {}
|
|
|
|
for language, config in six.iteritems(self.language_configs):
|
|
if 'insertions' in config:
|
|
self.language_insertions[language.lower()] = self.insertion_probs(config['insertions'])
|
|
|
|
def country_template(self, c):
|
|
return self.country_formats.get(c, self.country_formats['default'])
|
|
|
|
def is_reverse(self, template):
|
|
address_parts_match = self.template_address_parts_re.search(template)
|
|
admin_parts_match = list(self.template_admin_parts_re.finditer(template))
|
|
|
|
# last instance of city/state/country occurs before the first instance of house_number/road
|
|
return admin_parts_match[-1].start() < address_parts_match.start()
|
|
|
|
def build_first_of_template(self, keys):
|
|
""" For constructing """
|
|
return '{{{{#first}}}} {keys} {{{{/first}}}}'.format(keys=' || '.join(['{{{{{{{key}}}}}}}'.format(key=key) for key in keys]))
|
|
|
|
def insert_component(self, template, tag, before=None, after=None, first=False, last=False, separate=True, is_reverse=False):
|
|
if not before and not after and not first and not last:
|
|
return
|
|
|
|
template = template.rstrip()
|
|
|
|
tag_match = re.compile('\{{{key}\}}'.format(key=tag)).search(template)
|
|
|
|
if before:
|
|
before_match = re.compile('\{{{key}\}}'.format(key=before)).search(template)
|
|
if before_match and tag_match and before_match.start() > tag_match.start():
|
|
return template
|
|
|
|
if after:
|
|
after_match = re.compile('\{{{key}\}}'.format(key=after)).search(template)
|
|
if after_match and tag_match and tag_match.start() > after_match.start():
|
|
return template
|
|
|
|
key_added = False
|
|
skip_next_non_token = False
|
|
new_components = []
|
|
|
|
tag_token = '{{{{{{{key}}}}}}}'.format(key=tag)
|
|
|
|
parsed = pystache.parse(safe_decode(template))
|
|
num_tokens = len(parsed._parse_tree)
|
|
for i, el in enumerate(parsed._parse_tree):
|
|
|
|
if hasattr(el, 'parsed'):
|
|
keys = [e.key for e in el.parsed._parse_tree if hasattr(e, 'key')]
|
|
if (before in set(keys) or first) and not key_added:
|
|
token = new_components[-1] if new_components and '{' not in new_components[-1] else '\n'
|
|
new_components.extend([tag_token, token])
|
|
key_added = True
|
|
|
|
keys = [k for k in keys if self.aliases.get(k, k) != tag]
|
|
if keys:
|
|
new_components.append(self.build_first_of_template(keys))
|
|
else:
|
|
while new_components and '{' not in new_components[-1]:
|
|
new_components.pop()
|
|
continue
|
|
|
|
if (after in set(keys) or i == num_tokens - 1) and not key_added:
|
|
token = '\n'
|
|
if i < num_tokens - 1 and isinstance(parsed._parse_tree[i + 1], six.string_types):
|
|
token = parsed._parse_tree[i + 1]
|
|
new_components.extend([token, tag_token])
|
|
key_added = True
|
|
|
|
elif hasattr(el, 'key'):
|
|
if el.key == tag:
|
|
skip_next_non_token = True
|
|
continue
|
|
|
|
if (el.key == before or first) and not key_added:
|
|
token = '\n'
|
|
if new_components and '{' not in new_components[-1]:
|
|
token = new_components[-1]
|
|
new_components.extend([tag_token, token])
|
|
key_added = True
|
|
|
|
new_components.append('{{{{{{{key}}}}}}}'.format(key=el.key))
|
|
|
|
if (el.key == after or i == num_tokens - 1) and not key_added:
|
|
token = '\n'
|
|
if i < num_tokens - 1 and isinstance(parsed._parse_tree[i + 1], six.string_types):
|
|
token = parsed._parse_tree[i + 1]
|
|
new_components.extend([token, tag_token])
|
|
key_added = True
|
|
elif not skip_next_non_token:
|
|
new_components.append(el)
|
|
|
|
if i == num_tokens - 1 and not key_added:
|
|
key_added = True
|
|
new_components.append(tag_token)
|
|
|
|
skip_next_non_token = False
|
|
|
|
return ''.join(new_components)
|
|
|
|
def add_postprocessing_tags(self, template, country, language=None):
|
|
is_reverse = self.is_reverse(template)
|
|
for key, pre_keys, post_keys in self.get_admin_components(country, language=language):
|
|
key_tag = six.u('{{{{{{{key}}}}}}}').format(key=key)
|
|
|
|
key_included = key_tag in template
|
|
new_components = []
|
|
if key_included:
|
|
continue
|
|
|
|
pre_key_regex = re.compile('|'.join(['{{{}}}'.format(k) for k in pre_keys]))
|
|
post_key_regex = re.compile('|'.join(['{{{}}}'.format(k) for k in post_keys]))
|
|
|
|
for line in template.split(six.u('\n')):
|
|
if not line.strip():
|
|
continue
|
|
pre_key = pre_keys and pre_key_regex.search(line)
|
|
post_key = post_keys and post_key_regex.search(line)
|
|
if post_key and not pre_key and not key_included:
|
|
if not is_reverse:
|
|
new_components.append(key_tag)
|
|
key_included = True
|
|
|
|
new_components.append(line.rstrip('\n'))
|
|
if post_key and not pre_key and not key_included and is_reverse:
|
|
new_components.append(key_tag)
|
|
key_included = True
|
|
if not post_keys and not key_included:
|
|
new_components.append(key_tag)
|
|
template = six.u('\n').join(new_components)
|
|
return template
|
|
|
|
def render_template(self, template, components, tagged=False):
|
|
def render_first(text):
|
|
text = pystache.render(text, **components)
|
|
splits = (e.strip() for e in text.split('||'))
|
|
selected = next(ifilter(bool, splits), '')
|
|
return selected
|
|
|
|
output = pystache.render(template, first=render_first,
|
|
**components).strip()
|
|
|
|
values = self.whitespace_component_regex.split(output)
|
|
|
|
splitter = self.splitter if not tagged else ' {}/{} '.format(self.splitter.strip(), self.field_separator_tag)
|
|
|
|
values = [self.strip_component(val, tagged=tagged) for val in values]
|
|
|
|
output = splitter.join([
|
|
val for val in values if val.strip()
|
|
])
|
|
|
|
return output
|
|
|
|
def minimal_components(self, components):
|
|
for component_list in self.MINIMAL_COMPONENT_KEYS:
|
|
if all((c in components for c in component_list)):
|
|
return True
|
|
return False
|
|
|
|
def post_replacements(self, template, text):
|
|
components = []
|
|
seen = set()
|
|
for component in text.split(self.splitter):
|
|
component = component.strip()
|
|
if component not in seen:
|
|
components.append(component)
|
|
seen.add(component)
|
|
text = self.splitter.join(components)
|
|
post_format_replacements = template.get('postformat_replace')
|
|
if post_format_replacements:
|
|
for regex, replacement in post_format_replacements:
|
|
text = re.sub(regex, replacement, text)
|
|
return text
|
|
|
|
def revised_template(self, components, country, language=None):
|
|
template = self.get_template(country, language=language)
|
|
if not template or 'address_template' not in template:
|
|
return None
|
|
|
|
country = country.lower()
|
|
|
|
template = template['address_template']
|
|
|
|
cache_keys = []
|
|
|
|
for component in components:
|
|
scope = country
|
|
insertions = nested_get(self.country_insertions, (country, component), default=None)
|
|
|
|
if insertions is None and language:
|
|
country_language = '{}_{}'.format(country, language)
|
|
insertions = nested_get(self.country_insertions, (country_language, component), default=None)
|
|
scope = country_language
|
|
|
|
if insertions is None and language:
|
|
insertions = nested_get(self.language_insertions, (language, component), default=None)
|
|
scope = language
|
|
|
|
if insertions is None:
|
|
insertions = nested_get(self.global_insertions, (component,), default=None)
|
|
scope = None
|
|
|
|
if insertions is not None:
|
|
values, probs = insertions
|
|
order, other = weighted_choice(values, probs)
|
|
|
|
insertion_id = (scope, component, order, other)
|
|
cache_keys.append(insertion_id)
|
|
|
|
cache_key = tuple(sorted(cache_keys))
|
|
|
|
if cache_key in self.template_cache:
|
|
template = self.template_cache[cache_key]
|
|
continue
|
|
|
|
if order == self.BEFORE and other in components:
|
|
template = self.insert_component(template, component, before=other)
|
|
elif order == self.AFTER and other in components:
|
|
template = self.insert_component(template, component, after=other)
|
|
elif order == self.LAST:
|
|
template = self.insert_component(template, component, last=True)
|
|
elif order == self.FIRST:
|
|
template = self.insert_component(template, component, first=True)
|
|
else:
|
|
continue
|
|
|
|
self.template_cache[cache_key] = template
|
|
|
|
return template
|
|
|
|
def tag_template_separators(self, template):
|
|
template = re.sub(r'}\s*([,\-;])\s*', r'}} \1/{} '.format(self.separator_tag), template)
|
|
return template
|
|
|
|
def strip_component(self, value, tagged=False):
|
|
if not tagged:
|
|
comma = token_types.COMMA.value
|
|
hyphen = token_types.HYPHEN.value
|
|
|
|
start = end = 0
|
|
tokens = tokenize_raw(value.strip())
|
|
for token_start, token_length, token_type in tokens:
|
|
start = token_start
|
|
if token_type not in (comma, hyphen):
|
|
break
|
|
else:
|
|
start = token_start + token_length
|
|
|
|
for token_start, token_length, token_type in reversed(tokens):
|
|
end = token_start + token_length
|
|
if token_type not in (comma, hyphen):
|
|
break
|
|
else:
|
|
end = token_start
|
|
|
|
return value[start:end]
|
|
else:
|
|
start = end = 0
|
|
tokens = value.split()
|
|
|
|
separator_tag = self.separator_tag
|
|
|
|
for i, t in enumerate(tokens):
|
|
t, c = t.rsplit('/', 1)
|
|
start = i
|
|
if c != separator_tag:
|
|
break
|
|
else:
|
|
start = i + 1
|
|
|
|
num_tokens = len(tokens)
|
|
|
|
for j, t in enumerate(reversed(tokens)):
|
|
t, c = t.rsplit('/', 1)
|
|
end = num_tokens - j
|
|
if c != separator_tag:
|
|
break
|
|
else:
|
|
end = num_tokens - j - 1
|
|
|
|
return six.u(' ').join(tokens[start:end])
|
|
|
|
def get_template(self, country, language=None):
|
|
template = None
|
|
if language:
|
|
# For countries like China and Japan where the country format varies
|
|
# based on which language is being used
|
|
template = self.country_formats.get('{}_{}'.format(country.upper(), language.lower()), None)
|
|
|
|
if not template:
|
|
template = self.country_formats.get(country.upper())
|
|
|
|
if not template:
|
|
return None
|
|
|
|
use_country = template.get('use_country')
|
|
if use_country and use_country.upper() in self.country_formats:
|
|
template = self.country_formats[use_country.upper()]
|
|
|
|
if 'address_template' not in template:
|
|
return None
|
|
|
|
return template
|
|
|
|
def format_address(self, country, components, language=None,
|
|
minimal_only=True, tag_components=True, replace_aliases=True):
|
|
template = self.get_template(country, language=language)
|
|
if not template:
|
|
return None
|
|
|
|
template_text = self.revised_template(components, country, language=language)
|
|
if replace_aliases:
|
|
self.aliases.replace(components)
|
|
|
|
if minimal_only and not self.minimal_components(components):
|
|
return None
|
|
|
|
if tag_components:
|
|
template_text = self.tag_template_separators(template_text)
|
|
components = {k: six.u(' ').join([six.u('{}/{}').format(t.replace(' ', ''), k.replace(' ', '_'))
|
|
for t, c in tokenize(v)])
|
|
for k, v in components.iteritems()}
|
|
|
|
text = self.render_template(template_text, components, tagged=tag_components)
|
|
|
|
text = self.post_replacements(template, text)
|
|
return text
|