fix: clean code and complete docstrings

JuanDavidBuitrago · JuanDavidBuitrago · commit e74f39a3d28f · 2022-06-23T17:18:26.000-05:00
diff --git a/tvm/cli.py b/tvm/cli.py
@@ -177,7 +177,6 @@ def list_versions(limit: int):
         click.echo(click.style(name, fg=color))
 
 
-
 @click.command(name="list")
 @click.option('-l', '--limit', default=10, help='number of `latest versions` to list')
 def list_versions_backup(limit: int):
@@ -520,12 +519,12 @@ def install_plugin(options):
 def uninstall_plugin(options):
     """Use the package installer pip in current tutor version."""
     repository = VersionManagerGitRepository()
-    uninstaller =TutorPluginUninstaller(repository=repository)
+    uninstaller = TutorPluginUninstaller(repository=repository)
     options = list(options)
     options.insert(0, "uninstall")
     options.append("-y")
     uninstaller(options)
-    
+
 
 @click.group(
     name="config",
diff --git a/tvm/version_manager/__init__.py b/tvm/version_manager/__init__.py
@@ -0,0 +1 @@
+"""Version manager init."""
diff --git a/tvm/version_manager/application/__init__.py b/tvm/version_manager/application/__init__.py
@@ -0,0 +1 @@
+"""Application init."""
diff --git a/tvm/version_manager/application/tutor_plugin_installer.py b/tvm/version_manager/application/tutor_plugin_installer.py
@@ -1,9 +1,14 @@
+"""Tutor plugin installer application."""
 from tvm.version_manager.domain.version_manager_repository import VersionManagerRepository
 
 
 class TutorPluginInstaller:
+    """Tutor plugin installer for version manager."""
+
     def __init__(self, repository: VersionManagerRepository) -> None:
+        """init."""
         self.repository = repository
 
     def __call__(self, options) -> None:
+        """call."""
         self.repository.install_plugin(options)
diff --git a/tvm/version_manager/application/tutor_plugin_uninstaller.py b/tvm/version_manager/application/tutor_plugin_uninstaller.py
@@ -1,10 +1,14 @@
-from tvm.version_manager.domain.tutor_version import TutorVersion
+"""Tutor plugin uninstaller application."""
 from tvm.version_manager.domain.version_manager_repository import VersionManagerRepository
 
 
 class TutorPluginUninstaller:
+    """Tutor plugin uninstaller for version manager."""
+
     def __init__(self, repository: VersionManagerRepository) -> None:
+        """init."""
         self.repository = repository
 
     def __call__(self, options) -> None:
+        """call."""
         self.repository.uninstall_plugin(options)
diff --git a/tvm/version_manager/application/tutor_version_enabler.py b/tvm/version_manager/application/tutor_version_enabler.py
@@ -1,11 +1,16 @@
+"""Tutor version enabler application."""
 from tvm.version_manager.domain.tutor_version import TutorVersion
 from tvm.version_manager.domain.version_manager_repository import VersionManagerRepository
 
 
 class TutorVersionEnabler:
+    """Tutor version enabler for version manager."""
+
     def __init__(self, repository: VersionManagerRepository) -> None:
+        """init."""
         self.repository = repository
 
     def __call__(self, version: str) -> None:
+        """call."""
         version = TutorVersion(version)
         self.repository.use_version(version)
diff --git a/tvm/version_manager/application/tutor_version_finder.py b/tvm/version_manager/application/tutor_version_finder.py
@@ -1,11 +1,16 @@
+"""Tutor version finder application."""
 from tvm.version_manager.domain.tutor_version import TutorVersion
 from tvm.version_manager.domain.version_manager_repository import VersionManagerRepository
 
 
 class TutorVersionFinder:
+    """Tutor version finder for version manager."""
+
     def __init__(self, repository: VersionManagerRepository):
+        """init."""
         self.repository = repository
 
     def __call__(self, version: str) -> TutorVersion:
+        """call."""
         version = TutorVersion(version)
         return self.repository.find_version(version=version)
diff --git a/tvm/version_manager/application/tutor_version_installer.py b/tvm/version_manager/application/tutor_version_installer.py
@@ -1,11 +1,16 @@
+"""Tutor version installer application."""
 from tvm.version_manager.domain.tutor_version import TutorVersion
 from tvm.version_manager.domain.version_manager_repository import VersionManagerRepository
 
 
 class TutorVersionInstaller:
+    """Tutor version installer for version manager."""
+
     def __init__(self, repository: VersionManagerRepository) -> None:
+        """init."""
         self.repository = repository
 
     def __call__(self, version: str) -> None:
+        """call."""
         version = TutorVersion(version)
         self.repository.install_version(version=version)
diff --git a/tvm/version_manager/application/tutor_version_uninstaller.py b/tvm/version_manager/application/tutor_version_uninstaller.py
@@ -1,11 +1,16 @@
+"""Tutor version uninstaller application."""
 from tvm.version_manager.domain.tutor_version import TutorVersion
 from tvm.version_manager.domain.version_manager_repository import VersionManagerRepository
 
 
 class TutorVersionUninstaller:
+    """Tutor version uninstaller for version manager."""
+
     def __init__(self, repository: VersionManagerRepository) -> None:
+        """init."""
         self.repository = repository
 
     def __call__(self, version: str) -> None:
+        """call."""
         version = TutorVersion(version)
         self.repository.uninstall_version(version)
diff --git a/tvm/version_manager/application/tutor_vesion_lister.py b/tvm/version_manager/application/tutor_vesion_lister.py
@@ -1,13 +1,17 @@
+"""Tutor version application."""
 from typing import List
+
 from tvm.version_manager.domain.tutor_version import TutorVersion
-from tvm.version_manager.domain.version_manager_repository import (
-    VersionManagerRepository,
-)
+from tvm.version_manager.domain.version_manager_repository import VersionManagerRepository
 
 
 class TutorVersionLister:
+    """Tutor version lister for version manage."""
+
     def __init__(self, repository: VersionManagerRepository) -> None:
+        """init."""
         self.repository = repository
 
     def __call__(self, limit: int) -> List[TutorVersion]:
+        """call."""
         return self.repository.list_versions(limit=limit)
diff --git a/tvm/version_manager/domain/__init__.py b/tvm/version_manager/domain/__init__.py
@@ -0,0 +1 @@
+"""Domain init."""
diff --git a/tvm/version_manager/domain/tutor_version.py b/tvm/version_manager/domain/tutor_version.py
@@ -1,15 +1,17 @@
+"""Tutor version domain."""
 import re
-from tvm.version_manager.domain.tutor_version_format_error import (
-    TutorVersionFormatError,
-)
+
+from tvm.version_manager.domain.tutor_version_format_error import TutorVersionFormatError
 
 
 class TutorVersion(str):
-    def __init__(self, value: str, file_url: str = None):
+    """Tutor version format."""
+
+    def __init__(self, value: str, file_url: str = None):  # pylint: disable=super-init-not-called
         """Raise BadParameter if the value is not a tutor version."""
         self._value = value
         self._file_url = file_url
 
-        result = re.match(r'^v([0-9]+)\.([0-9]+)\.([0-9]+)$', value)
+        result = re.match(r"^v([0-9]+)\.([0-9]+)\.([0-9]+)$", value)
         if not result:
             raise TutorVersionFormatError("format must be 'vX.Y.Z'")
diff --git a/tvm/version_manager/domain/tutor_version_format_error.py b/tvm/version_manager/domain/tutor_version_format_error.py
@@ -1,2 +1,5 @@
+"""Tutor version format error message."""
+
+
 class TutorVersionFormatError(Exception):
-    pass
+    """Tutor version format error exception."""
diff --git a/tvm/version_manager/domain/tutor_version_is_not_installed.py b/tvm/version_manager/domain/tutor_version_is_not_installed.py
@@ -1,2 +1,5 @@
+"""Tutor vesion is not installed."""
+
+
 class TutorVersionIsNotInstalled(Exception):
-    pass
+    """Tutor vesion is not installed  domain."""
diff --git a/tvm/version_manager/domain/version_manager_repository.py b/tvm/version_manager/domain/version_manager_repository.py
@@ -1,49 +1,52 @@
+"""Version manager repository methods."""
 from abc import ABC, abstractmethod
 from typing import List, Optional
 
 from tvm.version_manager.domain.tutor_version import TutorVersion
 
 
 class VersionManagerRepository(ABC):
+    """Administrate version manager repository methods."""
+
     @abstractmethod
     def list_versions(self, limit: int) -> List[TutorVersion]:
-        pass
+        """List versions of the version manager."""
 
     @staticmethod
     @abstractmethod
     def local_versions(tvm_path: str) -> List[TutorVersion]:
-        pass
+        """List local versions of the version manager."""
 
     @staticmethod
     @abstractmethod
     def current_version(tvm_path: str) -> List[TutorVersion]:
-        pass
+        """Present the current version of the version manager."""
 
     @abstractmethod
     def install_version(self, version: TutorVersion) -> None:
-        pass
+        """Install the version manager for tutor version."""
 
     @abstractmethod
     def find_version(self, version: TutorVersion) -> Optional[TutorVersion]:
-        pass
+        """Find the tutor version manager."""
 
     @abstractmethod
     def uninstall_version(self, version: TutorVersion) -> None:
-        pass
+        """Uninstall the version manager for tutor version selected."""
 
     @abstractmethod
     def use_version(self, version: TutorVersion) -> None:
-        pass
+        """Use selected version when is installed."""
 
     @staticmethod
     @abstractmethod
     def version_is_installed(version: str) -> None:
-        pass
+        """Version is installed method."""
 
     @abstractmethod
     def install_plugin(self, options: List) -> None:
-        pass
+        """Install tutor plugin."""
 
     @abstractmethod
     def uninstall_plugin(self, options: List) -> None:
-        pass
+        """Uninstall tutor plugin."""
diff --git a/tvm/version_manager/infrastructure/__init__.py b/tvm/version_manager/infrastructure/__init__.py
@@ -0,0 +1 @@
+"""Infrastructure init."""
diff --git a/tvm/version_manager/infrastructure/version_manager_git_repository.py b/tvm/version_manager/infrastructure/version_manager_git_repository.py
diff --git a/tvm/version_manager/templates/__init__.py b/tvm/version_manager/templates/__init__.py
