Bus

Detail: Bus

Bus: Constructor

Detail: Bus: Constructor

Detail

Bus.__init__(series, *, store, config, max_persist)

Default Bus constructor. Args: store: A Store subclass. config: A StoreConfig, o…

Detail

Bus.from_concat(containers, *, index, name)

Concatenate multiple Bus into a new Bus. All Bus will load all Frame into memory…

Detail

Bus.from_dict(mapping, *, config, name, index_constructor)

Bus construction from a dictionary, where the first pair value is the index and…

Detail

Bus.from_frames(frames, *, config, name)

Return a Bus from an iterable of Frame; labels will be drawn from Frame.name.

Detail

Bus.from_hdf5(fp, *, config, max_persist)

Given a file path to a HDF5 Bus store, return a Bus instance. Args: fp: A string…

Detail

Bus.from_items(pairs, *, config, name, index_constructor)

Return a Bus from an iterable of pairs of label, Frame. Returns: Bus

Detail

Bus.from_sqlite(fp, *, config, max_persist)

Given a file path to an SQLite Bus store, return a Bus instance. Args: fp: A str…

Detail

Bus.from_xlsx(fp, *, config, max_persist)

Given a file path to an XLSX Bus store, return a Bus instance. Args: fp: A strin…

Detail

Bus.from_zip_csv(fp, *, config, max_persist)

Given a file path to zipped CSV Bus store, return a Bus instance. Args: fp: A st…

Detail

Bus.from_zip_parquet(fp, *, config, max_persist)

Given a file path to zipped parquet Bus store, return a Bus instance. Args: fp:…

Detail

Bus.from_zip_pickle(fp, *, config, max_persist)

Given a file path to zipped pickle Bus store, return a Bus instance. Args: fp: A…

Detail

Bus.from_zip_tsv(fp, *, config, max_persist)

Given a file path to zipped TSV Bus store, return a Bus instance. Args: fp: A st…

Bus: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary

Bus: Exporter

Detail: Bus: Exporter

Detail

Bus.to_hdf5(fp, *, config)

Write the complete Bus as an HDF5 table. Args: fp: A string file path or Path in…

Detail

Bus.to_series()

Return a Series with the Frame contained in this Bus. If the Bus is associated w…

Detail

Bus.to_sqlite(fp, *, config)

Write the complete Bus as an SQLite database file. Args: fp: A string file path…

Detail

Bus.to_visidata()

Open an interactive VisiData session.

Detail

Bus.to_xlsx(fp, *, config)

Write the complete Bus as a XLSX workbook. Args: fp: A string file path or Path…

Detail

Bus.to_zip_csv(fp, *, config)

Write the complete Bus as a zipped archive of CSV files. Args: fp: A string file…

Detail

Bus.to_zip_parquet(fp, *, config)

Write the complete Bus as a zipped archive of parquet files. Args: fp: A string…

Detail

Bus.to_zip_pickle(fp, *, config)

Write the complete Bus as a zipped archive of pickles. Args: fp: A string file p…

Detail

Bus.to_zip_tsv(fp, *, config)

Write the complete Bus as a zipped archive of TSV files. Args: fp: A string file…

Bus: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary

Bus: Attribute

Detail: Bus: Attribute

Detail

Bus.STATIC

bool(x) -> bool Returns True when the argument x is true, False otherwise. The b…

Detail

Bus.dtype

Return the dtype of the underlying NumPy array. Returns: numpy.dtype

Detail

Bus.dtypes

Returns a Frame of dtype per column for all loaded Frames.

Detail

Bus.index

The index instance assigned to this container. Returns: Index

Detail

Bus.mloc

Returns a Series showing a tuple of memory locations within each loaded Frame.

Detail

Bus.name

A hashable label attached to this container. Returns: Hashable

Detail

Bus.nbytes

Total bytes of data currently loaded in the Bus.

Detail

Bus.ndim

Return the number of dimensions, which for a Bus is always 1. Returns: int

Detail

Bus.shape

Return a tuple describing the shape of the underlying NumPy array. Returns: Tupl…

Detail

Bus.shapes

A Series describing the shape of each loaded Frame. Unloaded Frame will have a s…

