Merge pull request #275 from jasonacox/v0.15.1

v0.15.1 - Code Quality and Build Pipeline Improvements

Author: jasonacox

.github/workflows/check-protobuf.yml

@@ -0,0 +1,42 @@
+name: Check Protobuf
+
+on:
+  push:
+    paths:
+      - '**.proto'
+      - '**_pb2.py'
+  pull_request:
+    paths:
+      - '**.proto'
+      - '**_pb2.py'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  check-protobuf:
+    name: "Verify pb2 files are up to date"
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install pinned protobuf tools
+        run: pip install -r tools/requirements-tools.txt
+
+      - name: Regenerate protobuf files
+        run: bash tools/gen_proto.sh
+
+      - name: Check for uncommitted changes
+        run: |
+          git diff --exit-code -- '**/*_pb2.py' || {
+            echo ""
+            echo "ERROR: pb2 files are out of date with their .proto sources."
+            echo "Run the protoc commands above locally and commit the updated pb2 files."
+            exit 1
+          }

.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+repos:
+  - repo: local
+    hooks:
+      - id: protoc-gen
+        name: Regenerate protobuf Python files
+        language: script
+        entry: tools/gen_proto.sh
+        files: \.proto$
+        pass_filenames: false
+        # Requires: pip install -r tools/requirements-tools.txt
+
+      - id: pylint-pypowerwall
+        name: Pylint (pypowerwall errors)
+        language: system
+        entry: pylint -E pypowerwall/
+        files: ^pypowerwall/.*\.py$
+        pass_filenames: false
+
+      - id: pylint-proxy
+        name: Pylint (proxy errors)
+        language: system
+        entry: pylint -E proxy/*.py
+        files: ^proxy/.*\.py$
+        pass_filenames: false

.pylintrc

@@ -1,3 +1,7 @@
+[MASTER]
+# Ignore auto-generated protobuf files
+ignore-paths = .*_pb2\.py$
+
 [MESSAGES CONTROL]
 disable=consider-iterating-dictionary, consider-swap-variables, consider-using-enumerate, cyclic-import, consider-using-max-builtin, no-else-continue, consider-using-min-builtin, consider-using-in, super-with-arguments, protected-access, import-outside-toplevel, multiple-statements, unidiomatic-typecheck, no-else-break, import-error, invalid-name, missing-docstring, no-else-return, no-member, too-many-lines, line-too-long, too-many-ancestors, too-many-arguments, too-many-branches, too-many-instance-attributes, too-many-locals, too-many-nested-blocks, too-many-return-statements, too-many-statements, too-few-public-methods, ungrouped-imports, use-dict-literal, superfluous-parens, fixme, consider-using-f-string, bare-except, broad-except, unused-variable, unspecified-encoding, redefined-builtin, consider-using-dict-items, redundant-u-string-prefix, useless-object-inheritance, wrong-import-position, logging-not-lazy, logging-fstring-interpolation, wildcard-import, logging-format-interpolation
 

RELEASE.md

@@ -1,5 +1,17 @@
 # RELEASE NOTES
 
+## v0.15.1 - Code Quality and Build Pipeline Improvements
+
+* Fix: Remove duplicate stub methods `get_grid_charging()` and `get_grid_export()` in `pypowerwall_tedapi.py` that were left over from a merge — the real implementations (reading/writing config via v1r transport) were already present and being shadowed
+* Fix: Update `pwsimulator` `stub.py` to use `ssl.SSLContext` API replacing the removed `ssl.wrap_socket()` call, which caused the simulator container to silently exit on Python 3.12+
+* Fix: Remove `linux/arm/v7` platform from `pwsimulator` Docker build (`upload.sh`) — platform is no longer supported
+* Fix: Correct protobuf runtime dependency — `protobuf>=3.20.0` was misleading; pb2 files generated with 4.25.x require `protobuf>=4.25.1,<5`
+* Add: `.pylintrc` with `[MESSAGES CONTROL]` disable list (restored), `[SIMILARITIES]` config, and `ignore-paths` to skip auto-generated `*_pb2.py` files
+* Add: `tools/gen_proto.sh` — script to regenerate all `*_pb2.py` files from `.proto` sources using pinned `grpcio-tools`
+* Add: `tools/requirements-tools.txt` — pinned dev tools (`grpcio-tools<1.64`, `protobuf<5`) to ensure pb2 files are generated consistently with a compatible protobuf version
+* Add: `.pre-commit-config.yaml` — pre-commit hooks for protobuf regeneration and `pylint -E` checks on `pypowerwall/` and `proxy/` before every commit
+* Add: `.github/workflows/check-protobuf.yml` — CI workflow to verify committed `*_pb2.py` files are in sync with their `.proto` sources
+
 ## v0.15.0 - Powerwall 3 Wired LAN TEDAPI Support (v1r)
 
 * Docs: Note FleetAPI/Cloud mode requirement for `get_grid_charging()` and `get_grid_export()` - by @jasonacox-sam in https://github.com/jasonacox/pypowerwall/pull/268

proxy/.dockerignore

@@ -19,7 +19,6 @@ tedapi_rsa_*
 upload.sh
 upload-beta.sh
 .beta_version
-beta.txt
 perf_test.py
 localtest.sh
 testproxy.sh

proxy/requirements.txt

@@ -1,2 +1,2 @@
-pypowerwall==0.15.0
+pypowerwall==0.15.1
 bs4==0.0.2

pwsimulator/stub.py

@@ -38,7 +38,7 @@
     print("Warning: tedapi_pb2 not found - TEDAPI protobuf support disabled", flush=True)
     TEDAPI_ENABLED = False
 
-version_tuple = (0, 2, 4)
+version_tuple = (0, 2, 5)
 version = __version__ = '%d.%d.%d' % version_tuple
 __author__ = 'jasonacox'
 
@@ -727,13 +727,11 @@ def do_test_endpoint(self):
 
 # noinspection PyBroadException
 try:
-    # noinspection PyTypeChecker
     with ThreadingHTTPServer(server_address, Handler) as server:
-        server.socket = ssl.wrap_socket(server.socket,
-                                        server_side=True,
-                                        certfile='localhost.pem',
-                                        ssl_version=ssl.PROTOCOL_TLS)
+        context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
+        context.load_cert_chain(certfile='localhost.pem')
+        server.socket = context.wrap_socket(server.socket, server_side=True)
         print("Server configured to handle multiple simultaneous connections", flush=True)
         server.serve_forever()
-except Exception:
-    print(' CANCEL \n')
+except Exception as e:
+    print(f' CANCEL: {e}\n')

pypowerwall/__init__.py

@@ -89,7 +89,7 @@
 from json import JSONDecodeError
 from typing import Optional, Union
 
-version_tuple = (0, 15, 0)
+version_tuple = (0, 15, 1)
 version = __version__ = '%d.%d.%d' % version_tuple
 __author__ = 'jasonacox'
 

pypowerwall/local/tesla_pb2.py

@@ -464,7 +464,7 @@ def schedule_max_backup(self, duration_seconds=7200):
         try:
             # Must cancel any existing (active or expired) before scheduling new
             self.cancel_max_backup()
-            from google.protobuf.timestamp_pb2 import Timestamp
+            from google.protobuf.timestamp_pb2 import Timestamp  # pylint: disable=no-name-in-module
             teg = combined_pb2.TEGMessages()
             req = teg.schedule_manual_backup_event_request
             req.scheduling_info.start_time.CopyFrom(Timestamp(seconds=int(time.time())))