split up util.py into files.py and logger.py, moved code appropriately

overviewer.py

@@ -35,6 +35,7 @@ import logging
 from optparse import OptionParser
 
 from overviewer_core import util
+from overviewer_core import logger
 from overviewer_core import textures
 from overviewer_core import optimizeimages, world
 from overviewer_core import configParser, tileset, assetmanager, dispatcher
@@ -44,52 +45,36 @@ helptext = """
 %prog [--rendermodes=...] [options] <World> <Output Dir>
 %prog --config=<config file> [options]"""
 
-def configure_logger(loglevel=logging.INFO, verbose=False):
+def is_bare_console():
-    """Configures the root logger to our liking
+    """Returns true if Overviewer is running in a bare console in
-
+    Windows, that is, if overviewer wasn't started in a cmd.exe
-    For a non-standard loglevel, pass in the level with which to configure the handler.
+    session.
-
-    For a more verbose options line, pass in verbose=True
-
-    This function may be called more than once.
-
     """
-
-    logger = logging.getLogger()
-
-    outstream = sys.stderr
-
     if platform.system() == 'Windows':
-        # Our custom output stream processor knows how to deal with select ANSI
+        try:
-        # color escape sequences
+            import ctypes
-        outstream = util.WindowsOutputStream()
+            GetConsoleProcessList = ctypes.windll.kernel32.GetConsoleProcessList
-        formatter = util.ANSIColorFormatter(verbose)
+            num = GetConsoleProcessList(ctypes.byref(ctypes.c_int(0)), ctypes.c_int(1))
+            if (num == 1):
+                return True
                 
-    elif sys.stderr.isatty():
+        except Exception:
-        # terminal logging with ANSI color
+            pass
-        formatter = util.ANSIColorFormatter(verbose)
+    return False
 
-    else:
+def nice_exit(ret=0):
-        # Let's not assume anything. Just text.
+    """Drop-in replacement for sys.exit that will automatically detect
-        formatter = util.DumbFormatter(verbose)
+    bare consoles and wait for user input before closing.
-
+    """
-    if hasattr(logger, 'overviewerHandler'):
+    if ret and is_bare_console():
-        # we have already set up logging so just replace the formatter
+        print
-        # this time with the new values
+        print "Press [Enter] to close this window."
-        logger.overviewerHandler.setFormatter(formatter)
+        raw_input()
-        logger.setLevel(loglevel)
+    sys.exit(ret)
-
-    else:
-        # Save our handler here so we can tell which handler was ours if the
-        # function is called again
-        logger.overviewerHandler = logging.StreamHandler(outstream)
-        logger.overviewerHandler.setFormatter(formatter)
-        logger.addHandler(logger.overviewerHandler)
-        logger.setLevel(loglevel)
 
 def main():
     # bootstrap the logger with defaults
-    configure_logger()
+    logger.configure()
 
     try:
         cpus = multiprocessing.cpu_count()
@@ -132,7 +117,7 @@ def main():
     options, args = parser.parse_args()
 
     # re-configure the logger now that we've processed the command line options
-    configure_logger(logging.INFO + 10*options.quiet - 10*options.verbose,
+    logger.configure(logging.INFO + 10*options.quiet - 10*options.verbose,
                      options.verbose > 0)
 
     ##########################################################################
@@ -171,7 +156,7 @@ def main():
     if len(args) == 0 and not options.config:
         # first provide an appropriate error for bare-console users
         # that don't provide any options
-        if util.is_bare_console():
+        if is_bare_console():
             print "\n"
             print "The Overviewer is a console program.  Please open a Windows command prompt"
             print "first and run Overviewer from there.   Further documentation is available at"
@@ -485,10 +470,10 @@ if __name__ == "__main__":
     multiprocessing.freeze_support()
     try:
         ret = main()
-        util.exit(ret)
+        nice_exit(ret)
     except Exception, e:
         logging.exception("""An error has occurred. This may be a bug. Please let us know!
 See http://docs.overviewer.org/en/latest/index.html#help
 
 This is the error that occurred:""")
-        util.exit(1)
+        nice_exit(1)

overviewer_core/assetmanager.py

@@ -24,7 +24,7 @@ from PIL import Image
 
 import world
 import util
-import overviewer_version
+from files import FileReplacer, mirror_dir
 
 class AssetManager(object):
     """\
@@ -150,13 +150,13 @@ directory.
         global_assets = os.path.join(util.get_program_path(), "overviewer_core", "data", "web_assets")
         if not os.path.isdir(global_assets):
             global_assets = os.path.join(util.get_program_path(), "web_assets")
-        util.mirror_dir(global_assets, self.outputdir)
+        mirror_dir(global_assets, self.outputdir)
 
         # create overviewer.js from the source js files
         js_src = os.path.join(util.get_program_path(), "overviewer_core", "data", "js_src")
         if not os.path.isdir(js_src):
             js_src = os.path.join(util.get_program_path(), "js_src")
