Detail: Bus: Display#

Overview: Bus: Display

Bus.interface#

A Frame documenting the interface of this class.

>>> b = sf.Bus.from_frames((sf.Frame(np.arange(6).reshape(3,2), index=('p', 'q', 'r'), columns=('a', 'b'), name='x'), sf.Frame((np.arange(6).reshape(3,2) % 2).astype(bool), index=('p', 'q', 'r'), columns=('c', 'd'), name='y')), name='i')
>>> b
<Bus: i>
<Index>
x        Frame
y        Frame
<<U1>    <object>
>>> b.interface
<Frame>
<Index>                              cls_name group                doc                  <<U18>
<Index: signature>
__init__(frames, /, *, index, index… Bus      Constructor          Default Bus constru…
from_concat(containers, /, *, index… Bus      Constructor          Concatenate multipl…
from_dict(mapping, /, *, name, inde… Bus      Constructor          Bus construction fr…
from_frames(frames, /, *, index_con… Bus      Constructor          Return a Bus from a…
from_items(pairs, /, *, name, index… Bus      Constructor          Return a Bus from a…
from_manifest(label_to_fp_or_fps, /… Bus      Constructor          Load a Bus from arb…
from_series(series, /, *, store, ma… Bus      Constructor          Create a Bus from a…
from_sqlite(fp, /, *, config, max_p… Bus      Constructor          Given a file path t…
from_xlsx(fp, /, *, config, max_per… Bus      Constructor          Given a file path t…
from_zip_csv(fp, /, *, config, max_… Bus      Constructor          Given a file path t…
from_zip_npy(fp, /, *, config, max_… Bus      Constructor          Given a file path t…
from_zip_npz(fp, /, *, config, max_… Bus      Constructor          Given a file path t…
from_zip_parquet(fp, /, *, config, … Bus      Constructor          Given a file path t…
from_zip_pickle(fp, /, *, config, m… Bus      Constructor          Given a file path t…
from_zip_tsv(fp, /, *, config, max_… Bus      Constructor          Given a file path t…
to_manifest(fp, /, *, label_encoder) Bus      Exporter             Write each containe…
to_series()                          Bus      Exporter             Return a Series wit…
…                                    …        …                    …
via_hashlib(*, include_name, includ… Bus      Accessor Hashlib
via_hashlib(*, include_name, includ… Bus      Accessor Hashlib
via_hashlib(*, include_name, includ… Bus      Accessor Hashlib
via_hashlib(*, include_name, includ… Bus      Accessor Hashlib
via_type_clinic.to_hint()            Bus      Accessor Type Clinic Return the type hin…
via_type_clinic.check(hint, /, *, f… Bus      Accessor Type Clinic Given a hint (a typ…
via_type_clinic.warn(hint, /, *, fa… Bus      Accessor Type Clinic Given a hint (a typ…
via_type_clinic.__call__(hint, /, *… Bus      Accessor Type Clinic Given a hint (a typ…
via_type_clinic.__repr__()           Bus      Accessor Type Clinic Return a compact st…
via_mapping.__getitem__(key)         Bus      Accessor Mapping
via_mapping.__iter__()               Bus      Accessor Mapping
via_mapping.__len__()                Bus      Accessor Mapping
via_mapping.__contains__(key, /)     Bus      Accessor Mapping
via_mapping.__repr__()               Bus      Accessor Mapping
via_mapping.keys()                   Bus      Accessor Mapping
via_mapping.values()                 Bus      Accessor Mapping
via_mapping.items()                  Bus      Accessor Mapping
<<U122>                              <<U3>    <<U20>               <<U81>
Bus.__repr__()#

Return repr(self).

>>> b = sf.Bus.from_frames((sf.Frame(np.arange(6).reshape(3,2), index=('p', 'q', 'r'), columns=('a', 'b'), name='x'), sf.Frame((np.arange(6).reshape(3,2) % 2).astype(bool), index=('p', 'q', 'r'), columns=('c', 'd'), name='y')), name='i')
>>> repr(b)
<Bus: i>
<Index>
x        Frame
y        Frame
<<U1>    <object>
Bus.__str__()#

Return str(self).

>>> b = sf.Bus.from_frames((sf.Frame(np.arange(6).reshape(3,2), index=('p', 'q', 'r'), columns=('a', 'b'), name='x'), sf.Frame((np.arange(6).reshape(3,2) % 2).astype(bool), index=('p', 'q', 'r'), columns=('c', 'd'), name='y')), name='i')
>>> str(b)
<Bus: i>
<Index>
x        Frame
y        Frame
<<U1>    <object>
Bus.display(config=None, /, *, style_config=None)[source]#

Return a static_frame.Display, capable of providing a string representation.

Parameters:

config – A static_frame.DisplayConfig instance. If not provided, the static_frame.DisplayActive will be used.

>>> b = sf.Bus.from_frames((sf.Frame(np.arange(6).reshape(3,2), index=('p', 'q', 'r'), columns=('a', 'b'), name='x'), sf.Frame((np.arange(6).reshape(3,2) % 2).astype(bool), index=('p', 'q', 'r'), columns=('c', 'd'), name='y')), name='i')
>>> b.display()
<Bus: i>
<Index>
x        Frame
y        Frame
<<U1>    <object>
>>> b.display(sf.DisplayConfig(type_show=False))
x Frame
y Frame
Bus.display_tall(config=None, /)#

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

Parameters:

config – A static_frame.DisplayConfig instance. If not provided, the static_frame.DisplayActive will be used.

>>> b = sf.Bus.from_frames((sf.Frame(np.arange(6).reshape(3,2), index=('p', 'q', 'r'), columns=('a', 'b'), name='x'), sf.Frame((np.arange(6).reshape(3,2) % 2).astype(bool), index=('p', 'q', 'r'), columns=('c', 'd'), name='y')), name='i')
>>> b.display_tall()
<Bus: i>
<Index>
x        Frame
y        Frame
<<U1>    <object>
Bus.display_wide(config=None, /)#

Maximize horizontal presentation. Return a static_frame.Display, capable of providing a string representation.

Parameters:

config – A static_frame.DisplayConfig instance. If not provided, the static_frame.DisplayActive will be used.

>>> b = sf.Bus.from_frames((sf.Frame(np.arange(6).reshape(3,2), index=('p', 'q', 'r'), columns=('a', 'b'), name='x'), sf.Frame((np.arange(6).reshape(3,2) % 2).astype(bool), index=('p', 'q', 'r'), columns=('c', 'd'), name='y')), name='i')
>>> b.display_wide()
<Bus: i>
<Index>
x        Frame
y        Frame
<<U1>    <object>

Bus: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Accessor Hashlib | Accessor Type Clinic | Accessor Mapping