Code satisfies E rules (#514)

.gitignore

@@ -236,3 +236,5 @@ fabric.properties
 docs/reference/
 
 .idea/
+
+tests/tests/.temp/

Makefile

@@ -20,7 +20,7 @@ check: ## Run code quality tools.
 .PHONY: test
 test: ## Test the code with pytest
 	@echo "🚀 Testing code: Running pytest"
-	@poetry run pytest tests --cov --cov-config=pyproject.toml --cov-report=xml
+	@poetry run pytest -n auto tests --cov --cov-config=pyproject.toml --cov-report=xml
 
 .PHONY: build
 build: clean-build ## Build wheel file using poetry

archetypal/__init__.py

@@ -196,13 +196,13 @@ def initialize_units(cls, v):
 settings.unit_registry = unit_registry
 
 # After settings are loaded, import other modules
-from .eplus_interface.version import EnergyPlusVersion
-from .idfclass import IDF
-from .umi_template import (
+from .eplus_interface.version import EnergyPlusVersion  # noqa: E402
+from .idfclass import IDF  # noqa: E402
+from .umi_template import (  # noqa: E402
     BuildingTemplate,
     UmiTemplateLibrary,
 )
-from .utils import clear_cache, config, parallel_process
+from .utils import clear_cache, config, parallel_process  # noqa: E402
 
 try:
     __version__ = get_distribution("archetypal").version

archetypal/idfclass/idf.py

@@ -26,12 +26,8 @@
 from math import isclose
 from typing import IO, ClassVar, Literal
 
-import numpy as np
-from sigfig import round
-
-ReportingFrequency = Literal["Annual", "Monthly", "Daily", "Hourly", "Timestep"]
-
 import eppy
+import numpy as np
 import pandas as pd
 from energy_pandas import EnergySeries
 from eppy.bunch_subclass import BadEPFieldError
@@ -41,6 +37,7 @@
 from pandas import DataFrame, Series
 from pandas.errors import ParserError
 from path import Path
+from sigfig import round
 from tabulate import tabulate
 from tqdm.auto import tqdm
 
@@ -67,6 +64,8 @@
 from geomeppy.patches import EpBunch, idfreader1, obj2bunch
 from geomeppy.recipes import _is_window, window_vertices_given_wall
 
+ReportingFrequency = Literal["Annual", "Monthly", "Daily", "Hourly", "Timestep"]
+
 
 def find_and_launch(app_name, app_path_guess, file_path):
     app_path = shutil.which(app_name, path=app_path_guess)

archetypal/plot.py

@@ -56,7 +56,7 @@ def save_and_show(fig, ax, save, show, close, filename, file_format, dpi, axis_o
             os.makedirs(settings.imgs_folder)
         path_filename = os.path.join(settings.imgs_folder, os.extsep.join([filename, file_format]))
 
-        if not isinstance(ax, (np.ndarray, list)):
+        if not isinstance(ax, np.ndarray | list):
             ax = [ax]
         if file_format == "svg":
             fig.patch.set_alpha(0.0)

archetypal/template/constructions/base_construction.py

@@ -320,4 +320,4 @@ def __eq__(self, other):
 
     @property
     def children(self):
-        return tuple(l.Material for l in self.Layers)
+        return tuple(layer.Material for layer in self.Layers)

archetypal/utils.py

@@ -399,7 +399,7 @@ def angle(v1, v2, acute=True):
         angle (float): angle between the 2 vectors in degree
     """
     angle = np.arccos(np.dot(v1, v2) / (np.linalg.norm(v1) * np.linalg.norm(v2)))
-    if acute == True:
+    if acute is True:
         return angle
     else:
         return 2 * np.pi - angle
@@ -443,9 +443,9 @@ def timed(*args, **kwargs):
         try:
             try:
                 name = result.Name
-            except:
+            except Exception:
                 name = result.__qualname__
-        except:
+        except Exception:
             name = str(result)
         if tt > 0.001:
             log(f"Completed {method.__qualname__!r} for {name!r} in {tt:.3f} s")
@@ -512,23 +512,23 @@ def recursive_len(item):
     Returns:
         Total number of elements in nested list
     """
-    if type(item) == list:
+    if isinstance(item, list):
         return sum(recursive_len(subitem) for subitem in item)
     else:
         return 1
 
 
-def rotate(l, n):
+def rotate(items, n):
     """Shift list elements to the left
 
     Args:
-        l (list): list to rotate
+        items (list): list to rotate
         n (int): number to shift list to the left
 
     Returns:
         list: shifted list.
     """
-    return l[n:] + l[:n]
+    return items[n:] + items[:n]
 
 
 def parallel_process(

archetypal/zone_graph.py

@@ -110,7 +110,7 @@ def from_idf(cls, idf, log_adj_report=True, **kwargs):
                             this_cstr = surface["Construction_Name"]
                             their_cstr = adj_surf["Construction_Name"]
                             is_diff_cstr = surface["Construction_Name"] != adj_surf["Construction_Name"]
-                        except:
+                        except Exception:
                             this_cstr, their_cstr, is_diff_cstr = None, None, None
                         # create edge from this zone to the adjacent zone
                         G.add_edge(

pyproject.toml

@@ -109,18 +109,18 @@ select = [
     # mccabe
     "C90",
     # pycodestyle
-    #"E",
+    "E",
     "W",
     # pyflakes
-     "F",
+    "F",
     # pygrep-hooks
     "PGH",
     # pyupgrade
     "UP",
     # ruff
     "RUF",
     # tryceratops
-     "TRY",
+    "TRY",
 ]
 ignore = [
     # LineTooLong

tests/conftest.py

@@ -1,4 +1,3 @@
-import glob
 import os
 import sys
 from pathlib import Path
@@ -30,14 +29,6 @@ def scratch_then_cache(request):
             d.rmtree_p()
 
 
-samples_ = ["regular", "umi_samples"]  # ['problematic', 'regular', 'umi_samples']
-
-
-@pytest.fixture(params=samples_, ids=samples_, scope="session")
-def idf_source(request):
-    return glob.glob(f"tests/input_data/{request.param}/*.idf")
-
-
 @pytest.fixture(scope="session")
 def config():
     utils.config(

tests/test_energypandas.py

@@ -74,7 +74,7 @@ def test_discretize(self, rd_es):
         rd_es.discretize_tsam(noTypicalPeriods=1, inplace=True)
         assert_almost_equal(res.sum(), 2.118713381170598, decimal=3)
         # check that the type is maintained
-        assert type(rd_es) == EnergySeries
+        assert isinstance(res, EnergySeries)
 
 
 class TestEnergyDataFrame:
@@ -88,7 +88,7 @@ def test_discretize(self, rd_edf):
         rd_edf.discretize_tsam(noTypicalPeriods=1, inplace=True)
         assert hasattr(rd_edf, "agg")
         # check that the type is maintained
-        assert type(rd_edf) == EnergyDataFrame
+        assert isinstance(rd_edf, EnergyDataFrame)
 
     def test_plot_2d(self, rd_edf):
         fig, ax = rd_edf.plot2d(

tests/test_schedules.py

@@ -111,7 +111,7 @@ def test_replace(self):
 
 
 def schedules_idf():
-    config(cache_folder=os.getenv("ARCHETYPAL_CACHE") or data_dir / ".temp/cache")
+    config(cache_folder=os.getenv("ARCHETYPAL_CACHE") or data_dir / "../.temp/cache")
     idf = IDF(
         idf_file,
         epw=data_dir / "CAN_PQ_Montreal.Intl.AP.716270_CWEC.epw",

tests/test_template.py

@@ -2089,20 +2089,20 @@ def test_naturalVentilation_from_zone(self, ventilatontests):
             zone_ep = idf.getobject("ZONE", "ZONE 1")
             z = ZoneDefinition.from_epbunch(ep_bunch=zone_ep, construct_parents=False)
             ventilation_setting = VentilationSetting.from_zone(z, zone_ep)
-            assert ventilation_setting.IsNatVentOn == True
-            assert ventilation_setting.IsScheduledVentilationOn == False
+            assert ventilation_setting.IsNatVentOn is True
+            assert ventilation_setting.IsScheduledVentilationOn is False
         if idf_name == "VentilationSimpleTest.idf":
             zone_ep = idf.getobject("ZONE", "ZONE 2")
             z = ZoneDefinition.from_epbunch(ep_bunch=zone_ep, construct_parents=False)
             ventilation_setting = VentilationSetting.from_zone(z, zone_ep)
-            assert ventilation_setting.IsNatVentOn == False
-            assert ventilation_setting.IsScheduledVentilationOn == True
+            assert ventilation_setting.IsNatVentOn is False
+            assert ventilation_setting.IsScheduledVentilationOn is True
         if idf_name == "RefBldgWarehouseNew2004_Chicago.idf":
             zone_ep = idf.getobject("ZONE", "Office")
             z = ZoneDefinition.from_epbunch(ep_bunch=zone_ep, construct_parents=False)
             ventilation_setting = VentilationSetting.from_zone(z, zone_ep)
-            assert ventilation_setting.IsNatVentOn == False
-            assert ventilation_setting.IsScheduledVentilationOn == False
+            assert ventilation_setting.IsNatVentOn is False
+            assert ventilation_setting.IsScheduledVentilationOn is False
 
     def test_ventilationSetting_from_to_dict(self):
         """Make dict with `to_dict` and load again with `from_dict`."""