violet-poolController-api 0.0.37__tar.gz → 0.0.38__tar.gz

{violet_poolcontroller_api-0.0.37/violet_poolController_api.egg-info → violet_poolcontroller_api-0.0.38}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: violet-poolController-api
-Version: 0.0.37
+Version: 0.0.38
 Summary: Asynchronous Python client for the Violet Pool Controller.
 Author-email: "Basti (Xerolux)" <git@xerolux.de>
 License-Expression: AGPL-3.0-or-later

{violet_poolcontroller_api-0.0.37 → violet_poolcontroller_api-0.0.38}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "violet-poolController-api"
-version = "0.0.37"
+version = "0.0.38"
 authors = [
   { name="Basti (Xerolux)", email="git@xerolux.de" },
 ]

{violet_poolcontroller_api-0.0.37 → violet_poolcontroller_api-0.0.38}/tests/test_api.py

@@ -1,4 +1,4 @@
-# violet-poolController-api - API für Violet Pool Controller
+# violet-poolController-api - API for Violet Pool Controller
 # Copyright (C) 2024-2026  Xerolux
 #
 # This program is free software: you can redistribute it and/or modify

violet_poolcontroller_api-0.0.38/tests/test_language_policy.py

@@ -0,0 +1,136 @@
+# violet-poolController-api - API for Violet Pool Controller
+# Copyright (C) 2024-2026  Xerolux
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+"""Everything written into this repository is English.
+
+The policy lives in AGENTS.md; this file is what makes it hold. Two things are
+deliberately exempt and must stay exempt: the controller's own error strings in
+``const_api.py`` (and the German payloads the mock server replays), which are
+data rather than prose, and the German half of the bilingual documentation
+under ``docs/de/``.
+"""
+
+# ruff: noqa: S101
+
+from __future__ import annotations
+
+import re
+from pathlib import Path
+
+import pytest
+
+REPO = Path(__file__).parent.parent
+PACKAGE = REPO / "violet_poolcontroller_api"
+
+# Text the controller emits, reproduced verbatim. Translating it would break
+# the match with what the device actually says.
+#
+# Matched by file name, not by path: `python -m build` copies the package into
+# `build/lib/`, and an exemption keyed to the original path does not cover the
+# copy. That is not hypothetical - it failed the 0.0.38 release job, because
+# the release builds the wheel before running the checks.
+CONTROLLER_VERBATIM = frozenset({"const_api.py", "mock_server.py"})
+
+# This file has to name the German words it looks for.
+SELF = Path(__file__).name
+
+# Directories that hold generated or vendored copies of the sources. Scanning
+# them says nothing about what is written in this repository.
+GENERATED_DIRS = frozenset({".git", ".tox", ".venv", "venv", "build", "dist", "__pycache__"})
+
+# Words that only appear in German prose. Deliberately not "in", "die" or "der":
+# those collide with English or with identifiers.
+GERMAN_WORDS = (
+    "für",
+    "über",
+    "nicht",
+    "wird",
+    "werden",
+    "wenn",
+    "diese",
+    "dieser",
+    "keine",
+    "sollte",
+)
+_GERMAN = re.compile(r"\b(" + "|".join(GERMAN_WORDS) + r")\b", re.IGNORECASE)
+
+
+def _python_sources() -> list[Path]:
+    """Return every Python file the policy applies to."""
+    return sorted(
+        path
+        for path in REPO.rglob("*.py")
+        if not (GENERATED_DIRS & set(path.parts))
+        and not any(part.endswith(".egg-info") for part in path.parts)
+        and path.name not in CONTROLLER_VERBATIM
+        and path.name != SELF
+    )
+
+
+@pytest.mark.parametrize("path", _python_sources(), ids=lambda p: p.name)
+def test_python_sources_are_english(path: Path) -> None:
+    """A German comment is read by people who do not speak German."""
+    offenders = [
+        f"{path.relative_to(REPO)}:{number}: {line.strip()}"
+        for number, line in enumerate(path.read_text(encoding="utf-8").splitlines(), 1)
+        if _GERMAN.search(line)
+    ]
+
+    assert not offenders, "German text outside the exempt files:\n" + "\n".join(offenders)
+
+
+def test_the_changelog_is_english() -> None:
+    """The changelog is what a consumer reads when a version breaks something.
+
+    Code spans are quotations, not prose: an entry that removes a German string
+    has to be able to name the string it removed.
+    """
+    changelog = (REPO / "CHANGELOG.md").read_text(encoding="utf-8")
+    prose = re.sub(r"`[^`]*`", "", changelog)
+
+    offenders = sorted({match.group(0).lower() for match in _GERMAN.finditer(prose)})
+
+    assert not offenders, f"German outside code spans in CHANGELOG.md: {offenders}"
+
+
+def test_the_controller_strings_stay_german() -> None:
+    """The exemption is the point, not an oversight - guard it too.
+
+    If someone "cleans up" the error table into English, the messages stop
+    matching what the device reports.
+    """
+    const_api = (PACKAGE / "const_api.py").read_text(encoding="utf-8")
+
+    assert "Filterdrucküberwachung (Druck zu niedrig)" in const_api
+
+
+def test_generated_copies_are_not_scanned() -> None:
+    """A built wheel is not source, and scanning its copy fails the release.
+
+    `python -m build` writes `build/lib/<package>/`, so the release job runs
+    the checks with a duplicate of every module on disk.
+    """
+    scanned = {path.name for path in _python_sources()}
+
+    assert "const_api.py" not in scanned
+    assert not [path for path in _python_sources() if "build" in path.parts]
+
+
+def test_the_policy_is_written_down() -> None:
+    """Without the rule in AGENTS.md this file is just an opinion."""
+    agents = (REPO / "AGENTS.md").read_text(encoding="utf-8")
+
+    assert "## Language Policy" in agents

