pypcapkit 1.3.3.post1__cp313-none-any.whl

pcapkit/vendor/ipv4/tos_ecn.py

@@ -0,0 +1,95 @@
+# -*- coding: utf-8 -*-
+"""ToS ECN Field
+===================
+
+.. module:: pcapkit.vendor.ipv4.tos_ecn
+
+This module contains the vendor crawler for **ToS ECN Field**,
+which is automatically generating :class:`pcapkit.const.ipv4.tos_ecn.ToSECN`.
+
+"""
+
+import collections
+import sys
+from typing import TYPE_CHECKING
+
+from pcapkit.vendor.default import Vendor
+
+if TYPE_CHECKING:
+    from collections import Counter
+
+__all__ = ['ToSECN']
+
+#: ToS registry.
+DATA = {
+    0b00: 'Not-ECT',
+    0b01: 'ECT(1)',
+    0b10: 'ECT(0)',
+    0b11: 'CE',
+}  # type: dict[int, str]
+
+
+class ToSECN(Vendor):
+    """ToS ECN Field"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0b00 <= value <= 0b11'
+
+    def request(self) -> 'dict[int, str]':  # type: ignore[override] # pylint: disable=arguments-differ
+        """Fetch registry data.
+
+        Returns:
+            Registry data (:data:`~pcapkit.vendor.ipv4.tos_ecn.DATA`).
+
+        """
+        return DATA
+
+    def count(self, data: 'dict[int, str]') -> 'Counter[str]':  # type: ignore[override]
+        """Count field records.
+
+        Args:
+            data: Registry data.
+
+        Returns:
+            Field recordings.
+
+        """
+        return collections.Counter(map(self.safe_name, data.values()))
+
+    def rename(self, name: 'str', code: 'int') -> 'str':  # type: ignore[override] # pylint: disable=arguments-differ
+        """Rename duplicated fields.
+
+        Args:
+            name: Field name.
+            code: Field code.
+
+        Returns:
+            Revised field name.
+
+        """
+        if self.record[self.safe_name(name)] > 1 or self.safe_name(name).upper() in ['UNASSIGNED', 'RESERVED']:
+            name = f'{name} [0b{bin(code)[2:].zfill(2)}]'
+        return self.safe_name(name)
+
+    def process(self, data: 'dict[int, str]') -> 'tuple[list[str], list[str]]':  # type: ignore[override]
+        """Process registry data.
+
+        Args:
+            data: Registry data.
+
+        Returns:
+            Enumeration fields and missing fields.
+
+        """
+        enum = []  # type: list[str]
+        miss = [
+            "return extend_enum(cls, 'Unassigned_0b%s' % bin(value)[2:].zfill(2), value)",
+        ]
+        for code, name in DATA.items():
+            renm = self.rename(name, code)
+            enum.append(f"{renm} = 0b{bin(code)[2:].zfill(2)}".ljust(76))
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(ToSECN())  # type: ignore[arg-type]

pcapkit/vendor/ipv4/tos_pre.py

@@ -0,0 +1,84 @@
+# -*- coding: utf-8 -*-
+"""ToS (DS Field) Precedence
+===============================
+
+.. module:: pcapkit.vendor.ipv4.tos_pre
+
+This module contains the vendor crawler for **ToS (DS Field) Precedence**,
+which is automatically generating :class:`pcapkit.const.ipv4.tos_pre.ToSPrecedence`.
+
+"""
+
+import collections
+import sys
+from typing import TYPE_CHECKING
+
+from pcapkit.vendor.default import Vendor
+
+if TYPE_CHECKING:
+    from collections import Counter
+
+__all__ = ['ToSPrecedence']
+
+#: ToS registry.
+DATA = {
+    0b111: 'Network Control',
+    0b110: 'Internetwork Control',
+    0b101: 'CRITIC/ECP',
+    0b100: 'Flash Override',
+    0b011: 'Flash',
+    0b010: 'Immediate',
+    0b001: 'Priority',
+    0b000: 'Routine',
+}  # type: dict[int, str]
+
+
+class ToSPrecedence(Vendor):
+    """ToS (DS Field) Precedence"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0b000 <= value <= 0b111'
+
+    def request(self) -> 'dict[int, str]':  # type: ignore[override] # pylint: disable=arguments-differ
+        """Fetch registry data.
+
+        Returns:
+            Registry data (:data:`~pcapkit.vendor.ipv4.tos_pre.DATA`).
+
+        """
+        return DATA
+
+    def count(self, data: 'dict[int, str]') -> 'Counter[str]':  # type: ignore[override]
+        """Count field records.
+
+        Args:
+            data: Registry data.
+
+        Returns:
+            Field recordings.
+
+        """
+        return collections.Counter(map(self.safe_name, data.values()))
+
+    def process(self, data: 'dict[int, str]') -> 'tuple[list[str], list[str]]':  # type: ignore[override]
+        """Process registry data.
+
+        Args:
+            data: Registry data.
+
+        Returns:
+            Enumeration fields and missing fields.
+
+        """
+        enum = []  # type: list[str]
+        miss = [
+            "return extend_enum(cls, 'Unassigned_%d' % value, value)",
+        ]
+        for code, name in DATA.items():
+            renm = self.rename(name, code)  # type: ignore[arg-type]
+            enum.append(f"{renm} = {code}".ljust(76))
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(ToSPrecedence())  # type: ignore[arg-type]

