tlc.core.objects.tables.system_tables.indexing_tables.config_indexing_table#

A specialized indexing table for Config files objects fetched from URLs.

Module Contents#

Classes#

Class

Description

ConfigIndexingTable

A specialized indexing table for Config files fetched from URLs.

API#

class tlc.core.objects.tables.system_tables.indexing_tables.config_indexing_table.ConfigIndexingTable(url: tlc.core.url.Url | None = None, scan_urls: list[tlc.core.objects.tables.system_tables.indexing._ScanUrl] | None = None, init_parameters: Any = None)#

Bases: tlc.core.objects.tables.system_tables.indexing_table.IndexingTable

A specialized indexing table for Config files fetched from URLs.

This table is designed to manage Config file objects. Each row in this table corresponds to a config file object that is fetched from a URL. It extends from the generic IndexingTable to provide functionalities specifically optimized for handling external config files embedded with data.

Example:

table = ConfigIndexingTable.instance()
table.wait_for_next_index()
for row in table.table_rows:
    print(row)
Closing Comments:

  • Singleton Pattern: This class implements the Singleton pattern. Always use ConfigIndexingTable.instance() to get the singleton instance.

Initialize a ConfigIndexingTable object.

Parameters:

  • url – The URL from which this table can be read.

  • scan_urls – A list of URLs to scan for config files.

  • init_parameters – Any initialization parameters.

Raises:

ValueError – If some conditions, such as invalid URLs, are not met.

config_indexing_table_instance: tlc.core.objects.tables.system_tables.indexing_tables.config_indexing_table.ConfigIndexingTable | None = None#
update_config() → None#

Update the configuration of the ConfigIndexingTable.

ensure_dependent_properties() → None#

Ensure that the dependent properties are updated.

static instance() → tlc.core.objects.tables.system_tables.indexing_tables.config_indexing_table.ConfigIndexingTable#

Returns the singleton ConfigIndexingTable object

should_consider_object(obj: tlc.core.object.Object) → bool#

Only consider Config objects

start() → None#

Start the ConfigIndexingTable and dispatch a config updater thread

stop() → None#

Stop the ConfigIndexingTable and the config updater thread

wait_for_complete_index(timeout: float | None = None) → bool#