Merge pull request #60 from einarf/logging

Logging

Author: Kurt Yoder

README.md

@@ -76,6 +76,20 @@ obj = pywavefront.Wavefront('something.obj')
 visualization.draw(obj)
 ```
 
+## Logging
+
+The default log level is `ERROR`. This is configurable including overriding the formatter.
+
+```python
+import logging
+import pywavefront
+
+pywavefront.configure_logging(
+    logging.DEBUG,
+    formatter=logging.Formatter('%(name)s-%(levelname)s: %(message)s')
+)
+```
+
 ### Example Scripts
 
 The `example` directory contains some basic examples using the `visualization` module

pywavefront/__init__.py

@@ -31,6 +31,23 @@
 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
 # ----------------------------------------------------------------------------
+import logging
+
 from pywavefront.exceptions import PywavefrontException
 from pywavefront.obj import ObjParser
 from pywavefront.wavefront import Wavefront
+
+logger = logging.getLogger("pywavefront")
+log_handler = logging.StreamHandler()
+logger.addHandler(log_handler)
+
+
+def configure_logging(level, formatter=None):
+    logger.setLevel(level)
+    log_handler.setLevel(level)
+
+    if formatter:
+        log_handler.setFormatter(formatter)
+
+
+configure_logging(logging.ERROR, logging.Formatter('%(name)s-%(levelname)s: %(message)s'))

pywavefront/material.py

@@ -31,11 +31,14 @@
 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
 # ----------------------------------------------------------------------------
+import logging
 import os
 
 from pywavefront.parser import Parser, auto_consume
 from pywavefront.texture import Texture
 
+logger = logging.getLogger("pywavefront")
+
 
 class Material(object):
     def __init__(self, name=None, is_default=False):

pywavefront/obj.py

@@ -1,10 +1,13 @@
+import logging
 import os
 
 from pywavefront.exceptions import PywavefrontException
 from pywavefront.parser import Parser, auto_consume
 from pywavefront.material import Material, MaterialParser
 from pywavefront.mesh import Mesh
 
+logger = logging.getLogger("pywavefront")
+
 
 class ObjParser(Parser):
     """This parser parses lines from .obj files."""

pywavefront/parser.py

@@ -39,6 +39,8 @@
 
 from pywavefront.exceptions import PywavefrontException
 
+logger = logging.getLogger("pywavefront")
+
 
 def auto_consume(func):
     """Decorator for auto consuming lines when leaving the function"""
@@ -141,7 +143,7 @@ def parse_fallback(self):
             raise PywavefrontException("Unimplemented OBJ format statement '%s' on line '%s'"
                                        % (self.values[0], self.line.rstrip()))
         else:
-            logging.warning("Unimplemented OBJ format statement '%s' on line '%s'"
+            logger.warning("Unimplemented OBJ format statement '%s' on line '%s'"
                             % (self.values[0], self.line.rstrip()))
 
     def _build_dispatch_map(self):

pywavefront/wavefront.py

@@ -1,5 +1,8 @@
+import logging
 from pywavefront import ObjParser
 
+logger = logging.getLogger("pywavefront")
+
 
 class Wavefront(object):
     # Can be used to override the parser when extending the class