instant-python 0.4.0__py3-none-any.whl → 0.5.0__py3-none-any.whl

instant_python/cli.py

@@ -1,11 +1,28 @@
-import typer
+from rich.console import Console
+from rich.panel import Panel
 
 from instant_python import folder_cli, project_cli
+from instant_python.errors.application_error import ApplicationError
+from instant_python.intant_python_typer import InstantPythonTyper
+
+app = InstantPythonTyper()
+console = Console()
 
-app = typer.Typer()
 app.add_typer(folder_cli.app, name="folder", help="Generate only the folder structure for a new project")
 app.add_typer(project_cli.app, name="project", help="Generate a full project ready to be used")
 
 
+@app.error_handler(ApplicationError)
+def handle_application_error(exc: ApplicationError) -> None:
+    error_panel = Panel(exc.message, title="Error", border_style="red")
+    console.print(error_panel)
+
+
+@app.error_handler(Exception)
+def handle_unexpected_error(exc: Exception) -> None:
+    error_panel = Panel(f"An unexpected error occurred: {exc}", title="Error", border_style="red")
+    console.print(error_panel)
+
+
 if __name__ == "__main__":
     app()

instant_python/errors/application_error.py

@@ -0,0 +1,11 @@
+from abc import ABC, abstractmethod
+
+
+class ApplicationError(Exception, ABC):
+    @property
+    @abstractmethod
+    def type(self) -> str: ...
+
+    @property
+    @abstractmethod
+    def message(self) -> str: ...

instant_python/errors/command_execution_error.py

@@ -0,0 +1,20 @@
+from instant_python.errors.application_error import ApplicationError
+from instant_python.errors.error_types import ErrorTypes
+
+
+class CommandExecutionError(ApplicationError):
+    def __init__(self, exit_code: int, stderr_output=None):
+        self._message = (
+            f"Unexpected error when executing a command, exit code {exit_code}"
+        )
+        if stderr_output:
+            self._message += f": {stderr_output.decode('utf-8').strip()}"
+        super().__init__(self._message)
+
+    @property
+    def type(self) -> str:
+        return ErrorTypes.INSTALLER.value
+
+    @property
+    def message(self) -> str:
+        return self._message

instant_python/errors/error_types.py

@@ -0,0 +1,6 @@
+from enum import Enum
+
+
+class ErrorTypes(str, Enum):
+	INSTALLER = "installer_error"
+	GENERATOR = "project_generator_error"

instant_python/errors/template_file_not_found_error.py

@@ -0,0 +1,18 @@
+from pathlib import Path
+
+from instant_python.errors.application_error import ApplicationError
+from instant_python.errors.error_types import ErrorTypes
+
+
+class TemplateFileNotFoundError(ApplicationError):
+    def __init__(self, template_path: str | Path) -> None:
+        self._message = f"Could not find YAML file at: {template_path}"
+        super().__init__(self._message)
+
+    @property
+    def type(self) -> str:
+        return ErrorTypes.GENERATOR.value
+
+    @property
+    def message(self) -> str:
+        return self._message

instant_python/errors/unknown_dependency_manager_error.py

@@ -0,0 +1,18 @@
+from instant_python.errors.application_error import ApplicationError
+from instant_python.errors.error_types import ErrorTypes
+
+
+class UnknownDependencyManagerError(ApplicationError):
+    def __init__(self, manager: str) -> None:
+        self._message = (
+            f"Unknown dependency manager: {manager}. Please use 'pdm' or 'uv'."
+        )
+        super().__init__(self._message)
+
+    @property
+    def type(self) -> str:
+        return ErrorTypes.INSTALLER.value
+
+    @property
+    def message(self) -> str:
+        return self._message

instant_python/errors/unknown_node_typer_error.py

