pypcapkit 1.3.5.post6__cp313-none-any.whl

pcapkit/protocols/schema/transport/udp.py

@@ -0,0 +1,90 @@
+# -*- coding: utf-8 -*-
+# mypy: disable-error-code=assignment
+"""header schema for user datagram protocol"""
+
+from typing import TYPE_CHECKING
+
+from pcapkit.const.reg.apptype import AppType as Enum_AppType
+from pcapkit.const.reg.apptype import TransportProtocol as Enum_TransportProtocol
+from pcapkit.corekit.fields.misc import PayloadField
+from pcapkit.corekit.fields.numbers import EnumField, UInt16Field
+from pcapkit.corekit.fields.strings import BytesField
+from pcapkit.protocols.schema.schema import Schema, schema_final
+
+__all__ = ['UDP']
+
+if TYPE_CHECKING:
+    from typing import Any
+
+    from pcapkit.protocols.protocol import ProtocolBase as Protocol
+
+
+class PortEnumField(EnumField):
+    """Enumerated value for protocol fields.
+
+    Args:
+        length: Field size (in bytes); if a callable is given, it should return
+            an integer value and accept the current packet as its only argument.
+        default: Field default value, if any.
+        signed: Whether the field is signed.
+        byteorder: Field byte order.
+        bit_length: Field bit length.
+        callback: Callback function to be called upon
+            :meth:`self.__call__ <pcapkit.corekit.fields.field.FieldBase.__call__>`.
+
+    Important:
+        This class is specifically designed for :class:`~pcapkit.const.reg.apptype.AppType`
+        as it is actually a :class:`~enum.StrEnum` class.
+
+    """
+    if TYPE_CHECKING:
+        _namespace: 'Enum_AppType'
+
+    def pre_process(self, value: 'int | Enum_AppType', packet: 'dict[str, Any]') -> 'int | bytes':
+        """Process field value before construction (packing).
+
+        Arguments:
+            value: Field value.
+            packet: Packet data.
+
+        Returns:
+            Processed field value.
+
+        """
+        if isinstance(value, Enum_AppType):
+            value = value.port
+        return super().pre_process(value, packet)
+
+    def post_process(self, value: 'int | bytes', packet: 'dict[str, Any]') -> 'Enum_AppType':
+        """Process field value after parsing (unpacked).
+
+        Args:
+            value: Field value.
+            packet: Packet data.
+
+        Returns:
+            Processed field value.
+
+        """
+        value = super(EnumField, self).post_process(value, packet)
+        return self._namespace.get(value, proto=Enum_TransportProtocol.udp)
+
+
+@schema_final
+class UDP(Schema):
+    """Header schema for UDP packet."""
+
+    #: Source port.
+    srcport: 'Enum_AppType' = PortEnumField(length=2, namespace=Enum_AppType)
+    #: Destination port.
+    dstport: 'Enum_AppType' = PortEnumField(length=2, namespace=Enum_AppType)
+    #: Length of UDP packet.
+    len: 'int' = UInt16Field()
+    #: Checksum of UDP packet.
+    checksum: 'bytes' = BytesField(length=2)
+    #: Payload.
+    payload: 'bytes' = PayloadField()
+
+    if TYPE_CHECKING:
+        def __init__(self, srcport: 'Enum_AppType | int', dstport: 'Enum_AppType | int', len: 'int',
+                     checksum: 'bytes', payload: 'bytes | Schema | Protocol') -> 'None': ...

pcapkit/protocols/transport/__init__.py

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=unused-import,unused-wildcard-import,fixme
+"""Transport Layer Protocols
+===============================
+
+.. module:: pcapkit.protocols.transport
+
+:mod:`pcapkit.protocols.transport` is collection of all protocols in
+transport layer, with detailed implementation and methods.
+
+"""
+# TODO: Implements DCCP, RSVP, SCTP.
+
+# Base Class for Transport Layer
+from pcapkit.protocols.transport.transport import Transport
+
+# Utility Classes for Protocols
+from pcapkit.protocols.transport.tcp import TCP
+from pcapkit.protocols.transport.udp import UDP
+
+# Transport Layer Protocol Numbers
+from pcapkit.const.reg.transtype import TransType as TRANSTYPE
+
+__all__ = [
+    'TRANSTYPE',   # Protocol Numbers
+    'TCP', 'UDP',  # Transport Layer Protocols
+]