Feat/async typed sdk by YashGaykar0309 · Pull Request #225 · outscale/osc-sdk-python

YashGaykar0309 · 2026-05-27T11:24:55Z

Description

Implements the foundation for an async-first, OpenAPI-driven Python SDK with generated typed service clients. The architecture now supports multi-service expansion such as OSC/OAPI, OKS and future services through a modular core plus generated service layers.

Main goals:

async-first design
multi-service support
strong typing and request/response validation
profile/config-based client creation
minimal integration complexity
modular core + generated service architecture
OpenAPI-driven client generation

Fixes: NA

Type of Change

Please check the relevant option(s):

How Has This Been Tested?

Please describe the test strategy:

Manual testing
Unit tests
Integration tests
Not tested yet

Commands used (if applicable):

uv run python -m pytest tests

Checklist

I have followed the Contributing Guidelines
I have added tests or explained why they are not needed
I have updated relevant documentation (README, examples, etc.)
My changes follow the Conventional Commits specification
My commits include appropriate Gitmoji

…h SDK

-        super().__init__(
-            os.path.join(os.path.dirname(__file__), "resources/outscale.yaml"), **kwargs
+
+class AsyncOpenAPIActionAPI(OpenAPIActionAPI):


+        self.close()
+
+
+class AsyncOpenAPIPathAPI(OpenAPIPathAPI):


+        request: GetKubernetesVersionsRequest | None = None,
+    ) -> KubernetesVersionsResponse:
+        if request is None:
+            request = GetKubernetesVersionsRequest()


+        request: GetCPSubregionsRequest | None = None,
+    ) -> CPSubregionsResponse:
+        if request is None:
+            request = GetCPSubregionsRequest()


+        request: GetControlPlanePlansRequest | None = None,
+    ) -> ControlPlanesResponse:
+        if request is None:
+            request = GetControlPlanePlansRequest()


+        request: GetNetPeeringRequestTemplateRequest | None = None,
+    ) -> TemplateResponse_NetPeeringRequest:
+        if request is None:
+            request = GetNetPeeringRequestTemplateRequest()


+        request: GetNetPeeringAcceptanceTemplateRequest | None = None,
+    ) -> TemplateResponse_NetPeeringAcceptance:
+        if request is None:
+            request = GetNetPeeringAcceptanceTemplateRequest()


+        request: GetQuotasRequest | None = None,
+    ) -> quotas__quota_schema__QuotasResponse:
+        if request is None:
+            request = GetQuotasRequest()


+        request: GetClientIPRequest | None = None,
+    ) -> IPResponse:
+        if request is None:
+            request = GetClientIPRequest()


+import asyncio
+import copy
+import os
+import sys


jobs62

Good start. Despite all comments i made, it whould be nice that public facing methods raise only "owned" exception. also string enum support whould be nice in the generator (that may need support for overlays as well)

jobs62 · 2026-05-29T07:23:10Z

      api_version:
        description: 'Outscale API version'
        required: true
+      oks_api_url:


Both services can have different release plan, so we should be able to build and release one without the other

jobs62 · 2026-05-29T07:24:01Z

      env:
        OSC_ACCESS_KEY: ${{ secrets.OSC_ACCESS_KEY }}
        OSC_SECRET_KEY: ${{ secrets.OSC_SECRET_KEY }}
+        OSC_ACCESS_KEY_V2: ${{ secrets.OSC_ACCESS_KEY_V2 }}


jobs62 · 2026-05-29T07:25:51Z

+
+
+async def main():
+    async with AsyncClient(profile="profile_1") as client:


we should have one client per service

jobs62 · 2026-05-29T07:28:03Z

+async def main():
+    async with AsyncGateway() as gw:
+        # Example: list VMs
+        vms = await gw.ReadVms()


method name should by OperationId converted in snake case

jobs62 · 2026-05-29T07:43:32Z

+    json_body: dict | list | None = None
+    query_params: dict = field(default_factory=dict)
+
+    def resolved_path(self, path_params: dict | None = None) -> str:


this should probably throw an error if one or more placeholders are not remplaced

jobs62 · 2026-05-29T07:54:19Z

@@ -1 +1 @@
 import datetime


all that file could be removed and remplaced by a httpx middleware

