pypcapkit 1.3.3.post1__cp313-none-any.whl

pcapkit/vendor/mh/lla_code.py

@@ -0,0 +1,97 @@
+# -*- coding: utf-8 -*-
+"""Link-Layer Address (LLA) Option Code
+==========================================
+
+.. module:: pcapkit.vendor.mh.lla_code
+
+This module contains the vendor crawler for **Link-Layer Address (LLA) Option Code**,
+which is automatically generating :class:`pcapkit.const.mh.lla_code.LLACode`.
+
+"""
+
+import collections
+import sys
+from typing import TYPE_CHECKING
+
+from pcapkit.vendor.default import Vendor
+
+if TYPE_CHECKING:
+    from collections import Counter
+
+__all__ = ['LLACode']
+
+#: LLA option codes.
+DATA = {
+    #: Wildcard requesting resolution for all nearby access points.
+    0: 'Wilcard',
+    #: Link-Layer Address of the New Access Point.
+    1: 'New Access Point',
+    #: Link-Layer Address of the MN.
+    2: 'MH',
+    #: Link-Layer Address of the NAR (i.e., Proxied Originator).
+    3: 'NAR',
+    #: Link-Layer Address of the source of RtSolPr or PrRtAdv.
+    #: message.
+    4: 'RtSolPr or PrRtAdv',
+    #: The access point identified by the LLA belongs to the
+    #: current interface of the router.
+    5: 'access point',
+    #: No prefix information available for the access point
+    #: identified by the LLA.
+    6: 'no prefix information',
+    #: No fast handover support available for the access point
+    #: identified by the LLA.
+    7: 'no fast handover support',
+}  # type: dict[int, str]
+
+
+
+class LLACode(Vendor):
+    """Link-Layer Address (LLA) Option 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(LLACode())  # type: ignore[arg-type]

pcapkit/vendor/mh/lma_mag_suboption.py

@@ -0,0 +1,88 @@
+# -*- coding: utf-8 -*-
+"""LMA-Controlled MAG Parameters Sub-Option Type Values
+==========================================================
+
+.. module:: pcapkit.vendor.mh.lma_mag_suboption
+
+This module contains the vendor crawler for **LMA-Controlled MAG Parameters Sub-Option Type Values**,
+which is automatically generating :class:`pcapkit.const.mh.lma_mag_suboption.LMAControlledMAGSuboption`.
+
+"""
+
+import csv
+import re
+import sys
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['LMAControlledMAGSuboption']
+
+
+class LMAControlledMAGSuboption(Vendor):
+    """LMA-Controlled MAG Parameters 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/lma-controlled-mag-parameters-sub-option-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.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(LMAControlledMAGSuboption())  # type: ignore[arg-type]

pcapkit/vendor/mh/mn_group_id.py

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

pcapkit/vendor/mh/mn_id_subtype.py

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

pcapkit/vendor/mh/operator_id.py

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

pcapkit/vendor/mh/option.py

@@ -0,0 +1,83 @@
+# -*- coding: utf-8 -*-
+"""Mobility Options
+======================
+
+.. module:: pcapkit.vendor.mh.option
+
+This module contains the vendor crawler for **Mobility Options**,
+which is automatically generating :class:`pcapkit.const.mh.option.Option`.
+
+"""
+
+import csv
+import re
+import sys
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['Option']
+
+
+class Option(Vendor):
+    """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-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 = [
+            "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, 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(Option())  # type: ignore[arg-type]

pcapkit/vendor/mh/packet.py

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

pcapkit/vendor/mh/qos_attribute.py

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