followthemoney 1.3.7__py3-none-any.whl → 3.8.0__py3-none-any.whl

followthemoney/schema.py

@@ -1,193 +1,464 @@
-from rdflib import URIRef
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    Dict,
+    List,
+    Optional,
+    Set,
+    TypedDict,
+    Union,
+    cast,
+)
 from banal import ensure_list, ensure_dict, as_bool
+from functools import lru_cache
 
-from followthemoney.property import Property
+from followthemoney.property import Property, PropertySpec, PropertyToDict, ReverseSpec
 from followthemoney.types import registry
 from followthemoney.exc import InvalidData, InvalidModel
-from followthemoney.util import gettext, NAMESPACE
+from followthemoney.rdf import URIRef, NS
+from followthemoney.util import gettext
 
+if TYPE_CHECKING:
+    from followthemoney.model import Model
 
-class Schema(object):
-    """Defines the abstract data model.
 
-    Schema items define the entities and links available in the model.
+class EdgeSpec(TypedDict, total=False):
+    source: str
+    target: str
+    caption: List[str]
+    label: str
+    directed: bool
+
+
+class TemporalExtentSpec(TypedDict, total=False):
+    start: List[str]
+    end: List[str]
+
+
+class SchemaSpec(TypedDict, total=False):
+    label: str
+    plural: str
+    schemata: List[str]
+    extends: List[str]
+    properties: Dict[str, PropertySpec]
+    featured: List[str]
+    required: List[str]
+    caption: List[str]
+    edge: EdgeSpec
+    temporalExtent: TemporalExtentSpec
+    description: Optional[str]
+    rdf: Optional[str]
+    abstract: bool
+    hidden: bool
+    generated: bool
+    matchable: bool
+    deprecated: Optional[bool]
+
+
+class SchemaToDict(TypedDict, total=False):
+    label: str
+    plural: str
+    schemata: List[str]
+    extends: List[str]
+    properties: Dict[str, PropertyToDict]
+    featured: List[str]
+    required: List[str]
+    caption: List[str]
+    edge: EdgeSpec
+    temporalExtent: TemporalExtentSpec
+    description: Optional[str]
+    abstract: bool
+    hidden: bool
+    generated: bool
+    matchable: bool
+    deprecated: bool
+
+
+class Schema:
+    """A type definition for a class of entities that have certain properties.
+
+    Schemata are arranged in a multi-rooted hierarchy: each schema can have multiple
+    parent schemata from which it inherits all of their properties. A schema can also
+    have descendant child schemata, which, in turn, add further properties. Schemata
+    are usually accessed via the model, which holds all available definitions.
     """
 
-    def __init__(self, model, name, data):
-        self.model = model
+    __slots__ = (
+        "model",
+        "name",
+        "_label",
+        "_plural",
+        "_description",
+        "_hash",
+        "uri",
+        "abstract",
+        "hidden",
+        "generated",
+        "matchable",
+        "featured",
+        "required",
+        "deprecated",
+        "caption",
+        "edge",
+        "_edge_label",
+        "edge_directed",
+        "edge_source",
+        "edge_target",
+        "edge_caption",
+        "temporal_start",
+        "temporal_end",
+        "_extends",
+        "extends",
+        "schemata",
+        "names",
+        "descendants",
+        "properties",
+        "_matchable_schemata",
+    )
+
+    def __init__(self, model: "Model", name: str, data: SchemaSpec) -> None:
+        #: Machine-readable name of the schema, used for identification.
         self.name = name
-        self.data = data
-        self.icon = data.get('icon')
-        self._label = data.get('label', name)
-        self._plural = data.get('plural', self.label)
-        self._description = data.get('description')
-        self._extends = ensure_list(data.get('extends'))
-        self.featured = ensure_list(data.get('featured'))
-
-        self.uri = NAMESPACE[name]
-        if 'rdf' in data:
-            self.uri = URIRef(data.get('rdf'))
-
-        # Do not show in listings:
-        self.abstract = as_bool(data.get('abstract'), False)
-
-        # Try to perform fuzzy matching. Fuzzy similarity search does not
-        # make sense for entities which have a lot of similar names, such
-        # as land plots, assets etc.
-        self.matchable = as_bool(data.get('matchable'), True)
-
-        self._own_properties = []
-        for name, prop in data.get('properties', {}).items():
-            self._own_properties.append(Property(self, name, prop))
-
-    def generate(self):
-        for prop in self._own_properties:
-            prop.generate()
+        self.model = model
+        self._label = data.get("label", name)
+        self._plural = data.get("plural", self.label)
+        self._description = data.get("description")
+        self._hash = hash("<Schema(%r)>" % name)
+
+        #: RDF identifier for this schema when it is transformed to a triple term.
+        self.uri = URIRef(cast(str, data.get("rdf", NS[name])))
+
+        #: Do not store or emit entities of this type, it is used only for
+        #: inheritance.
+        self.abstract = as_bool(data.get("abstract"), False)
+
+        #: This schema is deprecated and should not be used.
+        self.deprecated = as_bool(data.get("deprecated", False))
+
+        #: Hide this schema in listings.
+        self.hidden = as_bool(data.get("hidden"), False)
+        self.hidden = self.hidden and not self.abstract
+
+        #: Entities with this type are generated by the system - for example, via
+        #: `ingest-file`. The user should not be offered an option to create them
+        #: in the interface.
+        self.generated = as_bool(data.get("generated"), False)
+
+        #: Try to perform fuzzy matching. Fuzzy similarity search does not
+        #: make sense for entities which have a lot of similar names, such
+        #: as land plots, assets etc.
+        self.matchable = as_bool(data.get("matchable"), True)
+
+        #: Mark a set of properties as important, i.e. they should be shown
+        #: first, or in an abridged view of the entity. In Aleph, these properties
+        #: are included in tabular entity listings.
+        self.featured = ensure_list(data.get("featured", []))
+
+        #: Mark a set of properties as required. This is applied only when
+        #: an entity is created by the user - bulk created entities will
+        #: slip through even if it is technically invalid.
+        self.required = ensure_list(data.get("required", []))
+
+        #: Mark a set of properties to be used for the entity's caption.
+        #: They will be checked in order and the first existent value will
+        #: be used.
+        self.caption = ensure_list(data.get("caption", []))
+
+        # A transform of the entity into an edge for its representation in
+        # the context of a property graph representation like Neo4J/Gephi.
+        edge = data.get("edge", {})
+        self.edge_source = edge.get("source")
+        self.edge_target = edge.get("target")
+
+        #: Flag to indicate if this schema should be represented by an edge (rather than
+        #: a node) when the data is converted into a property graph.
+        self.edge: bool = self.edge_source is not None and self.edge_target is not None
+        self.edge_caption = ensure_list(edge.get("caption", []))
+        self._edge_label = edge.get("label", self._label)
+
+        #: Flag to indicate if the edge should be presented as directed to the user,
+        #: e.g. by showing an error at the target end of the edge.
+        self.edge_directed = as_bool(edge.get("directed", True))
+
+        #: Specify which properties should be used to represent this schema in a
+        #: timeline.
+        temporal_extent = data.get("temporalExtent", {})
+        self.temporal_start = set(temporal_extent.get("start", []))
+        self.temporal_end = set(temporal_extent.get("end", []))
+
+        #: Direct parent schemata of this schema.
+        self._extends = ensure_list(data.get("extends", []))
+        self.extends: Set["Schema"] = set()
+
+        #: All parents of this schema (including indirect parents and the schema
+        #: itself).
+        self.schemata = set([self])
+
+        #: All names of :attr:`~schemata`.
+        self.names = set([self.name])
+
+        #: Inverse of :attr:`~schemata`, all derived child types of this schema
+        #: and their children.
+        self.descendants: Set["Schema"] = set()
+        self._matchable_schemata: Optional[Set["Schema"]] = None
+
+        #: The full list of properties defined for the entity, including those
+        #: inherited from parent schemata.
+        self.properties: Dict[str, Property] = {}
+        for name, prop in data.get("properties", {}).items():
+            self.properties[name] = Property(self, name, prop)
+
+    def generate(self, model: "Model") -> None:
+        """While loading the schema, this function will validate and
+        load the hierarchy, properties, and flags of the definition."""
+        for extends in self._extends:
+            parent = model.get(extends)
+            if parent is None:
+                raise InvalidData("Invalid extends: %r" % extends)
+            parent.generate(model)
+
+            for name, prop in parent.properties.items():
+                if name not in self.properties:
+                    self.properties[name] = prop
+
+            self.extends.add(parent)
+            for ancestor in parent.schemata:
+                self.schemata.add(ancestor)
+                self.names.add(ancestor.name)
+                ancestor.descendants.add(self)
+
+            self.temporal_start |= parent.temporal_start
+            self.temporal_end |= parent.temporal_end
+
+        for prop in list(self.properties.values()):
+            prop.generate(model)
 
         for featured in self.featured:
             if self.get(featured) is None:
                 raise InvalidModel("Missing featured property: %s" % featured)
 
-    def _add_reverse(self, data, other):
-        name = data.pop('name', None)
+        for caption in self.caption:
+            prop_ = self.get(caption)
+            if prop_ is None:
+                raise InvalidModel("Missing caption property: %s" % caption)
+            if prop_.type == registry.entity:
+                raise InvalidModel("Caption cannot be entity: %s" % caption)
+
+        for required in self.required:
+            if self.get(required) is None:
+                raise InvalidModel("Missing required property: %s" % required)
+
+        if self.edge:
+            if self.source_prop is None:
+                msg = "Missing edge source: %s" % self.edge_source
+                raise InvalidModel(msg)
+
+            if self.target_prop is None:
+                msg = "Missing edge target: %s" % self.edge_target
+                raise InvalidModel(msg)
+
+    def _add_reverse(
+        self, model: "Model", data: ReverseSpec, other: Property
+    ) -> Property:
+        name = data.get("name")
         if name is None:
             raise InvalidModel("Unnamed reverse: %s" % other)
 
         prop = self.get(name)
         if prop is None:
-            data.update({
-                'type': 'entity',
-                'reverse': {'name': other.name},
-                'schema': other.schema.name
-            })
-            prop = Property(self, name, data, stub=True)
-            prop.generate()
-            self._own_properties.append(prop)
-            self._flush_properties()
-        assert prop.type == registry.entity, prop.type
+            spec: PropertySpec = {
+                "label": data.get("label"),
+                "type": registry.entity.name,
+                "reverse": {"name": other.name},
+                "range": other.schema.name,
+                "hidden": data.get("hidden", other.hidden),
+            }
+            prop = Property(self, name, spec)
+            prop.stub = True
+            prop.generate(model)
+            self.properties[name] = prop
         return prop
 
     @property
-    def label(self):
+    def label(self) -> str:
+        """User-facing name of the schema."""
         return gettext(self._label)
 
     @property
-    def plural(self):
+    def plural(self) -> str:
+        """Name of the schema to be used in plural constructions."""
         return gettext(self._plural)
 
     @property
-    def description(self):
+    def description(self) -> Optional[str]:
+        """A longer description of the semantics of the schema."""
         return gettext(self._description)
 
     @property
-    def extends(self):
-        """Return the inherited schemata."""
-        for base in self._extends:
-            basecls = self.model.get(base)
-            if basecls is None:
-                raise InvalidModel("No such schema: %s" % base)
-            yield basecls
+    def edge_label(self) -> Optional[str]:
+        """Description label for edges derived from entities of this schema."""
+        return gettext(self._edge_label)
 
     @property
-    def schemata(self):
-        """Return the full inheritance chain."""
-        seen = set([self])
-        yield self
-        for base in self.extends:
-            for schema in base.schemata:
-                if schema not in seen:
-                    seen.add(schema)
-                    yield schema
+    def source_prop(self) -> Optional[Property]:
+        """The entity property to be used as an edge source."""
+        return self.get(self.edge_source)
 
     @property
-    def descendants(self):
-        for schema in self.model:
-            if schema == self:
-                continue
-            if self in schema.schemata:
-                yield schema
+    def target_prop(self) -> Optional[Property]:
+        """The entity property to be used as an edge target."""
+        return self.get(self.edge_target)
 
     @property
-    def matchable_schemata(self):
-        """The set of comparable types."""
-        if not self.matchable:
-            return
-        # This is used by the cross-referencer to determine what
-        # other schemata should be considered for matches. For
-        # example, a Company may be compared to a Legal Entity,
-        # but it makes no sense to compare it to an Aircraft.
-        matchable = set(self.schemata)
-        for schema in self.descendants:
-            matchable.add(schema)
-        for schema in matchable:
-            if schema.matchable:
-                yield schema
+    def temporal_start_props(self) -> Set[Property]:
+        """The entity properties to be used as the start when representing the entity
+        in a timeline."""
+        props = [self.get(prop_name) for prop_name in self.temporal_start]
+        return set([prop for prop in props if prop is not None])
 
     @property
-    def names(self):
-        return [s.name for s in self.schemata]
+    def temporal_end_props(self) -> Set[Property]:
+        """The entity properties to be used as the end when representing the entity
+        in a timeline."""
+        props = [self.get(prop_name) for prop_name in self.temporal_end]
+        return set([prop for prop in props if prop is not None])
 
-    def is_a(self, parent):
-        for schema in self.schemata:
-            if schema == parent:
-                return True
-        return False
+    @property
+    def sorted_properties(self) -> List[Property]:
+        """All properties of the schema in the order in which they should be shown
+        to the user (alphabetically, with captions and featured properties first)."""
+        return sorted(
+            self.properties.values(),
+            key=lambda p: (
+                p.name not in self.caption,
+                p.name not in self.featured,
+                p.label,
+            ),
+        )
 
     @property
-    def properties(self):
-        """Return properties, those defined locally and in ancestors."""
-        if not hasattr(self, '_properties') or self._properties is None:
-            self._properties = {}
-            for schema in self.extends:
-                for name, prop in schema.properties.items():
-                    self._properties[name] = prop
-            for prop in self._own_properties:
-                self._properties[prop.name] = prop
-        return self._properties
-
-    def _flush_properties(self):
-        for schema in self.descendants:
-            schema._flush_properties()
-        self._properties = None
-
-    def get(self, name):
+    def matchable_schemata(self) -> Set["Schema"]:
+        """Return the set of schemata to which it makes sense to compare with this
+        schema. For example, it makes sense to compare a legal entity with a company,
+        but it does not make sense to compare a car and a person."""
+        if self._matchable_schemata is None:
+            self._matchable_schemata = set()
+            if self.matchable:
+                # This is used by the cross-referencer to determine what
+                # other schemata should be considered for matches. For
+                # example, a Company may be compared to a Legal Entity,
+                # but it makes no sense to compare it to an Aircraft.
+                candidates = set(self.schemata)
+                candidates.update(self.descendants)
+                for schema in candidates:
+                    if schema.matchable:
+                        self._matchable_schemata.add(schema)
+        return self._matchable_schemata
+
+    def can_match(self, other: "Schema") -> bool:
+        """Check if an schema can match with another schema."""
+        return other in self.matchable_schemata
+
+    @lru_cache(maxsize=None)
+    def is_a(self, other: Union[str, "Schema"]) -> bool:
+        """Check if the schema or one of its parents is the same as the given
+        candidate ``other``."""
+        if not isinstance(other, str):
+            other = other.name
+        return other in self.names
+
+    def get(self, name: Optional[str]) -> Optional[Property]:
+        """Retrieve a property defined for this schema by its name."""
+        if name is None:
+            return None
         return self.properties.get(name)
 
-    def validate(self, data):
-        """Validate a dataset against the given schema.
-        This will also drop keys which are not present as properties.
+    def validate(self, data: Any) -> Optional[str]:
+        """Validate a dictionary against the given schema.
+        This will also drop keys which are not valid as properties.
         """
         errors = {}
