pipeline.src.entities.pnos

Classes

PnoCatch
PnoSource	Create a collection of name/value pairs.
PnoToRender
PreRenderedPno
ReturnToPortPurpose	Create a collection of name/value pairs.
PnoAddressee
RenderedPno
PnoToSend
PriorNotificationSentMessage

Module Contents

class pipeline.src.entities.pnos.PnoCatch

species_code: str

species_name: str

species_name_code: str

weight: float

number_of_fish: int

fao_area: str

statistical_rectangle: str

__post_init__()

class pipeline.src.entities.pnos.PnoSource(*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.

MANUAL = 'MANUAL'

LOGBOOK = 'LOGBOOK'

class pipeline.src.entities.pnos.PnoToRender

id: int

operation_datetime_utc: datetime.datetime

report_id: str

report_datetime_utc: datetime.datetime

vessel_id: str

cfr: str

ircs: str

external_identification: str

vessel_name: str

flag_state: str

purpose: str

catch_onboard: List[dict]

port_locode: str

port_name: str

facade: str

predicted_arrival_datetime_utc: datetime.datetime

predicted_landing_datetime_utc: datetime.datetime

trip_gears: List[dict]

trip_segments: List[dict]

pno_types: List[dict]

note: str

vessel_length: float

mmsi: str

risk_factor: float

last_control_datetime_utc: datetime.datetime

last_control_infractions: List[dict]

is_verified: bool

is_being_sent: bool

source: PnoSource

is_correction: bool

previous_notification_date_utc: datetime.datetime | None

__post_init__()

class pipeline.src.entities.pnos.PreRenderedPno

id: int

operation_datetime_utc: datetime.datetime

report_id: str

report_datetime_utc: datetime.datetime

vessel_id: str

cfr: str

ircs: str

external_identification: str

vessel_name: str

flag_state: str

purpose: str

catch_onboard: pandas.DataFrame

bft_summary: str

port_locode: str

port_name: str

facade: str

predicted_arrival_datetime_utc: datetime.datetime

predicted_landing_datetime_utc: datetime.datetime

trip_gears: List[src.entities.fleet_segments.FishingGear]

trip_segments: List[src.entities.fleet_segments.FleetSegment]

pno_types: List[str]

note: str

vessel_length: float

mmsi: str

risk_factor: float

last_control_datetime_utc: datetime.datetime

last_control_infractions: List[src.entities.missions.Infraction]

is_verified: bool

is_being_sent: bool

is_landing: bool

source: PnoSource

purpose_suffix: str

is_zero: bool

is_correction: bool

previous_notification_date_utc: datetime.datetime | None

static assert_equal(left: object, right: object)

class pipeline.src.entities.pnos.ReturnToPortPurpose(*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.

SHE = 'SHE'

OTH = 'OTH'

LAN = 'LAN'

REF = 'REF'

REP = 'REP'

RES = 'RES'

ECY = 'ECY'

TRA = 'TRA'

SCR = 'SCR'

GRD = 'GRD'

ACS = 'ACS'

label()

class pipeline.src.entities.pnos.PnoAddressee

name: str

organization: str

communication_means: src.entities.communication_means.CommunicationMeans

email_address_or_number: str

class pipeline.src.entities.pnos.RenderedPno

report_id: str

vessel_id: int

cfr: str

vessel_name: str

is_verified: bool

is_being_sent: bool

trip_segments: list

pno_types: List[str]

port_locode: str

facade: str

source: PnoSource

purpose_suffix: str

html_for_pdf: str | None = None

pdf_document: bytes | None = None

generation_datetime_utc: datetime.datetime | None = None

html_email_body: str | None = None

sms_content: str | None = None

control_units: List[src.entities.control_units.ControlUnit] | None = None

additional_addressees: List[PnoAddressee] = None

is_zero: bool = False

is_correction: bool = False

previous_notification_date_utc: datetime.datetime | None = None

get_addressees(communication_means: src.entities.communication_means.CommunicationMeans) → List[PnoAddressee]

class pipeline.src.entities.pnos.PnoToSend

pno: RenderedPno

message: email.message.EmailMessage

communication_means: src.entities.communication_means.CommunicationMeans

class pipeline.src.entities.pnos.PriorNotificationSentMessage

prior_notification_report_id: str

prior_notification_source: PnoSource

date_time_utc: datetime.datetime

communication_means: src.entities.communication_means.CommunicationMeans

recipient_address_or_number: str

success: bool

recipient_name: str

recipient_organization: str

error_message: str | None = None