barsukov 0.0.5__py3-none-any.whl → 1.0.9__py3-none-any.whl

barsukov/logger.py

@@ -1,123 +1,161 @@
-### BEGIN Dependencies ###
-import os
-from barsukov.time import time_stamp
-### END Dependencies ###
-
-class Logger:
-    """
-    ### Don't create multiple Logger objects.
-    ### Logger can be opened and closed with start() and close() methods.
-    ### Restarting the logger will log to the same file, unless self.full_file_path has been changed by hand.
-    ### start=True will start the logger automatically, but be careful
-    ### about the full_folder_path=os.getcwd() in init.
-    ### Log options are 'screen', 'file', 'both', 'no'. The logger default is 'both'.
-    ### The log='important' is for the Logger.log() method only. Try not to use it.
-    ### Default hyerarchy is logger-default overriden by object-default overriden by instance.
-    ### Instances, that log errors, will usually use 'both'.
-    ###
-    """
-    def __init__(self,
-        description=None, # Will be passed by Script. If not, write a brief description!
-        full_folder_path=os.getcwd(), # Will be passed by Script. If not, specify!
-        full_file_path=None, #  Specify only if you want to log into an already existing file.
-        log='both', # Logger default will be passed by Script. If not, you may choose to change.
-        start_file=True 
-        ):
-
-        ### Initializing all variables before setting/getting them ###
-        self.full_file_path = full_file_path # If changed by hand later, needs start() to take effect
-        self.description = description # If changed by hand later, needs set_full_file_path and start() to take effect       
-        self.log_mode = log # Default log mode can be changed by hand any time, no restart needed.
-
-        if self.full_file_path is not None:
-            self.full_folder_path = None
-        else:
-            self.full_folder_path = full_folder_path # If changed by hand later, needs set_full_file_path and start() to take effect
-            self.set_full_file_path(description=description, full_folder_path=full_folder_path)
-        
-        self.file_error = False # If a problem with file, will be set to True. Just in case for later.
-                                # If problem is remedied, you need to set file_error to False by hand.
-        
-        #
-        if start_file:
-            self.start_file()
-        else:
-            self.file = None
-        
-        self.log(f'Logger initialization complete.', log='important')
-            
-    def set_full_file_path(self, description=None, full_folder_path=None):
-        ### Checking if optional arguments are filled or if defaults are provided ###
-        if description is None:
-            description = self.description
-        if full_folder_path is None:
-            full_folder_path = self.full_folder_path
-        #
-        ### Create a file name like log_timeStamp_description_.txt ###
-        if not (description is None or description == ''):
-            description = '_' + description
-        else:
-            description = ''
-        file_name = 'log_' + time_stamp() + description + '_.txt'
-        #print(file_name)
-        #print(full_folder_path)
-        self.full_file_path = os.path.join(full_folder_path, file_name)
-
-    def start_file(self):
-        try:
-            self.file = open(self.full_file_path, 'a')
-            self.log('Logging file started.', log='important')
-        except:
-            print(f'{time_stamp()} Logger failed to open the log file \"{self.full_file_path}\".', log='important')
-
-    def close_file(self): # If closed, you'll need to restart before logging.
-        self.log('Logger is closing log file.', log='important')
-        self.file.close()
-        self.file = None
-
-    def decorated_msg(self, msg):
-        decorated_msg = time_stamp() + ' ' + msg + '\n'
-        return decorated_msg
-
-    def write_to_file(self, msg):
-        if self.file:
-            self.file.write(msg)
-            ### flushing the log file to make sure it's written ###
-            self.file.flush()
-            os.fsync(self.file)
-        else:
-            self.file_error = True
-            print(f'{time_stamp()} Logger is trying to write to a closed or non-existent file.')
-
-    def log(self, msg, log='default'):
-        ### This is the main function. Log options: 'screen', 'file', 'both', 'no', 'default', 'important'
-        if log == 'important' and self.log_mode == 'no':
-            log = 'screen'
-        elif log == 'important' and self.log_mode == 'file':
-            log = 'both'
-        elif (log == 'important') or(log == 'default') or (log is None):
-            log = self.log_mode
-
-        decorated_message = self.decorated_msg(msg)
-        
-        if log == 'both':
-            print(self.decorated_msg(msg))
-            self.write_to_file(decorated_message)
-        elif log == 'file':
-            self.write_to_file(decorated_message)
-        elif log == 'no':
-            pass
-        else: # log == 'screen' or anything else
-            print(decorated_message)
-            
-    
-    
-### Use this function in other libraries if needed for debugging -- Not really needed
-DEBUG = False
-def debug(msg):
-    if DEBUG:
-        print(msg)
-        return msg+'\n'
-    else:
-        return msg
+### BEGIN Dependencies ###
+import os
+from barsukov.time import time_stamp
+### END Dependencies ###
+
+class Logger:
+    """
+    Logger class that handles logging to both screen and file with flexible configuration
+
+    The logger is started upon initialization. 
+    It can be started with the 'start()' method and can be closed using the 'close()' method
+    It is designed to avoid creating multiple Logger instances. Restarting the logger logs to the same file unless the 'full_file_path' is manually changed
+
+    Avaliable log options:
+    - 'screen': Logs only to the screen.
+    - 'file': Logs only to a file.
+    - 'both': Logs to both the screen and file.
+    - 'no': Disables logging.
+
+    log level 'important' is used for important logs, typically for internal use with higher priority
+
+    Attributes:
+        full_file_path (str): path to the log file (e.g., 'D:/Rundong/Projects/AFM sims/2024-07-06 Autooscillations/text.txt')
+        description (str): Description of the log's purpose.
+        log_mode (str): Defines the logging mode ('screen', 'file', 'both, or 'no').
+        file (file object): Log file object.
+        file_error (bool): Flag indicating an error with the file
+    """
+    ### Don't create multiple Logger objects.
+    ### Logger can be opened and closed with start() and close() methods.
+    ### Restarting the logger will log to the same file, unless self.full_file_path has been changed by hand.
+    ### start=True will start the logger automatically, but be careful
+    ### about the full_folder_path=os.getcwd() in init.
+    ### Log options are 'screen', 'file', 'both', 'no'. The logger default is 'both'.
+    ### The log='important' is for the Logger.log() method only. Try not to use it.
+    ### Default hyerarchy is logger-default overriden by object-default overriden by instance.
+    ### Instances, that log errors, will usually use 'both'.
+
+### BEGIN: Initializing Tools
+    def __init__(self,
+        description=None, # Will be passed by Script. If not, write a brief description!
+        full_folder_path=os.getcwd(), # Will be passed by Script. If not, specify!
+        full_file_path=None, #  Specify only if you want to log into an already existing file.
+        log='both', # Logger default will be passed by Script. If not, you may choose to change.
+        start_file=True,
+        ):
+
+        ### Initializing all variables before setting/getting them
+        self.full_file_path = full_file_path # If changed by hand later, needs start() to take effect
+        self.description = description # If changed by hand later, needs set_full_file_path and start() to take effect       
+        self.log_mode = log # Default log mode can be changed by hand any time, no restart needed.
+
+        if self.full_file_path is not None: self.full_folder_path = None
+        else:
+            self.full_folder_path = full_folder_path # If changed by hand later, needs set_full_file_path and start() to take effect
+            self.set_full_file_path(description=description, full_folder_path=full_folder_path)
+
+        if start_file: self.start_file()
+        else: self.file = None
+
+        self.file_error = False 
+        # If a problem with file, will be set to True. Just in case for later.
+        # If problem is remedied, you need to set file_error to False by hand.
+
+        self.log(f'Logger initialization complete.', log='important')
+
+
+    def set_full_file_path(self, description=None, full_folder_path=None):
+        ### Checking if optional arguments are filled or if defaults are provided ###
+        if description is None:
+            description = self.description
+        if full_folder_path is None:
+            full_folder_path = self.full_folder_path
+
+        ### Create a file name like log_timeStamp_description_.txt ###
+        if not (description is None or description == ''):
+            description = f"_{description}"
+        else:
+            description = ''
+        file_name = f"log_{time_stamp()}{description}_.txt"
+        self.full_file_path = os.path.join(full_folder_path, file_name)
+
+
+    def start_file(self):
+        try:
+            self.file = open(self.full_file_path, 'a')
+            self.log('Logging file started.', log='important')
+        except:
+            print(f'{time_stamp()} Logger failed to open the log file \"{self.full_file_path}\".', log='important')
+
+
+    def close_file(self): # If closed, you'll need to restart before logging.
+        self.log('Logger is closing log file.', log='important')
+        self.file.close()
+        self.file = None
+### END: Initializing Tools
+
+
+### BEGIN: logging Tools
+    def decorated_msg(self, msg):
+        decorated_msg = time_stamp() + ' ' + msg + '\n'
+        return decorated_msg
+
+
+    def write_to_file(self, msg):
+        if self.file:
+            self.file.write(msg)
+            ### flushing the log file to make sure it's written ###
+            self.file.flush()
+            os.fsync(self.file)
+        else:
+            self.file_error = True
+            print(f'{time_stamp()} Logger is trying to write to a closed or non-existent file.')
+
+
+    def log(self, msg, log='default'):
+        ### This is the main function. Log options: 'screen', 'file', 'both', 'no', 'default', 'important'
+        if log == 'important' and self.log_mode == 'no':
+            log = 'screen'
+        elif log == 'important' and self.log_mode == 'file':
+            log = 'both'
+        elif (log == 'important') or(log == 'default') or (log is None):
+            log = self.log_mode
+
+        decorated_message = self.decorated_msg(msg)
+
+        if log == 'both':
+            print(self.decorated_msg(msg))
+            self.write_to_file(decorated_message)
+        elif log == 'file':
+            self.write_to_file(decorated_message)
+        elif log == 'no':
+            pass
+        else: # log == 'screen' or anything else
+            print(decorated_message)
+### END: logging Tools
+
+
+### BEGIN: OBJ2FILE TOOLS:
+    def __getargs__(self):
+        logger_args = self.__getstate__()
+        del logger_args['log_mode']
+        del logger_args['file_error']
+        del logger_args['file']
+        return logger_args
+
+    def __getstate__(self):
+        seriable_data = self.__dict__.copy()
+        return seriable_data
+### BEGIN: OBJ2FILE TOOLS:
+
+
+### Use this function in other libraries if needed for debugging -- Not really needed
+DEBUG = False
+def debug(msg):
+    if DEBUG:
+        print(msg)
+        return msg+'\n'
+    else:
+        return msg
 ###

