Refactor: config.py, defs.py, dirs.py

Author: titusjan

argos/info.py

@@ -45,20 +45,19 @@
 KEY_VERSION = '_version'
 
 # TODO: move to utils locations
-def program_directory():
+def program_directory() -> str:
     """ Returns the program directory where this program is installed
     """
     return os.path.abspath(os.path.dirname(__file__))
 
 
-def resource_directory():
+def resource_directory() -> str:
     """ Returns directory with resources (images, style sheets, etc)
     """
     return os.path.join(program_directory(), 'img/')
 
 
-
-def icons_directory():
+def icons_directory() -> str:
     """ Returns the icons directory
     """
     return os.path.join(program_directory(), 'img/snipicons')

argos/utils/config.py

@@ -3,13 +3,13 @@
 """ Various function related to config files.
 """
 import logging
-from typing import Dict, Any
+from typing import Any, Dict, List
 
 logger = logging.getLogger(__name__)
 
 ConfigDict = Dict[str, Any]
 
-def __findConfigParameter(cfg, parts, orgPath):
+def _findConfigParameter(cfg: ConfigDict, parts: List[str], orgPath: str) -> Any:
     """ Recursively finds a parameter in a (config) dict.
     """
     if len(parts) == 0:
@@ -18,7 +18,7 @@ def __findConfigParameter(cfg, parts, orgPath):
     head, tail = parts[0], parts[1:]
 
     if head == "":  # A leading slash or double orgPath
-        return __findConfigParameter(cfg, tail, orgPath)
+        return _findConfigParameter(cfg, tail, orgPath)
 
     if head not in cfg:
         msg = "Path {!r} not found in dict. {!r} not in: {}".format(orgPath, head, list(cfg.keys()))
@@ -27,32 +27,36 @@ def __findConfigParameter(cfg, parts, orgPath):
     if len(tail) == 0:
         return cfg[head]
     else:
-        return __findConfigParameter(cfg[head], tail, orgPath)
+        return _findConfigParameter(cfg[head], tail, orgPath)
 
 
-def findConfigParameter(cfg, path):
+def findConfigParameter(cfg: ConfigDict, path: str) -> Any:
     """ Recursively finds a parameter in a config dict.
 
-        Raises KeyError if the path cannot be found.
+        Raises:
+            KeyError: if the path cannot be found.
 
-        :param cfg: config dictionary. Can be a recursive dict (a dict of dicts, etc)
-        :param path: Slash separated parameter path. E.g.: '/dict1/dict2/parameter'
+        Args:
+            cfg: config dictionary. Can be a recursive dict (a dict of dicts, etc.)
+            path: Slash-separated parameter path. E.g.: '/dict1/dict2/parameter'
     """
     if not path:
         # An empty path is most likely a programming error
         raise KeyError("Empty path given to findConfigParameter: {}".format(path))
     else:
         parts = path.split('/')
-        return __findConfigParameter(cfg, parts, path)
+        return _findConfigParameter(cfg, parts, path)
 
 
-def getConfigParameter(cfg, path, alt=None):
+def getConfigParameter(cfg: ConfigDict, path: str, alt: Any = None) -> Any:
     """ Finds the findConfigParameter. Returns alternative value if not found.
 
         Will still log a warning if the parameter is not found.
 
-        :param cfg: config dictionary. Can be a recursive dict (a dict of dicts, etc)
-        :param path: Slash separated parameter path. E.g.: '/dict1/dict2/parameter'
+        Args:
+            cfg: config dictionary. Can be a recursive dict (a dict of dicts, etc.)
+            path: Slash separated parameter path. E.g.: '/dict1/dict2/parameter'
+            alt: Alternative value returned when the value is not found in the dictionary.
     """
     try:
         return findConfigParameter(cfg, path)
@@ -61,13 +65,13 @@ def getConfigParameter(cfg, path, alt=None):
         return alt
 
 
+def deleteParameter(cfg: ConfigDict, parentPath: str, parName: str) -> None:
+    """ Deletes a parameter from the config dictionary.
 
-def deleteParameter(cfg, parentPath, parName):
-    """ Deletes a parameter from the config dict
-
-        :param cfg: config dictionary
-        :param parentPath: the path of the parent dict that contains the paremeter
-        :param parName: name of the element that will be removed
+        Args:
+            cfg: config dictionary
+            parentPath: the path of the parent dict that contains the paremeter
+            parName: name of the element that will be removed
     """
     logger.debug("Deleting {!r} from parent dict: {!r}".format(parName, parentPath))
     try:

argos/utils/defs.py

@@ -16,7 +16,7 @@
 # along with Argos. If not, see <http://www.gnu.org/licenses/>.
 
 
-""" Various definitions, errors and constants that can be used throughout the program
+""" Various definitions, errors and constants that can be used throughout the program.
 
 """
 import sys
@@ -39,6 +39,6 @@
 
 
 class InvalidInputError(Exception):
-    """ Exception raised when the input is invalid after editing
+    """ Exception raised when the input is invalid after editing.z
     """
     pass

argos/utils/dirs.py

@@ -17,12 +17,12 @@
 
 r""" Default config and log directories under the different platforms.
 
-    Config files are stored in a subdirectory of the genericConfigLocation. Log files are stored
-    in a sub directory of the genericLocalDataLocation. These are:
+    Config files are stored in a subdirectory of the baseConfigLocation. Log files are stored
+    in a subdirectory of the baseLocalDataLocation. These are: ::
 
         Windows:
-            baseConfigLocation    -> C:\Users\<user>\AppData\Local\
-            baseLocalDataLocation -> C:\Users\<user>\AppData\Local\
+            baseConfigLocation    -> C:\Users\<user>\AppData\Local
+            baseLocalDataLocation -> C:\Users\<user>\AppData\Local
 
         OS-X:
             baseConfigLocation    -> ~/Library/Preferences
@@ -33,7 +33,6 @@
             baseLocalDataLocation -> ~/.local/share
 
     See http://doc.qt.io/qt-5/qsettings.html#platform-specific-notes.
-
 """
 
 import logging
@@ -45,10 +44,10 @@
 logger  = logging.getLogger(__name__)
 
 
-def normRealPath(path):
+def normRealPath(path: str) -> str:
     """ Returns the normalized real path.
 
-        If the path is empty or None it is returned as-is. This is to prevent expanding to the
+        If the path is empty or None, it is returned as-is. This is to prevent expanding to the
         current directory in case of undefined paths.
     """
     if path:
@@ -57,18 +56,22 @@ def normRealPath(path):
         return path
 
 
-def ensureDirectoryExists(dirName):
+def ensureDirectoryExists(dirName: str) -> None:
     """ Creates a directory if it doesn't yet exist.
     """
     if not os.path.exists(dirName):
         logger.info("Creating directory: {}".format(normRealPath(dirName)))
         os.makedirs(dirName)
 
 
-def ensureFileExists(pathName):
-    """ Creates an empty file file if it doesn't yet exist. Also creates necessary directory path.
+def ensureFileExists(pathName: str) -> str:
+    """ Creates an empty file if it doesn't yet exist. Also creates necessary directory path.
+
+        Args:
+            pathName: file path.
 
-        :returns: the normRealPath of the path name.
+        Returns:
+            The normRealPath of the path name.
     """
     pathName = normRealPath(pathName)
     dirName, fileName = os.path.split(pathName)
@@ -84,23 +87,20 @@ def ensureFileExists(pathName):
     return pathName
 
 
-def homeDirectory():
+def homeDirectory() -> str:
     """ Returns the user's home directory.
 
-        https://stackoverflow.com/a/4028943/625350
+        See: https://stackoverflow.com/a/4028943/625350
     """
     return os.path.expanduser("~")
 
 
-
-
-
 ################
 # Config files #
 ################
 
 
-def baseConfigLocation():
+def baseConfigLocation() -> str:
     r""" Gets the base configuration directory (for all applications of the user).
 
         See the module doc string at the top for details.
@@ -121,39 +121,25 @@ def baseConfigLocation():
     return normRealPath(configDir)
 
 
-def argosConfigDirectory():
+def argosConfigDirectory() -> str:
     r""" Gets the Argos configuration directory.
 
         The config directory is platform dependent. (See the module doc string at the top).
     """
     return os.path.join(baseConfigLocation(), ORGANIZATION_NAME, SCRIPT_NAME)
 
-#
-# def appConfigFileName(configFile):
-#     """ Returns default config file if configFile is emtpy string or None
-#     """
-#     if configFile:
-#         # Config file specified on the command line
-#         return configFile
-#     else:
-#         # Use the default config file name
-#         configDir = argosConfigDirectory()
-#         configFile = normRealPath(os.path.join(configDir, 'config.yaml'))
-#         return configFile
-
-
 
 #############
 # Log files #
 #############
 
 
-def baseLocalDataLocation():
+def baseLocalDataLocation() -> str:
     r""" Gets the base configuration directory (for all applications of the user).
 
         The config directory is platform dependent (see the Qt documentation for baseDataLocation).
         On Windows this will be something like:
-            C:\Users\<user>\AppData\Local\
+            ``C:\Users\<user>\AppData\Local\``
 
         See the module doc string at the top for details.
     """
@@ -173,7 +159,7 @@ def baseLocalDataLocation():
     return normRealPath(cfgDir)
 
 
-def argosLocalDataDirectory():
+def argosLocalDataDirectory() -> str:
     r""" Returns a directory where Argos can store files locally (not roaming).
 
         This directory is platform dependent. (See the module doc string at the top).
@@ -182,7 +168,7 @@ def argosLocalDataDirectory():
 
 
 
-def argosLogDirectory():
+def argosLogDirectory() -> str:
     r""" Returns the directory where Argos can store its log files.
 
         This is the 'logs' subdirectory of the argosLocalDataDirectory()

development/environment.yaml

@@ -22,5 +22,6 @@ dependencies:
 
 # The following dependencies are for development only and therefore have no version number
   - mypy
+  - pylint
   - sphinx
   - sphinx_rtd_theme

development/environment_min.yaml

@@ -25,5 +25,6 @@ dependencies:
 
 # The following dependencies are for development only and therefore have no version number
   - mypy
+  - pylint
   - sphinx
   - sphinx_rtd_theme

development/to_be_checked.txt

@@ -88,9 +88,6 @@ repo/rtiplugins/pillowio.py
 repo/rtiplugins/scipyio.py
 repo/testdata.py
 utils/__init__.py
-utils/cls.py
-utils/config.py
-utils/defs.py
 utils/dirs.py
 utils/logs.py
 utils/masks.py
@@ -108,4 +105,9 @@ widgets/testwalkdialog.py
 
 
 # Done
+utils/cls.py
+utils/config.py
+utils/defs.py
+
+
 

pyproject.toml

@@ -369,7 +369,8 @@ disable = [
     "too-few-public-methods",
     "consider-iterating-dictionary",
     "trailing-newlines",
-
+    "unnecessary-pass",
+    "consider-using-in",
 
 ]