-        with util.FileReplacer(os.path.join(self.outputdir, "overviewer.js")) as tmpfile:
+        with FileReplacer(os.path.join(self.outputdir, "overviewer.js")) as tmpfile:
             with open(tmpfile, "w") as fout:
                 # first copy in js_src/overviewer.js
                 with open(os.path.join(js_src, "overviewer.js"), 'r') as f:
@@ -169,7 +169,7 @@ directory.
         
         # write out config
         jsondump = json.dumps(dump, indent=4)
-        with util.FileReplacer(os.path.join(self.outputdir, "overviewerConfig.js")) as tmpfile:
+        with FileReplacer(os.path.join(self.outputdir, "overviewerConfig.js")) as tmpfile:
             with codecs.open(tmpfile, 'w', encoding='UTF-8') as f:
                 f.write("var overviewerConfig = " + jsondump + ";\n")
         
@@ -179,9 +179,9 @@ directory.
         index = codecs.open(indexpath, 'r', encoding='UTF-8').read()
         index = index.replace("{title}", "Minecraft Overviewer")
         index = index.replace("{time}", time.strftime("%a, %d %b %Y %H:%M:%S %Z", time.localtime()).decode(locale.getpreferredencoding()))
-        versionstr = "%s (%s)" % (overviewer_version.VERSION, overviewer_version.HASH[:7])
+        versionstr = "%s (%s)" % (util.findGitVersion(), util.findGitHash()[:7])
         index = index.replace("{version}", versionstr)
 
-        with util.FileReplacer(indexpath) as indexpath:
+        with FileReplacer(indexpath) as indexpath:
             with codecs.open(indexpath, 'w', encoding='UTF-8') as output:
                 output.write(index)

overviewer_core/files.py

@@ -0,0 +1,122 @@
+#    This file is part of the Minecraft Overviewer.
+#
+#    Minecraft Overviewer is free software: you can redistribute it and/or
+#    modify it under the terms of the GNU General Public License as published
+#    by the Free Software Foundation, either version 3 of the License, or (at
+#    your option) any later version.
+#
+#    Minecraft Overviewer is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
+#    Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License along
+#    with the Overviewer.  If not, see <http://www.gnu.org/licenses/>.
+
+import os
+import os.path
+import tempfile
+import shutil
+import logging
+
+## useful recursive copy, that ignores common OS cruft
+def mirror_dir(src, dst, entities=None):
+    '''copies all of the entities from src to dst'''
+    if not os.path.exists(dst):
+        os.mkdir(dst)
+    if entities and type(entities) != list: raise Exception("Expected a list, got a %r instead" % type(entities))
+    
+    # files which are problematic and should not be copied
+    # usually, generated by the OS
+    skip_files = ['Thumbs.db', '.DS_Store']
+    
+    for entry in os.listdir(src):
+        if entry in skip_files:
+            continue
+        if entities and entry not in entities:
+            continue
+        
+        if os.path.isdir(os.path.join(src,entry)):
+            mirror_dir(os.path.join(src, entry), os.path.join(dst, entry))
+        elif os.path.isfile(os.path.join(src,entry)):
+            try:
+                shutil.copy(os.path.join(src, entry), os.path.join(dst, entry))
+            except IOError as outer: 
+                try:
+                    # maybe permission problems?
+                    src_stat = os.stat(os.path.join(src, entry))
+                    os.chmod(os.path.join(src, entry), src_stat.st_mode | stat.S_IRUSR)
+                    dst_stat = os.stat(os.path.join(dst, entry))
+                    os.chmod(os.path.join(dst, entry), dst_stat.st_mode | stat.S_IWUSR)
+                except OSError: # we don't care if this fails
+                    pass
+                shutil.copy(os.path.join(src, entry), os.path.join(dst, entry))
+                # if this stills throws an error, let it propagate up
+
+# Define a context manager to handle atomic renaming or "just forget it write
+# straight to the file" depending on whether os.rename provides atomic
+# overwrites.
+# Detect whether os.rename will overwrite files
+with tempfile.NamedTemporaryFile() as f1:
+    with tempfile.NamedTemporaryFile() as f2:
+        try:
+            os.rename(f1.name,f2.name)
+        except OSError:
+            renameworks = False
+        else:
+            renameworks = True
+            # re-make this file so it can be deleted without error
+            open(f1.name, 'w').close()
+del tempfile,f1,f2
+doc = """This class acts as a context manager for files that are to be written
+out overwriting an existing file.
+
+The parameter is the destination filename. The value returned into the context
+is the filename that should be used. On systems that support an atomic
+os.rename(), the filename will actually be a temporary file, and it will be
+atomically replaced over the destination file on exit.
+
+On systems that don't support an atomic rename, the filename returned is the
+filename given.
+
+If an error is encountered, the file is attempted to be removed, and the error
+is propagated.
+
+Example:
+
+with FileReplacer("config") as configname:
+    with open(configout, 'w') as configout:
+        configout.write(newconfig)
+"""
+if renameworks:
+    class FileReplacer(object):
+        __doc__ = doc
+        def __init__(self, destname):
+            self.destname = destname
+            self.tmpname = destname + ".tmp"
+        def __enter__(self):
+            # rename works here. Return a temporary filename
+            return self.tmpname
+        def __exit__(self, exc_type, exc_val, exc_tb):
+            if exc_type:
+                # error
+                try:
+                    os.remove(self.tmpname)
+                except Exception, e:
+                    logging.warning("An error was raised, so I was doing "
+                            "some cleanup first, but I couldn't remove "
+                            "'%s'!", self.tmpname)
+            else:
+                # atomic rename into place
+                os.rename(self.tmpname, self.destname)
+else:
+    class FileReplacer(object):
+        __doc__ = doc
+        def __init__(self, destname):
+            self.destname = destname
+        def __enter__(self):
+            return self.destname
+        def __exit__(self, exc_type, exc_val, exc_tb):
+            return
+del renameworks
+

