Modules

Module class

class xbridge.modules.Module(code: str | None = None, url: str | None = None, tables: List[Table] | None = None)

Bases: object

Class representing an XBRL Module.

It has attributes like code, url, and tables whose main function is to operate with the module and return properties like a specific table from the JSON file used as input, an object, a dictionary using the attributes as keys, a module object from a part of preprocessed JSON file and the variables that are present in it.

It is used when taxonomies are loaded to collect the information associated to the tables belonging to the module.

Parameters:

code – The code of the XBRL module.
url – The module reference within the taxonomy.
tables – The tables that form the module.

property architecture: str

extract_tables(zip_file: ZipFile) → None: Extracts the tables in the JSON files for the modules in the taxonomy

classmethod from_serialized(input_path: str | Path) → Module: Returns a module object from a JSON file

classmethod from_taxonomy(zip_file: ZipFile, json_file_path: str) → Module: Returns a module object from a part of the JSON file

get_module_setup(zip_file: ZipFile) → None: Reads the json entry point for the module and extracts the setup

get_table(table_code: str) → Table: Returns a table object with the given code

static is_relative_url(url: str) → bool

property repeated_variables: Dict[str, List[str]]: Returns a dictionary with the variables and the tables where they are present, if they are repeated

property tables: List[Table]: Returns the tables defined in the JSON file for the module

to_dict() → Dict[str, Any]: Returns a dictionary

property variables_location: Dict[str, List[str]]: Returns a dictionary with the variables and the tables where they are present

Table class

Bases: object

Class representing an XBRL table as defined in the JSON file.

Its properties allow to return open keys, variables and attributes from the table. It can also generate a variable dataframe or work with one already created. Finally, it can return a dictionary using its attributes or a Table object from the preprocessed JSON file.

It is used when module is loaded to collect the information associated to the variables and open keys belonging to the table.

Parameters:

code – The code of the table.
url – The table reference within the module.
open_keys – Open key contained in the table.
variables – the variables that belongs to the table.
attributes – attributes related to the variables that can be extracted from the table.
input_zip_path – Path to the file used as table.

property attributes: List[str]: Returns the attributes for the table

static check_taxonomy_architecture(table_dict: dict[str, Any]) → str

Checks the taxonomy architecture

Returns datapoints if the architecture of the CSV follows the pattern: datapont,factValue

Returns headers if the architecture of the CSV follows the new DORA pattern: 0010,0020,…

extract_columns() → List[dict[str, Any]]: Extract the columns for the table

extract_open_keys() → None: Extracts the open keys for the table

extract_variables() → None: Extract the variable for the table

classmethod from_dict(table_dict: dict[str, Any]) → Table: Returns a table object from a dictionary

classmethod from_taxonomy(zip_file: ZipFile, table_path: str, module_setup_json: dict[str, Any]) → Table: Returns a table object from a part of the preprocessed JSON file

generate_variable_df() → None: Returns a dataframe with the variable and extensional context

get_table_code() → str | None: Returns the code of the table

property open_keys: List[str]: Returns the open keys for the table

to_dict() → dict[str, Any]: Returns a dictionary for the table

property variable_columns: Set[str]: Returns the columns for the variable dataframe

property variable_df: DataFrame | None: Returns a dataframe with the variable and extensional context

property variables: List[Variable]: Returns the variable for the table

Variable class

class xbridge.modules.Variable(code: str | None = None, dimensions: dict[str, str] | None = None, attributes: Any = None)

Bases: object

Class representing a variable as represented in the JSON files.

Can return or extract the dimension of the variable, create a dictionary using its attributes as keys or return a variable object from the preprocessed JSON file.

Parameters:

code – The code of the variable.
dimensions – the dimensions of the variable.
attributes – The attributes related to the variable.

property dimensions: dict[str, str]: Returns the dimensions of a variable

extract_dimensions(datapoint_dict: dict[str, Any]) → None: Extracts the dimensions for the variable

classmethod from_dict(variable_dict: dict[str, Any]) → Variable: Returns a variable object from a dictionary

classmethod from_taxonomy(variable_id: str, variable_dict: dict[str, Any]) → Variable: Returns a variable object from a part of the preprocessed JSON file

to_dict() → dict[str, Any]: Returns a dictionary with the attributes