treescript-builder 0.1.1__py3-none-any.whl → 0.1.3__py3-none-any.whl

treescript_builder/data/data_directory.py

@@ -10,7 +10,11 @@ from treescript_builder.input.string_validation import validate_data_label
 
 class DataDirectory:
     """ Manages Access to the Data Directory.
-     - Search for a Data Label, and obtain the Path to the Data File.
+ - Search for a Data Label, and obtain the Path to the Data File.
+
+**Method Summary:**
+ - validate_build(TreeData): Path?
+ - validate_trim(TreeData): Path?
     """
 
     def __init__(self, data_dir: Path):
@@ -81,5 +85,5 @@ class DataDirectory:
         data_files = self._data_dir.glob(data_label)
         try:
             return next(data_files)
-        except StopIteration as s:
+        except StopIteration:
             return None

treescript_builder/data/path_stack.py

@@ -6,6 +6,14 @@ from pathlib import Path
 
 class PathStack:
     """ A Stack of Directory names in a Path.
+
+**Method Summary:**
+ - push(str)
+ - pop: str?
+ - join_stack: Path
+ - create_path(str): Path
+ - reduce_depth(int): bool
+ - get_depth: int
     """
 
     def __init__(self):
@@ -15,56 +23,52 @@ class PathStack:
     def push(self, directory_name: str):
         """ Push a directory to the Path Stack.
 
-        Parameters:
-        - directory_name (str): The name of the next directory in the Path Stack.
+**Parameters:**
+ - directory_name (str): The name of the next directory in the Path Stack.
         """
         self._stack.append(directory_name)
 
     def pop(self) -> str | None:
-        """
-        Pop the top of the Stack, and return the directory name.
+        """ Pop the top of the Stack, and return the directory name.
 
-        Returns:
-        str : The String removed from the top of the Stack.
+**Returns:**
+ str - The String removed from the top of the Stack.
         """
         if len(self._stack) <= 0:
             return None
         return self._stack.pop()
 
     def join_stack(self) -> Path:
-        """
-        Combines all elements in the path Stack to form the parent directory.
+        """ Combines all elements in the path Stack to form the parent directory.
 
-        Returns:
-        Path representing the current directory.
+**Returns:**
+ Path - representing the current directory.
         """
         if len(self._stack) == 0:
             return Path("./")
         return Path(f"./{'/'.join(self._stack)}/")
 
     def create_path(self, filename: str) -> Path:
-        """
-        Combines all Elements in the Stack and appends a File name.
+        """ Combines all Elements in the Stack and appends a File name.
 
-        Parameters:
-        - filename (str): The name of the file to append to the end of the path.
+**Parameters:**
+ - filename (str): The name of the file to append to the end of the path.
 
-        Returns:
-        Path : The Path to the file.
+**Returns:**
+ Path - The Path to the file.
         """
         if type(filename) is not str or len(filename) < 1:
             return self.join_stack()
         return self.join_stack() / filename
 
     def reduce_depth(self, depth: int) -> bool:
-        """
-        Reduce the Depth of the Path Stack.
+        """ Reduce the Depth of the Path Stack.
 
-        Parameters:
-        - depth (int): The depth to reduce the stack to.
+**Parameters:**
+ - depth (int): The depth to reduce the stack to.
 
-        Returns:
-        boolean : Whether the Reduction was successful, ie 0 or more Stack pops.
+**Returns:**
+ boolean - Whether the Reduction was successful, ie 0 or more Stack pops.
         """
         current_depth = self.get_depth()
         if current_depth < depth or depth < 0:
@@ -76,11 +80,10 @@ class PathStack:
         return True
 
     def get_depth(self) -> int:
-        """
-        Obtain the current Depth of the Stack.
-            The state where the current directory is the path, ie: './' has a depth of 0.
+        """ Obtain the current Depth of the Stack.
+ - The state where the current directory is the path, ie: './' has a depth of 0.
 
