pypcapkit 1.3.3.post1__cp313-none-any.whl

pcapkit/vendor/pcapng/block_type.py

@@ -0,0 +1,94 @@
+# -*- coding: utf-8 -*-
+"""Block Types
+=================
+
+.. module:: pcapkit.vendor.pcapng.block_type
+
+This module contains the vendor crawler for **Block Types**,
+which is automatically generating :class:`pcapkit.const.pcapng.block_type.BlockType`.
+
+"""
+
+import collections
+import sys
+from typing import TYPE_CHECKING
+
+import bs4
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['BlockType']
+
+if TYPE_CHECKING:
+    from collections import Counter
+
+    from bs4.element import Tag
+
+
+class BlockType(Vendor):
+    """Block Types"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 0xFFFFFFFF'
+    #: Link to registry.
+    LINK = 'https://www.ietf.org/staging/draft-tuexen-opsawg-pcapng-02.html'
+
+    def count(self, data: 'list[str]') -> 'Counter[str]':
+        """Count field records."""
+        return collections.Counter()
+
+    def request(self, text: 'str') -> 'list[Tag]':  # type: ignore[override] # pylint: disable=signature-differs
+        """Fetch registry table.
+
+        Args:
+            text: Context from :attr:`~LinkType.LINK`.
+
+        Returns:
+            Rows (``tr``) from registry table (``table``).
+
+        """
+        soup = bs4.BeautifulSoup(text, 'html5lib')
+        table = soup.select('table#table-9')[0]
+        return table.select('tr')[1:]
+
+    def process(self, data: 'list[Tag]') -> 'tuple[list[str], list[str]]':
+        """Process registry data.
+
+        Args:
+            data: Registry data.
+
+        Returns:
+            Enumeration fields and missing fields.
+
+        """
+        enum = []  # type: list[str]
+        miss = []  # type: list[str]
+        for content in data:
+            temp = content.select('td')[0].text.strip()
+            desc = ' '.join(content.select('td')[1].stripped_strings)
+
+            if 'Reserved' in desc:
+                name = 'Reserved'
+            else:
+                name = self.safe_name(desc.split('.', maxsplit=1)[0].split('(', maxsplit=1)[0].strip())
+
+            try:
+                code = int(temp, base=16)
+                if name == 'Reserved':
+                    name = f'Reserved_0x{code:08x}'
+
+                pref = f'{name} = 0x{code:08x}'
+                sufs = self.wrap_comment(desc)
+
+                enum.append(f'#: {sufs}\n    {pref}')
+            except ValueError:
+                start, stop = map(lambda x: int(x, base=16), temp.split('-'))
+
+                miss.append(f'if 0x{start:08x} <= value <= 0x{stop:08x}:')
+                miss.append(f'    #: {desc}')
+                miss.append(f"    return extend_enum(cls, '{self.safe_name(name)}_%08x' % value, value)")
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(BlockType())  # type: ignore[arg-type]

pcapkit/vendor/pcapng/filter_type.py

@@ -0,0 +1,77 @@
+# -*- coding: utf-8 -*-
+"""Filter Types
+==================
+
+.. module:: pcapkit.vendor.pcapng.filter_type
+
+This module contains the vendor crawler for **Filter Types**,
+which is automatically generating :class:`pcapkit.const.pcapng.filter_type.FilterType`.
+
+"""
+
+import collections
+import sys
+from typing import TYPE_CHECKING
+
+from pcapkit.vendor.default import Vendor
+
+if TYPE_CHECKING:
+    from collections import Counter
+
+__all__ = ['FilterType']
+
+#: Filter type registry.
+DATA = {
+    # TODO: https://www.ietf.org/staging/draft-tuexen-opsawg-pcapng-02.html#section-4.2-28.2.1
+}  # type: dict[int, str]
+
+
+class FilterType(Vendor):
+    """Filter Types"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0x00<= value <= 0xFF'
+
+    def request(self) -> 'dict[int, str]':  # type: ignore[override] # pylint: disable=arguments-differ
+        """Fetch registry data.
+
+        Returns:
+            Registry data (:data:`~pcapkit.vendor.pcapng.filter_type.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(FilterType())  # type: ignore[arg-type]

pcapkit/vendor/pcapng/hash_algorithm.py

@@ -0,0 +1,82 @@
+# -*- coding: utf-8 -*-
+"""Hash Algorithms
+=====================
+
+.. module:: pcapkit.vendor.pcapng.hash_algorithm
+
+This module contains the vendor crawler for **Hash Algorithms**,
+which is automatically generating :class:`pcapkit.const.pcapng.hash_algorithm.HashAlgorithm`.
+
+"""
+
+import collections
+import sys
+from typing import TYPE_CHECKING
+
+from pcapkit.vendor.default import Vendor
+
+if TYPE_CHECKING:
+    from collections import Counter
+
+__all__ = ['HashAlgorithm']
+
+#: Hash algorithm registry.
+DATA = {
+    0: "two's complement",
+    1: 'XOR',
+    2: 'CRC32',
+    3: 'MD-5',
+    4: 'SHA-1',
+    5: 'Toeplitz',
+}  # type: dict[int, str]
+
+
+class HashAlgorithm(Vendor):
+    """Hash Algorithms"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0x00 <= value <= 0xFF'
+
+    def request(self) -> 'dict[int, str]':  # type: ignore[override] # pylint: disable=arguments-differ
+        """Fetch registry data.
+
+        Returns:
+            Registry data (:data:`~pcapkit.vendor.pcapng.hash_algorithm.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(HashAlgorithm())  # type: ignore[arg-type]

pcapkit/vendor/pcapng/option_type.py

@@ -0,0 +1,287 @@
+# -*- coding: utf-8 -*-
+"""Option Types
+==================
+
+.. module:: pcapkit.vendor.pcapng.option_type
+
+This module contains the vendor crawler for **Option Types**,
+which is automatically generating :class:`pcapkit.const.pcapng.option_type.OptionType`.
+
+"""
+
+import collections
+import sys
+from typing import TYPE_CHECKING
+
+import bs4
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['OptionType']
+
+if TYPE_CHECKING:
+    from collections import Counter
+    from typing import Callable
+
+    from bs4.element import Tag
+
+LINE = lambda NAME, DOCS, FLAG, ENUM, MISS, MODL: f'''\
+# -*- coding: utf-8 -*-
+# mypy: disable-error-code=assignment
+# 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 collections import defaultdict
+from typing import TYPE_CHECKING
+
+from aenum import StrEnum, extend_enum
+
+__all__ = ['{NAME}']
+
+if TYPE_CHECKING:
+    from typing import Any, DefaultDict, Optional, Type
+
+
+class {NAME}(StrEnum):
+    """[{NAME}] {DOCS}"""
+
+    if TYPE_CHECKING:
+        #: Short name of the option type.
+        opt_name: 'str'
+        #: Numeric value of the option type.
+        opt_value: 'int'
+
+    #: Mapping of members based on namespace.
+    __members_ns__: 'DefaultDict[str, dict[int, {NAME}]]' = defaultdict(dict)
+
+    def __new__(cls, value: 'int', name: 'str' = 'opt_unknown') -> 'Type[{NAME}]':
+        temp = '%s [%d]' % (name, value)
+
+        obj = str.__new__(cls, temp)
+        obj._value_ = temp
+
+        obj.opt_name = name
+        obj.opt_value = value
+
+        namespace = name.split('_', maxsplit=1)[0]
+        cls.__members_ns__[namespace][value] = obj
+
+        return obj
+
+    def __repr__(self) -> 'str':
+        return "<%s.%s: %d>" % (self.__class__.__name__, self.opt_name, self.opt_value)
+
+    def __str__(self) -> 'str':
+        return '%s [%d]' % (self.opt_name, self.opt_value)
+
+    def __int__(self) -> 'int':
+        return self.opt_value
+
+    def __lt__(self, other: '{NAME}') -> 'bool':
+        return self.opt_value < other
+
+    def __gt__(self, other: '{NAME}') -> 'bool':
+        return self.opt_value > other
+
+    def __le__(self, other: '{NAME}') -> 'bool':
+        return self.opt_value <= other
+
+    def __ge__(self, other: '{NAME}') -> 'bool':
+        return self.opt_value >= other
+
+    def __eq__(self, other: 'Any') -> 'bool':
+        return self.opt_value == other
+
+    def __ne__(self, other: 'Any') -> 'bool':
+        return self.opt_value != other
+
+    def __hash__(self) -> 'int':
+        return hash(self.opt_value)
+
+    {ENUM}
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1, *, namespace: 'str' = 'opt') -> '{NAME}':
+        """Backport support for original codes.
+
+        Args:
+            key: Key to get enum item.
+            default: Default value if not found.
+            namespace: Namespace of the enum item.
+
+        :meta private:
+        """
+        if isinstance(key, int):
+            temp_ns = {NAME}.__members_ns__.get('opt', {{}}).copy()
+            temp_ns.update({NAME}.__members_ns__.get(namespace, {{}}))
+            if key in temp_ns:
+                return temp_ns[key]
+            return extend_enum({NAME}, '%s_unknown_%d' % (namespace, key), key, '%s_unknown' % namespace)
+        if key in {NAME}.__members__:
+            return getattr({NAME}, key)
+        return extend_enum({NAME}, key, default, key)
+
+    @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__))
+        if value in cls.__members_ns__.get('opt', {{}}):
+            return cls.__members_ns__['opt'][value]
+        {MISS}
+        {'' if ''.join(MISS.splitlines()[-1:]).startswith('return') else 'return super()._missing_(value)'}
+'''.strip()  # type: Callable[[str, str, str, str, str, str], str]
+
+
+class OptionType(Vendor):
+    """Option Types"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 0xFFFF'
+    #: Link to registry.
+    LINK = 'https://www.ietf.org/staging/draft-tuexen-opsawg-pcapng-02.html'
+
+    def count(self, data: 'list[str]') -> 'Counter[str]':
+        """Count field records."""
+        return collections.Counter()
+
+    def request(self, text: 'str') -> 'dict[str, list[Tag]]':  # type: ignore[override] # pylint: disable=signature-differs
+        """Fetch registry table.
+
+        Args:
+            text: Context from :attr:`~LinkType.LINK`.
+
+        Returns:
+            Rows (``tr``) from registry table (``table``).
+
+        """
+        soup = bs4.BeautifulSoup(text, 'html5lib')
+        table_1 = soup.select('table#table-1')[0]
+        table_3 = soup.select('table#table-3')[0]
+        table_4 = soup.select('table#table-4')[0]
+        table_7 = soup.select('table#table-7')[0]
+        table_8 = soup.select('table#table-8')[0]
+        table_10 = soup.select('table#table-10')[0]
+        return {
+            'table-1': table_1.select('tr')[1:],
+            'table-3': table_3.select('tr')[1:],
+            'table-4': table_4.select('tr')[1:],
+            'table-7': table_7.select('tr')[1:],
+            'table-8': table_8.select('tr')[1:],
+            'table-10': table_10.select('tr')[1:],
+        }
+
+    def process(self, data: 'dict[str, list[Tag]]') -> '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, 'opt_unknown_%d' % value, value, 'opt_unknown')",
+        ]  # type: list[str]
+
+        for content in data['table-1']:
+            name = content.select('td')[0].text.strip()
+            temp = content.select('td')[1].text.strip()
+
+            try:
+                code = int(temp)
+
+                pref = f"{name}: 'OptionType' = {code}, {name!r}"
+                sufs = self.wrap_comment(name)
+
+                enum.append(f'#: {sufs}\n    {pref}')
+            except ValueError:
+                opts = tuple(map(lambda x: int(x), temp.split('/')))
+
+                for code in opts:
+                    pref = f"{name}_{code}: 'OptionType' = {code}, {name!r}"
+                    sufs = self.wrap_comment(name)
+
+                    enum.append(f'#: {sufs}\n    {pref}')
+
+        for content in data['table-3']:
+            name = content.select('td')[0].text.strip()
+            code = content.select('td')[1].text.strip()
+
+            pref = f"{name}: 'OptionType' = {int(code)}, {name!r}"
+            sufs = self.wrap_comment(name)
+
+            enum.append(f'#: {sufs}\n    {pref}')
+
+        for content in data['table-4']:
+            name = content.select('td')[0].text.strip()
+            code = content.select('td')[1].text.strip()
+
+            pref = f"{name}: 'OptionType' = {int(code)}, {name!r}"
+            sufs = self.wrap_comment(name)
+
+            enum.append(f'#: {sufs}\n    {pref}')
+
+        for content in data['table-7']:
+            name = content.select('td')[0].text.strip()
+            code = content.select('td')[1].text.strip()
+
+            pref = f"{name}: 'OptionType' = {int(code)}, {name!r}"
+            sufs = self.wrap_comment(name)
+
+            enum.append(f'#: {sufs}\n    {pref}')
+
+        for content in data['table-8']:
+            name = content.select('td')[0].text.strip()
+            code = content.select('td')[1].text.strip()
+
+            pref = f"{name}: 'OptionType' = {int(code)}, {name!r}"
+            sufs = self.wrap_comment(name)
+
+            enum.append(f'#: {sufs}\n    {pref}')
+
+        for content in data['table-10']:
+            name = content.select('td')[0].text.strip()
+            code = content.select('td')[1].text.strip()
+
+            pref = f"{name}: 'OptionType' = {int(code)}, {name!r}"
+            sufs = self.wrap_comment(name)
+
+            enum.append(f'#: {sufs}\n    {pref}')
+
+        return enum, miss
+
+    def context(self, soup: 'dict[str, list[Tag]]') -> 'str':  # type: ignore[override]
+        """Generate constant context.
+
+        Args:
+            data: CSV data.
+
+        Returns:
+            Constant context.
+
+        """
+        enum, miss = self.process(soup)
+
+        ENUM = '\n\n    '.join(map(lambda s: s.rstrip(), enum)).strip()
+        MISS = '\n        '.join(map(lambda s: s.rstrip(), miss)).strip()
+
+        return LINE(self.NAME, self.DOCS, self.FLAG, ENUM, MISS, self.__module__)
+
+
+if __name__ == '__main__':
+    sys.exit(OptionType())  # type: ignore[arg-type]

