treescript-builder 0.1.5__tar.gz → 0.1.7__tar.gz

{treescript_builder-0.1.5/treescript_builder.egg-info → treescript_builder-0.1.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: treescript-builder
-Version: 0.1.5
+Version: 0.1.7
 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.5 → treescript_builder-0.1.7}/setup.py

@@ -5,7 +5,7 @@ from setuptools import find_packages, setup
 
 setup(
     name="treescript-builder",
-    version="0.1.5",
+    version="0.1.7",
     description='Builds File Trees from TreeScript. If DataLabels are present in TreeScript, a DataDirectory argument is required.',
     long_description=open('README.md').read(),
     long_description_content_type='text/markdown',

{treescript_builder-0.1.5 → treescript_builder-0.1.7}/treescript_builder/__main__.py

@@ -3,10 +3,12 @@
 
 def main():
     # Author: DK96-OS 2024 - 2025
+    from sys import argv
     from treescript_builder.input import validate_input_arguments
+    input_data = validate_input_arguments(argv[1:])
+    #
     from treescript_builder.tree import build_tree
-    from sys import argv
-    build_tree(validate_input_arguments(argv[1:]))
+    build_tree(input_data)
 
 
 if __name__ == "__main__":

treescript_builder-0.1.7/treescript_builder/data/data_directory.py

@@ -0,0 +1,90 @@
+""" Data Directory Management.
+ Author: DK96-OS 2024 - 2025
+"""
+from pathlib import Path
+from sys import exit
+
+from treescript_builder.data.tree_data import TreeData
+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.
+
+**Method Summary:**
+ - validate_build(TreeData): Path?
+ - validate_trim(TreeData): Path?
+    """
+
+    def __init__(self, data_dir: Path):
+        if not isinstance(data_dir, Path) or not data_dir.exists():
+            exit('The Data Directory must be a Path that Exists!')
+        self._data_dir: Path = data_dir
+        self._expected_trim_data: list[str] = []
+
+    def validate_build(self, node: TreeData) -> Path | None:
+        """ Determine if the Data File supporting this Tree node is available.
+
+**Parameters:**
+ - node (TreeData): The TreeData to validate.
+
+**Returns:**
+ Path? - The Path to the Data File in the Data Directory.
+
+**Raises:**
+ SystemExit - When the Data label is invalid, or the Data File does not exist.
+        """
+        if node.data_label == '': # For compatibility with 0.1.x
+            return None
+        if not validate_data_label(data_label := node.get_data_label()):
+            exit(f'Invalid Data Label on line: {node.line_number}')
+        # Search in the DataDir for this Data File.
+        if (data_path := self._search_label(data_label)) is None:
+            exit(f'Label ({node.data_label}) not found in DataDirectory on Line: {node.line_number}')
+        return data_path
+
+    def validate_trim(self, node: TreeData) -> Path | None:
+        """ Determine if the File already exists in the Data Directory.
+
+**Parameters:**
+ - node (TreeData): The TreeData to validate.
+
+**Returns:**
+ Path? - The Path to a new File in the Data Directory.
+
+**Raises:**
+ SystemExit - When the Data label is invalid, or the Data File already exists.
+        """
+        if node.data_label == '': # For compatibility with 0.1.x
+            return None
+        if not validate_data_label(data_label := node.get_data_label()):
+            exit(f'Invalid Data Label on line: {node.line_number}')
+        # Check if another TreeData Node has this DataLabel
+        if data_label in self._expected_trim_data:
+            exit(f"Duplicate DataLabels in Trim Operation on Line: {node.line_number}")
+        # Check if the Data File already exists
+        if self._search_label(data_label) is not None:
+            exit(f'Data File already exists!\n({data_label}) on Line: {node.line_number}')
+        # Add the new DataLabel to the collection
+        self._expected_trim_data.append(data_label)
+        # Return the DataLabel Path
+        return self._data_dir / data_label
+
+    def _search_label(self, data_label: str) -> Path | None:
+        """ Search for a Data Label in this Data Directory.
+
+**Parameters:**
+ - data_label (str): The Data Label to search for.
+
+**Returns:**
+ Path? - The Path to the Data File, or None.
+        """
+        # Find the Data Label File
+        data_files = self._data_dir.glob(data_label)
+        try:
+            return next(data_files)
+        except StopIteration:
+            return None
+        except OSError:
+            return None

{treescript_builder-0.1.5 → treescript_builder-0.1.7}/treescript_builder/data/path_stack.py

@@ -17,8 +17,7 @@ class PathStack:
     """
 
     def __init__(self):
-        # The Stack of Directories in the Path.
-        self._stack = []
+        self._stack: list[str] = []
 
     def push(self, directory_name: str):
         """ Push a directory to the Path Stack.
@@ -70,8 +69,7 @@ class PathStack:
 **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:
+        if depth < 0 or (current_depth := self.get_depth()) < depth:
             return False
         if current_depth == depth:
             return True

{treescript_builder-0.1.5 → treescript_builder-0.1.7}/treescript_builder/data/tree_data.py

@@ -1,4 +1,4 @@
-"""Tree Node DataClass.
+""" Tree Node DataClass.
  Author: DK96-OS 2024 - 2025
 """
 from dataclasses import dataclass
@@ -15,9 +15,18 @@ Fields:
  - name (str): The Name of the Tree Node.
  - data_label (str): The Data Label, may be empty string.
     """
-
     line_number: int
     depth: int
     is_dir: bool
     name: str
-    data_label: str = ''
+    data_label: str = ''
+    
+    def get_data_label(self) -> str:
+        """ Obtain the string DataLabel for this TreeData Node.
+ - Contains the relation between these two Fields: name, data_label.
+ - If the DataLabel is the exclamation point !, then use the name as DataLabel.
+
+**Returns:**
+ str - The DataLabel string to use for this TreeData Node. It may not have been validated.
+        """
+        return self.name if self.data_label == '!' else self.data_label

{treescript_builder-0.1.5 → treescript_builder-0.1.7}/treescript_builder/data/tree_state.py

@@ -24,9 +24,9 @@ class TreeState:
     """
 
     def __init__(self):
-        self._stack = PathStack()
-        self._queue = []
-        self._prev_line_number = 0
+        self._stack: PathStack = PathStack()
+        self._queue: list = []
+        self._prev_line_number: int = 0
 
     def validate_tree_data(self, node: TreeData) -> int:
         """ Ensure that the next TreeData is valid, relative to current state.

{treescript_builder-0.1.5 → treescript_builder-0.1.7}/treescript_builder/input/line_reader.py

@@ -7,14 +7,15 @@ The Default Input Reader.
  - The Name String is the name of the line.
  Author: DK96-OS 2024 - 2025
 """
-from itertools import groupby
+from itertools import groupby, takewhile
 from sys import exit
 from typing import Generator
 
 from treescript_builder.data.tree_data import TreeData
 from treescript_builder.input.string_validation import validate_dir_name, validate_name
 
-SPACE_CHARS = (' ', ' ', ' ', ' ')
+
+SPACE_CHARS = (' ', ' ')
 
 
 def read_input_tree(input_tree_data: str) -> Generator[TreeData, None, None]:
@@ -57,9 +58,7 @@ def _process_line(
 **Raises:**
  SystemExit - When Line cannot be read successfully.
     """
-    # Calculate the Depth
-    depth = _calculate_depth(line)
-    if depth < 0:
+    if (depth := _calculate_depth(line)) < 0:
         exit(f"Invalid Space Count in Line: {line_number}")
     # Remove Space
     args = line.strip()
@@ -78,8 +77,7 @@ def _process_line(
     else:
         exit(f"Invalid Line: {line_number}")
     # Validate the Node Name and Type.
-    node_info = _validate_node_name(name)
-    if node_info is None:
+    if (node_info := _validate_node_name(name)) is None:
         exit(f'Invalid Node on Line: {line_number}')
     (is_dir, name) = node_info
     return TreeData(
@@ -126,11 +124,10 @@ def _calculate_depth(line: str) -> int:
 **Returns:**
  int: The depth of the line in the tree structure, or -1 if space count is invalid.
     """
-    from itertools import takewhile
     space_count = len(list(
         takewhile(lambda c: c in SPACE_CHARS, line)
     ))
     # Bit Shift Shuffle Equivalence Validation (space_count is divisible by 2)
     if (depth := space_count >> 1) << 1 == space_count:
         return depth
-    return -1  # Invalid Space Count! Someone made an off-by-one whitespace mistake!
+    return -1  # Invalid Space Count! Someone made an off-by-one whitespace mistake!

{treescript_builder-0.1.5 → treescript_builder-0.1.7}/treescript_builder/tree/build_validation.py

@@ -1,4 +1,4 @@
-"""Tree Validation Methods for the Build Operation.
+""" Tree Validation Methods for the Build Operation.
  Author: DK96-OS 2024 - 2025
 """
 from pathlib import Path
@@ -23,11 +23,11 @@ def validate_build(
 **Returns:**
  tuple[InstructionData] - A generator that yields Instructions.
     """
-    if data_dir_path is None:
-        return tuple(iter(_validate_build_generator(tree_data)))
-    else:
-        data = DataDirectory(data_dir_path)
-        return tuple(iter(_validate_build_generator_data(tree_data, data)))
+    return tuple(
+        _validate_build_generator(tree_data)
+        if data_dir_path is None else
+        _validate_build_generator_data(tree_data, DataDirectory(data_dir_path))
+    )
 
 
 def _validate_build_generator(
@@ -37,7 +37,7 @@ def _validate_build_generator(
     for node in tree_data:
         # Error if any Nodes have Data Labels
         if node.data_label != '':
-            exit(f"Found Data Label on Line {node.line_number} with no Data Directory: {node.data_label}")
+            exit(f"No DataDirectory provided, but DataLabel found on Line: {node.line_number}")
         # Calculate Tree Depth Change
         if tree_state.validate_tree_data(node) == 0:
             if node.is_dir:
@@ -104,4 +104,4 @@ def _validate_build_generator_data(
                 )
     # Always Finish Build Sequence with ProcessQueue
     if (dir := tree_state.process_queue()) is not None:
-        yield InstructionData(True, dir)
+        yield InstructionData(True, dir)

{treescript_builder-0.1.5 → treescript_builder-0.1.7}/treescript_builder/tree/trim_validation.py

@@ -19,16 +19,15 @@ def validate_trim(
 **Parameters:**
  - tree_data (Generator[TreeData]): The Generator that provides TreeData.
  - data_dir_path (Path?): The optional Path to a Data Directory. Default: None.
- - verbose (bool): Whether to print DataDirectory information during validation.
 
 **Returns:**
- tuple[InstructionData] - A generator that yields Instructions.
+ tuple[InstructionData] - A tuple of InstructionData.
     """
-    if data_dir_path is None:
-        return tuple(iter(_validate_trim_generator(tree_data)))
-    else:
-        data = DataDirectory(data_dir_path)
-        return tuple(iter(_validate_trim_generator_data(tree_data, data)))
+    return tuple(
+        _validate_trim_generator(tree_data)
+        if data_dir_path is None else
+        _validate_trim_generator_data(tree_data, DataDirectory(data_dir_path))
+    )
 
 
 def _validate_trim_generator(
@@ -36,6 +35,9 @@ def _validate_trim_generator(
 ) -> Generator[InstructionData, None, None]:
     tree_state = TreeState()
     for node in tree_data:
+        # Error if any Nodes have Data Labels
+        if node.data_label != '':
+            exit(f"No DataDirectory provided, but DataLabel found on Line: {node.line_number}")
         # Calculate Tree Depth Change
         if tree_state.validate_tree_data(node) == 1:
             if node.is_dir:
@@ -48,7 +50,6 @@ def _validate_trim_generator(
             # Pop Stack to required Depth
             for i in tree_state.process_stack(node.depth):
                 yield InstructionData(True, i)
-            # Dir or File
             if node.is_dir:
                 tree_state.add_to_stack(node.name)
             else:
@@ -80,7 +81,6 @@ def _validate_trim_generator_data(
             # Pop Stack to required Depth
             for i in tree_state.process_stack(node.depth):
                 yield InstructionData(True, i)
-            # Dir or File
             if node.is_dir:
                 tree_state.add_to_stack(node.name)
             else:
@@ -91,4 +91,4 @@ def _validate_trim_generator_data(
                 )
     # Finish Trim Sequence with Pop Stack
     for i in tree_state.process_stack(0):
-        yield InstructionData(True, i)
+        yield InstructionData(True, i)

{treescript_builder-0.1.5 → treescript_builder-0.1.7/treescript_builder.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: treescript-builder
-Version: 0.1.5
+Version: 0.1.7
 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.5/treescript_builder/data/data_directory.py

@@ -1,89 +0,0 @@
-"""Data Directory Management.
- Author: DK96-OS 2024 - 2025
-"""
-from pathlib import Path
-from sys import exit
-
-from treescript_builder.data.tree_data import TreeData
-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.
-
-**Method Summary:**
- - validate_build(TreeData): Path?
- - validate_trim(TreeData): Path?
-    """
-
-    def __init__(self, data_dir: Path):
-        if not isinstance(data_dir, Path) or not data_dir.exists():
-            exit('The Data Directory must be a Path that Exists!')
-        self._data_dir = data_dir
-        # todo: Create a map of used Data Labels
-
-    def validate_build(self, node: TreeData) -> Path | None:
-        """ Determine if the Data File supporting this Tree node is available.
-
-        Parameters:
-        - node (TreeData): The TreeData to validate.
-
-        Returns:
-        Path - The Path to the Data File in the Data Directory.
-
-        Raises:
-        SystemExit - When the Data label is invalid, or the Data File does not exist.
-        """
-        if node.data_label == '' or node.is_dir:
-            return None
-        if node.data_label == '!':
-            data_path = self._search_label(node.name)
-        else:
-            data_path = self._search_label(node.data_label)
-        if data_path is None:
-            exit(f'Data Label ({node.data_label}) not found in Data Directory on line: {node.line_number}')
-        return data_path
-
-    def validate_trim(self, node: TreeData) -> Path | None:
-        """ Determine if the File already exists in the Data Directory.
-
-        Parameters:
-        - node (TreeData): The TreeData to validate.
-
-        Returns:
-        Path - The Path to a new File in the Data Directory.
-
-        Raises:
-        SystemExit - When the Data label is invalid, or the Data File already exists.
-        """
-        # Ensure that the name of the Label is valid
-        if node.data_label == '' or node.is_dir:
-            return None
-        data_label = node.name if node.data_label == '!' else node.data_label
-        if not validate_data_label(data_label):
-            exit(f'Invalid Data Label on line: {node.line_number}')
-        # Check if the Data File already exists
-        data_path = self._search_label(data_label)
-        if data_path is not None:
-            exit(f'Data File already exists!\n({data_label}) on line: {node.line_number}')
-        # Create the Data Label Path in the Directory
-        return self._data_dir / data_label
-
-    def _search_label(self, data_label: str) -> Path | None:
-        """ Search for a Data Label in this Data Directory.
-
-        Parameters:
-        - data_label (str): The Data Label to search for.
-
-        Returns:
-        Path (optional) - The Path to the Data File, or None.
-        """
-        if not validate_data_label(data_label):
-            return None
-        # Find the Data Label File
-        data_files = self._data_dir.glob(data_label)
-        try:
-            return next(data_files)
-        except StopIteration:
-            return None