WIP: Commander Python API

mcmd/__main__.py

@@ -48,6 +48,14 @@ def start(argv, context: Context):
         return 0
 
 
+def start_detached(argv, context: Context):
+    with context:
+        args = _parse_args(argv)
+        setattr(args, 'arg_string', ' '.join(argv[1:]))
+        args.func(args)
+        return 0
+
+
 def _parse_args(argv):
     try:
         return parse_args(argv[1:])

mcmd/api.py

@@ -0,0 +1,77 @@
+from pathlib import Path
+from typing import List
+
+from mcmd.__main__ import start_detached
+from mcmd.config import config
+from mcmd.core.context import Context
+
+from mcmd.core.errors import ApiError
+
+
+class EmptyContext(Context):
+    def get_scripts_folder(self) -> Path:
+        self._raise()
+
+    def get_backups_folder(self) -> Path:
+        self._raise()
+
+    def get_issues_folder(self) -> Path:
+        self._raise()
+
+    def get_history_file(self) -> Path:
+        return None
+
+    def get_dataset_folders(self) -> List[Path]:
+        self._raise()
+
+    def get_resource_folders(self) -> List[Path]:
+        self._raise()
+
+    def get_git_folders(self) -> List[Path]:
+        self._raise()
+
+    def get_properties_file(self) -> Path:
+        self._raise()
+
+    def get_storage_file(self) -> Path:
+        self._raise()
+
+    def _raise(self):
+        raise ApiError("Can't access context paths using the API.")
+
+
+class Commander:
+
+    # TODO pass token, or better: a molgenis.client.Session
+    def __init__(self):
+        config.set_config(
+            {
+                "host":
+                    {
+                        "selected": "http://localhost",
+                        "auth": [
+                            {
+                                "url": "http://localhost",
+                                "username": "xxx",
+                                "password": "xxx",
+                                "token": "xxx"
+                            }
+                        ]
+                    },
+                "settings":
+                    {
+                        "import_action": "add_update_existing",
+                        "non_interactive":  True
+                    }
+            },
+            None)
+        pass
+
+    @staticmethod
+    def execute(arg_string):
+        exit_code = start_detached(['mcmd'] + arg_string.split(' '), EmptyContext())
+        assert exit_code == 0
+
+
+commander = Commander()
+commander.execute("import --from-path it_emx_autoid")

mcmd/config/config.py

@@ -14,8 +14,10 @@
 _config = None
 _properties_file: Optional[Path] = None
 
+# TODO make Config an object similar to Context so you can have multiple types:
+# TODO PersistedConfig / TestConfig / ApiConfig
 
-def set_config(config, properties_file):
+def set_config(config: dict, properties_file):
     """The config module must not have dependencies on other modules in the config package so the necessary information
     should be passed here."""
     global _config
@@ -33,7 +35,8 @@ def set_config(config, properties_file):
 
 def _persist():
     """Writes the config to disk."""
-    YAML().dump(_config, _properties_file)
+    if _properties_file:
+        YAML().dump(_config, _properties_file)
 
 
 def get(*args):

mcmd/core/command.py

@@ -30,6 +30,10 @@ def wrapper(args, nested=False):
         :return: a decorated function
         """
 
+        # TODO   detect when running via Api and:
+        # TODO   - don't write history
+        # TODO   - don't catch the McmdErrors and just let them be raised
+
         success = True
         try:
             _set_authentication(args)
@@ -60,6 +64,7 @@ def wrapper(args, nested=False):
 
 def _set_authentication(args):
     if args.as_user:
+        # TODO create a temporary alternative molgenis.client.Session
         if args.with_password:
             auth.set_(username=args.as_user, password=args.with_password, as_user=True)
         else:

mcmd/core/errors.py

@@ -1,6 +1,10 @@
 from mcmd.config import config
 
 
+class ApiError(Exception):
+    pass
+
+
 class McmdError(Exception):
     def __init__(self, message, info: str = None):
         """

mcmd/core/history.py

@@ -9,7 +9,12 @@
 
 def write(arg_string, success):
     try:
-        history = open(str(context().get_history_file()), 'a')
+        # TODO handle in command.py
+        file = context().get_history_file()
+        if not file:
+            return
+
+        history = open(str(file), 'a')
 
         indicator = _INDICATOR_SUCCESS
         if not success:

mcmd/molgenis/client.py

@@ -6,6 +6,7 @@
 from mcmd.molgenis import auth
 from mcmd.molgenis.request_handler import request
 
+# TODO use a molgenis.client.Session
 
 @request
 def get(url, params=None) -> Response: