ENH: add Path to allowed load() arguments (#264)

ComPWA · Apr 25, 2024 · df1b60d · df1b60d
1 parent 829f0b9
commit df1b60d
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -73,6 +73,7 @@ def create_constraints_inventory() -> None:
     "NodeQuantumNumber": ("obj", "qrules.quantum_numbers.NodeQuantumNumber"),
     "NodeType": "typing.TypeVar",
     "ParticleWithSpin": ("obj", "qrules.particle.ParticleWithSpin"),
+    "Path": "pathlib.Path",
     "qrules.topology.EdgeType": "typing.TypeVar",
     "qrules.topology.NodeType": "typing.TypeVar",
     "SpinFormalism": ("obj", "qrules.transition.SpinFormalism"),

diff --git a/src/qrules/io/__init__.py b/src/qrules/io/__init__.py
@@ -119,7 +119,7 @@ def asdot(
     return print_dot(instance)
 
 
-def load(filename: str) -> object:
+def load(filename: str | Path) -> object:
     with open(filename) as stream:
         file_extension = _get_file_extension(filename)
         if file_extension == "json":
@@ -170,7 +170,7 @@ def write(instance: object, filename: str) -> None:
     raise NotImplementedError(msg)
 
 
-def _get_file_extension(filename: str) -> str:
+def _get_file_extension(filename: str | Path) -> str:
     path = Path(filename)
     extension = path.suffix.lower()
     if not extension: