Skip to content

Field

metaxy.FieldKey 

FieldKey(parts: str | Sequence[str] | FieldKey)

Bases: _Key

Field key as a sequence of string parts.

Hashable for use as dict keys in registries. Parts cannot contain forward slashes (/) or double underscores (__).

Example:

```py
FieldKey("a/b/c")  # String format
# FieldKey(parts=['a', 'b', 'c'])

FieldKey(["a", "b", "c"])  # List format
# FieldKey(parts=['a', 'b', 'c'])

FieldKey(FieldKey(["a", "b", "c"]))  # FieldKey copy
# FieldKey(parts=['a', 'b', 'c'])
```
Source code in src/metaxy/models/types.py 
def __init__(
    self,
    parts: str | Sequence[str] | FieldKey,
) -> None: ...

Attributes

metaxy.FieldKey.parts property 

parts: tuple[str, ...]

Backward compatibility property for accessing root as parts.

metaxy.FieldKey.table_name property 

table_name: str

Get SQL-like table name for this feature key.

Replaces hyphens with underscores for SQL compatibility.

Functions

metaxy.FieldKey.to_string 

to_string() -> str

Convert to string representation with "/" separator.

Source code in src/metaxy/models/types.py 
def to_string(self) -> str:
    """Convert to string representation with "/" separator."""
    return KEY_SEPARATOR.join(self.parts)

metaxy.FieldKey.to_struct_key 

to_struct_key() -> str

Convert to a name that can be used as struct key in databases

Source code in src/metaxy/models/types.py 
def to_struct_key(self) -> str:
    """Convert to a name that can be used as struct key in databases"""
    return "_".join(self.parts)

metaxy.FieldKey.to_column_suffix 

to_column_suffix() -> str

Convert to a suffix usable for database column names (typically temporary).

Source code in src/metaxy/models/types.py 
def to_column_suffix(self) -> str:
    """Convert to a suffix usable for database column names (typically temporary)."""
    return "__" + "_".join(self.parts)

metaxy.FieldKey.__repr__ 

__repr__() -> str

Return string representation.

Source code in src/metaxy/models/types.py 
def __repr__(self) -> str:
    """Return string representation."""
    return self.to_string()

metaxy.FieldKey.__str__ 

__str__() -> str

Return string representation.

Source code in src/metaxy/models/types.py 
def __str__(self) -> str:
    """Return string representation."""
    return self.to_string()

metaxy.FieldKey.__lt__ 

__lt__(other: Any) -> bool

Less than comparison for sorting.

Source code in src/metaxy/models/types.py 
def __lt__(self, other: Any) -> bool:
    """Less than comparison for sorting."""
    if isinstance(other, self.__class__):
        return self.parts < other.parts
    return NotImplemented

metaxy.FieldKey.__le__ 

__le__(other: Any) -> bool

Less than or equal comparison for sorting.

Source code in src/metaxy/models/types.py 
def __le__(self, other: Any) -> bool:
    """Less than or equal comparison for sorting."""
    if isinstance(other, self.__class__):
        return self.parts <= other.parts
    return NotImplemented

metaxy.FieldKey.__gt__ 

__gt__(other: Any) -> bool

Greater than comparison for sorting.

Source code in src/metaxy/models/types.py 
def __gt__(self, other: Any) -> bool:
    """Greater than comparison for sorting."""
    if isinstance(other, self.__class__):
        return self.parts > other.parts
    return NotImplemented

metaxy.FieldKey.__ge__ 

__ge__(other: Any) -> bool

Greater than or equal comparison for sorting.

Source code in src/metaxy/models/types.py 
def __ge__(self, other: Any) -> bool:
    """Greater than or equal comparison for sorting."""
    if isinstance(other, self.__class__):
        return self.parts >= other.parts
    return NotImplemented

metaxy.FieldKey.__iter__ 

__iter__() -> Iterator[str]

Return iterator over parts.

Source code in src/metaxy/models/types.py 
def __iter__(self) -> Iterator[str]:  # ty: ignore[invalid-method-override]
    """Return iterator over parts."""
    return iter(self.parts)

metaxy.FieldKey.__getitem__ 

__getitem__(index: int) -> str

Get part by index.

Source code in src/metaxy/models/types.py 
def __getitem__(self, index: int) -> str:
    """Get part by index."""
    return self.parts[index]

