mirror of
https://github.com/volatilityfoundation/volatility3.git
synced 2026-08-21 14:02:22 +02:00
Mike Auty
29d41470a4
Relented on the strict import of direct objects/classes for the typing module only. Typing module components can be directly imported because it makes the code really painful to read and write otherwise. This is still in-line with the python style guide adopted from Google at http://google.github.io/styleguide/pyguide.html section 2.2.
44 lines
1.7 KiB
Python
44 lines
1.7 KiB
Python
"""A set of classes providing consistent type checking and error handling for type/class validity
|
|
"""
|
|
from typing import Callable, Optional, TypeVar, Type
|
|
|
|
ProgressCallback = Optional[Callable[[float, str], None]]
|
|
|
|
|
|
class ValidityRoutines(object):
|
|
"""Class to hold all validation routines, such as type checking
|
|
|
|
Contains only private class methods, including `_check_type(cls, value, valid_type)` and
|
|
`_check_class(cls, klass, valid_class)`. These may eventually be made obsolete by PEP 484
|
|
and appropriate static type verification by software such as mypy.
|
|
|
|
These are currently implemented by assertions that will be optimized out of production code.
|
|
"""
|
|
|
|
V = TypeVar('V')
|
|
|
|
@classmethod
|
|
def _check_type(cls, value: V, valid_type: Type) -> V:
|
|
"""Checks that value is an instance of valid_type, and returns value if it is, or throws a TypeError otherwise
|
|
|
|
Args:
|
|
value: The value of which to validate the type
|
|
valid_type: The type against which to validate
|
|
"""
|
|
assert isinstance(value,
|
|
valid_type), cls.__name__ + " expected " + valid_type.__name__ + ", not " + type(
|
|
value).__name__
|
|
return value
|
|
|
|
@classmethod
|
|
def _check_class(cls, klass: Type, valid_class: Type) -> Type:
|
|
"""Checks that class is an instance of valid_class, and returns klass if it is, or throws a TypeError otherwise
|
|
|
|
Args:
|
|
klass: Class to validate
|
|
valid_class: Valid class against which to check class validity
|
|
"""
|
|
assert issubclass(klass,
|
|
valid_class), cls.__name__ + " expected " + valid_class.__name__ + ", not " + klass.__name__
|
|
return klass
|