debug

Define debugging functions.

Functions

get_key_path_availability_counts()	Get counts of dot access paths that did not resolve to None.
get_unaccessed_key_paths()	Get unaccessed dot access paths of JSON objects.
get_unexpected_resource_types()	Get unexpected resource types from the API.

xbrl_filings_api.debug.get_key_path_availability_counts()

Get counts of dot access paths that did not resolve to None.

Get the list of successful retrieval counts for dot access paths in JSON fragments of API responses.

Does not record the unaccessed paths if JSONTree of the APIObject has been initialized with do_not_track value True.

For debugging API changes.

Returns:

List of ordered retrieve counts for key paths of different API objects.

Return type:

list of KeyPathRetrieveCounts

xbrl_filings_api.debug.get_unaccessed_key_paths()

Get unaccessed dot access paths of JSON objects.

Get the list of unaccessed dot access paths in JSON fragments of API responses. List values (JSON arrays) are listed as a single path.

Does not record the unaccessed paths if JSONTree of the APIObject has been initialized with do_not_track value True.

For debugging API changes.

Returns:

List of ordered tuples in form (class_qualname, key_path).

Return type:

list of tuple (str, str)

xbrl_filings_api.debug.get_unexpected_resource_types()

Get unexpected resource types from the API.

JSONTree initialization parameter do_not_track has no effect.

Returns:

List of ordered tuples in form (type_str, origin).

Return type:

list of tuple (str, str)