update

Author: hsz1273327

.github/workflows/python-package.yml

@@ -5,7 +5,7 @@ name: Python package
 
 on:
   push:
-    branches: [master,dev]
+    branches: [master, dev]
   pull_request:
     branches: [master]
 
@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.8, 3.9]
+        python-version: [3.8, 3.9, 3.11]
 
     steps:
       - uses: actions/checkout@v2

.gitignore

@@ -127,3 +127,4 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+data

CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0,0,2
+
++ 异步代理依赖由aetcd3改为aetcd
++ 接口变更,现在可以通过url或者连接参数初始化实例
++ 由于依赖由aetcd3改为aetcd,现在推荐key和value都统一使用bytes类型
+
 # 0.0.1
 
 项目创建

README.md

@@ -2,10 +2,10 @@
 
 提供etcd的代理对象功能.本项目代理的对象是
 
-+ aio模式代理aetcd3
-+ 普通模式代理etcd3
++ aio模式代理[aetcd](https://aetcd.readthedocs.io/en/latest/index.html)
++ 普通模式代理[etcd3](https://python-etcd3.readthedocs.io/en/latest/)
 
-需要注意这两个模块本身冲突,也就是说如果`import etcd3`就不能再`import aetcd3`.因此同一个程序中不能混用两种模式.如果并不确定使用的是什么模式可以在代理的`aio`字段进行确认
+需要注意这两个模块本身冲突,也就是说如果`import etcd3`就不能再`import aetcd`.因此同一个程序中不能混用两种模式.如果并不确定使用的是什么模式可以在代理的`aio`字段进行确认
 
 ## 安装
 

docker-compose.yml

@@ -0,0 +1,20 @@
+version: "2.4"
+x-log: &default-log
+  options:
+    max-size: "10m"
+    max-file: "3"
+services:
+  etcd1:
+    image: docker.io/bitnami/etcd:3.5.1
+    logging:
+      options:
+        max-file: 3
+        max-size: 10m
+    environment:
+      - ALLOW_NONE_AUTHENTICATION=yes
+      - ETCDCTL_API=3
+    ports:
+      - 12379:2379
+      - 12380:2380
+    volumes:
+      - ./data:/bitnami/etcd

etcdproxy/__init__.py

@@ -1,38 +1,54 @@
 
-from typing import Optional, Any
 from pyproxypattern import Proxy
-from .url_parser import etcdurl_parser
+from typing import Optional, Any
+from .url_parser import etcdurl_parser, EtcdConnParams
 
 
 class EtcdProxy(Proxy):
     """etcd的代理类."""
     __slots__ = ('instance', "_callbacks", "_instance_check", "aio")
 
-    def __init__(self, *, url: Optional[str] = None) -> None:
+    def __init__(self, *, conn_params: Optional[EtcdConnParams] = None, aio: bool = False, url: Optional[str] = None) -> None:
         """初始化一个etcd代理.
 
         Args:
             url (Optional[str], optional): etcd的url路径,注意schema为`etcd`或`etcd+async`. Defaults to None.
         """
 
         if url:
-            instance = self.new_instance(url)
+            instance = self.new_instance_from_url(url)
+            super().__init__(instance)
+        elif conn_params:
+            instance = self.new_instance(conn_params, aio=aio)
             super().__init__(instance)
         else:
             super().__init__()
 
-    def new_instance(self, url: str) -> Any:
-        aio, configs = etcdurl_parser(url)
+    def new_instance(self, conn_params: EtcdConnParams, *, aio: bool = False) -> Any:
         if aio:
             self.aio = True
-            import aetcd3
-            return aetcd3.client(**configs)
+            import aetcd
+            return aetcd.Client(**conn_params)
         else:
             self.aio = False
             import etcd3
-            return etcd3.client(**configs)
+            return etcd3.client(**conn_params)
+
+    def initialize_from_params(self, conn_params: EtcdConnParams, *, aio: bool = False) -> None:
+        """使用参数初始化etcd连接实例
+
+        Args:
+            conn_params (EtcdConnParams): 连接参数
+            aio (bool, optional): 是否使用异步接口. Defaults to False.
+        """
+        instance = self.new_instance(conn_params, aio=aio)
+        self.initialize(instance)
+
+    def new_instance_from_url(self, url: str) -> Any:
+        urlinfo = etcdurl_parser(url)
+        return self.new_instance(urlinfo["conn_params"], aio=urlinfo["aio"])
 
     def initialize_from_url(self, url: str) -> None:
         """从url初始化."""
-        instance = self.new_instance(url)
+        instance = self.new_instance_from_url(url)
         self.initialize(instance)

etcdproxy/url_parser.py

@@ -1,9 +1,36 @@
 from urllib.parse import urlparse, parse_qsl
-from typing import Tuple, Dict, Union, ItemsView
+from typing import Dict, Union, ItemsView, TypedDict, Optional, Sequence, Literal
 
 
-def etcdurl_parser(url: str) -> Tuple[bool, Dict[str, Union[str, int, ItemsView]]]:
-    """解析etcd路径
+class EtcdConnParams(TypedDict, total=False):
+    host: str
+    port: int
+    user: str
+    password: str
+    timeout: int
+    ca_cert: str
+    cert_key: str
+    cert_cert: str
+    grpc_options: ItemsView[str, Union[str, int]]
+    options: Dict[str, Union[str, int]]
+
+
+class ParserResult(TypedDict, total=False):
+    aio: bool
+    conn_params: EtcdConnParams
+    key: str
+    is_prefix: bool
+
+
+def etcdurl_parser(url: str) -> ParserResult:
+    """解析etcd路径.
+
+    schema为`etcd`返回的`aio`字段为False,为`etcd+async`返回的`aio`字段为True,其他都为非法.
+    url中host,port,user,password部分对应etcd中对应内容
+    url中的path会被作为返回的`key`字段,如果其首字符为`/`则会被去掉,
+    当返回中有key时如果在url的参数部分设置is_prefix=true则返回的`is_prefix`会被置为True,否则置为False,
+    `ca_cert`, `cert_key`, `cert_cert`和`timeout`也在url的参数部分设置,其他的参数则会作为grpc参数传入
+    其他的连接参数可以在url的参数部分设置
 
     Args:
         url (str): etcd的地址,注意请以`etcd://`或者`etcd+async://`开头
@@ -12,12 +39,15 @@ def etcdurl_parser(url: str) -> Tuple[bool, Dict[str, Union[str, int, ItemsView]
         AttributeError: schema 必须为etcd
 
     Returns:
-        Dict[str, Union[str, int, Dict[str, str]]]: 初始化etcd客户端的参数数据
+        Dict[bool,str,bool, Union[str, int, Dict[str, str]]]: 初始化etcd客户端的参数数据,分别为是否为
     """
-    keys = ("timeout", "ca_cert", "cert_key", "cert_cert")
-    aio = False
-    intkeys = ("timeout",)
-    result: Dict[str, Union[str, int, ItemsView]] = {
+    conn_str_params = ("ca_cert", "cert_key", "cert_cert")
+    conn_int_params = ("timeout",)
+    aio: bool = False
+    key: Optional[str] = None
+    is_prefix: Optional[bool] = None
+
+    conn_params: EtcdConnParams = {
         "host": '127.0.0.1',
         "port": 2379,
     }
@@ -28,28 +58,57 @@ def etcdurl_parser(url: str) -> Tuple[bool, Dict[str, Union[str, int, ItemsView]
     if schema == "etcd+async":
         aio = True
     if parse_result.username:
-        result.update({"user": parse_result.username})
+        conn_params.update({"user": parse_result.username})
     if parse_result.password:
-        result.update({"password": parse_result.password})
+        conn_params.update({"password": parse_result.password})
     if parse_result.port:
-        result.update({"port": parse_result.port})
+        conn_params.update({"port": parse_result.port})
     if parse_result.hostname:
-        result.update({"host": parse_result.hostname})
+        conn_params.update({"host": parse_result.hostname})
+    if parse_result.path:
+        if parse_result.path not in ("", "/"):
+            if parse_result.path.startswith("/"):
+                key = parse_result.path[1:]
+            else:
+                key = parse_result.path
     if parse_result.query:
         sql_result = dict(parse_qsl(parse_result.query))
         _grpc_options: Dict[str, Union[str, int]] = {}
+        if key is not None:
+            is_prefix = False
         for k, v in sql_result.items():
-            if k in keys:
-                if k in intkeys:
-                    result.update({k: int(v)})
+            if k == "is_prefix" and key is not None:
+                print("444")
+                print(v)
+                if v.lower() == "false" or v == "0":
+                    is_prefix = False
                 else:
-                    result.update({k: v})
+                    is_prefix = True
+            elif k in conn_str_params:
+                conn_params[k] = v  # type: ignore
+            elif k in conn_int_params:
+                conn_params.update({k: int(v)})  # type: ignore
             else:
                 if v.isdigit():
                     _grpc_options.update({k: int(v)})
                 else:
                     _grpc_options.update({k: v})
         if _grpc_options:
-            grpc_options = _grpc_options.items()
-            result.update({"grpc_options": grpc_options})
-    return aio, result
+            if aio:
+                conn_params.update({"options": _grpc_options})
+            else:
+                grpc_options = _grpc_options.items()
+                conn_params.update({"grpc_options": grpc_options})
+    result: ParserResult = {
+        "aio": aio,
+        "conn_params": conn_params
+    }
+    if key is not None:
+        result.update({
+            "key": key
+        })
+    if is_prefix is not None:
+        result.update({
+            "is_prefix": is_prefix
+        })
+    return result

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = etcdproxy
-version = 0.0.1
+version = 0.0.2
 author = hsz
 author_email = hsz1273327@gmail.com
 description = etcd的代理对象
@@ -12,14 +12,16 @@ classifiers =
 	License :: OSI Approved :: MIT License
 	Programming Language :: Python :: 3.8
 	Programming Language :: Python :: 3.9
+	Programming Language :: Python :: 3.10
+	Programming Language :: Python :: 3.11
 
 [options]
 zip_safe = False
 include_package_data = True
 packages = find:
 install_requires = 
 	etcd3 >= 0.12.0
-	aetcd3 >= 0.1.0a7
+	aetcd >= 1.0.0a2
 	pyproxypattern >= 0.0.1
 tests_require = 
 	coverage >= 5.5

test.py

@@ -4,7 +4,7 @@
 
 etcd.initialize_from_url("etcd://localhost:12379")
 
-etcd.put('/key', 'dooot')
-print(etcd.get('/key'))
+etcd.put(b'/key', b'dooot')
+print(etcd.get(b'/key'))
 
-etcd.close()
+etcd.close()

testaio.py

@@ -6,8 +6,8 @@ async def main() -> None:
     etcd = EtcdProxy()
     etcd.initialize_from_url("etcd+async://localhost:12379")
     print(etcd.aio)
-    await etcd.put('/key', 'dooot')
-    print(await etcd.get('/key'))
+    await etcd.put(b'/key', b'doootaio')
+    print(await etcd.get(b'/key'))
     await etcd.close()
 
 asyncio.run(main())