revised protocol registries (added schema registration to APIs)

Author: JarryShaw

docs/source/pcapkit/protocols/application/httpv2.rst

@@ -209,6 +209,12 @@ Auxiliary Functions
 
 .. autofunction:: pcapkit.protocols.schema.application.httpv2.http_frame_selector
 
+Miscellaneous Data
+~~~~~~~~~~~~~~~~~~
+
+.. autodata:: pcapkit.protocols.schema.application.httpv2.MAP_HTTP_FRAME
+   :no-value:
+
 Data Models
 -----------
 

docs/source/pcapkit/protocols/internet/ipv6_route.rst

@@ -114,6 +114,12 @@ Auxiliary Functions
 
 .. autofunction:: pcapkit.protocols.schema.internet.ipv6_route.ipv6_route_data_selector
 
+Miscellaneous Data
+~~~~~~~~~~~~~~~~~~
+
+.. autodata:: pcapkit.protocols.schema.internet.ipv6_route.MAP_IPV6_ROUTE_DATA
+   :no-value:
+
 Data Models
 -----------
 

docs/source/pcapkit/protocols/internet/mh.rst

@@ -369,6 +369,50 @@ Header Schemas
    :param \*args: Arbitrary positional arguments.
    :param \*\*kwargs: Arbitrary keyword arguments.
 
+Type Stubs
+~~~~~~~~~~
+
+.. autoclass:: pcapkit.protocols.schema.internet.mh.ANSIKeyLengthTest
+   :members:
+   :show-inheritance:
+
+   :param \*args: Arbitrary positional arguments.
+   :param \*\*kwargs: Arbitrary keyword arguments.
+
+.. autoclass:: pcapkit.protocols.schema.internet.mh.MultiPrefixExtensionFlags
+   :members:
+   :show-inheritance:
+
+   :param \*args: Arbitrary positional arguments.
+   :param \*\*kwargs: Arbitrary keyword arguments.
+
+.. autoclass:: pcapkit.protocols.schema.internet.mh.BindingUpdateMessageFlags
+   :members:
+   :show-inheritance:
+
+   :param \*args: Arbitrary positional arguments.
+   :param \*\*kwargs: Arbitrary keyword arguments.
+
+.. autoclass:: pcapkit.protocols.schema.internet.mh.BindingAcknowledgementMessageFlags
+   :members:
+   :show-inheritance:
+
+   :param \*args: Arbitrary positional arguments.
+   :param \*\*kwargs: Arbitrary keyword arguments.
+
+Auxiliary Functions
+~~~~~~~~~~~~~~~~~~~
+
+.. autofunction:: pcapkit.protocols.schema.internet.mh.mh_opt_registry
+.. autofunction:: pcapkit.protocols.schema.internet.mh.mh_data_selector
+.. autofunction:: pcapkit.protocols.schema.internet.mh.mh_id_selector
+
+Miscellaneous Data
+~~~~~~~~~~~~~~~~~~
+
+.. autodata:: pcapkit.protocols.schema.internet.mh.MAP_MH_DATA
+   :no-value:
+
 Data Models
 -----------
 

docs/source/pcapkit/protocols/misc/pcapng.rst

@@ -737,6 +737,15 @@ Auxiliary Functions
 .. autofunction:: pcapkit.protocols.schema.misc.pcapng.pcapng_block_selector
 .. autofunction:: pcapkit.protocols.schema.misc.pcapng.dsb_secrets_selector
 
+Miscellaneous Data
+~~~~~~~~~~~~~~~~~~
+
+.. autodata:: pcapkit.protocols.schema.misc.pcapng.MAP_PCAPNG_BLOCK
+   :no-value:
+
+.. autodata:: pcapkit.protocols.schema.misc.pcapng.MAP_DSB_SECRETS
+   :no-value:
+
 Data Models
 -----------
 

docs/source/pcapkit/protocols/transport/tcp.rst

@@ -530,6 +530,12 @@ Auxiliary Functions
 .. autofunction:: pcapkit.protocols.schema.transport.tcp.mptcp_data_selector
 .. autofunction:: pcapkit.protocols.schema.transport.tcp.mptcp_add_address_selector
 
