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 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595
|
"""Readarr Models."""
# pylint: disable=invalid-name, too-many-instance-attributes
from __future__ import annotations
from dataclasses import dataclass, field
from datetime import datetime
from enum import Enum
from ..const import AUTHOR_ID, PATH, TITLE
from .base import BaseModel
from .readarr_common import (
_ReadarrAddOptions,
_ReadarrAudioTags,
_ReadarrAuthorAddOptions,
_ReadarrAuthorBase,
_ReadarrAuthorStatistics,
_ReadarrBlocklistFilter,
_ReadarrBlocklistRecord,
_ReadarrBookCommon,
_ReadarrBookFileMediaInfo,
_ReadarrCategory,
_ReadarrEditionsValue,
_ReadarrImage,
_ReadarrMetadataProfileValue,
_ReadarrParsedBookInfo,
_ReadarrRating,
_ReadarrSearchAuthor,
_ReadarrSeriesLinks2,
)
from .request_common import (
_Common2,
_Common3,
_Common4,
_Common6,
_Common8,
_Editor,
_Fields,
_HistoryData,
_ImportListCommon,
_Link,
_ManualImport,
_Notification,
_Quality,
_QualityCommon,
_RecordCommon,
_ReleaseCommon,
_Rename,
_RetagChange,
_RootFolderExended,
_StatusMessage,
_TagDetails,
)
class ReadarrBookTypes(str, Enum):
"""Readarr book types."""
ASIN = "asin"
GOODREADS = "goodreads"
ISBN = "isbn"
class ReadarrCommands(str, Enum):
"""Readarr commands."""
APP_UPDATE_CHECK = "ApplicationUpdateCheck"
AUTHOR_SEARCH = "AuthorSearch"
BOOK_SEARCH = "BookSearch"
REFRESH_AUTHOR = "RefreshAuthor"
REFRESH_BOOK = "RefreshBook"
RENAME_AUTHOR = "RenameAuthor"
RESCAN_FOLDERS = "RescanFolders"
class ReadarrEventType(Enum):
"""Readarr event types."""
BOOK_IMPORTED = 3
DELETED = 5
DOWNLOAD_FAILED = 4
DOWNLOAD_IMPORTED = 8
GRABBED = 1
IGNORED = 7
IMPORT_FAILED = 7
RENAMED = 6
RETAGGED = 9
class ReadarrImportListType(str, Enum):
"""Readarr import list types."""
PROGRAM = "program"
GOODREADS = "goodreads"
OTHER = "other"
class ReadarrSortKeys(str, Enum):
"""Readarr sort keys."""
AUTHOR_ID = AUTHOR_ID
BOOK_ID = "Books.Id"
DATE = "books.releaseDate"
DOWNLOAD_CLIENT = "downloadClient"
ID = "id"
INDEXER = "indexer"
MESSAGE = "message"
PATH = PATH
PROGRESS = "progress"
PROTOCOL = "protocol"
QUALITY = "quality"
RATINGS = "ratings"
SIZE = "size"
SOURCE_TITLE = "sourcetitle"
STATUS = "status"
TIMELEFT = "timeleft"
TITLE = TITLE
@dataclass(init=False)
class ReadarrAuthor(_ReadarrAuthorBase):
"""Readarr author attributes."""
@dataclass(init=False)
class ReadarrBook(_ReadarrBookCommon):
"""Readarr book attributes."""
author: type[ReadarrAuthor] = field(default=ReadarrAuthor)
authorId: int
authorTitle: str
disambiguation: str
editions: list[_ReadarrEditionsValue] | None = None
grabbed: bool
images: list[_ReadarrImage] | None = None
overview: str
pageCount: int
remoteCover: str
seriesTitle: str
statistics: type[_ReadarrAuthorStatistics] = field(default=_ReadarrAuthorStatistics)
def __post_init__(self):
"""Post init."""
super().__post_init__()
self.author = ReadarrAuthor(self.author)
self.editions = [_ReadarrEditionsValue(x) for x in self.editions or []]
self.images = [_ReadarrImage(image) for image in self.images or []]
self.statistics = _ReadarrAuthorStatistics(self.statistics)
@dataclass(init=False)
class ReadarrAuthorLookup(ReadarrAuthor):
"""Readarr author attributes."""
monitorNewItems: str
@dataclass(init=False)
class ReadarrBlocklist(_RecordCommon):
"""Readarr blocklist attributes."""
filters: list[_ReadarrBlocklistFilter] | None = None
records: list[_ReadarrBlocklistRecord] = field(
default_factory=list[_ReadarrBlocklistRecord]
)
def __post_init__(self):
"""Post init."""
self.filters = [
_ReadarrBlocklistFilter(filter) for filter in self.filters or []
]
self.records = [_ReadarrBlocklistRecord(record) for record in self.records]
@dataclass(init=False)
class ReadarrAuthorEditor(_Editor):
"""Readarr author editor attributes."""
authorIds: list[int]
metadataProfileId: int
@dataclass(init=False)
class ReadarrBookFile(_QualityCommon):
"""Readarr book file attributes."""
audioTags: type[_ReadarrAudioTags] = field(default=_ReadarrAudioTags)
authorId: int
bookId: int
dateAdded: datetime
id: int
mediaInfo: type[_ReadarrBookFileMediaInfo] = field(
default=_ReadarrBookFileMediaInfo
)
path: str
qualityWeight: int
size: int
def __post_init__(self):
"""Post init."""
super().__post_init__()
self.audioTags = _ReadarrAudioTags(self.audioTags)
self.mediaInfo = _ReadarrBookFileMediaInfo(self.mediaInfo)
@dataclass(init=False)
class ReadarrBookFileEditor(BaseModel):
"""Readarr book file attributes."""
bookFileIds: list[int]
quality: type[_Quality] = field(default=_Quality)
def __post_init__(self):
"""Post init."""
self.quality = _Quality(self.quality)
@dataclass(init=False)
class ReadarrBookLookup(_Common6):
"""Readarr book lookup attributes."""
added: datetime
anyEditionOk: bool
author: type[ReadarrAuthor] = field(default=ReadarrAuthor)
authorId: int
authorTitle: str
disambiguation: str
editions: list[_ReadarrEditionsValue] | None = None
foreignBookId: str
genres: list[str]
grabbed: bool
images: list[_ReadarrImage] | None = None
links: list[_Link] | None = None
pageCount: int
ratings: type[_ReadarrRating] = field(default=_ReadarrRating)
releaseDate: datetime
remoteCover: str
seriesTitle: str
title: str
titleSlug: int
def __post_init__(self):
"""Post init."""
super().__post_init__()
self.author = ReadarrAuthor(self.author)
self.editions = [_ReadarrEditionsValue(editn) for editn in self.editions or []]
self.images = [_ReadarrImage(image) for image in self.images or []]
self.links = [_Link(link) for link in self.links or []]
self.ratings = _ReadarrRating(self.ratings)
@dataclass(init=False)
class ReadarrBookshelfAuthorBook(ReadarrBookLookup):
"""Readarr bookshelf author Book attributes."""
addOptions: type[_ReadarrAddOptions] = field(default=_ReadarrAddOptions)
id: int
statistics: type[_ReadarrAuthorStatistics] = field(default=_ReadarrAuthorStatistics)
def __post_init__(self):
"""Post init."""
super().__post_init__()
self.addOptions = _ReadarrAddOptions(self.addOptions)
self.statistics = _ReadarrAuthorStatistics(self.statistics)
@dataclass(init=False)
class ReadarrCalendar(ReadarrBookshelfAuthorBook):
"""Readarr calendar attributes."""
@dataclass(init=False)
class ReadarrBookshelfAuthor(BaseModel):
"""Readarr bookshelf author attributes."""
books: list[ReadarrBookshelfAuthorBook] | None = None
id: int
monitored: bool
def __post_init__(self):
"""Post init."""
self.books = [ReadarrBookshelfAuthorBook(book) for book in self.books or []]
@dataclass(init=False)
class ReadarrBookshelf(BaseModel):
"""Readarr bookshelf attributes."""
authors: list[ReadarrBookshelfAuthor] | None = None
monitoringOptions: type[_ReadarrAuthorAddOptions] = field(
default=_ReadarrAuthorAddOptions
)
def __post_init__(self):
"""Post init."""
self.authors = [ReadarrBookshelfAuthor(author) for author in self.authors or []]
self.monitoringOptions = _ReadarrAuthorAddOptions(self.monitoringOptions)
@dataclass(init=False)
class ReadarrWantedMissing(_RecordCommon):
"""Readarr wanted missing attributes."""
records: list[ReadarrBook] = field(default_factory=list[ReadarrBook])
def __post_init__(self):
"""Post init."""
self.records = [ReadarrBook(record) for record in self.records]
@dataclass(init=False)
class ReadarrWantedCutoff(ReadarrWantedMissing):
"""Readarr wanted cutoff attributes."""
filters: list[_ReadarrBlocklistFilter] | None = None
def __post_init__(self):
"""Post init."""
self.filters = [
_ReadarrBlocklistFilter(filter) for filter in self.filters or []
]
@dataclass(init=False)
class ReadarrMetadataProfile(_ReadarrMetadataProfileValue):
"""Readarr metadata profile attributes."""
@dataclass(init=False)
class ReadarrDevelopmentConfig(BaseModel):
"""Readarr development config attributes."""
consoleLogLevel: str
filterSentryEvents: bool
id: int
logRotate: int
logSql: bool
metadataSource: str
@dataclass(init=False)
class ReadarrBookHistory(_Common2, _QualityCommon):
"""Readarr history record attributes."""
authorId: int
bookId: int
data: type[_HistoryData] = field(default=_HistoryData)
date: datetime
id: int
sourceTitle: str
def __post_init__(self):
"""Post init."""
super().__post_init__()
self.data = _HistoryData(self.data)
@dataclass(init=False)
class ReadarrHistory(_RecordCommon):
"""Readarr history attributes."""
records: list[ReadarrBookHistory] = field(default_factory=list[ReadarrBookHistory])
def __post_init__(self):
"""Post init."""
self.records = [ReadarrBookHistory(record) for record in self.records]
@dataclass(init=False)
class ReadarrImportList(_ImportListCommon, _Common3):
"""Readarr importlist attributes."""
enableAutomaticAdd: bool
fields: list[_Fields] | None = None
implementation: str
implementationName: str
infoLink: str
listType: str
metadataProfileId: int
monitorNewItems: str
qualityProfileId: int
shouldMonitor: str
shouldMonitorExisting: bool
shouldSearch: bool
tags: list[int]
def __post_init__(self):
"""Post init."""
self.fields = [_Fields(field) for field in self.fields or []]
@dataclass(init=False)
class ReadarrMetadataProvider(BaseModel):
"""Readarr metadata provider attributes."""
embedMetadata: bool
id: int
scrubAudioTags: bool
updateCovers: bool
writeAudioTags: str
writeBookTags: str
@dataclass(init=False)
class ReadarrNamingConfig(BaseModel):
"""Readarr naming config attributes."""
authorFolderFormat: str
id: int
includeAuthorName: bool
includeBookTitle: bool
includeQuality: bool
renameBooks: bool
replaceIllegalCharacters: bool
replaceSpaces: bool
standardBookFormat: str
@dataclass(init=False)
class ReadarrNotification(_Common3, _Notification):
"""Readarr notification attributes."""
fields: list[_Fields] | None = None
onBookRetag: bool
onDownloadFailure: bool
onImportFailure: bool
onReleaseImport: bool
supportsOnBookRetag: bool
supportsOnDownloadFailure: bool
supportsOnImportFailure: bool
supportsOnReleaseImport: bool
def __post_init__(self):
"""Post init."""
self.fields = [_Fields(field) for field in self.fields or []]
@dataclass(init=False)
class ReadarrParse(BaseModel):
"""Readarr parse attributes."""
author: type[ReadarrAuthor] = field(default=ReadarrAuthor)
books: list[ReadarrBook] | None = None
id: int
parsedBookInfo: type[_ReadarrParsedBookInfo] = field(default=_ReadarrParsedBookInfo)
title: str
def __post_init__(self):
"""Post init."""
self.author = ReadarrAuthor(self.author)
self.books = [ReadarrBook(book) for book in self.books or []]
self.parsedBookInfo = _ReadarrParsedBookInfo(self.parsedBookInfo)
@dataclass(init=False)
class ReadarrQueueDetail(_Common4, _Common8):
"""Readarr queue detail attributes."""
author: type[ReadarrAuthor] = field(default=ReadarrAuthor)
authorId: int
book: type[ReadarrBook] = field(default=ReadarrBook)
bookId: int
downloadForced: bool
def __post_init__(self):
"""Post init."""
super().__post_init__()
self.author = ReadarrAuthor(self.authorId)
self.book = ReadarrBook(self.book)
self.quality = _Quality(self.quality)
self.statusMessages = [_StatusMessage(x) for x in self.statusMessages or []]
@dataclass(init=False)
class ReadarrQueue(_RecordCommon):
"""Readarr queue attributes."""
records: list[ReadarrQueueDetail] = field(default_factory=list[ReadarrQueueDetail])
def __post_init__(self):
"""Post init."""
self.records = [ReadarrQueueDetail(record) for record in self.records]
@dataclass(init=False)
class ReadarrRelease(_ReleaseCommon):
"""Readarr release attributes."""
authorName: str
bookTitle: str
discography: bool
preferredWordScore: int
quality: type[_Quality] = field(default=_Quality)
def __post_init__(self):
"""Post init."""
super().__post_init__()
self.quality = _Quality(self.quality)
@dataclass(init=False)
class ReadarrRename(_Rename):
"""Readarr rename attributes."""
authorId: int
bookFileId: int
bookId: int
@dataclass(init=False)
class ReadarrRetag(ReadarrRename):
"""Readarr retag attributes."""
changes: list[_RetagChange] | None = None
path: str
trackNumbers: list[int]
def __post_init__(self):
"""Post init."""
self.changes = [_RetagChange(change) for change in self.changes or []]
@dataclass(init=False)
class ReadarrSearch(BaseModel):
"""Readarr search attributes."""
author: type[_ReadarrSearchAuthor] = field(default=_ReadarrSearchAuthor)
foreignId: str
id: int
def __post_init__(self):
"""Post init."""
super().__post_init__()
self.author = _ReadarrSearchAuthor(self.author)
@dataclass(init=False)
class ReadarrSeries(BaseModel):
"""Readarr series attributes."""
description: str
id: int
links: list[_ReadarrSeriesLinks2] | None = None
title: str
def __post_init__(self):
"""Post init."""
self.links = [_ReadarrSeriesLinks2(link) for link in self.links or []]
@dataclass(init=False)
class ReadarrTagDetails(_TagDetails):
"""Readarr tag details attributes."""
authorIds: list[int]
@dataclass(init=False)
class ReadarrManualImport(_ManualImport):
"""Readarr manual import attributes."""
additionalFile: bool
audioTags: type[_ReadarrAudioTags] = field(default=_ReadarrAudioTags)
author: type[ReadarrAuthor] = field(default=ReadarrAuthor)
book: type[ReadarrBook] = field(default=ReadarrBook)
disableReleaseSwitching: bool
foreignEditionId: int
replaceExistingFiles: bool
def __post_init__(self):
"""Post init."""
super().__post_init__()
self.audioTags = _ReadarrAudioTags(self.audioTags)
self.author = ReadarrAuthor(self.author)
self.book = ReadarrBook(self.book)
@dataclass(init=False)
class ReadarrImportListOptions(BaseModel):
"""Readarr import list options attributes."""
options: list[_ReadarrCategory] | None = None
def __post_init__(self):
"""Post init."""
self.options = [_ReadarrCategory(option) for option in self.options or []]
@dataclass(init=False)
class ReadarrRootFolder(_RootFolderExended):
"""Readarr root folder attributes."""
isCalibreLibrary: bool
outputProfile: str
port: int
useSsl: bool
|