Compare commits

..

5 Commits

Author SHA1 Message Date
6738f73db7 create class 2025-09-28 13:53:10 +02:00
e99ee7925f update logger 2025-09-28 13:52:40 +02:00
d910027bc0 update refit.py with Refit_Create() class 2025-09-28 13:51:53 +02:00
2dc233eef0 update README 2025-09-28 13:48:57 +02:00
09563a997c made some minor adjustments 2025-09-28 09:25:08 +02:00
7 changed files with 122 additions and 32 deletions

View File

@@ -12,3 +12,7 @@
2.1 apply a pattern what to move to where 2.1 apply a pattern what to move to where
3. file removal 3. file removal
3.1 remove all files like '*.tar' 3.1 remove all files like '*.tar'
## Changelog
<2025-09-28> V0.1.0 - Added the creation of multiple numbered files in a given directory with the pattern default directory_n

View File

@@ -0,0 +1,92 @@
import os
import pathlib
import sys
from .refit_logger import logger
logger.debug("Initiated refit_create.py")
# ----------------------------------------------------------------------
class Refit_Create:
"""A class to create folders and files.
It first calls the decider which lets the create_input_valid() function
check if the input argument exists. If create_input_valid() returns
'True' it continues to execute the command as per the given arguments.
default folder name: directory"""
def __init__(self, args):
"""Initiating variables for creation"""
self.args = args
self.name = args.name
self.input = args.input
self.n = args.n
def create_input_valid(self):
"""Checks if the input is valid and returns either True or
throws an error in log and terminal."""
logger.debug("in create_input_valid()")
if self.input is None:
logger.warning(f"{self.input} cannot be None")
print("Input argument missing. Use 'refit create -h' for help")
raise ValueError("Input missing")
return True
def create_n_folders(self, n, input, name):
"""Creates an set ammount of folders. Using the default directory
name if no other is provided."""
logger.debug("in create_n_folders()")
# Sets the default directory name.
if name is None:
logger.debug("name argument is 'None', applying default name")
name = "directory"
else:
logger.debug(f"{name}, Type: {type(name)}, Length: {len(name)}")
# Checks if multiple names are passed to the --name argument
# if so, only the first one gets used.
if len(name) > 1:
_NAMES_WARNING = f"{len(name)} names given, only one required.\nContinuing with '{name[0]}' as name."
logger.warning(_NAMES_WARNING)
print(_NAMES_WARNING)
name = name[0]
logger.debug(f"{name}, Type: {type(name)}")
# Creating the length of the suffix.
length_n = len(str(n))
logger.debug(f"Length of numbering string:{length_n}")
while n > 0:
# Creating the suffix string, filling the numbers to len of arg.n
i = str(n - 1)
number_string = str.zfill(i, length_n)
# Creating path for the folder
temp_name = f"{name}_{number_string}"
rfc_path = os.path.join(input, temp_name)
# Creating folder and subtracting n by one for the number_string
os.mkdir(rfc_path)
n -= 1
def rf_create_decider(self):
"""Coordination of the 'create' sub command"""
if self.create_input_valid():
logger.debug("valid input -> continue")
self.create_n_folders(self.n, self.input, self.name)
logger.debug(
"End of run---------------------------------------------------------"
)
def __call__(self):
"""Gets called when the object is treated as an function"""
self.rf_create_decider()

View File

@@ -28,5 +28,5 @@ def handle_exception(exec_type, exec_value, exec_traceback):
sys.excepthook = handle_exception sys.excepthook = handle_exception
logger.debug(f"Log path:\t{log_dir}") # logger.debug(f"Log path:\t{log_dir}")
logger.debug(f"Log file:\t{log_file}") # logger.debug(f"Log file:\t{log_file}")

View File

