Skip to content

Names

A person, company or thing name. The rigour library contains many functions for the processing, cleaning, annotation and comparison of names in rigour.names.

Attribute Value Detail
name name Used in schema definitions
label Name plural: Names
group names Used in search indexing to query all properties of a given type
matchable Suitable for use in entity matching
pivot Suitable for use as a pivot point for connecting to other entities

Python API

followthemoney.types.NameType

Bases: PropertyType

A name used for a person or company. This is assumed to be as complete a name as available - when a first name, family name or patronymic are given separately, these are stored to string-type properties instead.

No validation rules apply, and things having multiple names must be considered a perfectly ordinary case.

Source code in followthemoney/types/name.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
class NameType(PropertyType):
    """A name used for a person or company. This is assumed to be as complete
    a name as available - when a first name, family name or patronymic are given
    separately, these are stored to string-type properties instead.

    No validation rules apply, and things having multiple names must be considered
    a perfectly ordinary case."""

    name = const("name")
    group = const("names")
    label = _("Name")
    plural = _("Names")
    matchable = True
    pivot = True
    max_length = MAX_NAME_LENGTH

    def clean_text(
        self,
        text: str,
        fuzzy: bool = False,
        format: Optional[str] = None,
        proxy: Optional["EntityProxy"] = None,
    ) -> Optional[str]:
        """Basic clean-up."""
        name = strip_quotes(text)
        return collapse_spaces(name)

    def pick(self, values: Sequence[str]) -> Optional[str]:
        """From a set of names, pick the most plausible user-facing one."""
        return pick_name(list(values))

    def _specificity(self, value: str) -> float:
        # TODO: insert artificial intelligence here.
        return dampen(3, 50, value)

    def compare(self, left: str, right: str) -> float:
        """Compare two names for similarity."""
        left_clean = " ".join(tokenize_name(left.lower()))
        right_clean = " ".join(tokenize_name(right.lower()))
        if not len(left_clean) or not len(right_clean):
            return 0.0
        return levenshtein_similarity(
            left_clean,
            right_clean,
            max_length=self.max_length,
        )

    def node_id(self, value: str) -> Optional[str]:
        slug = slugify(value)
        if slug is None:
            return None
        return f"name:{slug}"

clean_text(text, fuzzy=False, format=None, proxy=None)

Basic clean-up.

Source code in followthemoney/types/name.py 
32
33
34
35
36
37
38
39
40
41
def clean_text(
    self,
    text: str,
    fuzzy: bool = False,
    format: Optional[str] = None,
    proxy: Optional["EntityProxy"] = None,
) -> Optional[str]:
    """Basic clean-up."""
    name = strip_quotes(text)
    return collapse_spaces(name)

compare(left, right)

Compare two names for similarity.

Source code in followthemoney/types/name.py 
51
52
53
54
55
56
57
58
59
60
61
def compare(self, left: str, right: str) -> float:
    """Compare two names for similarity."""
    left_clean = " ".join(tokenize_name(left.lower()))
    right_clean = " ".join(tokenize_name(right.lower()))
    if not len(left_clean) or not len(right_clean):
        return 0.0
    return levenshtein_similarity(
        left_clean,
        right_clean,
        max_length=self.max_length,
    )

pick(values)

From a set of names, pick the most plausible user-facing one.

Source code in followthemoney/types/name.py 
43
44
45
def pick(self, values: Sequence[str]) -> Optional[str]:
    """From a set of names, pick the most plausible user-facing one."""
    return pick_name(list(values))