Skip to content

Ports

ports

Foundational port definition for the ForgingBlocks.

Port

Bases: Protocol

Base protocol for defining interface contracts.

Port is a generic Protocol that serves as the foundation for interface
declarations. It provides type parameters (InputType, OutputType) and
defines no methods — it's a marker protocol that you extend to create
your own specific interfaces.

TYPE PARAMETERS:
- InputType: The type of data accepted by operations on this interface.
- OutputType: The type of data returned by operations on this interface.

Source code in src/forging_blocks/foundation/ports.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
@runtime_checkable
class Port[InputType, OutputType](Protocol):
    """Base protocol for defining interface contracts.

    Port is a generic Protocol that serves as the foundation for interface
    declarations. It provides type parameters (InputType, OutputType) and
    defines no methods — it's a marker protocol that you extend to create
    your own specific interfaces.

    TYPE PARAMETERS:
    - `InputType`: The type of data accepted by operations on this interface.
    - `OutputType`: The type of data returned by operations on this interface.
    """

InboundPort

Bases: Port[InputType, OutputType], Protocol

Alias for Port used as an inbound marker.

Source code in src/forging_blocks/foundation/ports.py 
21
22
class InboundPort[InputType, OutputType](Port[InputType, OutputType], Protocol):
    """Alias for Port used as an inbound marker."""

OutboundPort

Bases: Port[InputType, OutputType], Protocol

Alias for Port used as an outbound marker.

Source code in src/forging_blocks/foundation/ports.py 
25
26
class OutboundPort[InputType, OutputType](Port[InputType, OutputType], Protocol):
    """Alias for Port used as an outbound marker."""