Detail

Bus.size

Return the size of the underlying NumPy array. Returns: int

Detail

Bus.status

Return a Frame indicating loaded status, size, bytes, and shape of all loaded Fr…

Bus: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary

Bus: Method

Detail: Bus: Method

Detail

Bus.__bool__()

Raises ValueError to prohibit ambiguous use of truethy evaluation.

Detail

Bus.__len__()

Length of values.

Detail

Bus.equals(other, *, compare_name, compare_dtype, compare_class, skipna)

Return a bool from comparison to any other object. Note: this will attempt to lo…

Detail

Bus.head(count)

Return a Bus consisting only of the top elements as specified by count. Args: co…

Detail

Bus.rehierarch(depth_map)

Return a new Bus with new a hierarchy based on the supplied depth_map.

Detail

Bus.reindex(index, *, fill_value, own_index, check_equals)

Return a new Bus with labels defined by the provided index. The size and orderin…

Detail

Bus.relabel(index)

Return a new Bus with transformed labels on the index. The size and ordering of…

Detail

Bus.relabel_flat()

Return a new Bus, where an IndexHierarchy (if defined) is replaced with a flat,…

Detail

Bus.relabel_level_add(level)

Return a new Bus, adding a new root level to an existing IndexHierarchy, or crea…

Detail

Bus.relabel_level_drop(count)

Return a new Bus, dropping one or more levels from a either the root or the leav…

Detail

Bus.rename(name)

Return a new Series with an updated name attribute.

Detail

Bus.roll(shift, *, include_index)

