Source code for static_frame.core.hloc

import typing as tp

from static_frame.core.util import EMPTY_TUPLE
from static_frame.core.util import GetItemKeyType
from static_frame.core.util import key_to_str

class HLocMeta(type):

    def __getitem__(cls, key: GetItemKeyType) -> 'HLoc':
        if not isinstance(key, tuple) or key is EMPTY_TUPLE:
            key = (key,)
        return cls(key) #type: ignore [no-any-return]

[docs]class HLoc(metaclass=HLocMeta): ''' A simple wrapper for embedding hierarchical specifications for :obj:`static_frame.IndexHierarchy` within a single axis argument of a ``loc`` selection. Implemented as a container of hierarchical keys that defines NULL slices for all lower dimensions that are not defined at construction. ''' STATIC = True __slots__ = ( 'key', )
[docs] def __init__(self, key: tp.Tuple[GetItemKeyType]) -> None: self.key = key
[docs] def __iter__(self) -> tp.Iterator[GetItemKeyType]: return self.key.__iter__()
[docs] def __len__(self) -> int: return self.key.__len__()
[docs] def __repr__(self) -> str: return f'<HLoc[{",".join(map(key_to_str, self.key))}]>'