mate_rest_client.analyses module¶

Python API bindings for analyses endpoints in the MATE REST API.

class mate_rest_client.analyses.Analysis(client: mate_rest_client.Client, info: AnalysisInfo)¶

Bases: mate_rest_client.common.APIModel

Represents an analysis in MATE.

property background: str¶

property filepath: str¶

property id_: str¶

property name: str¶

run(build: builds.Build) → AnalysisTaskInfo¶

Parameters: build (builds.Build) –
Return type: AnalysisTaskInfo

class mate_rest_client.analyses.AnalysisRoutes(client: mate_rest_client.Client)¶

Bases: mate_rest_client.common.Routes

An adapter for interactions with analysis endpoints.

Parameters: client (mate_rest_client.Client) –
Return type: None

create(filename: pathlib.Path) → mate_rest_client.analyses.Analysis¶

Parameters: filename (pathlib.Path) –
Return type: mate_rest_client.analyses.Analysis

iter() → Iterator[mate_rest_client.analyses.Analysis]¶

Yield each Analysis currently available.

Return type: Iterator[mate_rest_client.analyses.Analysis]

run(build: builds.Build) → Iterator[AnalysisTaskInfo]¶

Parameters: build (builds.Build) –
Return type: Iterator[AnalysisTaskInfo]

property tasks: Iterator[mate_common.models.analyses.AnalysisTaskInfo]¶