jobs62 · 2026-05-29T07:55:24Z

 from datetime import datetime, timezone, timedelta
+import asyncio
 import time



same as authentication, limiter should be a httpx middleware

jobs62 · 2026-05-29T07:59:38Z

@@ -0,0 +1,131 @@
+import asyncio
+import json


should be a httpx middleware as well

jobs62 · 2026-05-29T08:02:13Z

+from ..request import RequestSpec
+
+
+class AsyncCall(object):


you can probably get ride of Call/Requester. i never understood why we had that much boilerplate for parameters of transports (should be in the session or a middleware ?)

jobs62 · 2026-05-29T08:03:50Z

 dependencies = [
+    "httpx>=0.28.0",
+    "pydantic>=2.0.0",
    "requests>=2.20.0",


requests should not be used anymore

Updated README and docs examples to use Client / AsyncClient and async snake_case operation methods. Added unresolved path placeholder validation in RequestSpec with unit tests. Removed unnecessary IAM v2 secret injection from the CI workflow while keeping SDK credential support unchanged.

YashGaykar0309 added 18 commits May 27, 2026 15:04

✨ feat: Add async httpx gateway runtime and test

f093f28

♻️ refactor: Organize sync and async runtime and test layout

d715e3e

📝 docs: add async gateway usage examples

7f8d953

♻️ refactor: load OSC spec from service resources

d5c5406

✨ feat: add OKS client support

14b95ae

🔖 release: add OKS spec update automation

489ecda

✅ test: add test for async security group lifecycle

653069c

✨ feat: Add generator for oks to create models, funs to integrate wit…

85e8622

…h SDK

✨ feat: add generater for clients and schemas

61c939f

✨ feat: add generated clients and models

504180d

🔥 chore: remove unnecessary error codes file

feca815

✨ feat: Update Gateway/Client to support multi service async clients

7d59e49

✅ test: Update osc sync tests using new client

22a96e8

✅ test: Add a test for sync oks(project lifecycle)

aaa0da8

✅ test: Add a test for async oks(project lifecycle)

f1208e6

✅ test: Add a tests for usage of osc using async client

95df31d

✅ test: Add a tests for openapi based generator

88f12a4

✅ test: Add a test to uniquely marked fields

488d44a

YashGaykar0309 requested a review from a team May 27, 2026 11:24

YashGaykar0309 had a problem deploying to eu-west-2 May 27, 2026 11:25 — with GitHub Actions Failure

github-advanced-security AI found potential problems May 27, 2026

View reviewed changes

YashGaykar0309 added 5 commits May 27, 2026 18:32

🧪 test: cover retry timeout and retry-after behavior

0f52570

🔒 fix: make rate limiter concurrency safe and add tests

190f737

🧪 test: cover clients lifecycle cleanup

a4a26bf

🧪 test: cover authentication behavior

a32a671

🧪 test: cover profile config loading

4933bac

jobs62 requested changes May 29, 2026

View reviewed changes

YashGaykar0309 added 3 commits June 1, 2026 14:55

🚨 fix: address CodeQL findings in async gateway and generated clients

697cab8

🔖 fix: support per-service release builds

b1f38c4

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat/async typed sdk#225

Feat/async typed sdk#225
YashGaykar0309 wants to merge 26 commits into
mainfrom
feat/async-typed-sdk

YashGaykar0309 commented May 27, 2026 •

edited

Loading

Uh oh!

jobs62 left a comment

Uh oh!

jobs62 May 29, 2026

Uh oh!

jobs62 May 29, 2026

Uh oh!

jobs62 May 29, 2026

Uh oh!

jobs62 May 29, 2026

Uh oh!

jobs62 May 29, 2026

Uh oh!

jobs62 May 29, 2026

Uh oh!

jobs62 May 29, 2026

Uh oh!

jobs62 May 29, 2026

Uh oh!

jobs62 May 29, 2026

Uh oh!

jobs62 May 29, 2026

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants



		async def main():
		async with AsyncClient(profile="profile_1") as client:

Conversation

YashGaykar0309 commented May 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of Change

How Has This Been Tested?

Checklist

Uh oh!

jobs62 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

YashGaykar0309 commented May 27, 2026 •

edited

Loading