metaxy.FieldKey.__len__ 

__len__() -> int

Get number of parts.

Source code in src/metaxy/models/types.py 
def __len__(self) -> int:
    """Get number of parts."""
    return len(self.parts)

metaxy.FieldKey.__contains__ 

__contains__(item: str) -> bool

Check if part is in key.

Source code in src/metaxy/models/types.py 
def __contains__(self, item: str) -> bool:
    """Check if part is in key."""
    return item in self.parts

metaxy.FieldKey.__reversed__ 

__reversed__()

Return reversed iterator over parts.

Source code in src/metaxy/models/types.py 
def __reversed__(self):
    """Return reversed iterator over parts."""
    return reversed(self.parts)

metaxy.FieldKey.model_dump 

model_dump(**kwargs: Any) -> Any

Serialize to string format for JSON dict key compatibility.

Source code in src/metaxy/models/types.py 
def model_dump(self, **kwargs: Any) -> Any:
    """Serialize to string format for JSON dict key compatibility."""
    return self.to_string()

metaxy.FieldKey.__hash__ 

__hash__() -> int

Return hash for use as dict keys.

Source code in src/metaxy/models/types.py 
def __hash__(self) -> int:
    """Return hash for use as dict keys."""
    return hash(self.parts)

metaxy.FieldKey.__eq__ 

__eq__(other: Any) -> bool

Check equality with another instance.

Source code in src/metaxy/models/types.py 
def __eq__(self, other: Any) -> bool:
    """Check equality with another instance."""
    if isinstance(other, self.__class__):
        return self.parts == other.parts
    return super().__eq__(other)

metaxy.FieldSpec pydantic-model 

FieldSpec(*, key: CoercibleToFieldKey | None = None, code_version: str = DEFAULT_CODE_VERSION, deps: SpecialFieldDep | list[FieldDep] | None = None)

Bases: BaseModel

Show JSON schema: 
{
  "$defs": {
    "FeatureKey": {
      "description": "Feature key as a sequence of string parts.\n\nHashable for use as dict keys in registries.\nParts cannot contain forward slashes (/) or double underscores (__).\n\nExample:\n\n    ```py\n    FeatureKey(\"a/b/c\")  # String format\n    # FeatureKey(parts=['a', 'b', 'c'])\n\n    FeatureKey([\"a\", \"b\", \"c\"])  # List format\n    # FeatureKey(parts=['a', 'b', 'c'])\n\n    FeatureKey(FeatureKey([\"a\", \"b\", \"c\"]))  # FeatureKey copy\n    # FeatureKey(parts=['a', 'b', 'c'])\n    ```",
      "items": {
        "type": "string"
      },
      "title": "FeatureKey",
      "type": "array"
    },
    "FieldDep": {
      "additionalProperties": false,
      "properties": {
        "feature": {
          "$ref": "#/$defs/FeatureKey"
        },
        "fields": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/FieldKey"
              },
              "type": "array"
            },
            {
              "const": "__METAXY_ALL_DEP__",
              "type": "string"
            }
          ],
          "default": "__METAXY_ALL_DEP__",
          "title": "Fields"
        }
      },
      "required": [
        "feature"
      ],
      "title": "FieldDep",
      "type": "object"
    },
    "FieldKey": {
      "description": "Field key as a sequence of string parts.\n\nHashable for use as dict keys in registries.\nParts cannot contain forward slashes (/) or double underscores (__).\n\nExample:\n\n    ```py\n    FieldKey(\"a/b/c\")  # String format\n    # FieldKey(parts=['a', 'b', 'c'])\n\n    FieldKey([\"a\", \"b\", \"c\"])  # List format\n    # FieldKey(parts=['a', 'b', 'c'])\n\n    FieldKey(FieldKey([\"a\", \"b\", \"c\"]))  # FieldKey copy\n    # FieldKey(parts=['a', 'b', 'c'])\n    ```",
      "items": {
        "type": "string"
      },
      "title": "FieldKey",
      "type": "array"
    },
    "SpecialFieldDep": {
      "enum": [
        "__METAXY_ALL_DEP__"
      ],
      "title": "SpecialFieldDep",
      "type": "string"
    }
  },
  "additionalProperties": false,
  "properties": {
    "key": {
      "$ref": "#/$defs/FieldKey"
    },
    "code_version": {
      "default": "__metaxy_initial__",
      "title": "Code Version",
      "type": "string"
    },
    "deps": {
      "anyOf": [
        {
          "$ref": "#/$defs/SpecialFieldDep"
        },
        {
          "items": {
            "$ref": "#/$defs/FieldDep"
          },
          "type": "array"
        }
      ],
      "title": "Deps"
    }
  },
  "title": "FieldSpec",
  "type": "object"
}

