Source code for feast.field

# Copyright 2022 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, Optional

from typeguard import typechecked

from feast.feature import Feature
from feast.protos.feast.core.Feature_pb2 import FeatureSpecV2 as FieldProto
from feast.types import FeastType, from_value_type
from feast.value_type import ValueType

[docs]@typechecked class Field: """ A Field represents a set of values with the same structure. Attributes: name: The name of the field. dtype: The type of the field, such as string or float. description: A human-readable description. tags: User-defined metadata in dictionary form. """ name: str dtype: FeastType description: str tags: Dict[str, str] def __init__( self, *, name: str, dtype: FeastType, description: str = "", tags: Optional[Dict[str, str]] = None, ): """ Creates a Field object. Args: name: The name of the field. dtype: The type of the field, such as string or float. description (optional): A human-readable description. tags (optional): User-defined metadata in dictionary form. """ = name self.dtype = dtype self.description = description self.tags = tags or {} def __eq__(self, other): if type(self) != type(other): return False if ( != or self.dtype != other.dtype or self.description != other.description or self.tags != other.tags ): return False return True def __hash__(self): return hash((, hash(self.dtype))) def __lt__(self, other): return < def __repr__(self): return f"{}-{self.dtype}" def __str__(self): return f"Field(name={}, dtype={self.dtype}, tags={self.tags})"
[docs] def to_proto(self) -> FieldProto: """Converts a Field object to its protobuf representation.""" value_type = self.dtype.to_value_type() return FieldProto(, value_type=value_type.value, description=self.description, tags=self.tags, )
[docs] @classmethod def from_proto(cls, field_proto: FieldProto): """ Creates a Field object from a protobuf representation. Args: field_proto: FieldProto protobuf object """ value_type = ValueType(field_proto.value_type) return cls(, dtype=from_value_type(value_type=value_type), tags=dict(field_proto.tags), description=field_proto.description, )
[docs] @classmethod def from_feature(cls, feature: Feature): """ Creates a Field object from a Feature object. Args: feature: Feature object to convert. """ return cls(, dtype=from_value_type(feature.dtype), description=feature.description, tags=feature.labels, )