pre-finalise schema to save runtime

Author: JarryShaw

docs/source/pcapkit/protocols/index.rst

@@ -47,6 +47,8 @@ Header Schema
    .. autoattribute:: __excluded__
       :no-value:
 
+.. autodecorator:: pcapkit.protocols.schema.schema.schema_final
+
 Data Model
 ----------
 

pcapkit/corekit/fields/collections.py

@@ -240,9 +240,9 @@ def unpack(self, buffer: 'bytes | IO[bytes]', packet: 'dict[str, Any]') -> 'list
 
         Important:
             If the option list ended before the specified size limit,
-            set :attr:`self.option_padding <OptionField.option_padding>` as the remaining length to
-            the ``packet`` argument such that the next fields can be
-            aware of such informations.
+            set :attr:`self.option_padding <OptionField.option_padding>`
+            as the remaining length to the ``packet`` argument such that
+            the next fields can be aware of such informations.
 
         """
         length = self._length

pcapkit/protocols/schema/application/ftp.py

@@ -5,11 +5,12 @@
 from typing import TYPE_CHECKING
 
 from pcapkit.corekit.fields.strings import BytesField
-from pcapkit.protocols.schema.schema import Schema
+from pcapkit.protocols.schema.schema import Schema, schema_final
 
 __all__ = ['FTP']
 
 
+@schema_final
 class FTP(Schema):
     """Header schema for FTP packet."""
 

pcapkit/protocols/schema/application/httpv1.py

@@ -5,11 +5,12 @@
 from typing import TYPE_CHECKING
 
 from pcapkit.corekit.fields.strings import BytesField
-from pcapkit.protocols.schema.schema import Schema
+from pcapkit.protocols.schema.schema import Schema, schema_final
 
 __all__ = ['HTTP']
 
 
+@schema_final
 class HTTP(Schema):
     """Header schema for HTTP/1.\* packet."""
 

pcapkit/protocols/schema/application/httpv2.py

@@ -12,7 +12,7 @@
 from pcapkit.corekit.fields.misc import ConditionalField, SchemaField, SwitchField
 from pcapkit.corekit.fields.numbers import EnumField, NumberField, UInt8Field, UInt32Field
 from pcapkit.corekit.fields.strings import BitField, BytesField, PaddingField
-from pcapkit.protocols.schema.schema import Schema
+from pcapkit.protocols.schema.schema import Schema, schema_final
 from pcapkit.utilities.logging import SPHINX_TYPE_CHECKING
 
 __all__ = [
@@ -101,6 +101,7 @@ def http_frame_selector(pkt: 'dict[str, Any]') -> 'Field':
     return SchemaField(length=pkt['__length__'], schema=UnassignedFrame)
 
 
+@schema_final
 class HTTP(Schema):
     """Header schema for HTTP/2 packet."""
 
@@ -163,6 +164,7 @@ def post_process(self, packet: 'dict[str, Any]') -> 'Schema':
         return self
 
 
+@schema_final
 class UnassignedFrame(FrameType):
     """Header schema for unassigned HTTP/2 frame payload."""
 
@@ -173,6 +175,7 @@ class UnassignedFrame(FrameType):
         def __init__(self, data: 'bytes') -> 'None': ...
 
 
+@schema_final
 class DataFrame(FrameType):
     """Header schema for HTTP/2 ``DATA`` frames."""
 
@@ -199,6 +202,7 @@ class Flags(FrameType.Flags):
         def __init__(self, pad_len: 'Optional[int]', data: 'bytes') -> 'None': ...
 
 
+@schema_final
 class HeadersFrame(FrameType):
     """Header schema for HTTP/2 ``HEADERS`` frames."""
 
@@ -242,6 +246,7 @@ class Flags(FrameType.Flags):
         def __init__(self, pad_len: 'Optional[int]', stream_dep: 'Optional[StreamDependency]', weight: 'Optional[int]', fragment: 'bytes') -> 'None': ...
 
 
+@schema_final
 class PriorityFrame(FrameType):
     """Header schema for HTTP/2 ``PRIORITY`` frames."""
 
@@ -257,6 +262,7 @@ class PriorityFrame(FrameType):
         def __init__(self, stream: 'StreamDependency', weight: 'int') -> 'None': ...
 
 
+@schema_final
 class RSTStreamFrame(FrameType):
     """Header schema for HTTP/2 ``RST_STREAM`` frames."""
 
@@ -267,6 +273,7 @@ class RSTStreamFrame(FrameType):
         def __init__(self, error: 'Enum_ErrorCode') -> 'None': ...
 
 
+@schema_final
 class SettingPair(Schema):
     """Header schema for HTTP/2 ``SETTINGS`` frame setting pairs."""
 
@@ -279,6 +286,7 @@ class SettingPair(Schema):
         def __init__(self, id: 'Enum_Setting', value: 'int') -> 'None': ...
 
 
+@schema_final
 class SettingsFrame(FrameType):
     """Header schema for HTTP/2 ``SETTINGS`` frames."""
 
@@ -297,6 +305,7 @@ class Flags(FrameType.Flags):
         def __init__(self, settings: 'list[SettingPair] | bytes') -> 'None': ...
 
 
+@schema_final
 class PushPromiseFrame(FrameType):
     """Header schema for HTTP/2 ``PUSH_PROMISE`` frames."""
 
@@ -329,6 +338,7 @@ class Flags(FrameType.Flags):
         def __init__(self, pad_len: 'Optional[int]', stream: 'StreamID', fragment: 'bytes') -> 'None': ...
 
 
+@schema_final
 class PingFrame(FrameType):
     """Header schema for HTTP/2 ``PING`` frames."""
 
@@ -344,6 +354,7 @@ class Flags(FrameType.Flags):
         def __init__(self, data: 'bytes') -> 'None': ...
 
 
+@schema_final
 class GoawayFrame(FrameType):
     """Header schema for HTTP/2 ``GOAWAY`` frames."""
 
@@ -360,6 +371,7 @@ class GoawayFrame(FrameType):
         def __init__(self, stream: 'StreamID', error: 'Enum_ErrorCode', debug: 'bytes') -> 'None': ...
 
 
+@schema_final
 class WindowUpdateFrame(FrameType):
     """Header schema for HTTP/2 ``WINDOW_UPDATE`` frames."""
 
@@ -372,6 +384,7 @@ class WindowUpdateFrame(FrameType):
         def __init__(self, size: 'WindowSize') -> 'None': ...
 
 
+@schema_final
 class ContinuationFrame(FrameType):
     """Header schema for HTTP/2 ``CONTINUATION`` frames."""
 

pcapkit/protocols/schema/internet/ah.py

@@ -8,14 +8,15 @@
 from pcapkit.corekit.fields.misc import PayloadField
 from pcapkit.corekit.fields.numbers import EnumField, UInt8Field, UInt32Field
 from pcapkit.corekit.fields.strings import BytesField, PaddingField
-from pcapkit.protocols.schema.schema import Schema
+from pcapkit.protocols.schema.schema import Schema, schema_final
 
 __all__ = ['AH']
 
 if TYPE_CHECKING:
     from pcapkit.protocols.protocol import Protocol
 
 
+@schema_final
 class AH(Schema):
     """Header schema for AH packet."""