Confirm support for Python 3.13 and drop 3.8

.github/workflows/pytest.yaml

@@ -24,11 +24,11 @@ jobs:
         - ubuntu-latest
         - windows-latest
         python-version:
-        - "3.8"  # Earliest version supported by ixmp
-        - "3.9"
+        - "3.9"  # Earliest version supported by ixmp
         - "3.10"
         - "3.11"
-        - "3.12"  # Latest supported by ixmp
+        - "3.12"
+        - "3.13"  # Latest supported by ixmp
         gams-version:
         # Version used until 2024-07; disabled
         # - 25.1.1
@@ -43,17 +43,13 @@ jobs:
 
         exclude:
         # Specific version combinations that are invalid / not to be used
-        # No arm64 distribution for this version of GAMS
-        # - { os: macos-latest, gams-version: 25.1.1}
         # No arm64 distributions of JPype for these Pythons
-        - { os: macos-latest, python-version: "3.8" }
         - { os: macos-latest, python-version: "3.9" }
         # Redundant with macos-latest
         - { os: macos-13, python-version: "3.10" }
         - { os: macos-13, python-version: "3.11" }
         - { os: macos-13, python-version: "3.12" }
-        # Example: pandas 2.0 requires Python >= 3.8
-        # - { python-version: "3.7", pandas-version: "==2.0.0rc0" }
+        - { os: macos-13, python-version: "3.13" }
 
       fail-fast: false
 
@@ -80,6 +76,8 @@ jobs:
 
     - uses: r-lib/actions/setup-r@v2
       id: setup-r
+      with:
+        r-version: "4.4.1"
 
     - name: Cache GAMS installer and R packages
       uses: actions/cache@v4

.gitignore

@@ -60,6 +60,7 @@ prof/
 
 # Editors and IDEs
 .editorconfig
+.vscode
 *.iml
 /**/.idea
 

RELEASE_NOTES.rst

@@ -1,6 +1,8 @@
 Next release
 ============
 
+- :mod:`ixmp` is tested and compatible with `Python 3.13 <https://www.python.org/downloads/release/python-3130/>`__ (:pull:`544`).
+- Support for Python 3.8 is dropped (:pull:`544`), as it has reached end-of-life.
 - :mod:`ixmp` locates GAMS API libraries needed for the Java code underlying :class:`.JDBCBackend` based on the system GAMS installation (:pull:`532`).
   As a result:
 

doc/install.rst

@@ -34,7 +34,7 @@ Install system dependencies
 Python
 ------
 
-Python version 3.8 or later is required.
+Python version 3.9 or later is required.
 
 GAMS (required)
 ---------------
@@ -89,7 +89,7 @@ After installing GAMS, we recommend that new users install Anaconda, and then us
 Advanced users may choose to install :mod:`ixmp` from source code (next section).
 
 4. Install Python via either `Miniconda`_ or `Anaconda`_. [1]_
-   We recommend the latest version; currently Python 3.10. [2]_
+   We recommend the latest version; currently Python 3.13. [2]_
 
 5. Open a command prompt.
    We recommend Windows users use the “Anaconda Prompt” to avoid issues with permissions and environment variables when installing and using :mod:`ixmp`.

ixmp/_config.py

@@ -4,7 +4,7 @@
 from copy import copy
 from dataclasses import asdict, dataclass, field, fields, make_dataclass
 from pathlib import Path
-from typing import Any, Dict, Optional, Tuple, Type
+from typing import Any, Optional
 
 log = logging.getLogger(__name__)
 
@@ -121,7 +121,7 @@ def delete_field(self, name):
         data.pop(name)
         return new_cls, new_cls(**data)
 
-    def keys(self) -> Tuple[str, ...]:
+    def keys(self) -> tuple[str, ...]:
         return tuple(map(lambda f: f.name.replace("_", " "), fields(self)))
 
     def set(self, name: str, value: Any, strict: bool = True):
@@ -214,7 +214,7 @@ class Config:
     #: ``ixmp.config.values["platform"]["platform name"]…``.
     values: BaseValues
 
