chore: Refactor file_item.py for improved logging and error handling

Author: httpdss

struct_module/commands/generate.py

@@ -48,11 +48,12 @@ def _create_structure(self, args):
         elif isinstance(content, str):
           file_item = FileItem({"name": name, "content": content})
 
-          file_item.apply_template_variables(template_vars)
-          file_item.process_prompt(args.dry_run)
-          file_item.create(
-            args.base_path,
-            args.dry_run or False,
-            args.backup_path or None,
-            args.file_strategy or 'overwrite'
-          )
+        file_item.apply_template_variables(template_vars)
+        file_item.process_prompt(args.dry_run)
+
+        file_item.create(
+          args.base_path,
+          args.dry_run or False,
+          args.backup or None,
+          args.file_strategy or 'overwrite'
+        )

struct_module/file_item.py

@@ -15,6 +15,7 @@
 
 class FileItem:
     def __init__(self, properties):
+        self.logger = logging.getLogger(__name__)
         self.name = properties.get("name")
         self.content = properties.get("content")
         self.remote_location = properties.get("file")
@@ -27,18 +28,18 @@ def __init__(self, properties):
         )
 
         if not openai_model:
-            logging.info("OpenAI model not found. Using default model.")
+            self.logger.info("OpenAI model not found. Using default model.")
             self.openai_model = "gpt-3.5-turbo"
         else:
-            logging.debug(f"Using OpenAI model: {openai_model}")
+            self.logger.debug(f"Using OpenAI model: {openai_model}")
             self.openai_model = openai_model
 
     def process_prompt(self, dry_run=False):
         if self.user_prompt:
-            logging.debug(f"Using user prompt: {self.user_prompt}")
+            self.logger.debug(f"Using user prompt: {self.user_prompt}")
 
             if not openai_api_key:
-                logging.warning("Skipping processing prompt as OpenAI API key is not set.")
+                self.logger.warning("Skipping processing prompt as OpenAI API key is not set.")
                 return
 
             if not self.system_prompt:
@@ -47,7 +48,7 @@ def process_prompt(self, dry_run=False):
                 system_prompt = self.system_prompt
 
             if dry_run:
-                logging.info("[DRY RUN] Would generate content using OpenAI API.")
+                self.logger.info("[DRY RUN] Would generate content using OpenAI API.")
                 self.content = "[DRY RUN] Generating content using OpenAI"
                 return
 
@@ -60,27 +61,27 @@ def process_prompt(self, dry_run=False):
             )
 
             self.content = completion.choices[0].message.content
-            logging.debug(f"Generated content: {self.content}")
+            self.logger.debug(f"Generated content: {self.content}")
 
     def fetch_content(self):
         if self.remote_location:
-            logging.debug(f"Fetching content from: {self.remote_location}")
+            self.logger.debug(f"Fetching content from: {self.remote_location}")
             response = requests.get(self.remote_location)
-            logging.debug(f"Response status code: {response.status_code}")
+            self.logger.debug(f"Response status code: {response.status_code}")
             response.raise_for_status()
             self.content = response.text
-            logging.debug(f"Fetched content: {self.content}")
+            self.logger.debug(f"Fetched content: {self.content}")
 
     def apply_template_variables(self, template_vars):
         if self.content and template_vars:
-            logging.debug(f"Applying template variables: {template_vars}")
+            self.logger.debug(f"Applying template variables: {template_vars}")
             template = Template(self.content)
             self.content = template.substitute(template_vars)
 
     def create(self, base_path, dry_run=False, backup_path=None, file_strategy='overwrite'):
         file_path = os.path.join(base_path, self.name)
         if dry_run:
-            logging.info(f"[DRY RUN] Would create file: {file_path} with content: \n\n{self.content}")
+            self.logger.info(f"[DRY RUN] Would create file: {file_path} with content: \n\n{self.content}")
             return
 
         # Create the directory if it does not exist
@@ -90,24 +91,24 @@ def create(self, base_path, dry_run=False, backup_path=None, file_strategy='over
             if file_strategy == 'backup' and backup_path:
                 backup_file_path = os.path.join(backup_path, os.path.basename(file_path))
                 shutil.copy2(file_path, backup_file_path)
-                logging.info(f"Backed up existing file: {file_path} to {backup_file_path}")
+                self.logger.info(f"Backed up existing file: {file_path} to {backup_file_path}")
             elif file_strategy == 'skip':
-                logging.info(f"Skipped existing file: {file_path}")
+                self.logger.info(f"Skipped existing file: {file_path}")
                 return
             elif file_strategy == 'append':
                 with open(file_path, 'a') as f:
                     f.write(self.content)
-                logging.info(f"Appended to existing file: {file_path}")
+                self.logger.info(f"Appended to existing file: {file_path}")
                 return
             elif file_strategy == 'rename':
                 new_name = f"{file_path}.{int(time.time())}"
                 os.rename(file_path, new_name)
-                logging.info(f"Renamed existing file: {file_path} to {new_name}")
+                self.logger.info(f"Renamed existing file: {file_path} to {new_name}")
 
         with open(file_path, 'w') as f:
             f.write(self.content)
-        logging.info(f"Created file: {file_path} with content: {self.content}")
+        self.logger.info(f"Created file: {file_path} with content: {self.content}")
 
         if self.permissions:
             os.chmod(file_path, int(self.permissions, 8))
-            logging.info(f"Set permissions {self.permissions} for file: {file_path}")
+            self.logger.info(f"Set permissions {self.permissions} for file: {file_path}")