-        properties = ensure_dict(data.get('properties'))
+        properties = cast(Dict[str, Any], ensure_dict(data.get("properties")))
         for name, prop in self.properties.items():
-            values = properties.get(name)
+            values = ensure_list(properties.get(name, []))
             error = prop.validate(values)
+            if error is None and not len(values):
+                if prop.name in self.required:
+                    error = gettext("Required")
             if error is not None:
                 errors[name] = error
         if len(errors):
-            raise InvalidData({'properties': errors})
-
-    def to_dict(self):
-        data = {
-            'label': self.label,
-            'plural': self.plural,
-            'icon': self.icon,
-            'uri': str(self.uri),
-            'abstract': self.abstract,
-            'matchable': self.matchable,
-            'description': self.description,
-            'featured': self.featured,
-            'properties': {}
+            msg = gettext("Entity validation failed")
+            raise InvalidData(msg, errors={"properties": errors})
+        return None
+
+    def to_dict(self) -> SchemaToDict:
+        """Return schema metadata, including all properties, in a serializable form."""
+        data: SchemaToDict = {
+            "label": self.label,
+            "plural": self.plural,
+            "schemata": list(sorted(self.names)),
+            "extends": list(sorted([e.name for e in self.extends])),
         }
+        if self.edge_source and self.edge_target and self.edge_label:
+            data["edge"] = {
+                "source": self.edge_source,
+                "target": self.edge_target,
+                "caption": self.edge_caption,
+                "label": self.edge_label,
+                "directed": self.edge_directed,
+            }
+        start_props = [
+            prop.name for prop in self.temporal_start_props if prop.schema == self
+        ]
+        end_props = [
+            prop.name for prop in self.temporal_end_props if prop.schema == self
+        ]
+        if start_props or end_props:
+            data["temporalExtent"] = {
+                "start": sorted(start_props),
+                "end": sorted(end_props),
+            }
+        if len(self.featured):
+            data["featured"] = self.featured
+        if len(self.required):
+            data["required"] = self.required
+        if len(self.caption):
+            data["caption"] = self.caption
+        if self.description:
+            data["description"] = self.description
+        if self.abstract:
+            data["abstract"] = True
+        if self.hidden:
+            data["hidden"] = True
+        if self.generated:
+            data["generated"] = True
+        if self.matchable:
+            data["matchable"] = True
+        if self.deprecated:
+            data["deprecated"] = True
+        properties: Dict[str, PropertyToDict] = {}
         for name, prop in self.properties.items():
-            data['properties'][name] = prop.to_dict()
+            if prop.schema == self:
+                properties[name] = prop.to_dict()
+        data["properties"] = properties
         return data
 
-    def __eq__(self, other):
-        return hash(other) == hash(self)
+    def __eq__(self, other: Any) -> bool:
+        """Compare two schemata (via hash)."""
+        try:
+            return self._hash == hash(other)
+        except AttributeError:
+            return False
+
+    def __lt__(self, other: Any) -> bool:
+        return self.name.__lt__(other.name)
 
-    def __hash__(self):
-        return hash(self.name)
+    def __hash__(self) -> int:
+        try:
+            return self._hash
+        except AttributeError:
+            return super().__hash__()
 
-    def __repr__(self):
-        return '<Schema(%r)>' % self.name
+    def __repr__(self) -> str:
+        return "<Schema(%r)>" % self.name