Refactor2.new changes (aliyun#231)

* modify signer

* add more logics

* modify credentials

* modify credentials

* modify client and alibabacloud client

* modify compat

Author: Qingtang-SDK

aliyun-python-sdk-core/alibabacloud/client.py

@@ -15,22 +15,25 @@
 import time
 from alibabacloud.handlers import RequestContext
 from alibabacloud.handlers.prepare_handler import PrepareHandler
+from alibabacloud.handlers.credentials_handler import CredentialsHandler
 from alibabacloud.handlers.signer_handler import SignerHandler
-from alibabacloud.handlers.url_handler import URLHandler
-from alibabacloud.handlers.http_header_handler import HttpHeaderHandler
+
 from alibabacloud.handlers.timeout_config_reader import TimeoutConfigReader
 from alibabacloud.handlers.endpoint_handler import EndpointHandler
 from alibabacloud.handlers.log_handler import LogHandler
 from alibabacloud.handlers.retry_handler import RetryHandler
 from alibabacloud.handlers.server_error_handler import ServerErrorHandler
 from alibabacloud.handlers.http_handler import HttpHandler
-from alibabacloud.credentials.credentials_provider import DefaultCredentialsProvider
+
+from alibabacloud.credentials.provider import DefaultChainedCredentialsProvider
+
 from alibabacloud.endpoint.default_endpoint_resolver import DefaultEndpointResolver
+
 DEFAULT_HANDLERS = [
     PrepareHandler,
-    SignerHandler,  # 获取Signature
-    URLHandler,  # 获取url
-    HttpHeaderHandler,  # 获取签名的header
+    CredentialsHandler,
+    SignerHandler,  # 获取Signature,header,params
+    # HttpHeaderHandler,  # 获取签名的header
     TimeoutConfigReader,  # 获取timeout
     EndpointHandler,  # 获取endpoint
     LogHandler,
@@ -53,19 +56,26 @@ class ClientConfig:
     处理client级别的所有的参数
     """
 
+    ENV_NAME_FOR_CONFIG_FILE = 'ALIBABA_CLOUD_CONFIG_FILE'
+    DEFAULT_NAME_FOR_CONFIG_FILE = '~/.alibabacloud/config'
+
     def __init__(self, access_key_id=None, access_key_secret=None, bearer_token=None,
                  secret_token=None, region_id=None,
-                 enable_retry_policy=None, max_retry_times=None, user_agent=None,
+                 max_retry_times=None, user_agent=None,
                  extra_user_agent=None, enable_https=None, http_port=None, https_port=None,
                  connection_timeout=None, read_timeout=None, enable_http_debug=None,
                  http_proxy=None, https_proxy=None, enable_stream_logger=None,
-                 profile_name=None, config_file=None, auto_retry=True):
+                 profile_name=None, config_file=None, enable_retry=True, endpoint=None):
+
         # credentials部分会用到
         self.access_key_id = access_key_id
         self.access_key_secret = access_key_secret
         self.secret_token = secret_token
         self.bearer_token = bearer_token
         self.region_id = region_id
+        self.enable_retry = enable_retry
+        self.max_retry_times = max_retry_times
+        self.endpoint = endpoint
 
         # user-agent
         self.user_agent = user_agent
@@ -81,62 +91,45 @@ def __init__(self, access_key_id=None, access_key_secret=None, bearer_token=None
         self.enable_stream_logger = enable_stream_logger
         # credentials 的profile
         self.profile_name = profile_name
+        # 读取配置文件
         self.config_file = config_file
-        # self.enable_http_debug = enable_http_debug  # http-debug 只从环境变量获取，不设置开关
-        self.http_debug = None
+        self.enable_http_debug = enable_http_debug  # http-debug 只从环境变量获取，不设置开关
         # proxy provider两个： client  env
         self.http_proxy = http_proxy
         self.https_proxy = https_proxy
         self._proxy = {
             'http': self.http_proxy,
             'https': self.https_proxy,
         }
-        # retry
-        self._auto_retry = auto_retry
-        import aliyunsdkcore.retry.retry_policy as retry_policy
-        # retry
-        self.enable_retry_policy = enable_retry_policy
-        self.max_retry_times = max_retry_times
-        if self._auto_retry:
-            self.retry_policy = retry_policy.get_default_retry_policy(
-                max_retry_times=self.max_retry_times)
-        else:
-            self.retry_policy = retry_policy.NO_RETRY_POLICY
 
     def read_from_env(self):
         # 从环境变量读取一定量的数据
-        env_vars = ['HTTP_DEBUG', 'HTTPS_PROXY', 'HTTP_PROXY']
+        env_vars = ['HTTPS_PROXY', 'HTTP_PROXY']
         for item in env_vars:
             if getattr(self, item.lower()) is None:
                 setattr(self, item.lower(), os.environ.get(item) or os.environ.get(item.lower()))
 
+        self.enable_http_debug = os.environ.get('DEBUG')
+
     def read_from_profile(self):
-        ENV_NAME_FOR_CONFIG_FILE = 'ALIBABA_CLOUD_CONFIG_FILE'
-        DEFAULT_NAME_FOR_CONFIG_FILE = ['/etc/.alibabacloud/config',
-                                        '~/alibabacloud/config']
+        profile = {}
         # TODO read from profile
         from alibabacloud.utils.ini_helper import load_config
-        profile = {}
-        loaded_config = {}
         if self.config_file is None:
-            if ENV_NAME_FOR_CONFIG_FILE in os.environ:
-
-                env_config_file_path = os.environ.get(ENV_NAME_FOR_CONFIG_FILE)
-                if env_config_file_path is None or len(env_config_file_path) == 0:
+            # 没有指定file
+            if self.ENV_NAME_FOR_CONFIG_FILE in os.environ:
+
+                env_config_file_path = os.environ.get(self.ENV_NAME_FOR_CONFIG_FILE)
+                if env_config_file_path is not None:
+                    full_path = os.path.expanduser(env_config_file_path)
+                    loaded_config = load_config(full_path)
+                    profile = loaded_config.get(self.profile_name, {})
+                else:
                     # 默认配置不存在
-                    return None
-                full_path = os.path.expanduser(env_config_file_path)
-                loaded_config = load_config(full_path)
-                profile = loaded_config.get(self.profile_name, {})
-            else:
-                potential_locations = DEFAULT_NAME_FOR_CONFIG_FILE
-                for filename in potential_locations:
-                    try:
-                        loaded_config = load_config(filename)
-                        break
-                    except Exception:
-                        continue
-                profile = loaded_config.get(self.profile_name, {})
+                    filename = self.DEFAULT_NAME_FOR_CONFIG_FILE
+                    loaded_config = load_config(filename)
+                    profile = loaded_config.get(self.profile_name, {})
+
         else:
             profile = load_config(self.config_file)
 
@@ -151,80 +144,101 @@ def read_from_default(self):
         # 用户实例化的时候，就进行了覆盖
         pass
 
+    def _update_config(self, new_config):
+        # request 的config 更新client的config
+        request_settings = ['enable_https', 'connection_timeout', 'read_timeout']
+        for attr in request_settings:
+            setattr(self, attr, getattr(new_config, attr))
+
 
 def get_merged_client_config(config):
-    # config.read_from_env()
-    # config.read_from_profile()
+    config.read_from_env()
+    config.read_from_profile()
     # config.read_from_default()
+
     return config
 
 
 class AlibabaCloudClient:
 
-    def __init__(self, client_config, credentials_provider=DefaultCredentialsProvider):
+    def __init__(self, client_config, credentials_provider):
         self.config = get_merged_client_config(client_config)
-        self.credentials_provider = DefaultCredentialsProvider
+
+        if credentials_provider is not None:
+            self.credentials_provider = credentials_provider
+        else:
+            self.credentials_provider = DefaultChainedCredentialsProvider()
         self.handlers = DEFAULT_HANDLERS
         self.logger = None  # TODO initialize
         # endpoint_resolver阶段需要
         self.endpoint_resolver = DefaultEndpointResolver(self)  # TODO initialize
-        # self.product_code = None
-        # self.location_service_code = None
-        # self.location_service_type = None
-        # self.location_endpoint_type = None
-
-    def handle_request(self, api_request, request_handlers=None, context=None):
-        # TODO handle different types of request
-        from aliyunsdkcore.request import CommonRequest
-        if isinstance(api_request, CommonRequest):
-            api_request.trans_to_acs_request()
-
-        if not context:
-            context = RequestContext()
-            context.api_request = api_request
-            from .request import HTTPRequest
-            context.http_request = HTTPRequest()
+        # TODO product_code 如何获取
+        self.product_code = None
+        self.location_service_code = None
+        self.location_service_type = None
+        self.location_endpoint_type = None
+
+        import aliyunsdkcore.retry.retry_policy as retry_policy
+        # retry
+        if self.config.enable_retry:
+            self.retry_policy = retry_policy.get_default_retry_policy(
+                max_retry_times=self.config.max_retry_times)
+        else:
+            self.retry_policy = retry_policy.NO_RETRY_POLICY
+
+    def _handle_request(self, api_request, _config=None, _raise_exception=True):
+        context = RequestContext()
+        context.api_request = api_request
+        from .request import HTTPRequest
+        context.http_request = HTTPRequest()
+        if _config:
+            # For backward compatibility
+            context.config = _config
+        else:
             context.config = self.config
-            context.credentials_provider = self.credentials_provider
-            context.product_code = api_request.get_product()
-            context.location_service_code = api_request.get_location_service_code()
-            context.location_endpoint_type = api_request.get_location_endpoint_type()
-            context.endpoint_resolver = self.endpoint_resolver
-            # credentials 是和请求解耦的，从请求的流程来看，不应该放在handle当中
-            context.credentials = self.get_credentials()
-
-        if not request_handlers:
-            request_handlers = self.handlers
-        for i in range(len(request_handlers)):
-            request_handlers[i]().handle_request(context)
-
-        for i in reversed(range(len(request_handlers))):
-            request_handlers[i]().handle_response(context)
-            if context.retry_flag:
-                time.sleep(context.retry_backoff / 1000.0)
-                self.handle_request(api_request,
-                                    request_handlers=request_handlers[i:],
-                                    context=context)
-        if context.exception:
-            return context.exception
-
-        return context.http_response.content
-
-    def get_credentials(self):
-        credentials_provider = self.credentials_provider({
-            'access_key_id': self.config.access_key_id,
-            'access_key_secret': self.config.access_key_secret,
-            'secret_token': self.config.secret_token,
-            'bearer_token': self.config.bearer_token,
-            'profile_name': 'client5'
-        })
-        credentials = credentials_provider.load_credentials()
-        if credentials is None:
-            from aliyunsdkcore.acs_exception.exceptions import ClientException
-            raise ClientException(
-                'Credentials',
-                'Unable to locate credentials.'
-            )
-        return credentials
+        context.client = self
+
+        handler_index = 0
+
+        while True:
+
+            for i in range(len(self.handlers[handler_index:])):
+                self.handlers[i]().handle_request(context)
+
+            for i in reversed(range(len(self.handlers[handler_index:]))):
+                self.handlers[i]().handle_response(context)
+                if context.retry_flag:
+                    time.sleep(context.retry_backoff)
+                    handler_index = i
+                    context.retry_flag = False
+                    continue
+
+            break
+
+        if context.exception and _raise_exception:
+            raise context.exception
+
+        return context
+
+
+class ECSClient(AlibabaCloudClient):
+
+    def __init__(self):
+        self.product = 'Ecs'
+        self.location_service_code = 'ecs'
+        self.location_endpoint_type = 'OpenAPI'
+
+    def create_instance(self, **params):
+        api_request = APIRequest(**params)
+        return self._handle_request(api_request).result
+
+    def delete_instance(self, **params):
+        api_request = APIRequest(**params)
+        return self._handle_request(api_request).result
+
 
+class OTSClient(AlibabaCloudClient):
 
+    def create_table(self, **params):
+        api_request = APIRequest(**params)
+        return self._handle_request(api_request).result

aliyun-python-sdk-core/alibabacloud/credentials/__init__.py

@@ -11,3 +11,37 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+
+
+class AlibabaCloudCredentials:
+
+    def __init__(self):
+        self.access_key_id = None
+        self.access_key_secret = None
+        self.security_token = None
+        self.bearer_token = None
+
+
+# credentials
+class AccessKeyCredentials(AlibabaCloudCredentials):
+
+    def __init__(self, access_key_id, access_key_secret):
+        AlibabaCloudCredentials.__init__(self)
+        self.access_key_id = access_key_id
+        self.access_key_secret = access_key_secret
+
+
+class BearerTokenCredentials(AlibabaCloudCredentials):
+
+    def __init__(self, bearer_token):
+        AlibabaCloudCredentials.__init__(self)
+        self.bearer_token = bearer_token
+
+
+class SecurityCredentials(AlibabaCloudCredentials):
+
+    def __init__(self, access_key_id, access_key_secret, security_token):
+        AlibabaCloudCredentials.__init__(self)
+        self.access_key_id = access_key_id
+        self.access_key_secret = access_key_secret
+        self.security_token = security_token