@@ -0,0 +1,16 @@
+from instant_python.errors.application_error import ApplicationError
+from instant_python.errors.error_types import ErrorTypes
+
+
+class UnknownNodeTypeError(ApplicationError):
+    def __init__(self, node_type: str) -> None:
+        self._message = f"Unknown node type: {node_type}"
+        super().__init__(self._message)
+
+    @property
+    def type(self) -> str:
+        return ErrorTypes.GENERATOR.value
+
+    @property
+    def message(self) -> str:
+        return self._message

instant_python/errors/unknown_template_error.py

@@ -0,0 +1,16 @@
+from instant_python.errors.application_error import ApplicationError
+from instant_python.errors.error_types import ErrorTypes
+
+
+class UnknownTemplateError(ApplicationError):
+    def __init__(self, template_name: str) -> None:
+        self._message = f"Unknown template type: {template_name}"
+        super().__init__(self._message)
+
+    @property
+    def type(self) -> str:
+        return ErrorTypes.GENERATOR.value
+
+    @property
+    def message(self) -> str:
+        return self._message

instant_python/installer/dependency_manager_factory.py

@@ -1,3 +1,4 @@
+from instant_python.errors.unknown_dependency_manager_error import UnknownDependencyManagerError
 from instant_python.installer.dependency_manager import DependencyManager
 from instant_python.installer.managers import Managers
 from instant_python.installer.pdm_manager import PdmManager
@@ -11,4 +12,7 @@ class DependencyManagerFactory:
             Managers.UV: UvManager,
             Managers.PDM: PdmManager,
         }
-        return managers[Managers(user_manager)](project_path)
+        try:
+            return managers[Managers(user_manager)](project_path)
+        except KeyError:
+            raise UnknownDependencyManagerError(user_manager)

instant_python/installer/git_configurer.py

@@ -21,6 +21,7 @@ class GitConfigurer:
             check=True,
             cwd=self._project_directory,
             stdout=subprocess.DEVNULL,
+            stderr=subprocess.PIPE,
         )
         print(">>> Git repository initialized successfully")
 
@@ -32,6 +33,7 @@ class GitConfigurer:
             check=True,
             cwd=self._project_directory,
             stdout=subprocess.DEVNULL,
+            stderr=subprocess.PIPE,
         )
         print(">>> Git user and email configured successfully")
 
@@ -43,5 +45,6 @@ class GitConfigurer:
 	        check=True,
 	        cwd=self._project_directory,
             stdout=subprocess.DEVNULL,
+            stderr=subprocess.PIPE,
         )
         print(">>> Initial commit made successfully")

instant_python/installer/installer.py

@@ -1,3 +1,6 @@
+import subprocess
+
+from instant_python.errors.command_execution_error import CommandExecutionError
 from instant_python.installer.dependency_manager import DependencyManager
 
 
@@ -13,6 +16,9 @@ class Installer:
     def perform_installation(
         self, python_version: str, dependencies: list[str]
     ) -> None:
-        self._dependency_manager.install()
-        self._dependency_manager.install_python(python_version)
-        self._dependency_manager.install_dependencies(dependencies)
+        try:
+            self._dependency_manager.install()
+            self._dependency_manager.install_python(python_version)
+            self._dependency_manager.install_dependencies(dependencies)
+        except subprocess.CalledProcessError as error:
+            raise CommandExecutionError(exit_code=error.returncode, stderr_output=error.stderr)

instant_python/installer/managers.py

@@ -2,6 +2,5 @@ from enum import Enum
 
 
 class Managers(str, Enum):
-    PYENV = "pyenv"
     UV = "uv"
     PDM = "pdm"

instant_python/installer/pdm_manager.py

@@ -16,6 +16,8 @@ class PdmManager(DependencyManager):
             "curl -sSL https://pdm-project.org/install-pdm.py | python3 -",
             shell=True,
             check=True,
+            stdout=subprocess.DEVNULL,
+            stderr=subprocess.PIPE,
         )
         print(">>> pdm installed successfully")
 
@@ -27,6 +29,8 @@ class PdmManager(DependencyManager):
             shell=True,
             check=True,
             cwd=self._project_directory,