-    _ValuesClass: Type
+    _ValuesClass: type[BaseValues]
 
     def __init__(self, read: bool = True):
         self._ValuesClass = BaseValues
@@ -261,7 +261,7 @@ def get(self, name: str) -> Any:
         """Return the value of a configuration key `name`."""
         return self.values[name]
 
-    def keys(self) -> Tuple[str, ...]:
+    def keys(self) -> tuple[str, ...]:
         """Return the names of all registered configuration keys."""
         return self.values.keys()
 
@@ -383,7 +383,7 @@ def add_platform(self, name: str, *args, **kwargs):
 
         self.values["platform"][name] = info
 
-    def get_platform_info(self, name: str) -> Tuple[str, Dict[str, Any]]:
+    def get_platform_info(self, name: str) -> tuple[str, dict[str, Any]]:
         """Return information on configured Platform `name`.
 
         Parameters

ixmp/backend/__init__.py

@@ -1,7 +1,10 @@
 """Backend API."""
 
 from enum import IntFlag
-from typing import Dict, List, Type, Union
+from typing import TYPE_CHECKING, Union
+
+if TYPE_CHECKING:
+    import ixmp.backend.base
 
 #: Lists of field names for tuples returned by Backend API methods.
 #:
@@ -46,12 +49,12 @@
 #: Partial list of dimensions for the IAMC data structure, or “IAMC format”. This omits
 #: "year" and "subannual" which appear in some variants of the structure, but not in
 #: others.
-IAMC_IDX: List[Union[str, int]] = ["model", "scenario", "region", "variable", "unit"]
+IAMC_IDX: list[Union[str, int]] = ["model", "scenario", "region", "variable", "unit"]
 
 
 #: Mapping from names to available backends. To register additional backends, add
 #: entries to this dictionary.
-BACKENDS: Dict[str, Type] = {}
+BACKENDS: dict[str, type["ixmp.backend.base.Backend"]] = {}
 
 
 class ItemType(IntFlag):

ixmp/backend/base.py

@@ -6,15 +6,12 @@
 from pathlib import Path
 from typing import (
     Any,
-    Dict,
     Hashable,
     Iterable,
-    List,
     Literal,
     MutableMapping,
     Optional,
     Sequence,
-    Tuple,
     Union,
 )
 
@@ -33,7 +30,7 @@ class Backend(ABC):
     # Typing:
     # - All methods MUST be fully typed.
     # - Use more permissive types, e.g. Sequence[str], for inputs.
-    # - Use precise types, e.g. List[str], for return values.
+    # - Use precise types, e.g. list[str], for return values.
     # - Backend subclasses do not need to repeat the type annotations; these are implied
     #   by this parent class.
     #
@@ -57,7 +54,7 @@ def __call__(self, obj, method, *args, **kwargs):
     # Platform methods
 
     @classmethod
-    def handle_config(cls, args: Sequence, kwargs: MutableMapping) -> Dict[str, Any]:
+    def handle_config(cls, args: Sequence, kwargs: MutableMapping) -> dict[str, Any]:
         """OPTIONAL: Handle platform/backend config arguments.
 
         Returns a :class:`dict` to be stored in the configuration file. This
@@ -124,7 +121,7 @@ def set_doc(self, domain: str, docs) -> None:
         """
 
     @abstractmethod
-    def get_doc(self, domain: str, name: Optional[str] = None) -> Union[str, Dict]:
+    def get_doc(self, domain: str, name: Optional[str] = None) -> Union[str, dict]:
         """Read documentation from database
 
         Parameters
@@ -155,7 +152,7 @@ def close_db(self) -> None:
         Close any database connection(s), if open.
         """
 
-    def get_auth(self, user: str, models: Sequence[str], kind: str) -> Dict[str, bool]:
+    def get_auth(self, user: str, models: Sequence[str], kind: str) -> dict[str, bool]:
         """OPTIONAL: Return user authorization for `models`.
 
         If the Backend implements access control, this method **must** indicate whether
