python-linters 0.2.0__py3-none-any.whl

python_linters/references/ty.reference.toml

@@ -0,0 +1,203 @@
+# ============================================================================
+# ty Reference Configuration
+# ============================================================================
+#
+# Canonical rule table for new Python projects. Every rule ty 0.0.90 knows is
+# listed below, one line each, with no `all = "error"` base. Each line is
+# "error" or "ignore". A "warn" setting is never used, because a warning
+# does not fail a CI gate, so a green run hides it.
+#
+# Three sections: the ignored rules, each under a comment giving its triage
+# reason. Then the rules ty turns off by default that this file turns on.
+# Then the rules ty already enables, alphabetical, without comments.
+#
+# Copy this table as-is:
+#   - into a project's own `ty.toml` (as the top-level `[rules]` table), or
+#   - into `pyproject.toml` under `[tool.ty.rules]` (rename the table header,
+#     keep every line).
+#
+# Last triaged against: ty 0.0.90 (140 rules: 97 error-by-default,
+# 25 warn-by-default, 18 ignore-by-default).
+#
+# Re-check the copied table after every ty version bump:
+#   python-linters check-config ty <path/to/ty.toml>
+# It reports rules ty knows that the table omits (untriaged) and rules the
+# table names that ty no longer knows (stale), and exits non-zero on either.
+# ============================================================================
+
+[rules]
+
+# --- Ignored rules: each carries its triage reason -------------------------
+
+# not applicable: checks PEP 484's legacy `__`-prefixed positional-only
+# parameters, obsolete since PEP 570's `/` (Python 3.8).
+invalid-legacy-positional-parameter = "ignore"
+
+# not applicable: a no-op unless `TY_UV=1` is set and uv >= 0.12 supplies
+# dependency metadata. Re-triage when a project opts in.
+missing-direct-dependency = "ignore"
+
+# false positives: ty's flow narrowing ignores a concurrent task mutating an
+# instance attribute across an `await`. So it reports a check on that
+# attribute after the `await` as always true or always false.
+redundant-condition-strict = "ignore"
+
+# false positives: ty infers an empty literal (`[]`, `{}`, `set()`) as
+# `list[Unknown]` etc. and rejects it against `Sequence`, `Mapping`,
+# `AbstractSet`. The only per-site fix is code shaped for the checker
+# (`list[Path]()` instead of `[]`), and code never changes only because ty
+# cannot infer a type.
+# cost: an `Any` reaching a typed name (argparse attributes,
+# `re.Match.group()`) goes unflagged.
+# Re-triage on each ty bump: ty is 0.0.x and its inference changes.
+unsound-assignment = "ignore"
+unsound-return-statement = "ignore"
+unsound-yield = "ignore"
+
+# not applicable: checks classes built with `type()`, which the doctrine
+# does not use. Astral calls the rule noisy on dynamic `type()` code.
+unsupported-dynamic-base = "ignore"
+
+# --- Enabled although off by default in ty --------------------------------
+
+# off by default for false-positive volume. On here until a triage shows
+# that volume, then they move to the ignored section with the evidence.
+division-by-zero = "error"
+possibly-missing-attribute = "error"
+possibly-missing-import = "error"
+possibly-unresolved-reference = "error"
+
+# opt-in strictness: astral keeps these off as stricter than most projects
+# want. This file wants that strictness.
+blanket-ignore-comment = "error"
+disjoint-cast = "error"
+dynamic-function-decorator-return = "error"
+mismatched-sentinel-name = "error"
+missing-override-decorator = "error"
+missing-type-argument = "error"
+truthiness-test-of-none-union = "error"
+
+# --- Enforced rules: on by default in ty, alphabetical ----------------------
+
+abstract-and-final-method = "error"
+abstract-method-in-final-class = "error"
+ambiguous-protocol-member = "error"
+assert-type-unspellable-subtype = "error"
+call-abstract-method = "error"
+call-non-callable = "error"
+call-top-callable = "error"
+conflicting-declarations = "error"
+conflicting-metaclass = "error"
+cyclic-class-definition = "error"
+cyclic-type-alias-definition = "error"
+dataclass-field-order = "error"
+deprecated = "error"
+duplicate-base = "error"
+duplicate-kw-only = "error"
+empty-body = "error"
+escape-character-in-forward-annotation = "error"
+experimental-syntax = "error"
+final-on-non-method = "error"
+final-without-value = "error"
+ignore-comment-unknown-rule = "error"
+implicit-concatenated-string-type-annotation = "error"
+inconsistent-mro = "error"
+index-out-of-bounds = "error"
+ineffective-final = "error"
+instance-layout-conflict = "error"
+invalid-argument-type = "error"
+invalid-assignment = "error"
+invalid-attribute-access = "error"
+invalid-attribute-override = "error"
+invalid-await = "error"
+invalid-base = "error"
+invalid-context-manager = "error"
+invalid-dataclass = "error"
+invalid-dataclass-override = "error"
+invalid-declaration = "error"
+invalid-enum-member-annotation = "error"
+invalid-exception-caught = "error"
+invalid-explicit-override = "error"
+invalid-frozen-dataclass-subclass = "error"
+invalid-generic-class = "error"
+invalid-generic-enum = "error"
+invalid-ignore-comment = "error"
+invalid-init-type-variable = "error"
+invalid-key = "error"
+invalid-legacy-type-variable = "error"
+invalid-match-pattern = "error"
+invalid-metaclass = "error"
+invalid-method-override = "error"
+invalid-module-getattr-call = "error"
+invalid-mutable-override = "error"
+invalid-named-tuple = "error"
+invalid-named-tuple-override = "error"
+invalid-newtype = "error"
+invalid-overload = "error"
+invalid-parameter-default = "error"
+invalid-paramspec = "error"
+invalid-property-type-override = "error"
+invalid-protocol = "error"
+invalid-raise = "error"
+invalid-return-type = "error"
+invalid-super-argument = "error"
+invalid-syntax-in-forward-annotation = "error"
+invalid-total-ordering = "error"
+invalid-type-alias-type = "error"
+invalid-type-arguments = "error"
+invalid-type-checking-constant = "error"
+invalid-type-form = "error"
+invalid-type-guard-definition = "error"
+invalid-type-variable-bound = "error"
+invalid-type-variable-constraints = "error"
+invalid-type-variable-default = "error"
+invalid-typed-dict-field = "error"
+invalid-typed-dict-header = "error"
+invalid-typed-dict-statement = "error"
+invalid-yield = "error"
+isinstance-against-protocol = "error"
+isinstance-against-typed-dict = "error"
+mismatched-type-name = "error"
+missing-argument = "error"
+missing-slot = "error"
+missing-typed-dict-key = "error"
+no-matching-overload = "error"
+non-callable-init-subclass = "error"
+not-iterable = "error"
+not-subscriptable = "error"
+override-of-final-method = "error"
+override-of-final-variable = "error"
+parameter-already-assigned = "error"
+positional-only-parameter-as-kwarg = "error"
+possibly-missing-implicit-call = "error"
+possibly-missing-submodule = "error"
+pydantic-discarded-extra-argument = "error"
+raw-string-type-annotation = "error"
+redundant-cast = "error"
+redundant-condition = "error"
+redundant-final-classvar = "error"
+shadowed-type-variable = "error"
+static-assert-error = "error"
+subclass-of-dataclass-with-order = "error"
+subclass-of-final-class = "error"
+super-call-in-named-tuple-method = "error"
+too-many-positional-arguments = "error"
+truthiness-test-of-callable = "error"
+truthiness-test-of-iterable = "error"
+type-assertion-failure = "error"
+unavailable-implicit-super-arguments = "error"
+unbound-type-variable = "error"
+undefined-reveal = "error"
+unknown-argument = "error"
+unresolved-attribute = "error"
+unresolved-global = "error"
+unresolved-import = "error"
+unresolved-reference = "error"
+unsupported-base = "error"
+unsupported-bool-conversion = "error"
+unsupported-operator = "error"
+unused-awaitable = "error"
+unused-ignore-comment = "error"
+unused-type-ignore-comment = "error"
+useless-overload-body = "error"
+zero-stepsize-in-slice = "error"

