class documentation

class FieldPath(list[FieldKey]): (source)

Constructor: FieldPath(base)

View In Hierarchy

Undocumented

Class Method unmarshal Undocumented
Method __add__ Undocumented
Method __eq__ Undocumented
Method __iadd__ Undocumented
Method __init__ Undocumented
Method __repr__ Undocumented
Method copy Undocumented
Method is_prefix_of Undocumented
Method marshal Undocumented
Method matches_reset_mask Undocumented
Method matches_reset_mask_final Undocumented
Method matches_select_mask Undocumented
Method matches_select_mask_inner Undocumented
Method parent Undocumented
Method to_mask Undocumented
Static Method _matches_reset_mask Undocumented
Static Method _matches_select_mask Undocumented
@classmethod
def unmarshal(cls, s: str) -> FieldPath | None: (source)

Undocumented

@overload
def __add__(self, value: Iterable[FieldKey | str]) -> FieldPath:
@overload
def __add__(self, value: Mask) -> Mask:
(source)

Undocumented

def __eq__(self, value: object) -> bool: (source)

Undocumented

def __iadd__(self, value: Iterable[FieldKey | str]) -> FieldPath: (source)

Undocumented

@overload
def __init__(self):
@overload
def __init__(self, base: Iterable[FieldKey | str]):
(source)

Undocumented

def __repr__(self) -> str: (source)

Undocumented

def copy(self) -> FieldPath: (source)

Undocumented

def is_prefix_of(self, value: FieldPath) -> bool: (source)

Undocumented

def marshal(self) -> str: (source)

Undocumented

def matches_reset_mask(self, mask: Mask | None) -> bool: (source)

Undocumented

def matches_reset_mask_final(self, mask: Mask | None) -> bool: (source)

Undocumented

def matches_select_mask(self, mask: Mask | None) -> bool: (source)

Undocumented

def matches_select_mask_inner(self, mask: Mask | None) -> tuple[bool, bool]: (source)

Undocumented

def parent(self) -> FieldPath | None: (source)

Undocumented

def to_mask(self) -> Mask: (source)

Undocumented

@staticmethod
def _matches_reset_mask(fp: FieldPath | list[FieldKey], mask: Mask | None) -> tuple[bool, bool]: (source)

Undocumented

@staticmethod
def _matches_select_mask(fp: FieldPath | list[FieldKey], mask: Mask | None) -> tuple[bool, bool]: (source)

Undocumented