pypcapkit 1.3.3.post1__cp313-none-any.whl

pcapkit/vendor/ipv6/option.py

@@ -0,0 +1,104 @@
+# -*- coding: utf-8 -*-
+"""Destination Options and Hop-by-Hop Options
+================================================
+
+.. module:: pcapkit.vendor.ipv6.option
+
+This module contains the vendor crawler for **Destination Options and Hop-by-Hop Options**,
+which is automatically generating :class:`pcapkit.const.ipv6.option.Option`.
+
+"""
+
+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
+
+__all__ = ['Option']
+
+
+class Option(Vendor):
+    """Destination Options and Hop-by-Hop Options"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0x00 <= value <= 0xFF'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/ipv6-parameters/ipv6-parameters-2.csv'
+
+    def count(self, data: 'list[str]') -> 'Counter[str]':
+        """Count field records.
+
+        Args:
+            data: Registry data.
+
+        Returns:
+            Field recordings.
+
+        """
+        reader = csv.reader(data)
+        next(reader)  # header
+        return collections.Counter(map(lambda item: self.safe_name(item[4]), 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 = [
+            "return extend_enum(cls, 'Unassigned_0x%s' % hex(value)[2:].upper().zfill(2), value)",
+        ]
+        for item in reader:
+            if not item[0]:
+                continue
+
+            code = item[0]
+            dscp = item[4]
+            rfcs = item[5]
+
+            temp = []  # type: list[str]
+            for rfc in filter(None, re.split(r'\[|\]', rfcs)):
+                if re.match(r'\d+', rfc):
+                    continue
+                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('_', ' '))
+            tmp1 = f" {''.join(temp)}" if rfcs else ''
+
+            splt = re.split(r' \[\d+\]', dscp)[0]
+            name = re.sub(r'.* \((.*)\)', r'\1', splt)
+            if re.fullmatch(r'[0-9a-zA-Z]+', name) is None or name.upper() == 'DEPRECATED':
+                name = re.sub(r'(.*) \(.*\)', r'\1', splt)
+
+            desc = self.wrap_comment(re.sub(r'\r*\n', ' ', f'{splt}{tmp1}', re.MULTILINE))
+            renm = self.rename(name or 'Unassigned', code, original=dscp)
+
+            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}')
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(Option())  # type: ignore[arg-type]

pcapkit/vendor/ipv6/option_action.py

@@ -0,0 +1,90 @@
+# -*- coding: utf-8 -*-
+"""Option Actions
+====================
+
+.. module:: pcapkit.vendor.ipv6.option_action
+
+This module contains the vendor crawler for **Option Actions**,
+which is automatically generating :class:`pcapkit.const.ipv6.option_action.OptionAction`.
+
+"""
+
+import collections
+import sys
+from typing import TYPE_CHECKING
+
+from pcapkit.vendor.default import Vendor
+
+if TYPE_CHECKING:
+    from collections import Counter
+
+__all__ = ['OptionAction']
+
+#: Unknown option action [:rfc:`8200#section-4.2`].
+DATA = {
+    # skip over this option and continue processing the header.
+    0b00: 'skip',
+    # discard the packet.
+    0b01: 'discard',
+    # discard the packet and, regardless of whether or not the
+    # packet's Destination Address was a multicast address, send an
+    # ICMP Parameter Problem, Code 2, message to the packet's
+    # Source Address, pointing to the unrecognized Option Type.
+    0b10: 'discard_icmp_any',
+    # discard the packet and, only if the packet's Destination
+    # Address was not a multicast address, send an ICMP Parameter
+    # Problem, Code 2, message to the packet's Source Address,
+    # pointing to the unrecognized Option Type.
+    0b11: 'discard_icmp_unicast',
+}  # type: dict[int, str]
+
+
+class OptionAction(Vendor):
+    """Option Actions"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 3'
+
+    def request(self) -> 'dict[int, str]':  # type: ignore[override] # pylint: disable=arguments-differ
+        """Fetch registry data.
+
+        Returns:
+            Registry data (:data:`~pcapkit.vendor.ipv6.option_action.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(OptionAction())  # type: ignore[arg-type]

pcapkit/vendor/ipv6/qs_function.py

@@ -0,0 +1,78 @@
+# -*- coding: utf-8 -*-
+"""QS Functions
+==================
+
+.. module:: pcapkit.vendor.ipv6.qs_function
+
+This module contains the vendor crawler for **QS Functions**,
+which is automatically generating :class:`pcapkit.const.ipv6.qs_function.QSFunction`.
+
+"""
+
+import collections
+import sys
+from typing import TYPE_CHECKING
+
+from pcapkit.vendor.default import Vendor
+
+if TYPE_CHECKING:
+    from collections import Counter
+
+__all__ = ['QSFunction']
+
+#: QS function registry.
+DATA = {
+    0: 'Quick-Start Request',
+    8: 'Report of Approved Rate',
+}  # type: dict[int, str]
+
+
+class QSFunction(Vendor):
+    """QS Functions"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 8'
+
+    def request(self) -> 'dict[int, str]':  # type: ignore[override] # pylint: disable=arguments-differ
+        """Fetch registry data.
+
+        Returns:
+            Registry data (:data:`~pcapkit.vendor.ipv6.qs_function.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(QSFunction())  # type: ignore[arg-type]

pcapkit/vendor/ipv6/router_alert.py

@@ -0,0 +1,93 @@
+# -*- coding: utf-8 -*-
+"""IPv6 Router Alert Option Values
+=====================================
+
+.. module:: pcapkit.vendor.ipv6.router_alert
+
+This module contains the vendor crawler for **IPv6 Router Alert Option Values**,
+which is automatically generating :class:`pcapkit.const.ipv6.router_alert.RouterAlert`.
+
+"""
+
+import csv
+import re
+import sys
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['RouterAlert']
+
+
+class RouterAlert(Vendor):
+    """IPv6 Router Alert Option Values"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 65535'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/ipv6-routeralert-values/ipv6-routeralert-values-1.csv'
+
+    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:
+            name = item[1]
+            rfcs = item[2]
+
+            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('_', ' '))
+            desc = self.wrap_comment(re.sub(r'\r*\n', ' ', '%s %s' % (  # pylint: disable=consider-using-f-string
+                name, ''.join(temp) if rfcs else '',
+            ), re.MULTILINE))
+
+            try:
+                code, _ = item[0], int(item[0])
+                renm = self.rename(name, code)
+
+                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 = map(int, item[0].split('-'))
+
+                if 'Level' in name:
+                    base = name.rstrip('s 0-31')
+                    for tmp_code in range(start, stop+1):
+                        renm = self.safe_name(f'{base}_{tmp_code-start}')
+                        pres = f"{renm} = {tmp_code}"
+
+                        #if len(pres) > 74:
+                        #    sufs = f"\n{' '*80}{sufs}"
+
+                        #enum.append(f'{pres.ljust(76)}{sufs}')
+                        enum.append(f'#: {desc}\n    {pres}')
+                else:
+                    miss.append(f'if {start} <= value <= {stop}:')
+                    miss.append(f'    #: {desc}')
+                    miss.append(f"    return extend_enum(cls, '{name}_%d' % value, value)")
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(RouterAlert())  # type: ignore[arg-type]

