Alibaba Cloud Tea for Python

Warnings

• breaking Starting from version 0.4.0, `alibabacloud-tea` requires Python 3.7 or higher. Older Python versions will not be supported.
  Fix: Upgrade your Python environment to 3.7 or newer. Ensure your `pip` is also up-to-date (`pip install --upgrade pip setuptools`).
• gotcha Encountering `ModuleNotFoundError: No module named 'Tea'` typically indicates an outdated `pip` version or an incorrect package installation. Users might mistakenly install a package named `tea` instead of `alibabacloud-tea`.
  Fix: First, update `pip` and `setuptools`: `pip install --upgrade pip setuptools`. Then, ensure you install the correct package: `pip install alibabacloud-tea`.
• gotcha When using Alibaba Cloud SDKs that rely on `alibabacloud-tea`, always handle `TeaException` and `TeaUnretryableException` for robust error management, differentiating between business logic errors and network issues.
  Fix: Implement explicit `try...except TeaException` and `try...except TeaUnretryableException` blocks around SDK calls. Consult the specific SDK's documentation for common error codes.
• gotcha Avoid hardcoding Alibaba Cloud AccessKey ID and Secret. This is a security risk and generally not recommended for production environments.
  Fix: Configure credentials using environment variables (`ALIBABA_CLOUD_ACCESS_KEY_ID`, `ALIBABA_CLOUD_ACCESS_KEY_SECRET`) or Alibaba Cloud Resource Access Management (RAM) roles and credentials providers.

Install

• pip install alibabacloud-tea Install alibabacloud-tea

Imports

• TeaModel

  from Tea.model import TeaModel

• TeaCore

  from Tea.core import TeaCore

• TeaException

  from Tea.exceptions import TeaException

  TeaException is part of the 'exceptions' submodule, not directly under 'Tea'.
• TeaUnretryableException

  from Tea.exceptions import TeaUnretryableException

Quickstart

This quickstart demonstrates the basic usage of `TeaModel` for defining structured request/response objects and `TeaException` for handling errors. `alibabacloud-tea` itself is a foundational library; most direct interaction occurs through other Alibaba Cloud SDKs built upon it.

import os
from Tea.model import TeaModel
from Tea.exceptions import TeaException

class MyRequest(TeaModel):
    def __init__(self, **kwargs):
        super().__init__(**kwargs)
        self.my_param = kwargs.get('my_param', None)

    def validate(self):
        # Example validation: my_param is required
        if self.my_param is None:
            raise TeaException({'code': 'MissingParameter', 'message': 'my_param is required'})


def main():
    print("Demonstrating TeaModel and TeaException...")
    try:
        # Valid request
        req1 = MyRequest(my_param='test_value')
        req1.validate()
        print(f"Request 1 (valid): {req1.my_param}")

        # Invalid request (missing my_param)
        req2 = MyRequest()
        req2.validate()

    except TeaException as e:
        print(f"Caught TeaException: Code={e.code}, Message={e.message}")
    except Exception as e:
        print(f"Caught unexpected exception: {e}")

if __name__ == '__main__':
    main()