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

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

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

@@ -5,7 +5,7 @@ from setuptools import find_packages, setup
 
 setup(
     name="treescript-builder",
-    version="0.1.7",
+    version="0.1.8",
     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.7 → treescript_builder-0.1.8}/treescript_builder/data/path_stack.py

@@ -11,7 +11,6 @@ class PathStack:
  - push(str)
  - pop: str?
  - join_stack: Path
- - create_path(str): Path
  - reduce_depth(int): bool
  - get_depth: int
     """
@@ -47,19 +46,6 @@ class PathStack:
             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.
-
-**Parameters:**
- - filename (str): The name of the file to append to the end of the path.
-
-**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.
 
@@ -84,4 +70,4 @@ class PathStack:
 **Returns:**
  int - The number of elements in the Path Stack.
         """
-        return len(self._stack)
+        return len(self._stack)

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

@@ -102,18 +102,19 @@ class TreeState:
 
     def process_stack(self, depth: int) -> Generator[Path, None, None]:
         """ Pop the Stack to the Desired Depth.
+        - Combines all Elements in the Stack into a Directory Path.
 
-        Parameters:
+        **Parameters:**
          - depth (int): The depth to process the stack to.
 
-        Returns:
-         Generator[Path] - Provides a Path for each entry in the Stack.
+        **Yields:**
+         Path - A Path for every Directory in the Stack, from top to bottom.
         """
         if depth < 0:
-            exit('Invalid Depth')
+            raise ValueError('Negative Depth.')
         while depth < self._stack.get_depth():
             if (entry := self._stack.pop()) is not None:
-                yield self._stack.create_path(entry)
+                yield self._stack.join_stack() / entry
 
     def reduce_depth(self, depth: int) -> bool:
         """ Pop an element from the stack.
@@ -135,7 +136,6 @@ class TreeState:
         Raises:
          SystemExit - When the Line Number does not increase.
         """
-        if self._prev_line_number < line_number:
-            self._prev_line_number = line_number
-        else:
-            exit("Invalid Tree Data Sequence")
+        if self._prev_line_number >= line_number:
+            exit("Invalid Tree Data Sequence")
+        self._prev_line_number = line_number

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

@@ -1,10 +1,12 @@
-""" Line Reader.
+""" Line Reader Module for Processing TreeScript.
 
 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.
+ - DataLabel is the first word after the Name, and it has a strict set of validation criteria.
+ - Comments are filtered out by starting a line with the # character. A comment after a file name is also filtered.
  Author: DK96-OS 2024 - 2025
 """
 from itertools import groupby, takewhile
@@ -12,13 +14,22 @@ 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
+from treescript_builder.input.string_validation import validate_dir_name, validate_name, validate_data_label
 
 
 SPACE_CHARS = (' ', ' ')
 
 
-def read_input_tree(input_tree_data: str) -> Generator[TreeData, None, None]:
+_INVALID_DEPTH_ERROR_MSG = "Invalid Depth (Number of Spaces) in Line: "
+
+_INVALID_NODE_NAME_ERROR_MSG = "Invalid Name in Line: "
+_INVALID_DATALABEL_ERROR_MSG = "Invalid DataLabel in Line: "
+_MISSING_DATADIR_ERROR_MSG = "Missing DataDirectory for DataLabel in Line: "
+
+
+def read_input_tree(
+    input_tree_data: str,
+) -> Generator[TreeData, None, None]:
     """ Generate structured Tree Data from the Input Data String.
 
 **Parameters:**
