-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy path__main__.py
More file actions
281 lines (244 loc) · 9.87 KB
/
__main__.py
File metadata and controls
281 lines (244 loc) · 9.87 KB
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
import logging
from datetime import date
from enum import Enum
from pathlib import Path
from platform import python_version
from typing import Annotated
from comicfn2dict import comicfn2dict
from typer import Argument, Context, Exit, Option, Typer
from perdoo import __version__, get_cache_root, setup_logging
from perdoo.cli import archive_app, settings_app
from perdoo.comic import SUPPORTED_IMAGE_EXTENSIONS, Comic, ComicArchiveError, ComicMetadataError
from perdoo.console import CONSOLE
from perdoo.metadata import ComicInfo, MetronInfo
from perdoo.metadata.comic_info import Page
from perdoo.metadata.metron_info import Id, InformationSource
from perdoo.services import BaseService, Comicvine, Metron
from perdoo.settings import Service, Services, Settings
from perdoo.utils import (
IssueSearch,
Search,
SeriesSearch,
delete_empty_folders,
list_files,
recursive_delete,
)
app = Typer(help="CLI tool for managing comic collections and settings.")
app.add_typer(archive_app, name="archive")
app.add_typer(settings_app, name="settings")
LOGGER = logging.getLogger("perdoo")
class SyncOption(Enum):
FORCE = "Force"
OUTDATED = "Outdated"
SKIP = "Skip"
@staticmethod
def load(value: str) -> "SyncOption":
for entry in SyncOption:
if entry.value.casefold() == value.casefold():
return entry
raise ValueError(f"'{value}' isn't a valid SyncOption")
@app.callback(invoke_without_command=True)
def common(
ctx: Context,
version: Annotated[
bool | None, Option("--version", is_eager=True, help="Show the version and exit.")
] = None,
) -> None:
if ctx.invoked_subcommand:
return
if version:
CONSOLE.print(f"Perdoo v{__version__}")
raise Exit
def get_services(settings: Services) -> dict[Service, BaseService]:
output = {}
if settings.comicvine.api_key:
output[Service.COMICVINE] = Comicvine(settings.comicvine)
if settings.metron.username and settings.metron.password:
output[Service.METRON] = Metron(settings.metron)
return output
def _load_comics(target: Path) -> list[Comic]:
comics = []
files = list_files(target) if target.is_dir() else [target]
for file in files:
try:
comics.append(Comic(file=file))
except (ComicArchiveError, ComicMetadataError) as err: # noqa: PERF203
LOGGER.error("Failed to load '%s' as a Comic: %s", file, err)
return comics
def _get_id_value(ids: list[Id], source: InformationSource) -> str | None:
return next((x.value for x in ids if x.source == source), None)
def _create_search_from_metron(metron_info: MetronInfo) -> Search:
series_id = metron_info.series.id
source = next((x.source for x in metron_info.ids if x.primary), None)
return Search(
series=SeriesSearch(
name=metron_info.series.name,
volume=metron_info.series.volume,
year=metron_info.series.start_year,
comicvine=series_id if source == InformationSource.COMIC_VINE else None,
metron=series_id if source == InformationSource.METRON else None,
),
issue=IssueSearch(
number=metron_info.number,
comicvine=_get_id_value(metron_info.ids, InformationSource.COMIC_VINE),
metron=_get_id_value(metron_info.ids, InformationSource.METRON),
),
)
def _create_search_from_comic_info(comic_info: ComicInfo, filename: str) -> Search:
volume = comic_info.volume if comic_info.volume else None
year = volume if volume and volume > 1900 else None
volume = volume if volume and volume < 1900 else None
return Search(
series=SeriesSearch(name=comic_info.series or filename, volume=volume, year=year),
issue=IssueSearch(number=comic_info.number),
)
def _create_search_from_filename(filename: str) -> Search:
series_name = comicfn2dict(filename).get("series", filename).replace("-", " ")
return Search(series=SeriesSearch(name=series_name), issue=IssueSearch())
def get_search_details(
metadata: tuple[MetronInfo | None, ComicInfo | None], filename: str
) -> Search:
metron_info, comic_info = metadata
if metron_info and metron_info.series and metron_info.series.name:
return _create_search_from_metron(metron_info=metron_info)
if comic_info and comic_info.series:
return _create_search_from_comic_info(comic_info=comic_info, filename=filename)
return _create_search_from_filename(filename=filename)
def load_page_info(entry: Comic, comic_info: ComicInfo) -> list[Page]:
pages = set()
image_files = [
x
for x in entry.archive.get_filename_list()
if Path(x).suffix.lower() in SUPPORTED_IMAGE_EXTENSIONS
]
for idx, file in enumerate(image_files):
img_file = Path(file)
is_final_page = idx == len(image_files) - 1
page = next((x for x in comic_info.pages if x.image == idx), None)
pages.add(Page.from_path(file=img_file, index=idx, is_final_page=is_final_page, page=page))
return sorted(pages)
def sync_metadata(
search: Search, services: dict[Service, BaseService | None], settings: Settings
) -> tuple[MetronInfo | None, ComicInfo | None]:
for service_name in settings.services.order:
if service := services.get(service_name):
LOGGER.info("Searching %s for matching issue", type(service).__name__)
metron_info, comic_info = service.fetch(search=search)
if metron_info or comic_info:
return metron_info, comic_info
return None, None
@app.command(name="import", help="Import comics into your collection using Perdoo.")
def run(
target: Annotated[
Path,
Argument(
exists=True, help="Import comics from the specified file/folder.", show_default=False
),
],
skip_convert: Annotated[
bool, Option("--skip-convert", help="Skip converting comics to the configured format.")
] = False,
sync: Annotated[
SyncOption,
Option(
"--sync",
"-s",
case_sensitive=False,
help="Sync ComicInfo/MetronInfo with online services.",
),
] = SyncOption.OUTDATED,
skip_clean: Annotated[
bool,
Option(
"--skip-clean",
help="Skip removing any files not listed in the 'image_extensions' setting.",
),
] = False,
skip_rename: Annotated[
bool,
Option(
"--skip-rename",
help="Skip organizing and renaming comics based on their MetronInfo/ComicInfo.",
),
] = False,
clean_cache: Annotated[
bool,
Option(
"--clean",
"-c",
show_default=False,
help="Clean the cache before starting the synchronization process. "
"Removes all cached files.",
),
] = False,
debug: Annotated[
bool, Option("--debug", help="Enable debug mode to show extra information.")
] = False,
) -> None:
setup_logging(debug=debug)
LOGGER.info("Python v%s", python_version())
LOGGER.info("Perdoo v%s", __version__)
settings = Settings.load()
settings.save()
if debug:
CONSOLE.print(
{
"target": target,
"flags.skip-convert": skip_convert,
"flags.sync": sync,
"flags.skip-clean": skip_clean,
"flags.skip-rename": skip_rename,
"flags.clean-cache": clean_cache,
}
)
if clean_cache:
LOGGER.info("Cleaning Cache")
recursive_delete(path=get_cache_root())
services = get_services(settings=settings.services)
if not services and sync != SyncOption.SKIP:
LOGGER.warning("No external services configured")
sync = SyncOption.SKIP
comics = _load_comics(target=target)
for index, entry in enumerate(comics):
CONSOLE.rule(
f"[{index + 1}/{len(comics)}] Importing {entry.path.name}",
align="left",
style="subtitle",
)
if not skip_convert:
with CONSOLE.status(
f"Converting to '{settings.output.format}'", spinner="simpleDotsScrolling"
):
entry.convert(extension=settings.output.format)
metadata: tuple[MetronInfo | None, ComicInfo | None] = (entry.metron_info, entry.comic_info)
if sync != SyncOption.SKIP:
search = get_search_details(metadata=metadata, filename=entry.path.stem)
search.filename = entry.path.stem
last_modified = date(1900, 1, 1)
if sync == SyncOption.OUTDATED:
metron_info, _ = metadata
if metron_info and metron_info.last_modified:
last_modified = metron_info.last_modified.date()
if (date.today() - last_modified).days >= 28:
metadata = sync_metadata(search=search, services=services, settings=settings)
else:
LOGGER.info("Metadata up-to-date")
if not skip_clean:
with CONSOLE.status("Cleaning Archive", spinner="simpleDotsScrolling"):
entry.clean_archive()
if settings.output.metron_info.create and metadata[0]:
entry.write_metadata(metadata=metadata[0])
if settings.output.comic_info.create and metadata[1]:
metadata[1].pages = (
load_page_info(entry=entry, comic_info=metadata[1])
if settings.output.comic_info.handle_pages
else []
)
entry.write_metadata(metadata=metadata[1])
if not skip_rename:
with CONSOLE.status("Renaming based on metadata", spinner="simpleDotsScrolling"):
entry.rename(naming=settings.output.naming, output_folder=settings.output.folder)
with CONSOLE.status("Cleaning up empty folders"):
delete_empty_folders(folder=target)
if __name__ == "__main__":
app(prog_name="Perdoo")