clean up code (with a bug left)

Author: y1xiaoc

dargs/dargs.py

@@ -1,6 +1,6 @@
 r"""
 Some (ocaml) pseudo-code here to show the intended type structure::
-           
+
     type args = {key: str; value: data; optional: bool; doc: str} list
     and  data = 
            | Arg of dtype
@@ -19,7 +19,7 @@
 
 
 from typing import Union, Any, List, Iterable, Optional, Callable
-from textwrap import wrap, fill, indent
+from textwrap import indent
 from copy import deepcopy
 from enum import Enum
 import fnmatch, re
@@ -30,6 +30,7 @@
 class _Flags(Enum): NONE = 0 # for no value in dict
 
 class Argument:
+    """Define possible arguments and their types and properties."""
 
     def __init__(self, 
             name: str,
@@ -44,7 +45,9 @@ def __init__(self,
             doc: str = ""):
         self.name = name
         self.dtype = dtype
+        assert sub_fields is None or all(isinstance(s, Argument) for s in sub_fields)
         self.sub_fields = sub_fields if sub_fields is not None else []
+        assert sub_variants is None or all(isinstance(s, Variant) for s in sub_variants)
         self.sub_variants = sub_variants if sub_variants is not None else []
         self.repeat = repeat
         self.optional = optional
@@ -67,6 +70,9 @@ def __eq__(self, other: "Argument") -> bool:
             and self.repeat == other.repeat
             and self.optional == other.optional)
 
+    def __repr__(self) -> str:
+        return f"<Argument {self.name}: {' | '.join(dd.__name__ for dd in self.dtype)}>"
+
     def reorg_dtype(self):
         if isinstance(self.dtype, type) or self.dtype is None:
             self.dtype = [self.dtype]
@@ -145,7 +151,7 @@ def traverse_value(self, value: Any,
                     key_hook, value_hook, sub_hook, variant_hook)
                 self._traverse_subvariant(item, 
                     key_hook, value_hook, sub_hook, variant_hook)
-    
+
     def _traverse_subfield(self, value: dict, *args, **kwargs):
         assert isinstance(value, dict)
         for subarg in self.sub_fields:
@@ -174,7 +180,7 @@ def check_value(self, argdict: dict, strict: bool = False):
             key_hook=Argument._check_exist,
             value_hook=Argument._check_value,
             sub_hook=Argument._check_strict if strict else DUMMYHOOK)
-            
+
     def _check_exist(self, argdict: dict):
         if self.optional is True:
             return
@@ -198,7 +204,7 @@ def _check_strict(self, value: dict):
             if name not in allowed_set:
                 raise KeyError(f"undefined key `{name}` is "
                                 "not allowed in strict mode")
-        
+
     def _get_allowed_sub(self, value: dict) -> List[str]:
         allowed = [subarg.name for subarg in self.sub_fields]
         for subvrnt in self.sub_variants:
@@ -322,9 +328,10 @@ def gen_doc_body(self, paths: Optional[List[str]] = None, **kwargs) -> str:
                 body_list.append(subvrnt.gen_doc(paths, **kwargs))
         body = "\n".join(body_list)
         return body
-        
+
 
 class Variant:
+    """Define multiple choices of possible argument sets."""
 
     def __init__(self, 
             flag_name: str,
@@ -349,6 +356,9 @@ def __eq__(self, other: "Variant") -> bool:
             and self.choice_dict == other.choice_dict
             and self.optional == other.optional
             and self.default_tag == other.default_tag)
+    
+    def __repr__(self) -> str:
+        return f"<Variant {self.flag_name} in {{ {', '.join(self.choice_dict.keys())} }}>"
 
     def extend_choices(self, choices: Iterable["Argument"]):
         # choices is a list of arguments 
@@ -398,7 +408,7 @@ def traverse(self, argdict: dict,
                  variant_hook: Callable[["Variant", dict], None] = DUMMYHOOK):
         variant_hook(self, argdict)
         choice = self._load_choice(argdict)
-        # here we use check_value to flatten the tag
+        # here we use traverse_value to flatten the tag
         choice.traverse_value(argdict,
             key_hook, value_hook, sub_hook, variant_hook)
 
@@ -430,7 +440,7 @@ def _convert_alias(self, argdict: dict):
 
     # above are type checking part
     # below are doc generation part
-        
+
     def gen_doc(self, paths: Optional[List[str]] = None, **kwargs) -> str:
         body_list = [""]
         body_list.append(f"Depending on the value of *{self.flag_name}*, "

setup.py

@@ -25,7 +25,7 @@
     url="https://github.com/deepmodeling/dargs",
     packages=['dargs'],
     classifiers=[
-        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
         "License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)",
     ],
     install_requires=install_requires,

tests/test_checker.py

@@ -171,6 +171,7 @@ def test_sub_variants(self):
         with self.assertRaises(KeyError):
             ca.check(err_dict1)
         err_dict1["base"]["vnt_flag"] = "type1"
+        ca.check(err_dict1, strict=True) # this should pass
         err_dict1["base"]["additional"] = "hahaha"
         ca.check(err_dict1) # now should pass
         with self.assertRaises(KeyError):