overviewer_core/logger.py

@@ -0,0 +1,298 @@
+#    This file is part of the Minecraft Overviewer.
+#
+#    Minecraft Overviewer is free software: you can redistribute it and/or
+#    modify it under the terms of the GNU General Public License as published
+#    by the Free Software Foundation, either version 3 of the License, or (at
+#    your option) any later version.
+#
+#    Minecraft Overviewer is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
+#    Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License along
+#    with the Overviewer.  If not, see <http://www.gnu.org/licenses/>.
+
+import sys
+import os
+import logging
+import platform
+import ctypes
+from cStringIO import StringIO
+
+# Some cool code for colored logging:
+# For background, add 40. For foreground, add 30
+BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE = range(8)
+
+RESET_SEQ = "\033[0m"
+COLOR_SEQ = "\033[1;%dm"
+BOLD_SEQ = "\033[1m"
+
+# Windows colors, taken from WinCon.h
+FOREGROUND_BLUE   = 0x01
+FOREGROUND_GREEN  = 0x02
+FOREGROUND_RED    = 0x04
+FOREGROUND_BOLD   = 0x08
+FOREGROUND_WHITE  = FOREGROUND_BLUE | FOREGROUND_GREEN | FOREGROUND_RED
+
+BACKGROUND_BLACK  = 0x00
+BACKGROUND_BLUE   = 0x10
+BACKGROUND_GREEN  = 0x20
+BACKGROUND_RED    = 0x40
+
+COLORIZE = {
+    #'INFO': WHITe,
+    'DEBUG': CYAN,
+}
+HIGHLIGHT = {
+    'CRITICAL': RED,
+    'ERROR': RED,
+    'WARNING': YELLOW,
+}
+
+
+class WindowsOutputStream(object):
+    """A file-like object that proxies sys.stderr and interprets simple ANSI
+    escape codes for color, translating them to the appropriate Windows calls.
+
+    """
+    def __init__(self, stream=None):
+        assert platform.system() == 'Windows'
+        self.stream = stream or sys.stderr
+
+        # go go gadget ctypes 
+        self.GetStdHandle = ctypes.windll.kernel32.GetStdHandle
+        self.SetConsoleTextAttribute = ctypes.windll.kernel32.SetConsoleTextAttribute
+        self.STD_OUTPUT_HANDLE = ctypes.c_int(0xFFFFFFF5)
+        self.output_handle = self.GetStdHandle(self.STD_OUTPUT_HANDLE)
+        if self.output_handle == 0xFFFFFFFF:
+            raise Exception("Something failed in WindowsColorFormatter")
+
+
+        # default is white text on a black background
+        self.currentForeground = FOREGROUND_WHITE
+        self.currentBackground = BACKGROUND_BLACK
+        self.currentBold       = 0
+
+    def updateWinColor(self, Fore=None, Back=None, Bold=False):
+        if Fore != None: self.currentForeground = Fore
+        if Back != None: self.currentBackground = Back
+        if Bold: 
+            self.currentBold = FOREGROUND_BOLD
+        else:
+            self.currentBold = 0
+
+        self.SetConsoleTextAttribute(self.output_handle,
+                ctypes.c_int(self.currentForeground | self.currentBackground | self.currentBold))
+
+    def write(self, s):
+
+        msg_strm = StringIO(s) 
+    
+        while (True):
+            c = msg_strm.read(1)
+            if c == '': break
+            if c == '\033':
+                c1 = msg_strm.read(1)
+                if c1 != '[': # 
+                    sys.stream.write(c + c1)
+                    continue
+                c2 = msg_strm.read(2)
+                if c2 == "0m": # RESET_SEQ
+                    self.updateWinColor(Fore=FOREGROUND_WHITE, Back=BACKGROUND_BLACK)
+
+                elif c2 == "1;":
+                    color = ""
+                    while(True):
+                        nc = msg_strm.read(1)
+                        if nc == 'm': break
+                        color += nc
+                    color = int(color) 
+                    if (color >= 40): # background
+                        color = color - 40
+                        if color == BLACK:
+                            self.updateWinColor(Back=BACKGROUND_BLACK)
+                        if color == RED:
+                            self.updateWinColor(Back=BACKGROUND_RED)
+                        elif color == GREEN:
+                            self.updateWinColor(Back=BACKGROUND_GREEN)
+                        elif color == YELLOW:
+                            self.updateWinColor(Back=BACKGROUND_RED | BACKGROUND_GREEN)
+                        elif color == BLUE:
+                            self.updateWinColor(Back=BACKGROUND_BLUE)
+                        elif color == MAGENTA:
+                            self.updateWinColor(Back=BACKGROUND_RED | BACKGROUND_BLUE)
+                        elif color == CYAN:
+                            self.updateWinColor(Back=BACKGROUND_GREEN | BACKGROUND_BLUE)
+                        elif color == WHITE:
+                            self.updateWinColor(Back=BACKGROUND_RED | BACKGROUND_GREEN | BACKGROUND_BLUE)
+                    elif (color >= 30): # foreground
+                        color = color - 30
+                        if color == BLACK:
+                            self.updateWinColor(Fore=FOREGROUND_BLACK)
+                        if color == RED:
+                            self.updateWinColor(Fore=FOREGROUND_RED)
+                        elif color == GREEN:
+                            self.updateWinColor(Fore=FOREGROUND_GREEN)
+                        elif color == YELLOW:
+                            self.updateWinColor(Fore=FOREGROUND_RED | FOREGROUND_GREEN)
+                        elif color == BLUE:
+                            self.updateWinColor(Fore=FOREGROUND_BLUE)
+                        elif color == MAGENTA:
+                            self.updateWinColor(Fore=FOREGROUND_RED | FOREGROUND_BLUE)
+                        elif color == CYAN:
+                            self.updateWinColor(Fore=FOREGROUND_GREEN | FOREGROUND_BLUE)
+                        elif color == WHITE:
+                            self.updateWinColor(Fore=FOREGROUND_WHITE)
+
+                         
+                    
+                elif c2 == "1m": # BOLD_SEQ
+                    pass
+                
+            else:
+                self.stream.write(c)
+
+
+
+    def flush(self):
+        self.stream.flush()
+
+class HighlightingFormatter(logging.Formatter):
+    """Base class of our custom formatter
+    
+    """
+    datefmt = "%Y-%m-%d %H:%M:%S"
+    funcName_len = 15
+
+    def __init__(self, verbose=False):
+        if verbose:
+            fmtstr = '%(fileandlineno)-18s %(pid)s %(asctime)s ' \
+                    '%(levelname)-8s %(message)s'
+        else:
+            fmtstr = '%(asctime)s ' '%(shortlevelname)-1s%(message)s'
+
+        logging.Formatter.__init__(self, fmtstr, self.datefmt)
+
+    def format(self, record):
+        """Add a few extra options to the record
+
+        pid
+            The process ID
+
+        fileandlineno
+            A combination filename:linenumber string, so it can be justified as
+            one entry in a format string.
+
+        funcName
+            The function name truncated/padded to a fixed width characters
+
+        shortlevelname
+            The level name truncated to 1 character
+        
+        """
+
+        record.shortlevelname = record.levelname[0] + ' ' 
+        if record.levelname == 'INFO': record.shortlevelname = ''
+
+        record.pid = os.getpid()
+        record.fileandlineno = "%s:%s" % (record.filename, record.lineno)
+
+        # Set the max length for the funcName field, and left justify
+        l = self.funcName_len
+        record.funcName = ("%-" + str(l) + 's') % record.funcName[:l]
+
+        return self.highlight(record)
+
+    def highlight(self, record):
+        """This method applies any special effects such as colorization. It
+        should modify the records in the record object, and should return the
+        *formatted line*. This probably involves calling
+        logging.Formatter.format()
+
+        Override this in subclasses
+
+        """
+        return logging.Formatter.format(self, record)
+
+class DumbFormatter(HighlightingFormatter):
+    """Formatter for dumb terminals that don't support color, or log files.
+    Prints a bunch of stars before a highlighted line.
+
+    """
+    def highlight(self, record):
+        if record.levelname in HIGHLIGHT:
+            line = logging.Formatter.format(self, record)
+            line = "*" * min(79,len(line)) + "\n" + line
+            return line
+        else:
+            return HighlightingFormatter.highlight(self, record)
+
+
+class ANSIColorFormatter(HighlightingFormatter):
+    """Uses ANSI escape sequences to enable GLORIOUS EXTRA-COLOR!
+
+    """
+    def highlight(self, record):
+        if record.levelname in COLORIZE:
+            # Colorize just the levelname
+            # left justify again because the color sequence bumps the length up
+            # above 8 chars
+            levelname_color = COLOR_SEQ % (30 + COLORIZE[record.levelname]) + \
+                    "%-8s" % record.levelname + RESET_SEQ
+            record.levelname = levelname_color
+            return logging.Formatter.format(self, record)
+
+        elif record.levelname in HIGHLIGHT:
+            # Colorize the entire line
+            line = logging.Formatter.format(self, record)
+            line = COLOR_SEQ % (40 + HIGHLIGHT[record.levelname]) + line + \
+                    RESET_SEQ
+            return line
+
+        else:
+            # No coloring if it's not to be highlighted or colored
+            return logging.Formatter.format(self, record)
+
+def configure(loglevel=logging.INFO, verbose=False):
+    """Configures the root logger to our liking
+
+    For a non-standard loglevel, pass in the level with which to configure the handler.
+
+    For a more verbose options line, pass in verbose=True
+
+    This function may be called more than once.
+
+    """
+
+    logger = logging.getLogger()
+
+    outstream = sys.stderr
+
+    if platform.system() == 'Windows':
+        # Our custom output stream processor knows how to deal with select ANSI
+        # color escape sequences
+        outstream = WindowsOutputStream()
+        formatter = ANSIColorFormatter(verbose)
+
+    elif sys.stderr.isatty():
+        # terminal logging with ANSI color
+        formatter = ANSIColorFormatter(verbose)
+
+    else:
+        # Let's not assume anything. Just text.
+        formatter = DumbFormatter(verbose)
+
+    if hasattr(logger, 'overviewerHandler'):
+        # we have already set up logging so just replace the formatter
+        # this time with the new values
+        logger.overviewerHandler.setFormatter(formatter)
+        logger.setLevel(loglevel)
+
+    else:
+        # Save our handler here so we can tell which handler was ours if the
+        # function is called again
+        logger.overviewerHandler = logging.StreamHandler(outstream)
+        logger.overviewerHandler.setFormatter(formatter)
+        logger.addHandler(logger.overviewerHandler)
+        logger.setLevel(loglevel)