barsukov/obj2file.py

@@ -1,107 +1,93 @@
-# This is unfinished
-
-
-#import pickle
-import os
-#import glob
-
-import obj_name, time_stamp
-
-class Obj2File:
-    def __init__(self, logger=None, log='default', script=None):
-        self.script = script
-        self.logger = logger
-        self.default_log = log
-        self.msg_deco = f'[Obj2File]'
-
-        if self.logger is None:
-            try: self.logger = self.script.logger
-            except: pass
-
-        self.mtj_calib_directory = '/Users/alexandrakorotneva/Desktop/2024-11-18 obj import test'
-        self.tosave = {}
-
-
-    def log(self, msg, log=None):
-        if log is None: log = self.default_log
-        if self.logger is not None:
-            try:
-                self.logger.log(f'{self.msg_deco} {msg}', log=log)
-                return
-            except: pass
-        print(f'{time_stamp()} {self.msg_deco} {msg}')
-        
-    def save(self, obj, directory=None, full_file=None, short_file=None, log='default'):
-        if full_file is None:
-            if directory is None: directory = self.script.full_folder_path #current measurement folder
-            if short_file is None: short_file = f'{time_stamp()}_{obj_name(obj)}.pkl'
-            full_file = os.path.join(directory, short_file)
-        try:
-            with open(full_file, 'wb') as file:
-                pickle.dump(obj, file)
-                self.log(f'Object {obj_name(obj)} is written to file {full_file}.', log=log)
-        except:
-            self.log('Error: could not write object to file.', log='important')
-
-    def load(self, directory=None, full_file=None, short_file=None, log='default'):
-        if full_file is None:
-            if directory is None:
-                directory = self.script.full_folder_path
-            if short_file is None:
-                files = [f for f in glob.glob(os.path.join(directory, '*.pkl'))]
-                short_file = files[0]
-            full_file = os.path.join(directory, short_file)
-            
-        try:
-            with open(filepath, 'rb') as file:
-                toload = pickle.load(file)
-                self.log(f'Object is uploaded from file {full_file}.', log=log)
-        except:
-            self.log('Error: could not upload object from file.', log='important')        
-        return toload
-
- 
-    
-
-    def mtj_fieldcalib(self, directory=None, upd=False, log='default', spl_ind=None):
-        if directory is None: directory = self.mtj_calib_directory
-        else:
-            if upd: 
-                self.mtj_calib_directory = directory
-                self.log(f'MTJ station field calibration directory has been updated to {directory}', log='important')
-
-        files = [f for f in glob.glob(os.path.join(directory, '*.pkl'))]
-        if len(files)==1:
-            short_file = files[0]
-        else:
-            ##
-
-        full_file = os.path.join(directory, short_file)
-        splines = self.load(full_file=full_file, log=log)
-
-        if spl_ind is None:
-            return: splines
-        elif spl_ind=='c':
-            return: splines['cheap_to_H']
-        elif spl_ind=='v':
-            return: Vsplines['V_to_H']
-        elif spl_ind=='h':
-            return: splines['H_to_V']
-
-    def pack_tosave(self, obj, obj_name=None, overwrite=False, save=False):
-        #prepares a dictionary {'obj name':obj, ...}
-        tosave = self.tosave
-        if obj_name is None: obj_name = obj_name(obj)
-                
-        if overwrite:
-            tosave.update({obj_name : obj})
-        else: 
-            add = tosave.setdefault(obj_name, obj) #for already excisting name returns corresponding element and doesn't overwrite
-            if add!=obj:
-                print(f'Overwriting attempt!')
-       
-        self.tosave = tosave
-        if save:
-            self.save(tosave)
-        return tosave
-
+### BEGIN Dependencies ###
+import dill
+import os
+from barsukov.logger import debug
+### END Dependencies ###
+
+
+def save_object(obj, file_name, update=False, full_folder_path=None, script=None):
+    """
+    Saves a class object to a file using the '.pickle' format.
+
+    Args:
+        obj (object): An instance of a class to be saved. (Required)
+        file_name (str): Name of the file (must end with '.pickle'). (required)
+        update (bool, optional): if 'True', overwrites an existing file. Defaults to 'False'.
+        full_folder_path (str, optional): absolute path to the directory (e.g., "C://Users//John//Documents").
+            Defaults to the current working directory if not provided.
+        script (Script, optional): Script object providing directory information. 
+            Defaults to 'None'.
+
+    Returns:
+        str: Confirmation message upon successful save.
+
+    Raises:
+        FileExistsError: If the file already exists and 'update=False'.
+
+    Example:
+        >>> equipment = mwHP(...)
+        >>> save_object(obj=equipment, file_name="mwHP.pickle")
+        'equipment successfully saved in mwHP.pickle.'
+    """
+    # Check if full_folder_path is provided and is an absolute path:
+    if full_folder_path and not os.path.isabs(full_folder_path):
+        return debug(f"Please provide an absolute path (e.g., 'C://Users//John//Documents').")
+
+    #Set folder_path based on the provided or default to current directory
+    full_folder_path = full_folder_path or (script.full_folder_path if script else os.getcwd())
+    full_file_path = os.path.join(full_folder_path, file_name)
+
+    if update:
+        # If update is True, overwrite the file
+        with open(full_file_path, 'wb') as file:
+            dill.dump(obj, file)
+            return debug(f"{obj} object successfully saved.")
+    else:
+        try:
+            # Try to create the file and save the object
+            with open(full_file_path, 'xb') as file:
+                dill.dump(obj, file)
+                return debug(f"{obj} successfully saved in {file_name}.")
+        except FileExistsError:
+            # If the file already exists, provide a message
+            raise FileExistsError(f"File '{file_name}' already exists. Use 'update=True' to overwrite.")
+
+
+def load_object(file_name, full_folder_path=None, script=None):
+    """
+    Loads a class object stored in a '.pickle' formatted file.
+
+    Args:
+        file_name (str): Class object file (must end in '.pickle'). (Required)
+        full_folder_path (str, optional): absolute path to the directory where file exists (excluding the file name).
+            Defaults to the current working directory.
+        script (Script, optional): Script object providing directory information. 
+            Defaults to 'None'.
+
+    Returns:
+        object: The loaded class object.
+
+    Raises:
+        FileNotFoundError: If the file doesn't exist in the specified location.
+
+    Example:
+        >>> new_equipment = load_object(file_name="mw.pickle")
+        'Object successfully loaded from mw.pickle.'
+    """
+    # Check if the provided full_folder_path is absolute
+    if full_folder_path and not os.path.isabs(full_folder_path):
+        return debug(f"Please provide an absolute path (e.g., 'C://Users//John//Documents').")
+
+    # Set full_folder_path based on provided or default to current directory
+    full_folder_path = full_folder_path or (script.full_folder_path if script else os.getcwd())
+    full_file_path = os.path.join(full_folder_path, file_name)
+
+    # Check if the file exists at the specified path
+    if not os.path.isabs(full_file_path):
+        raise FileNotFoundError(f"The object file {file_name} does not exist at the specified directory.")
+
+    # load the object from the file
+    with open(full_file_path, 'rb') as file:
+        instance = dill.load(file)
+        print(debug(f'Object successfully loaded from {file_name}.'))
+    return instance