Redefine logging levels to minimize noise and improve usability

Baekalfen · Baekalfen · Sep 15, 2022 · Sep 15, 2022 · May 21, 2025 · May 20, 2025
commit d3f7b6537aded7ed2933b5c236d8d020f962e639
diff --git a/pyboy/core/cartridge/cartridge.py b/pyboy/core/cartridge/cartridge.py
@@ -53,7 +53,7 @@ def load_romfile(filename):
 
     logger.debug("Loading ROM file: %d bytes", len(romdata))
     if len(romdata) == 0:
-        logger.error("ROM file is empty!")
+        logger.critical("ROM file is empty!")
         raise PyBoyException("Empty ROM file")
 
     banksize = 16 * 1024

diff --git a/pyboy/core/cartridge/mbc1.py b/pyboy/core/cartridge/mbc1.py
@@ -47,7 +47,7 @@ def setitem(self, address, value):
     def getitem(self, address):
         if 0xA000 <= address < 0xC000:
             if not self.rambank_initialized:
-                logger.error("RAM banks not initialized: %0.4x", address)
+                logger.warning("RAM banks not initialized: %0.4x", address)
 
             if not self.rambank_enabled:
                 return 0xFF

diff --git a/pyboy/core/cartridge/mbc2.py b/pyboy/core/cartridge/mbc2.py
@@ -34,7 +34,7 @@ def getitem(self, address):
             return self.rombanks[self.rombank_selected, address - 0x4000]
         elif 0xA000 <= address < 0xC000:
             if not self.rambank_initialized:
-                logger.error("RAM banks not initialized: %0.4x", address)
+                logger.warning("RAM banks not initialized: %0.4x", address)
 
             if not self.rambank_enabled:
                 return 0xFF

diff --git a/pyboy/core/cartridge/rtc.py b/pyboy/core/cartridge/rtc.py
@@ -22,7 +22,7 @@ def __init__(self, filename):
         self.halt = 0
 
         if not os.path.exists(self.filename):
-            logger.info("No RTC file found. Skipping.")
+            logger.debug("No RTC file found. Skipping.")
         else:
             with open(self.filename, "rb") as f:
                 self.load_state(IntIOWrapper(f), STATE_VERSION)

diff --git a/pyboy/core/mb.py b/pyboy/core/mb.py
@@ -37,7 +37,7 @@ def __init__(
         serial_interrupt_based=False,
     ):
         if bootrom_file is not None:
-            logger.info("Boot-ROM file provided")
+            logger.debug("Boot-ROM file provided")
 
         self.cartridge = cartridge.load_cartridge(gamerom)
         logger.debug("Cartridge started:\n%s", str(self.cartridge))

diff --git a/pyboy/core/sound.py b/pyboy/core/sound.py
@@ -299,7 +299,7 @@ def sample(self):
             right_sample = 0
 
         if self.audiobuffer_head >= self.audiobuffer_length:
-            logger.critical("Buffer overrun! %d of %d", self.audiobuffer_head, self.audiobuffer_length)
+            logger.warning("Buffer overrun! %d of %d", self.audiobuffer_head, self.audiobuffer_length)
             return
         self.audiobuffer[self.audiobuffer_head] = left_sample
         self.audiobuffer[self.audiobuffer_head + 1] = right_sample

diff --git a/pyboy/logging/__init__.py b/pyboy/logging/__init__.py
@@ -1,12 +1,12 @@
 (
-    DEBUG,
-    INFO,
-    WARNING,
-    ERROR,
-    CRITICAL,
+    DEBUG,  # Only for developers
+    WARNING,  # Unexpected failure that can be worked around
+    ERROR,  # Unexpected failure that impacts usability
+    CRITICAL,  # Unexpected failure where we cannot continue
+    INFO,  # Normal operation, that the user *needs* or *wants* to be aware of
 ) = range(5)
 
-_log_level = WARNING
+_log_level = INFO
 
 
 def get_log_level():

diff --git a/pyboy/pyboy.py b/pyboy/pyboy.py
@@ -226,7 +226,7 @@ def __init__(
 
         for k, v in kwargs.items():
             if k not in defaults and k not in plugin_manager_keywords:
-                logger.error("Unknown keyword argument: %s", k)
+                logger.critical("Unknown keyword argument: %s", k)
                 raise KeyError(f"Unknown keyword argument: {k}")
 
         # Performance measures
@@ -616,7 +616,7 @@ def _pause(self):
         self.paused = True
         self.save_target_emulationspeed = self.target_emulationspeed
         self.target_emulationspeed = 1
-        logger.info("Emulation paused!")
+        logger.debug("Emulation paused!")
         self._update_window_title()
         self._plugin_manager.paused(True)
 
@@ -625,7 +625,7 @@ def _unpause(self):
             return
         self.paused = False
         self.target_emulationspeed = self.save_target_emulationspeed
-        logger.info("Emulation unpaused!")
+        logger.debug("Emulation unpaused!")
         self._update_window_title()
         self._plugin_manager.paused(False)
 
@@ -683,9 +683,9 @@ def stop(self, save=True):
                 provided game-ROM.
         """
         if self.initialized and not self.stopped:
-            logger.info("###########################")
-            logger.info("# Emulator is turning off #")
-            logger.info("###########################")
+            logger.debug("###########################")
+            logger.debug("# Emulator is turning off #")
+            logger.debug("###########################")
             self._plugin_manager.stop()
             self.mb.stop(save)
             self.stopped = True
@@ -1125,7 +1125,7 @@ def _load_symbols(self):
         gamerom_file_no_ext, rom_ext = os.path.splitext(self.gamerom)
         for sym_path in [self.symbols_file, gamerom_file_no_ext + ".sym", gamerom_file_no_ext + rom_ext + ".sym"]:
             if sym_path and os.path.isfile(sym_path):
-                logger.info("Loading symbol file: %s", sym_path)
+                logger.debug("Loading symbol file: %s", sym_path)
                 with open(sym_path) as f:
                     for _line in f.readlines():
                         line = _line.strip()