lookingglass/hyperglass/plugins/_input.py
2021-09-12 15:06:34 -07:00

21 lines
500 B
Python

"""Input validation plugins."""
# Standard Library
from typing import TYPE_CHECKING, Union
# Local
from ._base import HyperglassPlugin
if TYPE_CHECKING:
# Project
from hyperglass.models.api.query import Query
InputPluginReturn = Union[None, bool]
class InputPlugin(HyperglassPlugin):
"""Plugin to validate user input prior to running commands."""
def validate(self, query: "Query") -> InputPluginReturn:
"""Validate input from hyperglass UI/API."""
return None