barsukov 0.0.4__py3-none-any.whl → 1.0.8__py3-none-any.whl

barsukov/logger.py

@@ -1,123 +1,127 @@
-### 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:
+    """
+    ### 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 to_dict(self):
+        seriable_data = self.__dict__.copy()
+        return seriable_data
+            
+    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
 ###

barsukov/obj2file.py

@@ -1,107 +1,105 @@
-# 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
-
+# 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]
+
+        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
+

barsukov/script.py

@@ -1,82 +1,96 @@
-from barsukov.time import *
-from barsukov.logger import Logger
-
-import sys
-import os
-
-class Script():
-    def __init__(self,
-        ### Please ALWAYS specify the following:
-        operator='Anon', # ib, Rundong, Sasha, Ameerah, Alex, or AlexH if ambiguous  
-        station='No Stn', # qd, ppms, mseppms, data, orange, ...
-        sample='No Sample', # Use sample name from the sample table, e.g. "cro2410a1" or "yig2207"
-        description='No Description', # Briefly: what are you doing. Sets the folder name.
-        # i.e. 'Testing modulation' or 'fH OOP long average'
-        project_folder = os.getcwd(), # Full path to your project folder. Please follow this convention:
-        # D:/Rundong/Projects/AFM sims/2024-07-06 Autooscillations
-        # Will grab the current directory if not specified.
-
-        ### Optional:
-        log='both', # This is the default log setting which will be passed to the logger.
-            ### It will be overriden by other objects,
-            ### which in turn will be overriden by methods.
-            ### Choose here and everywhere from screen, file, both, no.
-
-        ### Usually, it's better not to change these:
-        log_full_folder_path=None,
-        log_full_file_path=None 
-        ):
-        
-        self.operator = operator
-        self.station = station
-        self.sample = sample
-        self.description = description
-        self.project_folder = project_folder
-
-        self.rm = None
-        
-        ### Creating the sub-project folder
-        self.folder_name = date() + '_' + self.station + '_' + self.operator + '_' + self.sample + '_' + self.description
-        self.full_folder_path = os.path.join(self.project_folder, self.folder_name)
-        os.makedirs(self.full_folder_path, exist_ok=True)
-
-        ### Starting the logger
-        if log_full_folder_path is None:
-            self.logger = Logger(
-                description=self.operator + '_' + self.description,
-                full_file_path=log_full_file_path,
-                log=log, # Script.log becomes Logger's default
-                start_file=True)
-        else:
-            self.logger = Logger(
-                description=self.operator + '_' + self.description,
-                full_folder_path=log_full_folder_path,
-                full_file_path=log_full_file_path,
-                log=log, # Script.log becomes Logger's default
-                start_file=True) 
-        
-        self.logger.log(f'Script object initialized. Logger started.', log='both')
-        
-    def log(self, msg, log='default'): # default means the default of the logger
-        self.logger.log(msg, log=log)
-    
-
-### BEGIN: Equipment related stuff
-
-    def init_rm(self):
-    # Imports pyvisa as method library #
-        import pyvisa as visa # ----------------XXX Can this be done like this??????????????
-        try: 
-            self.rm = visa.ResourceManager()
-        except:
-            self.rm = None
-            self.log('Script could not import pyvisa.', log='important')
-            sys.exit()
-        self.log(f'Script started pyvisa.ResourceManager.', log='both')
-        return self.rm
-
-### BEGIN Equipment devices
-    
-    def mwHP(self, **kwargs):
-        from barsukov.src.exp.mwHP import mwHP as eq
-        return eq(**kwargs, script=self, logger=self.logger)
+from barsukov.time import *
+from barsukov.logger import Logger
+
+import sys
+import os
+
+class Script():
+    def __init__(self,
+        ### Please ALWAYS specify the following:
+        operator='Anon', # ib, Rundong, Sasha, Ameerah, Alex, or AlexH if ambiguous  
+        station='No Stn', # qd, ppms, mseppms, data, orange, ...
+        sample='No Sample', # Use sample name from the sample table, e.g. "cro2410a1" or "yig2207"
+        description='No Description', # Briefly: what are you doing. Sets the folder name.
+        # i.e. 'Testing modulation' or 'fH OOP long average'
+        project_folder = os.getcwd(), # Full path to your project folder. Please follow this convention:
+        # D:/Rundong/Projects/AFM sims/2024-07-06 Autooscillations
+        # Will grab the current directory if not specified.
+
+        ### Optional:
+        log='both', # This is the default log setting which will be passed to the logger.
+            ### It will be overriden by other objects,
+            ### which in turn will be overriden by methods.
+            ### Choose here and everywhere from screen, file, both, no.
+
+        ### Usually, it's better not to change these:
+        log_full_folder_path=None,
+        log_full_file_path=None,
+        **kwargs
+        ):
+        
+        self.operator = operator
+        self.station = station
+        self.sample = sample
+        self.description = description
+        self.project_folder = project_folder
+
+        self.rm = None
+        
+        ### Creating the sub-project folder
+        self.folder_name = date() + '_' + self.station + '_' + self.operator + '_' + self.sample + '_' + self.description
+        self.full_folder_path = os.path.join(self.project_folder, self.folder_name)
+        os.makedirs(self.full_folder_path, exist_ok=True)
+
+        ### Starting the logger
+        if log_full_folder_path is None:
+            self.logger = Logger(
+                description=self.operator + '_' + self.description,
+                full_file_path=log_full_file_path,
+                log=log, # Script.log becomes Logger's default
+                start_file=True)
+        else:
+            self.logger = Logger(
+                description=self.operator + '_' + self.description,
+                full_folder_path=log_full_folder_path,
+                full_file_path=log_full_file_path,
+                log=log, # Script.log becomes Logger's default
+                start_file=True) 
+        
+        self.logger.log(f'Script object initialized. Logger started.', log='both')
+    
+    def to_dict(self):
+        seriable_data = self.__dict__.copy()
+        # take the attributes of unseriable data
+        del seriable_data['logger']
+        del seriable_data['rm']
+        del 
+        seriable_data['logger_information'] = self.logger.to_dict()
+        return seriable_data
+    
+    def __setstate__(self, seriable_data):
+        self.__dict__.update(seriable_data)
+        self.logger = Logger(**state['logger_information'])
+        
+    def log(self, msg, log='default'): # default means the default of the logger
+        self.logger.log(msg, log=log)
+    
+
+### BEGIN: Equipment related stuff
+
+    def init_rm(self):
+    # Imports pyvisa as method library #
+        import pyvisa as visa # ----------------XXX Can this be done like this??????????????
+        try: 
+            self.rm = visa.ResourceManager()
+        except:
+            self.rm = None
+            self.log('Script could not import pyvisa.', log='important')
+            sys.exit()
+        self.log(f'Script started pyvisa.ResourceManager.', log='both')
+        return self.rm
+
+### BEGIN Equipment devices
+    
+    def mwHP(self, **kwargs):
+        from barsukov.exp.mwHP import mwHP as eq
+        return eq(**kwargs, script=self, logger=self.logger)