Alibaba Cloud Gateway SPI SDK Library

0.0.3 · active · verified Sat Apr 11

The `alibabacloud-gateway-spi` library provides Service Provider Interface (SPI) definitions for building and extending Alibaba Cloud Gateway functionalities in Python. It's a foundational component within the Alibaba Cloud SDK ecosystem, defining abstract clients and models that other SDKs or custom gateway implementations can utilize. The current version is 0.0.3, with releases appearing to follow an irregular cadence as part of the broader Alibaba Cloud SDK development.

Warnings

gotcha This library (`alibabacloud-gateway-spi`) serves as a Service Provider Interface (SPI) and provides abstract classes and models. It is not designed for direct end-user interaction to make API calls to Alibaba Cloud services. Instead, it defines interfaces that other Alibaba Cloud SDKs or custom gateway implementations build upon or implement.
Fix: Do not attempt to instantiate `Client` directly for making API calls. Refer to specific Alibaba Cloud service SDKs for client-side API usage. Use this library when building custom gateway logic or extending the Alibaba Cloud SDK's gateway capabilities.
gotcha As of version 0.0.3, this library is in a very early development stage (implied by the low version number). While no explicit 'beta' status is listed for this specific package, a related package (`alibabacloud-gateway-pds`) that depends on `alibabacloud-gateway-spi` is marked as 'Development Status :: 4 - Beta'. This suggests that API stability might not be fully guaranteed, and breaking changes could occur in future minor versions.
Fix: Monitor GitHub releases and PyPI for updates. Pin the exact version in your `requirements.txt` to ensure stability in production environments. Be prepared for potential API changes when upgrading to new minor or patch versions.

Install

pip install alibabacloud-gateway-spi Install latest version

Imports

Client
```
from alibabacloud_gateway_spi.client import Client
```
Imports the abstract base client class for implementing custom gateways.
InterceptorContext
```
from alibabacloud_gateway_spi.models import InterceptorContext
```
Imports models related to interception context for gateway processing.

Quickstart

This quickstart demonstrates how to import core components of `alibabacloud-gateway-spi`, which primarily defines abstract classes and models. It highlights that this library is intended for extending or implementing custom gateway logic rather than direct end-user API invocation. It includes a simple placeholder for a custom gateway client extending the provided abstract `Client` class.

from alibabacloud_gateway_spi.client import Client
from alibabacloud_gateway_spi.models import InterceptorContext

# alibabacloud-gateway-spi provides abstract classes and interfaces.
# It is not typically used directly by end-users for making API calls,
# but rather extended or implemented by other Alibaba Cloud SDK components
# or custom gateway logic.

print(f"Successfully imported Client class: {Client.__name__}")
print(f"Successfully imported InterceptorContext model: {InterceptorContext.__name__}")

# Example of defining a placeholder for a custom gateway client:
class MyCustomGatewayClient(Client):
    def _do_request(self, request, runtime): # type: (...), (...) -> (...)
        # Implement custom request logic here
        print("MyCustomGatewayClient is processing a request.")
        # In a real scenario, this would involve making an actual HTTP request
        # and handling the response.
        return {'statusCode': 200, 'headers': {}, 'body': {}}

# This quickstart demonstrates importing and understanding the library's purpose.
# For actual usage, you would build upon or integrate with other Alibaba Cloud SDKs.

view raw JSON →