pypcapkit 1.3.3.post1__cp313-none-any.whl

pcapkit/vendor/http/__init__.py

@@ -0,0 +1,39 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=unused-import
+r""":class:`~pcapkit.protocols.application.http.HTTP` Vendor Crawlers
+========================================================================
+
+.. module:: pcapkit.vendor.http
+
+This module contains all vendor crawlers of
+:class:`~pcapkit.protocols.application.http.HTTP` implementations. Available
+crawlers include:
+
+.. list-table::
+
+   * - :class:`HTTP_ErrorCode <pcapkit.vendor.http.error_code.ErrorCode>`
+     - HTTP/2 Error Code [*]_
+   * - :class:`HTTP_Frame <pcapkit.vendor.http.frame.Frame>`
+     - HTTP/2 Frame Type [*]_
+   * - :class:`HTTP_Method <pcapkit.vendor.http.method.Method>`
+     - HTTP/1.\* Method [*]_
+   * - :class:`HTTP_Setting <pcapkit.vendor.http.setting.Setting>`
+     - HTTP/2 Settings [*]_
+   * - :class:`HTTP_Status <pcapkit.vendor.http.status_code.StatusCode>`
+     - HTTP/1.\* Status Code [*]_
+
+.. [*] https://www.iana.org/assignments/http2-parameters/http2-parameters.xhtml#error-code
+.. [*] https://www.iana.org/assignments/http2-parameters/http2-parameters.xhtml#frame-type
+.. [*] https://www.iana.org/assignments/http-methods/http-methods.xhtml#methods
+.. [*] https://www.iana.org/assignments/http2-parameters/http2-parameters.xhtml#settings
+.. [*] https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml#http-status-codes-1
+
+"""
+
+from pcapkit.vendor.http.error_code import ErrorCode as HTTP_ErrorCode
+from pcapkit.vendor.http.frame import Frame as HTTP_Frame
+from pcapkit.vendor.http.method import Method as HTTP_Method
+from pcapkit.vendor.http.setting import Setting as HTTP_Setting
+from pcapkit.vendor.http.status_code import StatusCode as HTTP_StatusCode
+
+__all__ = ['HTTP_ErrorCode', 'HTTP_Frame', 'HTTP_Method', 'HTTP_Setting', 'HTTP_StatusCode']

pcapkit/vendor/http/error_code.py

