"""AssertBlank class."""
from typing import TYPE_CHECKING
from text_lint.operations.assertions.bases.assertion_base import AssertionBase
from text_lint.utilities.translations import _
if TYPE_CHECKING: # pragma: no cover
from text_lint.linter.states.assertion import AssertionState
YAML_EXAMPLE_COMPONENTS = (
_("example assert blank assertion"),
)
YAML_EXAMPLE = """
- name: {0}
operation: assert_blank
""".format(*YAML_EXAMPLE_COMPONENTS)
[docs]
class AssertBlank(AssertionBase):
"""Assert that the line is blank."""
hint = _("the line contains no text")
operation = "assert_blank"
yaml_example = YAML_EXAMPLE
[docs]
def __init__(
self,
name: str,
) -> None:
"""Initialize AssertBlank instances.
:param name: The configured name of this assertion.
:raises: TypeError
"""
super().__init__(name, None, None)
[docs]
class Parameters:
"""Parameter validation for this operation."""
name = {"type": str}
[docs]
def apply(
self,
state: "AssertionState",
) -> None:
"""Apply the AssertBlank assertion logic."""
data = state.next()
if data != "":
state.fail("")