Skip to content

Commit 10564ee

Browse files
jobs62jobs62
committed
♻️ chore: refactor profile logic
1 parent 0b939de commit 10564ee

20 files changed

Lines changed: 26546 additions & 385 deletions

‎.github/actions/setup-test/action.yml‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,6 @@ description: "Setup toolchain and run smoke test"
33
runs:
44
using: composite
55
steps:
6-
- name: ⬇️ Import Outscale API description
7-
run: make init
8-
shell: bash
96
- name: ⬇️ Install uv
107
uses: astral-sh/setup-uv@v6
118
- name: ⬇️ Setup Python

‎.github/scripts/release-build.sh‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,8 @@ branch_name="autobuild-$new_sdk_version"
2121
git branch -m $branch_name
2222

2323
# Update osc-api version
24-
cd "$root/osc_sdk_python/osc-api"
25-
git reset --hard $osc_api_version
26-
cd ..
27-
git add osc-api
28-
cd "$root"
24+
curl --retry 10 -o "${root}/osc_sdk_python/resources/outscale.yaml" "https://raw.githubusercontent.com/outscale/osc-api/refs/tags/${osc_api_version}/outscale.yaml"
25+
git add "${root}/osc_sdk_python/resources/outscale.yaml"
2926

3027
# Setup new SDK version
3128
for f in "$root/README.md" "$root/osc_sdk_python/VERSION"; do

‎.gitmodules‎

Lines changed: 0 additions & 3 deletions
This file was deleted.

‎Makefile‎

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,28 +19,17 @@ test-lint:
1919
@uv tool run ruff check
2020

2121
.PHONY: test-int
22-
test-int: init
22+
test-int:
2323
@uv run pytest -s
2424

2525
.PHONY: package
26-
package: init
26+
package:
2727
@uv build
2828

2929
.PHONY: upload-package
3030
upload-package: package
3131
@uv publish --trusted-publishing=always
3232

33-
.PHONY: osc-api-update
34-
osc-api-update:
35-
cd osc_sdk_python/osc-api/; git fetch; git checkout origin/master; cd ..; git add osc-api
36-
37-
.PHONY: init
38-
init: osc_sdk_python/osc-api/outscale.yaml
39-
@echo Initialization: OK
40-
41-
osc_sdk_python/osc-api/outscale.yaml:
42-
git submodule update --init .
43-
4433
.PHONY: clean
4534
clean:
4635
@echo cleaning...

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,8 +149,8 @@ Example:
149149
```python
150150
from osc_sdk_python import Gateway
151151
152-
gw = Gateway(email="[email protected]", password="yourAccountPassword")
153-
keys = gw.ReadAccessKeys()
152+
with Gateway(email="[email protected]", password="yourAccountPassword") as gw:
153+
keys = gw.ReadAccessKeys()
154154
```
155155

156156
### Retry Options

‎docs/examples.md‎

Lines changed: 33 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,10 @@ Basic usage with the default profile:
55
```python
66
from osc_sdk_python import Gateway
77

8-
gw = Gateway()
9-
10-
# Example: list VMs
11-
vms = gw.ReadVms()
12-
print(vms)
8+
with Gateway() as gw:
9+
# Example: list VMs
10+
vms = gw.ReadVms()
11+
print(vms)
1312
```
1413