Return a Bus with values rotated forward and wrapped around the index (with a po…

Detail

Bus.shift(shift, *, fill_value)

Return a Bus with values shifted forward on the index (with a positive shift) or…

Detail

Bus.sort_index(*, ascending, kind, key)

Return a new Bus ordered by the sorted Index. Args: * ascending: Boolean, or ite…

Detail

Bus.sort_values(*, ascending, kind, key)

Return a new Bus ordered by the sorted values. Note that as a Bus contains Frame…

Detail

Bus.tail(count)

Return a Bus consisting only of the bottom elements as specified by count. s Arg…

Bus: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary

Bus: Dictionary-Like

Detail: Bus: Dictionary-Like

Detail

Bus.__contains__(value)

Inclusion of value in index labels. Returns: bool

Detail

Bus.__iter__()

Iterator of index labels, same as Series.keys. Returns: Iterator[Hashasble]

Detail

Bus.__reversed__()

Returns a reverse iterator on the Bus index. Returns: Index

Detail

Bus.get(key, default)

Return the value found at the index key, else the default if the key is not foun…

Detail

Bus.items()

Iterator of pairs of Bus label and contained Frame.

Detail

Bus.keys()

Iterator of index labels. Returns: Iterator[Hashable]

Detail

Bus.values

A 1D object array of all Frame contained in the Bus.

Bus: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary

Bus: Display

Detail: Bus: Display

Detail

Bus.interface

A Frame documenting the interface of this class.

Detail

Bus.__repr__()

Detail

Bus.__str__()

Return str(self).

Detail

Bus.display(config, *, style_config)

Return a Display, capable of providing a string representation. Args: config: A…

Detail

Bus.display_tall(config)

Maximize vertical presentation. Return a Display, capable of providing a string…

Detail

Bus.display_wide(config)

Maximize horizontal presentation. Return a Display, capable of providing a strin…

Bus: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary

Bus: Selector

Detail: Bus: Selector

Detail

Bus.drop[key]

Label-based selection.

Detail

Bus.drop.iloc[key]

Detail

Bus.drop.loc[key]

Detail

Bus[key]

Selector of values by label. Args: key: A loc selector, either a label, a list o…

Detail

Bus.iloc[key]

Detail

Bus.loc[key]

Bus: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary

Bus: Iterator

Detail: Bus: Iterator

Detail

Bus.iter_element()

Iterator of elements.

Detail

Bus.iter_element().apply(func, *, dtype, name)

Apply a function to each value. Returns a new container. Args: func: A function…

Detail

Bus.iter_element().apply_iter(func)

Apply a function to each value. A generator of resulting values. Args: func: A f…

Detail

Bus.iter_element().apply_iter_items(func)

Apply a function to each value. A generator of resulting key, value pairs. Args:…

Detail

Bus.iter_element().apply_pool(func, *, dtype, name, max_workers, chunksize, use_threads)

Apply a function to each value. Employ parallel processing with either the Proce…

Detail

Bus.iter_element().map_all(mapping, *, dtype, name)

Apply a mapping; for values not in the mapping, an Exception is raised. Returns…

Detail

Bus.iter_element().map_all_iter(mapping)

Apply a mapping; for values not in the mapping, an Exception is raised. A genera…

Detail

Bus.iter_element().map_all_iter_items(mapping)

Apply a mapping; for values not in the mapping, an Exception is raised. A genera…

Detail

Bus.iter_element().map_any(mapping, *, dtype, name)

Apply a mapping; for values not in the mapping, the value is returned. Returns a…

Detail

Bus.iter_element().map_any_iter(mapping)

Apply a mapping; for values not in the mapping, the value is returned. A generat…

Detail

Bus.iter_element().map_any_iter_items(mapping)

Apply a mapping; for values not in the mapping, the value is returned. A generat…

Detail

Bus.iter_element().map_fill(mapping, *, fill_value, dtype, name)

Apply a mapping; for values not in the mapping, the fill_value is returned. Retu…

Detail

Bus.iter_element().map_fill_iter(mapping, *, fill_value)

Apply a mapping; for values not in the mapping, the fill_value is returned. A ge…

Detail

Bus.iter_element().map_fill_iter_items(mapping, *, fill_value)

Apply a mapping; for values not in the mapping, the fill_value is returned. A ge…

Detail

Bus.iter_element_items()

Iterator of label, element pairs.

Detail

Bus.iter_element_items().apply(func, *, dtype, name)

Apply a function to each value. Returns a new container. Args: func: A function…

Detail

Bus.iter_element_items().apply_iter(func)

Apply a function to each value. A generator of resulting values. Args: func: A f…

Detail

Bus.iter_element_items().apply_iter_items(func)

Apply a function to each value. A generator of resulting key, value pairs. Args:…

Detail

Bus.iter_element_items().apply_pool(func, *, dtype, name, max_workers, chunksize, use_threads)

Apply a function to each value. Employ parallel processing with either the Proce…

Detail

Bus.iter_element_items().map_all(mapping, *, dtype, name)

Apply a mapping; for values not in the mapping, an Exception is raised. Returns…

Detail

Bus.iter_element_items().map_all_iter(mapping)

Apply a mapping; for values not in the mapping, an Exception is raised. A genera…

Detail

Bus.iter_element_items().map_all_iter_items(mapping)

Apply a mapping; for values not in the mapping, an Exception is raised. A genera…

Detail

Bus.iter_element_items().map_any(mapping, *, dtype, name)

Apply a mapping; for values not in the mapping, the value is returned. Returns a…

Detail

Bus.iter_element_items().map_any_iter(mapping)

Apply a mapping; for values not in the mapping, the value is returned. A generat…

Detail

Bus.iter_element_items().map_any_iter_items(mapping)

Apply a mapping; for values not in the mapping, the value is returned. A generat…

Detail

Bus.iter_element_items().map_fill(mapping, *, fill_value, dtype, name)

Apply a mapping; for values not in the mapping, the fill_value is returned. Retu…

Detail

Bus.iter_element_items().map_fill_iter(mapping, *, fill_value)

Apply a mapping; for values not in the mapping, the fill_value is returned. A ge…

Detail

Bus.iter_element_items().map_fill_iter_items(mapping, *, fill_value)

Apply a mapping; for values not in the mapping, the fill_value is returned. A ge…

Bus: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary

Bus: Operator Binary

Detail: Bus: Operator Binary

Detail

Bus.__eq__(value)

Return self==value.

Detail

Bus.__ge__(value)

Return self>=value.

Detail

Bus.__gt__(value)

Return self>value.

Detail

Bus.__le__(value)

Return self<=value.

Detail

Bus.__lt__(value)

Return self<value.

Detail

Bus.__ne__(value)

Return self!=value.

Bus: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary