1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
# wikiget - CLI tool for downloading files from Wikimedia sites
# Copyright (C) 2023 Cody Logan
# SPDX-License-Identifier: GPL-3.0-or-later
#
# Wikiget is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Wikiget is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Wikiget. If not, see <https://www.gnu.org/licenses/>.
"""Define a File class for representing individual files to be downloaded."""
from __future__ import annotations
from pathlib import Path
from typing import TYPE_CHECKING
from wikiget import DEFAULT_SITE
if TYPE_CHECKING:
from mwclient.image import Image
class File:
"""A file object."""
def __init__(
self, name: str, dest: str = "", site: str = "", image: Image = None
) -> None:
"""Initialize a new file with the given parameters.
Only the name is required. If a destination isn't specified, the provided name
will be used as the output name, and if no site is given, the default site will
be used (commons.wikimedia.org).
:param name: name of the file
:type name: str
:param dest: output name of the file; if not specified, defaults to name
:type dest: str, optional
:param site: name of the site hosting the file; if not specified, defaults to
the global default site
:type site: str, optional
:param image: mwclient image object retrieved from the host site
:type image: mwclient.image.Image, optional
"""
self.name = name
self.dest = Path(dest) if dest else Path(name)
self.site = site if site else DEFAULT_SITE
self.image = image
def __eq__(self, other: object) -> bool:
"""Compare this File object with another for equality.
:param other: another File to compare
:type other: wikiget.file.File
:return: True if the Files are equal and False otherwise
:rtype: bool
"""
if not isinstance(other, File):
return NotImplemented
return (
self.name == other.name
and self.dest == other.dest
and self.site == other.site
and self.image == other.image
)
def __str__(self) -> str:
"""Return a basic string representation of this class, for str().
:return: string form of the class
:rtype: str
"""
return str(self.__dict__)
def __repr__(self) -> str:
"""Return a formal string representation of this class, for repr().
:return: string form of the class
:rtype: str
"""
attr_list = [self.name, self.dest, self.site]
return '{}("{}", {})'.format(
self.__class__.__name__,
'", "'.join(map(str, attr_list)),
self.image,
)
|
