Merge pull request #528 from ianmcorvidae/protobufs-mypy

Protobuf type interfaces for type-checking & undoing protobufs hack

Author: ianmcorvidae

.github/workflows/ci.yml

@@ -34,7 +34,9 @@ jobs:
           which meshtastic
           meshtastic --version
       - name: Run pylint
-        run: pylint meshtastic examples/ --ignore-patterns ".*_pb2.py$"
+        run: pylint meshtastic examples/ --ignore-patterns ".*_pb2.pyi?$"
+      - name: Check types with mypy
+        run: mypy meshtastic/
       - name: Run tests with pytest
         run: pytest --cov=meshtastic
       - name: Generate coverage report

bin/regen-protobufs.sh

@@ -4,8 +4,8 @@
 #gsed -i 's/import "\//import ".\//g' ./protobufs/meshtastic/*
 #gsed -i 's/package meshtastic;//g' ./protobufs/meshtastic/*
 
-./nanopb-0.4.7/generator-bin/protoc -I=protobufs --python_out ./ ./protobufs/meshtastic/*.proto
-./nanopb-0.4.7/generator-bin/protoc -I=protobufs --python_out ./meshtastic/ ./protobufs/nanopb.proto
+./nanopb-0.4.7/generator-bin/protoc -I=protobufs --python_out ./ --mypy_out ./ ./protobufs/meshtastic/*.proto
+./nanopb-0.4.7/generator-bin/protoc -I=protobufs --python_out ./meshtastic/ --mypy_out ./meshtastic/ ./protobufs/nanopb.proto
 
 # workaround for import bug in protoc https://github.com/protocolbuffers/protobuf/issues/1491#issuecomment-690618628
 

meshtastic/__main__.py

@@ -9,16 +9,15 @@
 import sys
 import time
 
-import pyqrcode
+import pyqrcode # type: ignore[import-untyped]
 import yaml
 from google.protobuf.json_format import MessageToDict
-from pubsub import pub
+from pubsub import pub # type: ignore[import-untyped]
 
 import meshtastic.test
 import meshtastic.util
-from meshtastic import channel_pb2, config_pb2, portnums_pb2, remote_hardware
+from meshtastic import channel_pb2, config_pb2, portnums_pb2, remote_hardware, BROADCAST_ADDR
 from meshtastic.version import get_active_version
-from meshtastic.__init__ import BROADCAST_ADDR
 from meshtastic.ble_interface import BLEInterface
 from meshtastic.globals import Globals
 
@@ -147,7 +146,7 @@ def setPref(config, comp_name, valStr) -> bool:
 
     objDesc = config.DESCRIPTOR
     config_type = objDesc.fields_by_name.get(name[0])
-    pref = False
+    pref = None
     if config_type and config_type.message_type is not None:
         pref = config_type.message_type.fields_by_name.get(snake_name)
     # Others like ChannelSettings are standalone