Bases: PropertyType
A reference to another entity via its ID. This is how entities in FtM
become a graph: by pointing at each other using references.
Entity IDs can either be namespaced or plain, depending on the context.
When setting properties of this type, you can pass in an entity proxy or
dict of the entity, the ID will then be extracted and stored.
Source code in followthemoney/types/entity.py
| class EntityType(PropertyType):
"""A reference to another entity via its ID. This is how entities in FtM
become a graph: by pointing at each other using references.
Entity IDs can either be `namespaced` or `plain`, depending on the context.
When setting properties of this type, you can pass in an entity proxy or
dict of the entity, the ID will then be extracted and stored.
"""
REGEX_RAW = r"^[0-9a-zA-Z]([0-9a-zA-Z\.\-]*[0-9a-zA-Z])?$"
REGEX = re.compile(REGEX_RAW)
name = const("entity")
group = const("entities")
label = _("Entity")
plural = _("Entities")
matchable = True
pivot = True
max_length = ENTITY_ID_LEN
def validate(
self, value: Value, fuzzy: bool = False, format: Optional[str] = None
) -> bool:
text = sanitize_text(value)
if text is None:
return False
return self.REGEX.match(text) is not None
def clean(
self,
raw: Any,
fuzzy: bool = False,
format: Optional[str] = None,
proxy: Optional["EntityProxy"] = None,
) -> Optional[str]:
entity_id = get_entity_id(raw)
if entity_id is None:
return None
return self.clean_text(entity_id, fuzzy=fuzzy, format=format, proxy=proxy)
def clean_text(
self,
text: str,
fuzzy: bool = False,
format: Optional[str] = None,
proxy: Optional["EntityProxy"] = None,
) -> Optional[str]:
"""Specific types can apply their own cleaning routines here (this is called
by ``clean`` after the value has been converted to a string and null values
have been filtered)."""
if proxy is not None and text == proxy.id:
msg = gettext("Self-relationship (%s): %s")
raise InvalidData(msg % (proxy.schema, text))
if self.REGEX.match(text) is not None:
return text
return None
|
clean_text(text, fuzzy=False, format=None, proxy=None)
Specific types can apply their own cleaning routines here (this is called
by clean after the value has been converted to a string and null values
have been filtered).
Source code in followthemoney/types/entity.py
| def clean_text(
self,
text: str,
fuzzy: bool = False,
format: Optional[str] = None,
proxy: Optional["EntityProxy"] = None,
) -> Optional[str]:
"""Specific types can apply their own cleaning routines here (this is called
by ``clean`` after the value has been converted to a string and null values
have been filtered)."""
if proxy is not None and text == proxy.id:
msg = gettext("Self-relationship (%s): %s")
raise InvalidData(msg % (proxy.schema, text))
if self.REGEX.match(text) is not None:
return text
return None
|