vaneseltine/nominally

"""Constants and config for nominally.

Primarily includes regex patterns and raw sets of particular name parts.
"""

import re

NO_WORD_BEHIND = r"(?<!\w)\s*"
NO_WORD_AHEAD = r"(?!\w)"

NICKNAME_BOUNDARIES = (
    [NO_WORD_BEHIND + r"\'", r"\'" + NO_WORD_AHEAD],
    [r'"'] * 2,
    [r"\(", r"\)"],
)

NICKNAME_PATTERNS = [
    re.compile(open_pattern + r"(.*?)" + close_pattern)
    for open_pattern, close_pattern in NICKNAME_BOUNDARIES
]

JUNIOR_PATTERN = re.compile(r",\s*junior\s*,")  # pylint: disable invalid-name

SUFFIX_PATTERNS = {
    re.compile(NO_WORD_BEHIND + s + NO_WORD_AHEAD): generational
    for s, generational in [
        (r"ph\.?d\.?", False),
        (r"m\.?d\.?", False),
        (r"j\.?d\.?", False),
        (r"jr\.?", True),
        (r"sr\.?", True),
        (r"(ii|iii|iv)", True),
        (r"1st|2nd|3rd|10th", True),
        (r"[4-9]th", True),
    ]
}

# Tokens that should join to their neighboring tokens, e.g. "and", "y" and "&".
CONJUNCTIONS = {"y"}

# Titles: cannot include things that could also be first names
TITLES = {"dr", "miss", "mr", "mrs", "ms", "mx"}

# Name tokens that appear before a last name. Prefixes join to the token
# that follows them to make one new token. They can be chained together, e.g
# "von der" and "de la".
PREFIXES = {
    "abu",
    "bin",
    "bon",
    "da",
    "dal",
    "de",
    "dei",
    "del",
    "dela",
    "della",
    "delle",
    "delli",
    "dello",
    "dem",
    "der",
    "di",
    "do",
    "dos",
    "du",
    "ibn",
    "la",
    "le",
    "mc",
    "mac",
    "san",
    "santa",
    "st",
    "ste",
    "van",
    "vel",
    "von",
}