pcapkit/vendor/ipv6/routing.py

@@ -0,0 +1,87 @@
+# -*- coding: utf-8 -*-
+"""IPv6 Routing Types
+========================
+
+.. module:: pcapkit.vendor.ipv6.routing
+
+This module contains the vendor crawler for **IPv6 Routing Types**,
+which is automatically generating :class:`pcapkit.const.ipv6.routing.Routing`.
+
+"""
+
+import csv
+import re
+import sys
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['Routing']
+
+
+class Routing(Vendor):
+    """IPv6 Routing Types"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 255'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/ipv6-parameters/ipv6-parameters-3.csv'
+
+    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:
+            long = item[1]
+            rfcs = item[2]
+
+            split = long.split(' (')
+            if len(split) == 2:
+                name = re.sub(r'\[\d+\]', '', split[0]).strip()
+                cmmt = f' ({split[1][:-1]})'
+            else:
+                name, cmmt = re.sub(r'\[\d+\]', '', long).strip(), ''
+
+            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 = f" {''.join(temp)}" if rfcs else ''
+            desc = self.wrap_comment(f'{name}{cmmt}{lrfc}')
+
+            try:
+                code = int(item[0])
+                renm = self.rename(name, code)  # type: ignore[arg-type]
+
+                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, '{name}_%d' % value, value)")
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(Routing())  # type: ignore[arg-type]

pcapkit/vendor/ipv6/seed_id.py

@@ -0,0 +1,81 @@
+# -*- coding: utf-8 -*-
+"""Seed-ID Types
+===================
+
+.. module:: pcapkit.vendor.ipv6.seed_id
+
+This module contains the vendor crawler for **Seed-ID Types**,
+which is automatically generating :class:`pcapkit.const.ipv6.seed_id.SeedID`.
+
+"""
+
+import collections
+import sys
+from typing import TYPE_CHECKING
+
+from pcapkit.vendor.default import Vendor
+
+if TYPE_CHECKING:
+    from collections import Counter
+
+__all__ = ['SeedID']
+
+#: Seed-ID type registry [:rfc:`7731`].
+DATA = {
+    0b00: 'IPv6 Source Address',                   # [RFC 7731]
+    0b01: '16-Bit Unsigned Integer',               # [RFC 7731]
+    0b10: '64-Bit Unsigned Integer',               # [RFC 7731]
+    0b11: '128-Bit Unsigned Integer',              # [RFC 7731]
+}  # type: dict[int, str]
+
+
+class SeedID(Vendor):
+    """Seed-ID Types"""
+
+    #: 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 (:attr:`~pcapkit.vendor.ipv6.seed_id.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_0b%s' % bin(value)[2:].zfill(2), value)",
+        ]
+        for code, name in data.items():
+            bncd = f'0b{bin(code)[2:].zfill(2)}'
+            renm = self.rename(name, bncd).upper()
+            enum.append(f"{renm} = {bncd}".ljust(76))
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(SeedID())  # type: ignore[arg-type]

pcapkit/vendor/ipv6/smf_dpd_mode.py

@@ -0,0 +1,78 @@
+# -*- coding: utf-8 -*-
+"""Simplified Multicast Forwarding Duplicate Packet Detection (``SMF_DPD``) Options
+======================================================================================
+
+.. module:: pcapkit.vendor.ipv6.smf_dpd_mode
+
+This module contains the vendor crawler for **Simplified Multicast Forwarding Duplicate Packet Detection (``SMF_DPD``) Options**,
+which is automatically generating :class:`pcapkit.const.ipv6.smf_dpd_mode.SMFDPDMode`.
+
+"""
+
+import collections
+import sys
+from typing import TYPE_CHECKING
+
+from pcapkit.vendor.default import Vendor
+
+if TYPE_CHECKING:
+    from collections import Counter
+
+__all__ = ['SMFDPDMode']
+
+#: ``SMF_DPD`` mode registry.
+DATA = {
+    0:  'I-DPD',
+    1:  'H-DPD',
+}  # type: dict[int, str]
+
+
+class SMFDPDMode(Vendor):
+    """Simplified Multicast Forwarding Duplicate Packet Detection (``SMF_DPD``) Options"""
+
+    #: 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.ipv6.smf_dpd_mode.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(SMFDPDMode())  # type: ignore[arg-type]

pcapkit/vendor/ipv6/tagger_id.py

@@ -0,0 +1,81 @@
+# -*- coding: utf-8 -*-
+"""TaggerID Types
+====================
+
+.. module:: pcapkit.vendor.ipv6.tagger_id
+
+This module contains the vendor crawler for **TaggerID Types**,
+which is automatically generating :class:`pcapkit.const.ipv6.tagger_id.TaggerID`.
+
+"""
+
+import csv
+import re
+import sys
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['TaggerID']
+
+
+class TaggerID(Vendor):
+    """TaggerID Types"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 7'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/ipv6-parameters/taggerId-types.csv'
+
+    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:
+            name = item[1] or item[2]
+            rfcs = item[3]
+
+            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('_', ' '))
+            desc = self.wrap_comment(re.sub(r'\r*\n', ' ', '%s %s' % (  # pylint: disable=consider-using-f-string
+                name, ''.join(temp) if rfcs else '',
+            ), re.MULTILINE))
+
+            try:
+                code, _ = item[0], int(item[0])
+                renm = self.rename(name, code)
+
+                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, '{name}_%d' % value, value)")
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(TaggerID())  # type: ignore[arg-type]