Update formatting

Author: tanwigeetika1618

src/ansible_creator/config.py

@@ -31,16 +31,13 @@ class Config:
         collection_name: The name of the collection.
         namespace: The namespace for the collection.
         resource_type: The type of resource to be scaffolded.
-        path: The file path where the resource should be added.
         type: The type of the project for which the resource is being scaffolded.
+        path: The file path where the resource should be added.
     """
 
     creator_version: str
     output: Output
     subcommand: str
-    type: str = ""
-    resource_type: str = ""
-    path: str = ""
     collection: str = ""
     force: bool = False
     overwrite: bool = False
@@ -49,6 +46,9 @@ class Config:
     project: str = ""
     collection_name: str | None = None
     namespace: str = ""
+    resource_type: str = ""
+    type: str = ""
+    path: str = ""
 
     def __post_init__(self: Config) -> None:
         """Post process config values."""

src/ansible_creator/subcommands/add.py

@@ -17,7 +17,11 @@
 
 
 class Add:
-    """Class to handle the add subcommand."""
+    """Class to handle the add subcommand.
+
+    Attributes:
+        common_resources: List of common resources to copy.
+    """
 
     common_resources = ("common.devfile",)
 
@@ -30,7 +34,6 @@ def __init__(
         Args:
             config: App configuration object.
         """
-
         self._resource_type: str = config.resource_type
         self._add_path: Path = Path(config.path)
         self._force = config.force
@@ -49,14 +52,21 @@ def run(self) -> None:
         self._scaffold()
 
     def _check_add_path(self) -> None:
-        """Validate the provided add path."""
+        """Validate the provided add path.
+
+        Raises:
+            CreatorError: If the add path does not exist.
+        """
         if not self._add_path.exists():
-            raise CreatorError(
-                f"The path {self._add_path} does not exist. Please provide an existing directory.",
-            )
+            msg = f"The path {self._add_path} does not exist. Please provide an existing directory."
+            raise CreatorError(msg)
 
     def _scaffold(self) -> None:
-        """Scaffold the specified resource file."""
+        """Scaffold the specified resource file.
+
+        Raises:
+            CreatorError: If there are conflicts and overwriting is not allowed.
+        """
         self.output.debug(f"Started copying {self._project} resource to destination")
 
         # Set up template data
@@ -93,7 +103,9 @@ def _scaffold(self) -> None:
             return
 
         if not self._overwrite:
-            question = "Some files in the destination directory may be overwritten. Do you want to proceed?"
+            question = (
+                "Files in the destination directory will be overwritten. Do you want to proceed?"
+            )
             if ask_yes_no(question):
                 copier.copy_containers(paths)
             else:

src/ansible_creator/types.py

@@ -17,6 +17,7 @@ class TemplateData:
     """Dataclass representing the template data.
 
     Attributes:
+        resource_type: The type of resource to be scaffolded.
         additions: A dictionary containing additional data to add to the gitignore.
         collection_name: The name of the collection.
         creator_version: The version of the creator.