Clean up various warnings (#304)

* Clean up various warnings

* Clean up various warnings

.github/labels.yml

@@ -36,7 +36,7 @@
   color: 7057ff
 - name: help wanted
   description: Extra attention is needed
-  color: 008672
+  color: "008672"
 - name: invalid
   description: This doesn't seem right
   color: e4e669

.github/workflows/tests.yml

@@ -6,7 +6,7 @@ on:
 
 jobs:
   tests:
-    name: ${{ matrix.session }} ${{ matrix.python }} / ${{ matrix.os }}
+    name: "${{ matrix.session }} ${{ matrix.python }} / ${{ matrix.os }}"
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
@@ -93,7 +93,7 @@ jobs:
         if: matrix.session == 'pre-commit'
         with:
           path: ~/.cache/pre-commit
-          key: ${{ steps.pre-commit-cache.outputs.result }}-${{ hashFiles('.pre-commit-config.yaml') }}
+          key: "${{ steps.pre-commit-cache.outputs.result }}-${{ hashFiles('.pre-commit-config.yaml') }}"
           restore-keys: |
             ${{ steps.pre-commit-cache.outputs.result }}-
 

docs/conf.py

@@ -2,7 +2,7 @@
 
 project = "Gridworks Protocol"
 author = "Jessica Millar"
-copyright = "2022, Jessica Millar"
+copyright = "2022, Jessica Millar"  # noqa
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.napoleon",

src/gwproto/data_classes/component.py

@@ -10,11 +10,12 @@
 
 class Component(ABC, StreamlinedSerializerMixin):
     by_id: Dict[str, "Component"] = {}
-    base_props = []
-    base_props.append("component_id")
-    base_props.append("display_name")
-    base_props.append("component_attribute_class_id")
-    base_props.append("hw_uid")
+    base_props = [
+        "component_id",
+        "display_name",
+        "component_attribute_class_id",
+        "hw_uid",
+    ]
 
     def __new__(cls, component_id, *args, **kwargs):
         try:

src/gwproto/data_classes/component_attribute_class.py

@@ -10,9 +10,7 @@
 class ComponentAttributeClass(ABC, StreamlinedSerializerMixin):
     by_id: Dict[str, "ComponentAttributeClass"] = {}
 
-    base_props = []
-    base_props.append("component_attribute_class_id")
-    base_props.append("display_name")
+    base_props = ["component_attribute_class_id", "display_name"]
 
     def __new__(cls, component_attribute_class_id, *args, **kwargs):
         try:

src/gwproto/enums/actor_class.py

@@ -148,7 +148,7 @@ def value_to_symbol(cls, value: str) -> str:
         Provides the encoding symbol for a ActorClass enum to send in seriliazed messages.
 
         Args:
-            symbol (str): The candidate value.
+            value (str): The candidate value.
 
         Returns:
             str: The symbol encoding that value. If the value is not recognized -

src/gwproto/enums/local_comm_interface.py

@@ -111,7 +111,7 @@ def value_to_symbol(cls, value: str) -> str:
         Provides the encoding symbol for a LocalCommInterface enum to send in seriliazed messages.
 
         Args:
-            symbol (str): The candidate value.
+            value (str): The candidate value.
 
         Returns:
             str: The symbol encoding that value. If the value is not recognized -

src/gwproto/enums/make_model.py

@@ -156,7 +156,7 @@ def value_to_symbol(cls, value: str) -> str:
         Provides the encoding symbol for a MakeModel enum to send in seriliazed messages.
 
         Args:
-            symbol (str): The candidate value.
+            value (str): The candidate value.
 
         Returns:
             str: The symbol encoding that value. If the value is not recognized -

src/gwproto/enums/role.py

@@ -144,7 +144,7 @@ def value_to_symbol(cls, value: str) -> str:
         Provides the encoding symbol for a Role enum to send in seriliazed messages.
 
         Args:
-            symbol (str): The candidate value.
+            value (str): The candidate value.
 
         Returns:
             str: The symbol encoding that value. If the value is not recognized -

src/gwproto/enums/telemetry_name.py

@@ -133,7 +133,7 @@ def value_to_symbol(cls, value: str) -> str:
         Provides the encoding symbol for a TelemetryName enum to send in seriliazed messages.
 
         Args:
-            symbol (str): The candidate value.
+            value (str): The candidate value.
 
         Returns:
             str: The symbol encoding that value. If the value is not recognized -

src/gwproto/enums/unit.py

@@ -115,7 +115,7 @@ def value_to_symbol(cls, value: str) -> str:
         Provides the encoding symbol for a Unit enum to send in seriliazed messages.
 
         Args:
-            symbol (str): The candidate value.
+            value (str): The candidate value.
 
         Returns:
             str: The symbol encoding that value. If the value is not recognized -

src/gwproto/gs/gs_dispatch.py

@@ -9,5 +9,5 @@ def check_for_errors(self):
         if len(errors) > 0:
             raise SchemaError(f" Errors making making gs.pwr.100 for {self}: {errors}")
 
-    def hand_coded_errors(self):
+    def hand_coded_errors(self): # noqa
         return []

src/gwproto/gs/gs_pwr.py

@@ -9,5 +9,5 @@ def check_for_errors(self):
         if len(errors) > 0:
             raise SchemaError(f" Errors making making gs.pwr.100 for {self}: {errors}")
 
-    def hand_coded_errors(self):
+    def hand_coded_errors(self): # noqa
         return []

tests/types/test_data_channel.py

@@ -76,7 +76,7 @@ def test_data_channel_generated() -> None:
     ######################################
 
     d2 = dict(d, TelemetryNameGtEnumSymbol="unknown_symbol")
-    Maker.dict_to_tuple(d2).TelemetryName == TelemetryName.default()
+    assert Maker.dict_to_tuple(d2).TelemetryName == TelemetryName.default()
 
     ######################################
     # SchemaError raised if TypeName is incorrect

tests/types/test_electric_meter_cac_gt.py

@@ -110,14 +110,14 @@ def test_electric_meter_cac_gt_generated() -> None:
     ######################################
 
     d2 = dict(d, MakeModelGtEnumSymbol="unknown_symbol")
-    Maker.dict_to_tuple(d2).MakeModel == MakeModel.default()
+    assert Maker.dict_to_tuple(d2).MakeModel == MakeModel.default()
 
     d2 = dict(d, PollPeriodMs="1000.1")
     with pytest.raises(ValidationError):
         Maker.dict_to_tuple(d2)
 
     d2 = dict(d, InterfaceGtEnumSymbol="unknown_symbol")
-    Maker.dict_to_tuple(d2).Interface == LocalCommInterface.default()
+    assert Maker.dict_to_tuple(d2).Interface == LocalCommInterface.default()
 
     d2 = dict(d, DefaultBaud="9600.1")
     with pytest.raises(ValidationError):

tests/types/test_gt_sh_multipurpose_telemetry_status.py

@@ -83,7 +83,7 @@ def test_gt_sh_multipurpose_telemetry_status_generated() -> None:
     ######################################
 
     d2 = dict(d, TelemetryNameGtEnumSymbol="unknown_symbol")
-    Maker.dict_to_tuple(d2).TelemetryName == TelemetryName.default()
+    assert Maker.dict_to_tuple(d2).TelemetryName == TelemetryName.default()
 
     ######################################
     # SchemaError raised if TypeName is incorrect

tests/types/test_gt_sh_simple_telemetry_status.py

@@ -76,7 +76,7 @@ def test_gt_sh_simple_telemetry_status_generated() -> None:
     ######################################
 
     d2 = dict(d, TelemetryNameGtEnumSymbol="unknown_symbol")
-    Maker.dict_to_tuple(d2).TelemetryName == TelemetryName.default()
+    assert Maker.dict_to_tuple(d2).TelemetryName == TelemetryName.default()
 
     ######################################
     # SchemaError raised if TypeName is incorrect

tests/types/test_gt_telemetry.py

@@ -84,7 +84,7 @@ def test_gt_telemetry_generated() -> None:
         Maker.dict_to_tuple(d2)
 
     d2 = dict(d, NameGtEnumSymbol="unknown_symbol")
-    Maker.dict_to_tuple(d2).Name == TelemetryName.default()
+    assert Maker.dict_to_tuple(d2).Name == TelemetryName.default()
 
     d2 = dict(d, Exponent="3.1")
     with pytest.raises(ValidationError):

tests/types/test_multipurpose_sensor_cac_gt.py

@@ -124,7 +124,7 @@ def test_multipurpose_sensor_cac_gt_generated() -> None:
     ######################################
 
     d2 = dict(d, MakeModelGtEnumSymbol="unknown_symbol")
-    Maker.dict_to_tuple(d2).MakeModel == MakeModel.default()
+    assert Maker.dict_to_tuple(d2).MakeModel == MakeModel.default()
 
     d2 = dict(d, PollPeriodMs="880.1")
     with pytest.raises(ValidationError):
@@ -135,7 +135,7 @@ def test_multipurpose_sensor_cac_gt_generated() -> None:
         Maker.dict_to_tuple(d2)
 
     d2 = dict(d, TempUnitGtEnumSymbol="unknown_symbol")
-    Maker.dict_to_tuple(d2).TempUnit == Unit.default()
+    assert Maker.dict_to_tuple(d2).TempUnit == Unit.default()
 
     d2 = dict(d, MaxThermistors="12.1")
     with pytest.raises(ValidationError):

tests/types/test_pipe_flow_sensor_cac_gt.py

@@ -88,7 +88,7 @@ def test_pipe_flow_sensor_cac_gt_generated() -> None:
     ######################################
 
     d2 = dict(d, MakeModelGtEnumSymbol="unknown_symbol")
-    Maker.dict_to_tuple(d2).MakeModel == MakeModel.default()
+    assert Maker.dict_to_tuple(d2).MakeModel == MakeModel.default()
 
     ######################################
     # SchemaError raised if TypeName is incorrect

tests/types/test_relay_cac_gt.py

@@ -88,7 +88,7 @@ def test_relay_cac_gt_generated() -> None:
     ######################################
 
     d2 = dict(d, MakeModelGtEnumSymbol="unknown_symbol")
-    Maker.dict_to_tuple(d2).MakeModel == MakeModel.default()
+    assert Maker.dict_to_tuple(d2).MakeModel == MakeModel.default()
 
     d2 = dict(d, TypicalResponseTimeMs="400.1")
     with pytest.raises(ValidationError):

tests/types/test_resistive_heater_cac_gt.py

@@ -95,7 +95,7 @@ def test_resistive_heater_cac_gt_generated() -> None:
     ######################################
 
     d2 = dict(d, MakeModelGtEnumSymbol="unknown_symbol")
-    Maker.dict_to_tuple(d2).MakeModel == MakeModel.default()
+    assert Maker.dict_to_tuple(d2).MakeModel == MakeModel.default()
 
     d2 = dict(d, NameplateMaxPowerW="4500.1")
     with pytest.raises(ValidationError):

tests/types/test_simple_temp_sensor_cac_gt.py

@@ -118,7 +118,7 @@ def test_simple_temp_sensor_cac_gt_generated() -> None:
     ######################################
 
     d2 = dict(d, MakeModelGtEnumSymbol="unknown_symbol")
-    Maker.dict_to_tuple(d2).MakeModel == MakeModel.default()
+    assert Maker.dict_to_tuple(d2).MakeModel == MakeModel.default()
 
     d2 = dict(d, TypicalResponseTimeMs="880.1")
     with pytest.raises(ValidationError):
@@ -129,10 +129,10 @@ def test_simple_temp_sensor_cac_gt_generated() -> None:
         Maker.dict_to_tuple(d2)
 
     d2 = dict(d, TempUnitGtEnumSymbol="unknown_symbol")
-    Maker.dict_to_tuple(d2).TempUnit == Unit.default()
+    assert Maker.dict_to_tuple(d2).TempUnit == Unit.default()
 
     d2 = dict(d, TelemetryNameGtEnumSymbol="unknown_symbol")
-    Maker.dict_to_tuple(d2).TelemetryName == TelemetryName.default()
+    assert Maker.dict_to_tuple(d2).TelemetryName == TelemetryName.default()
 
     ######################################
     # SchemaError raised if TypeName is incorrect

tests/types/test_spaceheat_node_gt.py

@@ -131,10 +131,10 @@ def test_spaceheat_node_gt_generated() -> None:
     ######################################
 
     d2 = dict(d, ActorClassGtEnumSymbol="unknown_symbol")
-    Maker.dict_to_tuple(d2).ActorClass == ActorClass.default()
+    assert Maker.dict_to_tuple(d2).ActorClass == ActorClass.default()
 
     d2 = dict(d, RoleGtEnumSymbol="unknown_symbol")
-    Maker.dict_to_tuple(d2).Role == Role.default()
+    assert Maker.dict_to_tuple(d2).Role == Role.default()
 
     d2 = dict(d, ReportingSamplePeriodS="300.1")
     with pytest.raises(ValidationError):

tests/types/test_telemetry_reporting_config.py

@@ -112,7 +112,7 @@ def test_telemetry_reporting_config_generated() -> None:
     ######################################
 
     d2 = dict(d, TelemetryNameGtEnumSymbol="unknown_symbol")
-    Maker.dict_to_tuple(d2).TelemetryName == TelemetryName.default()
+    assert Maker.dict_to_tuple(d2).TelemetryName == TelemetryName.default()
 
     d2 = dict(d, ReportOnChange="this is not a boolean")
     with pytest.raises(ValidationError):
@@ -127,7 +127,7 @@ def test_telemetry_reporting_config_generated() -> None:
         Maker.dict_to_tuple(d2)
 
     d2 = dict(d, UnitGtEnumSymbol="unknown_symbol")
-    Maker.dict_to_tuple(d2).Unit == Unit.default()
+    assert Maker.dict_to_tuple(d2).Unit == Unit.default()
 
     d2 = dict(d, AsyncReportThreshold="this is not a float")
     with pytest.raises(ValidationError):