Cleanup

Author: max-amb

nix_tree/__main__.py

@@ -1,17 +1,18 @@
-"""Starts the UI"""
+"""Handles user command line interaction"""
 
 import argparse
 from pathlib import Path
 
 from nix_tree.ui import start_ui
 from nix_tree.errors import ConfigurationFileNotFound
 
+
 def main():
     """Parses the arguments to the tool and passes it on to the rest of the code"""
 
     parser = argparse.ArgumentParser(prog="nix-tree",
                                      description="A tool for viewing and editing your nix configuration as a tree")
-    parser.add_argument("file_location", type=str, default="/home/max/nea/NEA/configuration.nix",
+    parser.add_argument("file_location", type=str,
                         help="The location of your nix configuration file")
     parser.add_argument("-w", "--writeover", default=False, action="store_true",
                         help="Write over the file that you are editing")

nix_tree/composer.py

@@ -1,4 +1,4 @@
-"""contains the composer which builds the file"""
+"""The composer builds the output file if the user applies their changes"""
 
 import re
 import os
@@ -9,6 +9,7 @@
 from nix_tree.tree import VariableNode, ConnectorNode, Node
 from nix_tree.parsing import Types
 
+
 @dataclass
 class ComposerIterator:
     """An iterator that composer uses to build the file"""
@@ -18,6 +19,7 @@ class ComposerIterator:
     lines: str = ""
     previous_addition: str = ""
 
+
 class Composer:
     """The class which contains the functionality to output the edited tree"""
 
@@ -68,7 +70,7 @@ def __work_out_lines_comments(self, node: Node) -> None:
         comment_for_after = ""
         if node.get_comments():
             for comment in node.get_comments():
-                if comment[1]: # Need to insert above current line
+                if comment[1]:  # Need to insert above current line
                     before_comment = self.__composer_iterator.lines.split("\n")[:-1]
                     post_comment = self.__composer_iterator.lines.split("\n")[-1]
                     before_comment_str = '\n'.join(before_comment) + "\n" + self.__composer_iterator.prepend + comment[0]

nix_tree/custom_types.py

@@ -1,4 +1,4 @@
-"""Defines two custom types for use in the ui mostly"""
+"""Defines two custom types for use in the ui"""
 
 # Need to import Tree to import _tree
 from textual.widgets import Tree, _tree

nix_tree/decomposer.py

@@ -1,4 +1,5 @@
-"""The module containing the decomposer"""
+"""The decomposer decomposes the file into tokes and passes them into the tree"""
+
 from dataclasses import dataclass
 from pathlib import Path
 import re
@@ -15,6 +16,7 @@ class Iterator:
     prepend: str = ""
     previous_prepend: str = ""
 
+
 class CommentHandling:
     """Class to handle the comments in a Nix file"""
 
@@ -116,12 +118,13 @@ def get_comments_for_attaching(self) -> dict[int, list[tuple[str, bool]]]:
 
         return self.__comments
 
+
 class Decomposer:
     """Class to handle the decomposition of the Nix file and addition of tokens to the tree"""
 
     def __init__(self, file_path: Path, tree: DecomposerTree) -> None:
         """Takes in file path and stores it for the main decomposition function
-        
+
         Args:
             file_path: Path - The file path for the Nix configuration file
             tree: DecomposerTree - The tree that decomposer should add to
@@ -224,7 +227,7 @@ def __prepare_the_file(self, file: str) -> list[str]:
         rest_of_file_split: list = file.split(" ")
         i = 0
         while True:
-            if i < len(rest_of_file_split): # Doing it like this because the length changes every time
+            if i < len(rest_of_file_split):  # Doing it like this because the length changes every time
                 rest_of_file_split, i = self.__connecting_spaced_lines(rest_of_file_split, i)
                 i += 1
             else:
@@ -268,13 +271,13 @@ def __managing_the_rest_of_the_file(self) -> None:
                 comment_list: list[tuple[str, bool]] = comments.pop(equals_locations[iterator.equals_number][2])
                 comments_attached_to_id.update({
                     self.__checking_group(groups, equals_locations[iterator.equals_number][0]) +
-                    rest_of_file_split[equals_locations[iterator.equals_number][1] - 1] :
+                    rest_of_file_split[equals_locations[iterator.equals_number][1] - 1]:
                     comment_list
                 })
             except KeyError:  # If there isn't a comment attached
                 pass
             place_to_check = 1
-            for i in range(1, len(rest_of_file_split)): # To stop empty portions like [""] being an issue and meaning something was skipped
+            for i in range(1, len(rest_of_file_split)):  # To stop empty portions like [""] being an issue and meaning something was skipped
                 if rest_of_file_split[equals_locations[iterator.equals_number][1] + i] != "":
                     place_to_check = i
                     break
@@ -350,14 +353,14 @@ def __cleaning_the_configuration(self, file: str) -> str:
         Returns:
             file: str - the file all on one line now cleaned
         """
-        file = re.sub(r"[^\S\n]+", " ", file) # The [^\S\n] is my form of .*, it just excludes new lines so comment attaching can work as expected
+        file = re.sub(r"[^\S\n]+", " ", file)  # The [^\S\n] is my form of .*, it just excludes new lines so comment attaching can work as expected
         file = re.sub("=", " = ", file)
         file = re.sub(r"[^\S\n]}", " } ", file)
         file = re.sub(r"[^\S\n]{", " { ", file)
         file = re.sub(";", " ; ", file)  # For with clauses
         file = re.sub(r"}[^\S\n]*;", "}; ", file)
         file = re.sub(r"][^\S\n]*;", "]; ", file)
-        file = re.sub(r'\[[^\S\n]*"', '[ "', file) # Looks scary because of escapes for square brackets, is simply removing and adding spaces in lists
+        file = re.sub(r'\[[^\S\n]*"', '[ "', file)  # Looks scary because of escapes for square brackets, is simply removing and adding spaces in lists
         file = re.sub(r"\[[^\S\n]*'", "[ '", file)
         file = re.sub(r"\[[^\S\n]*''", "[ ''", file)
         file = re.sub(r"(\S*)(];)", r"\1 \2", file)
@@ -478,7 +481,7 @@ def replace_normal_speech(match):
             char_count += len(line)
         return equals_locations
 
-    def __add_comments_to_nodes(self, node: Node, prepend: str, comments: dict[str, list[tuple[str,bool]]]):
+    def __add_comments_to_nodes(self, node: Node, prepend: str, comments: dict[str, list[tuple[str, bool]]]):
         """Adds the comment lists to their respective nodes
 
         Args:

nix_tree/errors.py

@@ -12,6 +12,7 @@ class NodeNotFound(Exception):
     def __init__(self, node_name: str, message: str = "Node {NODE} does not exist in the tree"):
         super().__init__(message.format(NODE=node_name))
 
+
 class NoValidHeadersNode(Exception):
     """Raised if no valid headers are found by the composer
 
@@ -21,6 +22,7 @@ class NoValidHeadersNode(Exception):
     def __init__(self, message: str = "Could not find any valid headers nodes to start outputting the tree") -> None:
         super().__init__(message)
 
+
 class ErrorComposingFileFromTree(Exception):
     """Raised if there is an error outputting/composing the tree
 
@@ -30,9 +32,11 @@ class ErrorComposingFileFromTree(Exception):
     def __init__(self, message: str = "An error was encountered composing the file from the tree") -> None:
         super().__init__(message)
 
+
 class ConfigurationFileNotFound(Exception):
     """Raised if no configuration file is found to edit/read"""
 
+
 class ErrorHandlingComments(Exception):
     """Raised if there was an error with comment management
 

nix_tree/help_screens.py

@@ -12,6 +12,8 @@
 - Enter: To modify a variable or fold an indent
 - q/Esc : To close this help dialog
 
+Note: if in a list there it looks like (xy).z,
+it means that xy is used in a with clause!
 """
 
 # The help text for the options menu
@@ -33,11 +35,12 @@
 - Tab: To switch between buttons
 - Enter: To select one of the buttons
 - q/Esc: To close this help dialog or the options dialog
-- Delete: To delete that section 
-- Add: To add a variable/section 
+- Delete: To delete that section
+- Add: To add a variable/section
 - Exit: To close the options dialog
 """
 
+
 class HelpScreen(ModalScreen):
     """The outline for a help screen in the app"""
 

nix_tree/parsing.py

@@ -1,4 +1,4 @@
-"""Stores the parsing class for options checking"""
+"""Stores the parsing class to operate upon the options.json"""
 
 import json
 from enum import Enum

nix_tree/section_screens.py

@@ -313,7 +313,7 @@ def handle_return_from_variable_addition(data: tuple[str, Types | None] | None)
                     path_as_list = work_out_full_path(self.__node.node, [])
                     if data[1]:
                         node_added = self.recursive_addition(self.__node.node, path.value.split("."), data[0], path_as_list,
-                                                         data[1])
+                                                             data[1])
                     else:
                         raise TypeError("The nodes type could not be determined")
                     if node_added:

