policyengine-core 3.32.2__tar.gz → 3.32.4__tar.gz

{policyengine_core-3.32.2 → policyengine_core-3.32.4}/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [3.32.4] - 2026-09-08
+
+### Changed
+
+- Document the Hugging Face dataset download inputs and returned local file path, and correct its optional argument annotations.
+
+
+## [3.32.3] - 2026-09-04
+
+### Fixed
+
+- Correct the public type annotations for methods that add, replace, and update variables.
+
+
 ## [3.32.2] - 2026-09-04
 
 ### Fixed

{policyengine_core-3.32.2 → policyengine_core-3.32.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: policyengine-core
-Version: 3.32.2
+Version: 3.32.4
 Summary: Core microsimulation engine enabling country-specific policy models.
 Project-URL: Homepage, https://github.com/policyengine/policyengine-core
 Author-email: PolicyEngine <hello@policyengine.org>

{policyengine_core-3.32.2 → policyengine_core-3.32.4}/policyengine_core/taxbenefitsystems/tax_benefit_system.py

@@ -219,11 +219,11 @@ class TaxBenefitSystem:
 
         return variable
 
-    def add_variable(self, variable: Variable) -> Variable:
+    def add_variable(self, variable: Type[Variable]) -> Variable:
         """Adds an OpenFisca variable to the tax and benefit system.
 
         Args:
-            variable: The variable to add. Must be a subclass of Variable.
+            variable: The variable class to add. Must be a subclass of Variable.
 
         Raises:
             policyengine_core.errors.VariableNameConflictError: if a variable with the same name have previously been added to the tax and benefit system.
@@ -232,7 +232,7 @@ class TaxBenefitSystem:
         self.data_modified = True
         return self.load_variable(variable, update=False)
 
-    def replace_variable(self, variable: str) -> Variable:
+    def replace_variable(self, variable: Type[Variable]) -> None:
         """
         Replaces an existing OpenFisca variable in the tax and benefit system by a new one.
 
@@ -240,7 +240,7 @@ class TaxBenefitSystem:
 
         If no variable with the given name exists in the tax and benefit system, no error will be raised and the new variable will be simply added.
 
-        :param Variable variable: New variable to add. Must be a subclass of Variable.
+        :param Variable variable: New variable class to add. Must be a subclass of Variable.
         """
         name = variable.__name__
         if self.variables.get(name) is not None:
@@ -248,7 +248,7 @@ class TaxBenefitSystem:
         self.load_variable(variable, update=False)
         self.data_modified = True
 
-    def update_variable(self, variable: str) -> Variable:
+    def update_variable(self, variable: Type[Variable]) -> Variable:
         """
         Updates an existing OpenFisca variable in the tax and benefit system.
 
@@ -258,7 +258,7 @@ class TaxBenefitSystem:
 
         If no variable with the given name exists in the tax and benefit system, no error will be raised and the new variable will be simply added.
 
-        :param Variable variable: Variable to add. Must be a subclass of Variable.
+        :param Variable variable: Variable class to add. Must be a subclass of Variable.
         """
         self.data_modified = True
         return self.load_variable(variable, update=True)
@@ -377,9 +377,9 @@ class TaxBenefitSystem:
         for subdirectory in subdirectories:
             self.add_variables_from_directory(subdirectory)
 
-    def add_variables(self, *variables: List[Type[Variable]]):
+    def add_variables(self, *variables: Type[Variable]) -> None:
         """
-        Adds a list of OpenFisca Variables to the `TaxBenefitSystem`.
+        Adds OpenFisca Variable classes to the `TaxBenefitSystem`.
 
         See also :any:`add_variable`
         """

{policyengine_core-3.32.2 → policyengine_core-3.32.4}/policyengine_core/tools/hugging_face.py

@@ -6,6 +6,7 @@ from huggingface_hub import (
 from huggingface_hub.errors import RepositoryNotFoundError
 from getpass import getpass
 import os
+from pathlib import Path
 import warnings
 import traceback
 
@@ -46,17 +47,24 @@ def parse_hf_url(url: str) -> tuple[str, str, str, str | None]:
 def download_huggingface_dataset(
     repo: str,
     repo_filename: str,
-    version: str = None,
-    local_dir: str | None = None,
-):
+    version: str | None = None,
+    local_dir: str | Path | None = None,
+) -> str:
     """
-    Download a dataset from the Hugging Face Hub.
+    Download a PolicyEngine dataset file from the Hugging Face Hub.
 
     Args:
-        repo (str): The Hugging Face repo name, in format "{org}/{repo}".
-        repo_filename (str): The filename of the dataset.
-        version (str, optional): The version of the dataset. Defaults to None.
-        local_dir (str, optional): The local directory to save the dataset to. Defaults to None.
+        repo: Hugging Face model repository identifier in ``owner/name``
+            format.
+        repo_filename: Path to the dataset file within the repository.
+        version: Repository revision to download, such as a branch, tag, or
+            commit hash. If omitted, Hugging Face uses the repository's
+            default revision.
+        local_dir: Directory in which to place the downloaded file. If
+            omitted, Hugging Face uses its local cache.
+
+    Returns:
+        Path to the downloaded local file.
     """
     # Attempt connection to Hugging Face model_info endpoint
     # (https://huggingface.co/docs/huggingface_hub/v0.26.5/en/package_reference/hf_api#huggingface_hub.HfApi.model_info)
@@ -65,7 +73,7 @@ def download_huggingface_dataset(
     # but this error will also surface for public repos with malformed URL, etc.
     try:
         fetched_model_info: ModelInfo = model_info(repo)
-        is_repo_private: bool = fetched_model_info.private
+        is_repo_private = bool(fetched_model_info.private)
     except RepositoryNotFoundError as e:
         # If this error type arises, it's likely the repo is private; see docs above
         is_repo_private = True
@@ -77,9 +85,9 @@ def download_huggingface_dataset(
             + f"is private, the URL is malformed, or the dataset does not exist. The full error is {traceback.format_exc()}"
         )
 
-    authentication_token: str = None
+    authentication_token: str | None = None
     if is_repo_private:
-        authentication_token: str = get_or_prompt_hf_token()
+        authentication_token = get_or_prompt_hf_token()
 
     return hf_hub_download(
         repo_id=repo,

{policyengine_core-3.32.2 → policyengine_core-3.32.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "policyengine-core"
-version = "3.32.2"
+version = "3.32.4"
 description = "Core microsimulation engine enabling country-specific policy models."
 readme = "README.md"
 authors = [