From 5715ba52f2238af513b0b87f4aa3c0158d2c84ba Mon Sep 17 00:00:00 2001
From: jvoisin
Date: Sat, 30 Jul 2011 21:47:31 +0200
Subject: Documentation, and removal of unnecessary imports

---
 lib/archive.py | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

(limited to 'lib/archive.py')

diff --git a/lib/archive.py b/lib/archive.py
index f9e4dba..108134c 100644
--- a/lib/archive.py
+++ b/lib/archive.py
@@ -1,3 +1,6 @@
+'''
+    Take care of archives formats
+'''
 import tarfile
 import zipfile
 
@@ -67,6 +70,9 @@ class ZipStripper(GenericArchiveStripper):
             return True
 
     def is_clean(self):
+        '''
+            Check if the given file is clean from harmful metadata
+        '''
         zipin = zipfile.ZipFile(self.filename, 'r')
         if zipin.comment != '':
             logging.debug('%s has a comment' % self.filename)
@@ -154,6 +160,9 @@ harmless format' % item.filename)
 
 
 class TarStripper(GenericArchiveStripper):
+    '''
+        Represent a tarfile archive
+    '''
     def _remove(self, current_file):
         '''
             remove the meta added by tar itself to the file
@@ -209,6 +218,9 @@ class TarStripper(GenericArchiveStripper):
             return True
 
     def is_clean(self):
+        '''
+            Check if the file is clean from harmful metadatas
+        '''
         tarin = tarfile.open(self.filename, 'r' + self.compression)
         for item in tarin.getmembers():
             if not self.is_file_clean(item):
@@ -233,6 +245,9 @@ class TarStripper(GenericArchiveStripper):
         return True
 
     def get_meta(self):
+        '''
+            Return a dict with all the meta of the file
+        '''
         tarin = tarfile.open(self.filename, 'r' + self.compression)
         metadata = {}
         for current_file in tarin.getmembers():
-- 
cgit v1.3