datools package

Submodules

datools.cli module

Console script for datools.

datools.datools module

Main module.

datools.errors module

exception datools.errors.DatoolsError[source]

Bases: Exception

datools.explanations module

datools.models module

class datools.models.Aggregate(function: datools.models.AggregateFunction, column: datools.models.Column, as_name: datools.models.Column)[source]

Bases: object

as_name: Column
column: Column
function: AggregateFunction
to_sql()[source]
class datools.models.AggregateFunction(value)

Bases: Enum

An enumeration.

AVERAGE = 3
COUNT = 2
SUM = 1
class datools.models.Column(name: str)[source]

Bases: object

name: str
class datools.models.Constant(value: Any)[source]

Bases: object

value: Any
class datools.models.Explanation(predicates: Tuple[datools.models.Predicate, ...], risk_ratio: float)[source]

Bases: object

predicates: Tuple[Predicate, ...]
risk_ratio: float
class datools.models.Operator(value)

Bases: Enum

An enumeration.

EQUALS = 1
GT = 3
GTEQ = 5
LT = 4
LTEQ = 6
NOT_EQUALS = 2
class datools.models.Predicate(left: datools.models.Column, operator: datools.models.Operator, right: datools.models.Constant)[source]

Bases: object

left: Column
operator: Operator
right: Constant
to_sql()[source]
class datools.models.Table(name: str)[source]

Bases: object

name: str

datools.sqlalchemy_utils module

datools.table_statistics module

class datools.table_statistics.ColumnStatistics[source]

Bases: object

class datools.table_statistics.RangeValuedStatistics(bucket_minimums: List[Any])[source]

Bases: ColumnStatistics

bucket_minimums: List[Any]
class datools.table_statistics.SetValuedStatistics(distinct_values: int, most_common_values: list)[source]

Bases: ColumnStatistics

distinct_values: int
most_common_values: list
datools.table_statistics.column_statistics(engine: Engine, table: Table, columns_to_ignore: Set[Column]) Dict[Column, List[ColumnStatistics]][source]
datools.table_statistics.range_valued_statistics(engine: Engine, query: str, columns: Set[Column], num_buckets: int = 3) List[Tuple[Column, RangeValuedStatistics]][source]
datools.table_statistics.set_valued_statistics(engine: Engine, query: str, columns: Set[Column], num_most_common_values: int = 100) List[Tuple[Column, SetValuedStatistics]][source]

Module contents

Top-level package for datools.