analyzer.core.linting

Attributes

logger
PIPELINE_LINTERS
ANALYSIS_LINTERS

Classes

LintLevel	Create a collection of name/value pairs.
LintMessage
LintConfig
PipelineLinter	Helper class that provides a standard way to create an ABC using
AnalysisLinter	Helper class that provides a standard way to create an ABC using
DanglingSelectionLinter	Helper class that provides a standard way to create an ABC using
DataQualityLinter	Helper class that provides a standard way to create an ABC using
PipelineReferenceLinter	Helper class that provides a standard way to create an ABC using
MissingCutflowLinter	Helper class that provides a standard way to create an ABC using

Functions

runLint(→ list[LintMessage])

Module Contents

analyzer.core.linting.logger

class analyzer.core.linting.LintLevel(*args, **kwds)

Bases: enum.Enum

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

• attribute access:

  >>> Color.RED
  <Color.RED: 1>
  

• value lookup:

  >>> Color(1)
  <Color.RED: 1>
  

• name lookup:

  >>> Color['RED']
  <Color.RED: 1>
  

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

WARNING = 1

ERROR = 2

class analyzer.core.linting.LintMessage

level: LintLevel

category: str

message: str

pipeline_name: str | None = None

module_name: str | None = None

__str__()

class analyzer.core.linting.LintConfig

ignore: list[str]

class analyzer.core.linting.PipelineLinter

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

name: str = 'BasePipelineLinter'

abstractmethod lint(pipeline_name: str, pipeline: list[analyzer.core.analysis_modules.AnalyzerModule], metadatas: list[dict]) → list[LintMessage]

class analyzer.core.linting.AnalysisLinter

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

name: str = 'BaseAnalysisLinter'

abstractmethod lint(analysis: analyzer.core.analysis.Analysis) → list[LintMessage]

class analyzer.core.linting.DanglingSelectionLinter

Bases: PipelineLinter

Helper class that provides a standard way to create an ABC using inheritance.

name = 'DanglingSelection'

lint(pipeline_name: str, pipeline: list[analyzer.core.analysis_modules.AnalyzerModule], metadatas: list[dict]) → list[LintMessage]

class analyzer.core.linting.DataQualityLinter

Bases: PipelineLinter

Helper class that provides a standard way to create an ABC using inheritance.

name = 'DataQuality'

lint(pipeline_name: str, pipeline: list[analyzer.core.analysis_modules.AnalyzerModule], metadatas: list[dict]) → list[LintMessage]

class analyzer.core.linting.PipelineReferenceLinter

Bases: AnalysisLinter

Helper class that provides a standard way to create an ABC using inheritance.

name = 'PipelineReference'

lint(analysis: analyzer.core.analysis.Analysis) → list[LintMessage]

class analyzer.core.linting.MissingCutflowLinter

Bases: PipelineLinter

Helper class that provides a standard way to create an ABC using inheritance.

name = 'MissingCutflow'

lint(pipeline_name: str, pipeline: list[analyzer.core.analysis_modules.AnalyzerModule], metadatas: list[dict]) → list[LintMessage]

analyzer.core.linting.PIPELINE_LINTERS: list[PipelineLinter]

analyzer.core.linting.ANALYSIS_LINTERS: list[AnalysisLinter]

analyzer.core.linting.runLint(analysis: analyzer.core.analysis.Analysis) → list[LintMessage]