Source code for rios.cuiprogress

"""
Progress bars using CUI interface. 
"""
# This file is part of RIOS - Raster I/O Simplification
# Copyright (C) 2012  Sam Gillingham, Neil Flood
#
# This program 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.
#
# This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.

import sys
from osgeo.gdal import TermProgress_nocb


[docs]class CUIProgressBar(object):
    """
    Simple progress as a percentage pronted to the terminal
    """
    def __init__(self):
        self.totalsteps = 100

[docs]    def setTotalSteps(self, steps):
        self.totalsteps = steps

[docs]    def setProgress(self, progress):
        if hasattr(sys.stdout, 'isatty') and sys.stdout.isatty():  # don't write if a log file etc
            progress = int(float(progress) / self.totalsteps * 100)
            sys.stdout.write('%d%%\r' % progress)

[docs]    def reset(self):
        sys.stdout.write('\n')

[docs]    def setLabelText(self, text):
        sys.stdout.write('\n%s\n' % text)

[docs]    def wasCancelled(self):
        return False

[docs]    def displayException(self, trace):
        sys.stdout.write(trace)

[docs]    def displayWarning(self, text):
        sys.stdout.write("Warning: %s\n" % text)

[docs]    def displayError(self, text):
        sys.stdout.write("Error: %s\n" % text)

[docs]    def displayInfo(self, text):
        sys.stdout.write("Info: %s\n" % text)


[docs]class GDALProgressBar(object):
    """
    Uses GDAL's TermProgress to print a progress bar to the terminal
    """
    def __init__(self):
        self.totalsteps = 100

[docs]    def setTotalSteps(self, steps):
        self.totalsteps = steps

[docs]    def setProgress(self, progress):
        if hasattr(sys.stdout, 'isatty') and sys.stdout.isatty():  # don't write if a log file etc
            TermProgress_nocb(float(progress) / self.totalsteps)

[docs]    def reset(self):
        if hasattr(sys.stdout, 'isatty') and sys.stdout.isatty():  # don't write if a log file etc
            TermProgress_nocb(100.0)
        sys.stdout.write('\n')

[docs]    def setLabelText(self, text):
        sys.stdout.write('\n%s\n' % text)

[docs]    def wasCancelled(self):
        return False

[docs]    def displayException(self, trace):
        sys.stdout.write(trace)

[docs]    def displayWarning(self, text):
        sys.stdout.write("Warning: %s\n" % text)

[docs]    def displayError(self, text):
        sys.stdout.write("Error: %s\n" % text)

[docs]    def displayInfo(self, text):
        sys.stdout.write("Info: %s\n" % text)


[docs]class SilentProgress(object):
    """
    A progress object which is completely silent. 
    """
    def __init__(self):
        pass

[docs]    def setTotalSteps(self, steps):
        pass

[docs]    def setProgress(self, progress):
        pass

[docs]    def reset(self):
        pass

[docs]    def setLabelText(self, text):
        pass

[docs]    def wasCancelled(self):
        return False

[docs]    def displayException(self, trace):
        pass

[docs]    def displayWarning(self, text):
        pass

[docs]    def displayError(self, text):
        pass

[docs]    def displayInfo(self, text):
        pass