update: WIP

Author: justinekizhak

.readthedocs.yml

@@ -22,3 +22,4 @@ python:
   version: 3.8
   install:
     - requirements: docs/requirements.txt
+    - requirements: requirements.txt

devinstaller/__main__.py

@@ -1,6 +1,6 @@
 # -----------------------------------------------------------------------------
 # Created: Mon 25 May 2020 15:10:17 IST
-# Last-Updated: Sat  8 Aug 2020 15:20:44 IST
+# Last-Updated: Mon 10 Aug 2020 01:11:15 IST
 #
 # __main__.py is part of devinstaller
 # URL: https://gitlab.com/justinekizhak/devinstaller
@@ -36,7 +36,7 @@
 """The main entrypoint module for running CLI commands
 """
 import os
-from typing import Optional
+from typing import List, Optional
 
 import click
 

devinstaller/commands.py

@@ -1,6 +1,6 @@
 # -----------------------------------------------------------------------------
 # Created: Mon 25 May 2020 16:55:05 IST
-# Last-Updated: Sat  1 Aug 2020 21:20:16 IST
+# Last-Updated: Mon 10 Aug 2020 01:49:41 IST
 #
 # commands.py is part of devinstaller
 # URL: https://gitlab.com/justinekizhak/devinstaller
@@ -37,9 +37,18 @@
 import re
 import shlex
 import subprocess
+from dataclasses import dataclass
 
 from devinstaller import exceptions as e
-from devinstaller import models as m
+
+
+@dataclass
+class CommandResponse:
+    """Response object for the `devinstaller.comands.check_cmd`
+    """
+
+    prog: str
+    cmd: str
 
 
 def run_shell(command: str) -> None:
@@ -73,14 +82,14 @@ def run(command: str) -> None:
     command_functions[res.prog](res.cmd)
 
 
-def check_cmd(command: str) -> m.CommandResponse:
+def check_cmd(command: str) -> CommandResponse:
     """Check the command and returns the command response object
     """
     try:
         pattern = r"^(py|sh): (.*)"
         result = re.match(pattern, command)
         assert result is not None
-        data = m.CommandResponse(prog=result.group(0), cmd=result.group(1))
+        data = CommandResponse(prog=result.group(0), cmd=result.group(1))
         return data
     except AssertionError:
         raise e.SpecificationError(

devinstaller/file_handler.py

@@ -1,6 +1,6 @@
 # -----------------------------------------------------------------------------
 # Created: Mon 25 May 2020 15:40:37 IST
-# Last-Updated: Sat  1 Aug 2020 18:17:53 IST
+# Last-Updated: Mon 10 Aug 2020 01:50:05 IST
 #
 # file_handler.py is part of devinstaller
 # URL: https://gitlab.com/justinekizhak/devinstaller
@@ -37,14 +37,32 @@
 import hashlib
 import os
 import re
+from dataclasses import dataclass
 from typing import Any, Callable, Dict
 
 import anymarkup
 import requests
 from typeguard import typechecked
 
 from devinstaller import exceptions as e
-from devinstaller import models as m
+
+
+@dataclass
+class FileResponse:
+    """Response object for the `devinstaller.file_handler.get_data`
+    """
+
+    digest: str
+    contents: str
+
+
+@dataclass
+class PathResponse:
+    """Response object for the `devinstaller.file_handler.check_path`
+    """
+
+    method: str
+    path: str
 
 
 @typechecked
@@ -83,8 +101,8 @@ def read_file(file_path: str) -> str:
     """
     # TODO check if the path is starting with dot or two dots
     full_path = os.path.expanduser(file_path)
-    with open(full_path, "r") as f:
-        return f.read()
+    with open(full_path, "r") as _f:
+        return _f.read()
 
 
 @typechecked
@@ -126,7 +144,7 @@ def write_file(file_content: str, file_path: str) -> None:
 
 
 @typechecked
-def get_data(file_path: str) -> m.FileResponse:
+def get_data(file_path: str) -> FileResponse:
     """Checks the input_str and downloads or reads the file.
 
     Methods:
@@ -159,18 +177,18 @@ def get_data(file_path: str) -> m.FileResponse:
         "data": lambda x: x,
     }
     file_contents = function[method](file_path)
-    data = m.FileResponse(digest=hash(str(file_contents)), contents=file_contents)
+    data = FileResponse(digest=hash_data(str(file_contents)), contents=file_contents)
     return data
 
 
 @typechecked
-def hash(input_data: str) -> str:
+def hash_data(input_data: str) -> str:
     """Hashes the input string and returns its digest
     """
     return hashlib.sha256(input_data.encode("utf-8")).hexdigest()
 
 