@@ -0,0 +1,95 @@
+# -*- coding: utf-8 -*-
+"""HTTP/2 Error Code
+=======================
+
+.. module:: pcapkit.vendor.http.error_code
+
+This module contains the vendor crawler for **HTTP/2 Error Code**,
+which is automatically generating :class:`pcapkit.const.http.error_code.ErrorCode`.
+
+"""
+
+import csv
+import re
+import sys
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['ErrorCode']
+
+
+def hexlify(code: 'int') -> 'str':
+    """Convert code to hex form."""
+    # temp = hex(code)[2:].upper().zfill(8)
+    # return f'0x{temp[:4]}_{temp[4:]}'
+    return f'0x{hex(code)[2:].upper().zfill(8)}'
+
+
+class ErrorCode(Vendor):
+    """HTTP/2 Error Code"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0x00000000 <= value <= 0xFFFFFFFF'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/http2-parameters/error-code.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]
+            dscp = 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_split = rfc[3:].split(', ', maxsplit=1)
+                    if len(temp_split) > 1:
+                        temp.append(f'[:rfc:`{temp_split[0]}#{temp_split[1].lower()}`]'.replace(' ', '-'))
+                    else:
+                        temp.append(f'[:rfc:`{temp_split[0]}`]')
+                else:
+                    temp.append(f'[{rfc}]'.replace('_', ' '))
+            tmp1 = f" {''.join(temp)}" if rfcs else ''
+            dscp = f', {dscp}' if dscp else ''
+            desc = self.wrap_comment(f'{name}{dscp}{tmp1}')
+
+            try:
+                tmp2 = int(item[0], base=16)
+                code = hexlify(tmp2)
+                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(lambda s: int(s, base=16), item[0].split('-'))
+
+                miss.append(f'if {hexlify(start)} <= value <= {hexlify(stop)}:')
+                miss.append(f'    #: {desc}')
+                miss.append(f'    temp = hex(value)[2:].upper().zfill(8)')
+                miss.append(f"    return extend_enum(cls, '{self.safe_name(name)}_0x%s' % (temp[:4]+'_'+temp[4:]), value)")
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(ErrorCode())  # type: ignore[arg-type]

pcapkit/vendor/http/frame.py

@@ -0,0 +1,91 @@
+# -*- coding: utf-8 -*-
+"""HTTP/2 Frame Type
+=======================
+
+.. module:: pcapkit.vendor.http.frame
+
+This module contains the vendor crawler for **HTTP/2 Frame Type**,
+which is automatically generating :class:`pcapkit.const.http.frame.Frame`.
+
+"""
+
+import csv
+import re
+import sys
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['Frame']
+
+
+def hexlify(code: 'int') -> 'str':
+    """Convert code to hex form."""
+    return f'0x{hex(code)[2:].upper().zfill(2)}'
+
+
+class Frame(Vendor):
+    """HTTP/2 Frame Type"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0x00 <= value <= 0xFF'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/http2-parameters/frame-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:
+            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_split = rfc[3:].split(', ', maxsplit=1)
+                    if len(temp_split) > 1:
+                        temp.append(f'[:rfc:`{temp_split[0]}#{temp_split[1].lower()}`]'.replace(' ', '-'))
+                    else:
+                        temp.append(f'[:rfc:`{temp_split[0]}`]')
+                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:
+                tmp1 = int(item[0], base=16)
+                code = hexlify(tmp1)
+                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(lambda s: int(s, base=16), item[0].split('-'))
+
+                miss.append(f'if {hexlify(start)} <= value <= {hexlify(stop)}:')
+                miss.append(f'    #: {desc}')
+                miss.append(f"    return extend_enum(cls, '{name}_0x%s' % hex(value)[2:].upper().zfill(2), value)")
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(Frame())  # type: ignore[arg-type]

pcapkit/vendor/http/method.py

