update

Author: hsz1273327

Changelog.md

@@ -1,3 +1,10 @@
+# 0.1.2
+
+## 新增特性
+
++ `EntryPoint`类可以直接在实例化时通过参数定义其`description`, `epilog`, `usage`, `name`等属性.这样我们就可以直接实例化`EntryPoint`构造节点而不用继承了.这一特性适合用在构造非叶子节点时.
++ 与其对应的,`.regist_sub`方法现在可以添加参数用于在实例化节点时放入参数
+
 # 0.1.1
 
 ## bug修复

schema_entry/entrypoint.py

@@ -23,7 +23,7 @@
 from yaml import load as yaml_load
 
 from .protocol import SUPPORT_SCHEMA
-from .utils import get_parent_tree, parse_value_string_by_schema, parse_schema_as_cmd
+from .utils import SchemaType, get_parent_tree, parse_value_string_by_schema, parse_schema_as_cmd
 from .entrypoint_base import EntryPointABC
 
 
@@ -55,7 +55,77 @@ def _check_schema(self) -> None:
                 raise e
                 # sys.exit(1)
 
-    def __init__(self) -> None:
+    def __init__(self, *,
+                 description: Optional[str] = None,
+                 epilog: Optional[str] = None,
+                 usage: Optional[str] = None,
+                 name: Optional[str] = None,
+                 schema: Optional[SchemaType] = None,
+                 verify_schema: Optional[bool] = None,
+                 default_config_file_paths: Optional[List[str]] = None,
+                 config_file_only_get_need: Optional[bool] = None,
+                 load_all_config_file: Optional[bool] = None,
+                 env_prefix: Optional[str] = None,
+                 parse_env: Optional[bool] = None,
+                 argparse_check_required: Optional[bool] = None,
+                 argparse_noflag: Optional[str] = None,
+                 config_file_parser_map: Optional[Dict[str, Callable[[Path], Dict[str, Any]]]] = None,
+                 main: Optional[Callable[..., None]] = None
+                 ) -> None:
+        """初始化时定义配置.
+
+        使用这一特性我们就可以不用继承也可以定义节点了.这一特性比较适合用于那些非叶子节点.
+
+        Args:
+            description (Optional[str], optional): 节点命令行的描述信息. Defaults to None.
+            epilog (Optional[str], optional): 节点命令行的epilog信息. Defaults to None.
+            usage (Optional[str], optional): 节点命令行的usage信息. Defaults to None.
+            name (Optional[str], optional): 节点的name属性. Defaults to None.
+            schema (Optional[Dict[str, Union[str, List[str], Dict[str, Dict[str, Any]]]]], optional): 节点的校验json schema. Defaults to None.
+            verify_schema (Optional[bool], optional): 配置是否校验schema. Defaults to None.
+            default_config_file_paths (Optional[List[str]], optional): 默认配置文件路径列表. Defaults to None.
+            config_file_only_get_need (Optional[bool], optional): 设置是否在加载配置文件时只获取schema中定义的内容. Defaults to None.
+            load_all_config_file (Optional[bool], optional): 是否尝试加载全部指定的配置文件路径下的配置文件. Defaults to None.
+            env_prefix (Optional[str], optional): 设置环境变量的前缀. Defaults to None.
+            parse_env (Optional[bool], optional): 设置是否加载环境变量. Defaults to None.
+            argparse_check_required (Optional[bool], optional): 设置是否构造叶子节点命令行时指定schema中定义为必须的参数项为必填项. Defaults to None.
+            argparse_noflag (Optional[str], optional): 指定命令行中noflag的参数. Defaults to None.
+            config_file_parser_map (Optional[Dict[str, Callable[[Path], Dict[str, Any]]]], optional): 设置自定义配置文件名的解析映射. Defaults to None.
+            main (Optional[Callable[..., None]], optional): 设置作为入口的执行函数. Defaults to None.
+        """
+        if description is not None:
+            self.__doc__ = description
+        if epilog is not None:
+            self.epilog = epilog
+        if usage is not None:
+            self.usage = usage
+        if name is not None:
+            self._name = name
+        if schema is not None:
+            self.schema = schema
+        if verify_schema is not None:
+            self.verify_schema = verify_schema
+        if default_config_file_paths is not None:
+            self.default_config_file_paths = default_config_file_paths
+        if config_file_only_get_need is not None:
+            self.config_file_only_get_need = config_file_only_get_need
+        if load_all_config_file is not None:
+            self.load_all_config_file = load_all_config_file
+        if env_prefix is not None:
+            self.env_prefix = env_prefix
+        if parse_env is not None:
+            self.parse_env = parse_env
+        if argparse_check_required is not None:
+            self.argparse_check_required = argparse_check_required
+        if argparse_noflag is not None:
+            self.argparse_noflag = argparse_noflag
+        if config_file_parser_map is not None:
+            self._config_file_parser_map = config_file_parser_map
+        if config_file_parser_map is not None:
+            self._config_file_parser_map = config_file_parser_map
+        if main is not None:
+            self._main = main
+
         self._check_schema()
         self._subcmds = {}
         self._main = None