@@ -51,44 +62,59 @@ def _process_line(
 **Parameters:**
  - line_number (int): The line-number in the input tree structure, starting from 1.
  - line (str): A line from the input tree structure.
+ - is_data_label_enabled (bool): Whether DataLabels are enabled. If the DataDirectory argument is not provided, DataLabels are disabled.
 
 **Returns:**
- tuple: (int, bool, str, str) where int is the depth, bool is true when is Directory, and str is name, followed by str data.
+ TreeData - A Tree Node Data object.
 
 **Raises:**
  SystemExit - When Line cannot be read successfully.
     """
+    # Depth Depends on Leading Spaces
     if (depth := _calculate_depth(line)) < 0:
-        exit(f"Invalid Space Count in Line: {line_number}")
-    # Remove Space
+        exit(_INVALID_DEPTH_ERROR_MSG + str(line_number))
+    # Now remove Leading Spaces (and trailing)
     args = line.strip()
-    # Try to split line into multiple arguments
+    # Try to split line into multiple arguments, on one of the SpaceChars.
     for space_char in SPACE_CHARS:
         if space_char in args:
             args = args.split(space_char)
             break
     # Check whether line was split or not
     if isinstance(args, str):
-        name = args
-        data_label = ""
+        name = args  # Was Not Split
+        data_label = ''
     elif isinstance(args, list) and len(args) >= 2:
-        name = args[0]
-        data_label = args[1]
+        name = args[0]  # First Word is the Tree Node Name.
+        # Second Word is the DataLabel.
+        data_label = _validate_data_label_argument(line_number, args[1])
+        # Additional Words are ignored. Comments after the DataLabel are possible, for now. 
+        # Alternate LineReader Modules are likely to expand in this area:
     else:
         exit(f"Invalid Line: {line_number}")
-    # Validate the Node Name and Type.
+    # Validate the Node Name and Type (is_dir). The tuple is bool first, then node name.
     if (node_info := _validate_node_name(name)) is None:
-        exit(f'Invalid Node on Line: {line_number}')
-    (is_dir, name) = node_info
+        exit(_INVALID_NODE_NAME_ERROR_MSG + str(line_number))
     return TreeData(
-        line_number,
-        depth,
-        is_dir,
-        name,
-        data_label
+        line_number=line_number,
+        depth=depth,
+        is_dir=node_info[0],
+        name=node_info[1],
+        data_label=data_label,
     )
 
 
+def _validate_data_label_argument(
+    line_number: int,
+    argument: str,
+) -> str:
+    if argument.startswith('#'):  # Comment should be ignored.
+        return ''
+    elif not validate_data_label(argument):
+        exit(_INVALID_DATALABEL_ERROR_MSG + str(line_number))
+    return argument
+
+
 def _validate_node_name(node_name: str) -> tuple[bool, str] | None:
     """ Determine whether this Tree Node is a Directory, and validate the name.
 
@@ -96,7 +122,7 @@ def _validate_node_name(node_name: str) -> tuple[bool, str] | None:
  - node_name (str): The argument received for the node name.
 
 **Returns:**
- tuple[bool, str] - Node information, first whether it is a directory, then the valid name of the node.
+ tuple[bool, str]? - Node information, first whether it is a directory, then the valid name of the node.
     
 **Raises:**
  SystemExit - When the directory name is invalid.
@@ -104,14 +130,14 @@ def _validate_node_name(node_name: str) -> tuple[bool, str] | None:
     try:
         # Check if the line contains any slash characters
         if (dir_name := validate_dir_name(node_name)) is not None:
-            return (True, dir_name)
+            return True, dir_name
         # Fall-Through to File Node
     except ValueError:
         # An error in the dir name, such that it cannot be a file either
         return None
     # Is a File
     if validate_name(node_name):
-        return (False, node_name)
+        return False, node_name
     return None
 
 
@@ -122,7 +148,7 @@ def _calculate_depth(line: str) -> int:
  - line (str): A line from the tree command output.
 
 **Returns:**
- int: The depth of the line in the tree structure, or -1 if space count is invalid.
+ int - The depth of the line in the tree structure, or -1 if space count is invalid.
     """
     space_count = len(list(
         takewhile(lambda c: c in SPACE_CHARS, line)

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: treescript-builder
-Version: 0.1.7
+Version: 0.1.8
 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