tlc.client.bulk_data_url_utils

Util functions for generating bulk data Urls.

Module Contents

Functions

Function

Description

set_bulk_data_url_prefix

Set the global variable for the bulk data URL prefix.

set_table_with_bulk_data_url

Set the global variable for the table with bulk data URL.

increment_and_get_bulk_data_url

Get the next bulk data url.

relativize_bulk_data_url

Relativize the given bulk data Url to the Url of the Table with which it is associated.

reset_bulk_data_url

Reset the global bulk data Url prefix and index.

bulk_data_url_context

Context manager for bulk data Urls.

API

tlc.client.bulk_data_url_utils.set_bulk_data_url_prefix(prefix: tlc.core.url.Url | None) → None

Set the global variable for the bulk data URL prefix.

tlc.client.bulk_data_url_utils.set_table_with_bulk_data_url(table_with_bulk_data_url: tlc.core.url.Url | None) → None

Set the global variable for the table with bulk data URL.

tlc.client.bulk_data_url_utils.increment_and_get_bulk_data_url(column_name: str, suffix: str) → tlc.core.url.Url

Get the next bulk data url.

Increment the bulk data Url index and return a Url corresponding to the given column_name and suffix, and the current values of the global bulk data Url prefix and index.

Parameters:

  • column – The name of the part of the sample to generate the Url for.

  • suffix – The suffix to be used for the bulk data Url.

Returns:

The generated Url.

tlc.client.bulk_data_url_utils.relativize_bulk_data_url(bulk_data_url: tlc.core.url.Url) → tlc.core.url.Url

Relativize the given bulk data Url to the Url of the Table with which it is associated.

tlc.client.bulk_data_url_utils.reset_bulk_data_url() → None

Reset the global bulk data Url prefix and index.

tlc.client.bulk_data_url_utils.bulk_data_url_context(prefix: tlc.core.url.Url, table_with_bulk_data_url: tlc.core.url.Url) → collections.abc.Iterator[None]

Context manager for bulk data Urls.

Sets the global bulk data Url prefix to the given prefix, and resets it after the context manager exits.

Parameters:

  • prefix – The prefix to set the global bulk data Url prefix to.

  • table_with_bulk_data_url – The Url of the Table which all written bulk data Urls within this context will be relativized with respect to.