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

A specialized indexing table for Run objects fetched from URLs.

Module Contents#

Classes#

Class

Description

RunIndexingTable

A specialized indexing table for Run objects fetched from URLs.

API#

class tlc.core.objects.tables.system_tables.indexing_tables.run_indexing_table.RunIndexingTable(url: tlc.core.url.Url | None = None, project_scan_urls: list[str | tlc.core.url.Url] | None = None, extra_scan_urls: list[str | tlc.core.url.Url] | None = None, scan_wait: float | None = None, create_default_dirs: bool | None = None, init_parameters: Any = None)#

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

A specialized indexing table for Run objects fetched from URLs.

This table is designed to manage Run objects. Each row in this table corresponds to a Run object that is fetched from a URL. It extends from the generic IndexingTable to provide functionalities specifically optimized for handling Run objects.

Example:

table = RunIndexingTable.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 RunIndexingTable.instance() to get the singleton instance.

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

  • scan_urls – A list of URLs to scan for runs.

  • scan_wait – Time to wait before requeuing a new scan, in seconds.

  • init_parameters – Any initialization parameters.

Raises:

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

run_indexing_table_instance: tlc.core.objects.tables.system_tables.indexing_tables.run_indexing_table.RunIndexingTable | None = None#
static instance() tlc.core.objects.tables.system_tables.indexing_tables.run_indexing_table.RunIndexingTable#

Returns the singleton RunIndexingTable object

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

Only consider Runs