@@ -215,7 +212,7 @@ def set_node(
         """
 
     @abstractmethod
-    def get_nodes(self) -> Iterable[Tuple[str, Optional[str], str, str]]:
+    def get_nodes(self) -> Iterable[tuple[str, Optional[str], str, str]]:
         """Iterate over all nodes stored on the Platform.
 
         Yields
@@ -238,7 +235,7 @@ def get_nodes(self) -> Iterable[Tuple[str, Optional[str], str, str]]:
         """
 
     @abstractmethod
-    def get_timeslices(self) -> Iterable[Tuple[str, str, float]]:
+    def get_timeslices(self) -> Iterable[tuple[str, str, float]]:
         """Iterate over subannual timeslices defined on the Platform instance.
 
         Yields
@@ -321,7 +318,7 @@ def get_scenario_names(self) -> Iterable[str]:
     def get_scenarios(
         self, default: bool, model: Optional[str], scenario: Optional[str]
     ) -> Iterable[
-        Tuple[str, str, str, bool, bool, str, str, str, str, str, str, str, int]
+        tuple[str, str, str, bool, bool, str, str, str, str, str, str, str, int]
     ]:
         """Iterate over TimeSeries stored on the Platform.
 
@@ -377,7 +374,7 @@ def set_unit(self, name: str, comment: str) -> None:
         """
 
     @abstractmethod
-    def get_units(self) -> List[str]:
+    def get_units(self) -> list[str]:
         """Return all registered symbols for units of measurement.
 
         Returns
@@ -592,7 +589,7 @@ def preload(self, ts: TimeSeries) -> None:
         """OPTIONAL: Load `ts` data into memory."""
 
     @staticmethod
-    def _handle_rw_filters(filters: dict) -> Tuple[Optional[TimeSeries], Dict]:
+    def _handle_rw_filters(filters: dict) -> tuple[Optional[TimeSeries], dict]:
         """Helper for :meth:`read_file` and :meth:`write_file`.
 
         The `filters` argument is unpacked if the 'scenarios' key is a single
@@ -617,7 +614,7 @@ def get_data(
         variable: Sequence[str],
         unit: Sequence[str],
         year: Sequence[str],
-    ) -> Iterable[Tuple[str, str, str, int, float]]:
+    ) -> Iterable[tuple[str, str, str, int, float]]:
         """Retrieve time series data.
 
         Parameters
@@ -650,7 +647,7 @@ def get_data(
     @abstractmethod
     def get_geo(
         self, ts: TimeSeries
-    ) -> Iterable[Tuple[str, str, int, str, str, str, bool]]:
+    ) -> Iterable[tuple[str, str, int, str, str, str, bool]]:
         """Retrieve time-series 'geodata'.
 
         Yields
@@ -677,7 +674,7 @@ def set_data(
         ts: TimeSeries,
         region: str,
         variable: str,
-        data: Dict[int, float],
+        data: dict[int, float],
         unit: str,
         subannual: str,
         meta: bool,
@@ -831,7 +828,7 @@ def has_solution(self, s: Scenario) -> bool:
         """
 
     @abstractmethod
-    def list_items(self, s: Scenario, type: str) -> List[str]:
+    def list_items(self, s: Scenario, type: str) -> list[str]:
         """Return a list of names of items of `type`.
 
         Parameters
@@ -882,7 +879,7 @@ def delete_item(self, s: Scenario, type: str, name: str) -> None:
         """
 
     @abstractmethod
-    def item_index(self, s: Scenario, name: str, sets_or_names: str) -> List[str]:
+    def item_index(self, s: Scenario, name: str, sets_or_names: str) -> list[str]:
         """Return the index sets or names of item `name`.
 
         Parameters
@@ -900,8 +897,8 @@ def item_get_elements(
         s: Scenario,
         type: Literal["equ", "par", "set", "var"],
         name: str,
-        filters: Optional[Dict[str, List[Any]]] = None,
-    ) -> Union[Dict[str, Any], pd.Series, pd.DataFrame]:
+        filters: Optional[dict[str, list[Any]]] = None,
+    ) -> Union[dict[str, Any], pd.Series, pd.DataFrame]:
         """Return elements of item `name`.
 
         Parameters
@@ -945,7 +942,7 @@ def item_set_elements(
         s: Scenario,
         type: str,
         name: str,
-        elements: Iterable[Tuple[Any, Optional[float], Optional[str], Optional[str]]],
+        elements: Iterable[tuple[Any, Optional[float], Optional[str], Optional[str]]],
     ) -> None:
         """Add keys or values to item `name`.
 
