dataframely.config module

class dataframely.config.Config(**options: Unpack[Options])

Bases: ContextDecorator

An object to track global configuration for operations in dataframely.

Methods

__call__(func)	Call self as a function.
restore_defaults()	Restore the defaults of the configuration.
set_max_sampling_iterations(iterations)	Set the maximum number of sampling iterations to use on Schema.sample().

options: Options = {'max_sampling_iterations': 10000}

The currently valid config options.

static restore_defaults() → None

Restore the defaults of the configuration.

static set_max_sampling_iterations(iterations: int) → None

Set the maximum number of sampling iterations to use on Schema.sample().

class dataframely.config.Options

Bases: TypedDict

Methods

clear(/)	Remove all items from the dict.
copy(/)	Return a shallow copy of the dict.
fromkeys(iterable[, value])	Create a new dictionary with keys from iterable and values set to value.
get(key[, default])	Return the value for key if key is in the dictionary, else default.
items(/)	Return a set-like object providing a view on the dict's items.
keys(/)	Return a set-like object providing a view on the dict's keys.
pop(key[, default])	If the key is not found, return the default if given; otherwise, raise a KeyError.
popitem(/)	Remove and return a (key, value) pair as a 2-tuple.
setdefault(key[, default])	Insert key with a value of default if key is not in the dictionary.
update([E, ]**F)	If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
values(/)	Return an object providing a view on the dict's values.

clear(/)

Remove all items from the dict.

copy(/)

Return a shallow copy of the dict.

classmethod fromkeys(iterable, value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items(/)

Return a set-like object providing a view on the dict’s items.

keys(/)

Return a set-like object providing a view on the dict’s keys.

max_sampling_iterations: int

The maximum number of iterations to use for “fuzzy” sampling.

pop(key, default=<unrepresentable>, /)

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem(/)

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None.  Update D from mapping/iterable E and F.

If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values(/)

Return an object providing a view on the dict’s values.

dataframely.config.default_options() → Options