overviewer_core/tileset.py

@@ -28,8 +28,8 @@ from itertools import product, izip
 
 from PIL import Image
 
-from .util import iterate_base4, convert_coords, unconvert_coords, roundrobin
+from .util import roundrobin
-from .util import FileReplacer
+from .files import FileReplacer
 from .optimizeimages import optimize_image
 import c_overviewer
 
@@ -84,6 +84,11 @@ do_work(workobj)
 
 """
 
+# small but useful
+def iterate_base4(d):
+    """Iterates over a base 4 number with d digits"""
+    return product(xrange(4), repeat=d)
+
 # A named tuple class storing the row and column bounds for the to-be-rendered
 # world
 Bounds = namedtuple("Bounds", ("mincol", "maxcol", "minrow", "maxrow"))
@@ -1002,6 +1007,27 @@ class TileSet(object):
                     # Nope.
                     yield path, max_child_mtime, False
 
+##
+## Functions for converting (x, z) to (col, row) and back
+##
+
+def convert_coords(chunkx, chunkz):
+    """Takes a coordinate (chunkx, chunkz) where chunkx and chunkz are
+    in the chunk coordinate system, and figures out the row and column
+    in the image each one should be. Returns (col, row)."""
+    
+    # columns are determined by the sum of the chunk coords, rows are the
+    # difference
+    # change this function, and you MUST change unconvert_coords
+    return (chunkx + chunkz, chunkz - chunkx)
+
+def unconvert_coords(col, row):
+    """Undoes what convert_coords does. Returns (chunkx, chunkz)."""
+    
+    # col + row = chunkz + chunkz => (col + row)/2 = chunkz
+    # col - row = chunkx + chunkx => (col - row)/2 = chunkx
+    return ((col - row) / 2, (col + row) / 2)
+
 ######################
 # The following two functions define the mapping from chunks to tiles and back.
 # The mapping from chunks to tiles (get_tiles_by_chunk()) is used during the

overviewer_core/util.py

@@ -18,17 +18,10 @@ Misc utility routines used by multiple files that don't belong anywhere else
 """
 
 import imp