@@ -2,25 +2,12 @@ import argparse
import sys import sys
from modules.refit_logger import logger from modules.refit_logger import logger
from modules.refit_create import Refit_Create
# Setting Global Variables # Setting Global Variables
REFIT_VERSION = "Refit Beta 0.0.0" REFIT_VERSION = "Refit Beta 0.0.0"
# ---------------------------BEGIN FUNCTIONS---------------------------
# will be in seperate file at some point
def refit_create(args):
logger.info("Running in create mode")
logger.debug(f"Arguments: {args}")
print(f"executing on {args.input}")
# ----------------------------END FUNCTIONS----------------------------
# ---------------------------ARGPARSE START--------------------------- # ---------------------------ARGPARSE START---------------------------
# Main Parser # Main Parser
parser = argparse.ArgumentParser( parser = argparse.ArgumentParser(
prog="Refit", prog="Refit",
@@ -46,16 +33,24 @@ create_parser = subparser.add_parser(
) )
create_parser.add_argument("-n", type=int, help="number of items") create_parser.add_argument("-n", type=int, help="number of items")
create_parser.add_argument("-i", "--input", help="input file") create_parser.add_argument("-i", "--input", help="input file")
create_parser.set_defaults(func=refit_create) create_parser.add_argument(
"--name",
nargs="*",
help="the name of the folder you want to create\n Default: directory",
)
create_parser.set_defaults(command_class=Refit_Create)
args = parser.parse_args() args = parser.parse_args()
# ---------------------------ARGPARSE END----------------------------- # ---------------------------ARGPARSE END-----------------------------
# Dispatcher # Dispatcher
if hasattr(args, "func"): # determines what code gets addressed based of the users choosen flags.
if hasattr(args, "command_class"):
logger.debug("In hasattr()") logger.debug("In hasattr()")
args.func(args) Refit_Create = args.command_class
create_command_instance = Refit_Create(args)
create_command_instance()
else: else:
parser.print_help() parser.print_help()
logger.info("No input, exiting with error:1") logger.info("No input, exiting with error:1")

View File

@@ -29,12 +29,15 @@ def execute_as_subprocess(command, base_path, verbosity=False):
"""executes the string given with the '-c, --command' flag.""" """executes the string given with the '-c, --command' flag."""
logger.debug("Entered execute_as_subprocess()") logger.debug("Entered execute_as_subprocess()")
logger.debug(f"Path:\t{base_path}\nCommand:\t{command}") logger.debug(f"Path:\t{base_path}\nCommand:\t\t\t{command}")
# Decicion if the terminal output is verbose or not
if verbosity: if verbosity:
# Verbose output
logger.info("Running subprocess with terminal output.") logger.info("Running subprocess with terminal output.")
subprocess.run(command, cwd=base_path, shell=True) subprocess.run(command, cwd=base_path, shell=True)
else: else:
# Suppressed output
logger.info("Running with suppressed stdout and stderr") logger.info("Running with suppressed stdout and stderr")
subprocess.run( subprocess.run(
command, command,
@@ -43,5 +46,4 @@ def execute_as_subprocess(command, base_path, verbosity=False):
stdout=subprocess.DEVNULL, stdout=subprocess.DEVNULL,
stderr=subprocess.STDOUT, stderr=subprocess.STDOUT,
) )
logger.debug("Exited execute_as_subprocess()") logger.debug("Exited execute_as_subprocess()")

View File

@@ -13,5 +13,5 @@ logging.basicConfig(
) )
logger = logging.getLogger() logger = logging.getLogger()
logger.debug(f"Log path:\t{log_dir}") # logger.debug(f"Log path:\t{log_dir}")
logger.debug(f"Log file:\t{log_file}") # logger.debug(f"Log file:\t{log_file}")

View File

@@ -5,12 +5,13 @@ from modules.tempbox_functions import execute_as_subprocess
from modules.tempbox_logger import logger from modules.tempbox_logger import logger
tempbox_version = "Tempbox Beta b0.2.1" tempbox_version = "Tempbox Beta b0.2.1"
# Argument parsing # Argument parsing
parser = argparse.ArgumentParser( parser = argparse.ArgumentParser(
prog="tempbox", prog="tempbox",
description="This program accepts an\ description="This program accepts an\
command whicht it executes in an temporary directory in /temp.", command whicht it executes in an temporary directory in /temp.",
# epilog="helloooooooo", epilog=tempbox_version,
) )
parser.add_argument( parser.add_argument(
@@ -19,20 +20,19 @@ parser.add_argument(
action="store_true", action="store_true",
help="Activates or deactivates verbose output. (default=%(default)s)", help="Activates or deactivates verbose output. (default=%(default)s)",
) )
parser.add_argument( parser.add_argument(
"-c", "-c",
"--command", "--command",
help="Takes the string right after the flag to execute it.", help="Takes the string right after the flag to execute it.",
) )
parser.add_argument("-V", "--version", action="version", version=tempbox_version) parser.add_argument("-V", "--version", action="version", version=tempbox_version)
args = parser.parse_args() args = parser.parse_args()
# Begin of script logic
if args.command is not None: if args.command is not None:
with tempfile.TemporaryDirectory() as temp_dir: with tempfile.TemporaryDirectory() as temp_dir:
logger.debug(f"'{temp_dir}' was created") logger.info(f"'{temp_dir}' was created")
if args.command is not None: if args.command is not None:
execute_as_subprocess( execute_as_subprocess(
args.command, args.command,
@@ -41,7 +41,4 @@ if args.command is not None:
) )
else: else:
parser.print_help() parser.print_help()
logger.info("Printed Version") logger.debug("Printed Version")
# Creates a temporary directory and executes the command in it.