fix!: restrict exported names with __all__ (#306)

* fix!: restrict exported names with __all__ Signed-off-by: Federico Bond <[email protected]> * restrict codecov upload to Python 3.11 Signed-off-by: gruebel <[email protected]> * disable codecov ci fail on error Signed-off-by: Michael Beemer <[email protected]> --------- Signed-off-by: Federico Bond <[email protected]> Signed-off-by: gruebel <[email protected]> Signed-off-by: Michael Beemer <[email protected]> Co-authored-by: gruebel <[email protected]> Co-authored-by: Michael Beemer <[email protected]>
open-feature · Apr 9, 2024 · 34ac91c · 34ac91c
1 parent 9966c14
commit 34ac91c
Show file tree

Hide file tree

Showing 10 changed files with 56 additions and 2 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -43,12 +43,13 @@ jobs:
       - name: Run E2E tests with behave
         run: hatch run e2e
 
-      - name: Upload coverage to Codecov
+      - if: matrix.python-version == '3.11'
+        name: Upload coverage to Codecov
         uses: codecov/codecov-action@v3
         with:
           flags: unittests # optional
           name: coverage # optional
-          fail_ci_if_error: true # optional (default = false)
+          fail_ci_if_error: false # optional (default = false)
           verbose: true # optional (default = false)
 
   lint:

diff --git a/openfeature/api.py b/openfeature/api.py
@@ -13,6 +13,21 @@
 from openfeature.provider._registry import provider_registry
 from openfeature.provider.metadata import Metadata
 
+__all__ = [
+    "get_client",
+    "set_provider",
+    "clear_providers",
+    "get_provider_metadata",
+    "get_evaluation_context",
+    "set_evaluation_context",
+    "add_hooks",
+    "clear_hooks",
+    "get_hooks",
+    "shutdown",
+    "add_handler",
+    "remove_handler",
+]
+
 _evaluation_context = EvaluationContext()
 
 _hooks: typing.List[Hook] = []

diff --git a/openfeature/client.py b/openfeature/client.py
@@ -30,6 +30,11 @@
 from openfeature.provider import FeatureProvider, ProviderStatus
 from openfeature.provider._registry import provider_registry
 
+__all__ = [
+    "ClientMetadata",
+    "OpenFeatureClient",
+]
+
 logger = logging.getLogger("openfeature")
 
 GetDetailCallable = typing.Union[

diff --git a/openfeature/evaluation_context.py b/openfeature/evaluation_context.py
@@ -1,6 +1,8 @@
 import typing
 from dataclasses import dataclass, field
 
+__all__ = ["EvaluationContext"]
+
 
 @dataclass
 class EvaluationContext:

diff --git a/openfeature/event.py b/openfeature/event.py
@@ -7,6 +7,8 @@
 from openfeature.exception import ErrorCode
 from openfeature.provider import ProviderStatus
 
+__all__ = ["ProviderEvent", "ProviderEventDetails", "EventDetails", "EventHandler"]
+
 
 class ProviderEvent(Enum):
     PROVIDER_READY = "PROVIDER_READY"

diff --git a/openfeature/exception.py b/openfeature/exception.py
@@ -4,6 +4,19 @@
 from collections.abc import Mapping
 from enum import Enum
 
+__all__ = [
+    "OpenFeatureError",
+    "ProviderNotReadyError",
+    "ProviderFatalError",
+    "FlagNotFoundError",
+    "GeneralError",
+    "ParseError",
+    "TypeMismatchError",
+    "TargetingKeyMissingError",
+    "InvalidContextError",
+    "ErrorCode",
+]
+
 
 class OpenFeatureError(Exception):
     """

diff --git a/openfeature/flag_evaluation.py b/openfeature/flag_evaluation.py
@@ -11,6 +11,16 @@
     from openfeature.hook import Hook, HookHints
 
 
+__all__ = [
+    "FlagType",
+    "Reason",
+    "FlagMetadata",
+    "FlagEvaluationDetails",
+    "FlagEvaluationOptions",
+    "FlagResolutionDetails",
+]
+
+
 class FlagType(StrEnum):
     BOOLEAN = "BOOLEAN"
     STRING = "STRING"

diff --git a/openfeature/hook/__init__.py b/openfeature/hook/__init__.py
@@ -12,6 +12,8 @@
     from openfeature.client import ClientMetadata
     from openfeature.provider.metadata import Metadata
 
+__all__ = ["HookType", "HookContext", "HookHints", "Hook"]
+
 
 class HookType(Enum):
     BEFORE = "before"

diff --git a/openfeature/provider/__init__.py b/openfeature/provider/__init__.py
@@ -7,6 +7,8 @@
 
 from .metadata import Metadata
 
+__all__ = ["ProviderStatus", "FeatureProvider", "Metadata"]
+
 
 class ProviderStatus(Enum):
     NOT_READY = "NOT_READY"

diff --git a/openfeature/provider/provider.py b/openfeature/provider/provider.py
@@ -8,6 +8,8 @@
 from openfeature.provider import FeatureProvider
 from openfeature.provider.metadata import Metadata
 
+__all__ = ["AbstractProvider"]
+
 
 class AbstractProvider(FeatureProvider):
     def initialize(self, evaluation_context: EvaluationContext) -> None: