mainframe.models.schemas

Classes

ServerMetadata	Server metadata
Error	Error
Package	Model representing a package queried from the database.
PackageSpecifier	Model used to specify a package by name and version
ReportPackageBody	Model used to specify a package by name and version
EmailReport	Model for a report using email
ObservationKind	Create a collection of name/value pairs.
ObservationReport	Model for a report using the PyPI Observation Api
PackageScanResult	Client payload to server containing the results of a package scan
PackageScanResultFail	The client's reason as to why scanning a package failed
JobResult	Package information of a requested job.
GetRules	Usage docs: https://docs.pydantic.dev/2.8/concepts/models/
NoJob	Returned when no available jobs were found.
QueuePackageResponse	Returned after queueing a package. Contains the UUID
StatsResponse	Recent system statistics

Module Contents

class mainframe.models.schemas.ServerMetadata(/, **data: Any)

Bases: pydantic.BaseModel

Server metadata

server_commit: str

rules_commit: str

class mainframe.models.schemas.Error(/, **data: Any)

Bases: pydantic.BaseModel

Error

detail: str

class mainframe.models.schemas.Package(/, **data: Any)

Bases: pydantic.BaseModel

Model representing a package queried from the database.

scan_id: str

name: str

version: str | None

status: str | None

score: int | None

inspector_url: str | None

rules: list[str] = []

download_urls: list[str] = []

queued_at: datetime.datetime | None

queued_by: str | None

reported_at: datetime.datetime | None

reported_by: str | None

pending_at: datetime.datetime | None

pending_by: str | None

finished_at: datetime.datetime | None

finished_by: str | None

commit_hash: str | None

classmethod from_db(scan: mainframe.models.orm.Scan)

serialize_dt(dt: datetime.datetime | None, _info)

class mainframe.models.schemas.PackageSpecifier(/, **data: Any)

Bases: pydantic.BaseModel

Model used to specify a package by name and version

name: A str of the name of the package to be scanned version: A str of the package version to scan.

model_config

name: str

version: str

class mainframe.models.schemas.ReportPackageBody(/, **data: Any)

Bases: PackageSpecifier

Model used to specify a package by name and version

name: A str of the name of the package to be scanned version: A str of the package version to scan.

recipient: str | None

inspector_url: str | None

additional_information: str | None

use_email: bool = False

class mainframe.models.schemas.EmailReport(/, **data: Any)

Bases: PackageSpecifier

Model for a report using email

rules_matched: list[str]

recipient: str | None = None

inspector_url: str | None

additional_information: str | None

class mainframe.models.schemas.ObservationKind(*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.

DependencyConfusion = 'is_dependency_confusion'

Malware = 'is_malware'

Spam = 'is_spam'

Other = 'something_else'

class mainframe.models.schemas.ObservationReport(/, **data: Any)

Bases: pydantic.BaseModel

Model for a report using the PyPI Observation Api

kind: ObservationKind

summary: str

inspector_url: str | None

extra: dict[str, Any]

class mainframe.models.schemas.PackageScanResult(/, **data: Any)

Bases: PackageSpecifier

Client payload to server containing the results of a package scan

commit: str

score: int = 0

inspector_url: str | None = None

rules_matched: list[str] = []

class mainframe.models.schemas.PackageScanResultFail(/, **data: Any)

Bases: PackageSpecifier

The client’s reason as to why scanning a package failed

reason: str

class mainframe.models.schemas.JobResult(/, **data: Any)

Bases: pydantic.BaseModel

Package information of a requested job.

name: str

version: str

distributions: list[str]

hash: str

class mainframe.models.schemas.GetRules(/, **data: Any)

Bases: pydantic.BaseModel

Usage docs: https://docs.pydantic.dev/2.8/concepts/models/

A base class for creating Pydantic models.

__class_vars__

The names of classvars defined on the model.

__private_attributes__

Metadata about the private attributes of the model.

__signature__

The signature for instantiating the model.

__pydantic_complete__

Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__

The pydantic-core schema used to build the SchemaValidator and SchemaSerializer.

__pydantic_custom_init__

Whether the model has a custom __init__ function.

__pydantic_decorators__

Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_generic_metadata__

Metadata for generic models; contains data used for a similar purpose to __args__, __origin__, __parameters__ in typing-module generics. May eventually be replaced by these.

__pydantic_parent_namespace__

Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__

The name of the post-init method for the model, if defined.

__pydantic_root_model__

Whether the model is a RootModel.

__pydantic_serializer__

The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__

The pydantic-core SchemaValidator used to validate instances of the model.

__pydantic_extra__

An instance attribute with the values of extra fields from validation when model_config[‘extra’] == ‘allow’.

__pydantic_fields_set__

An instance attribute with the names of fields explicitly set.

__pydantic_private__

Instance attribute with the values of private attributes set on the model instance.

hash: str

rules: dict[str, str]

class mainframe.models.schemas.NoJob(/, **data: Any)

Bases: pydantic.BaseModel

Returned when no available jobs were found.

detail: str

class mainframe.models.schemas.QueuePackageResponse(/, **data: Any)

Bases: pydantic.BaseModel

Returned after queueing a package. Contains the UUID

id: str

class mainframe.models.schemas.StatsResponse(/, **data: Any)

Bases: pydantic.BaseModel

Recent system statistics

ingested: int

average_scan_time: float

failed: int