-def check_path(file_path: str) -> m.PathResponse:
+def check_path(file_path: str) -> PathResponse:
     """Check if the given path is adhearing to the spec
 
     Args:
@@ -183,7 +201,7 @@ def check_path(file_path: str) -> m.PathResponse:
         pattern = r"^(url|file|data): (.*)"
         result = re.match(pattern, file_path)
         assert result is not None
-        data = m.PathResponse(method=result.group(1), path=result.group(2))
+        data = PathResponse(method=result.group(1), path=result.group(2))
         return data
     except AssertionError:
         raise e.SpecificationError(

devinstaller/hookspecs.py

@@ -7,6 +7,8 @@
 
 hookspec = pluggy.HookspecMarker("devinstaller")
 
+# pylint: disable=unused-argument
+
 
 @hookspec
 def create_dependency_graph(

devinstaller/host.py

@@ -84,7 +84,7 @@ def run(
         prog_file_path: Optional[str] = None,
         spec_object: Optional[Dict[Any, Any]] = None,
         platform_codename: Optional[str] = None,
-    ) -> m.TypeFullDocument:
+    ) -> None:
         """The `run` function.
 
         This function is used for the interface block.

devinstaller/models/__init__.py

@@ -2,9 +2,6 @@
 """
 from devinstaller.models.base_module import ModuleInstallInstruction
 from devinstaller.models.common_models import (
-    CommandResponse,
-    FileResponse,
-    PathResponse,
     TypeAnyModule,
     TypeFullDocument,
     TypeInterface,

devinstaller/models/app_module.py

@@ -38,6 +38,7 @@ def __post_init_post_parse__(self):
             return None
         for i in self.uninstall_inst:
             i = i.format(**self.constants)
+        return None
 
     def install(self) -> None:
         """The function which installs app modules
@@ -52,6 +53,7 @@ def install(self) -> None:
         # installation_steps = create_instruction_list(self.install_inst)
         try:
             self.execute_instructions(self.install_inst)
+            return None
         except ModuleRollbackFailed:
             print(f"Rollback instructions for {self.display} failed. Quitting program.")
             sys.exit(1)
@@ -69,6 +71,7 @@ def uninstall(self) -> None:
         try:
             for i in self.uninstall_inst:
                 c.run(i)
+            return None
         except ModuleInstallationFailed:
             print(f"Uninstallation of {self.display} failed. Quitting program.")
             sys.exit(1)

devinstaller/models/base_module.py

@@ -4,7 +4,7 @@
 from pydantic.dataclasses import dataclass
 from typeguard import typechecked
 
-from devinstaller.commands import run_shell
+from devinstaller.commands import run
 from devinstaller.exceptions import (
     CommandFailed,
     ModuleInstallationFailed,
@@ -40,7 +40,7 @@ class BaseModule:
     @validator("constants", pre=True)
     @typechecked
     def convert_constant(
-        cls, constants: Optional[List[Dict[str, str]]]
+        self, constants: Optional[List[Dict[str, str]]]
     ) -> Dict[str, str]:
         data: Dict[str, str] = {}
         if constants is None:
@@ -120,4 +120,3 @@ def rollback_instructions(
                     run(inst.rollback)
                 except CommandFailed:
                     raise ModuleRollbackFailed
-        return None

devinstaller/models/common_models.py

@@ -1,6 +1,6 @@
 # -----------------------------------------------------------------------------
 # Created: Thu 28 May 2020 23:37:47 IST
-# Last-Updated: Sat  1 Aug 2020 21:18:33 IST
+# Last-Updated: Mon 10 Aug 2020 01:43:03 IST
 #
 # models.py is part of devinstaller
 # URL: https://gitlab.com/justinekizhak/devinstaller
@@ -81,6 +81,8 @@ class TypeCommonModule(TypedDict, total=False):
     target: str
     url: str
     version: str
+    before: Optional[str]
+    after: Optional[str]
 
 
 class TypeInterfaceModule(TypedDict, total=False):
@@ -154,33 +156,6 @@ class TypeValidateResponse(TypedDict):
     errors: Dict[Any, Any]
 
 
-@dataclass
-class FileResponse:
-    """Response object for the `devinstaller.file_handler.get_data`
-    """
-
-    digest: str
-    contents: str
-
-
-@dataclass
-class PathResponse:
-    """Response object for the `devinstaller.file_handler.check_path`
-    """
-
-    method: str
-    path: str
-
-
-@dataclass
-class CommandResponse:
-    """Response object for the `devinstaller.comands.check_cmd`
-    """
-
-    prog: str
-    cmd: str
-
-
 TypeAnyModule = Union[
     AppModule, FileModule, FolderModule, LinkModule, GroupModule, PhonyModule
 ]