Bump version to 0.5.1

[snf-image-creator] / image_creator / output / __init__.py

diff --git a/image_creator/output/__init__.py b/image_creator/output/__init__.py
index 7143785..b4aa7c0 100644 (file)
--- a/image_creator/output/__init__.py
+++ b/image_creator/output/__init__.py
@@ -1,3 +1,5 @@
+# -*- coding: utf-8 -*-
+#
 # Copyright 2012 GRNET S.A. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or
@@ -31,21 +33,41 @@
 # interpreted as representing official policies, either expressed
 # or implied, of GRNET S.A.
 
+"""This package is intended to provide output classes for printing messages and
+progress bars. The user can change the output behaviour of the program by
+subclassing the Output class and assigning the derived one as the output class
+of the various parts of the image-creator package.
+"""
+
 
 class Output(object):
+    """A class for printing program output"""
     def error(self, msg, new_line=True):
+        """Print an error"""
         pass
 
     def warn(self, msg, new_line=True):
+        """Print a warning"""
         pass
 
     def success(self, msg, new_line=True):
+        """Print msg after an action is completed"""
         pass
 
     def output(self, msg='', new_line=True):
+        """Print normal program output"""
+        pass
+
+    def cleanup(self):
+        """Cleanup this output class"""
+        pass
+
+    def clear(self):
+        """Clear the screen"""
         pass
 
     def _get_progress(self):
+        """Returns a new Progress object"""
         progress = self._Progress
         progress.output = self
         return progress
@@ -53,20 +75,26 @@ class Output(object):
     Progress = property(_get_progress)
 
     class _Progress(object):
+        """Internal progress bar class"""
         def __init__(self, size, title, bar_type='default'):
             self.size = size
-            self.output.output("%s..." % title, False)
+            self.bar_type = bar_type
+            self.output.output("%s ..." % title, False)
 
         def goto(self, dest):
+            """Move progress to a specific position"""
             pass
 
         def next(self):
+            """Move progress a step forward"""
             pass
 
         def success(self, result):
+            """Print a msg after an action is completed successfully"""
             self.output.success(result)
 
     def progress_generator(self, message):
+        """A python generator for the progress bar class"""
         def generator(n):
             progressbar = self.Progress(n, message)