python_linters/tool_errors.py

@@ -0,0 +1,44 @@
+"""Shared subprocess-failure handling for every external tool this package runs."""
+
+from __future__ import annotations
+
+import subprocess
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+
+class ToolFailedError(Exception):
+    """An external tool exited with a code outside its accepted set.
+
+    Raised at the boundary where the subprocess result is read, so the
+    interior (grouping, config comparison, ...) never has to distinguish
+    "0 findings" from "the tool crashed and printed nothing".
+    """
+
+    def __init__(self, tool: str, stderr: str) -> None:
+        self.tool = tool
+        self.stderr = stderr
+        super().__init__(f"{tool} failed:\n{stderr}")
+
+
+def run_checked(
+    cmd: list[str],
+    cwd: Path,
+    tool: str,
+    ok_codes: tuple[int, ...] = (0,),
+    env: dict[str, str] | None = None,
+) -> subprocess.CompletedProcess[str]:
+    """Run cmd, raising ToolFailedError unless its exit code is in ok_codes.
+
+    env=None (the default) inherits this process's environment, same as
+    subprocess.run's own default. Callers pass an explicit env when the
+    inherited one would steer the tool wrong (see run_ty's VIRTUAL_ENV fix).
+    """
+    result = subprocess.run(  # ruff: ignore[subprocess-without-shell-equals-true]  # cmd is a fixed argv list built by this package, never shell-interpolated or from untrusted input
+        cmd, cwd=cwd, capture_output=True, text=True, check=False, env=env
+    )
+    if result.returncode not in ok_codes:
+        raise ToolFailedError(tool, result.stderr)
+    return result

