diff options
| author | jvoisin | 2013-10-27 23:01:20 +0000 |
|---|---|---|
| committer | jvoisin | 2013-10-27 23:01:20 +0000 |
| commit | 4c81e731a485d3ea84049ef6d568153c8b10e90b (patch) | |
| tree | 86ad43d7df67ed8d27cfbe7ff60dda1545784845 /MAT/archive.py | |
| parent | 6f21743fdae533d7a94f64fb03d706fb342aff01 (diff) | |
Improves documentation
Diffstat (limited to 'MAT/archive.py')
| -rw-r--r-- | MAT/archive.py | 25 |
1 files changed, 11 insertions, 14 deletions
diff --git a/MAT/archive.py b/MAT/archive.py index 447f068..f07e18c 100644 --- a/MAT/archive.py +++ b/MAT/archive.py | |||
| @@ -1,21 +1,19 @@ | |||
| 1 | ''' | 1 | ''' Take care of archives formats |
| 2 | Take care of archives formats | ||
| 3 | ''' | 2 | ''' |
| 4 | 3 | ||
| 5 | import zipfile | ||
| 6 | import shutil | ||
| 7 | import os | ||
| 8 | import logging | 4 | import logging |
| 5 | import os | ||
| 6 | import shutil | ||
| 9 | import tempfile | 7 | import tempfile |
| 8 | import zipfile | ||
| 10 | 9 | ||
| 11 | import parser | ||
| 12 | import mat | 10 | import mat |
| 11 | import parser | ||
| 13 | import tarfile | 12 | import tarfile |
| 14 | 13 | ||
| 15 | 14 | ||
| 16 | class GenericArchiveStripper(parser.GenericParser): | 15 | class GenericArchiveStripper(parser.GenericParser): |
| 17 | ''' | 16 | ''' Represent a generic archive |
| 18 | Represent a generic archive | ||
| 19 | ''' | 17 | ''' |
| 20 | def __init__(self, filename, parser, mime, backup, is_writable, **kwargs): | 18 | def __init__(self, filename, parser, mime, backup, is_writable, **kwargs): |
| 21 | super(GenericArchiveStripper, self).__init__(filename, parser, mime, backup, is_writable, **kwargs) | 19 | super(GenericArchiveStripper, self).__init__(filename, parser, mime, backup, is_writable, **kwargs) |
| @@ -24,8 +22,7 @@ class GenericArchiveStripper(parser.GenericParser): | |||
| 24 | self.tempdir = tempfile.mkdtemp() | 22 | self.tempdir = tempfile.mkdtemp() |
| 25 | 23 | ||
| 26 | def __del__(self): | 24 | def __del__(self): |
| 27 | ''' | 25 | ''' Remove the files inside the temp dir, |
| 28 | Remove the files inside the temp dir, | ||
| 29 | then remove the temp dir | 26 | then remove the temp dir |
| 30 | ''' | 27 | ''' |
| 31 | for root, dirs, files in os.walk(self.tempdir): | 28 | for root, dirs, files in os.walk(self.tempdir): |
| @@ -35,16 +32,16 @@ class GenericArchiveStripper(parser.GenericParser): | |||
| 35 | shutil.rmtree(self.tempdir) | 32 | shutil.rmtree(self.tempdir) |
| 36 | 33 | ||
| 37 | def remove_all(self): | 34 | def remove_all(self): |
| 35 | ''' Virtual method to remove all metadata | ||
| 36 | ''' | ||
| 38 | raise NotImplementedError | 37 | raise NotImplementedError |
| 39 | 38 | ||
| 40 | 39 | ||
| 41 | class ZipStripper(GenericArchiveStripper): | 40 | class ZipStripper(GenericArchiveStripper): |
| 42 | ''' | 41 | ''' Represent a zip file |
| 43 | Represent a zip file | ||
| 44 | ''' | 42 | ''' |
| 45 | def is_file_clean(self, fileinfo): | 43 | def is_file_clean(self, fileinfo): |
| 46 | ''' | 44 | ''' Check if a ZipInfo object is clean of metadatas added |
| 47 | Check if a ZipInfo object is clean of metadatas added | ||
| 48 | by zip itself, independently of the corresponding file metadatas | 45 | by zip itself, independently of the corresponding file metadatas |
| 49 | ''' | 46 | ''' |
| 50 | if fileinfo.comment: | 47 | if fileinfo.comment: |
