Replace print statements with proper logging throughout library

Author: Arun Persaud

.coverage

@@ -31,6 +31,53 @@ time.sleep(1)
 laser.off()
 ```
 
+## Logging Configuration
+
+The vortran library uses Python's standard logging module. By default, no log messages are shown. To see log output, configure logging in your application:
+
+### Basic Logging Setup
+
+```python
+import logging
+import vortran
+
+# Show INFO level and above (device discovery, connections)
+logging.basicConfig(level=logging.INFO)
+
+# Or show DEBUG level for detailed USB communication
+logging.basicConfig(level=logging.DEBUG)
+
+lasers = vortran.get_lasers()  # Will now show log messages
+```
+
+### Advanced Logging Configuration
+
+```python
+import logging
+import vortran
+
+# Configure specific logger levels
+logging.getLogger('vortran.usb').setLevel(logging.INFO)      # USB device discovery
+logging.getLogger('vortran.laser').setLevel(logging.DEBUG)   # Laser operations
+logging.getLogger('vortran.usb_connection').setLevel(logging.WARNING)  # Only errors
+
+# Custom formatter
+formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+handler = logging.StreamHandler()
+handler.setFormatter(formatter)
+
+logger = logging.getLogger('vortran')
+logger.addHandler(handler)
+logger.setLevel(logging.DEBUG)
+```
+
+### Log Levels
+
+- **DEBUG**: Detailed USB communication, retry attempts
+- **INFO**: Device discovery, connection status
+- **WARNING**: Parse errors, failed operations with retries
+- **ERROR**: Connection failures, USB communication errors
+
 ## Configuration
 
 ### USB Library Configuration (Windows only)

Readme.md

@@ -1,10 +1,13 @@
 from enum import IntFlag
 from typing import Any
+import logging
 
 from .usb_connection import USB_ReadWrite
 from .usb import get_usb_ports, VortranDevice
 from .parser import parse_output, verify_result
 
+logger = logging.getLogger(__name__)
+
 
 class LaserStatus(IntFlag):
     EMISSION_ACTIVE = 0
@@ -197,7 +200,7 @@ def send_query(self, command: str, alt_list: list[str] = []) -> str | None:
         if (result is not None) and (verify_result(result, verify_list) == True):
             data = result
         else:  # if result is None or not verified, ask again
-            print("trying second query")
+            logger.debug("Query failed, trying second attempt for command: %s", command)
             second_try = self.send_usb(command)
             if (second_try is not None) and (
                 verify_result(second_try, verify_list) == True
@@ -225,7 +228,7 @@ def get_lasers() -> list[Laser]:
                 manager = device
             else:
                 lasers.append(device)
-                print("Attaching Endpoint", device)
+                logger.info("Found laser device: %s", device)
 
     my_timeout = 500
     my_retries = 0

src/vortran/laser.py

@@ -3,6 +3,7 @@
 from pathlib import Path
 import os
 import site
+import logging
 
 # Note: these are imports from pyusb
 import usb.core
@@ -11,6 +12,8 @@
 import re
 import platform
 
+logger = logging.getLogger(__name__)
+
 
 @dataclass
 class VortranDevice:
@@ -193,13 +196,13 @@ def parse_bus_and_address(text: str) -> tuple[int | None, int | None]:
             try:
                 bus = int(tmp_match_bus.groups()[0])
             except ValueError:
-                print("Unable to get a bus in utility get_usb_ports")
+                logger.warning("Failed to parse bus number from USB string: %s", text)
 
     if tmp_match_address:
         if len(tmp_match_address.groups()) == 1:
             try:
                 address = int(tmp_match_address.groups()[0])
             except ValueError:
-                print("Unable to get a bus in utility get_usb_ports")
+                logger.warning("Failed to parse address from USB string: %s", text)
 
     return bus, address

src/vortran/usb.py

@@ -11,6 +11,8 @@
 
 from .usb import VortranDevice, get_usb_backend
 
+logger = logging.getLogger(__name__)
+
 
 class USB_ReadWrite:
     SET_CMD_QUERY = bytes([0xA0])
@@ -104,23 +106,29 @@ def open_connection(self) -> bool:
                         self.logger.log.info(msg_out)
 
             except Exception as e:
-                print(repr(e))
+                logger.error("USB connection failed: %s", repr(e))
                 if self.logger:
                     self.logger.log.error(repr(e))
 
                 num_attempts += 1
                 if num_attempts <= self.retries:
-                    msg_out = "Retrying connection to USB Vendor_ID={self.vendor_id}, Product_ID={self.product_id}. Attempt {num_attempts} of {self.retries}"
-                    print(msg_out)
+                    logger.warning(
+                        "Retrying USB connection (Vendor=%04x, Product=%04x). Attempt %d of %d",
+                        self.vendor_id,
+                        self.product_id,
+                        num_attempts,
+                        self.retries,
+                    )
                     if self.logger:
+                        msg_out = f"Retrying connection to USB Vendor_ID={self.vendor_id}, Product_ID={self.product_id}. Attempt {num_attempts} of {self.retries}"
                         self.logger.log.warning(msg_out)
         return is_connection_open
 
     def read_usb(self, timeout: int, include_first_byte: bool = False) -> str | None:
         try:
             data = self.connection.read(0x81, 64, timeout)
         except usb.core.USBError as e:
-            print(f"Error reading response: {e.args}: {str(timeout)}")
+            logger.error("USB read error (timeout=%s): %s", timeout, e.args)
             return None
 
         if include_first_byte:
@@ -180,4 +188,4 @@ def send_usb(self, cmd: str, writeOnly: bool = False) -> str | None:
                 return response
 
         except usb.core.USBError as e:
-            print(repr(e.args))
+            logger.error("USB communication error: %s", repr(e.args))