fhirpathpy 2.0.0__tar.gz → 2.0.2__tar.gz

{fhirpathpy-2.0.0 → fhirpathpy-2.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fhirpathpy
-Version: 2.0.0
+Version: 2.0.2
 Summary: FHIRPath implementation in Python
 Keywords: fhir,fhirpath
 Author-email: "beda.software" <fhirpath@beda.software>
@@ -82,7 +82,7 @@ patient = {
 }
 
 # Evaluating FHIRPath
-result = evaluate(patient, "Patient.name.where(use='usual').given.first()", [])
+result = evaluate(patient, "Patient.name.where(use='usual').given.first()", {})
 # result: `['Jim']`
 ```
 
@@ -97,11 +97,11 @@ path (string): fhirpath expression, sample 'Patient.name.given'
 
 context (dict): a hash of variable name/value pairs.
 
-model (dict): The "model" data object specific to a domain, e.g. R4.
+model (dict): The "model" data object specific to a domain, e.g. R4. See Using data models documentation below.
 
-options (dict) - Custom options (see the documentation below)
+options (dict) - Custom options.
 
-options.userInvocationTable - a user invocation table used to replace any existing functions or define new ones (see User-defined functions documentation below)
+options.userInvocationTable - a user invocation table used to replace any existing functions or define new ones. See User-defined functions documentation below.
 
 ## compile
 Returns a function that takes a resource and an optional context hash (see "evaluate"), and returns the result of evaluating the given FHIRPath expression on that resource.  The advantage of this function over "evaluate" is that if you have multiple resources, the given FHIRPath expression will only be parsed once
@@ -110,14 +110,38 @@ Returns a function that takes a resource and an optional context hash (see "eval
 
 path (string) - the FHIRPath expression to be parsed.
 
-model (dict) - The "model" data object specific to a domain, e.g. R4.
+model (dict) - The "model" data object specific to a domain, e.g. R4. See Using data models documentation below.
 
 options (dict) - Custom options
 
-options.userInvocationTable - a user invocation table used to replace any existing functions or define new ones (see User-defined functions documentation below)
+options.userInvocationTable - a user invocation table used to replace any existing functions or define new ones. See User-defined functions documentation below.
+
+## Using data models
+
+The fhirpathpy library comes with pre-defined data models for FHIR versions DSTU2, STU3, R4, and R5. These models can be used within your project.
+
+Example:
+```python
+from fhirpathpy.models import models
+
+
+r4_model = models["r4"]
+
+patient = {
+  "resourceType": "Patient",
+  "deceasedBoolean": false,
+}
+
+result = evaluate(patient, "Patient.deceased", {}, r4_model)
+
+# result: `[False]`
+```
 
 ## User-defined functions
 
+The FHIRPath specification includes a set of built-in functions. However, if you need to extend the functionality by adding custom logic, you can define your own functions by providing a table of user-defined functions.
+
+Example:
 ```python
 user_invocation_table = {
     "pow": {
@@ -132,7 +156,15 @@ result = evaluate(
     options={"userInvocationTable": user_invocation_table},
 )
 
-# result: [25, 36, 49]
+# result: `[25, 36, 49]`
 ```
 
 It works similarly to [fhirpath.js](https://github.com/HL7/fhirpath.js/tree/master?tab=readme-ov-file#user-defined-functions)
+
+
+## Development
+
+To activate git pre-commit hook: `autohooks activate`
+
+To run tests: `pytest`
+

{fhirpathpy-2.0.0 → fhirpathpy-2.0.2}/README.md

@@ -51,7 +51,7 @@ patient = {
 }
 
 # Evaluating FHIRPath
-result = evaluate(patient, "Patient.name.where(use='usual').given.first()", [])
+result = evaluate(patient, "Patient.name.where(use='usual').given.first()", {})
 # result: `['Jim']`
 ```
 
@@ -66,11 +66,11 @@ path (string): fhirpath expression, sample 'Patient.name.given'
 
 context (dict): a hash of variable name/value pairs.
 
-model (dict): The "model" data object specific to a domain, e.g. R4.
+model (dict): The "model" data object specific to a domain, e.g. R4. See Using data models documentation below.
 
-options (dict) - Custom options (see the documentation below)
+options (dict) - Custom options.
 
-options.userInvocationTable - a user invocation table used to replace any existing functions or define new ones (see User-defined functions documentation below)
+options.userInvocationTable - a user invocation table used to replace any existing functions or define new ones. See User-defined functions documentation below.
 
 ## compile
 Returns a function that takes a resource and an optional context hash (see "evaluate"), and returns the result of evaluating the given FHIRPath expression on that resource.  The advantage of this function over "evaluate" is that if you have multiple resources, the given FHIRPath expression will only be parsed once
@@ -79,14 +79,38 @@ Returns a function that takes a resource and an optional context hash (see "eval
 
 path (string) - the FHIRPath expression to be parsed.
 
-model (dict) - The "model" data object specific to a domain, e.g. R4.
+model (dict) - The "model" data object specific to a domain, e.g. R4. See Using data models documentation below.
 
 options (dict) - Custom options
 
-options.userInvocationTable - a user invocation table used to replace any existing functions or define new ones (see User-defined functions documentation below)
+options.userInvocationTable - a user invocation table used to replace any existing functions or define new ones. See User-defined functions documentation below.
+
+## Using data models
+
+The fhirpathpy library comes with pre-defined data models for FHIR versions DSTU2, STU3, R4, and R5. These models can be used within your project.
+
+Example:
+```python
+from fhirpathpy.models import models
+
+
+r4_model = models["r4"]
+
+patient = {
+  "resourceType": "Patient",
+  "deceasedBoolean": false,
+}
+
+result = evaluate(patient, "Patient.deceased", {}, r4_model)
+
+# result: `[False]`
+```
 
 ## User-defined functions
 
+The FHIRPath specification includes a set of built-in functions. However, if you need to extend the functionality by adding custom logic, you can define your own functions by providing a table of user-defined functions.
+
+Example:
 ```python
 user_invocation_table = {
     "pow": {
@@ -101,7 +125,14 @@ result = evaluate(
     options={"userInvocationTable": user_invocation_table},
 )
 
-# result: [25, 36, 49]
+# result: `[25, 36, 49]`
 ```
 
-It works similarly to [fhirpath.js](https://github.com/HL7/fhirpath.js/tree/master?tab=readme-ov-file#user-defined-functions)
+It works similarly to [fhirpath.js](https://github.com/HL7/fhirpath.js/tree/master?tab=readme-ov-file#user-defined-functions)
+
+
+## Development
+
+To activate git pre-commit hook: `autohooks activate`
+
+To run tests: `pytest`

{fhirpathpy-2.0.0 → fhirpathpy-2.0.2}/fhirpathpy/__init__.py

@@ -5,7 +5,7 @@ from fhirpathpy.engine.util import arraify, get_data, set_paths, process_user_in
 from fhirpathpy.engine.nodes import FP_Type, ResourceNode
 
 __title__ = "fhirpathpy"
-__version__ = "2.0.0"
+__version__ = "2.0.2"
 __author__ = "beda.software"
 __license__ = "MIT"
 __copyright__ = "Copyright 2025 beda.software"
@@ -103,6 +103,4 @@ 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
-    )
+    return set_paths(apply_parsed_path, parsedPath=parse(path), model=model, options=options)

{fhirpathpy-2.0.0 → fhirpathpy-2.0.2}/fhirpathpy/engine/invocations/equality.py

@@ -82,6 +82,7 @@ def equivalence(ctx, x, y):
         return x_val.deep_equal(y_val)
 
     if isinstance(a, (abc.Mapping, list)) and isinstance(b, (abc.Mapping, list)):
+
         def deep_equal(a, b):
             if isinstance(a, abc.Mapping) and isinstance(b, abc.Mapping):
                 if a.keys() != b.keys():
@@ -89,7 +90,7 @@ def equivalence(ctx, x, y):
                 return all(deep_equal(a[key], b[key]) for key in a)
             elif isinstance(a, list) and isinstance(b, list):
                 return len(a) == len(b) and all(
-                    deep_equal(x, y) for x, y in zip(sorted(a), sorted(b))
+                    deep_equal(x, y) for x, y in zip(sorted(a), sorted(b), strict=True)
                 )
             elif isinstance(a, str) and isinstance(b, str):
                 return normalize_string(a) == normalize_string(b)

{fhirpathpy-2.0.0 → fhirpathpy-2.0.2}/fhirpathpy/engine/nodes.py

@@ -281,7 +281,8 @@ class FP_Quantity(FP_Type):
             return FP_Quantity(result, toUnit)
         return None
 
-    def _compare_years_and_months(self, other, year_units=["year", "years"]):
+    def _compare_years_and_months(self, other, year_units=None):
+        year_units = year_units or ["year", "years"]
         self_value_in_months = self.value
         other_value_in_months = other.value
 

{fhirpathpy-2.0.0 → fhirpathpy-2.0.2}/fhirpathpy/engine/util.py

@@ -107,7 +107,7 @@ def process_user_invocation_table(table):
     return {
         name: {
             **entity,
-            "fn": lambda ctx, inputs, *args: entity["fn"](
+            "fn": lambda ctx, inputs, *args, __fn__=entity["fn"]: __fn__(
                 [get_data(i) for i in inputs], *args
             ),
         }

{fhirpathpy-2.0.0 → fhirpathpy-2.0.2}/fhirpathpy/parser/ASTPathListener.py

@@ -2,19 +2,32 @@ from antlr4.tree.Tree import TerminalNodeImpl
 from fhirpathpy.parser.generated.FHIRPathListener import FHIRPathListener
 
 
+def has_node_type_text(node_type):
+    # In general we need mostly terminal nodes (e.g. Identifier and any Literal)
+    # But the code also uses TypeSpecifier, InvocationExpression and TermExpression
+    return node_type.endswith("Literal") or node_type in [
+        "LiteralTerm",
+        "Identifier",
+        "TypeSpecifier",
+        "InvocationExpression",
+        "TermExpression",
+    ]
+
+
 class ASTPathListener(FHIRPathListener):
     def __init__(self):
         self.parentStack = [{}]
 
     def pushNode(self, nodeType, ctx):
         parentNode = self.parentStack[-1]
-        node = {"type": nodeType, "text": ctx.getText(), "terminalNodeText": []}
-
+        node = {"type": nodeType, "terminalNodeText": []}
+        if has_node_type_text(nodeType):
+            node["text"] = ctx.getText()
         for child in ctx.children:
             if isinstance(child, TerminalNodeImpl):
                 node["terminalNodeText"].append(child.getText())
 
-        if not "children" in parentNode:
+        if "children" not in parentNode:
             parentNode["children"] = []
 
         parentNode["children"].append(node)
@@ -28,7 +41,7 @@ class ASTPathListener(FHIRPathListener):
     def __getattribute__(self, name):
         attr = object.__getattribute__(self, name)
 
-        if name in FHIRPathListener.__dict__ and hasattr(attr, "__call__"):
+        if name in FHIRPathListener.__dict__ and callable(attr):
 
             def newfunc(*args, **kwargs):
                 if name.startswith("enter"):

{fhirpathpy-2.0.0 → fhirpathpy-2.0.2}/pyproject.toml

@@ -12,11 +12,6 @@ exclude = '''
 )
 '''
 
-[tool.isort]
-profile = "black"
-line_length = 100
-skip = [".gitignore"]
-
 [tool.pytest.ini_options]
 minversion = "6.0"
 addopts = "-ra -q --color=yes --cov=fhirpathpy --cov-report=xml"
@@ -62,3 +57,19 @@ Homepage = "https://github.com/beda-software/fhirpath-py"
 Documentation = "https://github.com/beda-software/fhirpath-py#readme"
 Source = "https://github.com/beda-software/fhirpath-py.git"
 Changelog = "https://github.com/beda-software/fhirpath-py/blob/master/CHANGELOG.md"
+
+
+[tool.ruff]
+target-version = "py39"
+line-length = 100
+include = ["app/**/*.py", "tests/**/*.py"]
+
+[tool.ruff.lint]
+select = ["B", "F", "I", "E", "UP", "N", "PL", "PERF"]
+# Black is responsible for E501
+ignore = ["E501"]
+unfixable = ["F401"]
+
+[tool.autohooks]
+mode = "pipenv"
+pre-commit = ["autohooks.plugins.black", "autohooks.plugins.ruff"]