Readd ruff check for scripts, but allow print and missing docstring (#316)

* Reorder lint settings in ruff.toml to match order in HA-pyproject.toml
* Also adds the pydocstyle and pytest-style-mark-parentheses = false (both from HA)

Author: steinmn

.github/workflows/validate.yaml

@@ -48,9 +48,7 @@ jobs:
         uses: astral-sh/ruff-action@v3
         with:
           args: check --exit-zero # succeed despite errors until https://github.com/custom-components/zaptec/issues/258 is done
-          src: >-
-            custom_components/zaptec
-            tests
+          src: "."
 
   manifest-requirements:
     name: Manifest requirements validation

.ruff.toml

@@ -3,12 +3,6 @@
 target-version = "py313"
 line-length = 98
 
-[lint.per-file-ignores]
-"tests/**/*.py" = [
-    "S101",  # Allow assert in tests
-    "INP001",  # Don't complain over missing __init__.py in test dirs
-]
-
 [lint]
 select = [
     "ALL",
@@ -49,14 +43,29 @@ ignore = [
 
 [lint.flake8-pytest-style]
 fixture-parentheses = false
+mark-parentheses = false
 
 [lint.pyupgrade]
 keep-runtime-typing = true
 
-[lint.mccabe]
-max-complexity = 25
-
 [lint.isort]
 force-sort-within-sections = true
 combine-as-imports = true
 split-on-trailing-comma = false
+
+[lint.per-file-ignores]
+"tests/**/*.py" = [
+    "S101",  # Allow assert in tests
+    "INP001",  # Don't complain over missing __init__.py in test dirs
+]
+"scripts/*" = [
+    "D103",  # Don't complain over missing docstrings in scripts
+    "T201",  # Allow for scripts to write to stdout
+]
+
+[lint.mccabe]
+max-complexity = 25
+
+[lint.pydocstyle]
+convention = "google"
+property-decorators = ["propcache.api.cached_property"]

scripts/check_requirements.py

@@ -18,23 +18,23 @@
 PYPI_URL = "https://pypi.org/pypi/{package}/json"
 
 
-def load_manifest_requirements() -> list[Requirement]:  # noqa: D103 (disable docstrings requirement)
+def load_manifest_requirements() -> list[Requirement]:
     with MANIFEST.open() as f:
         manifest = json.load(f)
         reqs: list[str] = manifest.get("requirements", [])
         return [Requirement(req) for req in reqs]
 
 
-def load_minimum_ha_version() -> Version:  # noqa: D103
+def load_minimum_ha_version() -> Version:
     with HACS.open() as f:
         hacs = json.load(f)
         return Version(hacs.get("homeassistant", None))
 
 
-def load_relevant_constraints(url: str, reqs: list[Requirement]) -> dict[str, Requirement]:  # noqa: D103
+def load_relevant_constraints(url: str, reqs: list[Requirement]) -> dict[str, Requirement]:
     names = [req.name for req in reqs]
     constraints: dict[str, Requirement] = {}
-    with urllib.request.urlopen(url) as response:
+    with urllib.request.urlopen(url) as response:  # noqa: S310 (ignore suspicious-url-open-usage since url is hardcoded https)
         for raw_line in response:
             line = raw_line.decode().strip()
             if not line or line.startswith("#"):
@@ -46,11 +46,11 @@ def load_relevant_constraints(url: str, reqs: list[Requirement]) -> dict[str, Re
     return constraints
 
 
-def get_pypi_versions_for_package(package: str) -> list[Version]:  # noqa: D103
+def get_pypi_versions_for_package(package: str) -> list[Version]:
     url = PYPI_URL.format(package=package)
 
     versions: list[Version] = []
-    with urllib.request.urlopen(url) as resp:
+    with urllib.request.urlopen(url) as resp:  # noqa: S310
         data = json.load(resp)
 
         for v in data.get("releases", {}):
@@ -61,14 +61,14 @@ def get_pypi_versions_for_package(package: str) -> list[Version]:  # noqa: D103
     return versions
 
 
-def get_pypi_versions(packages: list[str]) -> dict[str, list[Version]]:  # noqa: D103
+def get_pypi_versions(packages: list[str]) -> dict[str, list[Version]]:
     versions: dict[str, list[Version]] = {}
     for package in packages:
         versions[package] = get_pypi_versions_for_package(package)
     return versions
 
 
-def check_compatibility(  # noqa: D103
+def check_compatibility(
     requirements: list[Requirement],
     constraints: dict[str, Requirement],
     pypi_lib: dict[str, list[Version]],
@@ -94,13 +94,13 @@ def check_compatibility(  # noqa: D103
     return errors
 
 
-def get_ha_tags() -> list[str]:  # noqa: D103
+def get_ha_tags() -> list[str]:
     tags = []
     page = 1
     last_page = 3
     while page <= last_page:
         url = f"{HA_RELEASES_URL}?per_page=100&page={page}"
-        with urllib.request.urlopen(url) as resp:
+        with urllib.request.urlopen(url) as resp:  # noqa: S310
             data = json.load(resp)
         if not data:
             break
@@ -116,7 +116,7 @@ def get_ha_tags() -> list[str]:  # noqa: D103
     return sorted(versions, reverse=True)
 
 
-def get_constraints_url(version: str = "") -> str:  # noqa: D103
+def get_constraints_url(version: str = "") -> str:
     return CONSTRAINTS_URL.format(v=version if version else "dev")
 
 

scripts/lint

@@ -7,10 +7,10 @@ cd "$(dirname "$0")/.."
 if [ "$1" = "ci" ]; then
     # Don't try to fix errors, just fail
     ruff format . --diff
-    ruff check custom_components/zaptec --exit-zero # succeed despite errors until https://github.com/custom-components/zaptec/issues/258 is done
+    ruff check . --exit-zero # succeed despite errors until https://github.com/custom-components/zaptec/issues/258 is done
     # ruff check .
 else
     # Auto-fix as much as possible
     ruff format .
-    ruff check custom_components/zaptec --fix
+    ruff check . --fix
 fi