1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-10-18 20:09:08 +02:00
unleash.unleash/website/docs/sdks/python.md

78 lines
2.6 KiB
Markdown
Raw Normal View History

---
id: python_sdk
title: Python SDK
---
2021-05-18 13:31:54 +02:00
> You will need your `API URL` and your `API token` in order to connect the Client SDK to you Unleash instance. You can find this information in the “Admin” section Unleash management UI. [Read more](../user_guide/api-token)
2021-05-04 16:08:21 +02:00
```python
from UnleashClient import UnleashClient
2021-05-04 16:08:21 +02:00
client = UnleashClient(
url="<API url>",
app_name="my-python-app",
2021-05-18 13:31:54 +02:00
custom_headers={'Authorization': '<API token>'})
2021-05-04 16:08:21 +02:00
client.initialize_client()
2021-05-04 16:08:21 +02:00
client.is_enabled("unleash.beta.variants")
```
## Checking if a feature is enabled {#checking-if-a-feature-is-enabled}
2021-05-21 22:26:56 +02:00
Check a feature's status:
2021-05-21 22:26:56 +02:00
```Python title="Check whether a feature is enabled"
client.is_enabled("my_toggle")
2021-05-21 22:26:56 +02:00
```
To supply application context, use the second positional argument:
2021-05-21 22:26:56 +02:00
```Python title="Check whether a feature is enabled for the given context"
2021-05-21 22:26:56 +02:00
app_context = {"userId": "test@email.com"}
client.is_enabled("user_id_toggle", app_context)
2021-05-21 22:26:56 +02:00
```
### Fallback function and default values
2021-05-21 22:26:56 +02:00
You can specify a fallback function for cases where the client doesn't recognize the toggle by using the `fallback_function` keyword argument:
```Python title="Check a feature status, using a fallback if the feature is unrecognized."
2021-05-21 22:26:56 +02:00
def custom_fallback(feature_name: str, context: dict) -> bool:
return True
client.is_enabled("my_toggle", fallback_function=custom_fallback)
2021-05-21 22:26:56 +02:00
```
You can also use the `fallback_function` argument to replace the obsolete `default_value` keyword argument by using a lambda that ignores its inputs. Whatever the lambda returns will be used as the default value.
```Python title="Use fallback_function to provide a default value"
client.is_enabled("my_toggle", fallback_function=lambda feature_name, context: True)
```
The fallback function **must** accept the feature name and context as positional arguments in that order.
The client will evaluate the fallback function only if an exception occurs when calling the `is_enabled()` method. This happens when the client can't find the feature flag. The client *may* also throw other, general exceptions.
2021-05-21 22:26:56 +02:00
## Getting a variant {#getting-a-variant}
2021-05-21 22:26:56 +02:00
Checking for a variant:
```python
context = {'userId': '2'} # Context must have userId, sessionId, or remoteAddr. If none are present, distribution will be random.
variant = client.get_variant("my_variant_toggle", context)
2021-05-21 22:26:56 +02:00
print(variant)
> {
> "name": "variant1",
> "payload": {
> "type": "string",
> "value": "val1"
> },
> "enabled": True
> }
```
2021-05-04 16:08:21 +02:00
Read more at [github.com/Unleash/unleash-client-python](https://github.com/Unleash/unleash-client-python)