pypcapkit 1.3.1.dev1__tar.gz → 1.3.1.dev3__tar.gz

{pypcapkit-1.3.1.dev1/pypcapkit.egg-info → pypcapkit-1.3.1.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pypcapkit
-Version: 1.3.1.dev1
+Version: 1.3.1.dev3
 Summary: PyPCAPKit: comprehensive network packet analysis library
 Author-email: Jarry Shaw <jarryshaw@icloud.com>
 Maintainer: Jarry Shaw

{pypcapkit-1.3.1.dev1 → pypcapkit-1.3.1.dev3}/pcapkit/__init__.py

@@ -123,4 +123,4 @@ __all__ = [
 ]
 
 #: version number
-__version__ = '1.3.1.dev1'
+__version__ = '1.3.1.dev3'

{pypcapkit-1.3.1.dev1 → pypcapkit-1.3.1.dev3}/pcapkit/const/reg/apptype.py

@@ -23047,6 +23047,15 @@ class AppType(StrEnum):
     #: [UDP] Reserved
     reserved_8666: 'AppType' = 8666, 'reserved', TransportProtocol.get('udp')
 
+    #: [N/A] Unassigned
+    unassigned_8667: 'AppType' = 8667, 'unassigned', TransportProtocol.get('undefined')
+
+    #: [TCP] Spartan management
+    spartan: 'AppType' = 8668, 'spartan', TransportProtocol.get('tcp')
+
+    #: [UDP] Reserved
+    reserved_8668: 'AppType' = 8668, 'reserved', TransportProtocol.get('udp')
+
     #: [TCP] Motorola Solutions Customer Programming Software for Radio Management
     msi_cps_rm: 'AppType' = 8675, 'msi-cps-rm', TransportProtocol.get('tcp')
 
@@ -28888,6 +28897,9 @@ class AppType(StrEnum):
     #: [TCP] A protocol for controlling a microscope
     microdeep: 'AppType' = -1, 'microdeep', TransportProtocol.get('tcp')
 
+    #: [UDP] MIDI 2.0 Device Discovery
+    midi2: 'AppType' = -1, 'midi2', TransportProtocol.get('udp')
+
     #: [TCP] Protocol for connected accessories
     mieleacs: 'AppType' = -1, 'mieleacs', TransportProtocol.get('tcp')
 
@@ -31365,7 +31377,7 @@ class AppType(StrEnum):
         if 8616 <= value <= 8664:
             #: [N/A] Unassigned
             return extend_enum(cls, 'unassigned_%d' % value, value, 'unassigned', TransportProtocol.get('undefined'))
-        if 8667 <= value <= 8674:
+        if 8669 <= value <= 8674:
             #: [N/A] Unassigned
             return extend_enum(cls, 'unassigned_%d' % value, value, 'unassigned', TransportProtocol.get('undefined'))
         if 8676 <= value <= 8685:

{pypcapkit-1.3.1.dev1 → pypcapkit-1.3.1.dev3}/pcapkit/const/reg/ethertype.py

@@ -50,7 +50,7 @@ class EtherType(IntEnum):
     #: DLOG [Neil Sembower]
     DLOG_0x0661 = 0x0661
 
-    #: Internet Protocol version 4 (IPv4) [:rfc:`7042`]
+    #: Internet Protocol version 4 (IPv4) [RFC-ietf-intarea-rfc7042bis-11]
     Internet_Protocol_version_4 = 0x0800
 
     #: X.75 Internet [Neil Sembower]
@@ -68,7 +68,7 @@ class EtherType(IntEnum):
     #: X.25 Level 3 [Neil Sembower]
     X_25_Level_3 = 0x0805
 
-    #: Address Resolution Protocol (ARP) [:rfc:`7042`]
+    #: Address Resolution Protocol (ARP) [RFC-ietf-intarea-rfc7042bis-11]
     Address_Resolution_Protocol = 0x0806
 
     #: XNS Compatability [Neil Sembower]
@@ -318,7 +318,7 @@ class EtherType(IntEnum):
     Wellfleet_Communications = 0x80FF
 
     #: Customer VLAN Tag Type (C-Tag, formerly called the Q-Tag) (initially
-    #: Wellfleet) [:rfc:`7042`]
+    #: Wellfleet) [RFC-ietf-intarea-rfc7042bis-11]
     Customer_VLAN_Tag_Type = 0x8100
 
     #: Hayes Microcomputers [Neil Sembower]
@@ -381,7 +381,7 @@ class EtherType(IntEnum):
     #: Delta Controls [Neil Sembower]
     Delta_Controls = 0x86DE
 
-    #: Internet Protocol version 6 (IPv6) [:rfc:`7042`]
+    #: Internet Protocol version 6 (IPv6) [RFC-ietf-intarea-rfc7042bis-11]
     Internet_Protocol_version_6 = 0x86DD
 
     #: ATOMIC [Joe Touch]
@@ -396,16 +396,17 @@ class EtherType(IntEnum):
     #: Secure Data [:rfc:`1701`]
     Secure_Data = 0x876D
 
-    #: IEEE Std 802.3 - Ethernet Passive Optical Network (EPON) [EPON][:rfc:`7042`]
+    #: IEEE Std 802.3 - Ethernet Passive Optical Network (EPON) [EPON][RFC-ietf-
+    #: intarea-rfc7042bis-11]
     IEEE_Std_802_3_Ethernet_Passive_Optical_Network = 0x8808
 
     #: Slow Protocols (Link Aggregation, OAM, etc.) [IEEE]
     Slow_Protocols = 0x8809
 
-    #: Point-to-Point Protocol (PPP) [:rfc:`7042`]
+    #: Point-to-Point Protocol (PPP) [RFC-ietf-intarea-rfc7042bis-11]
     Point_to_Point_Protocol = 0x880B
 
-    #: General Switch Management Protocol (GSMP) [:rfc:`7042`]
+    #: General Switch Management Protocol (GSMP) [RFC-ietf-intarea-rfc7042bis-11]
     General_Switch_Management_Protocol = 0x880C
 
     #: Ethernet NIC hardware and software testing [Wind River]
@@ -417,7 +418,8 @@ class EtherType(IntEnum):
     #: MPLS with upstream-assigned label [:rfc:`5332`]
     MPLS_with_upstream_assigned_label = 0x8848
 
-    #: Multicast Channel Allocation Protocol (MCAP) [:rfc:`7042`]
+    #: Multicast Channel Allocation Protocol (MCAP) [RFC-ietf-intarea-
+    #: rfc7042bis-11]
     Multicast_Channel_Allocation_Protocol = 0x8861
 
     #: PPP over Ethernet (PPPoE) Discovery Stage [:rfc:`2516`]

{pypcapkit-1.3.1.dev1 → pypcapkit-1.3.1.dev3}/pcapkit/const/reg/transtype.py

@@ -476,7 +476,7 @@ class TransType(IntEnum):
     #: AGGFRAG encapsulation payload for ESP [:rfc:`9347`]
     AGGFRAG = 144
 
-    #: Network Service Header [RFC-ietf-spring-nsh-sr-14]
+    #: Network Service Header [:rfc:`9491`]
     NSH = 145
 
     #: Use for experimentation and testing [:rfc:`3692`]

{pypcapkit-1.3.1.dev1 → pypcapkit-1.3.1.dev3}/pcapkit/protocols/internet/ah.py

@@ -226,7 +226,7 @@ class AH(IPsec[Data_AH, Schema_AH],
             **kwargs: Arbitrary keyword arguments.
 
         See Also:
-            For construction argument, please refer to :meth:`make`.
+            For construction argument, please refer to :meth:`self.make <AH.make>`.
 
         """
         #: bool: If the protocol is used as an IPv6 extension header.

{pypcapkit-1.3.1.dev1 → pypcapkit-1.3.1.dev3}/pcapkit/protocols/internet/hip.py

@@ -311,7 +311,7 @@ class HIP(Internet[Data_HIP, Schema_HIP],
          - :meth:`~pcapkit.protocols.internet.hip.HIP._read_param_reg_failed`
        * - :attr:`~pcapkit.const.hip.parameter.Parameter.REG_FROM`
          - :meth:`~pcapkit.protocols.internet.hip.HIP._read_param_reg_from`
-       * - :attr:`~pcapkit.const.hip.parameter.Parameter.ECHO_RESPONSE_SIGNEED`
+       * - :attr:`~pcapkit.const.hip.parameter.Parameter.ECHO_RESPONSE_SIGNED`
          - :meth:`~pcapkit.protocols.internet.hip.HIP._read_param_echo_response_signed`
        * - :attr:`~pcapkit.const.hip.parameter.Parameter.TRANSPORT_FORMAT_LIST`
          - :meth:`~pcapkit.protocols.internet.hip.HIP._read_param_transport_format_list`
@@ -611,7 +611,7 @@ class HIP(Internet[Data_HIP, Schema_HIP],
             **kwargs: Arbitrary keyword arguments.
 
         See Also:
-            For construction argument, please refer to :meth:`make`.
+            For construction argument, please refer to :meth:`self.make <HIP.make>`.
 
         """
         #: bool: If the protocol is used as an IPv6 extension header.

{pypcapkit-1.3.1.dev1 → pypcapkit-1.3.1.dev3}/pcapkit/protocols/internet/hopopt.py

@@ -186,8 +186,8 @@ class HOPOPT(Internet[Data_HOPOPT, Schema_HOPOPT],
     # Defaults.
     ##########################################################################
 
-    #: DefaultDict[Enum_Option, str | tuple[OptionParser, OptionConstructor]]:
-    #: Option code to method mapping, c.f. :meth:`_read_hopopt_options` and/or
+    #: DefaultDict[Enum_Option, str | tuple[OptionParser, OptionConstructor]]: Option
+    #: code to method mapping, c.f. :meth:`_read_hopopt_options` and/or
     #: :meth:`_make_hopopt_options`. Method names are expected to be referred
     #: to the class by ``_read_opt_${name}`` and/or ``_make_opt_${name}``, and
     #: if such name not found, the value should then be a method that can parse
@@ -492,7 +492,6 @@ class HOPOPT(Internet[Data_HOPOPT, Schema_HOPOPT],
 
         Args:
             schema: parsed parameter schema
-            length: option length (incl. type, length, content)
             option: extracted HOPOPT options
 
         Returns:
@@ -577,7 +576,6 @@ class HOPOPT(Internet[Data_HOPOPT, Schema_HOPOPT],
 
         Args:
             schema: parsed parameter schema
-            length: option length (incl. type, length, content)
             option: extracted HOPOPT options
 
         Returns:
@@ -612,7 +610,6 @@ class HOPOPT(Internet[Data_HOPOPT, Schema_HOPOPT],
 
         Args:
             schema: parsed parameter schema
-            length: option length (incl. type, length, content)
             option: extracted HOPOPT options
 
         Returns:
@@ -653,7 +650,6 @@ class HOPOPT(Internet[Data_HOPOPT, Schema_HOPOPT],
 
         Args:
             schema: parsed parameter schema
-            length: option length (incl. type, length, content)
             option: extracted HOPOPT options
 
         Returns:
@@ -718,7 +714,6 @@ class HOPOPT(Internet[Data_HOPOPT, Schema_HOPOPT],
 
         Args:
             schema: parsed parameter schema
-            length: option length (incl. type, length, content)
             option: extracted HOPOPT options
 
         Returns:
@@ -782,7 +777,6 @@ class HOPOPT(Internet[Data_HOPOPT, Schema_HOPOPT],
 
         Args:
             schema: parsed parameter schema
-            length: option length (incl. type, length, content)
             option: extracted HOPOPT options
 
         Returns:
@@ -842,7 +836,6 @@ class HOPOPT(Internet[Data_HOPOPT, Schema_HOPOPT],
 
         Args:
             schema: parsed parameter schema
-            length: option length (incl. type, length, content)
             option: extracted HOPOPT options
 
         Returns:
@@ -906,7 +899,6 @@ class HOPOPT(Internet[Data_HOPOPT, Schema_HOPOPT],
 
         Args:
             schema: parsed parameter schema
-            length: option length (incl. type, length, content)
             option: extracted HOPOPT options
 
         Returns:
@@ -951,7 +943,6 @@ class HOPOPT(Internet[Data_HOPOPT, Schema_HOPOPT],
 
         Args:
             schema: parsed parameter schema
-            length: option length (incl. type, length, content)
             option: extracted HOPOPT options
 
         Returns:
@@ -1013,7 +1004,6 @@ class HOPOPT(Internet[Data_HOPOPT, Schema_HOPOPT],
 
         Args:
             schema: parsed parameter schema
-            length: option length (incl. type, length, content)
             option: extracted HOPOPT options
 
         Returns:
@@ -1046,7 +1036,6 @@ class HOPOPT(Internet[Data_HOPOPT, Schema_HOPOPT],
 
         Args:
             schema: parsed parameter schema
-            length: option length (incl. type, length, content)
             option: extracted HOPOPT options
 
         Returns:
@@ -1078,7 +1067,6 @@ class HOPOPT(Internet[Data_HOPOPT, Schema_HOPOPT],
 
         Args:
             schema: parsed parameter schema
-            length: option length (incl. type, length, content)
             option: extracted HOPOPT options
 
         Returns:
@@ -1123,7 +1111,6 @@ class HOPOPT(Internet[Data_HOPOPT, Schema_HOPOPT],
 
         Args:
             schema: parsed parameter schema
-            length: option length (incl. type, length, content)
             option: extracted HOPOPT options
 
         Returns:
@@ -1162,7 +1149,6 @@ class HOPOPT(Internet[Data_HOPOPT, Schema_HOPOPT],
 
         Args:
             schema: parsed parameter schema
-            length: option length (incl. type, length, content)
             option: extracted HOPOPT options
 
         Returns:

{pypcapkit-1.3.1.dev1 → pypcapkit-1.3.1.dev3}/pcapkit/protocols/internet/ipv4.py

@@ -152,9 +152,9 @@ class IPv4(IP[Data_IPv4, Schema_IPv4],
        * - :attr:`~pcapkit.const.ipv4.option_number.OptionNumber.TS`
          - :meth:`~pcapkit.protocols.internet.ipv4.IPv4._read_opt_ts`
          - :meth:`~pcapkit.protocols.internet.ipv4.IPv4._make_opt_ts`
-       * - :attr:`~pcapkit.const.ipv4.option_number.OptionNumber.ESEC`
-         - :meth:`~pcapkit.protocols.internet.ipv4.IPv4._read_opt_esec`
-         - :meth:`~pcapkit.protocols.internet.ipv4.IPv4._make_opt_esec`
+       * - :attr:`~pcapkit.const.ipv4.option_number.OptionNumber.E_SEC`
+         - :meth:`~pcapkit.protocols.internet.ipv4.IPv4._read_opt_e_sec`
+         - :meth:`~pcapkit.protocols.internet.ipv4.IPv4._make_opt_e_sec`
        * - :attr:`~pcapkit.const.ipv4.option_number.OptionNumber.RR`
          - :meth:`~pcapkit.protocols.internet.ipv4.IPv4._read_opt_rr`
          - :meth:`~pcapkit.protocols.internet.ipv4.IPv4._make_opt_rr`
@@ -800,10 +800,10 @@ class IPv4(IP[Data_IPv4, Schema_IPv4],
         )
         return opt
 
-    def _read_opt_esec(self, schema: 'Schema_ESECOption', *, options: 'Option') -> 'Data_ESECOption':  # pylint: disable=unused-argument
-        """Read IPv4 Extended Security (``ESEC``) option.
+    def _read_opt_e_sec(self, schema: 'Schema_ESECOption', *, options: 'Option') -> 'Data_ESECOption':  # pylint: disable=unused-argument
+        """Read IPv4 Extended Security (``E-SEC``) option.
 
-        Structure of IPv4 Extended Security (``ESEC``) option [:rfc:`1108`]:
+        Structure of IPv4 Extended Security (``E-SEC``) option [:rfc:`1108`]:
 
         .. code-block:: text
 
@@ -1477,11 +1477,11 @@ class IPv4(IP[Data_IPv4, Schema_IPv4],
             data=ts_list,
         )
 
-    def _make_opt_esec(self, kind: 'Enum_OptionNumber', option: 'Optional[Data_ESECOption]' = None, *,
+    def _make_opt_e_sec(self, kind: 'Enum_OptionNumber', option: 'Optional[Data_ESECOption]' = None, *,
                        format: 'int' = 0,
                        info: 'Optional[bytes]' = None,
                        **kwargs: 'Any') -> 'Schema_ESECOption':
-        """Make IPv4 Extended Security (``ESEC``) option.
+        """Make IPv4 Extended Security (``E-SEC``) option.
 
         Args:
             kind: option type code

{pypcapkit-1.3.1.dev1 → pypcapkit-1.3.1.dev3}/pcapkit/protocols/internet/ipv6_frag.py

@@ -209,7 +209,7 @@ class IPv6_Frag(Internet[Data_IPv6_Frag, Schema_IPv6_Frag],
             **kwargs: Arbitrary keyword arguments.
 
         See Also:
-            For construction argument, please refer to :meth:`make`.
+            For construction argument, please refer to :meth:`self.make <IPv6_Frag.make>`.
 
         """
         #: bool: If the protocol is used as an IPv6 extension header.

{pypcapkit-1.3.1.dev1 → pypcapkit-1.3.1.dev3}/pcapkit/protocols/internet/ipv6_opts.py

@@ -191,8 +191,8 @@ class IPv6_Opts(Internet[Data_IPv6_Opts, Schema_IPv6_Opts],
     # Defaults.
     ##########################################################################
 
-    #: DefaultDict[Enum_Option, str | tuple[OptionParser, OptionConstructor]]:
-    #: Option code to method mapping, c.f. :meth:`_read_ipv6_opts` and/or
+    #: DefaultDict[Enum_Option, str | tuple[OptionParser, OptionConstructor]]: Option
+    #: code to method mapping, c.f. :meth:`_read_ipv6_opts` and/or
     #: :meth:`_make_ipv6_opts`. Method names are expected to be referred to the
     #: class by ``_read_opt_${name}`` and/or ``_make_opt_${name}``, and if such
     #: name not found, the value should then be a method that can parse the
@@ -393,7 +393,7 @@ class IPv6_Opts(Internet[Data_IPv6_Opts, Schema_IPv6_Opts],
             **kwargs: Arbitrary keyword arguments.
 
         See Also:
-            For construction argument, please refer to :meth:`make`.
+            For construction argument, please refer to :meth:`self.make <IPv6_Opts.make>`.
 
         """
         #: bool: If the protocol is used as an IPv6 extension header.
@@ -503,7 +503,6 @@ class IPv6_Opts(Internet[Data_IPv6_Opts, Schema_IPv6_Opts],
 
         Args:
             schema: parsed parameter schema
-            length: option length (incl. type, length, content)
             option: extracted IPv6-Opts options
 
         Returns:
@@ -588,7 +587,6 @@ class IPv6_Opts(Internet[Data_IPv6_Opts, Schema_IPv6_Opts],
 
         Args:
             schema: parsed parameter schema
-            length: option length (incl. type, length, content)
             option: extracted IPv6-Opts options
 
         Returns:
@@ -623,7 +621,6 @@ class IPv6_Opts(Internet[Data_IPv6_Opts, Schema_IPv6_Opts],
 
         Args:
             schema: parsed parameter schema
-            length: option length (incl. type, length, content)
             option: extracted IPv6-Opts options
 
         Returns:
@@ -664,7 +661,6 @@ class IPv6_Opts(Internet[Data_IPv6_Opts, Schema_IPv6_Opts],
 
         Args:
             schema: parsed parameter schema
-            length: option length (incl. type, length, content)
             option: extracted IPv6-Opts options
 
         Returns:
@@ -729,7 +725,6 @@ class IPv6_Opts(Internet[Data_IPv6_Opts, Schema_IPv6_Opts],
 
         Args:
             schema: parsed parameter schema
-            length: option length (incl. type, length, content)
             option: extracted IPv6-Opts options
 
         Returns:
@@ -793,7 +788,6 @@ class IPv6_Opts(Internet[Data_IPv6_Opts, Schema_IPv6_Opts],
 
         Args:
             schema: parsed parameter schema
-            length: option length (incl. type, length, content)
             option: extracted IPv6-Opts options
 
         Returns:
@@ -853,7 +847,6 @@ class IPv6_Opts(Internet[Data_IPv6_Opts, Schema_IPv6_Opts],
 
         Args:
             schema: parsed parameter schema
-            length: option length (incl. type, length, content)
             option: extracted IPv6-Opts options
 
         Returns:
@@ -917,7 +910,6 @@ class IPv6_Opts(Internet[Data_IPv6_Opts, Schema_IPv6_Opts],
 
         Args:
             schema: parsed parameter schema
-            length: option length (incl. type, length, content)
             option: extracted IPv6-Opts options
 
         Returns:
@@ -962,7 +954,6 @@ class IPv6_Opts(Internet[Data_IPv6_Opts, Schema_IPv6_Opts],
 
         Args:
             schema: parsed parameter schema
-            length: option length (incl. type, length, content)
             option: extracted IPv6-Opts options
 
         Returns:
@@ -1024,7 +1015,6 @@ class IPv6_Opts(Internet[Data_IPv6_Opts, Schema_IPv6_Opts],
 
         Args:
             schema: parsed parameter schema
-            length: option length (incl. type, length, content)
             option: extracted IPv6-Opts options
 
         Returns:
@@ -1057,7 +1047,6 @@ class IPv6_Opts(Internet[Data_IPv6_Opts, Schema_IPv6_Opts],
 
         Args:
             schema: parsed parameter schema
-            length: option length (incl. type, length, content)
             option: extracted IPv6-Opts options
 
         Returns:
@@ -1089,7 +1078,6 @@ class IPv6_Opts(Internet[Data_IPv6_Opts, Schema_IPv6_Opts],
 
         Args:
             schema: parsed parameter schema
-            length: option length (incl. type, length, content)
             option: extracted IPv6-Opts options
 
         Returns:
@@ -1134,7 +1122,6 @@ class IPv6_Opts(Internet[Data_IPv6_Opts, Schema_IPv6_Opts],
 
         Args:
             schema: parsed parameter schema
-            length: option length (incl. type, length, content)
             option: extracted IPv6-Opts options
 
         Returns:
@@ -1173,7 +1160,6 @@ class IPv6_Opts(Internet[Data_IPv6_Opts, Schema_IPv6_Opts],
 
         Args:
             schema: parsed parameter schema
-            length: option length (incl. type, length, content)
             option: extracted IPv6-Opts options
 
         Returns:

{pypcapkit-1.3.1.dev1 → pypcapkit-1.3.1.dev3}/pcapkit/protocols/internet/ipv6_route.py

@@ -96,8 +96,8 @@ class IPv6_Route(Internet[Data_IPv6_Route, Schema_IPv6_Route],
     # Defaults.
     ##########################################################################
 
-    #: DefaultDict[Enum_Routing, str | tuple[TypeParser, TypeConstructor]]:
-    #: Type code to method mapping. Method names are expected to be referred to
+    #: DefaultDict[Enum_Routing, str | tuple[TypeParser, TypeConstructor]]: Type
+    #: code to method mapping. Method names are expected to be referred to
     #: the class by ``_read_data_type_${name}`` and/or ``_make_data_type_${name}``,
     #: and if such name not found, the value should then be a method that can
     #: parse the routing type by itself.
@@ -327,7 +327,7 @@ class IPv6_Route(Internet[Data_IPv6_Route, Schema_IPv6_Route],
             **kwargs: Arbitrary keyword arguments.
 
         See Also:
-            For construction argument, please refer to :meth:`make`.
+            For construction argument, please refer to :meth:`self.make <IPv6_Route.make>`.
 
         """
         #: bool: If the protocol is used as an IPv6 extension header.

{pypcapkit-1.3.1.dev1 → pypcapkit-1.3.1.dev3}/pcapkit/protocols/internet/mh.py

@@ -193,8 +193,16 @@ if TYPE_CHECKING:
 
 __all__ = ['MH']
 
-NTPTimestamp = collections.namedtuple('NTPTimestamp', 'seconds fraction')
-NTPTimestamp.__doc__ = """NTP timestamp format, c.f., :rfc:`1305`."""
+
+class NTPTimestamp(collections.namedtuple('NTPTimestamp', 'seconds fraction')):
+    """NTP timestamp format, c.f., :rfc:`1305`."""
+
+    __slots__ = ()
+
+    #: Seconds since 1 January 1900.
+    seconds: int
+    #: Fraction of a second.
+    fraction: int
 
 
 class MH(Internet[Data_MH, Schema_MH],
@@ -607,7 +615,7 @@ class MH(Internet[Data_MH, Schema_MH],
             **kwargs: Arbitrary keyword arguments.
 
         See Also:
-            For construction argument, please refer to :meth:`make`.
+            For construction argument, please refer to :meth:`self.make <MH.make>`.
 
         """
         #: bool: If the protocol is used as an IPv6 extension header.

{pypcapkit-1.3.1.dev1 → pypcapkit-1.3.1.dev3}/pcapkit/protocols/link/arp.py

@@ -80,8 +80,8 @@ class ARP(Link[Data_ARP, Schema_ARP],
 
     - Address Resolution Protocol (:class:`~pcapkit.protocols.link.arp.ARP`) [:rfc:`826`]
     - Reverse Address Resolution Protocol (:class:`~pcapkit.protocols.link.rarp.RARP`) [:rfc:`903`]
-    - Dynamic Reverse Address Resolution Protocol (:class:`~pcapkit.protocols.link.DRARP`) [:rfc:`1931`]
-    - Inverse Address Resolution Protocol (:class:`~pcapkit.protocols.link.InARP`) [:rfc:`2390`]
+    - Dynamic Reverse Address Resolution Protocol (:class:`~pcapkit.protocols.link.rarp.DRARP`) [:rfc:`1931`]
+    - Inverse Address Resolution Protocol (:class:`~pcapkit.protocols.link.arp.InARP`) [:rfc:`2390`]
 
     """
     #: Name of corresponding protocol.

{pypcapkit-1.3.1.dev1 → pypcapkit-1.3.1.dev3}/pcapkit/protocols/link/link.py

@@ -5,10 +5,15 @@
 
 .. module:: pcapkit.protocols.link.link
 
-:mod:`pcapkit.protocols.link.link` contains :class:`~pcapkit.protocols.link.link.Link`,
-which is a base class for link layer protocols, e.g. :class:`~pcapkit.protocols.link.arp.ARP`/InARP,
-:class:`~pcapkit.protocols.link.ethernet.Ethernet`, :class:`~pcapkit.protocols.link.l2tp.L2TP`,
-:class:`~pcapkit.protocols.link.ospf.OSPF`, :class:`~pcapkit.protocols.link.rarp.RARP`/DRARP and etc.
+:mod:`pcapkit.protocols.link.link` contains
+:class:`~pcapkit.protocols.link.link.Link`,
+which is a base class for link layer protocols, e.g.
+:class:`~pcapkit.protocols.link.arp.ARP`/:class:`~pcapkit.protocols.link.arp.InARP`,
+:class:`~pcapkit.protocols.link.ethernet.Ethernet`,
+:class:`~pcapkit.protocols.link.l2tp.L2TP`,
+:class:`~pcapkit.protocols.link.ospf.OSPF`,
+:class:`~pcapkit.protocols.link.rarp.RARP`/:class:`~pcapkit.protocols.link.rarp.DRARP`
+and etc.
 
 """
 import collections

{pypcapkit-1.3.1.dev1 → pypcapkit-1.3.1.dev3}/pcapkit/protocols/misc/pcapng.py

@@ -532,8 +532,8 @@ class PCAPNG(Protocol[Data_PCAPNG, Schema_PCAPNG],
         },
     )  # type: DefaultDict[Enum_LinkType | int, ModuleDescriptor[Protocol] | Type[Protocol]]
 
-    #: DefaultDict[Enum_BlockType, str | tuple[BlockParser, BlockConstructor]]:
-    #: Block type to method mapping. Method names are expected to be referred
+    #: DefaultDict[Enum_BlockType, str | tuple[BlockParser, BlockConstructor]]: Block
+    #: type to method mapping. Method names are expected to be referred
     #: to the class by ``_read_block_${name}`` and/or ``_make_block_${name}``,
     #: and if such name not found, the value should then be a method that can
     #: parse the block by itself.
@@ -554,8 +554,8 @@ class PCAPNG(Protocol[Data_PCAPNG, Schema_PCAPNG],
         },
     )  # type: DefaultDict[Enum_BlockType | int, str | tuple[BlockParser, BlockConstructor]]
 
-    #: DefaultDict[Enum_OptionType, str | tuple[OptionParser, OptionConstructor]]:
-    #: Block option type to method mapping. Method names are expected to be
+    #: DefaultDict[Enum_OptionType, str | tuple[OptionParser, OptionConstructor]]: Block
+    #: option type to method mapping. Method names are expected to be
     #: referred to the class by ``_read_option_${name}`` and/or ``_make_option_${name}``,
     #: and if such name not found, the value should then be a method that can
     #: parse the option by itself.
@@ -605,8 +605,8 @@ class PCAPNG(Protocol[Data_PCAPNG, Schema_PCAPNG],
         },
     )  # type: DefaultDict[Enum_OptionType | int, str | tuple[OptionParser, OptionConstructor]]
 
-    #: DefaultDict[Enum_RecordType, str | tuple[RecordParser, RecordConstructor]]:
-    #: :manpage:`systemd(1)` Journal Export record type to method mapping. Method names are expected
+    #: DefaultDict[Enum_RecordType, str | tuple[RecordParser, RecordConstructor]]: :manpage:`systemd(1)`
+    #: Journal Export record type to method mapping. Method names are expected
     #: to be referred to the class by ``_read_record_${name}`` and/or ``_make_record_${name}``,
     #: and if such name not found, the value should then be a method that can
     #: parse the name record by itself.
@@ -619,8 +619,8 @@ class PCAPNG(Protocol[Data_PCAPNG, Schema_PCAPNG],
         },
     )  # type: DefaultDict[Enum_RecordType | int, str | tuple[RecordParser, RecordConstructor]]
 
-    #: DefaultDict[Enum_SecretsType, str | tuple[SecretsParser, SecretsConstructor]]:
-    #: Decryption secrets type to method mapping. Method names are expected to
+    #: DefaultDict[Enum_SecretsType, str | tuple[SecretsParser, SecretsConstructor]]: Decryption
+    #: secrets type to method mapping. Method names are expected to
     #: be referred to the class by ``_read_secrets_${name}`` and/or ``_make_secrets_${name}``,
     #: and if such name not found, the value should then be a method that can
     #: parse the decryption secrets by itself.

{pypcapkit-1.3.1.dev1 → pypcapkit-1.3.1.dev3}/pcapkit/protocols/protocol.py

@@ -105,9 +105,9 @@ class ProtocolBase(Generic[PT, ST], metaclass=ProtocolMeta):
 
     #: Layer of protocol, can be one of ``Link``, ``Internet``, ``Transport``
     #: and ``Application``. For example, the layer of
-    #: :class:`~pcapkit.protocols.link.Ethernet` is ``Link``. However, certain
-    #: protocols are not in any layer, such as
-    # :class:`~pcapkit.protocols.misc.raw.Raw`, and thus its layer is :obj:`None`.
+    #: :class:`~pcapkit.protocols.link.ethernet.Ethernet` is ``Link``. However,
+    #: certain protocols are not in any layer, such as
+    #: :class:`~pcapkit.protocols.misc.raw.Raw`, and thus its layer is :obj:`None`.
     __layer__: 'Optional[Literal["Link", "Internet", "Transport", "Application"]]' = None
 
     #: Protocol index mapping for decoding next layer, c.f.
@@ -205,8 +205,9 @@ class ProtocolBase(Generic[PT, ST], metaclass=ProtocolMeta):
     def id(cls) -> 'tuple[str, ...]':
         """Index ID of the protocol.
 
-        By default, it returns the name of the protocol. In certain cases, the
-        method may return multiple values.
+        Returns:
+            By default, it returns the name of the protocol. In certain cases,
+            the method may return multiple values.
 
         See Also:
             :meth:`pcapkit.protocols.protocol.Protocol.__getitem__`
@@ -500,7 +501,7 @@ class ProtocolBase(Generic[PT, ST], metaclass=ProtocolMeta):
             length: Length of packet data.
             _layer (str): Parse packet until ``_layer``
                 (:attr:`self._exlayer <pcapkit.protocols.protocol.Protocol._exlayer>`).
-            _protocol (str | ProtocolBase | Type[ProtocolBase]): Parse packet until ``_protocol``
+            _protocol (Union[str, Protocol, Type[Protocol]]): Parse packet until ``_protocol``
                 (:attr:`self._exproto <pcapkit.protocols.protocol.Protocol._exproto>`).
             **kwargs: Arbitrary keyword arguments.
 
@@ -657,7 +658,7 @@ class ProtocolBase(Generic[PT, ST], metaclass=ProtocolMeta):
         """Subscription (``getitem``) support.
 
         * If ``key`` is a :class:`~pcapkit.protocols.protocol.Protocol` object,
-          the method will fetch its indexes (:meth:`~pcapkit.protocols.protocol.Protocol.id`).
+          the method will fetch its indexes (:meth:`self.id <pcapkit.protocols.protocol.Protocol.id>`).
         * Later, search the packet's chain of protocols with the calculated ``key``.
         * If no matches, then raises :exc:`~pcapkit.utilities.exceptions.ProtocolNotFound`.
 
@@ -760,13 +761,13 @@ class ProtocolBase(Generic[PT, ST], metaclass=ProtocolMeta):
     ##########################################################################
 
     def _get_payload(self) -> 'bytes':
-        """Get payload of :attr:`self.__header__ <Protocol.__header__>`.
+        """Get payload from :attr:`self.__header__ <Protocol.__header__>`.
 
         Returns:
             Payload of :attr:`self.__header__ <Protocol.__header__>` as :obj:`bytes`.
 
         See Also:
-            This is a wrapper function for :meth:`pcapkit.protocols.schema.Schema.get_payload`.
+            This is a wrapper function for :meth:`pcapkit.protocols.schema.schema.Schema.get_payload`.
 
         """
         return self.__header__.get_payload()
@@ -883,7 +884,7 @@ class ProtocolBase(Generic[PT, ST], metaclass=ProtocolMeta):
         * If ``discard`` is set as :data:`True`, returns the packet body (in
           :obj:`bytes`) only.
         * Otherwise, returns the header and payload data as
-          :class:`~pcapkit.protocols.data.protocol.Data_Packet` object.
+          :class:`~pcapkit.protocols.data.protocol.Packet` object.
 
         """
         if header is not None:
@@ -1089,7 +1090,7 @@ class ProtocolBase(Generic[PT, ST], metaclass=ProtocolMeta):
             dict\_: info buffer
             proto: next layer protocol index
             length: valid (*non-padding*) length
-            packet: packet info (passed from :meth:`unpack`)
+            packet: packet info (passed from :meth:`self.unpack <Protocol.unpack>`)
 
         Returns:
             Current protocol with next layer extracted.
@@ -1126,7 +1127,7 @@ class ProtocolBase(Generic[PT, ST], metaclass=ProtocolMeta):
         Arguments:
             proto: next layer protocol index
             length: valid (*non-padding*) length
-            packet: packet info (passed from :meth:`unpack`)
+            packet: packet info (passed from :meth:`self.unpack <Protocol.unpack>`)
 
         Returns:
             Instance of next layer.