pypcapkit 1.3.3.post1__cp313-none-any.whl

pcapkit/vendor/mh/binding_update_flag.py

@@ -0,0 +1,147 @@
+# -*- coding: utf-8 -*-
+"""Binding Update Flags
+==========================
+
+.. module:: pcapkit.vendor.mh.binding_update_flag
+
+This module contains the vendor crawler for **Binding Update Flags**,
+which is automatically generating :class:`pcapkit.const.mh.binding_update_flag.BindingUpdateFlag`.
+
+"""
+
+import csv
+import re
+import sys
+from typing import TYPE_CHECKING
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['BindingUpdateFlag']
+
+if TYPE_CHECKING:
+    from typing import Callable
+
+LINE = lambda NAME, DOCS, FLAG, 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 IntFlag
+
+__all__ = ['{NAME}']
+
+
+class {NAME}(IntFlag):
+    """[{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]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> '{NAME}':
+        """Lookup function used when value is not found.
+
+        Args:
+            value: Value to get enum item.
+
+        """
+        if not ({FLAG}):
+            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
+        return cls(value)
+'''  # type: Callable[[str, str, str, str, str], str]
+
+
+class BindingUpdateFlag(Vendor):
+    """Binding Update Flags"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 0xFFFF'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/mobility-parameters/mobility-parameters-11.csv'
+
+    def process(self, data: 'list[str]') -> 'list[str]':  # type: ignore[override] # pylint: disable=arguments-differ,arguments-renamed
+        """Process CSV data.
+
+        Args:
+            data: CSV data.
+
+        Returns:
+            Enumeration fields and missing fields.
+
+        """
+        reader = csv.reader(data)
+        next(reader)  # header
+
+        enum = []  # type: list[str]
+        for item in reader:
+            long = item[0]
+            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('_', ' '))
+            tmp1 = f" {''.join(temp)}" if rfcs else ''
+
+            split = long.split(' (', 1)
+            if len(split) == 2:
+                name = split[0]
+                cmmt = f" ({split[1]}"
+            else:
+                name, cmmt = long, ''
+            desc = self.wrap_comment(f'{name}{cmmt}{tmp1}')
+
+            code, code_val = item[1], int(item[1], base=16)
+            renm = self.rename(name, code, original=long)
+
+            pres = f"{renm} = 0x{code_val:04x}"
+            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
+
+    def context(self, data: 'list[str]') -> 'str':  # pylint: disable=arguments-differ,arguments-renamed
+        """Generate constant context.
+
+        Args:
+            soup: Parsed HTML source.
+
+        Returns:
+            Constant context.
+
+        """
+        enum = self.process(data)
+        ENUM = '\n\n    '.join(map(lambda s: s.rstrip(), enum))
+        return LINE(self.NAME, self.DOCS, self.FLAG, ENUM, self.__module__)
+
+
+if __name__ == '__main__':
+    sys.exit(BindingUpdateFlag())  # type: ignore[arg-type]

pcapkit/vendor/mh/cga_extension.py

@@ -0,0 +1,91 @@
+# -*- coding: utf-8 -*-
+"""CGA Extension Type Values
+===============================
+
+.. module:: pcapkit.vendor.mh.cga_extension
+
+This module contains the vendor crawler for **CGA Extension Type Values**,
+which is automatically generating :class:`pcapkit.const.mh.cga_extension.CGAExtension`.
+
+"""
+
+import csv
+import re
+import sys
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['CGAExtension']
+
+
+class CGAExtension(Vendor):
+    """CGA Extension Type Values"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 0xFFFF'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/cga-message-types/cga-message-types-2.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]
+
+            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('_', ' '))
+            tmp1 = f" {''.join(temp)}" if rfcs else ''
+
+            split = long.split(' (', 1)
+            if len(split) == 2:
+                name = split[0]
+                cmmt = f" ({split[1]}"
+            else:
+                name, cmmt = long, ''
+            desc = self.wrap_comment(f'{name}{cmmt}{tmp1}')
+
+            try:
+                code, _ = item[0], int(item[0], base=16)
+                renm = self.rename(name, code, original=long)
+
+                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)}_%04x' % value, value)")
+
+        # TODO: figure out how to handle this programmatically
+        miss.append('#: Unspecified in the IANA registry')
+        miss.append("return extend_enum(cls, 'Unassigned_%04x' % value, value)")
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(CGAExtension())  # type: ignore[arg-type]

pcapkit/vendor/mh/cga_sec.py

@@ -0,0 +1,91 @@
+# -*- coding: utf-8 -*-
+"""CGA SEC
+=============
+
+.. module:: pcapkit.vendor.mh.cga_sec
+
+This module contains the vendor crawler for **CGA SEC**,
+which is automatically generating :class:`pcapkit.const.mh.cga_sec.CGASec`.
+
+"""
+
+import csv
+import re
+import sys
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['CGASec']
+
+
+class CGASec(Vendor):
+    """CGA SEC"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 0b111'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/cga-message-types/cga-message-types-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]
+
+            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('_', ' '))
+            tmp1 = f" {''.join(temp)}" if rfcs else ''
+
+            split = long.split(' (', 1)
+            if len(split) == 2:
+                name = split[0]
+                cmmt = f" ({split[1]}"
+            else:
+                name, cmmt = long, ''
+            desc = self.wrap_comment(f'{name}{cmmt}{tmp1}')
+
+            try:
+                code, _ = item[0], int(item[0], base=2)
+                renm = self.rename(name, code, original=long)
+
+                pres = f"{renm} = 0b{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)}_%s' % bin(value)[2:], value)")
+
+        # TODO: figure out how to handle this programmatically
+        miss.append('#: Unspecified in the IANA registry')
+        miss.append("return extend_enum(cls, 'Unassigned_%s' % bin(value)[2:], value)")
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(CGASec())  # type: ignore[arg-type]