@@ -1011,7 +1008,7 @@ def get_meta(
         scenario: Optional[str],
         version: Optional[int],
         strict: bool,
-    ) -> Dict[str, Any]:
+    ) -> dict[str, Any]:
         """Retrieve all metadata attached to a specific target.
 
         Depending on which of `model`, `scenario`, `version` are :obj:`None`, metadata
@@ -1121,7 +1118,7 @@ def clear_solution(self, s: Scenario, from_year=None):
     # Methods for message_ix.Scenario
 
     @abstractmethod
-    def cat_list(self, ms: Scenario, name: str) -> List[str]:
+    def cat_list(self, ms: Scenario, name: str) -> list[str]:
         """Return list of categories in mapping `name`.
 
         Parameters
@@ -1136,7 +1133,7 @@ def cat_list(self, ms: Scenario, name: str) -> List[str]:
         """
 
     @abstractmethod
-    def cat_get_elements(self, ms: Scenario, name: str, cat: str) -> List[str]:
+    def cat_get_elements(self, ms: Scenario, name: str, cat: str) -> list[str]:
         """Get elements of a category mapping.
 
         Parameters
@@ -1188,11 +1185,11 @@ class CachingBackend(Backend):
 
     #: Cache of values. Keys are given by :meth:`_cache_key`; values depend on the
     #: subclass' usage of the cache.
-    _cache: Dict[Tuple, object] = {}
+    _cache: dict[tuple, object] = {}
 
     #: Count of number of times a value was retrieved from cache successfully
     #: using :meth:`cache_get`.
-    _cache_hit: Dict[Tuple, int] = {}
+    _cache_hit: dict[tuple, int] = {}
 
     # Backend API methods
 
@@ -1217,8 +1214,8 @@ def _cache_key(
         ts: TimeSeries,
         ix_type: Optional[str],
         name: Optional[str],
-        filters: Optional[Dict[str, Hashable]] = None,
-    ) -> Tuple[Hashable, ...]:
+        filters: Optional[dict[str, Hashable]] = None,
+    ) -> tuple[Hashable, ...]:
         """Return a hashable cache key.
 
         ixmp `filters` (a :class:`dict` of :class:`list`) are converted to a unique id
@@ -1237,7 +1234,7 @@ def _cache_key(
             return (ts_id, ix_type, name, hash(json.dumps(sorted(filters.items()))))
 
     def cache_get(
-        self, ts: TimeSeries, ix_type: str, name: str, filters: Dict
+        self, ts: TimeSeries, ix_type: str, name: str, filters: dict
     ) -> Optional[Any]:
         """Retrieve value from cache.
 
@@ -1258,7 +1255,7 @@ def cache_get(
             raise KeyError(ts, ix_type, name, filters)
 
     def cache(
-        self, ts: TimeSeries, ix_type: str, name: str, filters: Dict, value: Any
+        self, ts: TimeSeries, ix_type: str, name: str, filters: dict, value: Any
     ) -> bool:
         """Store `value` in cache.
 
@@ -1284,7 +1281,7 @@ def cache_invalidate(
         ts: TimeSeries,
         ix_type: Optional[str] = None,
         name: Optional[str] = None,
-        filters: Optional[Dict] = None,
+        filters: Optional[dict] = None,
     ) -> None:
         """Invalidate cached values.
 
@@ -1300,7 +1297,7 @@ def cache_invalidate(
 
         if filters is None:
             i = slice(1) if (ix_type is name is None) else slice(3)
-            to_remove: Iterable[Tuple] = filter(
+            to_remove: Iterable[tuple] = filter(
                 lambda k: k[i] == key[i], self._cache.keys()
             )
         else: