Improve logging format and unify behaviour between different classes

Signed-off-by: HaHeho <[email protected]>

Author: HaHeho

pybinsim/__init__.py

@@ -8,14 +8,14 @@ def init_logging():
     console_handler = logging.StreamHandler()
 
     formatter = logging.Formatter(
-        '%(asctime)s - %(filename)s:%(lineno)d - %(levelname)s - %(message)s')
+        '%(asctime)s - %(filename)s:%(lineno)d - %(levelname)s - %(name)s - %(message)s')
     console_handler.setFormatter(formatter)
 
-    logger = logging.getLogger("pybinsim")
+    logger = logging.getLogger(__package__)
     logger.addHandler(console_handler)
 
     return logger
 
 
 logger = init_logging()
-logger.info(f"Starting pybinsim v{version('pybinsim')}")
+logger.info(f"Starting {__package__} v{version(__package__)}")

pybinsim/application.py

@@ -42,8 +42,7 @@
 
 class BinSimConfig(object):
     def __init__(self):
-
-        self.log = logging.getLogger("pybinsim.BinSimConfig")
+        self.log = logging.getLogger(f"{__package__}.{self.__class__.__name__}")
 
         # Default Configuration
         self.configurationDict = {'soundfile': '',
@@ -120,9 +119,8 @@ class BinSim(object):
     """
 
     def __init__(self, config_file):
-
-        self.log = logging.getLogger("pybinsim.BinSim")
-        self.log.info("BinSim: init")
+        self.log = logging.getLogger(f"{__package__}.{self.__class__.__name__}")
+        self.log.info("Init")
 
         self.cpu_usage_update_rate = 100
         self.time_usage = np.zeros(self.cpu_usage_update_rate-1, dtype='float32')
@@ -151,7 +149,7 @@ def __exit__(self, exc_type, exc_val, exc_tb):
         self.__cleanup()
 
     def stream_start(self):
-        self.log.info("BinSim: stream_start")
+        self.log.info("Stream start")
         try:
             self.stream = sd.OutputStream(samplerate=self.sampleRate,
                                           dtype='float32',

pybinsim/convolver.py

@@ -37,8 +37,8 @@ class ConvolverTorch(object):
     def __init__(self, ir_size: int, block_size: int, stereoInput: bool, sources: int, interpolate: bool, torch_settings: str):
         start = default_timer()
 
-        self.log = logging.getLogger("pybinsim.ConvolverTorch")
-        self.log.info("Convolver: Start Init")
+        self.log = logging.getLogger(f"{__package__}.{self.__class__.__name__}")
+        self.log.info("Start init")
 
         # Torch options
         self.torch_device = torch.device(torch_settings)
@@ -100,7 +100,7 @@ def __init__(self, ir_size: int, block_size: int, stereoInput: bool, sources: in
 
         end = default_timer()
         delta = end - start
-        self.log.info("Convolver: Finished Init (took {}s)".format(delta))
+        self.log.info(f"Finished init (took {delta}s)")
 
     def get_counter(self):
         """
@@ -169,4 +169,4 @@ def multiply_accumulate_ifft(self, filters_blocked, irfft_buffer):
             return torch.fft.irfft(self.resultFreq, out=irfft_buffer, dim=2)[:, :, self.block_size:self.block_size * 2]
 
     def close(self):
-        self.log.info("Convolver: close")
+        self.log.info("Close")

pybinsim/filterstorage.py

@@ -37,7 +37,7 @@
 class Filter(object):
 
     def __init__(self, inputfilter, irBlocks, block_size,torch_settings, filename=None):
-        self.log = logging.getLogger("pybinsim.Filter")
+        self.log = logging.getLogger(f"{__package__}.{self.__class__.__name__}")
 
         # Torch options
         self.torch_device = torch.device(torch_settings)
@@ -72,7 +72,7 @@ def getFilter(self):
 
     def getFilterTD(self):
         if self.fd_available:
-            self.log.warning("FilterStorage: No time domain filter available!")
+            self.log.warning("No time domain filter available!")
             return torch.zeros((2, self.ir_blocks, self.block_size))
         else:
             return self.IR_blocked
@@ -87,7 +87,7 @@ def storeInFDomain(self):
 
     def getFilterFD(self):
         if not self.fd_available:
-            self.log.warning("FilterStorage: No frequency domain filter available!")
+            self.log.warning("No frequency domain filter available!")
             return torch.zeros((2, self.ir_blocks, self.block_size+1), dtype=torch.complex64)
         else:
             return self.TF_blocked
@@ -106,8 +106,8 @@ class FilterStorage(object):
     #def __init__(self, irSize, block_size, filter_list_name):
     def __init__(self, block_size, filter_source, filter_list_name, filter_database, torch_settings, useHeadphoneFilter = False, headphoneFilterSize = 0, ds_filterSize = 0, early_filterSize = 0, late_filterSize = 0, sd_filterSize = 0):
 
-        self.log = logging.getLogger("pybinsim.FilterStorage")
-        self.log.info("FilterStorage: init")
+        self.log = logging.getLogger(f"{__package__}.{self.__class__.__name__}")
+        self.log.info("Init")
 
         self.ds_size = ds_filterSize
         self.block_size = block_size
@@ -387,7 +387,7 @@ def load_wav_filters(self):
 
             # check for missing filters and throw exception if not found
             if not Path(filter_path).exists():
-                self.log.warn(f'Wavefile not found: {fn_filter}')
+                self.log.warning(f'Wavefile not found: {fn_filter}')
                 raise FileNotFoundError(f'File {fn_filter} is missing.')
 
             self.log.debug(f'Loading {filter_path}')
@@ -570,4 +570,4 @@ def check_filter(self, filter_type, current_filter):
         return current_filter
 
     def close(self):
-        self.log.info('FilterStorage: close()')
+        self.log.info('Close')

pybinsim/input_buffer.py

@@ -37,8 +37,8 @@ class InputBufferMulti(object):
     def __init__(self, block_size, inputs, torch_settings):
         start = default_timer()
 
-        self.log = logging.getLogger("pybinsim.input_buffer")
-        self.log.info("Input_buffer: Start Init")
+        self.log = logging.getLogger(f"{__package__}.{self.__class__.__name__}")
+        self.log.info("Start init")
 
         # Torch Options
         self.torch_device = torch.device(torch_settings)
@@ -56,7 +56,7 @@ def __init__(self, block_size, inputs, torch_settings):
 
         end = default_timer()
         delta = end - start
-        self.log.info("Convolver: Finished Init (took {}s)".format(delta))
+        self.log.info(f"Finished init (took {delta}s)")
 
 
     def get_counter(self):
@@ -108,5 +108,5 @@ def process(self, block: torch.Tensor):
         return output
 
     def close(self):
-        self.log.info("Input_buffer: close")
+        self.log.info("Close")
 

pybinsim/osc_receiver.py

@@ -42,7 +42,7 @@ class OscReceiver(PkgReceiver):
 
     def __init__(self, current_config, soundhandler: SoundHandler):
         super().__init__(current_config, soundhandler)
-        self.log.info("oscReceiver: init")
+        self.log.info("Init")
 
         self.port1 = self.port
         self.port2 = self.port + 1
@@ -135,7 +135,7 @@ def close(self):
 
         :return: None
         """
-        self.log.info('oscReiver: close()')
+        self.log.info('Close')
         self.server.shutdown()
         self.server2.shutdown()
         self.server3.shutdown()

pybinsim/pkg_receiver.py

@@ -9,8 +9,8 @@
 
 class PkgReceiver(object):
     def __init__(self, current_config, soundhandler: SoundHandler):
-        self.log = logging.getLogger("pybinsim.PkgReceiver")
-        #self.log.info("pkgReceiver: init")
+        self.log = logging.getLogger(f"{__package__}.{self.__class__.__name__}")
+        self.log.info("Init")
 
         self.soundhandler = soundhandler
 

pybinsim/player.py

@@ -9,8 +9,6 @@
 
 from pathlib import Path
 
-logger = logging.getLogger('pybinsim.Player')
-
 PlayState = Enum('PlayState', ('PLAYING PAUSED STOPPED'))
 LoopState = Enum('LoopState', ('SINGLE LOOP'))
 
@@ -51,6 +49,9 @@ class Player(object):
     """
 
     def __init__(self, filepaths: List[Path], initial_play_state: PlayState, initial_loop_state: LoopState, block_size, fs):
+        self.log = logging.getLogger(f"{__package__}.{self.__class__.__name__}")
+        self.log.info("Init")
+
         self._filepaths: Final[List[Path]] = filepaths
         self._block_size: Final[int] = block_size
         self._fs: Final[int] = fs
@@ -88,7 +89,7 @@ def get_block(self):
                 if self._playback_queue.qsize() < PLAYBACK_QUEUE_MINIMUM_SIZE and self.filling_queue_done():
                     self._request_filling_queue()
             except Empty:
-                logger.warning('Playback queue empty')
+                self.log.warning('Playback queue empty')
                 # TODO remove allocation and benchmark
                 block = np.zeros((1, self._block_size), dtype=np.float32)
         elif self.play_state == PlayState.PAUSED:
@@ -130,7 +131,7 @@ def _fill_queue(self):
                     self._read_and_queue(self._next_file_index)
                     self._next_file_index += 1
                 except Exception as err:
-                    logger.error(err)
+                    self.log.error(err)
                     self._filepaths.pop(self._next_file_index)
 
             if (self._end_of_playlist_reached() and self.loop_state == LoopState.SINGLE) or not self._filepaths:

pybinsim/pose.py

@@ -3,8 +3,6 @@
 
 import numpy as np
 
-logger = logging.getLogger("pybinsim.Pose")
-
 
 class Orientation(namedtuple('Orientation', ['yaw', 'pitch', 'roll'])):
     pass
@@ -21,6 +19,9 @@ class Custom(namedtuple('CustomValues', ['a', 'b', 'c'])):
 class Pose:
     def __init__(self, listener_orientation, listener_position, custom=Custom(0, 0, 0,),
                  source_orientation=Orientation(0, 0, 0), source_position=Position(0, 0, 0)):
+        self.log = logging.getLogger(f"{__package__}.{self.__class__.__name__}")
+        # self.log.info("Init")
+
         self.listener_orientation = listener_orientation
         self.listener_position = listener_position
         self.source_orientation = source_orientation
@@ -69,6 +70,9 @@ def from_filterValueList(filter_value_list):
 class SourcePose:
     def __init__(self, source_orientation=Orientation(0, 0, 0),
                  source_position=Position(0, 0, 0), custom=Custom(0, 0, 0)):
+        self.log = logging.getLogger(f"{__package__}.{self.__class__.__name__}")
+        # self.log.info("Init")
+
         self.source_orientation = source_orientation
         self.source_position = source_position
         self.custom = custom

pybinsim/soundhandler.py

@@ -29,8 +29,6 @@
 
 from pybinsim.player import LoopState, PlayState, Player
 
-logger = logging.getLogger('pybinsim.SoundHandler')
-
 
 class SoundHandler(object):
     """Handles multiple players and serves their audio to pyBinSim.
@@ -57,6 +55,9 @@ class SoundHandler(object):
     """
 
     def __init__(self, block_size, n_channels, fs):
+        self.log = logging.getLogger(f"{__package__}.{self.__class__.__name__}")
+        self.log.info("Init")
+
         self._fs: Final[int] = fs
         self._n_channels: Final[int] = n_channels
         self._block_size: Final[int] = block_size