fhirpathpy 2.1.0__tar.gz → 2.2.0__tar.gz

{fhirpathpy-2.1.0 → fhirpathpy-2.2.0}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: fhirpathpy
-Version: 2.1.0
+Version: 2.2.0
 Summary: FHIRPath implementation in Python
 Keywords: fhir,fhirpath
 Author-email: "beda.software" <fhirpath@beda.software>
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Web Environment
@@ -12,17 +12,19 @@ Classifier: Intended Audience :: Developers
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
 License-File: LICENSE.md
 Requires-Dist: antlr4-python3-runtime~=4.10
 Requires-Dist: python-dateutil~=2.8
 Requires-Dist: pytest==7.1.1 ; extra == "test"
 Requires-Dist: pyyaml==5.4 ; extra == "test"
+Requires-Dist: pydantic==2.13.1 ; extra == "test"
 Project-URL: Changelog, https://github.com/beda-software/fhirpath-py/blob/master/CHANGELOG.md
 Project-URL: Documentation, https://github.com/beda-software/fhirpath-py#readme
 Project-URL: Homepage, https://github.com/beda-software/fhirpath-py
@@ -35,7 +37,7 @@ fhirpath.py
 [![Build Status](https://github.com/beda-software/fhirpath-py/actions/workflows/build.yaml/badge.svg)](https://github.com/beda-software/fhirpath-py/actions)
 [![codecov](https://codecov.io/gh/beda-software/fhirpath-py/branch/master/graph/badge.svg)](https://codecov.io/gh/beda-software/fhirpath-py)
 [![pypi](https://img.shields.io/pypi/v/fhirpathpy.svg)](https://pypi.org/project/fhirpathpy/)
-[![Supported Python version](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/release/python-380/)
+[![Supported Python version](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/release/python-3100/)
 
 [FHIRPath](https://www.hl7.org/fhir/fhirpath.html) implementation in Python
 

{fhirpathpy-2.1.0 → fhirpathpy-2.2.0}/README.md

@@ -4,7 +4,7 @@ fhirpath.py
 [![Build Status](https://github.com/beda-software/fhirpath-py/actions/workflows/build.yaml/badge.svg)](https://github.com/beda-software/fhirpath-py/actions)
 [![codecov](https://codecov.io/gh/beda-software/fhirpath-py/branch/master/graph/badge.svg)](https://codecov.io/gh/beda-software/fhirpath-py)
 [![pypi](https://img.shields.io/pypi/v/fhirpathpy.svg)](https://pypi.org/project/fhirpathpy/)
-[![Supported Python version](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/release/python-380/)
+[![Supported Python version](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/release/python-3100/)
 
 [FHIRPath](https://www.hl7.org/fhir/fhirpath.html) implementation in Python
 

{fhirpathpy-2.1.0 → fhirpathpy-2.2.0}/fhirpathpy/__init__.py

@@ -1,18 +1,26 @@
-from fhirpathpy.engine.invocations.constants import constants
-from fhirpathpy.parser import parse
+from __future__ import annotations
+
+from collections.abc import Callable, Mapping, Sequence
+from typing import Any, Protocol, TypeVar, cast
+
 from fhirpathpy.engine import do_eval
-from fhirpathpy.engine.util import arraify, get_data, set_paths, process_user_invocation_table
+from fhirpathpy.engine.invocations.constants import constants
 from fhirpathpy.engine.nodes import FP_Type, ResourceNode
+from fhirpathpy.engine.util import arraify, get_data, process_user_invocation_table, set_paths
+from fhirpathpy.parser import parse
 
 __title__ = "fhirpathpy"
-__version__ = "2.1.0"
+__version__ = "2.2.0"
 __author__ = "beda.software"
 __license__ = "MIT"
-__copyright__ = "Copyright 2025 beda.software"
+__copyright__ = "Copyright 2026 beda.software"
 
 # Version synonym
 VERSION = __version__
 
+ResourceType = Mapping[str, Any]
+ContextType = Mapping[str, Any] | None
+
 
 def apply_parsed_path(resource, parsedPath, context=None, model=None, options=None):
     constants.reset()
@@ -84,7 +92,13 @@ def apply_parsed_path(resource, parsedPath, context=None, model=None, options=No
     return visit(node)
 
 
-def evaluate(resource, path, context=None, model=None, options=None):
+def evaluate(
+    resource: ResourceType | list,
+    path: str | dict,
+    context: dict | None = None,
+    model: dict | None = None,
+    options: dict | None = None,
+) -> list:
     """
     Evaluates the "path" FHIRPath expression on the given resource, using data
     from "context" for variables mentioned in the "path" expression.
@@ -109,7 +123,9 @@ def evaluate(resource, path, context=None, model=None, options=None):
     return apply_parsed_path(resource, node, context or {}, model, options)
 
 
-def compile(path, model=None, options=None):
+def compile(
+    path: str, model: dict | None = None, options: dict | None = None
+) -> Callable[[ResourceType, ContextType], list]:
     """
     Returns a function that takes a resource and an optional context hash (see
     "evaluate"), and returns the result of evaluating the given FHIRPath
@@ -124,3 +140,89 @@ def compile(path, model=None, options=None):
     For example, you could pass in the result of require("fhirpath/fhir-context/r4")
     """
     return set_paths(apply_parsed_path, parsedPath=parse(path), model=model, options=options)
+
+
+InputType = TypeVar("InputType")
+OutputType = TypeVar("OutputType")
+# Contravariant: a callable accepting a wider input type is a valid subtype.
+_I_contra = TypeVar("_I_contra", contravariant=True)
+# Covariant: a callable returning a narrower output type is a valid subtype.
+# Sequence (read-only) is required here because list is invariant and rejects covariant TypeVars.
+_O_co = TypeVar("_O_co", covariant=True)
+
+
+class CompiledFirst(Protocol[_I_contra, _O_co]):
+    def __call__(self, resource: _I_contra, context: ContextType = ...) -> _O_co | None: ...
+
+
+class CompiledArray(Protocol[_I_contra, _O_co]):
+    def __call__(self, resource: _I_contra, context: ContextType = ...) -> Sequence[_O_co]: ...
+
+
+def compile_as_array(
+    expression: str, input_type: type[InputType], output_type: type[OutputType]
+) -> CompiledArray[InputType, OutputType]:
+    path_fn = compile(expression)
+
+    def fn(resource: Any, context: ContextType = None) -> Any:
+        return _format_result(
+            path_fn(_prepare_data(resource, input_type), context),
+            output_type,
+            is_array=True,
+        )
+
+    return cast(CompiledArray[InputType, OutputType], fn)
+
+
+def compile_as_first(
+    expression: str, input_type: type[InputType], output_type: type[OutputType]
+) -> CompiledFirst[InputType, OutputType]:
+    path_fn = compile(expression)
+
+    def fn(resource: Any, context: ContextType = None) -> Any:
+        return _format_result(
+            path_fn(_prepare_data(resource, input_type), context),
+            output_type,
+            is_array=False,
+        )
+
+    return cast(CompiledFirst[InputType, OutputType], fn)
+
+
+def _prepare_data(resource: Any, input_type: type[InputType]) -> ResourceType:
+    if not isinstance(resource, input_type):
+        raise Exception(
+            f"Resource type is {type(resource).__name__}, expected {input_type.__name__}"
+        )
+
+    if isinstance(resource, dict):
+        return resource
+
+    if hasattr(resource, "model_dump"):
+        return resource.model_dump()
+
+    raise Exception(f"Don't know how to work with type {type(resource).__name__}")
+
+
+def _format_result(result: list, output_type: type[OutputType], is_array=False) -> Any:
+    result = [_format_item(item, output_type) for item in result]
+
+    if is_array:
+        return result
+
+    if len(result) == 0:
+        return None
+
+    return result[0]
+
+
+def _format_item(item: Any, output_type: type[OutputType]) -> OutputType:
+    if hasattr(output_type, "model_validate"):
+        return cast(Any, output_type).model_validate(item)
+
+    if not isinstance(item, output_type):
+        raise Exception(
+            f"Expected result to be {output_type.__name__}, but got {type(item).__name__}"
+        )
+
+    return item

{fhirpathpy-2.1.0 → fhirpathpy-2.2.0}/pyproject.toml

@@ -1,17 +1,3 @@
-[tool.black]
-line-length = 100
-target-version = ['py311']
-exclude = '''
-(
-  /(
-    | \.git
-    | \.pytest_cache
-    | pyproject.toml
-    | dist
-  )/
-)
-'''
-
 [tool.pytest.ini_options]
 minversion = "6.0"
 addopts = "-ra -q --color=yes --cov=fhirpathpy --cov-report=xml"
@@ -40,17 +26,18 @@ classifiers = [
     "Operating System :: OS Independent",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.8",
-    "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Topic :: Internet :: WWW/HTTP",
     "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
 ]
-requires-python = ">=3.8"
+requires-python = ">=3.10"
 
 [project.optional-dependencies]
-test = ["pytest==7.1.1", "pyyaml==5.4"]
+test = ["pytest==7.1.1", "pyyaml==5.4", "pydantic==2.13.1"]
 
 [project.urls]
 Homepage = "https://github.com/beda-software/fhirpath-py"
@@ -60,17 +47,22 @@ Changelog = "https://github.com/beda-software/fhirpath-py/blob/master/CHANGELOG.
 
 
 [tool.ruff]
-target-version = "py39"
+target-version = "py310"
 line-length = 100
-include = ["app/**/*.py", "tests/**/*.py"]
+include = ["fhirpathpy/**/*.py", "tests/**/*.py"]
 
 [tool.ruff.lint]
 select = ["B", "F", "I", "E", "UP", "N", "PL", "PERF"]
-# Black is responsible for E501
 # N803/N806 is not relevant for us because we use camelCase for historical reasons
 ignore = ["E501", "N803", "N806"]
 unfixable = ["F401"]
 
+[tool.mypy]
+python_version = "3.10"
+ignore_missing_imports = true
+plugins = ["pydantic.mypy"]
+
+
 [tool.autohooks]
 mode = "pipenv"
-pre-commit = ["autohooks.plugins.black", "autohooks.plugins.ruff"]
+pre-commit = ["autohooks.plugins.ruff.check", "autohooks.plugins.ruff.format"]