merge main and adapt code to follow 8f2caba

leohoare · leohoare · commit cd20c124b231 · 2025-02-02T20:23:57.000+11:00
Signed-off-by: leohoare &lt;leo@insight.co&gt;
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -46,7 +46,7 @@ jobs:
 
       - if: matrix.python-version == '3.11'
         name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v5.1.2
+        uses: codecov/codecov-action@v5.3.1
         with:
           flags: unittests # optional
           name: coverage # optional
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -24,8 +24,10 @@ jobs:
       - uses: googleapis/release-please-action@v4
         id: release
         with:
+          command: manifest
           token: ${{secrets.RELEASE_PLEASE_ACTION_TOKEN}}
-          target-branch: main
+          default-branch: main
+          signoff: "OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com>"
     outputs:
       release_created: ${{ steps.release.outputs.release_created }}
       release_tag_name: ${{ steps.release.outputs.tag_name }}
@@ -37,12 +39,14 @@ jobs:
       # IMPORTANT: this permission is mandatory for trusted publishing to pypi
       id-token: write
     needs: release-please
-    if: ${{ needs.release-please.outputs.release_created }}
-    container:
-      image: "python:3.13"
+    if: ${{ fromJSON(needs.release-please.outputs.release_created || false) }}
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+
+      - uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5
+        with:
+          python-version: '3.13'
 
       - name: Upgrade pip
         run: pip install --upgrade pip
@@ -54,5 +58,4 @@ jobs:
         run: hatch build
 
       - name: Publish a Python distribution to PyPI
-        # pinning till fixed https://github.com/pypa/gh-action-pypi-publish/issues/300
-        uses: pypa/gh-action-pypi-publish@release/v1.11
+        uses: pypa/gh-action-pypi-publish@release/v1
diff --git a/.gitmodules b/.gitmodules
@@ -1,3 +1,3 @@
-[submodule "test-harness"]
-	path = test-harness
-	url = https://github.com/open-feature/test-harness.git
+[submodule "spec"]
+	path = spec
+	url = https://github.com/open-feature/spec.git
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,7 +1,7 @@
 default_stages: [commit]
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.9.1
+    rev: v0.9.4
     hooks:
       - id: ruff
         args: [--fix]
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -1 +1 @@
-{".":"0.7.4"}
+{".":"0.7.5"}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,52 @@
 # Changelog
 