@@ -79,8 +149,8 @@ def regist_subcmd(self, subcmd: EntryPointABC) -> None:
         subcmd.parent = self
         self._subcmds[subcmd.name] = subcmd
 
-    def regist_sub(self, subcmdclz: type) -> EntryPointABC:
-        instance = subcmdclz()
+    def regist_sub(self, subcmdclz: type, **kwargs: Any) -> EntryPointABC:
+        instance = subcmdclz(**kwargs)
         self.regist_subcmd(instance)
         return instance
 
@@ -139,7 +209,7 @@ def _make_commandline_parse_by_schema(self, parser: argparse.ArgumentParser) ->
         if self.schema is None:
             raise AttributeError("此处不该被执行")
         else:
-            properties: Dict[str, Any] = self.schema.get("properties", {})
+            properties: Dict[str, Dict[str, Any]] = self.schema.get("properties", {})
             requireds: List[str] = self.schema.get("required", [])
             for key, prop in properties.items():
                 required = False
@@ -235,7 +305,7 @@ def file_config_filter(self, file_param: Dict[str, Any]) -> Dict[str, Any]:
             Dict[str, Any]: 筛选过后的参数
         """
         if self.config_file_only_get_need and self.schema is not None and self.schema.get("properties") is not None:
-            needs = list(self.schema.get("properties").keys())
+            needs = list(self.schema["properties"].keys())
             res = {}
             for key in needs:
                 if file_param.get(key) is not None:

schema_entry/entrypoint_base.py

@@ -2,7 +2,8 @@
 import abc
 import argparse
 from pathlib import Path
-from typing import Callable, Sequence, Dict, Any, Optional, List, Union, Tuple
+from typing import Callable, Sequence, Dict, Any, Optional, Tuple
+from .utils import SchemaType
 
 
 class EntryPointABC(abc.ABC):
@@ -28,7 +29,7 @@ class EntryPointABC(abc.ABC):
     _name: str
     parent: Optional["EntryPointABC"]
 
-    schema: Optional[Dict[str, Union[str, List[str], Dict[str, Dict[str, Any]]]]]
+    schema: Optional[SchemaType]  # Optional[Dict[str, Union[str, List[str], Dict[str, Dict[str, Any]]]]]
     verify_schema: bool
 
     default_config_file_paths: Sequence[str]
@@ -71,7 +72,7 @@ def regist_subcmd(self, subcmd: "EntryPointABC") -> None:
 
         """
     @abc.abstractmethod
-    def regist_sub(self, subcmdclz: type) -> "EntryPointABC":
+    def regist_sub(self, subcmdclz: type, **kwargs: Any) -> "EntryPointABC":
         '''注册子命令.
 
         Args:

schema_entry/utils.py

@@ -5,9 +5,16 @@
 import warnings
 import argparse
 from typing import List, Dict, Any, Optional
+from mypy_extensions import TypedDict
 from .entrypoint_base import EntryPointABC
 
 
+class SchemaType(TypedDict):
+    required: List[str]
+    type: str
+    properties: Dict[str, Dict[str, Any]]
+
+
 def _get_parent_tree(c: EntryPointABC, result: List[str]) -> None:
     if c.parent:
         result.append(c.parent.name)

setup.cfg

@@ -24,6 +24,7 @@ packages = find:
 install_requires =
     jsonschema >= 3.2.0
     pyyaml >= 5.0.0
+    mypy >= 0.800
 
 [options.packages.find]
 include = schema_entry

tests/test_entrypoint.py

@@ -19,11 +19,11 @@ def tearDownModule() -> None:
 class CMDTest(unittest.TestCase):
     @classmethod
     def setUpClass(cls) -> None:
-        print("setUp GetParentTree test context")
+        print("setUp CMDTest test context")
 
     @classmethod
     def tearDownClass(cls) -> None:
-        print("tearDown GetParentTree test context")
+        print("tearDown CMDTest test context")
 
     def test_default_name(self) -> None:
         class Test_A(EntryPoint):
@@ -140,11 +140,11 @@ def _(a: int) -> None:
 class LoadConfigTest(unittest.TestCase):
     @classmethod
     def setUpClass(cls) -> None:
-        print("setUp GetParentTree test context")
+        print("setUp LoadConfigTest test context")
 
     @classmethod
     def tearDownClass(cls) -> None:
-        print("tearDown GetParentTree test context")
+        print("tearDown LoadConfigTest test context")
 
     def test_load_default_config(self) -> None:
         class Test_A(EntryPoint):