{violet_poolcontroller_api-0.0.37 → violet_poolcontroller_api-0.0.38/violet_poolController_api.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: violet-poolController-api
-Version: 0.0.37
+Version: 0.0.38
 Summary: Asynchronous Python client for the Violet Pool Controller.
 Author-email: "Basti (Xerolux)" <git@xerolux.de>
 License-Expression: AGPL-3.0-or-later

{violet_poolcontroller_api-0.0.37 → violet_poolcontroller_api-0.0.38}/violet_poolController_api.egg-info/SOURCES.txt

@@ -4,6 +4,7 @@ pyproject.toml
 tests/test_api.py
 tests/test_api_smoke.py
 tests/test_circuit_breaker.py
+tests/test_language_policy.py
 tests/test_mock_server.py
 tests/test_parsers.py
 tests/test_rate_limiter.py

{violet_poolcontroller_api-0.0.37 → violet_poolcontroller_api-0.0.38}/violet_poolcontroller_api/__init__.py

@@ -1,4 +1,4 @@
-# violet-poolController-api - API für Violet Pool Controller
+# violet-poolController-api - API for Violet Pool Controller
 # Copyright (C) 2024-2026  Xerolux
 #
 # This program is free software: you can redistribute it and/or modify

{violet_poolcontroller_api-0.0.37 → violet_poolcontroller_api-0.0.38}/violet_poolcontroller_api/api.py

@@ -1,4 +1,4 @@
-# violet-poolController-api - API für Violet Pool Controller
+# violet-poolController-api - API for Violet Pool Controller
 # Copyright (C) 2024-2026  Xerolux
 #
 # This program is free software: you can redistribute it and/or modify

{violet_poolcontroller_api-0.0.37 → violet_poolcontroller_api-0.0.38}/violet_poolcontroller_api/circuit_breaker.py

@@ -1,4 +1,4 @@
-# violet-poolController-api - API für Violet Pool Controller
+# violet-poolController-api - API for Violet Pool Controller
 # Copyright (C) 2024-2026  Xerolux
 #
 # This program is free software: you can redistribute it and/or modify

{violet_poolcontroller_api-0.0.37 → violet_poolcontroller_api-0.0.38}/violet_poolcontroller_api/const_api.py

@@ -1,4 +1,4 @@
-# violet-poolController-api - API für Violet Pool Controller
+# violet-poolController-api - API for Violet Pool Controller
 # Copyright (C) 2024-2026  Xerolux
 #
 # This program is free software: you can redistribute it and/or modify

{violet_poolcontroller_api-0.0.37 → violet_poolcontroller_api-0.0.38}/violet_poolcontroller_api/const_devices.py

@@ -1,4 +1,4 @@
-# violet-poolController-api - API für Violet Pool Controller
+# violet-poolController-api - API for Violet Pool Controller
 # Copyright (C) 2024-2026  Xerolux
 #
 # This program is free software: you can redistribute it and/or modify

{violet_poolcontroller_api-0.0.37 → violet_poolcontroller_api-0.0.38}/violet_poolcontroller_api/parsers.py

@@ -1,4 +1,4 @@
-# violet-poolController-api - API für Violet Pool Controller
+# violet-poolController-api - API for Violet Pool Controller
 # Copyright (C) 2024-2026  Xerolux
 #
 # This program is free software: you can redistribute it and/or modify

{violet_poolcontroller_api-0.0.37 → violet_poolcontroller_api-0.0.38}/violet_poolcontroller_api/readings.py

@@ -1,4 +1,4 @@
-# violet-poolController-api - API für Violet Pool Controller
+# violet-poolController-api - API for Violet Pool Controller
 # Copyright (C) 2024-2026  Xerolux
 #
 # This program is free software: you can redistribute it and/or modify

{violet_poolcontroller_api-0.0.37 → violet_poolcontroller_api-0.0.38}/violet_poolcontroller_api/utils_rate_limiter.py

@@ -1,4 +1,4 @@
-# violet-poolController-api - API für Violet Pool Controller
+# violet-poolController-api - API for Violet Pool Controller
 # Copyright (C) 2024-2026  Xerolux
 #
 # This program is free software: you can redistribute it and/or modify
@@ -14,7 +14,7 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
-"""Rate Limiter für API-Requests - Token Bucket Algorithm."""
+"""Rate limiter for API requests - token bucket algorithm."""
 
 from __future__ import annotations
 
@@ -34,8 +34,8 @@ class RateLimiter:
 
     Verhindert API-Overload durch:
     - Maximale Requests pro Zeitfenster
-    - Burst-Support für kurzzeitige Spitzen
-    - Priority Queue für kritische Requests
+    - Burst support for short spikes
+    - Priority queue for critical requests
     - Graceful Degradation bei Limit-Überschreitung
     """
 
@@ -89,7 +89,7 @@ class RateLimiter:
             "last_minute_reset": time.monotonic(),
         }
 
-        # Lock für Thread-Safety
+        # Lock for thread safety
         self._lock = asyncio.Lock()
         self._waiters: list[tuple[int, int, asyncio.Event]] = []
         self._waiter_sequence = 0
@@ -169,7 +169,7 @@ class RateLimiter:
             timeout: Maximale Wartezeit in Sekunden
 
         Raises:
-            TimeoutError: Wenn Timeout erreicht
+            TimeoutError: If the timeout is reached
 
         """
         start_time = time.monotonic()
@@ -279,7 +279,7 @@ class RateLimiter:
         _LOGGER.debug("Rate Limiter zurückgesetzt")
 
 
-# Global Rate Limiter-Instanz (kann pro API-Instanz auch separat erstellt werden)
+# Global rate limiter instance (one can also be created per API instance)
 _global_rate_limiter: RateLimiter | None = None
 
 

{violet_poolcontroller_api-0.0.37 → violet_poolcontroller_api-0.0.38}/violet_poolcontroller_api/utils_sanitizer.py

@@ -1,4 +1,4 @@
-# violet-poolController-api - API für Violet Pool Controller
+# violet-poolController-api - API for Violet Pool Controller
 # Copyright (C) 2024-2026  Xerolux
 #
 # This program is free software: you can redistribute it and/or modify
@@ -15,7 +15,7 @@
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 
-"""Input Sanitization Utilities für User-Inputs und API-Parameter."""
+"""Input sanitization utilities for user inputs and API parameters."""
 
 from __future__ import annotations
 
@@ -33,11 +33,11 @@ _MAX_API_PARAM_LENGTH = 100
 
 
 class InputSanitizer:
-    """Input Sanitization für Sicherheit und Datenintegrität.
+    """Input sanitization for security and data integrity.
 
     Schützt vor:
     - XSS (Cross-Site Scripting)
-    - SQL Injection (nicht relevant bei HTTP API, aber defensiv)
+    - SQL injection (not relevant for an HTTP API, but defended against)
     - Command Injection
     - Path Traversal
     - Unerwarteten Zeichen
@@ -85,14 +85,14 @@ class InputSanitizer:
         # Konvertiere zu String
         str_value = str(value).strip()
 
-        # Unicode-Normalisierung (NFKD für Defense-in-Depth)
+        # Unicode normalisation (NFKD, defence in depth)
         # Normalized Form Compatibility Decomposition
         str_value = unicodedata.normalize("NFKD", str_value)
 
         # Längen-Validierung
         if len(str_value) > max_length:
             _LOGGER.warning(
-                "String zu lang (%d > %d), wird gekürzt: %s...",
+                "String too long (%d > %d), truncating: %s...",
                 len(str_value),
                 max_length,
                 str_value[:50],
@@ -233,7 +233,7 @@ class InputSanitizer:
             float_value = float(value)
             if not math.isfinite(float_value):
                 _LOGGER.warning(
-                    "Nicht-endlicher Float-Wert '%s', verwende default %.2f",
+                    "Non-finite float value '%s', using default %.2f",
                     value,
                     default,
                 )
@@ -315,7 +315,7 @@ class InputSanitizer:
 
         """
         if not key:
-            msg = "Device-Key darf nicht leer sein"
+            msg = "Device key must not be empty"
             raise ValueError(msg)
 
         # Nur Großbuchstaben, Zahlen und Underscore erlaubt
@@ -351,7 +351,7 @@ class InputSanitizer:
 
         """
         if not param:
-            msg = "API-Parameter darf nicht leer sein"
+            msg = "API parameter must not be empty"
             raise ValueError(msg)
 
         # Prüfe auf Path Traversal VOR der Bereinigung
@@ -458,27 +458,27 @@ class InputSanitizer:
         )
 
 
-# Singleton-Instanz für einfachen Zugriff
+# Singleton instance for convenient access
 _sanitizer = InputSanitizer()
 
 
 def sanitize_string(*args: Any, **kwargs: Any) -> str:  # noqa: ANN401
-    """Shortcut für InputSanitizer.sanitize_string()."""
+    """Shortcut for InputSanitizer.sanitize_string()."""
     return _sanitizer.sanitize_string(*args, **kwargs)
 
 
 def sanitize_integer(*args: Any, **kwargs: Any) -> int:  # noqa: ANN401
-    """Shortcut für InputSanitizer.sanitize_integer()."""
+    """Shortcut for InputSanitizer.sanitize_integer()."""
     return _sanitizer.sanitize_integer(*args, **kwargs)
 
 
 def sanitize_float(*args: Any, **kwargs: Any) -> float:  # noqa: ANN401
-    """Shortcut für InputSanitizer.sanitize_float()."""
+    """Shortcut for InputSanitizer.sanitize_float()."""
     return _sanitizer.sanitize_float(*args, **kwargs)
 
 
 def sanitize_boolean(*args: Any, **kwargs: Any) -> bool:  # noqa: ANN401
-    """Shortcut für InputSanitizer.sanitize_boolean()."""
+    """Shortcut for InputSanitizer.sanitize_boolean()."""
     return _sanitizer.sanitize_boolean(*args, **kwargs)