AnalysisScope#

class openstef_beam.analysis.AnalysisScope(*, target_name: TargetName | None = None, group_name: GroupName | None = None, run_name: RunName | None = None, aggregation: AnalysisAggregation)[source]#

Bases: BaseConfig

Defines the scope context for analysis operations.

Specifies which targets, groups, and runs are included in an analysis, along with the aggregation level for grouping data.

Parameters:
  • target_name (str | None)

  • group_name (str | None)

  • run_name (str | None)

  • aggregation (AnalysisAggregation)

target_name: TargetName | None#
group_name: GroupName | None#
run_name: RunName | None#
aggregation: AnalysisAggregation#
__hash__() → int[source]#

Enable using AnalysisScope as a dictionary key.

Return type:

int

Returns:

Hash value based on all scope fields.

Overrides:

BaseModel.__hash__

model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': False, 'extra': 'ignore', 'protected_namespaces': ()}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].