pcapkit/vendor/mh/cga_type.py

@@ -0,0 +1,74 @@
+# -*- coding: utf-8 -*-
+"""CGA Extension Type Tags
+=============================
+
+.. module:: pcapkit.vendor.mh.cga_type
+
+This module contains the vendor crawler for **CGA Extension Type Tags**,
+which is automatically generating :class:`pcapkit.const.mh.cga_type.CGAType`.
+
+"""
+
+import csv
+import re
+import sys
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['CGAType']
+
+
+class CGAType(Vendor):
+    """CGA Extension Type Tags"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 0xFFFF_FFFF_FFFF_FFFF_FFFF_FFFF_FFFF_FFFF'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/cga-message-types/cga-message-types-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 = [
+            "return extend_enum(cls, 'Tag_%s' % ('_'.join(__import__('textwrap').wrap('%032x' % value, 4))), value)",
+        ]
+        for item in reader:
+            long = item[0]
+            rfcs = item[1]
+
+            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('_', ' '))
+            tmp1 = f" {''.join(temp)}" if rfcs else ''
+
+            name = 'Tag_%s' % long[2:].replace(' ', '_')
+            desc = self.wrap_comment(f'{long}{tmp1}')
+
+            pres = f"{name} = {long.replace(' ', '_')}"
+            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(CGAType())  # type: ignore[arg-type]

pcapkit/vendor/mh/dhcp_support_mode.py

@@ -0,0 +1,77 @@
+# -*- coding: utf-8 -*-
+"""IPv4 DHCP Support Mode Flags
+==================================
+
+.. module:: pcapkit.vendor.mh.dhcp_support_mode
+
+This module contains the vendor crawler for **IPv4 DHCP Support Mode Flags**,
+which is automatically generating :class:`pcapkit.const.mh.dhcp_support_mode.DHCPSupportMode`.
+
+"""
+
+import csv
+import re
+import sys
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['DHCPSupportMode']
+
+
+class DHCPSupportMode(Vendor):
+    """IPv4 DHCP Support Mode Flags"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 1'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/mobility-parameters/dhcp-support-mode.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 = [
+            "return extend_enum(cls, 'Unassigned_%d' % value, value)",
+        ]
+        for item in reader:
+            long = 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('_', ' '))
+            tmp1 = f" {''.join(temp)}" if rfcs else ''
+
+            name = self.safe_name(re.sub(r'\((.+?)\)', r'\1', long))
+            desc = self.wrap_comment(f'{long}{tmp1}')
+
+            code, code_val = item[0], int(item[0], base=16)
+            renm = self.rename(name, code, original=long)
+
+            pres = f"{renm} = 0x{code_val:01x}"
+            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(DHCPSupportMode())  # type: ignore[arg-type]

pcapkit/vendor/mh/dns_status_code.py

@@ -0,0 +1,87 @@
+# -*- coding: utf-8 -*-
+"""Status Codes (DNS Update Mobility Option)
+===============================================
+
+.. module:: pcapkit.vendor.mh.dns_status_code
+
+This module contains the vendor crawler for **Status Codes (DNS Update Mobility Option)**,
+which is automatically generating :class:`pcapkit.const.mh.dns_status_code.DNSStatusCode`.
+
+"""
+
+import csv
+import re
+import sys
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['DNSStatusCode']
+
+
+class DNSStatusCode(Vendor):
+    """Status Codes (DNS Update Mobility Option)"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 255'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/mobility-parameters/mobility-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]
+
+            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('_', ' '))
+            tmp1 = f" {''.join(temp)}" if rfcs else ''
+
+            split = long.split(' (', 1)
+            if len(split) == 2:
+                name = split[0]
+                cmmt = f" ({split[1]}"
+            else:
+                name, cmmt = long, ''
+            desc = self.wrap_comment(f'{name}{cmmt}{tmp1}')
+
+            try:
+                code, _ = item[0], int(item[0])
+                renm = self.rename(name, code, original=long)
+
+                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
+
+
+if __name__ == '__main__':
+    sys.exit(DNSStatusCode())  # type: ignore[arg-type]

pcapkit/vendor/mh/dsmip6_tls_packet.py

@@ -0,0 +1,87 @@
+# -*- coding: utf-8 -*-
+"""DSMIP6-TLS Packet Types Registry
+======================================
+
+.. module:: pcapkit.vendor.mh.dsmip6_tls_packet
+
+This module contains the vendor crawler for **DSMIP6-TLS Packet Types Registry**,
+which is automatically generating :class:`pcapkit.const.mh.dsmip6_tls_packet.DSMIP6TLSPacket`.
+
+"""
+
+import csv
+import re
+import sys
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['DSMIP6TLSPacket']
+
+
+class DSMIP6TLSPacket(Vendor):
+    """DSMIP6-TLS Packet Types Registry"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 15'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/mobility-parameters/dsmip6-tls-packet-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:
+            long = 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('_', ' '))
+            tmp1 = f" {''.join(temp)}" if rfcs else ''
+
+            split = long.split(' (', 1)
+            if len(split) == 2:
+                name = split[0]
+                cmmt = f" ({split[1]}"
+            else:
+                name, cmmt = long, ''
+            desc = self.wrap_comment(f'{name}{cmmt}{tmp1}')
+
+            try:
+                code, _ = item[0], int(item[0])
+                renm = self.rename(name, code, original=long)
+
+                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
+
+
+if __name__ == '__main__':
+    sys.exit(DSMIP6TLSPacket())  # type: ignore[arg-type]