+            stdout=subprocess.DEVNULL,
+            stderr=subprocess.PIPE,
         )
         print(f">>> Python {version} installed successfully")
 
@@ -55,6 +59,8 @@ class PdmManager(DependencyManager):
             shell=True,
             check=True,
             cwd=self._project_directory,
+            stdout=subprocess.DEVNULL,
+            stderr=subprocess.PIPE,
         )
 
     @staticmethod
@@ -76,4 +82,5 @@ class PdmManager(DependencyManager):
             check=True,
             cwd=self._project_directory,
             stdout=subprocess.DEVNULL,
+            stderr=subprocess.PIPE,
         )

instant_python/installer/uv_manager.py

@@ -17,6 +17,7 @@ class UvManager(DependencyManager):
             shell=True,
             check=True,
             stdout=subprocess.DEVNULL,
+            stderr=subprocess.PIPE,
         )
         print(">>> uv installed successfully")
 
@@ -29,6 +30,7 @@ class UvManager(DependencyManager):
             check=True,
             cwd=self._project_directory,
             stdout=subprocess.DEVNULL,
+            stderr=subprocess.PIPE,
         )
         print(f">>> Python {version} installed successfully")
 
@@ -58,6 +60,7 @@ class UvManager(DependencyManager):
             check=True,
             cwd=self._project_directory,
             stdout=subprocess.DEVNULL,
+            stderr=subprocess.PIPE,
         )
         print(f">>> {dependency_name} installed successfully")
 
@@ -81,4 +84,5 @@ class UvManager(DependencyManager):
             check=True,
             cwd=self._project_directory,
             stdout=subprocess.DEVNULL,
+            stderr=subprocess.PIPE,
         )

instant_python/intant_python_typer.py

@@ -0,0 +1,30 @@
+from collections.abc import Callable
+
+import typer
+
+ExceptionType = type[Exception]
+ErrorHandlingCallback = Callable[[Exception], None]
+
+
+class InstantPythonTyper(typer.Typer):
+    error_handlers: dict[ExceptionType, ErrorHandlingCallback] = {}
+
+    def error_handler(self, exc: ExceptionType):
+        """Registers a callback function to be called when 'exc' (the given exception) is raised."""
+
+        def decorator(func: ErrorHandlingCallback):
+            self.error_handlers[exc] = func
+            return func
+
+        return decorator
+
+    def __call__(self, *args, **kwargs):
+        """Overrides Typer.__call__ so that when we run the CLI,
+        we can catch any exception that's raised and see if there's
+        a matching error handler for it.
+        """
+        try:
+            super().__call__(*args, **kwargs)
+        except Exception as error:
+            callback = self.error_handlers.get(error.__class__.__base__)
+            callback(error)

instant_python/project_generator/custom_template_manager.py

@@ -2,6 +2,7 @@ from pathlib import Path
 
 import yaml
 
+from instant_python.errors.template_file_not_found_error import TemplateFileNotFoundError
 from instant_python.project_generator.template_manager import TemplateManager
 
 
@@ -11,8 +12,6 @@ class CustomTemplateManager(TemplateManager):
 
     def get_project(self, template_name: str) -> dict[str, str]:
         if not self._template_path.is_file():
-            raise FileNotFoundError(
-                f"Could not find YAML file at: {self._template_path}"
-            )
+            raise TemplateFileNotFoundError(self._template_path)
         with open(self._template_path, "r", encoding="utf-8") as f:
             return yaml.safe_load(f)

instant_python/project_generator/folder_tree.py

@@ -1,17 +1,12 @@
 from pathlib import Path
 
-from instant_python.project_generator.directory import Directory
+from instant_python.errors.unknown_node_typer_error import UnknownNodeTypeError
 from instant_python.project_generator.boilerplate_file import BoilerplateFile
+from instant_python.project_generator.directory import Directory
 from instant_python.project_generator.file import File
 from instant_python.project_generator.node import Node, NodeType
 
 
