summaryrefslogtreecommitdiff
path: root/libmat2/abstract.py
diff options
context:
space:
mode:
Diffstat (limited to 'libmat2/abstract.py')
-rw-r--r--libmat2/abstract.py11
1 files changed, 10 insertions, 1 deletions
diff --git a/libmat2/abstract.py b/libmat2/abstract.py
index 41a720a..701ab60 100644
--- a/libmat2/abstract.py
+++ b/libmat2/abstract.py
@@ -6,10 +6,16 @@ assert Set # make pyflakes happy
6 6
7 7
8class AbstractParser(abc.ABC): 8class AbstractParser(abc.ABC):
9 """ This is the base classe of every parser.
10 It might yeild `ValueError` on instanciation on invalid files.
11 """
9 meta_list = set() # type: Set[str] 12 meta_list = set() # type: Set[str]
10 mimetypes = set() # type: Set[str] 13 mimetypes = set() # type: Set[str]
11 14
12 def __init__(self, filename: str) -> None: 15 def __init__(self, filename: str) -> None:
16 """
17 :raises ValueError: Raised upon an invalid file
18 """
13 self.filename = filename 19 self.filename = filename
14 fname, extension = os.path.splitext(filename) 20 fname, extension = os.path.splitext(filename)
15 self.output_filename = fname + '.cleaned' + extension 21 self.output_filename = fname + '.cleaned' + extension
@@ -23,5 +29,8 @@ class AbstractParser(abc.ABC):
23 pass # pragma: no cover 29 pass # pragma: no cover
24 30
25 def remove_all_lightweight(self) -> bool: 31 def remove_all_lightweight(self) -> bool:
26 """ Remove _SOME_ metadata. """ 32 """ This method removes _SOME_ metadata.
33 I might be useful to implement it for fileformats that do
34 not support non-destructive cleaning.
35 """
27 return self.remove_all() 36 return self.remove_all()