pcapkit/vendor/ipv4/tos_rel.py

@@ -0,0 +1,78 @@
+# -*- coding: utf-8 -*-
+"""ToS (DS Field) Reliability
+================================
+
+.. module:: pcapkit.vendor.ipv4.tos_rel
+
+This module contains the vendor crawler for **ToS (DS Field) Reliability**,
+which is automatically generating :class:`pcapkit.const.ipv4.tos_rel.ToSReliability`.
+
+"""
+
+import collections
+import sys
+from typing import TYPE_CHECKING
+
+from pcapkit.vendor.default import Vendor
+
+if TYPE_CHECKING:
+    from collections import Counter
+
+__all__ = ['ToSReliability']
+
+#: ToS registry.
+DATA = {
+    0: 'Normal',
+    1: 'High',
+}  # type: dict[int, str]
+
+
+class ToSReliability(Vendor):
+    """ToS (DS Field) Reliability"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 1'
+
+    def request(self) -> 'dict[int, str]':  # type: ignore[override] # pylint: disable=arguments-differ
+        """Fetch registry data.
+
+        Returns:
+            Registry data (:data:`~pcapkit.vendor.ipv4.tos_rel.DATA`).
+
+        """
+        return DATA
+
+    def count(self, data: 'dict[int, str]') -> 'Counter[str]':  # type: ignore[override]
+        """Count field records.
+
+        Args:
+            data: Registry data.
+
+        Returns:
+            Field recordings.
+
+        """
+        return collections.Counter(map(self.safe_name, data.values()))
+
+    def process(self, data: 'dict[int, str]') -> 'tuple[list[str], list[str]]':  # type: ignore[override]
+        """Process registry data.
+
+        Args:
+            data: Registry data.
+
+        Returns:
+            Enumeration fields and missing fields.
+
+        """
+        enum = []  # type: list[str]
+        miss = [
+            "return extend_enum(cls, 'Unassigned_%d' % value, value)",
+        ]
+        for code, name in DATA.items():
+            renm = self.rename(name, code).upper()  # type: ignore[arg-type]
+            enum.append(f"{renm} = {code}".ljust(76))
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(ToSReliability())  # type: ignore[arg-type]

pcapkit/vendor/ipv4/tos_thr.py

@@ -0,0 +1,77 @@
+# -*- coding: utf-8 -*-
+"""ToS (DS Field) Throughput
+===============================
+
+.. module:: pcapkit.vendor.ipv4.tos_thr
+
+This module contains the vendor crawler for **ToS (DS Field) Throughput**,
+which is automatically generating :class:`pcapkit.const.ipv4.tos_thr.ToSThroughput`.
+
+"""
+
+import collections
+import sys
+from typing import TYPE_CHECKING
+
+from pcapkit.vendor.default import Vendor
+
+if TYPE_CHECKING:
+    from collections import Counter
+
+__all__ = ['ToSThroughput']
+
+#: ToS registry.
+DATA = {
+    0: 'Normal',
+    1: 'High',
+}  # type: dict[int, str]
+
+
+class ToSThroughput(Vendor):
+    """ToS (DS Field) Throughput"""
+
+    FLAG = 'isinstance(value, int) and 0 <= value <= 1'
+
+    def request(self) -> 'dict[int, str]':  # type: ignore[override] # pylint: disable=arguments-differ
+        """Fetch registry data.
+
+        Returns:
+            Registry data (:data:`~pcapkit.vendor.ipv4.tos_thr.DATA`).
+
+        """
+        return DATA
+
+    def count(self, data: 'dict[int, str]') -> 'Counter[str]':  # type: ignore[override]
+        """Count field records.
+
+        Args:
+            data: Registry data.
+
+        Returns:
+            Field recordings.
+
+        """
+        return collections.Counter(map(self.safe_name, data.values()))
+
+    def process(self, data: 'dict[int, str]') -> 'tuple[list[str], list[str]]':  # type: ignore[override]
+        """Process registry data.
+
+        Args:
+            data: Registry data.
+
+        Returns:
+            Enumeration fields and missing fields.
+
+        """
+        enum = []  # type: list[str]
+        miss = [
+            "return extend_enum(cls, 'Unassigned_%d' % value, value)",
+        ]
+        for code, name in DATA.items():
+            renm = self.rename(name, code).upper()  # type: ignore[arg-type]
+            enum.append(f"{renm} = {code}".ljust(76))
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(ToSThroughput())  # type: ignore[arg-type]

pcapkit/vendor/ipv4/ts_flag.py

@@ -0,0 +1,79 @@
+# -*- coding: utf-8 -*-
+"""TS Flag
+=============
+
+.. module:: pcapkit.vendor.ipv4.ts_flag
+
+This module contains the vendor crawler for **TS Flag**,
+which is automatically generating :class:`pcapkit.const.ipv4.ts_flag.TSFlag`.
+
+"""
+
+import collections
+import sys
+from typing import TYPE_CHECKING
+
+from pcapkit.vendor.default import Vendor
+
+if TYPE_CHECKING:
+    from collections import Counter
+
+__all__ = ['TSFlag']
+
+#: TS flag registry [:rfc:`719#section-3.1`].
+DATA = {
+    0: 'Timestamp Only',
+    1: 'IP with Timestamp',
+    3: 'Prespecified IP with Timestamp',
+}  # type: dict[int, str]
+
+
+class TSFlag(Vendor):
+    """TS Flag"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0b0000 <= value <= 0b1111'
+
+    def request(self) -> 'dict[int, str]':  # type: ignore[override] # pylint: disable=arguments-differ
+        """Fetch registry data.
+
+        Returns:
+            Registry data (:data:`~pcapkit.vendor.ipv4.tos_pre.DATA`).
+
+        """
+        return DATA
+
+    def count(self, data: 'dict[int, str]') -> 'Counter[str]':  # type: ignore[override]
+        """Count field records.
+
+        Args:
+            data: Registry data.
+
+        Returns:
+            Field recordings.
+
+        """
+        return collections.Counter(map(self.safe_name, data.values()))
+
+    def process(self, data: 'dict[int, str]') -> 'tuple[list[str], list[str]]':  # type: ignore[override]
+        """Process registry data.
+
+        Args:
+            data: Registry data.
+
+        Returns:
+            Enumeration fields and missing fields.
+
+        """
+        enum = []  # type: list[str]
+        miss = [
+            "return extend_enum(cls, 'Unassigned_%d' % value, value)",
+        ]
+        for code, name in DATA.items():
+            renm = self.rename(name, code)  # type: ignore[arg-type]
+            enum.append(f"{renm} = {code}".ljust(76))
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(TSFlag())  # type: ignore[arg-type]