-class UnknownNodeType(ValueError):
-    def __init__(self, node_type: str) -> None:
-        self._message = f"Unknown node type: {node_type}"
-        super().__init__(self._message)
-
-
 class FolderTree:
     def __init__(self, project_directory: str) -> None:
         self._project_directory = Path(project_directory)
@@ -41,4 +36,4 @@ class FolderTree:
             extension = node.get("extension", "")
             return File(name=name, extension=extension)
         else:
-            raise UnknownNodeType(node_type)
+            raise UnknownNodeTypeError(node_type)

instant_python/project_generator/jinja_custom_filters.py

@@ -1,3 +1,4 @@
+from instant_python.errors.unknown_template_error import UnknownTemplateError
 from instant_python.question_prompter.template_types import TemplateTypes
 
 
@@ -15,4 +16,4 @@ def compute_base_path(initial_path: str, template_type: str) -> str:
     elif template_type == TemplateTypes.STANDARD:
         return ".".join(path_components[2:])
     else:
-        raise ValueError(f"Unknown template type: {template_type}")
+        raise UnknownTemplateError(template_type)

instant_python/project_generator/project_generator.py

@@ -1,5 +1,6 @@
 import subprocess
 
+from instant_python.errors.command_execution_error import CommandExecutionError
 from instant_python.project_generator.folder_tree import FolderTree
 from instant_python.project_generator.jinja_template_manager import TemplateManager
 
@@ -18,13 +19,17 @@ class ProjectGenerator:
         self._format_project_files()
 
     def _format_project_files(self) -> None:
-        subprocess.run(
-            "uvx ruff format",
-            shell=True,
-            check=True,
-            cwd=self._folder_tree.project_directory,
-            stdout=subprocess.DEVNULL,
-        )
+        try:
+            subprocess.run(
+                "uvx ruff format",
+                shell=True,
+                check=True,
+                cwd=self._folder_tree.project_directory,
+                stdout=subprocess.DEVNULL,
+                stderr=subprocess.PIPE,
+            )
+        except subprocess.CalledProcessError as error:
+            raise CommandExecutionError(exit_code=error.returncode, stderr_output=error.stderr)
 
     @property
     def path(self) -> str:

{instant_python-0.4.0.dist-info → instant_python-0.5.0.dist-info}/METADATA

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: instant-python
-Version: 0.4.0
+Version: 0.5.0
 Summary: Instant boilerplate generation for Python projects
-Project-URL: documentation, https://dimanu-py.github.io/instant-python/welcome/
+Project-URL: documentation, https://dimanu-py.github.io/instant-python/
 Project-URL: repository, https://github.com/dimanu-py/instant-python/
 Author-email: dimanu-py <diegomtz126@gmail.com>
 License:                                  Apache License

{instant_python-0.4.0.dist-info → instant_python-0.5.0.dist-info}/RECORD

@@ -1,26 +1,35 @@
 instant_python/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-instant_python/cli.py,sha256=94jwSQmOI_2jjaLyz9IcPFt6cIDUO6Kzd2JssKW-TFE,327
+instant_python/cli.py,sha256=seXa5ejBGG8dtEGakXRQLwurDKoRIZzEGWTY3gMcTZ4,957
 instant_python/folder_cli.py,sha256=kEVCuhq08v8ahdUTa3sA1v5B96xoMO4U6cGEcXHrZLo,1748
+instant_python/intant_python_typer.py,sha256=y5NUkpOXagH-9nEnb-APhwMZQyRPNAZITRCNDWJKQmE,966
 instant_python/project_cli.py,sha256=aDYZZwpkMFN-J7UEKgvZQ9lXlKtr5e3ttdNzEtGslbw,3446
