X-Git-Url: https://code.grnet.gr/git/snf-image-creator/blobdiff_plain/c16850ae1ce37e8fed14320c55233e272bed4e69..5a380da9c7d19260ec8c033ae8b28b2f1c647d96:/image_creator/util.py

diff --git a/image_creator/util.py b/image_creator/util.py
index 8730143..fb0d0fa 100644
--- a/image_creator/util.py
+++ b/image_creator/util.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,7 +33,10 @@
 # interpreted as representing official policies, either expressed
 # or implied, of GRNET S.A.
 
-import sys
+"""This module provides various helper functions to be used by other parts of
+the package.
+"""
+
 import sh
 import hashlib
 import time
@@ -39,10 +44,12 @@ import os
 
 
 class FatalError(Exception):
+    """Fatal Error exception of snf-image-creator"""
     pass
 
 
 def get_command(command):
+    """Return a file system binary command"""
     def find_sbin_command(command, exception):
         search_paths = ['/usr/local/sbin', '/usr/sbin', '/sbin']
         for fullpath in map(lambda x: "%s/%s" % (x, command), search_paths):
@@ -52,12 +59,12 @@ def get_command(command):
 
     try:
         return sh.__getattr__(command)
-    except sh.CommadNotFount as e:
+    except sh.CommandNotFound as e:
         return find_sbin_command(command, e)
 
 
 def try_fail_repeat(command, *args):
-
+    """Execute a command multiple times until it succeeds"""
     times = (0.1, 0.5, 1, 2)
     i = iter(times)
     while True:
@@ -75,15 +82,19 @@ def try_fail_repeat(command, *args):
 
 
 def free_space(dirname):
+    """Compute the free space in a directory"""
     stat = os.statvfs(dirname)
     return stat.f_bavail * stat.f_frsize
 
 
 class MD5:
+    """Represents MD5 computations"""
     def __init__(self, output):
+        """Create an MD5 instance"""
         self.out = output
 
     def compute(self, filename, size):
+        """Compute the MD5 checksum of a file"""
         MB = 2 ** 20
         BLOCKSIZE = 4 * MB  # 4MB