-        Returns:
-        int : The number of elements in the Path Stack.
+**Returns:**
+ int - The number of elements in the Path Stack.
         """
         return len(self._stack)

treescript_builder/data/tree_state.py

@@ -1,5 +1,4 @@
-"""Tree State.
-    A Key component in Tree Validation for Build operations.
+""" Tree State: A Key component in Tree Validation for Build operations.
  Author: DK96-OS 2024 - 2025
 """
 from pathlib import Path
@@ -12,6 +11,16 @@ from treescript_builder.data.tree_data import TreeData
 
 class TreeState:
     """ Manages the State of the Tree during Validation.
+
+**Method Summary:**
+ - validate_tree_data(TreeData): int
+ - get_current_depth: int
+ - get_current_path: Path
+ - add_to_queue(str)
+ - add_to_stack(str)
+ - process_queue: Path?
+ - process_stack(int): Generator[Path]
+ - reduce_depth(int): bool
     """
 
     def __init__(self):

treescript_builder/input/__init__.py

@@ -1,4 +1,4 @@
-"""The Input Module.
+""" The Input Module.
  - Validate And Format Input Arguments.
  - Read Input Tree String from File.
  Author: DK96-OS 2024 - 2025

treescript_builder/input/argument_parser.py

@@ -1,33 +1,32 @@
-"""Defines and Validates Argument Syntax.
+""" Defines and Validates Argument Syntax.
  - Encapsulates Argument Parser.
  - Returns Argument Data, the args provided by the User.
  Author: DK96-OS 2024 - 2025
 """
 from argparse import ArgumentParser
 from sys import exit
-from typing import Optional
 
 from treescript_builder.input.argument_data import ArgumentData
 from treescript_builder.input.string_validation import validate_name
 
 
-def parse_arguments(args: Optional[list[str]] = None) -> ArgumentData:
+def parse_arguments(
+    args: list[str],
+) -> ArgumentData:
     """ Parse command line arguments.
 
-    Parameters:
-     - args: A list of argument strings.
+**Parameters:**
+ - args(list): A list of argument strings.
 
-    Returns:
-    ArgumentData : Container for Valid Argument Data.
+**Returns:**
+ ArgumentData - Container for Valid Argument Data.
     """
     if args is None or len(args) == 0:
-        exit("No Arguments given. ")
-    # Initialize the Parser and Parse Immediately
-    try:
+        exit("No Arguments given.")
+    try: # Initialize the Parser and Parse Immediately
         parsed_args = _define_arguments().parse_args(args)
-    except SystemExit as e:
+    except SystemExit:
         exit("Unable to Parse Arguments.")
-    #
     return _validate_arguments(
         parsed_args.tree_file_name,
         parsed_args.data_dir,
@@ -41,16 +40,16 @@ def _validate_arguments(
     is_reverse: bool
 ) -> ArgumentData:
     """ Checks the values received from the ArgParser.
-        - Uses Validate Name method from StringValidation.
-        - Ensures that Reverse Operations have a Data Directory.
+ - Uses Validate Name method from StringValidation.
+ - Ensures that Reverse Operations have a Data Directory.
     
-    Parameters:
-     - tree_file_name (str): The file name of the tree input.
-     - data_dir_name (str): The Data Directory name.
-     - is_reverse (bool): Whether the builder operation is reversed.
+**Parameters:**
+ - tree_file_name (str): The file name of the tree input.
+ - data_dir_name (str): The Data Directory name.
+ - is_reverse (bool): Whether the builder operation is reversed.
 
