report package

report module

class pdbstore.report.BaseEntryStatistics

Bases: ABC

Handle statistic for one specific entry.

get_transactions_count() → int

Retrieve the total number of associated transactions.

abstract property resources: List[str]

List of data member containing statistics information from derived class.

class pdbstore.report.BaseStatistics

Bases: ABC

Base class form managing statistics.

abstract build(store: Store) → bool

Build required statistics dictonary

Parameters:

store – The symbol store to analyze

Returns:

True if successful, else False

abstract property key1: str

The first collecting criteria

abstract property key2: str

The second collecting criteria

abstract property statistics: Mapping[Tuple[str, str], BaseEntryStatistics]

The data member containing all generated statistics.

abstract property value1: str

The first collected data

abstract property value2: str

The second collected data

class pdbstore.report.ReportGenerator(store: Store)

Bases: object

Manage symbol store usage analysis data.

FILES = 'files'

PRODUCTS = 'products'

TRANSACTIONS = 'transactions'

generate(report_type: str = 'products') → BaseStatistics | None

generate symbol store statistics given a report type

Parameters:

report_type – Specify which kind of report must be generated. It can be products or files

Returns:

The generated statistics if successsful, else None

supported_list() → List[str]

Retrieve the list of supported report types