pcapkit/vendor/ipv6/__init__.py

@@ -0,0 +1,53 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=unused-import
+""":class:`~pcapkit.protocols.internet.ipv6.IPv6` Vendor Crawlers
+====================================================================
+
+.. module:: pcapkit.vendor.ipv6
+
+This module contains all vendor crawlers of
+:class:`~pcapkit.protocols.internet.ipv6.IPv6` implementations. Available
+crawlers include:
+
+.. list-table::
+
+   * - :class:`IPv6_Extension_Header <pcapkit.vendor.ipv6.extension_header.ExtensionHeader>`
+     - IPv6 Extension Header Types [*]_
+   * - :class:`IPv6_Option <pcapkit.vendor.ipv6.option.Option>`
+     - Destination Options and Hop-by-Hop Options [*]_
+   * - :class:`IPv6_OptionAction <pcapkit.vendor.ipv6.option_action.OptionAction>`
+     - Option Actions [*]_
+   * - :class:`IPv6_QSFunction <pcapkit.vendor.ipv6.qs_function.QSFunction>`
+     - IPv6 QS Functions
+   * - :class:`IPv6_RouterAlert <pcapkit.vendor.ipv6.router_alert.RouterAlert>`
+     - IPv6 Router Alert Option Values [*]_
+   * - :class:`IPv6_Routing <pcapkit.vendor.ipv6.routing.Routing>`
+     - Routing Types [*]_
+   * - :class:`IPv6_SeedID <pcapkit.vendor.ipv6.seed_id.SeedID>`
+     - Seed-ID Types
+   * - :class:`IPv6_SMFDPDMode <pcapkit.vendor.ipv6.smf_dpd_mode.SMFDPDMode>`
+     - Simplified Multicast Forwarding Duplicate Packet Detection (``SMF_DPD``) Options
+   * - :class:`IPv6_TaggerID <pcapkit.vendor.ipv6.tagger_id.TaggerID>`
+     - Tagger-ID Types [*]_
+
+.. [*] https://www.iana.org/assignments/ipv6-parameters/ipv6-parameters.xhtml#extension-header
+.. [*] https://www.iana.org/assignments/ipv6-parameters/ipv6-parameters.xhtml#ipv6-parameters-2
+.. [*] https://www.rfc-editor.org/rfc/rfc8200#section-4.2
+.. [*] https://www.iana.org/assignments/ipv6-routeralert-values/ipv6-routeralert-values.xhtml#ipv6-routeralert-values-1
+.. [*] https://www.iana.org/assignments/ipv6-parameters/ipv6-parameters.xhtml#ipv6-parameters-3
+.. [*] https://www.iana.org/assignments/ipv6-parameters/ipv6-parameters.xhtml#taggerId-types
+
+"""
+
+from pcapkit.vendor.ipv6.extension_header import ExtensionHeader as IPv6_ExtensionHeader
+from pcapkit.vendor.ipv6.option import Option as IPv6_Option
+from pcapkit.vendor.ipv6.option_action import OptionAction as IPv6_OptionAction
+from pcapkit.vendor.ipv6.qs_function import QSFunction as IPv6_QSFunction
+from pcapkit.vendor.ipv6.router_alert import RouterAlert as IPv6_RouterAlert
+from pcapkit.vendor.ipv6.routing import Routing as IPv6_Routing
+from pcapkit.vendor.ipv6.seed_id import SeedID as IPv6_SeedID
+from pcapkit.vendor.ipv6.smf_dpd_mode import SMFDPDMode as IPv6_SMFDPDMode
+from pcapkit.vendor.ipv6.tagger_id import TaggerID as IPv6_TaggerID
+
+__all__ = ['IPv6_ExtensionHeader', 'IPv6_Option', 'IPv6_QSFunction', 'IPv6_RouterAlert', 'IPv6_Routing',
+           'IPv6_SeedID', 'IPv6_SMFDPDMode', 'IPv6_TaggerID', 'IPv6_OptionAction']

