pipeline.src.entities.alerts

Classes

AlertType	Create a collection of name/value pairs.
GearSpecification
SpeciesSpecification
AdministrativeAreaType	Create a collection of name/value pairs.
AreasTableMetadata
AdminAreasSpecification
AdminAreasSpecWithTable
RegulatoryAreaSpecification
PositionAlertSpecification

Module Contents

class pipeline.src.entities.alerts.AlertType(*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.

MISSING_DEP_ALERT = 'MISSING_DEP_ALERT'

MISSING_FAR_ALERT = 'MISSING_FAR_ALERT'

MISSING_FAR_48_HOURS_ALERT = 'MISSING_FAR_48_HOURS_ALERT'

SUSPICION_OF_UNDER_DECLARATION_ALERT = 'SUSPICION_OF_UNDER_DECLARATION_ALERT'

POSITION_ALERT = 'POSITION_ALERT'

class pipeline.src.entities.alerts.GearSpecification

gear: str

minMesh: float | None = None

maxMesh: float | None = None

class pipeline.src.entities.alerts.SpeciesSpecification

species: str

minWeight: float | None = None

class pipeline.src.entities.alerts.AdministrativeAreaType(*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.

FAO_AREA = 'FAO_AREA'

EEZ_AREA = 'EEZ_AREA'

NEAFC_AREA = 'NEAFC_AREA'

DISTANCE_TO_SHORE = 'DISTANCE_TO_SHORE'

class pipeline.src.entities.alerts.AreasTableMetadata

table_name: str

geometry_column: str

filter_column: str

class pipeline.src.entities.alerts.AdminAreasSpecification

Bases: pydantic.BaseModel

areaType: AdministrativeAreaType

areas: List

class pipeline.src.entities.alerts.AdminAreasSpecWithTable

area_type: AdministrativeAreaType

areas: List

metadata: AreasTableMetadata

table: sqlalchemy.Table

class pipeline.src.entities.alerts.RegulatoryAreaSpecification

Bases: pydantic.BaseModel

lawType: str | None = None

topic: str | None = None

zone: str | None = None

class pipeline.src.entities.alerts.PositionAlertSpecification

Bases: pydantic.BaseModel

id: int

name: str

description: str

natinf_code: int

threat: str

threat_characterization: str

is_activated: bool

is_in_error: bool

error_reason: str | None

validity_start_datetime_utc: datetime.datetime | None

validity_end_datetime_utc: datetime.datetime | None

repeat_each_year: bool

track_analysis_depth: float

only_fishing_positions: bool

gears: List[GearSpecification] | None

species: List[SpeciesSpecification] | None

species_catch_areas: List[str] | None

administrative_areas: List[AdminAreasSpecification] | None

regulatory_areas: List[RegulatoryAreaSpecification] | None

min_depth: float | None

flag_states_iso2: List[str] | None

vessel_ids: List[int] | None

district_codes: List[str] | None

producer_organizations: List[str] | None

model_post_init(__context)