mirror of
https://github.com/checktheroads/hyperglass
synced 2024-05-11 05:55:08 +00:00
82 lines
2.0 KiB
Python
82 lines
2.0 KiB
Python
"""Custom Pydantic Fields/Types."""
|
|
|
|
# Standard Library
|
|
import re
|
|
from typing import TypeVar
|
|
|
|
# Third Party
|
|
from pydantic import StrictInt, StrictFloat, constr
|
|
|
|
IntFloat = TypeVar("IntFloat", StrictInt, StrictFloat)
|
|
|
|
SupportedDriver = constr(regex=r"(scrapli|netmiko|hyperglass_agent)")
|
|
|
|
|
|
class StrictBytes(bytes):
|
|
"""Custom data type for a strict byte string.
|
|
|
|
Used for validating the encoded JWT request payload.
|
|
"""
|
|
|
|
@classmethod
|
|
def __get_validators__(cls):
|
|
"""Yield Pydantic validator function.
|
|
|
|
See: https://pydantic-docs.helpmanual.io/usage/types/#custom-data-types
|
|
|
|
Yields:
|
|
{function} -- Validator
|
|
"""
|
|
yield cls.validate
|
|
|
|
@classmethod
|
|
def validate(cls, value):
|
|
"""Validate type.
|
|
|
|
Arguments:
|
|
value {Any} -- Pre-validated input
|
|
|
|
Raises:
|
|
TypeError: Raised if value is not bytes
|
|
|
|
Returns:
|
|
{object} -- Instantiated class
|
|
"""
|
|
if not isinstance(value, bytes):
|
|
raise TypeError("bytes required")
|
|
return cls()
|
|
|
|
def __repr__(self):
|
|
"""Return representation of object.
|
|
|
|
Returns:
|
|
{str} -- Representation
|
|
"""
|
|
return f"StrictBytes({super().__repr__()})"
|
|
|
|
|
|
class AnyUri(str):
|
|
"""Custom field type for HTTP URI, e.g. /example."""
|
|
|
|
@classmethod
|
|
def __get_validators__(cls):
|
|
"""Pydantic custim field method."""
|
|
yield cls.validate
|
|
|
|
@classmethod
|
|
def validate(cls, value):
|
|
"""Ensure URI string contains a leading forward-slash."""
|
|
uri_regex = re.compile(r"^(\/.*)$")
|
|
if not isinstance(value, str):
|
|
raise TypeError("AnyUri type must be a string")
|
|
match = uri_regex.fullmatch(value)
|
|
if not match:
|
|
raise ValueError(
|
|
"Invalid format. A URI must begin with a forward slash, e.g. '/example'"
|
|
)
|
|
return cls(match.group())
|
|
|
|
def __repr__(self):
|
|
"""Stringify custom field representation."""
|
|
return f"AnyUri({super().__repr__()})"
|