+## [0.7.5](https://github.com/open-feature/python-sdk/compare/v0.7.4...v0.7.5) (2025-01-31)
+
+
+### ⚠ BREAKING CHANGES
+
+The signature of the `finally_after` hook stage has been changed. The signature now includes the `evaluation details`, as per the [OpenFeature specification](https://openfeature.dev/specification/sections/hooks#requirement-438). To migrate, update any hook that implements the `finally_after` stage to accept `evaluation details` as the second argument.
+
+* Add evaluation details to finally hook stage [#403](https://github.com/open-feature/python-sdk/issues/403) ([#423](https://github.com/open-feature/python-sdk/issues/423)) ([9e9bb5c](https://github.com/open-feature/python-sdk/commit/9e9bb5c6269cfa5d9c9ffc7141c6dc63e399cdca))
+
+
+### 🐛 Bug Fixes
+
+* Finally hooks do not get called when the provider is not ready [#424](https://github.com/open-feature/python-sdk/issues/424) ([#425](https://github.com/open-feature/python-sdk/issues/425)) ([8f2caba](https://github.com/open-feature/python-sdk/commit/8f2cabaa32f595304ecd6964b6ae21909672ef4a))
+
+
+### ✨ New Features
+
+* Add evaluation details to finally hook stage [#403](https://github.com/open-feature/python-sdk/issues/403) ([#423](https://github.com/open-feature/python-sdk/issues/423)) ([9e9bb5c](https://github.com/open-feature/python-sdk/commit/9e9bb5c6269cfa5d9c9ffc7141c6dc63e399cdca))
+* Update test harness (add assertions) [#1467](https://github.com/open-feature/python-sdk/issues/1467) ([#415](https://github.com/open-feature/python-sdk/issues/415)) ([f559d1b](https://github.com/open-feature/python-sdk/commit/f559d1b27a096c585bd81f32f6472039c9ce5e03))
+* Update test harness (copy test files) [#1467](https://github.com/open-feature/python-sdk/issues/1467) ([#416](https://github.com/open-feature/python-sdk/issues/416)) ([192f7c4](https://github.com/open-feature/python-sdk/commit/192f7c40bd07616030e86ff2aba7e993390d4af4))
+
+
+### 🧹 Chore
+
+* **config:** migrate config renovate.json ([26bc964](https://github.com/open-feature/python-sdk/commit/26bc9642270f9371170ce8ab2d9b938a0fca187e))
+* **config:** migrate renovate config ([#408](https://github.com/open-feature/python-sdk/issues/408)) ([26bc964](https://github.com/open-feature/python-sdk/commit/26bc9642270f9371170ce8ab2d9b938a0fca187e))
+* **deps:** update actions/setup-python digest to 4237552 ([#422](https://github.com/open-feature/python-sdk/issues/422)) ([9c2ed71](https://github.com/open-feature/python-sdk/commit/9c2ed71c6efdc2ece9ae89cf91f3b019c44b0033))
+* **deps:** update codecov/codecov-action action to v5.1.0 ([#401](https://github.com/open-feature/python-sdk/issues/401)) ([0459330](https://github.com/open-feature/python-sdk/commit/0459330cb91e9b28a15bdd380aec4c56c3b5d8df))
+* **deps:** update codecov/codecov-action action to v5.1.1 ([#402](https://github.com/open-feature/python-sdk/issues/402)) ([a6907d6](https://github.com/open-feature/python-sdk/commit/a6907d610e6dde1eecef56f25f3cc6a569b6eee4))
+* **deps:** update codecov/codecov-action action to v5.1.2 ([#405](https://github.com/open-feature/python-sdk/issues/405)) ([1c56480](https://github.com/open-feature/python-sdk/commit/1c564804afad474151489d695af7fa0409a768c6))
+* **deps:** update codecov/codecov-action action to v5.2.0 ([#418](https://github.com/open-feature/python-sdk/issues/418)) ([b69e81a](https://github.com/open-feature/python-sdk/commit/b69e81a63676240ef2abb98e96d2954a50f0c20a))
+* **deps:** update codecov/codecov-action action to v5.3.0 ([#420](https://github.com/open-feature/python-sdk/issues/420)) ([6af37b1](https://github.com/open-feature/python-sdk/commit/6af37b1c2bc2e10161673af5726932129ed02506))
+* **deps:** update codecov/codecov-action action to v5.3.1 ([#421](https://github.com/open-feature/python-sdk/issues/421)) ([e99e481](https://github.com/open-feature/python-sdk/commit/e99e481524ccfbea5bc7554d531f9c883dce6b5f))
+* **deps:** update googleapis/release-please-action action to v4 ([#428](https://github.com/open-feature/python-sdk/issues/428)) ([99905d5](https://github.com/open-feature/python-sdk/commit/99905d57f8b21a640f8f64f177679eee127ebba6))
+* **deps:** update pre-commit hook astral-sh/ruff-pre-commit to v0.8.1 ([#398](https://github.com/open-feature/python-sdk/issues/398)) ([043385a](https://github.com/open-feature/python-sdk/commit/043385a8369e253a5e0ad1e184e980f8e8d7e5c7))
+* **deps:** update pre-commit hook astral-sh/ruff-pre-commit to v0.8.2 ([#400](https://github.com/open-feature/python-sdk/issues/400)) ([2b6e210](https://github.com/open-feature/python-sdk/commit/2b6e210bc9dda72335e646fc60cde79b5bdd76c1))
+* **deps:** update pre-commit hook astral-sh/ruff-pre-commit to v0.8.3 ([#404](https://github.com/open-feature/python-sdk/issues/404)) ([01ec388](https://github.com/open-feature/python-sdk/commit/01ec388d2d93fc87a4f2eca856cf507cbee35785))
+* **deps:** update pre-commit hook astral-sh/ruff-pre-commit to v0.8.4 ([#406](https://github.com/open-feature/python-sdk/issues/406)) ([3296d3b](https://github.com/open-feature/python-sdk/commit/3296d3b229d41c7f879adfb7ab36e19de36617e4))
+* **deps:** update pre-commit hook astral-sh/ruff-pre-commit to v0.8.6 ([#410](https://github.com/open-feature/python-sdk/issues/410)) ([7f9d422](https://github.com/open-feature/python-sdk/commit/7f9d422497a6d8392eee18ccfd12050eef7a2338))
+* **deps:** update pre-commit hook astral-sh/ruff-pre-commit to v0.9.0 ([#411](https://github.com/open-feature/python-sdk/issues/411)) ([bc6e333](https://github.com/open-feature/python-sdk/commit/bc6e3332157788ec3f8037f68b9087e26a4634b5))
+* **deps:** update pre-commit hook astral-sh/ruff-pre-commit to v0.9.1 ([#412](https://github.com/open-feature/python-sdk/issues/412)) ([cbace6a](https://github.com/open-feature/python-sdk/commit/cbace6a24c3fa091242aedd4f7c2e8de4332e463))
+* **deps:** update pre-commit hook astral-sh/ruff-pre-commit to v0.9.2 ([#414](https://github.com/open-feature/python-sdk/issues/414)) ([9304292](https://github.com/open-feature/python-sdk/commit/9304292ea91580cf8cbfee7dbde922caa818189d))
+* **deps:** update pre-commit hook astral-sh/ruff-pre-commit to v0.9.3 ([#419](https://github.com/open-feature/python-sdk/issues/419)) ([8f9cc7c](https://github.com/open-feature/python-sdk/commit/8f9cc7ca96a1210bab104e6342b4f7d1553bad3b))
+* **deps:** update pre-commit hook astral-sh/ruff-pre-commit to v0.9.4 ([#426](https://github.com/open-feature/python-sdk/issues/426)) ([f726706](https://github.com/open-feature/python-sdk/commit/f72670689d25b82c8d54cacde3b1af179e0bc7e6))
+* **deps:** update pre-commit hook pre-commit/mirrors-mypy to v1.14.0 ([#407](https://github.com/open-feature/python-sdk/issues/407)) ([89d6997](https://github.com/open-feature/python-sdk/commit/89d6997b1fe04df82e0873de7e7a1ea1aca2b071))
+* **deps:** update pre-commit hook pre-commit/mirrors-mypy to v1.14.1 ([#409](https://github.com/open-feature/python-sdk/issues/409)) ([2c1840c](https://github.com/open-feature/python-sdk/commit/2c1840c87d00177d87b93135a38a7df98a9f6c0b))
+
 ## [0.7.4](https://github.com/open-feature/python-sdk/compare/v0.7.3...v0.7.4) (2024-11-25)
 
 
diff --git a/README.md b/README.md
@@ -19,8 +19,8 @@
 
   <!-- x-release-please-start-version -->
 
-  <a href="https://github.com/open-feature/python-sdk/releases/tag/v0.7.4">
-    <img alt="Latest version" src="https://img.shields.io/static/v1?label=release&message=v0.7.4&color=blue&style=for-the-badge" />
+  <a href="https://github.com/open-feature/python-sdk/releases/tag/v0.7.5">
+    <img alt="Latest version" src="https://img.shields.io/static/v1?label=release&message=v0.7.5&color=blue&style=for-the-badge" />
   </a>
 
   <!-- x-release-please-end -->
@@ -60,13 +60,13 @@
 #### Pip install
 
 ```bash
-pip install openfeature-sdk==0.7.4
+pip install openfeature-sdk==0.7.5
 ```
 
 #### requirements.txt
 
 ```bash
-openfeature-sdk==0.7.4
+openfeature-sdk==0.7.5
 ```
 
 ```python
diff --git a/openfeature/client.py b/openfeature/client.py
@@ -547,21 +547,22 @@ async def evaluate_flag_details_async(
                 flag_evaluation_options,
             )
         )
-        error_code = self._assert_provider_status(
-            flag_type,
-            hook_context,
-            reversed_merged_hooks,
-            hook_hints,
-        )
-        if error_code:
-            return FlagEvaluationDetails(
-                flag_key=flag_key,
-                value=default_value,
-                reason=Reason.ERROR,
-                error_code=error_code,
-            )
 
         try:
+            error_code = self._assert_provider_status(
+                flag_type,
+                hook_context,
+                reversed_merged_hooks,
+                hook_hints,
+            )
+            if error_code:
+                return FlagEvaluationDetails(
+                    flag_key=flag_key,
+                    value=default_value,
+                    reason=Reason.ERROR,
+                    error_code=error_code,
+                )
+
             merged_context = self._before_hooks_and_merge_context(
                 flag_type,
                 hook_context,
@@ -647,21 +648,22 @@ def evaluate_flag_details(
                 flag_evaluation_options,
             )
         )
-        error_code = self._assert_provider_status(
-            flag_type,
-            hook_context,
-            reversed_merged_hooks,
-            hook_hints,
-        )
-        if error_code:
-            return FlagEvaluationDetails(
-                flag_key=flag_key,
-                value=default_value,
-                reason=Reason.ERROR,
-                error_code=error_code,
-            )
 
         try:
+            error_code = self._assert_provider_status(
+                flag_type,
+                hook_context,
+                reversed_merged_hooks,
+                hook_hints,
+            )
+            if error_code:
+                return FlagEvaluationDetails(
+                    flag_key=flag_key,
+                    value=default_value,
+                    reason=Reason.ERROR,
+                    error_code=error_code,
+                )
+
             merged_context = self._before_hooks_and_merge_context(
                 flag_type,
                 hook_context,
@@ -691,13 +693,14 @@ def evaluate_flag_details(
         except OpenFeatureError as err:
             error_hooks(flag_type, hook_context, err, reversed_merged_hooks, hook_hints)
 
-            return FlagEvaluationDetails(
+            flag_evaluation = FlagEvaluationDetails(
                 flag_key=flag_key,
                 value=default_value,
                 reason=Reason.ERROR,
                 error_code=err.error_code,
                 error_message=err.error_message,
             )
+            return flag_evaluation
         # Catch any type of exception here since the user can provide any exception
         # in the error hooks
         except Exception as err:  # pragma: no cover
@@ -708,16 +711,23 @@ def evaluate_flag_details(
             error_hooks(flag_type, hook_context, err, reversed_merged_hooks, hook_hints)
 
             error_message = getattr(err, "error_message", str(err))
-            return FlagEvaluationDetails(
+            flag_evaluation = FlagEvaluationDetails(
                 flag_key=flag_key,
                 value=default_value,
                 reason=Reason.ERROR,
                 error_code=ErrorCode.GENERAL,
                 error_message=error_message,
             )
+            return flag_evaluation
 
         finally:
-            after_all_hooks(flag_type, hook_context, reversed_merged_hooks, hook_hints)
+            after_all_hooks(
+                flag_type,
+                hook_context,
+                flag_evaluation,
+                reversed_merged_hooks,
+                hook_hints,
+            )
 
     async def _create_provider_evaluation_async(
         self,
diff --git a/openfeature/hook/__init__.py b/openfeature/hook/__init__.py
@@ -109,7 +109,12 @@ def error(
         """
         pass
 
-    def finally_after(self, hook_context: HookContext, hints: HookHints) -> None:
+    def finally_after(
+        self,
+        hook_context: HookContext,
+        details: FlagEvaluationDetails[typing.Any],
+        hints: HookHints,
+    ) -> None:
         """
         Run after flag evaluation, including any error processing.
         This will always run. Errors will be swallowed.
diff --git a/openfeature/hook/_hook_support.py b/openfeature/hook/_hook_support.py
@@ -25,10 +25,11 @@ def error_hooks(
 def after_all_hooks(
     flag_type: FlagType,
     hook_context: HookContext,
+    details: FlagEvaluationDetails[typing.Any],
     hooks: typing.List[Hook],
     hints: typing.Optional[HookHints] = None,
 ) -> None:
-    kwargs = {"hook_context": hook_context, "hints": hints}
+    kwargs = {"hook_context": hook_context, "details": details, "hints": hints}
     _execute_hooks(
         flag_type=flag_type, hooks=hooks, hook_method=HookType.FINALLY_AFTER, **kwargs
     )
diff --git a/openfeature/version.py b/openfeature/version.py
@@ -1 +1 @@
-__version__ = "0.7.4"
+__version__ = "0.7.5"
diff --git a/pyproject.toml b/pyproject.toml
@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "openfeature_sdk"
-version = "0.7.4"
+version = "0.7.5"
 description = "Standardizing Feature Flagging for Everyone"
 readme = "README.md"
 authors = [{ name = "OpenFeature", email = "openfeature-core@groups.io" }]
@@ -48,8 +48,8 @@ cov = [
     "cov-report",
 ]
 e2e = [
-    "git submodule update --init",
-    "cp test-harness/features/evaluation.feature tests/features/",
+    "git submodule add --force https://github.com/open-feature/spec.git spec",
+    "cp spec/specification/assets/gherkin/* tests/features/",
     "behave tests/features/",
     "rm tests/features/*.feature",
 ]
diff --git a/release-please-config.json b/release-please-config.json
@@ -1,6 +1,5 @@
 {
   "bootstrap-sha": "198336b098f167f858675235214cc907ede10182",
-  "signoff": "OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com>",
   "packages": {
     ".": {
       "release-type": "python",
diff --git a/test-harness b/test-harness
diff --git a/tests/features/data.py b/tests/features/data.py
@@ -69,4 +69,16 @@ def context_func(flag: InMemoryFlag, evaluation_context: EvaluationContext):
         variants={"one": "uno", "two": "dos"},
         default_variant="one",
     ),
+    "metadata-flag": InMemoryFlag(
+        state=InMemoryFlag.State.ENABLED,
+        default_variant="on",
+        variants={"on": True, "off": False},
+        context_evaluator=None,
+        flag_metadata={
+            "string": "1.0.2",
+            "integer": 2,
+            "float": 0.1,
+            "boolean": True,
+        },
+    ),
 }
diff --git a/tests/features/steps/flag_steps.py b/tests/features/steps/flag_steps.py
@@ -0,0 +1,22 @@
+from behave import given, when
+
+
+@given('a {flag_type}-flag with key "{flag_key}" and a default value "{default_value}"')
+def step_impl_flag(context, flag_type: str, flag_key, default_value):
+    context.flag = (flag_type, flag_key, default_value)
+
+
+@when("the flag was evaluated with details")
+def step_impl_evaluation(context):
+    client = context.client
+    flag_type, key, default_value = context.flag
+    if flag_type.lower() == "string":
+        context.evaluation = client.get_string_details(key, default_value)
+    elif flag_type.lower() == "boolean":
+        context.evaluation = client.get_boolean_details(key, default_value)
+    elif flag_type.lower() == "object":
+        context.evaluation = client.get_object_details(key, default_value)
+    elif flag_type.lower() == "float":
+        context.evaluation = client.get_float_details(key, default_value)
+    elif flag_type.lower() == "integer":
+        context.evaluation = client.get_integer_details(key, default_value)
diff --git a/tests/features/steps/hooks_steps.py b/tests/features/steps/hooks_steps.py
diff --git a/tests/features/steps/metadata_steps.py b/tests/features/steps/metadata_steps.py
diff --git a/tests/features/steps/steps.py b/tests/features/steps/steps.py
diff --git a/tests/hook/test_hook_support.py b/tests/hook/test_hook_support.py
diff --git a/tests/test_client.py b/tests/test_client.py