nix_tree/stacks.py

@@ -1,8 +1,9 @@
 """Contains the stacks and queue implementations used in throughout the program
 
 Note:
-    Inheritance is useless due to all the stacks being of different data types
+    Inheritance is useless due to all the stacks being of different data types by design, to avoid confusion
 """
+
 from textual.widgets import ListItem
 
 

nix_tree/tree.py

@@ -1,4 +1,5 @@
-"""Contains the tree implementation"""
+"""Contains the tree used to store the decomposed file"""
+
 import re
 
 from nix_tree.custom_types import UIConnectorNode
@@ -36,7 +37,7 @@ class Node:
 
     def __init__(self, name: str) -> None:
         """Sets the name of the node
-        
+
         Args:
             name: str - the name to be set
         """
@@ -70,7 +71,7 @@ def get_connected_nodes(self) -> list:
         """
         return []
 
-    def set_comments(self, comments: list[tuple[str,bool]]) -> None:
+    def set_comments(self, comments: list[tuple[str, bool]]) -> None:
         """To set the comments of the current node
 
         Args:
@@ -79,7 +80,7 @@ def set_comments(self, comments: list[tuple[str,bool]]) -> None:
 
         self.__comments = comments
 
-    def get_comments(self) -> list[tuple[str,bool]]:
+    def get_comments(self) -> list[tuple[str, bool]]:
         """To get the comments of the current node
 
         Returns:
@@ -90,6 +91,7 @@ def get_comments(self) -> list[tuple[str,bool]]:
             return self.__comments
         return []
 
+
 class ConnectorNode(Node):
     """The connector node, it is a part of the path
 
@@ -142,7 +144,7 @@ def remove_child_variable_node(self, full_path: str) -> None:
         raise NodeNotFound(full_path)
 
     def remove_child_section_node(self, name: str) -> None:
-        """Given a section nodes name, this method removes the section node from 
+        """Given a section nodes name, this method removes the section node from
         the current nodes children
 
         Args:
@@ -179,7 +181,7 @@ def __init__(self, name: str, data, data_type: Types) -> None:
         self.__data = data
 
     def get_type(self) -> Types:
-        """Returns the data type of the variable 
+        """Returns the data type of the variable
 
         Returns:
             Types - the data type of the variable
@@ -236,7 +238,7 @@ def add_branch(self, contents: str) -> None:
             contents: str - the variables full path
         """
 
-        if contents.count("=") >= 2: # To account for having equals in strings
+        if contents.count("=") >= 2:  # To account for having equals in strings
             equals_splits = contents.split("=")
             string_path = equals_splits[0]
             del equals_splits[0]