-import os
 import os.path
 import sys
-import platform
 from subprocess import Popen, PIPE
-import logging
-from cStringIO import StringIO
-import ctypes
-import platform
 from itertools import cycle, islice, product
-import shutil
 
 def get_program_path():
     if hasattr(sys, "frozen") or imp.is_frozen("__main__"):
@@ -89,33 +82,6 @@ def findGitVersion():
         except Exception:
             return "unknown"
 
-def is_bare_console():
-    """Returns true if Overviewer is running in a bare console in
-    Windows, that is, if overviewer wasn't started in a cmd.exe
-    session.
-    """
-    if platform.system() == 'Windows':
-        try:
-            import ctypes
-            GetConsoleProcessList = ctypes.windll.kernel32.GetConsoleProcessList
-            num = GetConsoleProcessList(ctypes.byref(ctypes.c_int(0)), ctypes.c_int(1))
-            if (num == 1):
-                return True
-                
-        except Exception:
-            pass
-    return False
-
-def exit(ret=0):
-    """Drop-in replacement for sys.exit that will automatically detect
-    bare consoles and wait for user input before closing.
-    """
-    if ret and is_bare_console():
-        print
-        print "Press [Enter] to close this window."
-        raw_input()
-    sys.exit(ret)
-
 # http://docs.python.org/library/itertools.html
 def roundrobin(iterables):
     "roundrobin('ABC', 'D', 'EF') --> A D E B F C"
@@ -130,367 +96,6 @@ def roundrobin(iterables):
             pending -= 1
             nexts = cycle(islice(nexts, pending))
 