python_linters-0.2.0.dist-info/METADATA

@@ -0,0 +1,44 @@
+Metadata-Version: 2.4
+Name: python-linters
+Version: 0.2.0
+Summary: Run ruff, ty and pymodularity on a Python project and print one JSON report grouped by rule.
+Author: Tilo Himmelsbach
+License-Expression: MIT
+Requires-Dist: ruff==0.17.3
+Requires-Dist: ty==0.0.90
+Requires-Dist: pymodularity==0.5.0
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# python-linters
+
+Run ruff, ty and pymodularity on a Python project and print one JSON report
+grouped by rule, for agents and CI to read.
+
+## Install
+
+As a dev dependency of the project you want to lint:
+
+```
+uv add --dev python-linters
+```
+
+## Commands
+
+- `uv run python-linters lint [path] [--out FILE]` — runs ruff, ty and
+  pymodularity (default path: `.`) and prints the merged JSON report to
+  stdout, or writes it to `FILE` with `--out`.
+- `uv run python-linters reference ruff|ty` — prints this package's shipped
+  reference config for the given tool to stdout. The package never writes
+  it into your project — copying it into `ruff.toml`/`ty.toml` (or
+  `pyproject.toml`) stays with you.
+- `uv run python-linters check-config ruff|ty <path/to/config>` — compares
+  your copy against the pinned tool's current rule set: rules the tool
+  knows that your config omits (untriaged), and rules your config names
+  that the tool no longer knows (stale).
+
+## Exit codes
+
+- `lint`: 0 clean, 1 findings, 2 any tool failure (named on stderr).
+- `check-config`: 0 up to date, 1 untriaged or stale rules found, 2 tool
+  failure.

python_linters-0.2.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+python_linters/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+python_linters/__main__.py,sha256=Xkx-N0S-OWOvqBBgDA0HgCwrW324UrwBEQbR8PUayJI,158
+python_linters/cli_commands.py,sha256=tVneEJJd6bgBrzunto3UJoEJHupwc5wNjMfTGwFCmN0,3122
+python_linters/config_check.py,sha256=Tj92OWNaVcQ81SXiN13pMfbvFctI1iJnzF0sK5JqU6s,14401
+python_linters/lint_report.py,sha256=GfEowFIJx4BOQtSnjya2k31w_wVumscix-NB4yAN0qs,10340
+python_linters/reference_files.py,sha256=pD0fGW-PJiV09LFIy9-hZKD7EVmHIUjkE3SfD-NeiI4,764
+python_linters/references/ruff.reference.toml,sha256=1nzYkfphwmJdUPBo6WIg3DbuVfCvvVDxf17jcX6GIAY,28330
+python_linters/references/ty.reference.toml,sha256=674u63jOImBHrY92lAa27ZcilevZj6GSqxWywp6kQTw,7677
+python_linters/tool_errors.py,sha256=Fw3byFD0kk8QKJQg85weKB11_CRrnu2h_N2XQId6Abc,1572
+python_linters-0.2.0.dist-info/WHEEL,sha256=3NO1oYsF7mANFUWVdyEQLM-zmecczWWEmmF5rEbXrWk,80
+python_linters-0.2.0.dist-info/entry_points.txt,sha256=2qemc7DiLCP7wVNw-8KENf-v5L62Jx40tHgVXC0s_FM,65
+python_linters-0.2.0.dist-info/METADATA,sha256=AocHZGXEE-8jYTT1bwXE9gJJCw--ZwJQ5_xQ2rzNqig,1497
+python_linters-0.2.0.dist-info/RECORD,,

python_linters-0.2.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.13.6
+Root-Is-Purelib: true
+Tag: py3-none-any

python_linters-0.2.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+python-linters = python_linters.__main__:main
+