Source code for feast.entity

# Copyright 2019 The Feast Authors
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# See the License for the specific language governing permissions and
# limitations under the License.

from typing import Dict, MutableMapping, Optional

import yaml
from google.protobuf import json_format
from google.protobuf.json_format import MessageToDict, MessageToJson
from google.protobuf.timestamp_pb2 import Timestamp

from feast.core.Entity_pb2 import Entity as EntityV2Proto
from feast.core.Entity_pb2 import EntityMeta as EntityMetaProto
from feast.core.Entity_pb2 import EntitySpecV2 as EntitySpecProto
from feast.loaders import yaml as feast_yaml
from feast.value_type import ValueType

[docs]class Entity: """ Represents a collection of entities and associated metadata. """ def __init__( self, name: str, description: str, value_type: ValueType, labels: Optional[MutableMapping[str, str]] = None, ): self._name = name self._description = description self._value_type = value_type if labels is None: self._labels = dict() # type: MutableMapping[str, str] else: self._labels = labels self._created_timestamp: Optional[Timestamp] = None self._last_updated_timestamp: Optional[Timestamp] = None def __eq__(self, other): if not isinstance(other, Entity): raise TypeError("Comparisons should only involve Entity class objects.") if ( self.labels != other.labels or != or self.description != other.description or self.value_type != other.value_type ): return False return True def __str__(self): return str(MessageToJson(self.to_proto())) @property def name(self): """ Returns the name of this entity """ return self._name @name.setter def name(self, name): """ Sets the name of this entity """ self._name = name @property def description(self): """ Returns the description of this entity """ return self._description @description.setter def description(self, description): """ Sets the description of this entity """ self._description = description @property def value_type(self) -> ValueType: """ Returns the type of this entity """ return self._value_type @value_type.setter def value_type(self, value_type: ValueType): """ Set the type for this entity """ self._value_type = value_type @property def labels(self): """ Returns the labels of this entity. This is the user defined metadata defined as a dictionary. """ return self._labels @labels.setter def labels(self, labels: MutableMapping[str, str]): """ Set the labels for this entity """ self._labels = labels @property def created_timestamp(self): """ Returns the created_timestamp of this entity """ return self._created_timestamp @property def last_updated_timestamp(self): """ Returns the last_updated_timestamp of this entity """ return self._last_updated_timestamp
[docs] def is_valid(self): """ Validates the state of a entity locally. Raises an exception if entity is invalid. """ if not raise ValueError("No name found in entity.") if not self.value_type: raise ValueError("No type found in entity {self.value_type}")
[docs] @classmethod def from_yaml(cls, yml: str): """ Creates an entity from a YAML string body or a file path Args: yml: Either a file path containing a yaml file or a YAML string Returns: Returns a EntityV2 object based on the YAML file """ return cls.from_dict(feast_yaml.yaml_loader(yml, load_single=True))
[docs] @classmethod def from_dict(cls, entity_dict): """ Creates an entity from a dict Args: entity_dict: A dict representation of an entity Returns: Returns a EntityV2 object based on the entity dict """ entity_proto = json_format.ParseDict( entity_dict, EntityV2Proto(), ignore_unknown_fields=True ) return cls.from_proto(entity_proto)
[docs] @classmethod def from_proto(cls, entity_proto: EntityV2Proto): """ Creates an entity from a protobuf representation of an entity Args: entity_proto: A protobuf representation of an entity Returns: Returns a EntityV2 object based on the entity protobuf """ entity = cls(, description=entity_proto.spec.description, value_type=ValueType(entity_proto.spec.value_type), labels=entity_proto.spec.labels, ) entity._created_timestamp = entity_proto.meta.created_timestamp entity._last_updated_timestamp = entity_proto.meta.last_updated_timestamp return entity
[docs] def to_proto(self) -> EntityV2Proto: """ Converts an entity object to its protobuf representation Returns: EntityV2Proto protobuf """ meta = EntityMetaProto( created_timestamp=self.created_timestamp, last_updated_timestamp=self.last_updated_timestamp, ) spec = EntitySpecProto(, description=self.description, value_type=self.value_type.value, labels=self.labels, ) return EntityV2Proto(spec=spec, meta=meta)
[docs] def to_dict(self) -> Dict: """ Converts entity to dict Returns: Dictionary object representation of entity """ entity_dict = MessageToDict(self.to_proto()) # Remove meta when empty for more readable exports if entity_dict["meta"] == {}: del entity_dict["meta"] return entity_dict
[docs] def to_yaml(self): """ Converts a entity to a YAML string. Returns: Entity string returned in YAML format """ entity_dict = self.to_dict() return yaml.dump(entity_dict, allow_unicode=True, sort_keys=False)
[docs] def to_spec_proto(self) -> EntitySpecProto: """ Converts an EntityV2 object to its protobuf representation. Used when passing EntitySpecV2 object to Feast request. Returns: EntitySpecV2 protobuf """ spec = EntitySpecProto(, description=self.description, value_type=self.value_type.value, labels=self.labels, ) return spec
def _update_from_entity(self, entity): """ Deep replaces one entity with another Args: entity: Entity to use as a source of configuration """ = self.description = entity.description self.value_type = entity.value_type self.labels = entity.labels self._created_timestamp = entity.created_timestamp self._last_updated_timestamp = entity.last_updated_timestamp