+instant_python/errors/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+instant_python/errors/application_error.py,sha256=A2XOPci4b0gkpr0EEqSxpo6gWpPxGm2VjJksZRX3KOY,212
+instant_python/errors/command_execution_error.py,sha256=ugsU4PQKZBdHB4zihWcCEMw0xnFkRw2JAlMjf2ZfLec,649
+instant_python/errors/error_types.py,sha256=AOcBRwJkLjE9kCGbKGebwaNzLvTbb9Vsv-bXtBEqnb0,122
+instant_python/errors/template_file_not_found_error.py,sha256=-tozNvJLxSekXe57GjyMUzwzEGjT1sSDskLBUxygmJk,534
+instant_python/errors/unknown_dependency_manager_error.py,sha256=AAY8jASB4RBABwjP_8CTUHw183uL_cEzgtJic3LOvC8,543
+instant_python/errors/unknown_node_typer_error.py,sha256=pG3wqrqUJXsSFVJzZRZZfx_ttgquVK8VfhNFdw0915U,478
+instant_python/errors/unknown_template_error.py,sha256=EfBs5HvV394o1qAah5FoJ7kkskXYWeYi63gZX4LTfdo,490
 instant_python/installer/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 instant_python/installer/dependency_manager.py,sha256=0pVTtNPGUKFvLeFjiVlegIDU7SjC1urlTSSR7pvzIkU,384
-instant_python/installer/dependency_manager_factory.py,sha256=uAwpTK9ilCkaZ50d4hePWNndpK0fOHqEClRQmViJjnY,541
-instant_python/installer/git_configurer.py,sha256=di6kGnQ4TF5GSoXh2yXM7a1jg8QoFzD_YWq5HKWzYD8,1524
-instant_python/installer/installer.py,sha256=YV0PZ2wLC4bjpalvIqk7PEpLrFr_P7GSVJ_U8rnf7Ds,565
-instant_python/installer/managers.py,sha256=HNDazLb2iNgP1xdYvPFfMmVE9Ww_v9a0_CWTPo4XN1w,101
-instant_python/installer/pdm_manager.py,sha256=z49NAurrzgByMbB560xeAMH-5a4H1jkXi9AvtAQ8G4E,2756
-instant_python/installer/uv_manager.py,sha256=iyoETYfheaTEXWncvcZqnmrfV91sq9fJtH_-8sTmBqg,2878
+instant_python/installer/dependency_manager_factory.py,sha256=_CA4j3V2HzOIeEMJUgN_fCfZo2X_H0uggfuQFCierKU,742
+instant_python/installer/git_configurer.py,sha256=TFend94t9Kx96CwXLvyeKlhHDiVTpIwUuZqv1aWsoSQ,1632
+instant_python/installer/installer.py,sha256=537Y58ZigLc1Kys83eerFWFPjoZ6YaarnJki3bTYWRg,840
+instant_python/installer/managers.py,sha256=EmFtL-WucSSZEs1Un3YFqVymlSLTHMTCqHoQRHSl_Oo,81
+instant_python/installer/pdm_manager.py,sha256=YN25zBYkTDo9opmzqK2qIJ5s44qxZGMvo06XK_Szd4U,3017
+instant_python/installer/uv_manager.py,sha256=okNedYUksLYuhtgxS9OeTiHWXBDsa5ALOXChbCM_xTs,3022
 instant_python/project_generator/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 instant_python/project_generator/boilerplate_file.py,sha256=7APVzUdgieRopJwybTkkycXRRAkr95Q3GmX5M0IrO3c,754
-instant_python/project_generator/custom_template_manager.py,sha256=ApOBNU9hdOiQeaJhbr_RMdjm3B-vVLaXyvgj6XtbkZY,628
+instant_python/project_generator/custom_template_manager.py,sha256=cRORZXhg2dx6yKARMG5qnyDgCjtQCV_jKnOdMxjNPIk,662
 instant_python/project_generator/directory.py,sha256=nJoxOd2RQUJoNkML3Dh7JqhR_xp0czasBXRE2WvW-kQ,747
 instant_python/project_generator/file.py,sha256=CV8utHrK3OBWr-HjVlSYvelcvfcCRVF0cHpd_qAm0-g,484