+Miscellaneous Data
+~~~~~~~~~~~~~~~~~~
+
+.. autodata:: pcapkit.protocols.schema.transport.tcp.MAP_MPTCP_DATA
+   :no-value:
+
 Data Models
 -----------
 

pcapkit/corekit/fields/collections.py

@@ -3,7 +3,7 @@
 
 import copy
 import io
-from typing import TYPE_CHECKING, TypeVar, cast
+from typing import TYPE_CHECKING, Generic, TypeVar, cast
 
 from pcapkit.corekit.fields.field import _Field
 from pcapkit.corekit.multidict import OrderedMultiDict
@@ -25,9 +25,10 @@
     from pcapkit.protocols.schema.schema import Schema
 
 _TL = TypeVar('_TL', 'Schema', '_Field', 'bytes')
+_TS = TypeVar('_TS', bound='Schema')
 
 
-class ListField(_Field[List[_TL]]):
+class ListField(_Field[List[_TL]], Generic[_TL]):
     """Field list for protocol fields.
 
     Args:
@@ -160,7 +161,7 @@ def unpack(self, buffer: 'bytes | IO[bytes]', packet: 'dict[str, Any]') -> 'byte
         return temp
 
 
-class OptionField(ListField):
+class OptionField(ListField, Generic[_TS]):
     """Field list for protocol options.
 
     Args:
@@ -181,7 +182,7 @@ class OptionField(ListField):
     """
 
     @property
-    def base_schema(self) -> 'Type[Schema]':
+    def base_schema(self) -> 'Type[_TS]':
         """Base schema."""
         return self._base_schema
 
@@ -191,7 +192,7 @@ def type_name(self) -> 'str':
         return self._type_name
 
     @property
-    def registry(self) -> 'defaultdict[int | StdlibEnum | AenumEnum, Type[Schema]]':
+    def registry(self) -> 'defaultdict[int | StdlibEnum | AenumEnum, Type[_TS]]':
         """Option registry."""
         return self._registry
 
@@ -206,9 +207,9 @@ def option_padding(self) -> 'int':
         return self._option_padding
 
     def __init__(self, length: 'int | Callable[[dict[str, Any]], int]' = lambda _: -1,
-                 base_schema: 'Optional[Type[Schema]]' = None,
+                 base_schema: 'Optional[Type[_TS]]' = None,
                  type_name: 'str' = 'type',
-                 registry: 'Optional[defaultdict[int | StdlibEnum | AenumEnum, Type[Schema]]]' = None,
+                 registry: 'Optional[defaultdict[int | StdlibEnum | AenumEnum, Type[_TS]]]' = None,
                  eool: 'Optional[int | StdlibEnum | AenumEnum]' = None,
                  callback: 'Callable[[Self, dict[str, Any]], None]' = lambda *_: None) -> 'None':
         super().__init__(length, None, callback)
@@ -228,7 +229,7 @@ def __init__(self, length: 'int | Callable[[dict[str, Any]], int]' = lambda _: -
             raise FieldValueError('Field <option> has no registry.')
         self._registry = registry
 
-    def unpack(self, buffer: 'bytes | IO[bytes]', packet: 'dict[str, Any]') -> 'list[Schema]':
+    def unpack(self, buffer: 'bytes | IO[bytes]', packet: 'dict[str, Any]') -> 'list[_TS]':
         """Unpack field value from :obj:`bytes`.
 
         Args:
@@ -256,7 +257,7 @@ def unpack(self, buffer: 'bytes | IO[bytes]', packet: 'dict[str, Any]') -> 'list
         new_packet = packet.copy()
         new_packet[self.name] = OrderedMultiDict()
 
-        temp = []  # type: list[Schema]
+        temp = []  # type: list[_TS]
         while length > 0:
             # unpack option type using base schema
             meta = self._base_schema.unpack(file, length, packet)  # type: ignore[call-arg,misc,var-annotated]