@@ -0,0 +1,167 @@
+# -*- coding: utf-8 -*-
+"""HTTP Method
+=================
+
+.. module:: pcapkit.vendor.http.method
+
+This module contains the vendor crawler for **HTTP Method**,
+which is automatically generating :class:`pcapkit.const.http.method.Method`.
+
+"""
+import csv
+import re
+import sys
+from typing import TYPE_CHECKING
+
+from pcapkit.vendor.default import Vendor
+
+if TYPE_CHECKING:
+    from typing import Callable
+
+__all__ = ['Method']
+
+#: Default constant template of enumerate registry from IANA CSV.
+LINE = lambda NAME, DOCS, 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 typing import TYPE_CHECKING
+
+from aenum import StrEnum, extend_enum
+
+if TYPE_CHECKING:
+    from typing import Optional, Type
+
+__all__ = ['{NAME}']
+
+class {NAME}(StrEnum):
+    """[{NAME}] {DOCS}"""
+
+    if TYPE_CHECKING:
+        #: Safe method.
+        safe: 'bool'
+        #: Idempotent method.
+        idempotent: 'bool'
+
+    def __new__(cls, value: 'str', safe: 'bool' = False,
+                idempotent: 'bool' = False) -> 'Type[{NAME}]':
+        obj = str.__new__(cls)
+        obj._value_ = value
+
+        obj.safe = safe
+        obj.idempotent = idempotent
+
+        return obj
+
+    def __repr__(self) -> 'str':
+        return "<%s.%s>" % (self.__class__.__name__, self._value_)
+
+    {ENUM}
+
+    @staticmethod
+    def get(key: 'str', default: 'Optional[str]' = None) -> '{NAME}':
+        """Backport support for original codes.
+
+        Args:
+            key: Key to get enum item.
+            default: Default value if not found.
+
+        :meta private:
+        """
+        if key not in {NAME}._member_map_:  # pylint: disable=no-member
+            return extend_enum({NAME}, key.upper(), default if default is not None else key)
+        return {NAME}[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'str') -> '{NAME}':
+        """Lookup function used when value is not found.
+
+        Args:
+            value: Value to get enum item.
+
+        """
+        return extend_enum(cls, value.upper(), value)
+'''.strip()  # type: Callable[[str, str, str, str], str]
+
+
+class Method(Vendor):
+    """HTTP Method"""
+
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/http-methods/methods.csv'
+
+    def process(self, data: 'list[str]') -> 'list[str]':  # type: ignore[override]
+        """Process CSV data.
+
+        Args:
+            data: CSV data.
+
+        Returns:
+            Enumeration fields.
+
+        """
+        reader = csv.reader(data)
+        next(reader)  # header
+
+        enum = []  # type: list[str]
+        for item in reader:
+            meth = item[0]
+            if meth == '*':
+                continue
+
+            safe = item[1]
+            idem = 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_split = rfc[3:].split(', ', maxsplit=1)
+                    if len(temp_split) > 1:
+                        temp.append(f'[:rfc:`{temp_split[0]}#{temp_split[1].lower()}`]'.replace(' ', '-'))
+                    else:
+                        temp.append(f'[:rfc:`{temp_split[0]}`]')
+                else:
+                    temp.append(f'[{rfc}]'.replace('_', ' '))
+            desc = self.wrap_comment(re.sub(r'\r*\n', ' ', '%s %s' % (  # pylint: disable=consider-using-f-string
+                meth, ''.join(temp) if rfcs else '',
+            ), re.MULTILINE))
+
+            name = self.safe_name(meth).upper()
+            safe_flag = 'True' if safe == 'yes' else 'False'
+            idem_flag = 'True' if idem == 'yes' else 'False'
+
+            pres = f"{name} = {meth!r}, {safe_flag}, {idem_flag}"
+            sufs = f'#: {desc}'
+
+            enum.append(f'{sufs}\n    {pres}')
+        return enum
+
+    def context(self, data: 'list[str]') -> 'str':
+        """Generate constant context.
+
+        Args:
+            data: CSV data.
+
+        Returns:
+            Constant context.
+
+        """
+        enum = self.process(data)
+        ENUM = '\n\n    '.join(map(lambda s: s.rstrip(), enum)).strip()
+
+        return LINE(self.NAME, self.DOCS, ENUM, self.__module__)
+
+
+if __name__ == '__main__':
+    sys.exit(Method())  # type: ignore[arg-type]

pcapkit/vendor/http/setting.py

@@ -0,0 +1,93 @@
+# -*- coding: utf-8 -*-
+"""HTTP/2 Settings
+=====================
+
+.. module:: pcapkit.vendor.http.setting
+
+This module contains the vendor crawler for **HTTP/2 Settings**,
+which is automatically generating :class:`pcapkit.const.http.setting.Setting`.
+
+"""
+
+import csv
+import re
+import sys
+
+from pcapkit.vendor.default import Vendor
+
+__all__ = ['Setting']
+
+
+def hexlify(code: 'int') -> 'str':
+    """Convert code to hex form."""
+    return f'0x{hex(code)[2:].upper().zfill(4)}'
+
+
+class Setting(Vendor):
+    """HTTP/2 Settings"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 0x0000 <= value <= 0xFFFF'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/http2-parameters/settings.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]
+            dscp = 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_split = rfc[3:].split(', ', maxsplit=1)
+                    if len(temp_split) > 1:
+                        temp.append(f'[:rfc:`{temp_split[0]}#{temp_split[1].lower()}`]'.replace(' ', '-'))
+                    else:
+                        temp.append(f'[:rfc:`{temp_split[0]}`]')
+                else:
+                    temp.append(f'[{rfc}]'.replace('_', ' '))
+            tmp1 = f" {''.join(temp)}" if rfcs else ''
+            subs = re.sub(r'\(|\)', '', dscp)
+            dscp = f' (Initial Value: {subs})' if subs else ''
+            desc = self.wrap_comment(f'``{name}``{tmp1}{dscp}')
+
+            try:
+                tmp2 = int(item[0], base=16)
+                code = hexlify(tmp2)
+                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(lambda s: int(s, base=16), item[0].split('-'))
+
+                miss.append(f'if {hexlify(start)} <= value <= {hexlify(stop)}:')
+                miss.append(f'    #: {desc}')
+                miss.append(f"    return extend_enum(cls, '{self.safe_name(name)}_0x%s' % hex(value)[2:].upper().zfill(4), value)")  # pylint: disable=line-too-long
+        return enum, miss
+
+
+if __name__ == '__main__':
+    sys.exit(Setting())  # type: ignore[arg-type]

pcapkit/vendor/http/status_code.py

@@ -0,0 +1,185 @@
+# -*- coding: utf-8 -*-
+"""HTTP Status Code
+======================
+
+.. module:: pcapkit.vendor.http.status_code
+
+This module contains the vendor crawler for **HTTP Status Code**,
+which is automatically generating :class:`pcapkit.const.http.status_code.StatusCode`.
+
+"""
+import csv
+import re
+import sys
+from typing import TYPE_CHECKING
+
+from pcapkit.vendor.default import Vendor
+
+if TYPE_CHECKING:
+    from typing import Callable
+
+__all__ = ['StatusCode']
+
+
+#: Default constant template of enumerate registry from IANA CSV.
+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 typing import TYPE_CHECKING
+
+from aenum import IntEnum, extend_enum
+
+if TYPE_CHECKING:
+    from typing import Type
+
+__all__ = ['{NAME}']
+
+
+class {NAME}(IntEnum):
+    """[{NAME}] {DOCS}"""
+
+    if TYPE_CHECKING:
+        #: Status message.
+        message: 'str'
+
+    def __new__(cls, value: 'int', message: 'str' = '(Unknown)') -> 'Type[{NAME}]':
+        obj = int.__new__(cls, value)
+        obj._value_ = value
+
+        obj.message = message
+
+        return obj
+
+    def __repr__(self) -> 'str':
+        return "<%s [%s]>" % (self.__class__.__name__, self._value_)
+
+    def __str__(self) -> 'str':
+        return "[%s] %s" % (self._value_, self.message)
+
+    {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)
+        if key not in {NAME}._member_map_:  # pylint: disable=no-member
+            extend_enum({NAME}, key, default)
+        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__))
+        {MISS}
+        {'' if (test := ''.join(MISS.splitlines()[-1:])).startswith('return') or test[8:].startswith('return') else 'return super()._missing_(value)'}
+'''.strip()  # type: Callable[[str, str, str, str, str, str], str]
+
+
+class StatusCode(Vendor):
+    """HTTP Status Code"""
+
+    #: Value limit checker.
+    FLAG = 'isinstance(value, int) and 100 <= value <= 599'
+    #: Link to registry.
+    LINK = 'https://www.iana.org/assignments/http-status-codes/http-status-codes-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)
+
+        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_split = rfc[3:].split(', ', maxsplit=1)
+                    if len(temp_split) > 1:
+                        temp.append(f'[:rfc:`{temp_split[0]}#{temp_split[1].lower()}`]'.replace(' ', '-'))
+                    else:
+                        temp.append(f'[:rfc:`{temp_split[0]}`]')
+                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])
+                if name != '(Unused)':
+                    name = re.sub(r'\(.*\)', '', name).strip()
+
+                pres = f'CODE_{code} = {code}, {name!r}'
+                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, 'CODE_%d' % value, value, {name!r})")
+        return enum, miss
+
+    def context(self, data: 'list[str]') -> 'str':
+        """Generate constant context.
+
+        Args:
+            data: CSV data.
+
+        Returns:
+            Constant context.
+
+        """
+        enum, miss = self.process(data)
+
+        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(StatusCode())  # type: ignore[arg-type]