stouputils.check package#
Style rules that ruff cannot express, checked on text files and Python sources.
Each rule of RULES can be left out with ignore, and the limits tuned, in pyproject.toml:
[tool.stouputils.check]
ignore = ["tab-indentation", "space-alignment"]
final-newlines = { ".py" = 1, ".json" = 1 }
initial-newlines = { ".md" = 1, ".mcfunction" = 1 }
docstring-max-lines = 20
per-file-ignores = { "tests/**" = ["long-comment"] }
In a Python file, # stp: ignore[rule] silences its own line, or the multi-line string it closes,
and # stouputils: ignore[rule] the whole file.
Submodules#
- stouputils.check.cli module
- stouputils.check.python module
CLAUSE_ENDINGSCLAUSE_BOUNDARYNEW_ITEMEXAMPLES_HEADERTYPED_ARGUMENTSPAN_DELIMITERSSTRANDED_FRAGMENTSUPPRESSIONLAYOUT_TOKENSpython_errors()suppressions()statements()indentation_errors()tab_aligned_lines()string_content_lines()comment_errors()docstring_layout_errors()constant_errors()is_docstring()docstring_errors()split_spans()code_block_indent()strands_fragment()
- stouputils.check.rules module