nacos-sdk-python 2.0.0b5__tar.gz → 2.0.2__tar.gz

{nacos-sdk-python-2.0.0b5 → nacos-sdk-python-2.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nacos-sdk-python
-Version: 2.0.0b5
+Version: 2.0.2
 Summary: Python client for Nacos.
 Home-page: https://github.com/nacos-group/nacos-sdk-python
 Author: nacos
@@ -68,6 +68,7 @@ Description:
         * *namespace* - Namespace. | default: `None`
         * *ak* - The accessKey to authenticate. | default: null
         * *sk* - The secretKey to authentication. | default: null
+        * *credentials_provider* - The custom access key manager | default: null
         * *log_level* - Log level. | default: null
         * *log_rotation_backup_count* - The number of log files to keep. | default: `7`
         
@@ -249,9 +250,9 @@ Description:
         
         ### Subscribe Service Instances Changed
         
-        > `NacosClient.subscribe(listener_fn, listener_interval=7, *args, **kwargs)`
+        >`NacosClient.subscribe(listener_fn, listener_interval=7, *args, **kwargs)`
         
-        * `param` *listener_fn*  **required** Customized listener function.
+        * `param` *listener_fn*  **required** Customized listener function.  with signature `fn_listener1(event, instance)->None`
         * `param` *listener_interval*  Listen interval , default 7 second.
         * `param` *service_name*  **required** Service name which subscribes.
         * `param` *clusters* Cluster names separated by comma.
@@ -304,7 +305,7 @@ Description:
         ## Installation
         
         ```shell
-         pip install nacos-sdk-python==2.0.0b4 
+         pip install nacos-sdk-python==2.0.0b5 
         ```
         
         ## Client Configuration
@@ -326,6 +327,7 @@ Description:
         * *server_address* - **required**  - Nacos server address
         * *access_key* - The aliyun accessKey to authenticate.
         * *secret_key* - The aliyun secretKey to authenticate.
+        * *credentials_provider* - The custom access key manager.
         * *username* - The username to authenticate.
         * *password* - The password to authenticate.
         * *log_level* - Log level | default: `logging.INFO`

{nacos-sdk-python-2.0.0b5 → nacos-sdk-python-2.0.2}/README.md

@@ -56,6 +56,7 @@ client = NacosClient(server_addresses, namespace=your_ns, ak=your_ak, sk=your_sk
 * *namespace* - Namespace. | default: `None`
 * *ak* - The accessKey to authenticate. | default: null
 * *sk* - The secretKey to authentication. | default: null
+* *credentials_provider* - The custom access key manager | default: null
 * *log_level* - Log level. | default: null
 * *log_rotation_backup_count* - The number of log files to keep. | default: `7`
 
@@ -237,9 +238,9 @@ Remove one data item from Nacos.
 
 ### Subscribe Service Instances Changed
 
-> `NacosClient.subscribe(listener_fn, listener_interval=7, *args, **kwargs)`
+>`NacosClient.subscribe(listener_fn, listener_interval=7, *args, **kwargs)`
 
-* `param` *listener_fn*  **required** Customized listener function.
+* `param` *listener_fn*  **required** Customized listener function.  with signature `fn_listener1(event, instance)->None`
 * `param` *listener_interval*  Listen interval , default 7 second.
 * `param` *service_name*  **required** Service name which subscribes.
 * `param` *clusters* Cluster names separated by comma.
@@ -292,7 +293,7 @@ Supported Nacos version over 2.x
 ## Installation
 
 ```shell
- pip install nacos-sdk-python==2.0.0b4 
+ pip install nacos-sdk-python==2.0.0b5 
 ```
 
 ## Client Configuration
@@ -314,6 +315,7 @@ client_config = (ClientConfigBuilder()
 * *server_address* - **required**  - Nacos server address
 * *access_key* - The aliyun accessKey to authenticate.
 * *secret_key* - The aliyun secretKey to authenticate.
+* *credentials_provider* - The custom access key manager.
 * *username* - The username to authenticate.
 * *password* - The password to authenticate.
 * *log_level* - Log level | default: `logging.INFO`

nacos-sdk-python-2.0.2/nacos/auth.py

@@ -0,0 +1,26 @@
+class Credentials(object):
+    def __init__(self, access_key_id, access_key_secret, security_token=None):
+        self.access_key_id = access_key_id
+        self.access_key_secret = access_key_secret
+        self.security_token = security_token
+
+    def get_access_key_id(self):
+        return self.access_key_id
+
+    def get_access_key_secret(self):
+        return self.access_key_secret
+
+    def get_security_token(self):
+        return self.security_token
+
+class CredentialsProvider(object):
+    def get_credentials(self):
+        return
+
+
+class StaticCredentialsProvider(CredentialsProvider):
+    def __init__(self, access_key_id="", access_key_secret="", security_token=""):
+        self.credentials = Credentials(access_key_id, access_key_secret, security_token)
+
+    def get_credentials(self):
+        return self.credentials

{nacos-sdk-python-2.0.0b5 → nacos-sdk-python-2.0.2}/nacos/client.py

@@ -14,6 +14,7 @@ from logging.handlers import TimedRotatingFileHandler
 from typing import Dict
 
 from .task import HeartbeatInfo, HeartbeatTask
+from .auth import StaticCredentialsProvider
 
 try:
     import ssl
@@ -276,7 +277,8 @@ class NacosClient:
             logger.propagate = False
 
     def __init__(self, server_addresses=None, endpoint=None, namespace=None, ak=None,
-                 sk=None, username=None, password=None, logDir=None, log_level=None, log_rotation_backup_count=None):
+                 sk=None, username=None, password=None, logDir=None, log_level=None,
+                 log_rotation_backup_count=None, credentials_provider=None):
         self.server_list = list()
         self.initLog(logDir, log_level, log_rotation_backup_count)
         try:
@@ -308,8 +310,7 @@ class NacosClient:
 
         self.endpoint = endpoint
         self.namespace = namespace or DEFAULT_NAMESPACE or ""
-        self.ak = ak
-        self.sk = sk
+        self.credentials_provider = credentials_provider if credentials_provider else StaticCredentialsProvider(ak, sk)
         self.username = username
         self.password = password
 
@@ -330,7 +331,8 @@ class NacosClient:
         self.process_mgr = None
 
         self.default_timeout = DEFAULTS["TIMEOUT"]
-        self.auth_enabled = self.ak and self.sk
+        credentials = self.credentials_provider.get_credentials()
+        self.auth_enabled = credentials.get_access_key_id() and credentials.get_access_key_secret()
         self.cai_enabled = True
         self.pulling_timeout = DEFAULTS["PULLING_TIMEOUT"]
         self.pulling_config_size = DEFAULTS["PULLING_CONFIG_SIZE"]
@@ -747,6 +749,7 @@ class NacosClient:
             cache_pool[cache_key] = CacheData(cache_key, self)
 
         while cache_list:
+            time.sleep(1)
             unused_keys = set(cache_pool.keys())
             contains_init_key = False
             probe_update_string = ""
@@ -784,10 +787,8 @@ class NacosClient:
                 logger.info("[do-pulling] following keys are changed from server %s" % truncate(str(changed_keys)))
             except NacosException as e:
                 logger.error("[do-pulling] nacos exception: %s, waiting for recovery" % str(e))
-                time.sleep(1)
             except Exception as e:
                 logger.exception("[do-pulling] exception %s occur, return empty list, waiting for recovery" % str(e))
-                time.sleep(1)
 
             for cache_key, cache_data in cache_pool.items():
                 cache_data.is_init = False
@@ -813,35 +814,38 @@ class NacosClient:
         logger.info("[init-pulling] init completed")
 
     def _process_polling_result(self):
-        while True:
-            cache_key, content, md5 = self.notify_queue.get()
-            logger.info("[process-polling-result] receive an event:%s" % cache_key)
-            wl = self.watcher_mapping.get(cache_key)
-            if not wl:
-                logger.warning("[process-polling-result] no watcher on %s, ignored" % cache_key)
-                continue
+        try:
+            while True:
+                cache_key, content, md5 = self.notify_queue.get()
+                logger.info("[process-polling-result] receive an event:%s" % cache_key)
+                wl = self.watcher_mapping.get(cache_key)
+                if not wl:
+                    logger.warning("[process-polling-result] no watcher on %s, ignored" % cache_key)
+                    continue
 
-            data_id, group, namespace = parse_key(cache_key)
-            plain_content = content
-
-            params = {
-                "data_id": data_id,
-                "group": group,
-                "namespace": namespace,
-                "raw_content": content,
-                "content": plain_content,
-            }
-            for watcher in wl:
-                if not watcher.last_md5 == md5:
-                    logger.info(
-                        "[process-polling-result] md5 changed since last call, calling %s with changed md5: %s ,params: %s"
-                        % (watcher.callback.__name__, md5, params))
-                    try:
-                        self.callback_tread_pool.apply(watcher.callback, (params,))
-                    except Exception as e:
-                        logger.exception("[process-polling-result] exception %s occur while calling %s " % (
-                            str(e), watcher.callback.__name__))
-                    watcher.last_md5 = md5
+                data_id, group, namespace = parse_key(cache_key)
+                plain_content = content
+
+                params = {
+                    "data_id": data_id,
+                    "group": group,
+                    "namespace": namespace,
+                    "raw_content": content,
+                    "content": plain_content,
+                }
+                for watcher in wl:
+                    if not watcher.last_md5 == md5:
+                        logger.info(
+                            "[process-polling-result] md5 changed since last call, calling %s with changed md5: %s ,params: %s"
+                            % (watcher.callback.__name__, md5, params))
+                        try:
+                            self.callback_tread_pool.apply(watcher.callback, (params,))
+                        except Exception as e:
+                            logger.exception("[process-polling-result] exception %s occur while calling %s " % (
+                                str(e), watcher.callback.__name__))
+                        watcher.last_md5 = md5
+        except (EOFError, OSError) as e:
+            logger.exception(f"[process-polling-result] break when receive exception of {type(e)}")
 
     @staticmethod
     def _inject_version_info(headers):
@@ -884,7 +888,8 @@ class NacosClient:
         if not params and not data:
             return
         ts = str(int(time.time() * 1000))
-        ak, sk = self.ak, self.sk
+        # now we have a fixed credentials (access key or sts token)
+        credentials = self.credentials_provider.get_credentials()
 
         sign_str = ""
 
@@ -892,7 +897,7 @@ class NacosClient:
         # config signature
         if "config" == module:
             headers.update({
-                "Spas-AccessKey": ak,
+                "Spas-AccessKey": credentials.get_access_key_id(),
                 "timeStamp": ts,
             })
 
@@ -905,7 +910,9 @@ class NacosClient:
                 sign_str = sign_str + group + "+"
             if sign_str:
                 sign_str += ts
-                headers["Spas-Signature"] = self.__do_sign(sign_str, sk)
+                headers["Spas-Signature"] = self.__do_sign(sign_str, credentials.get_access_key_secret())
+            if credentials.get_security_token():
+                headers["Spas-SecurityToken"] = credentials.get_security_token()
 
         # naming signature
         else:
@@ -922,10 +929,12 @@ class NacosClient:
                 sign_str = ts
 
             params.update({
-                "ak": ak,
+                "ak": credentials.get_access_key_id(),
                 "data": sign_str,
-                "signature": self.__do_sign(sign_str, sk),
+                "signature": self.__do_sign(sign_str, credentials.get_access_key_secret()),
             })
+            if credentials.get_security_token():
+                params.update({"Spas-SecurityToken": credentials.get_security_token()})
 
     def __do_sign(self, sign_str, sk):
         return base64.encodebytes(

{nacos-sdk-python-2.0.0b5 → nacos-sdk-python-2.0.2}/nacos_sdk_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nacos-sdk-python
-Version: 2.0.0b5
+Version: 2.0.2
 Summary: Python client for Nacos.
 Home-page: https://github.com/nacos-group/nacos-sdk-python
 Author: nacos
@@ -68,6 +68,7 @@ Description:
         * *namespace* - Namespace. | default: `None`
         * *ak* - The accessKey to authenticate. | default: null
         * *sk* - The secretKey to authentication. | default: null
+        * *credentials_provider* - The custom access key manager | default: null
         * *log_level* - Log level. | default: null
         * *log_rotation_backup_count* - The number of log files to keep. | default: `7`
         
@@ -249,9 +250,9 @@ Description:
         
         ### Subscribe Service Instances Changed
         
-        > `NacosClient.subscribe(listener_fn, listener_interval=7, *args, **kwargs)`
+        >`NacosClient.subscribe(listener_fn, listener_interval=7, *args, **kwargs)`
         
-        * `param` *listener_fn*  **required** Customized listener function.
+        * `param` *listener_fn*  **required** Customized listener function.  with signature `fn_listener1(event, instance)->None`
         * `param` *listener_interval*  Listen interval , default 7 second.
         * `param` *service_name*  **required** Service name which subscribes.
         * `param` *clusters* Cluster names separated by comma.
@@ -304,7 +305,7 @@ Description:
         ## Installation
         
         ```shell
-         pip install nacos-sdk-python==2.0.0b4 
+         pip install nacos-sdk-python==2.0.0b5 
         ```
         
         ## Client Configuration
@@ -326,6 +327,7 @@ Description:
         * *server_address* - **required**  - Nacos server address
         * *access_key* - The aliyun accessKey to authenticate.
         * *secret_key* - The aliyun secretKey to authenticate.
+        * *credentials_provider* - The custom access key manager.
         * *username* - The username to authenticate.
         * *password* - The password to authenticate.
         * *log_level* - Log level | default: `logging.INFO`

{nacos-sdk-python-2.0.0b5 → nacos-sdk-python-2.0.2}/nacos_sdk_python.egg-info/SOURCES.txt

@@ -1,6 +1,7 @@
 README.md
 setup.py
 nacos/__init__.py
+nacos/auth.py
 nacos/client.py
 nacos/commons.py
 nacos/exception.py
@@ -18,6 +19,7 @@ v2/__init__.py
 v2/nacos/__init__.py
 v2/nacos/nacos_client.py
 v2/nacos/common/__init__.py
+v2/nacos/common/auth.py
 v2/nacos/common/client_config.py
 v2/nacos/common/client_config_builder.py
 v2/nacos/common/constants.py

{nacos-sdk-python-2.0.0b5 → nacos-sdk-python-2.0.2}/setup.py

@@ -53,7 +53,7 @@ class UploadCommand(Command):
 
 setup(
     name="nacos-sdk-python",
-    version="2.0.0.beta5",
+    version="2.0.2",
     packages=find_packages(
         exclude=["test", "*.tests", "*.tests.*", "tests.*", "tests"]),
     url="https://github.com/nacos-group/nacos-sdk-python",

nacos-sdk-python-2.0.2/v2/nacos/common/auth.py

@@ -0,0 +1,32 @@
+class Credentials(object):
+    def __init__(self, access_key_id, access_key_secret, security_token=None):
+        self.access_key_id = access_key_id
+        self.access_key_secret = access_key_secret
+        self.security_token = security_token
+
+    def get_access_key_id(self):
+        return self.access_key_id
+
+    def get_access_key_secret(self):
+        return self.access_key_secret
+
+    def get_security_token(self):
+        return self.security_token
+
+class CredentialsProvider(object):
+    def get_credentials(self):
+        return
+
+
+class StaticCredentialsProvider(CredentialsProvider):
+    def __init__(self, access_key_id="", access_key_secret="", security_token=""):
+        self.credentials = Credentials(access_key_id, access_key_secret, security_token)
+
+    def get_credentials(self):
+        return self.credentials
+
+    def set_access_key_id(self, access_key_id):
+        self.credentials.access_key_id = access_key_id
+
+    def set_access_key_secret(self, access_key_secret):
+        self.credentials.access_key_secret = access_key_secret

{nacos-sdk-python-2.0.0b5 → nacos-sdk-python-2.0.2}/v2/nacos/common/client_config.py

@@ -2,6 +2,7 @@ import logging
 
 from v2.nacos.common.constants import Constants
 from v2.nacos.common.nacos_exception import NacosException, INVALID_PARAM
+from v2.nacos.common.auth import StaticCredentialsProvider
 
 
 class KMSConfig:
@@ -44,7 +45,7 @@ class GRPCConfig:
 class ClientConfig:
     def __init__(self, server_addresses=None, endpoint=None, namespace_id='', context_path='', access_key=None,
                  secret_key=None, username=None, password=None, app_name='', app_key='', log_dir='', log_level=None,
-                 log_rotation_backup_count=None, app_conn_labels=None):
+                 log_rotation_backup_count=None, app_conn_labels=None, credentials_provider=None):
         self.server_list = []
         try:
             if server_addresses is not None and server_addresses.strip() != "":
@@ -57,9 +58,8 @@ class ClientConfig:
         self.endpoint_context_path = Constants.WEB_CONTEXT
         self.endpoint_query_header = None
         self.namespace_id = namespace_id
-        self.access_key = access_key
+        self.credentials_provider = credentials_provider if credentials_provider else StaticCredentialsProvider(access_key, secret_key)
         self.context_path = context_path
-        self.secret_key = secret_key
         self.username = username  # the username for nacos auth
         self.password = password  # the password for nacos auth
         self.app_name = app_name

{nacos-sdk-python-2.0.0b5 → nacos-sdk-python-2.0.2}/v2/nacos/common/client_config_builder.py

@@ -1,5 +1,6 @@
 from typing import Dict, List
 
+from v2.nacos.common.auth import CredentialsProvider, StaticCredentialsProvider
 from v2.nacos.common.client_config import ClientConfig, GRPCConfig
 from v2.nacos.common.client_config import KMSConfig
 from v2.nacos.common.client_config import TLSConfig
@@ -43,11 +44,21 @@ class ClientConfigBuilder:
         return self
 
     def access_key(self, access_key: str) -> "ClientConfigBuilder":
-        self._config.access_key = access_key
+        if not self._config.credentials_provider:
+            self._config.credentials_provider = StaticCredentialsProvider(access_key_id=access_key)
+        else:
+            self._config.credentials_provider.set_access_key_id(access_key)
         return self
 
     def secret_key(self, secret_key: str) -> "ClientConfigBuilder":
-        self._config.secret_key = secret_key
+        if not self._config.credentials_provider:
+            self._config.credentials_provider = StaticCredentialsProvider(access_key_secret=secret_key)
+        else:
+            self._config.credentials_provider.set_access_key_secret(secret_key)
+        return self
+
+    def credentials_provider(self, credentials_provider: CredentialsProvider) -> "ClientConfigBuilder":
+        self._config.credentials_provider = credentials_provider
         return self
 
     def username(self, username: str) -> "ClientConfigBuilder":

{nacos-sdk-python-2.0.0b5 → nacos-sdk-python-2.0.2}/v2/nacos/config/remote/config_grpc_client_proxy.py

@@ -94,7 +94,8 @@ class ConfigGRPCClientProxy:
                 'Timestamp': str(now),
             })
 
-            if self.client_config.access_key is not None and self.client_config.secret_key is not None:
+            credentials = self.client_config.credentials_provider.get_credentials()
+            if credentials.get_access_key_id() and credentials.get_access_key_secret():
                 if request.tenant:
                     resource = request.tenant + "+" + request.group
                 else:
@@ -106,11 +107,13 @@ class ConfigGRPCClientProxy:
                     sign_str = str(now)
 
                 request.put_all_headers({
-                    'Spas-AccessKey': self.client_config.access_key,
+                    'Spas-AccessKey': credentials.get_access_key_id(),
                     'Spas-Signature': base64.encodebytes(
-                        hmac.new(self.client_config.secret_key.encode(), sign_str.encode(),
+                        hmac.new(credentials.get_access_key_secret().encode(), sign_str.encode(),
                                  digestmod=hashlib.sha1).digest()).decode().strip(),
                 })
+                if credentials.get_security_token():
+                    request.put_header("Spas-SecurityToken", credentials.get_security_token())
 
             response = await rpc_client.request(request, self.client_config.grpc_config.grpc_timeout)
             if response.get_result_code() != 200:

{nacos-sdk-python-2.0.0b5 → nacos-sdk-python-2.0.2}/v2/nacos/naming/remote/naming_grpc_client_proxy.py

@@ -64,7 +64,8 @@ class NamingGRPCClientProxy:
         try:
             await self.nacos_server_connector.inject_security_info(request.get_headers())
 
-            if self.client_config.access_key is not None and self.client_config.secret_key is not None:
+            credentials = self.client_config.credentials_provider.get_credentials()
+            if credentials.get_access_key_id() and credentials.get_access_key_secret():
                 service_name = get_group_name(request.serviceName, request.groupName)
                 if service_name.strip():
                     sign_str = str(get_current_time_millis()) + Constants.SERVICE_INFO_SPLITER + service_name
@@ -72,11 +73,13 @@ class NamingGRPCClientProxy:
                     sign_str = str(get_current_time_millis())
 
                 request.put_all_headers({
-                    "ak": self.client_config.access_key,
+                    "ak": credentials.get_access_key_id(),
                     "data": sign_str,
-                    "signature": base64.encodebytes(hmac.new(self.client_config.secret_key.encode(), sign_str.encode(),
+                    "signature": base64.encodebytes(hmac.new(credentials.get_access_key_secret().encode(), sign_str.encode(),
                                                              digestmod=hashlib.sha1).digest()).decode().strip()
                 })
+                if credentials.get_security_token():
+                    request.put_header("Spas-SecurityToken", credentials.get_security_token())
 
             response = await self.rpc_client.request(request, self.client_config.grpc_config.grpc_timeout)
             if response.get_result_code() != 200:

{nacos-sdk-python-2.0.0b5 → nacos-sdk-python-2.0.2}/v2/nacos/transport/grpc_client.py

@@ -6,7 +6,7 @@ import pydantic
 
 from v2.nacos.common.client_config import ClientConfig
 from v2.nacos.common.constants import Constants
-from v2.nacos.common.nacos_exception import NacosException
+from v2.nacos.common.nacos_exception import NacosException, CLIENT_DISCONNECT
 from v2.nacos.transport.connection import Connection
 from v2.nacos.transport.grpc_connection import GrpcConnection
 from v2.nacos.transport.grpc_util import GrpcUtils
@@ -53,9 +53,13 @@ class GrpcClient(RpcClient):
         else:
             channel = grpc.aio.insecure_channel(f'{server_ip}:{grpc_port}',
                                                 options=options)
-        await channel.channel_ready()
-
-        return channel
+        try:
+            await asyncio.wait_for(channel.channel_ready(), self.grpc_config.grpc_timeout / 1000)
+        except asyncio.TimeoutError as e:
+            await channel.close()
+            raise NacosException(CLIENT_DISCONNECT, 'failed to connect nacos server') from e
+        else:
+            return channel
 
     async def _server_check(self, server_ip, server_port, channel_stub: RequestStub):
         for i in range(self.RETRY_TIMES):

{nacos-sdk-python-2.0.0b5 → nacos-sdk-python-2.0.2}/v2/nacos/transport/model/internal_request.py

@@ -8,16 +8,12 @@ CLIENT_DETECTION_REQUEST_TYPE = "ClientDetectionRequest"
 
 
 class InternalRequest(Request, ABC):
-    def __init__(self):
-        super().__init__()
 
     def get_module(self) -> str:
         return 'internal'
 
 
 class HealthCheckRequest(InternalRequest):
-    def __init__(self):
-        super().__init__()
 
     def get_request_type(self):
         return "HealthCheckRequest"

{nacos-sdk-python-2.0.0b5 → nacos-sdk-python-2.0.2}/v2/nacos/transport/nacos_server_connector.py

@@ -32,6 +32,9 @@ class NacosServerConnector:
             asyncio.create_task(self.auth_client.get_access_token(True))
 
     async def init(self):
+        if len(self.server_list) != 0:
+            return
+
         await self._get_server_list_from_endpoint()
         if len(self.server_list) == 0:
             raise NacosException(INVALID_SERVER_STATUS, "server list is empty")

{nacos-sdk-python-2.0.0b5 → nacos-sdk-python-2.0.2}/v2/nacos/transport/rpc_client.py

@@ -374,7 +374,7 @@ class RpcClient(ABC):
                 # when client request immediately after  server starts, server may not ready to serve new request
                 # the server will return code 3xx, tell the client to retry after a while
                 # this situation, just return true,because the healthCheck will start again after 5 seconds
-                if response.get_error_code() >= 300 and response.get_error_code < 400:
+                if response.get_error_code() >= 300 and response.get_error_code() < 400:
                     return True
                 return False
             return response and response.is_success()