pypcapkit 1.3.3.post1__cp313-none-any.whl

pcapkit/vendor/mh/ack_status_code.py

@@ -0,0 +1,88 @@
+#
+# -*- coding: utf-8 -*-
+"""Pseudo Home Address Acknowledgement Status Codes
+======================================================
+
+.. module:: pcapkit.vendor.mh.ack_status_code
+
+This module contains the vendor crawler for **Pseudo Home Address Acknowledgement Status Codes**,
+which is automatically generating :class:`pcapkit.const.mh.ack_status_code.ACKStatusCode`.
+
+"""
+
+import csv
+import re
+import sys
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['ACKStatusCode']
+
+
+class ACKStatusCode(Vendor):
+    """Pseudo Home Address Acknowledgement Status Codes"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 255'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/mobility-parameters/mobility-parameters-4.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(ACKStatusCode())  # type: ignore[arg-type]

pcapkit/vendor/mh/ani_suboption.py

@@ -0,0 +1,88 @@
+# -*- coding: utf-8 -*-
+"""Access Network Information (ANI) Sub-Option Type Values
+=============================================================
+
+.. module:: pcapkit.vendor.mh.ani_suboption
+
+This module contains the vendor crawler for **Access Network Information (ANI) Sub-Option Type Values**,
+which is automatically generating :class:`pcapkit.const.mh.ani_suboption.ANISuboption`.
+
+"""
+
+import csv
+import re
+import sys
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['ANISuboption']
+
+
+class ANISuboption(Vendor):
+    """Access Network Information (ANI) Sub-Option Type Values"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 255'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/mobility-parameters/ani.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.replace('sub-option', '').strip(),
+                                   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(ANISuboption())  # type: ignore[arg-type]

pcapkit/vendor/mh/auth_subtype.py

@@ -0,0 +1,83 @@
+# -*- coding: utf-8 -*-
+"""Subtype Field of the MN-HA and MN-AAA Authentication Mobility Options
+==========================================================================
+
+.. module:: pcapkit.vendor.mh.auth_subtype
+
+This module contains the vendor crawler for **Subtype Field of the MN-HA and MN-AAA Authentication Mobility Options**,
+which is automatically generating :class:`pcapkit.const.mh.auth_subtype.AuthSubtype`.
+
+"""
+
+import csv
+import re
+import sys
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['AuthSubtype']
+
+
+class AuthSubtype(Vendor):
+    """Subtype Field of the MN-HA and MN-AAA Authentication Mobility Options"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 255'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/mobility-parameters/mobility-parameters-8.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 ''
+
+            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, _ = item[0], int(item[0])
+            renm = self.rename(name.replace(' authentication mobility option', ''),
+                               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}')
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(AuthSubtype())  # type: ignore[arg-type]

pcapkit/vendor/mh/binding_ack_flag.py

@@ -0,0 +1,148 @@
+# -*- coding: utf-8 -*-
+"""Binding Acknowledgment Flags
+==================================
+
+.. module:: pcapkit.vendor.mh.binding_ack_flag
+
+This module contains the vendor crawler for **Binding Acknowledgment Flags**,
+which is automatically generating :class:`pcapkit.const.mh.binding_ack_flag.BindingACKFlag`.
+
+"""
+
+import csv
+import re
+import sys
+from typing import TYPE_CHECKING
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['BindingACKFlag']
+
+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 BindingACKFlag(Vendor):
+    """Binding Acknowledgment Flags"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 0xFF'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/mobility-parameters/mobility-parameters-12.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:02x}"
+            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(BindingACKFlag())  # type: ignore[arg-type]

pcapkit/vendor/mh/binding_error.py

@@ -0,0 +1,78 @@
+# -*- coding: utf-8 -*-
+"""Binding Error Status Code
+===============================
+
+.. module:: pcapkit.vendor.mh.binding_error
+
+This module contains the vendor crawler for **Binding Error Status Code**,
+which is automatically generating :class:`pcapkit.const.mh.binding_error.BindingError`.
+
+"""
+
+import collections
+import sys
+from typing import TYPE_CHECKING
+
+from pcapkit.vendor.default import Vendor
+
+if TYPE_CHECKING:
+    from collections import Counter
+
+__all__ = ['BindingError']
+
+#: Binding error codes.
+DATA = {
+    1: 'Unknown binding for Home Address destination option',
+    2: 'Unrecognized MH Type value',
+}  # type: dict[int, str]
+
+
+class BindingError(Vendor):
+    """Binding Error Status Code"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 255'
+
+    def request(self) -> 'dict[int, str]':  # type: ignore[override] # pylint: disable=arguments-differ
+        """Fetch registry data.
+
+        Returns:
+            Registry data (:data:`~pcapkit.vendor.ipv4.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(BindingError())  # type: ignore[arg-type]

pcapkit/vendor/mh/binding_revocation.py

@@ -0,0 +1,87 @@
+# -*- coding: utf-8 -*-
+"""Binding Revocation Type
+=============================
+
+.. module:: pcapkit.vendor.mh.binding_revocation
+
+This module contains the vendor crawler for **Binding Revocation Type**,
+which is automatically generating :class:`pcapkit.const.mh.binding_revocation.BindingRevocation`.
+
+"""
+
+import csv
+import re
+import sys
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['BindingRevocation']
+
+
+class BindingRevocation(Vendor):
+    """Binding Revocation Type"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 255'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/mobility-parameters/binding-revocation-type.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(BindingRevocation())  # type: ignore[arg-type]