Source code for pcapkit.utilities.warnings

# -*- coding: utf-8 -*-
"""user defined warnings

:mod:`pcapkit.warnings` refined built-in warnings.

"""

__all__ = [
    # UserWarning
    'BaseWarning',
    # ImportWarning
    'FormatWarning', 'EngineWarning', 'InvalidVendorWarning',
    # RuntimeWarning
    'FileWarning', 'LayerWarning', 'ProtocolWarning', 'AttributeWarning',
    'DevModeWarning', 'VendorRequestWarning', 'VendorRuntimeWarning',
    # ResourceWarning
    'DPKTWarning', 'ScapyWarning', 'PySharkWarning'
]

##############################################################################
# BaseWarning (abc of warnings) session.
##############################################################################



[docs]class BaseWarning(UserWarning):
    """Base warning class of all kinds."""


[docs]    def __init__(self, *args, **kwargs):  # pylint: disable=useless-super-delegation
        # warnings.simplefilter('default')
        super().__init__(*args, **kwargs)



##############################################################################
# ImportWarning session.
##############################################################################



[docs]class FormatWarning(BaseWarning, ImportWarning):
    """Warning on unknown format(s)."""




[docs]class EngineWarning(BaseWarning, ImportWarning):
    """Unsupported extraction engine."""




[docs]class InvalidVendorWarning(BaseWarning, ImportWarning):
    """Vendor CLI invalid updater."""



##############################################################################
# RuntimeWarning session.
##############################################################################



[docs]class FileWarning(BaseWarning, RuntimeWarning):
    """Warning on file(s)."""




[docs]class LayerWarning(BaseWarning, RuntimeWarning):
    """Unrecognised layer."""




[docs]class ProtocolWarning(BaseWarning, RuntimeWarning):
    """Unrecognised protocol."""




[docs]class AttributeWarning(BaseWarning, RuntimeWarning):
    """Unsupported attribute."""




[docs]class DevModeWarning(BaseWarning, RuntimeWarning):
    """Run in development mode."""




[docs]class VendorRequestWarning(BaseWarning, RuntimeWarning):
    """Vendor request connection failed."""




[docs]class VendorRuntimeWarning(BaseWarning, RuntimeWarning):
    """Vendor failed during runtime."""



##############################################################################
# ResourceWarning session.
##############################################################################



[docs]class DPKTWarning(BaseWarning, ResourceWarning):
    """Warnings on DPKT usage."""




[docs]class ScapyWarning(BaseWarning, ResourceWarning):
    """Warnings on Scapy usage."""




[docs]class PySharkWarning(BaseWarning, ResourceWarning):
    """Warnings on PyShark usage."""