-def iterate_base4(d):
-    """Iterates over a base 4 number with d digits"""
-    return product(xrange(4), repeat=d)
-   
-
-def convert_coords(chunkx, chunkz):
-    """Takes a coordinate (chunkx, chunkz) where chunkx and chunkz are
-    in the chunk coordinate system, and figures out the row and column
-    in the image each one should be. Returns (col, row)."""
-    
-    # columns are determined by the sum of the chunk coords, rows are the
-    # difference
-    # change this function, and you MUST change unconvert_coords
-    return (chunkx + chunkz, chunkz - chunkx)
-
-def unconvert_coords(col, row):
-    """Undoes what convert_coords does. Returns (chunkx, chunkz)."""
-    
-    # col + row = chunkz + chunkz => (col + row)/2 = chunkz
-    # col - row = chunkx + chunkx => (col - row)/2 = chunkx
-    return ((col - row) / 2, (col + row) / 2)
-
-# Define a context manager to handle atomic renaming or "just forget it write
-# straight to the file" depending on whether os.rename provides atomic
-# overwrites.
-# Detect whether os.rename will overwrite files
-import tempfile
-with tempfile.NamedTemporaryFile() as f1:
-    with tempfile.NamedTemporaryFile() as f2:
-        try:
-            os.rename(f1.name,f2.name)
-        except OSError:
-            renameworks = False
-        else:
-            renameworks = True
-            # re-make this file so it can be deleted without error
-            open(f1.name, 'w').close()
-del tempfile,f1,f2
-doc = """This class acts as a context manager for files that are to be written
-out overwriting an existing file.
-
-The parameter is the destination filename. The value returned into the context
-is the filename that should be used. On systems that support an atomic
-os.rename(), the filename will actually be a temporary file, and it will be
-atomically replaced over the destination file on exit.
-
-On systems that don't support an atomic rename, the filename returned is the
-filename given.
-
-If an error is encountered, the file is attempted to be removed, and the error
-is propagated.
-
-Example:
-
-with FileReplacer("config") as configname:
-    with open(configout, 'w') as configout:
-        configout.write(newconfig)
-"""
-if renameworks:
-    class FileReplacer(object):
-        __doc__ = doc
-        def __init__(self, destname):
-            self.destname = destname
-            self.tmpname = destname + ".tmp"
-        def __enter__(self):
-            # rename works here. Return a temporary filename
-            return self.tmpname
-        def __exit__(self, exc_type, exc_val, exc_tb):
-            if exc_type:
-                # error
-                try:
-                    os.remove(self.tmpname)
-                except Exception, e:
-                    logging.warning("An error was raised, so I was doing "
-                            "some cleanup first, but I couldn't remove "
-                            "'%s'!", self.tmpname)
-            else:
-                # atomic rename into place
-                os.rename(self.tmpname, self.destname)
-else:
-    class FileReplacer(object):
-        __doc__ = doc
-        def __init__(self, destname):
-            self.destname = destname
-        def __enter__(self):
-            return self.destname
-        def __exit__(self, exc_type, exc_val, exc_tb):
-            return
-del renameworks
-
-# Logging related classes are below
-
-# Some cool code for colored logging:
-# For background, add 40. For foreground, add 30
-BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE = range(8)
-
-RESET_SEQ = "\033[0m"
-COLOR_SEQ = "\033[1;%dm"
-BOLD_SEQ = "\033[1m"
-
-# Windows colors, taken from WinCon.h
-FOREGROUND_BLUE   = 0x01
-FOREGROUND_GREEN  = 0x02
-FOREGROUND_RED    = 0x04
-FOREGROUND_BOLD   = 0x08
-FOREGROUND_WHITE  = FOREGROUND_BLUE | FOREGROUND_GREEN | FOREGROUND_RED
-
-BACKGROUND_BLACK  = 0x00
-BACKGROUND_BLUE   = 0x10
-BACKGROUND_GREEN  = 0x20
-BACKGROUND_RED    = 0x40
-
-COLORIZE = {
-    #'INFO': WHITe,
-    'DEBUG': CYAN,
-}
-HIGHLIGHT = {
-    'CRITICAL': RED,
-    'ERROR': RED,
-    'WARNING': YELLOW,
-}
-
-
-class WindowsOutputStream(object):
-    """A file-like object that proxies sys.stderr and interprets simple ANSI
-    escape codes for color, translating them to the appropriate Windows calls.
-
-    """
-    def __init__(self, stream=None):
-        assert platform.system() == 'Windows'
-        self.stream = stream or sys.stderr
-
-        # go go gadget ctypes 
-        self.GetStdHandle = ctypes.windll.kernel32.GetStdHandle
-        self.SetConsoleTextAttribute = ctypes.windll.kernel32.SetConsoleTextAttribute
-        self.STD_OUTPUT_HANDLE = ctypes.c_int(0xFFFFFFF5)
-        self.output_handle = self.GetStdHandle(self.STD_OUTPUT_HANDLE)
-        if self.output_handle == 0xFFFFFFFF:
-            raise Exception("Something failed in WindowsColorFormatter")
-
-
-        # default is white text on a black background
-        self.currentForeground = FOREGROUND_WHITE
-        self.currentBackground = BACKGROUND_BLACK
-        self.currentBold       = 0
-
-    def updateWinColor(self, Fore=None, Back=None, Bold=False):
-        if Fore != None: self.currentForeground = Fore
-        if Back != None: self.currentBackground = Back
-        if Bold: 
-            self.currentBold = FOREGROUND_BOLD
-        else:
-            self.currentBold = 0
-
-        self.SetConsoleTextAttribute(self.output_handle,
-                ctypes.c_int(self.currentForeground | self.currentBackground | self.currentBold))
-
-    def write(self, s):
-
-        msg_strm = StringIO(s) 
-    
-        while (True):
-            c = msg_strm.read(1)
-            if c == '': break
-            if c == '\033':
-                c1 = msg_strm.read(1)
-                if c1 != '[': # 
-                    sys.stream.write(c + c1)
-                    continue
-                c2 = msg_strm.read(2)
-                if c2 == "0m": # RESET_SEQ
-                    self.updateWinColor(Fore=FOREGROUND_WHITE, Back=BACKGROUND_BLACK)
-
-                elif c2 == "1;":
-                    color = ""
-                    while(True):
-                        nc = msg_strm.read(1)
-                        if nc == 'm': break
-                        color += nc
-                    color = int(color) 
-                    if (color >= 40): # background
-                        color = color - 40
-                        if color == BLACK:
-                            self.updateWinColor(Back=BACKGROUND_BLACK)
-                        if color == RED:
-                            self.updateWinColor(Back=BACKGROUND_RED)
-                        elif color == GREEN:
-                            self.updateWinColor(Back=BACKGROUND_GREEN)
-                        elif color == YELLOW:
-                            self.updateWinColor(Back=BACKGROUND_RED | BACKGROUND_GREEN)
-                        elif color == BLUE:
-                            self.updateWinColor(Back=BACKGROUND_BLUE)
-                        elif color == MAGENTA:
-                            self.updateWinColor(Back=BACKGROUND_RED | BACKGROUND_BLUE)
-                        elif color == CYAN:
-                            self.updateWinColor(Back=BACKGROUND_GREEN | BACKGROUND_BLUE)
-                        elif color == WHITE:
-                            self.updateWinColor(Back=BACKGROUND_RED | BACKGROUND_GREEN | BACKGROUND_BLUE)
-                    elif (color >= 30): # foreground
-                        color = color - 30
-                        if color == BLACK:
-                            self.updateWinColor(Fore=FOREGROUND_BLACK)
-                        if color == RED:
-                            self.updateWinColor(Fore=FOREGROUND_RED)
-                        elif color == GREEN:
-                            self.updateWinColor(Fore=FOREGROUND_GREEN)
-                        elif color == YELLOW:
-                            self.updateWinColor(Fore=FOREGROUND_RED | FOREGROUND_GREEN)
-                        elif color == BLUE:
-                            self.updateWinColor(Fore=FOREGROUND_BLUE)
-                        elif color == MAGENTA:
-                            self.updateWinColor(Fore=FOREGROUND_RED | FOREGROUND_BLUE)
-                        elif color == CYAN:
-                            self.updateWinColor(Fore=FOREGROUND_GREEN | FOREGROUND_BLUE)
-                        elif color == WHITE:
-                            self.updateWinColor(Fore=FOREGROUND_WHITE)
-
-                         
-                    
-                elif c2 == "1m": # BOLD_SEQ
-                    pass
-                
-            else:
-                self.stream.write(c)
-
-
-
-    def flush(self):
-        self.stream.flush()
-
-class HighlightingFormatter(logging.Formatter):
-    """Base class of our custom formatter
-    
-    """
-    datefmt = "%Y-%m-%d %H:%M:%S"
-    funcName_len = 15
-
-    def __init__(self, verbose=False):
-        if verbose:
-            fmtstr = '%(fileandlineno)-18s %(pid)s %(asctime)s ' \
-                    '%(levelname)-8s %(message)s'
-        else:
-            fmtstr = '%(asctime)s ' '%(shortlevelname)-1s%(message)s'
-
-        logging.Formatter.__init__(self, fmtstr, self.datefmt)
-
-    def format(self, record):
-        """Add a few extra options to the record
-
-        pid
-            The process ID
-
-        fileandlineno
-            A combination filename:linenumber string, so it can be justified as
-            one entry in a format string.
-
-        funcName
-            The function name truncated/padded to a fixed width characters
-
-        shortlevelname
-            The level name truncated to 1 character
-        
-        """
-
-        record.shortlevelname = record.levelname[0] + ' ' 
-        if record.levelname == 'INFO': record.shortlevelname = ''
-
-        record.pid = os.getpid()
-        record.fileandlineno = "%s:%s" % (record.filename, record.lineno)
-
-        # Set the max length for the funcName field, and left justify
-        l = self.funcName_len
-        record.funcName = ("%-" + str(l) + 's') % record.funcName[:l]
-
-        return self.highlight(record)
-
-    def highlight(self, record):
-        """This method applies any special effects such as colorization. It
-        should modify the records in the record object, and should return the
-        *formatted line*. This probably involves calling
-        logging.Formatter.format()
-
-        Override this in subclasses
-
-        """
-        return logging.Formatter.format(self, record)
-
-class DumbFormatter(HighlightingFormatter):
-    """Formatter for dumb terminals that don't support color, or log files.
-    Prints a bunch of stars before a highlighted line.
-
-    """
-    def highlight(self, record):
-        if record.levelname in HIGHLIGHT:
-            line = logging.Formatter.format(self, record)
-            line = "*" * min(79,len(line)) + "\n" + line
-            return line
-        else:
-            return HighlightingFormatter.highlight(self, record)
-
-
-class ANSIColorFormatter(HighlightingFormatter):
-    """Uses ANSI escape sequences to enable GLORIOUS EXTRA-COLOR!
-
-    """
-    def highlight(self, record):
-        if record.levelname in COLORIZE:
-            # Colorize just the levelname
-            # left justify again because the color sequence bumps the length up
-            # above 8 chars
-            levelname_color = COLOR_SEQ % (30 + COLORIZE[record.levelname]) + \
-                    "%-8s" % record.levelname + RESET_SEQ
-            record.levelname = levelname_color
-            return logging.Formatter.format(self, record)
-
-        elif record.levelname in HIGHLIGHT:
-            # Colorize the entire line
-            line = logging.Formatter.format(self, record)
-            line = COLOR_SEQ % (40 + HIGHLIGHT[record.levelname]) + line + \
-                    RESET_SEQ
-            return line
-
-        else:
-            # No coloring if it's not to be highlighted or colored
-            return logging.Formatter.format(self, record)
-
-
-def mirror_dir(src, dst, entities=None):
-    '''copies all of the entities from src to dst'''
-    if not os.path.exists(dst):
-        os.mkdir(dst)
-    if entities and type(entities) != list: raise Exception("Expected a list, got a %r instead" % type(entities))
-    
-    # files which are problematic and should not be copied
-    # usually, generated by the OS
-    skip_files = ['Thumbs.db', '.DS_Store']
-    
-    for entry in os.listdir(src):
-        if entry in skip_files:
-            continue
-        if entities and entry not in entities:
-            continue
-        
-        if os.path.isdir(os.path.join(src,entry)):
-            mirror_dir(os.path.join(src, entry), os.path.join(dst, entry))
-        elif os.path.isfile(os.path.join(src,entry)):
-            try:
-                shutil.copy(os.path.join(src, entry), os.path.join(dst, entry))
-            except IOError as outer: 
-                try:
-                    # maybe permission problems?
-                    src_stat = os.stat(os.path.join(src, entry))
-                    os.chmod(os.path.join(src, entry), src_stat.st_mode | stat.S_IRUSR)
-                    dst_stat = os.stat(os.path.join(dst, entry))
-                    os.chmod(os.path.join(dst, entry), dst_stat.st_mode | stat.S_IWUSR)
-                except OSError: # we don't care if this fails
-                    pass
-                shutil.copy(os.path.join(src, entry), os.path.join(dst, entry))
-                # if this stills throws an error, let it propagate up
-
-
 def dict_subset(d, keys):
     "Return a new dictionary that is built from copying select keys from d"
     n = dict()
