1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-28 00:06:53 +01:00
unleash.unleash/website/docs/sdks/python.md

76 lines
2.0 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
A check of a simple toggle:
```python
client.is_enabled("my_toggle")
2021-05-21 22:26:56 +02:00
```
Specifying a default value:
```python
client.is_enabled("my_toggle", default_value=True)
2021-05-21 22:26:56 +02:00
```
Supplying application context:
```python
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
```
Supplying a fallback function:
```python
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
```
2021-10-11 17:49:29 +02:00
- Must accept the feature name and context as an argument.
2021-05-21 22:26:56 +02:00
- Client will evaluate the fallback function only if exception occurs when calling the `is_enabled()` method i.e. feature flag not found or other general exception.
- If both a `default_value` and `fallback_function` are supplied, client will define the default value by `OR`ing the default value and the output of the fallback function.
## 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)