Use proper type annotations instead of comments
This commit is contained in:
parent
2ac8c24dac
commit
1b9608aecf
@ -2,14 +2,10 @@
|
|||||||
|
|
||||||
import enum
|
import enum
|
||||||
import importlib
|
import importlib
|
||||||
from typing import Optional, Union, Dict
|
from typing import Dict
|
||||||
|
|
||||||
from . import exiftool, video
|
from . import exiftool, video
|
||||||
|
|
||||||
# make pyflakes happy
|
|
||||||
assert Optional
|
|
||||||
assert Union
|
|
||||||
|
|
||||||
# A set of extension that aren't supported, despite matching a supported mimetype
|
# A set of extension that aren't supported, despite matching a supported mimetype
|
||||||
UNSUPPORTED_EXTENSIONS = {
|
UNSUPPORTED_EXTENSIONS = {
|
||||||
'.asc',
|
'.asc',
|
||||||
@ -68,7 +64,7 @@ CMD_DEPENDENCIES = {
|
|||||||
|
|
||||||
|
|
||||||
def check_dependencies() -> Dict[str, Dict[str, bool]]:
|
def check_dependencies() -> Dict[str, Dict[str, bool]]:
|
||||||
ret = dict() # type: Dict[str, Dict]
|
ret: Dict[str, Dict] = dict()
|
||||||
|
|
||||||
for key, value in DEPENDENCIES.items():
|
for key, value in DEPENDENCIES.items():
|
||||||
ret[key] = {
|
ret[key] = {
|
||||||
|
@ -9,8 +9,8 @@ class AbstractParser(abc.ABC):
|
|||||||
It might yield `ValueError` on instantiation on invalid files,
|
It might yield `ValueError` on instantiation on invalid files,
|
||||||
and `RuntimeError` when something went wrong in `remove_all`.
|
and `RuntimeError` when something went wrong in `remove_all`.
|
||||||
"""
|
"""
|
||||||
meta_list = set() # type: Set[str]
|
meta_list: Set[str] = set()
|
||||||
mimetypes = set() # type: Set[str]
|
mimetypes: Set[str] = set()
|
||||||
|
|
||||||
def __init__(self, filename: str) -> None:
|
def __init__(self, filename: str) -> None:
|
||||||
"""
|
"""
|
||||||
|
@ -49,15 +49,15 @@ class ArchiveBasedAbstractParser(abstract.AbstractParser):
|
|||||||
|
|
||||||
# Those are the files that have a format that _isn't_
|
# Those are the files that have a format that _isn't_
|
||||||
# supported by mat2, but that we want to keep anyway.
|
# supported by mat2, but that we want to keep anyway.
|
||||||
self.files_to_keep = set() # type: Set[Pattern]
|
self.files_to_keep: Set[Pattern] = set()
|
||||||
|
|
||||||
# Those are the files that we _do not_ want to keep,
|
# Those are the files that we _do not_ want to keep,
|
||||||
# no matter if they are supported or not.
|
# no matter if they are supported or not.
|
||||||
self.files_to_omit = set() # type: Set[Pattern]
|
self.files_to_omit: Set[Pattern] = set()
|
||||||
|
|
||||||
# what should the parser do if it encounters an unknown file in
|
# what should the parser do if it encounters an unknown file in
|
||||||
# the archive?
|
# the archive?
|
||||||
self.unknown_member_policy = UnknownMemberPolicy.ABORT # type: UnknownMemberPolicy
|
self.unknown_member_policy: UnknownMemberPolicy = UnknownMemberPolicy.ABORT
|
||||||
|
|
||||||
# The LGTM comment is to mask a false-positive,
|
# The LGTM comment is to mask a false-positive,
|
||||||
# see https://lgtm.com/projects/g/jvoisin/mat2/
|
# see https://lgtm.com/projects/g/jvoisin/mat2/
|
||||||
@ -134,7 +134,7 @@ class ArchiveBasedAbstractParser(abstract.AbstractParser):
|
|||||||
return member
|
return member
|
||||||
|
|
||||||
def get_meta(self) -> Dict[str, Union[str, Dict]]:
|
def get_meta(self) -> Dict[str, Union[str, Dict]]:
|
||||||
meta = dict() # type: Dict[str, Union[str, Dict]]
|
meta: Dict[str, Union[str, Dict]] = dict()
|
||||||
|
|
||||||
with self.archive_class(self.filename) as zin:
|
with self.archive_class(self.filename) as zin:
|
||||||
temp_folder = tempfile.mkdtemp()
|
temp_folder = tempfile.mkdtemp()
|
||||||
@ -174,7 +174,7 @@ class ArchiveBasedAbstractParser(abstract.AbstractParser):
|
|||||||
|
|
||||||
# Sort the items to process, to reduce fingerprinting,
|
# Sort the items to process, to reduce fingerprinting,
|
||||||
# and keep them in the `items` variable.
|
# and keep them in the `items` variable.
|
||||||
items = list() # type: List[ArchiveMember]
|
items: List[ArchiveMember] = list()
|
||||||
for item in sorted(self._get_all_members(zin), key=self._get_member_name):
|
for item in sorted(self._get_all_members(zin), key=self._get_member_name):
|
||||||
# Some fileformats do require to have the `mimetype` file
|
# Some fileformats do require to have the `mimetype` file
|
||||||
# as the first file in the archive.
|
# as the first file in the archive.
|
||||||
|
@ -39,7 +39,7 @@ class MP3Parser(MutagenParser):
|
|||||||
mimetypes = {'audio/mpeg', }
|
mimetypes = {'audio/mpeg', }
|
||||||
|
|
||||||
def get_meta(self) -> Dict[str, Union[str, Dict]]:
|
def get_meta(self) -> Dict[str, Union[str, Dict]]:
|
||||||
metadata = {} # type: Dict[str, Union[str, Dict]]
|
metadata: Dict[str, Union[str, Dict]] = dict()
|
||||||
meta = mutagen.File(self.filename).tags
|
meta = mutagen.File(self.filename).tags
|
||||||
if not meta:
|
if not meta:
|
||||||
return metadata
|
return metadata
|
||||||
|
@ -15,7 +15,7 @@ class ExiftoolParser(abstract.AbstractParser):
|
|||||||
from a import file, hence why several parsers are re-using its `get_meta`
|
from a import file, hence why several parsers are re-using its `get_meta`
|
||||||
method.
|
method.
|
||||||
"""
|
"""
|
||||||
meta_allowlist = set() # type: Set[str]
|
meta_allowlist: Set[str] = set()
|
||||||
|
|
||||||
def get_meta(self) -> Dict[str, Union[str, Dict]]:
|
def get_meta(self) -> Dict[str, Union[str, Dict]]:
|
||||||
try:
|
try:
|
||||||
|
@ -11,9 +11,6 @@ from gi.repository import GdkPixbuf, GLib, Rsvg
|
|||||||
|
|
||||||
from . import exiftool, abstract
|
from . import exiftool, abstract
|
||||||
|
|
||||||
# Make pyflakes happy
|
|
||||||
assert Any
|
|
||||||
|
|
||||||
class SVGParser(exiftool.ExiftoolParser):
|
class SVGParser(exiftool.ExiftoolParser):
|
||||||
mimetypes = {'image/svg+xml', }
|
mimetypes = {'image/svg+xml', }
|
||||||
meta_allowlist = {'Directory', 'ExifToolVersion', 'FileAccessDate',
|
meta_allowlist = {'Directory', 'ExifToolVersion', 'FileAccessDate',
|
||||||
@ -162,7 +159,7 @@ class PPMParser(abstract.AbstractParser):
|
|||||||
mimetypes = {'image/x-portable-pixmap'}
|
mimetypes = {'image/x-portable-pixmap'}
|
||||||
|
|
||||||
def get_meta(self) -> Dict[str, Union[str, Dict]]:
|
def get_meta(self) -> Dict[str, Union[str, Dict]]:
|
||||||
meta = {} # type: Dict[str, Union[str, Dict[Any, Any]]]
|
meta: Dict[str, Union[str, Dict[Any, Any]]] = dict()
|
||||||
with open(self.filename) as f:
|
with open(self.filename) as f:
|
||||||
for idx, line in enumerate(f):
|
for idx, line in enumerate(f):
|
||||||
if line.lstrip().startswith('#'):
|
if line.lstrip().startswith('#'):
|
||||||
|
@ -148,7 +148,7 @@ class MSOfficeParser(ZipParser):
|
|||||||
return False
|
return False
|
||||||
xml_data = zin.read('[Content_Types].xml')
|
xml_data = zin.read('[Content_Types].xml')
|
||||||
|
|
||||||
self.content_types = dict() # type: Dict[str, str]
|
self.content_types: Dict[str, str] = dict()
|
||||||
try:
|
try:
|
||||||
tree = ET.fromstring(xml_data)
|
tree = ET.fromstring(xml_data)
|
||||||
except ET.ParseError:
|
except ET.ParseError:
|
||||||
|
@ -12,7 +12,7 @@ from . import bubblewrap
|
|||||||
class AbstractFFmpegParser(exiftool.ExiftoolParser):
|
class AbstractFFmpegParser(exiftool.ExiftoolParser):
|
||||||
""" Abstract parser for all FFmpeg-based ones, mainly for video. """
|
""" Abstract parser for all FFmpeg-based ones, mainly for video. """
|
||||||
# Some fileformats have mandatory metadata fields
|
# Some fileformats have mandatory metadata fields
|
||||||
meta_key_value_allowlist = {} # type: Dict[str, Union[str, int]]
|
meta_key_value_allowlist: Dict[str, Union[str, int]] = dict()
|
||||||
|
|
||||||
def remove_all(self) -> bool:
|
def remove_all(self) -> bool:
|
||||||
if self.meta_key_value_allowlist:
|
if self.meta_key_value_allowlist:
|
||||||
@ -48,7 +48,7 @@ class AbstractFFmpegParser(exiftool.ExiftoolParser):
|
|||||||
def get_meta(self) -> Dict[str, Union[str, Dict]]:
|
def get_meta(self) -> Dict[str, Union[str, Dict]]:
|
||||||
meta = super().get_meta()
|
meta = super().get_meta()
|
||||||
|
|
||||||
ret = dict() # type: Dict[str, Union[str, Dict]]
|
ret: Dict[str, Union[str, Dict]] = dict()
|
||||||
for key, value in meta.items():
|
for key, value in meta.items():
|
||||||
if key in self.meta_key_value_allowlist:
|
if key in self.meta_key_value_allowlist:
|
||||||
if value == self.meta_key_value_allowlist[key]:
|
if value == self.meta_key_value_allowlist[key]:
|
||||||
|
@ -44,10 +44,10 @@ class CSSParser(abstract.AbstractParser):
|
|||||||
|
|
||||||
|
|
||||||
class AbstractHTMLParser(abstract.AbstractParser):
|
class AbstractHTMLParser(abstract.AbstractParser):
|
||||||
tags_blocklist = set() # type: Set[str]
|
tags_blocklist: Set[str] = set()
|
||||||
# In some html/xml-based formats some tags are mandatory,
|
# In some html/xml-based formats some tags are mandatory,
|
||||||
# so we're keeping them, but are discarding their content
|
# so we're keeping them, but are discarding their content
|
||||||
tags_required_blocklist = set() # type: Set[str]
|
tags_required_blocklist: Set[str] = set()
|
||||||
|
|
||||||
def __init__(self, filename):
|
def __init__(self, filename):
|
||||||
super().__init__(filename)
|
super().__init__(filename)
|
||||||
@ -91,7 +91,7 @@ class _HTMLParser(parser.HTMLParser):
|
|||||||
self.filename = filename
|
self.filename = filename
|
||||||
self.__textrepr = ''
|
self.__textrepr = ''
|
||||||
self.__meta = {}
|
self.__meta = {}
|
||||||
self.__validation_queue = [] # type: list[str]
|
self.__validation_queue: List[str] = list()
|
||||||
|
|
||||||
# We're using counters instead of booleans, to handle nested tags
|
# We're using counters instead of booleans, to handle nested tags
|
||||||
self.__in_dangerous_but_required_tag = 0
|
self.__in_dangerous_but_required_tag = 0
|
||||||
|
4
mat2
4
mat2
@ -36,7 +36,7 @@ def __check_file(filename: str, mode: int = os.R_OK) -> bool:
|
|||||||
__print_without_chars("[-] %s is not a regular file." % filename)
|
__print_without_chars("[-] %s is not a regular file." % filename)
|
||||||
return False
|
return False
|
||||||
elif not os.access(filename, mode):
|
elif not os.access(filename, mode):
|
||||||
mode_str = [] # type: List[str]
|
mode_str: List[str] = list()
|
||||||
if mode & os.R_OK:
|
if mode & os.R_OK:
|
||||||
mode_str += 'readable'
|
mode_str += 'readable'
|
||||||
if mode & os.W_OK:
|
if mode & os.W_OK:
|
||||||
@ -168,7 +168,7 @@ def show_parsers():
|
|||||||
|
|
||||||
|
|
||||||
def __get_files_recursively(files: List[str]) -> List[str]:
|
def __get_files_recursively(files: List[str]) -> List[str]:
|
||||||
ret = set() # type: Set[str]
|
ret: Set[str] = set()
|
||||||
for f in files:
|
for f in files:
|
||||||
if os.path.isdir(f):
|
if os.path.isdir(f):
|
||||||
for path, _, _files in os.walk(f):
|
for path, _, _files in os.walk(f):
|
||||||
|
Loading…
Reference in New Issue
Block a user