added parameter sweeps back in

core/correctness/validation.py

@@ -1,7 +1,7 @@
 
 from inspect import signature
-from os.path import sep
-from typing import Any, _SpecialForm, Union, get_origin, get_args
+from os.path import sep, exists, isfile, isdir, dirname
+from typing import Any, _SpecialForm, Union, Tuple, get_origin, get_args
 
 from core.correctness.vars import VALID_PATH_CHARS, get_not_imp_msg
 
@@ -129,10 +129,52 @@ def valid_list(variable:list[Any], entry_type:type,
     for entry in variable:
         check_type(entry, entry_type, alt_types=alt_types)
 
-def valid_path(variable:str, allow_base=False, extension:str="", min_length=1):
+def valid_path(variable:str, allow_base:bool=False, extension:str="", 
+        min_length:int=1):
     valid_string(variable, VALID_PATH_CHARS, min_length=min_length)
     if not allow_base and variable.startswith(sep):
         raise ValueError(f"Cannot accept path '{variable}'. Must be relative.")
     if extension and not variable.endswith(extension):
         raise ValueError(f"Path '{variable}' does not have required "
             f"extension '{extension}'.")
+
+def valid_existing_file_path(variable:str, allow_base:bool=False, 
+        extension:str=""):
+    valid_path(variable, allow_base=allow_base, extension=extension)
+    if not exists(variable):
+        raise FileNotFoundError(
+            f"Requested file path '{variable}' does not exist.")
+    if not isfile(variable):
+        raise ValueError(
+            f"Requested file '{variable}' is not a file.")
+
+def valid_existing_dir_path(variable:str, allow_base:bool=False):
+    valid_path(variable, allow_base=allow_base, extension="")
+    if not exists(variable):
+        raise FileNotFoundError(
+            f"Requested dir path '{variable}' does not exist.")
+    if not isdir(variable):
+        raise ValueError(
+            f"Requested dir '{variable}' is not a directory.")
+
+def valid_non_existing_path(variable:str, allow_base:bool=False):
+    valid_path(variable, allow_base=allow_base, extension="")
+    if exists(variable):
+        raise ValueError(f"Requested path '{variable}' already exists.")
+    if dirname(variable) and not exists(dirname(variable)):
+        raise ValueError(
+            f"Route to requested path '{variable}' does not exist.")
+
+def setup_debugging(print:Any=None, logging:int=0)->Tuple[Any,int]:
+    check_type(logging, int)
+    if print is None:
+        return None, 0
+    else:
+        if not isinstance(print, object):
+            raise TypeError(f"Invalid print location provided")
+        writeable = getattr(print, "write", None)
+        if not writeable or not callable(writeable):
+            raise TypeError(f"Print object does not implement required "
+                "'write' function")
+
+    return print, logging

core/correctness/vars.py

@@ -7,6 +7,7 @@ from inspect import signature
 
 from typing import Union
 
+# validation
 CHAR_LOWERCASE = 'abcdefghijklmnopqrstuvwxyz'
 CHAR_UPPERCASE = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
 CHAR_NUMERIC = '0123456789'
@@ -26,13 +27,167 @@ VALID_TRIGGERING_PATH_CHARS = VALID_NAME_CHARS + ".*" + os.path.sep
 
 VALID_CHANNELS = Union[Connection,Queue]
 
+# hashing
+HASH_BUFFER_SIZE = 65536
+SHA256 = "sha256"
+
+# testing 
 BAREBONES_NOTEBOOK = {
     "cells": [],
     "metadata": {},
     "nbformat": 4,
     "nbformat_minor": 4
 }
+TEST_MONITOR_BASE = "test_monitor_base"
+TEST_HANDLER_BASE = "test_handler_base"
+TEST_JOB_OUTPUT = "test_job_output"
+COMPLETE_NOTEBOOK = {
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": None,
+   "metadata": {},
+   "outputs": [],
+   "source": "# The first cell\n\ns = 0\nnum = 1000"
+  },
+  {
+   "cell_type": "code",
+   "execution_count": None,
+   "metadata": {},
+   "outputs": [],
+   "source": "for i in range(num):\n    s += i"
+  },
+  {
+   "cell_type": "code",
+   "execution_count": None,
+   "metadata": {},
+   "outputs": [],
+   "source": "div_by = 4"
+  },
+  {
+   "cell_type": "code",
+   "execution_count": None,
+   "metadata": {},
+   "outputs": [],
+   "source": "result = s / div_by"
+  },
+  {
+   "cell_type": "code",
+   "execution_count": None,
+   "metadata": {},
+   "outputs": [],
+   "source": "print(result)"
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.7.3"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}
+APPENDING_NOTEBOOK = {
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": None,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Default parameters values\n",
+    "# The line to append\n",
+    "extra = 'This line comes from a default pattern'\n",
+    "# Data input file location\n",
+    "infile = 'start/alpha.txt'\n",
+    "# Output file location\n",
+    "outfile = 'first/alpha.txt'"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": None,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# load in dataset. This should be a text file\n",
+    "with open(infile) as input_file:\n",
+    "    data = input_file.read()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": None,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Append the line\n",
+    "appended = data + '\\n' + extra"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": None,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "\n",
+    "# Create output directory if it doesn't exist\n",
+    "output_dir_path = os.path.dirname(outfile)\n",
+    "\n",
+    "if output_dir_path:\n",
+    "    os.makedirs(output_dir_path, exist_ok=True)\n",
+    "\n",
+    "# Save added array as new dataset\n",
+    "with open(outfile, 'w') as output_file:\n",
+    "   output_file.write(appended)"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.10.6 (main, Nov 14 2022, 16:10:14) [GCC 11.3.0]"
+  },
+  "vscode": {
+   "interpreter": {
+    "hash": "916dbcbb3f70747c44a77c7bcd40155683ae19c65e1c03b4aa3499c5328201f1"
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}
 
+# events
 FILE_CREATE_EVENT = "file_created"
 FILE_MODIFY_EVENT = "file_modified"
 FILE_MOVED_EVENT = "file_moved"
@@ -57,9 +212,12 @@ DIR_EVENTS = [
     DIR_DELETED_EVENT
 ]
 
-PIPE_READ = 0
-PIPE_WRITE = 1
+# debug printing levels
+DEBUG_ERROR = 1
+DEBUG_WARNING = 2
+DEBUG_INFO = 3
 
+# debug message functions
 def get_drt_imp_msg(base_class):
     return f"{base_class.__name__} may not be instantiated directly. " \
         f"Implement a child class."