process_params module

This module provides parameter classes for process configuration.

Users define the params required for a process using the nice pydantic dataclass-like syntax, and then they can use those in their process functions with dot syntax. Nice. Also provides free pydantic validation.

class FixedParams

Bases: _Params

model_config: ConfigDict = {'arbitrary_types_allowed': True, 'extra': 'forbid', 'frozen': True, 'strict': True}

parent dataclass to be be inherited from to store specific fixed parameters for a particular subclass of FilterTester, or in other words for a particular filtering test. Using subclasses of this class for the fixed parameters provides type-safety and a consistent interface for implementing filters

class RunParams(*, record: VariantRecord, reads: ReadView[ExtendedRead])

Bases: _Params

record: VariantRecord

model_config: ConfigDict = {'arbitrary_types_allowed': True, 'extra': 'forbid', 'frozen': True, 'strict': True}

parent dataclass to be be inherited from to store specific fixed parameters for a particular subclass of FilterTester, or in other words for a particular filtering test. Using subclasses of this class for the fixed parameters provides type-safety and a consistent interface for implementing filters

reads: ReadView[ExtendedRead]