1514
Using a specific profile:
@@ -30,21 +29,20 @@ Example:
3029
```python
3130
from osc_sdk_python import Gateway
3231

33-
gw = Gateway(profile="profile_1")
32+
with Gateway(profile="profile_1") as gw:
33+
# Calls with API action as method
34+
result = gw.ReadSecurityGroups(Filters={"SecurityGroupNames": ["default"]})
35+
result = gw.CreateVms(ImageId="ami-3e158364", VmType="tinav4.c2r4")
3436

35-
# Calls with API action as method
36-
result = gw.ReadSecurityGroups(Filters={"SecurityGroupNames": ["default"]})
37-
result = gw.CreateVms(ImageId="ami-3e158364", VmType="tinav4.c2r4")
38-
39-
# Or raw calls:
40-
result = gw.raw("ReadVms")
41-
result = gw.raw(
42-
"CreateVms",
43-
ImageId="ami-xx",
44-
BlockDeviceMappings=[{"/dev/sda1": {"Size": 10}}],
45-
SecurityGroupIds=["sg-aaa", "sg-bbb"],
46-
Wrong="wrong",
47-
)
37+
# Or raw calls:
38+
result = gw.raw("ReadVms")
39+
result = gw.raw(
40+
"CreateVms",
41+
ImageId="ami-xx",
42+
BlockDeviceMappings=[{"/dev/sda1": {"Size": 10}}],
43+
SecurityGroupIds=["sg-aaa", "sg-bbb"],
44+
Wrong="wrong",
45+
)
4846
```
4947

