Swap out print statements for use of the logging library.

Author: GraylinKim

sc2reader/__init__.py

@@ -1,6 +1,9 @@
 from __future__ import absolute_import
 
-from sc2reader import factories
+from sc2reader import factories, log_utils
+
+# setup the library logging
+log_utils.setup()
 
 # For backwards compatibility
 SC2Reader = factories.SC2Factory

sc2reader/events.py

@@ -2,9 +2,11 @@
 
 from sc2reader.utils import Length, LITTLE_ENDIAN
 from sc2reader.data.utils import DataObject
+from sc2reader import log_utils
 
 class Event(object):
     def __init__(self, frame, pid):
+        self.logger = log_utils.get_logger(self.__class__)
         self.pid = pid
         self.frame = frame
         self.second = frame >> 4
@@ -125,11 +127,11 @@ def load_context(self, replay):
         if self.ability not in replay.datapack.abilities:
             if not getattr(replay, 'marked_error', None):
                 replay.marked_error=True
-                print replay.filename
-                print "Release String: "+replay.release_string
+                self.logger.error(replay.filename)
+                self.logger.error("Release String: "+replay.release_string)
                 for player in replay.players:
-                    print "\t"+str(player)
-            print "[Error] {0}\t{1}\tMissing ability {2} from {3}".format(self.frame, self.player.name, hex(self.ability), replay.datapack.__class__.__name__)
+                    self.logger.error("\t"+str(player))
+            self.logger.error("{0}\t{1}\tMissing ability {2} from {3}".format(self.frame, self.player.name, hex(self.ability), replay.datapack.__class__.__name__))
 
     def __str__(self):
         if not self.ability:
@@ -153,7 +155,6 @@ def load_context(self, replay):
             self.target = replay.objects[(obj_id, obj_type)]
 
         elif obj_id:
-            #print "{0}:\t{1}\t{2}".format(self.frame << 2, self.player.name, hex(obj_type))
             if obj_type not in replay.datapack.types:
                 self.target = DataObject(0x00)
             else:
@@ -221,8 +222,8 @@ def load_context(self, replay):
         data = replay.datapack
         for (obj_id, obj_type) in self.objects:
             if obj_type not in data.types:
-                msg = "[Error] Unit Type {0} not found in {1}"
-                print msg.format(hex(obj_type), data.__class__.__name__)
+                msg = "Unit Type {0} not found in {1}"
+                self.logger.error(msg.format(hex(obj_type), data.__class__.__name__))
                 objects.append(DataObject(0x0))
 
             else:

sc2reader/factories.py

@@ -13,6 +13,7 @@
 from sc2reader import data
 from sc2reader import exceptions
 from sc2reader import utils
+from sc2reader import log_utils
 from sc2reader.resources import Replay, Map
 
 class SC2Factory(object):
@@ -82,6 +83,7 @@ class SC2Factory(object):
     def __init__(self, **options):
         self.reset()
         self.configure(**options)
+        self.logger = log_utils.get_logger(self.__class__)
 
         if self.options.get('register_defaults',None):
             self.register_defaults()
@@ -148,6 +150,7 @@ def load_resource(self, resource, options=None, **new_options):
 
         if isinstance(resource, basestring):
             if re.match(r'https?://',resource):
+                self.logger.info("Fetching remote resource: "+resource)
                 contents = urllib2.urlopen(resource).read()
 
             else:

sc2reader/log_utils.py

@@ -0,0 +1,49 @@
+import logging
+
+LEVEL_MAP = dict(
+    DEBUG=logging.DEBUG,
+    INFO=logging.INFO,
+    WARN=logging.WARN,
+    ERROR=logging.ERROR,
+    CRITICAL=logging.CRITICAL
+)
+
+def setup():
+    logging.getLogger('sc2reader').addHandler(logging.NullHandler())
+
+def log_to_file(filename, level='WARN', format=None, datefmt=None, **options):
+    add_log_handler(logging.FileHandler(filename, **options),level, format, datefmt)
+
+def log_to_console(level='WARN', format=None, datefmt=None, **options):
+    add_log_handler(logging.StreamHandler(**options),level, format, datefmt)
+
+def add_log_handler(handler, level='WARN', format=None, datefmt=None):
+    handler.setFormatter(logging.Formatter(format, datefmt))
+
+    if isinstance(level, basestring):
+        level = LEVEL_MAP[level]
+
+    logger = logging.getLogger('sc2reader')
+    logger.setLevel(level)
+    logger.addHandler(handler)
+
+def get_logger(entity):
+    """
+        Retrieves loggers from the enties fully scoped name. Accepts strings,
+        classes, and functions.
+
+            get_logger(Replay)     -> sc2reader.replay.Replay
+            get_logger(__name__)   -> sc2reader.utils
+            get_logger(get_logger) -> sc2reader.utils.get_logger
+
+        :param entity: The entity for which we want a logger.
+    """
+    try:
+        if isinstance(entity, basestring):
+            return logging.getLogger(entity)
+        else:
+            return logging.getLogger(entity.__module__+'.'+entity.__name__)
+
+    except AttributeError as e:
+        msg = "Cannot retrieve logger for {0}. Only strings, classes, and functions supported."
+        raise TypeError(msg.format(entity))

sc2reader/objects.py

@@ -19,10 +19,7 @@ class Team(object):
     """
     The team object primarily a container object for organizing :class:`Player`
     objects with some metadata. As such, it implements iterable and can be
-    looped over like a list::
-
-        for player in team:
-            print player
+    looped over like a list.
 
     :param interger number: The team number as recorded in the replay
     """

sc2reader/resources.py

@@ -8,13 +8,15 @@
 from mpyq import MPQArchive
 
 from sc2reader import utils
+from sc2reader import log_utils
 from sc2reader.objects import Player, Observer, Team
 from sc2reader.constants import REGIONS, LOCALIZED_RACES, GAME_SPEED_FACTOR
 
 
 class Resource(object):
     def __init__(self, file_object, filename=None, **options):
         self.opt = utils.AttributeDict(options)
+        self.logger = log_utils.get_logger(self.__class__)
         self.filename = filename or getattr(file_object,'name','Unavailable')
 
         file_object.seek(0)
@@ -152,7 +154,7 @@ def read_data(self, data_file, reader):
         elif self.opt.debug:
             raise ValueError("{0} not found in archive".format(data_file))
         else:
-            print "[Error] {0} not found in archive".format(data_file)
+            self.logger.error("{0} not found in archive".format(data_file))
 
     def load_details(self):
         if 'replay.initData' in self.raw_data: