arelle.oim.tc.report.keys

See COPYRIGHT.md for copyright information.

Module Contents

Classes

KeyStore

The distinct key values of one unique key.

MemoryKeyStore

Keeps every distinct key value in memory.

Functions

encode_key_values

Encodes key values as bytes that are equal exactly when the key values are.

API

class arelle.oim.tc.report.keys.KeyStore

Bases: abc.ABC

The distinct key values of one unique key.

Validation only uses this interface, so a store that manages keys on disk or in a database could be added if very large reports need one.

abstractmethod add(key_values: arelle.oim.tc.report.key_values.KeyValues) → bool

Adds key values and returns False if they were already present.

abstractmethod clear() → None

Forgets every key value, once no check needs them.

class arelle.oim.tc.report.keys.MemoryKeyStore

Bases: arelle.oim.tc.report.keys.KeyStore

Keeps every distinct key value in memory.

Initialization

add(key_values: arelle.oim.tc.report.key_values.KeyValues) → bool
clear() → None
arelle.oim.tc.report.keys.encode_key_values(key_values: arelle.oim.tc.report.key_values.KeyValues) → bytes

Encodes key values as bytes that are equal exactly when the key values are.