tseqmock.generator.base package

Submodules

tseqmock.generator.base.generator module

tseqmock.generator.base.granularity module

tseqmock.generator.base.profile module

tseqmock.generator.base.settings module

Base configuration settings for temporal sequence generation.

class tseqmock.generator.base.settings.BaseSeqGeneratorSettings(output_columns: Any, time_design: Any, sequence_id: str | None = 'seq', profiles: list | None = None)

Bases: object

Base configuration for temporal sequence generator settings.

Provides a minimal configuration structure for sequence generation, enforcing the definition of output column and time design specifications.

output_columns

Configuration for output column specifications. Defines how generated sequence data will be structured and labeled.

Type:

Any

time_design

Configuration for temporal design of the sequence generation process. Specifies how timestamps and time-related attributes are generated.

Type:

Any, optional

Example

# Typical usage in subclasses class EventGeneratorSettings(BaseSeqGeneratorSettings):

output_columns: EventOutputColumns time_design: EventTimeDesign profiles: List[Profile] = None

__init__(output_columns: Any, time_design: Any, sequence_id: str | None = 'seq', profiles: list | None = None) → None
output_columns: Any
profiles: list | None = None
sequence_id: str | None = 'seq'
time_design: Any

tseqmock.generator.base.utils module

Utility functions for temporal sequence generation.

tseqmock.generator.base.utils.ensure_calendar_aware_int(list_values, granularity)

Validate and convert values for calendar-aware time granularities.

Ensures that values used with calendar-based granularities (MONTH, YEAR) are integers, converting float values when possible and raising errors for non-integer floats.

Parameters:

  • list_values (List[Union[int, float]]) – Input values to validate.

  • granularity (Granularity) – Time granularity to check against.

Returns:

Converted integer values.

Return type:

List[int]

Raises:

  • ValueError – If non-integer float values are provided for

  • calendar-based granularities. –

Example

# Convert float values for monthly granularity values = [1.0, 2.0, 3.5] # Will raise ValueError values = [1.0, 2.0, 3.0] # Will convert to [1, 2, 3]

Module contents

Package stub.