beamds.beam.type package

Submodules

beamds.beam.type.core module

class beamds.beam.type.core.BeamType(_ref: Any, _major: str | None = None, _minor: str | None = None, _element: str | None = None)

Bases: object

classmethod check(x, major=True, minor=True, element=True)

classmethod check_element(x)

static check_if_array(x)

static check_if_data_array(x)

static check_if_dataframe(x)

static check_if_scalar(x)

classmethod check_major(x)

classmethod check_minor(x)

property element

property is_array

property is_data_array

property is_dataframe

property is_path

property is_scalar

property is_str

property is_torch

property major

property minor

static repr_subtype(x)

beamds.beam.type.utils module

class beamds.beam.type.utils.TypeTuple(major, minor, element)

Bases: tuple

element

Alias for field number 2

major

Alias for field number 0

minor

Alias for field number 1

class beamds.beam.type.utils.Types

Bases: object

array = 'array'

beam_data = 'beam_data'

beam_processor = 'beam_processor'

bool = 'bool'

bytes = 'bytes'

cls = 'class'

complex = 'complex'

container = 'container'

counter = 'counter'

cudf = 'cudf'

dict = 'dict'

empty = 'empty'

float = 'float'

function = 'function'

int = 'int'

list = 'list'

method = 'method'

na = 'na'

native = 'native'

none = 'none'

numpy = 'numpy'

object = 'object'

other = 'other'

pandas = 'pandas'

path = 'path'

pil = 'pil'

polars = 'polars'

scalar = 'scalar'

scipy_sparse = 'scipy_sparse'

set = 'set'

slice = 'slice'

str = 'str'

tensor = 'tensor'

tuple = 'tuple'

unknown = 'unknown'

beamds.beam.type.utils.check_element_type(x, minor=None)

beamds.beam.type.utils.check_minor_type(x)

beamds.beam.type.utils.elt_of_list(x, sample_size=20)

beamds.beam.type.utils.is_beam_config(x)

beamds.beam.type.utils.is_beam_data(x)

beamds.beam.type.utils.is_beam_path(x)

beamds.beam.type.utils.is_beam_processor(x)

beamds.beam.type.utils.is_beam_resource(x)

beamds.beam.type.utils.is_cached_property(obj, attribute_name)

beamds.beam.type.utils.is_class_instance(obj)

Returns True if obj is an instance of a user-defined class.

beamds.beam.type.utils.is_class_method(obj)

Returns True if obj is a method bound to an instance of a class.

beamds.beam.type.utils.is_class_type(obj)

Returns True if obj is a class type, excluding function types.

beamds.beam.type.utils.is_container(x)

beamds.beam.type.utils.is_cudf(x)

beamds.beam.type.utils.is_dataframe(x)

beamds.beam.type.utils.is_function(obj, include_class=False)

Returns True if obj is a function, method, or callable. If include_class is True, callable class instances are included.

beamds.beam.type.utils.is_nan(x)

beamds.beam.type.utils.is_pandas(x)

beamds.beam.type.utils.is_pandas_dataframe(x)

beamds.beam.type.utils.is_pandas_series(x)

beamds.beam.type.utils.is_pil(x)

beamds.beam.type.utils.is_polars(x)

beamds.beam.type.utils.is_scalar(x)

beamds.beam.type.utils.is_scipy_sparse(x)

beamds.beam.type.utils.is_tensor(x)

beamds.beam.type.utils.is_torch_scalar(x)

Module contents

class beamds.beam.type.BeamType(_ref: Any, _major: str | None = None, _minor: str | None = None, _element: str | None = None)

Bases: object

classmethod check(x, major=True, minor=True, element=True)

classmethod check_element(x)

static check_if_array(x)

static check_if_data_array(x)

static check_if_dataframe(x)

static check_if_scalar(x)

classmethod check_major(x)

classmethod check_minor(x)

property element

property is_array

property is_data_array

property is_dataframe

property is_path

property is_scalar

property is_str

property is_torch

property major

property minor

static repr_subtype(x)

beamds.beam.type.check_type(x, major=True, minor=True, element=True) → BeamType