pcapkit/vendor/ipv6/extension_header.py

@@ -0,0 +1,171 @@
+# -*- coding: utf-8 -*-
+"""IPv6 Extension Header Types
+=================================
+
+.. module:: pcapkit.vendor.ipv6.extension_header
+
+This module contains the vendor crawler for **IPv6 Extension Header Types**,
+which is automatically generating :class:`pcapkit.const.ipv6.extension_header.ExtensionHeader`.
+
+"""
+
+import collections
+import csv
+import re
+import sys
+from typing import TYPE_CHECKING
+
+from pcapkit.vendor.default import Vendor
+
+if TYPE_CHECKING:
+    from collections import Counter
+    from typing import Callable
+
+__all__ = ['ExtensionHeader']
+
+LINE = lambda NAME, DOCS, ENUM, MODL: f'''\
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""{(name := DOCS.split(' [', maxsplit=1)[0])}
+{'=' * (len(name) + 6)}
+
+.. module:: {MODL.replace('vendor', 'const')}
+
+This module contains the constant enumeration for **{name}**,
+which is automatically generated from :class:`{MODL}.{NAME}`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['{NAME}']
+
+
+class {NAME}(IntEnum):
+    """[{NAME}] {DOCS}"""
+
+    {ENUM}
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> '{NAME}':
+        """Backport support for original codes.
+
+        Args:
+            key: Key to get enum item.
+            default: Default value if not found.
+
+        :meta private:
+        """
+        if isinstance(key, int):
+            return {NAME}(key)
+        return {NAME}[key]  # type: ignore[misc]
+'''  # type: Callable[[str, str, str, str], str]
+
+
+class ExtensionHeader(Vendor):
+    """IPv6 Extension Header Types"""
+
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/protocol-numbers/protocol-numbers-1.csv'
+
+    def count(self, data: 'list[str]') -> 'Counter[str]':
+        """Count field records.
+
+        Args:
+            data: CSV data.
+
+        Returns:
+            Field recordings.
+
+        """
+        reader = csv.reader(data)
+        next(reader)  # header
+        return collections.Counter(map(lambda item: self.safe_name(item[1] or item[2]),
+                                       filter(lambda item: len(item[0].split('-')) != 2, reader)))
+
+    def process(self, data: 'list[str]') -> 'tuple[list[str], list[str]]':
+        """Process CSV data.
+
+        Args:
+            data: CSV data.
+
+        Returns:
+            Enumeration fields and missing fields.
+
+        """
+        reader = csv.reader(data)
+        next(reader)  # header
+
+        enum = []  # type: list[str]
+        miss = []  # type: list[str]
+        for item in reader:
+            flag = item[3]
+            if flag != 'Y':
+                continue
+
+            name = item[1]
+            rfcs = item[4]
+
+            temp = []  # type: list[str]
+            for rfc in filter(None, re.split(r'\[|\]', rfcs)):
+                if 'RFC' in rfc and re.match(r'\d+', rfc[3:]):
+                    #temp.append(f'[{rfc[:3]} {rfc[3:]}]')
+                    temp.append(f'[:rfc:`{rfc[3:]}`]')
+                else:
+                    temp.append(f'[{rfc}]'.replace('_', ' '))
+            lrfc = re.sub(r'( )( )*', ' ', f" {''.join(temp)}".replace('\n', ' ')) if rfcs else ''
+
+            subd = re.sub(r'( )( )*', ' ', item[2].replace('\n', ' '))
+            tmp1 = f' {subd}' if item[2] else ''
+
+            split = name.split(' (', 1)
+            if len(split) == 2:
+                name, cmmt = split[0], f" ({split[1]}"
+            else:
+                name, cmmt = name, ''  # pylint: disable=self-assigning-variable
+
+            if name:
+                tmp1 = f',{tmp1}' if tmp1 else ''
+            else:
+                name, tmp1 = item[2], ''
+            desc = self.wrap_comment(f'{name}{tmp1}{lrfc}{cmmt}')
+
+            try:
+                code, _ = item[0], int(item[0])
+                if not name:
+                    name, desc = item[2], ''
+                renm = self.rename(name, code, original=item[1])
+
+                pres = f"{renm} = {code}"
+                sufs = f"#: {desc}"
+
+                #if len(pres) > 74:
+                #    sufs = f"\n{' '*80}{sufs}"
+
+                #enum.append(f'{pres.ljust(76)}{sufs}')
+                enum.append(f'{sufs}\n    {pres}')
+            except ValueError:
+                start, stop = item[0].split('-')
+
+                miss.append(f'if {start} <= value <= {stop}:')
+                miss.append(f'    #: {desc}')
+                miss.append(f"    return extend_enum(cls, '{self.safe_name(name)}_%d' % value, value)")
+        return enum, miss
+
+    def context(self, data: 'list[str]') -> 'str':
+        """Generate constant context.
+
+        Args:
+            data: CSV data.
+
+        Returns:
+            Constant context.
+
+        """
+        enum, _ = self.process(data)
+        ENUM = '\n\n    '.join(map(lambda s: s.rstrip(), enum))
+        return LINE(self.NAME, self.DOCS, ENUM, self.__module__)
+
+
+if __name__ == '__main__':
+    sys.exit(ExtensionHeader())  # type: ignore[arg-type]