@@ -498,5 +103,3 @@ def dict_subset(d, keys):
         if key in d:
             n[key] = d[key]
     return n
-
-    

test/test_all.py

@@ -26,9 +26,8 @@ if 0:
             self.lock = None
     root.addHandler(NullHandler())
 else:
-    import overviewer
+    from overviewer_core import logger
-    import logging
+    logger.configure(logging.DEBUG, True)
-    overviewer.configure_logger(logging.DEBUG, True)
 
 
 if __name__ == "__main__":

test/test_rendertileset.py

@@ -1,7 +1,6 @@
 import unittest
 
-from overviewer_core.tileset import RendertileSet
+from overviewer_core.tileset import iterate_base4, RendertileSet
-from overviewer_core.util import iterate_base4
 
 class RendertileSetTest(unittest.TestCase):
     # If you change this definition, you must also change the hard-coded

test/test_tileobj.py

@@ -1,7 +1,6 @@
 import unittest
 
-from overviewer_core.util import iterate_base4
+from overviewer_core.tileset import iterate_base4, RenderTile
-from overviewer_core.tileset import RenderTile
 
 items = [
         ((-4,-8), (0,0)),

test/test_tileset.py

@@ -6,7 +6,7 @@ import os
 import os.path
 import random
 
-from overviewer_core import tileset, util
+from overviewer_core import tileset
 
 # Supporing data
 # chunks list: chunkx, chunkz mapping to chunkmtime
@@ -120,7 +120,7 @@ def get_tile_set(chunks):
     tile_set = defaultdict(int)
     for (chunkx, chunkz), chunkmtime in chunks.iteritems():
 
-        col, row = util.convert_coords(chunkx, chunkz)
+        col, row = tileset.convert_coords(chunkx, chunkz)
 
         for tilec, tiler in tileset.get_tiles_by_chunk(col, row):
             tile = tileset.RenderTile.compute_path(tilec, tiler, 3)