StoreConfig¶
Overview: StoreConfig
- class StoreConfig(*, index_depth: int = 0, index_name_depth_level: Optional[Union[int, Iterable[int]]] = None, index_constructors: Union[Callable[[...], IndexBase], None, Sequence[Optional[Callable[[...], IndexBase]]]] = None, columns_depth: int = 1, columns_name_depth_level: Optional[Union[int, Iterable[int]]] = None, columns_constructors: Union[Callable[[...], IndexBase], None, Sequence[Optional[Callable[[...], IndexBase]]]] = None, columns_select: Optional[Iterable[str]] = None, dtypes: Union[str, numpy.dtype, type, None, Iterable[Optional[Union[str, numpy.dtype, type]]], Dict[Hashable, Optional[Union[str, numpy.dtype, type]]]] = None, consolidate_blocks: bool = False, skip_header: int = 0, skip_footer: int = 0, trim_nadir: bool = False, include_index: bool = True, include_index_name: bool = True, include_columns: bool = True, include_columns_name: bool = False, merge_hierarchical_labels: bool = True, label_encoder: Optional[Callable[[Hashable], str]] = None, label_decoder: Optional[Callable[[str], Hashable]] = None, read_max_workers: Optional[int] = None, read_chunksize: int = 1, write_max_workers: Optional[int] = None, write_chunksize: int = 1)[source]¶
A read-only container of parameters used by
Store
subclasses for reading from and writing to multi-table storage formats.
StoreConfig: Constructor¶
Overview: StoreConfig: Constructor
- StoreConfig.__init__(*, index_depth: int = 0, index_name_depth_level: Optional[Union[int, Iterable[int]]] = None, index_constructors: Union[Callable[[...], IndexBase], None, Sequence[Optional[Callable[[...], IndexBase]]]] = None, columns_depth: int = 1, columns_name_depth_level: Optional[Union[int, Iterable[int]]] = None, columns_constructors: Union[Callable[[...], IndexBase], None, Sequence[Optional[Callable[[...], IndexBase]]]] = None, columns_select: Optional[Iterable[str]] = None, dtypes: Union[str, numpy.dtype, type, None, Iterable[Optional[Union[str, numpy.dtype, type]]], Dict[Hashable, Optional[Union[str, numpy.dtype, type]]]] = None, consolidate_blocks: bool = False, skip_header: int = 0, skip_footer: int = 0, trim_nadir: bool = False, include_index: bool = True, include_index_name: bool = True, include_columns: bool = True, include_columns_name: bool = False, merge_hierarchical_labels: bool = True, label_encoder: Optional[Callable[[Hashable], str]] = None, label_decoder: Optional[Callable[[str], Hashable]] = None, read_max_workers: Optional[int] = None, read_chunksize: int = 1, write_max_workers: Optional[int] = None, write_chunksize: int = 1)[source]
- Parameters
include_index – Boolean to determine if the
index
is included in output.include_columns – Boolean to determine if the
columns
is included in output.
- classmethod StoreConfig.from_frame(frame: static_frame.core.frame.Frame) static_frame.core.store.StoreConfig [source]
Derive a config from a Frame.
StoreConfig: Constructor | Exporter | Attribute | Method | Display | Operator Binary
StoreConfig: Exporter¶
Overview: StoreConfig: Exporter
- StoreConfig.to_store_config_he() static_frame.core.store.StoreConfigHE [source]
Return a
StoreConfigHE
version of this StoreConfig.
StoreConfig: Constructor | Exporter | Attribute | Method | Display | Operator Binary
StoreConfig: Attribute¶
Overview: StoreConfig: Attribute
- StoreConfig.columns_constructors: IndexConstructors
- StoreConfig.columns_depth: int
- StoreConfig.columns_name_depth_level: tp.Optional[DepthLevelSpecifier]
- StoreConfig.columns_select: tp.Optional[tp.Iterable[str]]
- StoreConfig.consolidate_blocks: bool
- StoreConfig.dtypes: DtypesSpecifier
- StoreConfig.include_columns: bool
- StoreConfig.include_columns_name: bool
- StoreConfig.include_index: bool
- StoreConfig.include_index_name: bool
- StoreConfig.index_constructors: IndexConstructors
- StoreConfig.index_depth: int
- StoreConfig.index_name_depth_level: tp.Optional[DepthLevelSpecifier]
- StoreConfig.label_decoder: Optional[Callable[[str], Hashable]]
- StoreConfig.label_encoder: Optional[Callable[[Hashable], str]]
- StoreConfig.merge_hierarchical_labels: bool
- StoreConfig.read_chunksize: int
- StoreConfig.read_max_workers: tp.Optional[int]
- StoreConfig.skip_footer: int
- StoreConfig.skip_header: int
- StoreConfig.trim_nadir: bool
- StoreConfig.write_chunksize: int
- StoreConfig.write_max_workers: tp.Optional[int]
StoreConfig: Constructor | Exporter | Attribute | Method | Display | Operator Binary
StoreConfig: Method¶
Overview: StoreConfig: Method
- StoreConfig.label_decode(label: str) Hashable [source]
- StoreConfig.label_encode(label: Hashable) str [source]
StoreConfig: Constructor | Exporter | Attribute | Method | Display | Operator Binary
StoreConfig: Display¶
Overview: StoreConfig: Display
- StoreConfig.interface¶
A Frame documenting the interface of this class.
- StoreConfig.__repr__()
Return repr(self).
- StoreConfig.__str__()
Return str(self).
StoreConfig: Constructor | Exporter | Attribute | Method | Display | Operator Binary
StoreConfig: Operator Binary¶
Overview: StoreConfig: Operator Binary
- StoreConfig.__eq__(other: Any) bool [source]
Return self==value.
- StoreConfig.__ge__(value, /)
Return self>=value.
- StoreConfig.__gt__(value, /)
Return self>value.
- StoreConfig.__le__(value, /)
Return self<=value.
- StoreConfig.__lt__(value, /)
Return self<value.
- StoreConfig.__ne__(other: Any) bool
Return self!=value.
StoreConfig: Constructor | Exporter | Attribute | Method | Display | Operator Binary