Skip to content

feather module

Module with FeatherData.

FeatherData class

FeatherData(
    wrapper,
    data,
    single_key=True,
    classes=None,
    level_name=None,
    fetch_kwargs=None,
    returned_kwargs=None,
    last_index=None,
    delisted=None,
    tz_localize=None,
    tz_convert=None,
    missing_index=None,
    missing_columns=None,
    **kwargs
)

Data class for fetching Feather data using PyArrow.

Superclasses

Inherited members

fetch_feature class method

FeatherData.fetch_feature(
    feature,
    **kwargs
)

Fetch the Feather file of a feature.

Uses FeatherData.fetch_key().

fetch_key class method

FeatherData.fetch_key(
    key,
    path=None,
    tz=None,
    index_col=None,
    squeeze=None,
    **read_kwargs
)

Fetch the Feather file of a feature or symbol.

Args

key : hashable
Feature or symbol.
path : str

Path.

If path is None, uses key as the path to the Feather file.

tz : any

Target timezone.

See to_timezone().

index_col : int, str, or sequence

Position(s) or name(s) of column(s) that should become the index.

Will only apply if the fetched object has a default index.

squeeze : int
Whether to squeeze a DataFrame with one column into a Series.
**read_kwargs
Other keyword arguments passed to pd.read_feather.

See https://pandas.pydata.org/docs/reference/api/pandas.read_feather.html for other arguments.

For defaults, see custom.feather in data.

fetch_symbol class method

FeatherData.fetch_symbol(
    symbol,
    **kwargs
)

Fetch the Feather file of a symbol.

Uses FeatherData.fetch_key().

update_feature method

FeatherData.update_feature(
    feature,
    **kwargs
)

Update data of a feature.

Uses FeatherData.update_key() with key_is_feature=True.

update_key method

FeatherData.update_key(
    key,
    key_is_feature=False,
    **kwargs
)

Update data of a feature or symbol.

update_symbol method

FeatherData.update_symbol(
    symbol,
    **kwargs
)

Update data for a symbol.

Uses FeatherData.update_key() with key_is_feature=False.