"""Core text file linter."""
from typing import TYPE_CHECKING
from text_lint.exceptions.sequencers import UnconsumedData
from text_lint.linter import states
from text_lint.linter.logging import Logger
from text_lint.linter.logging import contexts as logging_contexts
from text_lint.linter.recursion import RecursionDetection
from text_lint.results.forest import ResultForest
from text_lint.schema import Schema
from text_lint.sequencers.assertions import AssertionSequencer
from text_lint.sequencers.patterns.loop import LinearLoopPattern
from text_lint.sequencers.textfile import TextFileSequencer
from text_lint.sequencers.validators import ValidatorSequencer
from text_lint.utilities.translations import _
if TYPE_CHECKING: # no cover
from text_lint.linter.settings import LinterSettings
[Doku]
class Linter:
"""Orchestrates the text file linting process."""
msg_fmt_all_assertions_not_read = _(
"The entire file was read before all schema assertions were run."
)
msg_fmt_entire_file_not_read = _(
"The entire file was not read after all schema assertions were run."
)
[Doku]
def __init__(self, settings: "LinterSettings") -> None:
"""Initialize Linter instances.
:param settings: The settings object being used.
"""
self.settings = settings
schema = Schema(
self.settings.schema_path,
self.settings.interpolate_schema,
)
self.assertions = AssertionSequencer(schema)
self.validators = ValidatorSequencer(schema)
self.textfile = TextFileSequencer(self.settings.file_path)
self.textfile.configure(schema)
self.recursion = RecursionDetection(self)
self.states = states.StateFactory(self)
self.forest = ResultForest()
self.log = Logger(self)
[Doku]
def start(self) -> None:
"""Start the text file linting process."""
with logging_contexts.main(self):
with logging_contexts.assertion_section(self):
self._run_assertions()
self._ensure_all_assertions()
self._ensure_eof()
with logging_contexts.validator_section(self):
self._run_validators()
def _run_assertions(self) -> None:
for operation in self.assertions:
try:
with logging_contexts.assertion(self, operation):
operation.apply(self.states.assertion())
except StopIteration:
# Text file has finished.
break
self.recursion.detect()
def _run_validators(self) -> None:
for operation in self.validators:
with logging_contexts.validator(self, operation):
operation.apply(self.states.validator())
def _ensure_all_assertions(self) -> None:
try:
next(self.assertions)
except StopIteration:
pass
else:
if not isinstance(self.assertions.pattern, LinearLoopPattern):
raise UnconsumedData(self.msg_fmt_all_assertions_not_read)
def _ensure_eof(self) -> None:
try:
next(self.textfile)
except StopIteration:
pass
else:
raise UnconsumedData(self.msg_fmt_entire_file_not_read)