5048
---
@@ -57,15 +55,14 @@ result = gw.raw(
5755
from osc_sdk_python import Gateway
5856

5957
if __name__ == "__main__":
60-
gw = Gateway()
61-
62-
print("Your virtual machines:")
63-
for vm in gw.ReadVms()["Vms"]:
64-
print(vm["VmId"])
65-
66-
print("\nYour volumes:")
67-
for volume in gw.ReadVolumes()["Volumes"]:
68-
print(volume["VolumeId"])
58+
with Gateway() as gw:
59+
print("Your virtual machines:")
60+
for vm in gw.ReadVms()["Vms"]:
61+
print(vm["VmId"])
62+
63+
print("\nYour volumes:")
64+
for volume in gw.ReadVolumes()["Volumes"]:
65+
print(volume["VolumeId"])
6966
```
7067

7168
### Enabling logs
@@ -74,16 +71,15 @@ if __name__ == "__main__":
7471
from osc_sdk_python import *
7572

7673
if __name__ == "__main__":
77-
gw = Gateway(profile="profile_1")
78-
79-
# 'what' can be LOG_KEEP_ONLY_LAST_REQ or LOG_ALL
80-
# Here we print logs in memory, standard output and standard error
81-
gw.log.config(type=LOG_MEMORY | LOG_STDIO | LOG_STDERR, what=LOG_KEEP_ONLY_LAST_REQ)
74+
with Gateway(profile="profile_1") as gw:
75+
# 'what' can be LOG_KEEP_ONLY_LAST_REQ or LOG_ALL
76+
# Here we print logs in memory, standard output and standard error
77+
gw.log.config(type=LOG_MEMORY | LOG_STDIO | LOG_STDERR, what=LOG_KEEP_ONLY_LAST_REQ)
8278

83-
result = gw.raw("ReadVms")
79+
result = gw.raw("ReadVms")
8480

85-
last_request = gw.log.str()
86-
print(last_request)
81+
last_request = gw.log.str()
82+
print(last_request)
8783
```
8884

89-
Usage examples can be combined with the official [Outscale API documentation](https://docs.outscale.com/en/userguide/Home.html).
85+
Usage examples can be combined with the official [Outscale API documentation](https://docs.outscale.com/en/userguide/Home.html).

‎local-tests.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ export OSC_TEST_PASSWORD=ashita wa dochida
22
export OSC_TEST_LOGIN=joe
33
export OSC_SECRET_KEY=0000001111112222223333334444445555555666
44
export OSC_ACCESS_KEY=11112211111110000000
5-
export OSC_ENDPOINT_API=http://127.0.0.1:3000
5+
export OSC_ENDPOINT_API=http://127.0.0.1:3000/api/v1
66
export OSC_IS_RICOCHET=true
77

88
if [ "$#" -eq 0 ]; then

‎osc_sdk_python/__init__.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
from .outscale_gateway import LOG_STDIO
55
from .outscale_gateway import LOG_MEMORY
66
from .version import get_version
7+
from .problem import Problem, ProblemDecoder
78

89
# what to Log
910
from .outscale_gateway import LOG_ALL
@@ -21,4 +22,6 @@
2122
"LOG_MEMORY",
2223
"LOG_ALL",
2324
"LOG_KEEP_ONLY_LAST_REQ",
25+
"Problem",
26+
"ProblemDecoder"
2427
]

‎osc_sdk_python/authentication.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,20 @@
44
import base64
55

66
from .version import get_version
7-
VERSION = get_version()
7+
from .credentials import Profile
8+
VERSION: str = get_version()
89
DEFAULT_USER_AGENT = "osc-sdk-python/" + VERSION
910

1011
class Authentication:
11-
def __init__(self, credentials, host,
12+
def __init__(self, credentials: Profile, host: str,
1213
method='POST', service='api',
1314
content_type='application/json; charset=utf-8',
1415
algorithm='OSC4-HMAC-SHA256',
1516
signed_headers = 'content-type;host;x-osc-date',
1617
user_agent = DEFAULT_USER_AGENT):
1718
self.access_key = credentials.access_key
1819
self.secret_key = credentials.secret_key
19-
self.email = credentials.email
20+
self.login = credentials.login
2021
self.password = credentials.password
2122
self.host = host
2223
self.region = credentials.region
@@ -26,7 +27,6 @@ def __init__(self, credentials, host,
2627
self.algorithm = algorithm
2728
self.signed_headers = signed_headers
2829
self.user_agent = user_agent
29-
self.proxy = credentials.proxy
3030
self.x509_client_cert = credentials.x509_client_cert
3131

3232
def forge_headers_signed(self, uri, request_data):
@@ -121,12 +121,12 @@ def build_authorization_header(self, credential_scope, signature):
121121
+ 'Signature=' + signature
122122

123123
def is_basic_auth_configured(self):
124-
return self.email is not None and self.password is not None
124+
return self.login is not None and self.password is not None
125125

126126
def get_basic_auth_header(self):
127127
if not self.is_basic_auth_configured():
128128
raise Exception("email or password not set")
129-
creds = self.email + ":" + self.password
129+
creds = self.login + ":" + self.password
130130
b64_creds = str(base64.b64encode(creds.encode("utf-8")), "utf-8")
131131
date_iso, _ = self.build_dates()
132132
return {

‎osc_sdk_python/call.py‎

Lines changed: 50 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
# -*- coding: utf-8 -*-
21
from .authentication import Authentication
32
from .authentication import DEFAULT_USER_AGENT
4-
from .credentials import Credentials
3+
from .credentials import Profile
54
from .requester import Requester
5+
from requests import Session
6+
from requests.adapters import HTTPAdapter
7+
from urllib3.util.retry import Retry
8+
from urllib3.util import parse_url
69

710
import json
8-
import os
9-
11+
import warnings
1012

1113
class Call(object):
1214
def __init__(self, logger=None, limiter=None, **kwargs):
@@ -16,53 +18,39 @@ def __init__(self, logger=None, limiter=None, **kwargs):
1618
self.user_agent = kwargs.pop("user_agent", DEFAULT_USER_AGENT)
1719
self.logger = logger
1820
self.limiter = limiter
19-
self.update_credentials(
20-
access_key=kwargs.pop("access_key", None),
21-
secret_key=kwargs.pop("secret_key", None),
22-
region=kwargs.pop("region", None),
23-
profile=kwargs.pop("profile", None),
24-
email=kwargs.pop("email", None),
25-
password=kwargs.pop("password", None),
26-
proxy=kwargs.pop("proxy", None),
27-
x509_client_cert=kwargs.pop("x509_client_cert", None),
28-
max_retries=kwargs.pop("max_retries", None),
29-
retry_backoff_factor=kwargs.pop("retry_backoff_factor", None),
30-
retry_backoff_jitter=kwargs.pop("retry_backoff_jitter", None),
31-
retry_backoff_max=kwargs.pop("retry_backoff_max", None)
32-
)
3321
self.update_limiter(
3422
limiter_max_requests=kwargs.pop("limiter_max_requests", None),
35-
limiter_window=kwargs.pop("limiter_window", None)
23+
limiter_window=kwargs.pop("limiter_window", None),
3624
)
25+
self.update_profile(**kwargs)
26+
self.session = Session()
27+
self.session.mount("https://", self.adapter)
28+
self.session.mount("http://", self.adapter)
3729

38-
def update_credentials(
39-
self,
40-
region=None,
41-
profile=None,
42-
access_key=None,
43-
secret_key=None,
44-
email=None,
45-
password=None,
46-
proxy=None,
47-
x509_client_cert=None,
48-
max_retries=None,
49-
retry_backoff_factor=None,
50-
retry_backoff_jitter=None,
51-
retry_backoff_max=None,
52-
):
53-
self.credentials = {
54-
"access_key": access_key,
55-
"secret_key": secret_key,
56-
"region": region,
57-
"profile": profile,
58-
"email": email,
59-
"password": password,
60-
"x509_client_cert": x509_client_cert,
61-
"max_retries": max_retries,
62-
"retry_backoff_factor": retry_backoff_factor,
63-
"retry_backoff_jitter": retry_backoff_jitter,
64-
"retry_backoff_max": retry_backoff_max,
65-
}
30+
def update_credentials(self, **kwargs):
31+
warnings.warn(
32+
"update_credentials is deprecated, use update_profile instead",
33+
DeprecationWarning,
34+
stacklevel=2,
35+
)
36+
self.update_profile(**kwargs)
37+
38+
def update_profile(self, **kwargs):
39+
self.profile = Profile.from_standard_configuration(
40+
kwargs.pop("path", None), kwargs.pop("profile", None)
41+
)
42+
self.profile.merge(Profile(**kwargs))
43+
44+
self.adapter = HTTPAdapter(
45+
max_retries=Retry(
46+
total=3,
47+
backoff_factor=1,
48+
backoff_jitter=3,
49+
backoff_max=30,
50+
status_forcelist=(400, 429, 500, 503),
51+
allowed_methods=("POST", "GET"),
52+
)
53+
)
6654

6755
def update_limiter(
6856
self,
@@ -75,36 +63,24 @@ def update_limiter(
7563
if limiter_max_requests is not None:
7664
self.limiter.max_requests = limiter_max_requests
7765

78-
79-
def api(self, action, **data):
66+
def api(self, action, service="api", **data):
8067
try:
81-
credentials = Credentials(**self.credentials)
82-
host = (
83-
self.host
84-
if self.host
85-
else "api.{}.outscale.{}".format(
86-
credentials.region, credentials.get_url_extension()
87-
)
88-
)
89-
uri = "/api/{}/{}".format(self.version, action)
90-
protocol = "https" if self.ssl else "http"
91-
92-
endpoint = os.environ.get("OSC_ENDPOINT_API")
93-
if endpoint is None:
94-
endpoint = "{}://{}{}".format(protocol, host, uri)
95-
else:
96-
endpoint = "{}{}".format(endpoint, uri)
68+
endpoint = self.profile.get_endpoint(service) + "/" + action
69+
parsed_url = parse_url(endpoint)
70+
uri = parsed_url.path
71+
host = parsed_url.host
9772

9873
if self.limiter is not None:
9974
self.limiter.acquire()
10075

10176
requester = Requester(
102-
Authentication(credentials, host, user_agent=self.user_agent),
77+
self.session,
78+
Authentication(
79+
self.profile,
80+
host,
81+
user_agent=self.user_agent,
82+
),
10383
endpoint,
104-
credentials.max_retries,
105-
credentials.retry_backoff_factor,
106-
credentials.retry_backoff_jitter,
107-
credentials.retry_backoff_max,
10884
)
10985
if self.logger is not None:
11086
self.logger.do_log(
@@ -113,3 +89,7 @@ def api(self, action, **data):
11389
return requester.send(uri, json.dumps(data))
11490
except Exception as err:
11591
raise err
92+
93+
def close(self):
94+
if self.session:
95+
self.session.close()

0 commit comments

Comments
 (0)