v2.18.10 (#542)

* chore: remove unused dependencies (#535)

* chore: remove unused dependencies

* Use Optional for energyplus_location (#536)

* test: add energyplus interface coverage (#537)

* Replace deprecated pkg_resources with importlib.metadata (#541)

* Fix a typing issue

* Replace deprecated pkg_resources with importlib.metadata

pkg_resources was removed in setuptools 82. Use importlib.metadata
(stdlib since Python 3.8) to resolve package version at runtime.

https://claude.ai/code/session_01931BKYPT56MDrWgY3maT8D

* Add PackageNotFoundError fallback in docs/conf.py

Prevents Sphinx build from crashing if archetypal is not installed
in the docs build environment.

* Fix Sphinx version/release assignment in docs/conf.py

Split the chained assignment so `release` retains the full version
string (e.g. "2.18.9") and only `version` is truncated to major.minor.

* Apply ruff auto-fixes (import sorting, __all__ ordering)

* Bump version to 2.18.10

Author: samuelduchesne

archetypal/__init__.py

@@ -7,14 +7,14 @@
 from __future__ import annotations
 
 import logging as lg
+
+# Version of the package
+from importlib.metadata import PackageNotFoundError, version
 from pathlib import Path
-from typing import Any, ClassVar, Literal
+from typing import Any, ClassVar, Literal, Optional
 
 from energy_pandas.units import unit_registry
 
-# Version of the package
-from pkg_resources import DistributionNotFound, get_distribution
-
 try:
     from pydantic_settings import BaseSettings
 except ImportError:
@@ -171,7 +171,7 @@ class Settings(BaseSettings, arbitrary_types_allowed=True, validate_assignment=T
         "for ENERGYPLUS_VERSION in os.environ",
     )
 
-    energyplus_location: DirectoryPath | None = Field(
+    energyplus_location: Optional[DirectoryPath] = Field(
         None,
         validation_alias="ENERGYPLUS_LOCATION",
         description="Root directory of the EnergyPlus install.",
@@ -205,8 +205,8 @@ def initialize_units(cls, v):
 from .utils import clear_cache, config, parallel_process  # noqa: E402
 
 try:
-    __version__ = get_distribution("archetypal").version
-except DistributionNotFound:
+    __version__ = version("archetypal")
+except PackageNotFoundError:
     # package is not installed
     __version__ = "0.0.0"  # should happen only if package is copied, not installed.
 else:
@@ -219,16 +219,16 @@ def initialize_units(cls, v):
     warn_if_not_compatible()
 
 __all__ = [
-    "settings",
-    "Settings",
-    "__version__",
-    "utils",
-    "dataportal",
     "IDF",
-    "EnergyPlusVersion",
     "BuildingTemplate",
+    "EnergyPlusVersion",
+    "Settings",
     "UmiTemplateLibrary",
+    "__version__",
     "clear_cache",
     "config",
+    "dataportal",
     "parallel_process",
+    "settings",
+    "utils",
 ]

docs/conf.py

@@ -15,8 +15,8 @@
 #
 import os
 import sys
-
-from pkg_resources import get_distribution
+from importlib.metadata import PackageNotFoundError
+from importlib.metadata import version as get_version
 
 sys.path.insert(0, os.path.abspath("."))
 sys.path.insert(0, os.path.abspath("archetypal"))
@@ -28,9 +28,12 @@
 author = "Samuel Letellier-Duchesne"
 
 # The full version, including alpha/beta/rc tags
-release = get_distribution("archetypal").version
+try:
+    release = get_version("archetypal")
+except PackageNotFoundError:
+    release = "0.0.0"
 # for example take major/minor
-version = release = ".".join(release.split(".")[:2])
+version = ".".join(release.split(".")[:2])
 
 # -- General configuration ---------------------------------------------------
 

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "archetypal"
-version = "2.18.9"
+version = "2.18.10"
 description = "Retrieve, construct, simulate, convert and analyse building archetypes"
 authors = ["Samuel Letellier-Duchesne <samuelduchesne@me.com>"]
 license = "MIT License"
@@ -20,43 +20,25 @@ scikit-learn = "^1.5.0"
 pandas = ">=2.0.3"
 tqdm = "^4.66.4"
 click = "^8.1.7"
-outdated = "^0.2.2"
-deprecation = "^2.1.0"
 sigfig = "^1.3.3"
 requests = "^2.32.3"
 coolprop = "^6.6.0"
 energy_pandas = "^0.4.1"
 validator-collection = "^1.5.0"
-typing-extensions = "^4.12.2"
 pydantic-settings = "^2.3.2"
 path = ">=17.1.0"  # fix an issue with Path.copy returning a str instead of a Path object
 numpy = [
     {version = "^2.0.2", python = "<=3.9"},
     {version = "^2.1.1", python = "3.10"}
 ]
-eval-type-backport = {version = "^0.2.0", python = "3.9"}
 
 # geomeppy.dependencies
 shapely = "^2.0.6"
-beautifulsoup4 = "<=4.8"
-contourpy = "^1.2.1"
-cycler = "^0.12.1"
-decorator = "^5.1.1"
 esoreader = "^1.2.3"
-fonttools = "^4.53.0"
-future = "^1.0.0"
-kiwisolver = "^1.4.5"
-lxml = "^5.2.2"
-munch = "^4.0.0"
 packaging = "^24.1"
-pillow = "^10.3.0"
 pyclipper = "^1.3.0.post5"
-pydot3k = "^1.0.17"
-pyparsing = "^3.1.2"
 pypoly2tri = "^0.0.3"
-python-dateutil = "^2.9.0.post0"
 six = "^1.16.0"
-soupsieve = "^2.5"
 tomli = "^2.0.1"
 transforms3d = "^0.4.1"
 
@@ -86,6 +68,9 @@ archetypal = "archetypal.cli:cli"
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]
+markers = [
+    "slow: marks tests as slow that require EnergyPlus or long processing"
+]
 
 [tool.ruff]
 target-version = "py39"

pyproject.toml

@@ -52,9 +52,9 @@ def clean_config(config):
         d.rmtree_p()
 
 
-# List fixtures that are located outiside of conftest.py so that they can be
+# List fixtures that are located outside of conftest.py so that they can be
 # used in other tests
-pytest_plugins = ["tests.test_dataportals"]
+# Removed import of test_dataportals as plugin to avoid unnecessary test loading
 
 ALL = set("darwin linux win32".split())
 
@@ -85,3 +85,15 @@ def safe_int_cast(val, default=0):
         return int(val)
     except (ValueError, TypeError):
         return default
+
+
+def pytest_addoption(parser):
+    parser.addoption("--runslow", action="store_true", default=False, help="run slow tests")
+
+
+def pytest_collection_modifyitems(config, items):
+    if not config.getoption("--runslow"):
+        skip_slow = pytest.mark.skip(reason="need --runslow option to run")
+        for item in items:
+            if "slow" in item.keywords:
+                item.add_marker(skip_slow)

tests/conftest.py

@@ -10,6 +10,8 @@
 
 from .conftest import data_dir
 
+pytestmark = pytest.mark.slow
+
 
 class TestCli:
     """Defines tests for usage of the archetypal Command Line Interface"""

tests/test_cli.py

@@ -9,6 +9,8 @@
 
 from .conftest import data_dir
 
+pytestmark = pytest.mark.slow
+
 
 def test_tabula_available_country(config):
     # First, let's try the API call

tests/test_dataportals.py

@@ -5,6 +5,8 @@
 from archetypal import IDF
 from archetypal.idfclass.end_use_balance import EndUseBalance
 
+pytestmark = pytest.mark.slow
+
 
 class TestEndUseBalance:
     @pytest.fixture()

tests/test_end_use_balance.py

@@ -7,6 +7,8 @@
 
 from .conftest import data_dir
 
+pytestmark = pytest.mark.slow
+
 
 @pytest.fixture(scope="module")
 def idf(config):

tests/test_energypandas.py

@@ -0,0 +1,39 @@
+import pytest
+from path import Path
+
+from archetypal.eplus_interface.energy_plus import EnergyPlusExe, EnergyPlusProgram
+from archetypal.eplus_interface.exceptions import EnergyPlusVersionError
+from archetypal.eplus_interface.version import EnergyPlusVersion
+
+
+def test_energyplus_exe_cmd(tmp_path, mocker):
+    exe = Path(tmp_path / "energyplus")
+    exe.write_text("")
+    weather = Path(tmp_path / "weather")
+    weather.write_text("")
+    mocker.patch("eppy.runner.run_functions.install_paths", return_value=(str(exe), str(weather)))
+    version = EnergyPlusVersion("9.2.0")
+    ep = EnergyPlusExe("in.idf", "in.epw", Path(tmp_path), version, annual=True, readvars=False)
+    cmd = ep.cmd()
+    assert str(exe) in str(cmd[0])
+    assert "-a" in cmd
+    assert "-r" not in cmd
+    assert "in.idf" in cmd[-1]
+
+
+def test_energyplus_exe_missing(tmp_path, mocker):
+    mocker.patch(
+        "eppy.runner.run_functions.install_paths",
+        return_value=(str(Path(tmp_path) / "missing"), str(tmp_path)),
+    )
+    version = EnergyPlusVersion("9.2.0")
+    with pytest.raises(EnergyPlusVersionError):
+        EnergyPlusExe("in.idf", "in.epw", Path(tmp_path), version)
+
+
+def test_energyplus_program_home(tmp_path):
+    version = EnergyPlusVersion("9.2.0")
+    version.install_locations = {version.dash: Path(tmp_path)}
+    idf = type("IDF", (), {"file_version": version})()
+    program = EnergyPlusProgram(idf)
+    assert program.eplus_home == Path(tmp_path)