-    Returns:
-    ArgumentData - A DataClass of syntactically correct arguments.
+**Returns:**
+ ArgumentData - A DataClass of syntactically correct arguments.
     """
     # Validate Tree Name Syntax
     if not validate_name(tree_file_name):
@@ -60,7 +59,6 @@ def _validate_arguments(
         pass
     elif not validate_name(data_dir_name):
         exit("The Data Directory argument was invalid.")
-    #
     return ArgumentData(
         tree_file_name,
         data_dir_name,
@@ -69,15 +67,14 @@ def _validate_arguments(
 
 
 def _define_arguments() -> ArgumentParser:
-    """
-    Initializes and Defines Argument Parser.
-       - Sets Required/Optional Arguments and Flags.
+    """ Initializes and Defines Argument Parser.
+ - Sets Required/Optional Arguments and Flags.
 
-    Returns:
-    argparse.ArgumentParser - An instance with all supported FTB Arguments.
+**Returns:**
+ argparse.ArgumentParser - An instance with all supported FTB Arguments.
     """
     parser = ArgumentParser(
-        description="File Tree Builder"
+        description="""TreeScript-Builder: The File Tree Builder and Trimmer."""
     )
     # Required argument
     parser.add_argument(

treescript_builder/input/file_validation.py

@@ -1,5 +1,5 @@
 """ File Validation Methods.
-    These Methods all raise SystemExit exceptions.
+ - These Methods all raise SystemExit exceptions.
  Author: DK96-OS 2024 - 2025
 """
 from pathlib import Path
@@ -11,14 +11,14 @@ from treescript_builder.input.string_validation import validate_name
 def validate_input_file(file_name: str) -> str | None:
     """ Read the Input File, Validate (non-blank) data, and return Input str.
 
-    Parameters:
-    - file_name (str): The Name of the Input File.
+**Parameters:**
+ - file_name (str): The Name of the Input File.
 
-    Returns:
-    str - The String Contents of the Input File.
+**Returns:**
+ str - The String Contents of the Input File.
 
-    Raises:
-    SystemExit - If the File does not exist, or is empty or blank, or read failed.
+**Raises:**
+ SystemExit - If the File does not exist, or is empty or blank, or read failed.
     """
     file_path = Path(file_name)
     if not file_path.exists():
@@ -26,7 +26,7 @@ def validate_input_file(file_name: str) -> str | None:
     try:
         if (data := file_path.read_text()) is not None and validate_name(data):
             return data
-    except IOError as e:
+    except OSError:
         exit("Failed to Read from File.")
     return None
 
@@ -34,14 +34,14 @@ def validate_input_file(file_name: str) -> str | None:
 def validate_directory(dir_path_str: str | None) -> Path | None:
     """ Ensure that if the Directory is present, it Exists.
 
-    Parameters:
-    - dir_path_str (str, optional): The String representation of the Path to the Directory.
+**Parameters:**
+- dir_path_str (str, optional): The String representation of the Path to the Directory.
 
-    Returns:
-    Path? - The , or None if given input is None.
+**Returns:**
+ Path? - The , or None if given input is None.
 
-    Raises:
-    SystemExit - If a given path does not exist.
+**Raises:**
+ SystemExit - If a given path does not exist.
     """
     if dir_path_str is None:
         return None

treescript_builder/input/input_data.py

@@ -1,4 +1,4 @@
-"""Valid Input Data Class.
+""" Valid Input Data Class.
  Author: DK96-OS 2024 - 2025
 """
 from dataclasses import dataclass
@@ -11,7 +11,7 @@ class InputData:
 
 **Fields:**
  - tree_input (str): The Tree Input to the FTB operation.
- - data_dir (Path, optional): An Optional Path to the Data Directory.
+ - data_dir (Path?): An Optional Path to the Data Directory.
  - is_reversed (bool): Whether this FTB operation is reversed.
     """
     tree_input: str

treescript_builder/input/line_reader.py

@@ -1,10 +1,10 @@
-"""Line Reader.
+""" Line Reader.
 
 The Default Input Reader.
-    Processes a single line at a time, and determines its key properties.
-    The Depth is the Integer number of directories between the current line and the root.
-    The Directory Boolean indicates whether the line represents a Directory.
-    The Name String is the name of the line.
+ - Processes a single line at a time, and determines its key properties.
+ - The Depth is the Integer number of directories between the current line and the root.
+ - The Directory Boolean indicates whether the line represents a Directory.
+ - The Name String is the name of the line.
  Author: DK96-OS 2024 - 2025
 """
 from itertools import groupby
@@ -23,8 +23,8 @@ def read_input_tree(input_tree_data: str) -> Generator[TreeData, None, None]:
 **Parameters:**
  - input_data (InputData): The Input.
 
-**Returns:**
- Generator[TreeData] - Produces TreeData from the Input Data.
+**Yields:**
+ TreeData - Produces TreeData from the Input Data.
 
 **Raises:**
  SystemExit - When any Line cannot be read successfully.
@@ -108,7 +108,7 @@ def _validate_node_name(node_name: str) -> tuple[bool, str] | None:
         if (dir_name := validate_dir_name(node_name)) is not None:
             return (True, dir_name)
         # Fall-Through to File Node
-    except ValueError as e:
+    except ValueError:
         # An error in the dir name, such that it cannot be a file either
         return None
     # Is a File

treescript_builder/input/string_validation.py

@@ -1,4 +1,4 @@
-"""String Validation Methods.
+""" String Validation Methods.
  Author: DK96-OS 2024 - 2025
 """
 from typing import Literal

treescript_builder/tree/build_validation.py

@@ -13,14 +13,12 @@ from treescript_builder.data.tree_state import TreeState
 def validate_build(
     tree_data: Generator[TreeData, None, None],
     data_dir_path: Path | None = None,
-    verbose: bool = False,
 ) -> tuple[InstructionData, ...]:
     """ Validate the Build Instructions.
 
 **Parameters:**
  - tree_data (Generator[TreeData]): The Generator that provides TreeData.
  - data_dir_path (Path?): The optional Data Directory Path. Default: None.
- - verbose (bool): Whether to print DataDirectory information during validation.
 
 **Returns:**
  tuple[InstructionData] - A generator that yields Instructions.
@@ -29,8 +27,6 @@ def validate_build(
         return tuple(iter(_validate_build_generator(tree_data)))
     else:
         data = DataDirectory(data_dir_path)
-        if verbose:
-            print(f"Validating Build With DataDir: {data_dir_path}")
         return tuple(iter(_validate_build_generator_data(tree_data, data)))
 
 

treescript_builder/tree/tree_builder.py

@@ -52,7 +52,7 @@ def _create_file(
     """
     try:
         copy2(data, path)
-    except BaseException as e:
+    except OSError:
         return False
     return True
 
@@ -72,6 +72,6 @@ def _make_dir_exist(
         return True
     try:
         path.mkdir(parents=True, exist_ok=True)
-    except IOError as e:
+    except OSError:
         return False
     return True

treescript_builder/tree/tree_trimmer.py

@@ -25,10 +25,9 @@ def _trim(instruct: InstructionData) -> bool:
     if instruct.data_path is None:
         try:
             instruct.path.unlink(missing_ok=True)
-            return True
-        except IOError as e:
-            print("IO File Error")
+        except OSError:
             return False
+        return True
     return _extract_file(instruct.path, instruct.data_path)
 
 
@@ -47,9 +46,9 @@ def _extract_file(
     """
     try:
         move(path, data)
-        return True
-    except:
+    except OSError:
         return False
+    return True
 
 
 def _remove_dir(
@@ -65,6 +64,6 @@ def _remove_dir(
     """
     try:
         path.rmdir()
-    except BaseException as e:
+    except OSError:
         return False
     return True

treescript_builder/tree/trim_validation.py

@@ -13,7 +13,6 @@ from treescript_builder.data.tree_state import TreeState
 def validate_trim(
     tree_data: Generator[TreeData, None, None],
     data_dir_path: Path | None = None,
-    verbose: bool = False,
 ) -> tuple[InstructionData, ...]:
     """ Validate the Trim Instructions.
 
@@ -29,8 +28,6 @@ def validate_trim(
         return tuple(iter(_validate_trim_generator(tree_data)))
     else:
         data = DataDirectory(data_dir_path)
-        if verbose:
-            print(f"Validating Trim With DataDir: {data_dir_path}")
         return tuple(iter(_validate_trim_generator_data(tree_data, data)))
 
 

{treescript_builder-0.1.1.dist-info → treescript_builder-0.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: treescript-builder
-Version: 0.1.1
+Version: 0.1.3
 Summary: Builds File Trees from TreeScript. If DataLabels are present in TreeScript, a DataDirectory argument is required.
 Home-page: https://github.com/DK96-OS/treescript-builder
 Author: DK96-OS

treescript_builder-0.1.3.dist-info/RECORD

@@ -0,0 +1,26 @@
+treescript_builder/__init__.py,sha256=bPuoIR3cWkK2iW_IW5By4U0d797xVpWE2z4bSVEdQRg,117
+treescript_builder/__main__.py,sha256=axPC8V6yi58rbj8GpzxI9c7tc_5MKMomrkY2EbK5W58,583
+treescript_builder/data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+treescript_builder/data/data_directory.py,sha256=IaoAGRusyT1gPaBmKRP5YMLMKvaQPa7NG7bZJnrykRI,3140
+treescript_builder/data/instruction_data.py,sha256=VqJ25-1Na0b2KamuKaVDN6qGPn-8Mm89tS1rt7_RzCY,533
+treescript_builder/data/path_stack.py,sha256=QqpbrhWH3VwVqbDGBZW_CU4WGiZ6f4T7eFHzTd5zL5I,2423
+treescript_builder/data/tree_data.py,sha256=zdICXPy48ysthu9PPAse00ZHdL-Lk1PKVhUp4pMgyQU,590
+treescript_builder/data/tree_state.py,sha256=bLTwKKPYIiLMExZzzMydZpGSAotzx3_W7wyrzWfb9PQ,4451
+treescript_builder/input/__init__.py,sha256=Ue8rD6DXZF-lu4vAoZdMjHPHL27LO3XHKxlShcBptYc,920
+treescript_builder/input/argument_data.py,sha256=PFacb8g-RXh4-RH8foW4eINms6REWpm_knaehYAICfA,806
+treescript_builder/input/argument_parser.py,sha256=SImhEs4crP9iF--5LnOVihOEPXrcEbZ_6CUXeG0mL0M,2809
+treescript_builder/input/file_validation.py,sha256=ZEdQiFOOmhIz_nDXRsdWh70cBOxfCqNkartMeAUHEEw,1494
+treescript_builder/input/input_data.py,sha256=mP8FAI26UDRwfuEFWXsJJnw77Qxv_yjkuy4NFiTZVOg,479
+treescript_builder/input/line_reader.py,sha256=_-mWwr9bfROFP34l9d787Qr7nNSqqMnzXMRKjlIwBQA,4410
+treescript_builder/input/string_validation.py,sha256=wG4ZEDI18ztg2g-zSed4rxOAFtxkqQbaLeBOP8AwBl0,3951
+treescript_builder/tree/__init__.py,sha256=3YgyrVcplTYEtFL9PuEM2k08LM8N8xsdRmNJR0rbA4s,1884
+treescript_builder/tree/build_validation.py,sha256=fQwNX_fovjvpq63HZ4NCYQxPrPYlmC_0gFK_LomF45I,4214
+treescript_builder/tree/tree_builder.py,sha256=0OiJ_Rjpm9Ux1DXvP4d6lHw9CoUCpu6lTfxTmLVOTfQ,1862
+treescript_builder/tree/tree_trimmer.py,sha256=4cYrnAPX4WQi9JW60K20KPWb9aAtkPYTZWeZ4scEjps,1581
+treescript_builder/tree/trim_validation.py,sha256=W5FCLBLurHSQYUanU8VmJeprL11OVa7-Z2pCZ39IchQ,3357
+treescript_builder-0.1.3.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+treescript_builder-0.1.3.dist-info/METADATA,sha256=A0NdpQsnMnOTksy0JRSwyOCVGL2srdWkNwuWnhw6Mic,4143
+treescript_builder-0.1.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+treescript_builder-0.1.3.dist-info/entry_points.txt,sha256=eOmYzJQPcGaH2GGBfwwU6UH_33tGtsK_ogxB4DnVrFI,111
+treescript_builder-0.1.3.dist-info/top_level.txt,sha256=parytS3LU7PXBsMVe_puiTOva14bUCzvFwcIwF_Y3Ks,19
+treescript_builder-0.1.3.dist-info/RECORD,,

{treescript_builder-0.1.1.dist-info → treescript_builder-0.1.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.7.1)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

treescript_builder-0.1.1.dist-info/RECORD

@@ -1,26 +0,0 @@
-treescript_builder/__init__.py,sha256=bPuoIR3cWkK2iW_IW5By4U0d797xVpWE2z4bSVEdQRg,117
-treescript_builder/__main__.py,sha256=axPC8V6yi58rbj8GpzxI9c7tc_5MKMomrkY2EbK5W58,583
-treescript_builder/data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-treescript_builder/data/data_directory.py,sha256=eOA__xqqjzwbmaEH_Q2MQU8y8g8tPrA8D0UepF3E6_k,3059
-treescript_builder/data/instruction_data.py,sha256=VqJ25-1Na0b2KamuKaVDN6qGPn-8Mm89tS1rt7_RzCY,533
-treescript_builder/data/path_stack.py,sha256=veMbiJMPI2yUOk5lrax2G0UwcSpAAtLW_dblROjDsrc,2420
-treescript_builder/data/tree_data.py,sha256=zdICXPy48ysthu9PPAse00ZHdL-Lk1PKVhUp4pMgyQU,590
-treescript_builder/data/tree_state.py,sha256=Fn27_Mm-lGJ3wrdd7QNWVQ4v0U8JsbB6acmuRIXnHFE,4212
-treescript_builder/input/__init__.py,sha256=kLf5lMiADoeyRpBnqDOa3DADRifocUxcupsbti1lW_U,919
-treescript_builder/input/argument_data.py,sha256=PFacb8g-RXh4-RH8foW4eINms6REWpm_knaehYAICfA,806
-treescript_builder/input/argument_parser.py,sha256=hiUwgzKFUMN2i9EcJxlMhzUZ6_oyQokvQGEE6GgoB9w,2870
-treescript_builder/input/file_validation.py,sha256=gH7J-45FSo5Ltrdyt2LOUSZ_ZdfCSXZU9H-syLr_9Tw,1519
-treescript_builder/input/input_data.py,sha256=5Jgax5LJZ9qf7Yp_qYvst8MdIkR5GgzGpG3QPKUSdWc,487
-treescript_builder/input/line_reader.py,sha256=0UdquMVLk3Ye7E6NTskxNJ6mZ6HE85nJZqoz4ByHS8c,4430
-treescript_builder/input/string_validation.py,sha256=liABqanpHSsbyGAJMBo8_OtM9vMVxZC9U7JQS1e9k-E,3950
-treescript_builder/tree/__init__.py,sha256=3YgyrVcplTYEtFL9PuEM2k08LM8N8xsdRmNJR0rbA4s,1884
-treescript_builder/tree/build_validation.py,sha256=Y2LSofp7c3XumkHIYszZEyVTL0vW3vXnfuro3NL39jk,4411
-treescript_builder/tree/tree_builder.py,sha256=2MpcPSK5ZIhix40dBSZjIdPS5t-OCCimXGmRLhIjETw,1878
-treescript_builder/tree/tree_trimmer.py,sha256=Lc5wcV9CtW6a9GYE_nMBQS-UZJ2cJ2dU03qIH5rKNoU,1632
-treescript_builder/tree/trim_validation.py,sha256=VfQLeyZkGVG363Wqu7cYhU36UcXMG0JJ8sH8R2eXDJE,3472
-treescript_builder-0.1.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-treescript_builder-0.1.1.dist-info/METADATA,sha256=0O-QG50k5xLkkrqL1j-NNhLWQrklq_7B1ZqKLGNGoXc,4143
-treescript_builder-0.1.1.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
-treescript_builder-0.1.1.dist-info/entry_points.txt,sha256=eOmYzJQPcGaH2GGBfwwU6UH_33tGtsK_ogxB4DnVrFI,111
-treescript_builder-0.1.1.dist-info/top_level.txt,sha256=parytS3LU7PXBsMVe_puiTOva14bUCzvFwcIwF_Y3Ks,19
-treescript_builder-0.1.1.dist-info/RECORD,,