-instant_python/project_generator/folder_tree.py,sha256=ophcp4FuXz4QBVKvEvq6V0_bzwMHFdfnzNB2UPdSkj4,1752
-instant_python/project_generator/jinja_custom_filters.py,sha256=uXHmcTvhcVYJeG5EhTFfacIFs7Pu9F5YOPo2144LYpM,638
+instant_python/project_generator/folder_tree.py,sha256=X0mY_g8RzAjAlR1InZD1vAOzf8YE-8Hhf7KYSbF0JJE,1654
+instant_python/project_generator/jinja_custom_filters.py,sha256=3VUCfHmU0y_fT5CFiJQqTYeUAShptoSTdNArrcwxDdo,698
 instant_python/project_generator/jinja_environment.py,sha256=wEERsimWbG0XLxBNhkFN9Y2plX8SzTpOewyJRsBLSa4,595
 instant_python/project_generator/jinja_template_manager.py,sha256=rfQXnFmtK1zCxD8RJ22NL-cojCjcJSUhrOOjAT3sLb4,1472
 instant_python/project_generator/node.py,sha256=nmT09M8vPPbgDUTpykU_bPY_1w0IT9oVFoKPCfi64Yk,315
-instant_python/project_generator/project_generator.py,sha256=B6j9Pp6hz1qsn2th0Ou0hEjDTakUBXDklx4MvfXkwls,982
+instant_python/project_generator/project_generator.py,sha256=MG_eVvj3Wy9inGYkNN2PIe4jObDYvbSJqrb61G9SLAY,1294
 instant_python/project_generator/template_manager.py,sha256=LhN56T04QlRZv0DXUIl9yx3y1OFq_S9Zq8efxgNHSVI,175
 instant_python/question_prompter/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 instant_python/question_prompter/question_wizard.py,sha256=32SoH2ADQklU3WkLorn3NtztyaHACcCIfU2zEsMQKFc,512
@@ -146,8 +155,8 @@ instant_python/templates/project_structure/domain_driven_design/test.yml.j2,sha2
 instant_python/templates/project_structure/standard_project/main_structure.yml.j2,sha256=Tger29wWSQRqJ4NF8aIq5a3cb1sIm8CL5fyTAv-ZcbU,1306
 instant_python/templates/project_structure/standard_project/source.yml.j2,sha256=tqD9AsAAzPhulWmRrUW7k3F0eguhAKvNc_p5faQCfRg,1586
 instant_python/templates/project_structure/standard_project/test.yml.j2,sha256=wadDyJsuDlUecFPNu4RU2v34gOAlKFCQSL5z5U8rgdU,372
-instant_python-0.4.0.dist-info/METADATA,sha256=tiopciQ2xxGGgywmembbt_D8PLjldw60h_FCkEPpHl8,16219
-instant_python-0.4.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-instant_python-0.4.0.dist-info/entry_points.txt,sha256=EdBTj3b3N9Pa4oNzPLPivE_AnMcQIFsmRC3RsSkoLLA,47
-instant_python-0.4.0.dist-info/licenses/LICENSE,sha256=kf7wA-1IsqXkzXjlsG95sdQJtsqUON_lNXombfPlklo,11353
-instant_python-0.4.0.dist-info/RECORD,,
+instant_python-0.5.0.dist-info/METADATA,sha256=QUDokGny6-yiPPsMxqJ2Xhum8umkvI_2UdN_oDNMgX8,16211
+instant_python-0.5.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+instant_python-0.5.0.dist-info/entry_points.txt,sha256=EdBTj3b3N9Pa4oNzPLPivE_AnMcQIFsmRC3RsSkoLLA,47
+instant_python-0.5.0.dist-info/licenses/LICENSE,sha256=kf7wA-1IsqXkzXjlsG95sdQJtsqUON_lNXombfPlklo,11353
+instant_python-0.5.0.dist-info/RECORD,,