New release: 0.0.26 → 0.0.27

milc.py

@@ -178,8 +178,9 @@ class ConfigurationSection(Configuration):
 
     def __getitem__(self, key):
         """Returns a config value, pulling from the `user` section as a fallback.
+        This is called when the attribute is accessed either via the get method or through [ ] index.
         """
-        if key in self._config:
+        if key in self._config and self._config.get(key) is not None:
             return self._config[key]
 
         elif key in self.parent.user:
@@ -187,6 +188,15 @@ class ConfigurationSection(Configuration):
 
         return None
 
+    def __getattr__(self, key):
+        """Returns the config value from the `user` section.
+        This is called when the attribute is accessed via dot notation but does not exists.
+        """
+        if key in self.parent.user:
+            return self.parent.user[key]
+
+        return None
+
 
 def handle_store_boolean(self, *args, **kwargs):
     """Does the add_argument for action='store_boolean'.
@@ -249,6 +259,9 @@ class MILC(object):
     """
     def __init__(self):
         """Initialize the MILC object.
+
+            version
+                The version string to associate with your CLI program
         """
         # Setup a lock for thread safety
         self._lock = threading.RLock() if thread else None
@@ -263,7 +276,7 @@ class MILC(object):
         self.config = None
         self.config_file = None
         self.default_arguments = {}
-        self.version = os.environ.get('QMK_VERSION', 'unknown')
+        self.version = 'unknown'
         self.release_lock()
 
         # Figure out our program name
@@ -364,6 +377,7 @@ class MILC(object):
         self.add_argument('--log-file', help='File to write log messages to')
         self.add_argument('--color', action='store_boolean', default=True, help='color in output')
         self.add_argument('--config-file', help='The location for the configuration file')
+        self.arg_only.append('config_file')
 
     def add_subparsers(self, title='Sub-commands', **kwargs):
         if self._inside_context_manager:
@@ -473,8 +487,10 @@ class MILC(object):
                     # Coerce values into useful datatypes
                     if value.lower() in ['1', 'yes', 'true', 'on']:
                         value = True
-                    elif value.lower() in ['0', 'no', 'false', 'none', 'off']:
+                    elif value.lower() in ['0', 'no', 'false', 'off']:
                         value = False
+                    elif value.lower() in ['none']:
+                        continue
                     elif value.replace('.', '').isdigit():
                         if '.' in value:
                             value = Decimal(value)
@@ -495,25 +511,31 @@ class MILC(object):
 
             if argument not in self.arg_only:
                 # Find the argument's section
-                argument_found = True
-                for group in self.default_arguments:
-                    if argument in self.default_arguments[group]:
-                        argument_found = True
-                        section = group
-                        break
+                # Underscores in command's names are converted to dashes during initialization.
+                # TODO(Erovia) Find a better solution
+                entrypoint_name = self._entrypoint.__name__.replace("_", "-")
+                if entrypoint_name in self.default_arguments and argument in self.default_arguments[entrypoint_name]:
+                    argument_found = True
+                    section = self._entrypoint.__name__
+                if argument in self.default_arguments['general']:
+                    argument_found = True
+                    section = 'general'
 
                 if not argument_found:
                     raise RuntimeError('Could not find argument in `self.default_arguments`. This should be impossible!')
                     exit(1)
 
                 # Merge this argument into self.config
-                if argument in self.default_arguments:
+                if argument in self.default_arguments['general'] or argument in self.default_arguments[entrypoint_name]:
                     arg_value = getattr(self.args, argument)
-                    if arg_value:
+                    if arg_value is not None:
                         self.config[section][argument] = arg_value
                 else:
-                    if argument not in self.config[section]:
-                        self.config[section][argument] = getattr(self.args, argument)
+                    if argument not in self.config[entrypoint_name]:
+                        # Check if the argument exist for this section
+                        arg = getattr(self.args, argument)
+                        if arg is not None:
+                            self.config[section][argument] = arg
 
         self.release_lock()
 
@@ -536,7 +558,8 @@ class MILC(object):
                 if section_name == 'general':
                     if option_name in ['config_file']:
                         continue
-                config.set(section_name, option_name, str(value))
+                if value is not None:
+                    config.set(section_name, option_name, str(value))
 
         # Write out the config file
         config_dir = self.config_file.parent
@@ -588,23 +611,25 @@ class MILC(object):
 
         return entrypoint_func
 
-    def add_subcommand(self, handler, description, name=None, **kwargs):
+    def add_subcommand(self, handler, description, name=None, hidden=False, **kwargs):
         """Register a subcommand.
 
         If name is not provided we use `handler.__name__`.
         """
+
         if self._inside_context_manager:
             raise RuntimeError('You must run this before the with statement!')
 
         if self._subparsers is None:
-            self.add_subparsers()
+            self.add_subparsers(metavar="")
 
         if not name:
             name = handler.__name__.replace("_", "-")
 
         self.acquire_lock()
-
-        kwargs['help'] = description
+        if not hidden:
+            self._subparsers.metavar = "{%s,%s}" % (self._subparsers.metavar[1:-1], name) if self._subparsers.metavar else "{%s%s}" % (self._subparsers.metavar[1:-1], name)
+            kwargs['help'] = description
         self.subcommands[name] = SubparserWrapper(self, name, self._subparsers.add_parser(name, **kwargs))
         self.subcommands[name].set_defaults(entrypoint=handler)
 
@@ -612,11 +637,11 @@ class MILC(object):
 
         return handler
 
-    def subcommand(self, description, **kwargs):
+    def subcommand(self, description, hidden=False, **kwargs):
         """Decorator to register a subcommand.
         """
         def subcommand_function(handler):
-            return self.add_subcommand(handler, description, **kwargs)
+            return self.add_subcommand(handler, description, hidden=hidden, **kwargs)
 
         return subcommand_function
 

qmk_cli/__init__.py

@@ -1,3 +1,3 @@
 """A program to help you work with qmk_firmware."""
 
-__version__ = '0.0.19'
+__version__ = '0.0.27'

qmk_cli/script_qmk.py

@@ -56,7 +56,10 @@ def find_qmk_firmware():
         return Path(milc.cli.config.user.qmk_home).expanduser().resolve()
 
     if 'QMK_HOME' in os.environ:
-        return Path(os.environ['QMK_HOME']).expanduser().resolve()
+        path = Path(os.environ['QMK_HOME']).expanduser()
+        if path.exists():
+            return path.resolve()
+        return path
 
     return Path.home() / 'qmk_firmware'
 
@@ -65,6 +68,8 @@ def main():
     """Setup the environment before dispatching to the entrypoint.
     """
     # Environment setup
+    import qmk_cli
+    milc.cli.version = qmk_cli.__version__
     qmk_firmware = find_qmk_firmware()
     os.environ['QMK_HOME'] = str(qmk_firmware)
     os.environ['ORIG_CWD'] = os.getcwd()

setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.0.19
+current_version = 0.0.27
 commit = True
 tag = True
 tag_name = {new_version}

setup.py

@@ -44,6 +44,8 @@ if __name__ == "__main__":
             "appdirs",
             "argcomplete",
             "colorama",
-            "hjson"
+            "flake8",
+            "hjson",
+            "yapf"
         ],
     )