pcapkit/vendor/pcapng/record_type.py

@@ -0,0 +1,81 @@
+# -*- coding: utf-8 -*-
+"""Record Types
+==================
+
+.. module:: pcapkit.vendor.pcapng.record_type
+
+This module contains the vendor crawler for **Record Types**,
+which is automatically generating :class:`pcapkit.const.pcapng.record_type.RecordType`.
+
+"""
+
+import collections
+import sys
+from typing import TYPE_CHECKING
+
+import bs4
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['RecordType']
+
+if TYPE_CHECKING:
+    from collections import Counter
+
+    from bs4.element import Tag
+
+
+class RecordType(Vendor):
+    """Record Types"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0 <= value <= 0xFFFF'
+    #: Link to registry.
+    LINK = 'https://www.ietf.org/staging/draft-tuexen-opsawg-pcapng-02.html'
+
+    def count(self, data: 'list[str]') -> 'Counter[str]':
+        """Count field records."""
+        return collections.Counter()
+
+    def request(self, text: 'str') -> 'list[Tag]':  # type: ignore[override] # pylint: disable=signature-differs
+        """Fetch registry table.
+
+        Args:
+            text: Context from :attr:`~LinkType.LINK`.
+
+        Returns:
+            Rows (``tr``) from registry table (``table``).
+
+        """
+        soup = bs4.BeautifulSoup(text, 'html5lib')
+        table_1 = soup.select('table#table-6')[0]
+        return table_1.select('tr')[1:]
+
+    def process(self, data: 'list[Tag]') -> 'tuple[list[str], list[str]]':
+        """Process registry data.
+
+        Args:
+            data: Registry data.
+
+        Returns:
+            Enumeration fields and missing fields.
+
+        """
+        enum = []  # type: list[str]
+        miss = [
+            "extend_enum(cls, 'Unassigned_0x%04x' % value, value)",
+            'return cls(value)'
+        ]
+        for content in data:
+            name = content.select('td')[0].text.strip()
+            temp = content.select('td')[1].text.strip()
+
+            pref = f'{name} = {temp}'
+            sufs = self.wrap_comment(name)
+
+            enum.append(f'#: {sufs}\n    {pref}')
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(RecordType())  # type: ignore[arg-type]

pcapkit/vendor/pcapng/secrets_type.py

@@ -0,0 +1,81 @@
+# -*- coding: utf-8 -*-
+"""Secrets Types
+===================
+
+.. module:: pcapkit.vendor.pcapng.secrets_type
+
+This module contains the vendor crawler for **Secrets Types**,
+which is automatically generating :class:`pcapkit.const.pcapng.secrets_type.SecretsType`.
+
+"""
+
+import collections
+import sys
+from typing import TYPE_CHECKING
+
+from pcapkit.vendor.default import Vendor
+
+if TYPE_CHECKING:
+    from collections import Counter
+
+__all__ = ['SecretsType']
+
+#: Secrets type registry.
+DATA = {
+    0x544c534b: 'TLS Key Log',     # NSS Key Log Format
+    0x57474b4c: 'WireGuard Key Log',
+    0x5a4e574b: 'ZigBee NWK Key',  # ZigBee Specification
+    0x5a415053: 'ZigBee APS Key',  # ZigBee Specification
+}  # type: dict[int, str]
+
+
+class SecretsType(Vendor):
+    """Secrets Types"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0x00000000 <= value <= 0xFFFFFFFF'
+
+    def request(self) -> 'dict[int, str]':  # type: ignore[override] # pylint: disable=arguments-differ
+        """Fetch registry data.
+
+        Returns:
+            Registry data (:data:`~pcapkit.vendor.pcapng.secrets_type.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 = [
+            "extend_enum(cls, 'Unassigned_0x%08x' % value, value)",
+            'return cls(value)'
+        ]
+        for code, name in DATA.items():
+            renm = self.rename(name, code)  # type: ignore[arg-type]
+            enum.append(f"{renm} = 0x{code:08x}".ljust(76))
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(SecretsType())  # type: ignore[arg-type]