Skip to content

Commit 50f5a48

Browse files
mschoenlaubmschoenlaub
authored
fix: Fix type checking (#25)
* Fix type checking within client Signed-off-by: Manuel Schönlaub <[email protected]> * Make linter happy Signed-off-by: Manuel Schönlaub <[email protected]> * Migrate Hook Hints to Mapping Signed-off-by: Manuel Schönlaub <[email protected]> * Fix type annotations in FlagEvaluationDetails Signed-off-by: Manuel Schönlaub <[email protected]> * Fix last hint typing Signed-off-by: Manuel Schönlaub <[email protected]> * Rework typing Signed-off-by: Manuel Schönlaub <[email protected]> Signed-off-by: Manuel Schönlaub <[email protected]> Signed-off-by: Manuel Schönlaub <[email protected]>
1 parent f60b44e commit 50f5a48

File tree

10 files changed

+105
-75
lines changed

10 files changed

+105
-75
lines changed

‎open_feature/evaluation_context/evaluation_context.py

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
1+
import typing
2+
3+
14
class EvaluationContext:
2-
def __init__(self, targeting_key: str = None, attributes: dict = None):
5+
def __init__(
6+
self,
7+
targeting_key: typing.Optional[str] = None,
8+
attributes: typing.Optional[dict] = None,
9+
):
310
self.targeting_key = targeting_key
411
self.attributes = attributes or {}
512

‎open_feature/exception/exceptions.py

+9-9
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ class OpenFeatureError(Exception):
1010
"""
1111

1212
def __init__(
13-
self, error_message: typing.Optional[str] = None, error_code: ErrorCode = None
13+
self, error_code: ErrorCode, error_message: typing.Optional[str] = None
1414
):
1515
"""
1616
Constructor for the generic OpenFeatureError.
@@ -35,7 +35,7 @@ def __init__(self, error_message: typing.Optional[str] = None):
3535
@param error_message: an optional string message representing
3636
why the error has been raised
3737
"""
38-
super().__init__(error_message, ErrorCode.FLAG_NOT_FOUND)
38+
super().__init__(ErrorCode.FLAG_NOT_FOUND, error_message)
3939

4040

4141
class GeneralError(OpenFeatureError):
@@ -51,7 +51,7 @@ def __init__(self, error_message: typing.Optional[str] = None):
5151
@param error_message: an optional string message representing why the error
5252
has been raised
5353
"""
54-
super().__init__(error_message, ErrorCode.GENERAL)
54+
super().__init__(ErrorCode.GENERAL, error_message)
5555

5656

5757
class ParseError(OpenFeatureError):
@@ -67,7 +67,7 @@ def __init__(self, error_message: typing.Optional[str] = None):
6767
@param error_message: an optional string message representing why the
6868
error has been raised
6969
"""
70-
super().__init__(error_message, ErrorCode.PARSE_ERROR)
70+
super().__init__(ErrorCode.PARSE_ERROR, error_message)
7171

7272

7373
class TypeMismatchError(OpenFeatureError):
@@ -83,7 +83,7 @@ def __init__(self, error_message: typing.Optional[str] = None):
8383
@param error_message: an optional string message representing why the
8484
error has been raised
8585
"""
86-
super().__init__(error_message, ErrorCode.TYPE_MISMATCH)
86+
super().__init__(ErrorCode.TYPE_MISMATCH, error_message)
8787

8888

8989
class TargetingKeyMissingError(OpenFeatureError):
@@ -92,14 +92,14 @@ class TargetingKeyMissingError(OpenFeatureError):
9292
but one was not provided in the evaluation context.
9393
"""
9494

95-
def __init__(self, error_message: str = None):
95+
def __init__(self, error_message: typing.Optional[str] = None):
9696
"""
9797
Constructor for the TargetingKeyMissingError. The error code for this type of
9898
exception is ErrorCode.TARGETING_KEY_MISSING.
9999
@param error_message: a string message representing why the error has been
100100
raised
101101
"""
102-
super().__init__(error_message, ErrorCode.TARGETING_KEY_MISSING)
102+
super().__init__(ErrorCode.TARGETING_KEY_MISSING, error_message)
103103

104104

105105
class InvalidContextError(OpenFeatureError):
@@ -108,11 +108,11 @@ class InvalidContextError(OpenFeatureError):
108108
requirements.
109109
"""
110110

111-
def __init__(self, error_message: str = None):
111+
def __init__(self, error_message: typing.Optional[str]):
112112
"""
113113
Constructor for the InvalidContextError. The error code for this type of
114114
exception is ErrorCode.INVALID_CONTEXT.
115115
@param error_message: a string message representing why the error has been
116116
raised
117117
"""
118-
super().__init__(error_message, ErrorCode.INVALID_CONTEXT)
118+
super().__init__(ErrorCode.INVALID_CONTEXT, error_message)

‎open_feature/flag_evaluation/flag_evaluation_details.py

+7-5
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,14 @@
44
from open_feature.exception.error_code import ErrorCode
55
from open_feature.flag_evaluation.reason import Reason
66

7+
T = typing.TypeVar("T", covariant=True)
8+
79

810
@dataclass
9-
class FlagEvaluationDetails:
11+
class FlagEvaluationDetails(typing.Generic[T]):
1012
flag_key: str
11-
value: typing.Any
12-
variant: str = None
13-
reason: Reason = None
14-
error_code: ErrorCode = None
13+
value: T
14+
variant: typing.Optional[str] = None
15+
reason: typing.Optional[Reason] = None
16+
error_code: typing.Optional[ErrorCode] = None
1517
error_message: typing.Optional[str] = None

‎open_feature/hooks/hook_context.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,5 @@ class HookContext:
1111
flag_type: FlagType
1212
default_value: typing.Any
1313
evaluation_context: EvaluationContext
14-
client_metadata: dict = None
15-
provider_metadata: dict = None
14+
client_metadata: typing.Optional[dict] = None
15+
provider_metadata: typing.Optional[dict] = None

‎open_feature/hooks/hook_support.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ def error_hooks(
1515
hook_context: HookContext,
1616
exception: Exception,
1717
hooks: typing.List[Hook],
18-
hints: dict,
18+
hints: typing.Optional[typing.Mapping] = None,
1919
):
2020
kwargs = {"hook_context": hook_context, "exception": exception, "hints": hints}
2121
_execute_hooks(
@@ -27,7 +27,7 @@ def after_all_hooks(
2727
flag_type: FlagType,
2828
hook_context: HookContext,
2929
hooks: typing.List[Hook],
30-
hints: dict,
30+
hints: typing.Optional[typing.Mapping] = None,
3131
):
3232
kwargs = {"hook_context": hook_context, "hints": hints}
3333
_execute_hooks(
@@ -40,7 +40,7 @@ def after_hooks(
4040
hook_context: HookContext,
4141
details: FlagEvaluationDetails,
4242
hooks: typing.List[Hook],
43-
hints: dict,
43+
hints: typing.Optional[typing.Mapping] = None,
4444
):
4545
kwargs = {"hook_context": hook_context, "details": details, "hints": hints}
4646
_execute_hooks_unchecked(
@@ -52,7 +52,7 @@ def before_hooks(
5252
flag_type: FlagType,
5353
hook_context: HookContext,
5454
hooks: typing.List[Hook],
55-
hints: dict,
55+
hints: typing.Optional[typing.Mapping] = None,
5656
) -> EvaluationContext:
5757
kwargs = {"hook_context": hook_context, "hints": hints}
5858
executed_hooks = _execute_hooks_unchecked(

‎open_feature/open_feature_api.py

+4-2
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,12 @@
44
from open_feature.open_feature_client import OpenFeatureClient
55
from open_feature.provider.provider import AbstractProvider
66

7-
_provider = None
7+
_provider: typing.Optional[AbstractProvider] = None
88

99

10-
def get_client(name: str = None, version: str = None) -> OpenFeatureClient:
10+
def get_client(
11+
name: typing.Optional[str] = None, version: typing.Optional[str] = None
12+
) -> OpenFeatureClient:
1113
if _provider is None:
1214
raise GeneralError(
1315
error_message="Provider not set. Call set_provider before using get_client"

‎open_feature/open_feature_client.py

+49-31
Original file line numberDiff line numberDiff line change
@@ -24,17 +24,34 @@
2424
from open_feature.provider.no_op_provider import NoOpProvider
2525
from open_feature.provider.provider import AbstractProvider
2626

27-
NUMERIC_TYPES = [FlagType.FLOAT, FlagType.INTEGER]
27+
28+
GetDetailCallable = typing.Union[
29+
typing.Callable[
30+
[str, bool, typing.Optional[EvaluationContext]], FlagEvaluationDetails[bool]
31+
],
32+
typing.Callable[
33+
[str, int, typing.Optional[EvaluationContext]], FlagEvaluationDetails[int]
34+
],
35+
typing.Callable[
36+
[str, float, typing.Optional[EvaluationContext]], FlagEvaluationDetails[float]
37+
],
38+
typing.Callable[
39+
[str, str, typing.Optional[EvaluationContext]], FlagEvaluationDetails[str]
40+
],
41+
typing.Callable[
42+
[str, dict, typing.Optional[EvaluationContext]], FlagEvaluationDetails[dict]
43+
],
44+
]
2845

2946

3047
class OpenFeatureClient:
3148
def __init__(
3249
self,
33-
name: str,
34-
version: str,
35-
context: EvaluationContext = None,
36-
hooks: typing.List[Hook] = None,
37-
provider: AbstractProvider = None,
50+
name: typing.Optional[str],
51+
version: typing.Optional[str],
52+
provider: AbstractProvider,
53+
context: typing.Optional[EvaluationContext] = None,
54+
hooks: typing.Optional[typing.List[Hook]] = None,
3855
):
3956
self.name = name
4057
self.version = version
@@ -49,8 +66,8 @@ def get_boolean_value(
4966
self,
5067
flag_key: str,
5168
default_value: bool,
52-
evaluation_context: EvaluationContext = None,
53-
flag_evaluation_options: FlagEvaluationOptions = None,
69+
evaluation_context: typing.Optional[EvaluationContext] = None,
70+
flag_evaluation_options: typing.Optional[FlagEvaluationOptions] = None,
5471
) -> bool:
5572
return self.evaluate_flag_details(
5673
FlagType.BOOLEAN,
@@ -64,8 +81,8 @@ def get_boolean_details(
6481
self,
6582
flag_key: str,
6683
default_value: bool,
67-
evaluation_context: EvaluationContext = None,
68-
flag_evaluation_options: FlagEvaluationOptions = None,
84+
evaluation_context: typing.Optional[EvaluationContext] = None,
85+
flag_evaluation_options: typing.Optional[FlagEvaluationOptions] = None,
6986
) -> FlagEvaluationDetails:
7087
return self.evaluate_flag_details(
7188
FlagType.BOOLEAN,
@@ -79,8 +96,8 @@ def get_string_value(
7996
self,
8097
flag_key: str,
8198
default_value: str,
82-
evaluation_context: EvaluationContext = None,
83-
flag_evaluation_options: FlagEvaluationOptions = None,
99+
evaluation_context: typing.Optional[EvaluationContext] = None,
100+
flag_evaluation_options: typing.Optional[FlagEvaluationOptions] = None,
84101
) -> str:
85102
return self.evaluate_flag_details(
86103
FlagType.STRING,
@@ -94,8 +111,8 @@ def get_string_details(
94111
self,
95112
flag_key: str,
96113
default_value: str,
97-
evaluation_context: EvaluationContext = None,
98-
flag_evaluation_options: FlagEvaluationOptions = None,
114+
evaluation_context: typing.Optional[EvaluationContext] = None,
115+
flag_evaluation_options: typing.Optional[FlagEvaluationOptions] = None,
99116
) -> FlagEvaluationDetails:
100117
return self.evaluate_flag_details(
101118
FlagType.STRING,
@@ -109,8 +126,8 @@ def get_integer_value(
109126
self,
110127
flag_key: str,
111128
default_value: int,
112-
evaluation_context: EvaluationContext = None,
113-
flag_evaluation_options: FlagEvaluationOptions = None,
129+
evaluation_context: typing.Optional[EvaluationContext] = None,
130+
flag_evaluation_options: typing.Optional[FlagEvaluationOptions] = None,
114131
) -> int:
115132
return self.get_integer_details(
116133
flag_key,
@@ -123,8 +140,8 @@ def get_integer_details(
123140
self,
124141
flag_key: str,
125142
default_value: int,
126-
evaluation_context: EvaluationContext = None,
127-
flag_evaluation_options: FlagEvaluationOptions = None,
143+
evaluation_context: typing.Optional[EvaluationContext] = None,
144+
flag_evaluation_options: typing.Optional[FlagEvaluationOptions] = None,
128145
) -> FlagEvaluationDetails:
129146
return self.evaluate_flag_details(
130147
FlagType.INTEGER,
@@ -138,8 +155,8 @@ def get_float_value(
138155
self,
139156
flag_key: str,
140157
default_value: float,
141-
evaluation_context: EvaluationContext = None,
142-
flag_evaluation_options: FlagEvaluationOptions = None,
158+
evaluation_context: typing.Optional[EvaluationContext] = None,
159+
flag_evaluation_options: typing.Optional[FlagEvaluationOptions] = None,
143160
) -> float:
144161
return self.get_float_details(
145162
flag_key,
@@ -152,8 +169,8 @@ def get_float_details(
152169
self,
153170
flag_key: str,
154171
default_value: float,
155-
evaluation_context: EvaluationContext = None,
156-
flag_evaluation_options: FlagEvaluationOptions = None,
172+
evaluation_context: typing.Optional[EvaluationContext] = None,
173+
flag_evaluation_options: typing.Optional[FlagEvaluationOptions] = None,
157174
) -> FlagEvaluationDetails:
158175
return self.evaluate_flag_details(
159176
FlagType.FLOAT,
@@ -167,8 +184,8 @@ def get_object_value(
167184
self,
168185
flag_key: str,
169186
default_value: dict,
170-
evaluation_context: EvaluationContext = None,
171-
flag_evaluation_options: FlagEvaluationOptions = None,
187+
evaluation_context: typing.Optional[EvaluationContext] = None,
188+
flag_evaluation_options: typing.Optional[FlagEvaluationOptions] = None,
172189
) -> dict:
173190
return self.evaluate_flag_details(
174191
FlagType.OBJECT,
@@ -182,8 +199,8 @@ def get_object_details(
182199
self,
183200
flag_key: str,
184201
default_value: dict,
185-
evaluation_context: EvaluationContext = None,
186-
flag_evaluation_options: FlagEvaluationOptions = None,
202+
evaluation_context: typing.Optional[EvaluationContext] = None,
203+
flag_evaluation_options: typing.Optional[FlagEvaluationOptions] = None,
187204
) -> FlagEvaluationDetails:
188205
return self.evaluate_flag_details(
189206
FlagType.OBJECT,
@@ -198,8 +215,8 @@ def evaluate_flag_details(
198215
flag_type: FlagType,
199216
flag_key: str,
200217
default_value: typing.Any,
201-
evaluation_context: EvaluationContext = None,
202-
flag_evaluation_options: FlagEvaluationOptions = None,
218+
evaluation_context: typing.Optional[EvaluationContext] = None,
219+
flag_evaluation_options: typing.Optional[FlagEvaluationOptions] = None,
203220
) -> FlagEvaluationDetails:
204221
"""
205222
Evaluate the flag requested by the user from the clients provider.
@@ -302,7 +319,7 @@ def _create_provider_evaluation(
302319
flag_type: FlagType,
303320
flag_key: str,
304321
default_value: typing.Any,
305-
evaluation_context: EvaluationContext = None,
322+
evaluation_context: typing.Optional[EvaluationContext] = None,
306323
) -> FlagEvaluationDetails:
307324
"""
308325
Encapsulated method to create a FlagEvaluationDetail from a specific provider.
@@ -324,14 +341,15 @@ def _create_provider_evaluation(
324341
logging.info("No provider configured, using no-op provider.")
325342
self.provider = NoOpProvider()
326343

327-
get_details_callable = {
344+
get_details_callables: typing.Mapping[FlagType, GetDetailCallable] = {
328345
FlagType.BOOLEAN: self.provider.resolve_boolean_details,
329346
FlagType.INTEGER: self.provider.resolve_integer_details,
330347
FlagType.FLOAT: self.provider.resolve_float_details,
331348
FlagType.OBJECT: self.provider.resolve_object_details,
332349
FlagType.STRING: self.provider.resolve_string_details,
333-
}.get(flag_type)
350+
}
334351

352+
get_details_callable = get_details_callables.get(flag_type)
335353
if not get_details_callable:
336354
raise GeneralError(error_message="Unknown flag type")
337355

0 commit comments

Comments
 (0)