Config:

  • default: {'extra': 'forbid'}

Fields:

Source code in src/metaxy/models/field.py 
def __init__(
    self,
    *,
    key: CoercibleToFieldKey | None = None,
    code_version: str = DEFAULT_CODE_VERSION,
    deps: SpecialFieldDep | list[FieldDep] | None = None,
) -> None: ...

Functions

metaxy.FieldSpec.__get_pydantic_core_schema__ classmethod 

__get_pydantic_core_schema__(source_type, handler)

Add custom validator to coerce strings to FieldSpec.

Source code in src/metaxy/models/field.py 
@classmethod
def __get_pydantic_core_schema__(cls, source_type, handler):
    """Add custom validator to coerce strings to FieldSpec."""
    from pydantic_core import core_schema

    # Get the default schema
    python_schema = handler(source_type)

    # Wrap it with a before validator that converts strings
    return core_schema.no_info_before_validator_function(
        _validate_field_spec_from_string,
        python_schema,
    )

metaxy.FieldDep pydantic-model 

FieldDep(*, feature: str | Sequence[str] | FeatureKey | FeatureSpec | type[BaseFeature], fields: list[CoercibleToFieldKey] | Literal[ALL] = ALL)

Bases: BaseModel

Show JSON schema: 
{
  "$defs": {
    "FeatureKey": {
      "description": "Feature key as a sequence of string parts.\n\nHashable for use as dict keys in registries.\nParts cannot contain forward slashes (/) or double underscores (__).\n\nExample:\n\n    ```py\n    FeatureKey(\"a/b/c\")  # String format\n    # FeatureKey(parts=['a', 'b', 'c'])\n\n    FeatureKey([\"a\", \"b\", \"c\"])  # List format\n    # FeatureKey(parts=['a', 'b', 'c'])\n\n    FeatureKey(FeatureKey([\"a\", \"b\", \"c\"]))  # FeatureKey copy\n    # FeatureKey(parts=['a', 'b', 'c'])\n    ```",
      "items": {
        "type": "string"
      },
      "title": "FeatureKey",
      "type": "array"
    },
    "FieldKey": {
      "description": "Field key as a sequence of string parts.\n\nHashable for use as dict keys in registries.\nParts cannot contain forward slashes (/) or double underscores (__).\n\nExample:\n\n    ```py\n    FieldKey(\"a/b/c\")  # String format\n    # FieldKey(parts=['a', 'b', 'c'])\n\n    FieldKey([\"a\", \"b\", \"c\"])  # List format\n    # FieldKey(parts=['a', 'b', 'c'])\n\n    FieldKey(FieldKey([\"a\", \"b\", \"c\"]))  # FieldKey copy\n    # FieldKey(parts=['a', 'b', 'c'])\n    ```",
      "items": {
        "type": "string"
      },
      "title": "FieldKey",
      "type": "array"
    }
  },
  "additionalProperties": false,
  "properties": {
    "feature": {
      "$ref": "#/$defs/FeatureKey"
    },
    "fields": {
      "anyOf": [
        {
          "items": {
            "$ref": "#/$defs/FieldKey"
          },
          "type": "array"
        },
        {
          "const": "__METAXY_ALL_DEP__",
          "type": "string"
        }
      ],
      "default": "__METAXY_ALL_DEP__",
      "title": "Fields"
    }
  },
  "required": [
    "feature"
  ],
  "title": "FieldDep",
  "type": "object"
}

Config:

  • default: {'extra': 'forbid'}

Fields:

Source code in src/metaxy/models/field.py 
def __init__(
    self,
    *,
    feature: str
    | Sequence[str]
    | FeatureKey
    | "FeatureSpec"
    | type["BaseFeature"],
    fields: list[CoercibleToFieldKey]
    | Literal[SpecialFieldDep.ALL] = SpecialFieldDep.ALL,
) -> None: ...