File: readarr_common.py

package info (click to toggle)
python-aiopyarr 23.4.0-2
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 2,300 kB
  • sloc: python: 25,335; makefile: 22; javascript: 11
file content (657 lines) | stat: -rw-r--r-- 18,230 bytes parent folder | download
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
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
"""Readarr Common Models. These are only for internal module use."""
# pylint: disable=invalid-name, too-many-instance-attributes
from __future__ import annotations

from dataclasses import dataclass, field
from datetime import datetime

from .base import BaseModel
from .request_common import (
    _Common3,
    _Common5,
    _Common6,
    _Common7,
    _IsLoaded,
    _Link,
    _Quality,
    _Ratings,
    _SelectOption,
    _TitleInfo,
)


@dataclass(init=False)
class _ReadarrCommon(BaseModel):
    """Readarr Common attributes."""

    authorMetadataId: int
    id: int
    links: list[_Link] | None = None
    titleSlug: int

    def __post_init__(self):
        """Post init."""
        self.links = [_Link(link) for link in self.links or []]


@dataclass(init=False)
class _ReadarrCommon2(BaseModel):
    """Readarr Common attributes."""

    foreignAuthorId: str
    genres: list[str]
    overview: str
    sortName: str
    sortNameLastFirst: str
    status: str


@dataclass(init=False)
class _ReadarrRating(_Ratings):
    """Readarr ratings attributes."""

    popularity: float


@dataclass(init=False)
class _ReadarrAddOptions(BaseModel):
    """Readarr add options attributes."""

    addType: str
    searchForNewBook: bool


@dataclass(init=False)
class _ReadarrImage(_Common5):
    """readarr metadata value attributes."""

    extension: str


@dataclass(init=False)
class _ReadarrMetadataValue(_ReadarrCommon2, _Common3):
    """Readarr metadata value attributes."""

    aliases: list[str]
    born: datetime
    died: datetime
    disambiguation: str
    gender: str
    hometown: str
    images: list[_ReadarrImage] | None = None
    links: list[_Link] | None = None
    nameLastFirst: str
    ratings: type[_ReadarrRating] = field(default=_ReadarrRating)
    titleSlug: int

    def __post_init__(self):
        """Post init."""
        super().__post_init__()
        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 _ReadarrAuthorMetadata(_IsLoaded):
    """Readarr author Metadata attributes."""

    value: type[_ReadarrMetadataValue] = field(default=_ReadarrMetadataValue)

    def __post_init__(self):
        """Post init."""
        self.value = _ReadarrMetadataValue(self.value)


@dataclass(init=False)
class _ReadarrAuthorAddOptions(BaseModel):
    """Readarr author add options attributes."""

    booksToMonitor: list[str]
    monitor: str
    monitored: bool
    searchForMissingBooks: bool


@dataclass(init=False)
class _ReadarrQualityItem(_Common3):
    """Readarr quality item attributes."""

    allowed: bool
    items: list  # Currently unknown contents
    quality: type[_Common3] = field(default=_Common3)

    def __post_init__(self):
        """Post init."""
        self.quality = _Common3(self.quality)


@dataclass(init=False)
class _ReadarrQualityProfileValue(_Common3):
    """Readarr quality profile value attributes."""

    cutoff: int
    items: list[_ReadarrQualityItem] | None = None
    upgradeAllowed: bool

    def __post_init__(self):
        """Post init."""
        self.items = [_ReadarrQualityItem(item) for item in self.items or []]


@dataclass(init=False)
class _ReadarrQualityProfile(_IsLoaded):
    """Readarr quality profile attributes."""

    value: type[_ReadarrQualityProfileValue] = field(
        default=_ReadarrQualityProfileValue
    )

    def __post_init__(self):
        """Post init."""
        self.value = _ReadarrQualityProfileValue(self.value)


@dataclass(init=False)
class _ReadarrMetadataProfileValue(_Common3):
    """Readarr metadata profile value attributes."""

    allowedLanguages: str
    ignored: str
    minPages: int
    minPopularity: float
    skipMissingDate: bool
    skipMissingIsbn: bool
    skipPartsAndSets: bool
    skipSeriesSecondary: bool


@dataclass(init=False)
class _ReadarrMetadataProfile(_IsLoaded):
    """Readarr metadata profile attributes."""

    value: type[_ReadarrMetadataProfileValue] = field(
        default=_ReadarrMetadataProfileValue
    )

    def __post_init__(self):
        self.value = _ReadarrMetadataProfileValue(self.value)


@dataclass(init=False)
class _ReadarrAuthorValueBooks(_IsLoaded):
    """Readarr author value books attributes."""

    value: list  # Currently unknown contents


@dataclass(init=False)
class _ReadarrAuthorValueSeriesValue(BaseModel):
    """Readarr author value series value attributes."""

    books: type[_ReadarrAuthorValueBooks] = field(default=_ReadarrAuthorValueBooks)
    description: str
    foreignAuthorId: str
    foreignSeriesId: str
    id: int
    numbered: bool
    primaryWorkCount: int
    title: str
    workCount: int

    def __post_init__(self):
        """Post init."""
        self.books = _ReadarrAuthorValueBooks(self.books)


@dataclass(init=False)
class _ReadarrAuthorValueSeriesLinks(_IsLoaded):
    """Readarr author value series links attributes."""

    value: type[_ReadarrAuthorValueSeriesValue] = field(
        default=_ReadarrAuthorValueSeriesValue
    )

    def __post_init__(self):
        """Post init."""
        self.value = _ReadarrAuthorValueSeriesValue(self.value)


@dataclass(init=False)
class _ReadarrAuthorValueSeries(_IsLoaded):
    """Readarr author value series attributes."""

    value: list[_ReadarrAuthorValueSeriesValue] | None = None

    def __post_init__(self):
        """Post init."""
        self.value = [_ReadarrAuthorValueSeriesValue(item) for item in self.value or []]


@dataclass(init=False)
class _ReadarrCommon3(BaseModel):
    """Readarr common attributes."""

    added: datetime
    cleanName: str
    metadataProfileId: int
    monitored: bool
    path: str
    qualityProfileId: int
    tags: list[int]


@dataclass(init=False)
class _ReadarrAuthorValue(_Common3, _ReadarrCommon3):
    """Readarr author value attributes."""

    addOptions: type[_ReadarrAuthorAddOptions] = field(default=_ReadarrAuthorAddOptions)
    authorMetadataId: int
    books: type[_ReadarrAuthorValueBooks] = field(default=_ReadarrAuthorValueBooks)
    foreignAuthorId: str
    lastInfoSync: datetime
    metadata: type[_ReadarrAuthorMetadata] = field(default=_ReadarrAuthorMetadata)
    metadataProfile: type[_ReadarrMetadataProfile] = field(
        default=_ReadarrMetadataProfile
    )
    qualityProfile: type[_ReadarrQualityProfile] = field(default=_ReadarrQualityProfile)
    rootFolderPath: str
    series: type[_ReadarrAuthorValueSeries] = field(default=_ReadarrAuthorValueSeries)

    def __post_init__(self):
        super().__post_init__()
        self.addOptions = _ReadarrAuthorAddOptions(self.addOptions)
        self.books = _ReadarrAuthorValueBooks(self.books)
        self.metadata = _ReadarrAuthorMetadata(self.metadata)
        self.metadataProfile = _ReadarrMetadataProfile(self.metadataProfile)
        self.qualityProfile = _ReadarrQualityProfile(self.qualityProfile)
        self.series = _ReadarrAuthorValueSeries(self.series)


@dataclass(init=False)
class _ReadarrAuthor(_IsLoaded):
    """Readarr author attributes."""

    value: type[_ReadarrAuthorValue] = field(default=_ReadarrAuthorValue)

    def __post_init__(self):
        """Post init."""
        self.value = _ReadarrAuthorValue(self.value)


@dataclass(init=False)
class _ReadarrEditionsValueBookFilesValueMediaInfo(BaseModel):
    """Reaarr editions value book files value media info attributes."""

    audioBitrate: str
    audioBitRate: str
    audioBits: int
    audioChannels: float
    audioCodec: str
    audioFormat: str
    audioSampleRate: str


@dataclass(init=False)
class _ReadarrEditionsValueBookFilesValue(BaseModel):
    """Readarr editions value book files value attributes."""

    author: type[_ReadarrAuthor] = field(default=_ReadarrAuthor)
    calibreId: int
    dateAdded: datetime
    edition: type[_IsLoaded] = field(default=_IsLoaded)
    editionId: int
    id: int
    mediaInfo: type[_ReadarrEditionsValueBookFilesValueMediaInfo] = field(
        default=_ReadarrEditionsValueBookFilesValueMediaInfo
    )
    modified: datetime
    part: int
    partCount: int
    path: str
    quality: type[_Quality] = field(default=_Quality)
    releaseGroup: str
    sceneName: str
    size: int

    def __post_init__(self):
        """Post init."""
        super().__post_init__()
        self.author = _ReadarrAuthor(self.author)
        self.edition = _IsLoaded(self.edition)
        self.mediaInfo = _ReadarrEditionsValueBookFilesValueMediaInfo(self.mediaInfo)
        self.quality = _Quality(self.quality)


@dataclass(init=False)
class _ReadarrEditionsValueBookFiles(_IsLoaded):
    """Readarr editions value book files attributes."""

    value: list[_ReadarrEditionsValueBookFilesValue] | None = None

    def __post_init__(self):
        """Post init."""
        self.value = [
            _ReadarrEditionsValueBookFilesValue(item) for item in self.value or []
        ]


@dataclass(init=False)
class _ReadarrEditionsValue(_Common6):
    """Readarr editions value attributes."""

    asin: str
    book: type[_IsLoaded] = field(default=_IsLoaded)
    bookFiles: type[_ReadarrEditionsValueBookFiles] = field(
        default=_ReadarrEditionsValueBookFiles
    )
    bookId: int
    disambiguation: str
    foreignEditionId: str
    format: str
    grabbed: bool
    id: int
    images: list[_ReadarrImage] | None = None
    isbn13: str
    isEbook: bool
    language: str
    links: list[_Link] | None = None
    manualAdd: bool
    pageCount: int
    publisher: str
    ratings: type[_ReadarrRating] = field(default=_ReadarrRating)
    releaseDate: datetime
    remoteCover: str
    title: str
    titleSlug: int

    def __post_init__(self):
        """Post init."""
        super().__post_init__()
        self.book = _IsLoaded(self.book)
        self.bookFiles = _ReadarrEditionsValueBookFiles(self.bookFiles)
        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 _ReadarrEditions(_IsLoaded):
    """Readarr editions attributes."""

    value: list[_ReadarrEditionsValue] | None = None

    def __post_init__(self):
        """Post init."""
        self.value = [_ReadarrEditionsValue(item) for item in self.value or []]


@dataclass(init=False)
class _ReadarrSeriesLinksValue(BaseModel):
    """Readarr series links value attributes."""

    book: type[_IsLoaded] = field(default=_IsLoaded)
    bookId: int
    id: int
    isPrimary: bool
    position: str
    series: type[_ReadarrAuthorValueSeriesLinks] = field(
        default=_ReadarrAuthorValueSeriesLinks
    )
    seriesId: int

    def __post_init__(self):
        """Post init."""
        self.book = _IsLoaded(self.book)
        self.series = _ReadarrAuthorValueSeriesLinks(self.series)


@dataclass(init=False)
class _ReadarrSeriesLinks(_IsLoaded):
    """Readarr series links attributes."""

    value: list[_ReadarrSeriesLinksValue] | None = None

    def __post_init__(self):
        """Post init."""
        self.value = [_ReadarrSeriesLinksValue(item) for item in self.value or []]


@dataclass(init=False)
class _ReadarrSeriesLinks2(BaseModel):
    """Readarr series links attributes."""

    bookId: int
    id: int
    position: str
    seriesId: int
    seriesPosition: int


@dataclass(init=False)
class _ReadarrBookCommon(_ReadarrCommon):
    """Readarr book base common attributes."""

    added: datetime
    addOptions: type[_ReadarrAddOptions] = field(default=_ReadarrAddOptions)
    anyEditionOk: bool
    authorMetadata: type[_ReadarrAuthorMetadata] = field(default=_ReadarrAuthorMetadata)
    bookFiles: type[_ReadarrEditionsValueBookFiles] = field(
        default=_ReadarrEditionsValueBookFiles
    )
    cleanTitle: str
    foreignBookId: str
    genres: list[str]
    lastInfoSync: datetime
    monitored: bool
    ratings: type[_ReadarrRating] = field(default=_ReadarrRating)
    releaseDate: datetime
    seriesLinks: type[_ReadarrSeriesLinks] = field(default=_ReadarrSeriesLinks)
    title: str

    def __post_init__(self):
        """Post init."""
        super().__post_init__()
        self.addOptions = _ReadarrAddOptions(self.addOptions)
        self.authorMetadata = _ReadarrAuthorMetadata(self.authorMetadata)
        self.bookFiles = _ReadarrEditionsValueBookFiles(self.bookFiles)
        self.ratings = _ReadarrRating(self.ratings)
        self.seriesLinks = _ReadarrSeriesLinks(self.seriesLinks)


@dataclass(init=False)
class _ReadarrAuthorStatistics(BaseModel):
    """Readarr author statistics attributes."""

    availableBookCount: int
    bookCount: int
    bookFileCount: int
    percentOfBooks: float
    sizeOnDisk: int
    totalBookCount: int


@dataclass(init=False)
class _ReadarrAuthorBook(_ReadarrBookCommon):
    """Readarr author book attributes."""

    author: type[_ReadarrAuthor] = field(default=_ReadarrAuthor)
    editions: type[_ReadarrEditions] = field(default=_ReadarrEditions)

    def __post_init__(self):
        """Post init."""
        super().__post_init__()
        self.author = _ReadarrAuthor(self.author)
        self.editions = _ReadarrEditions(self.editions)


@dataclass(init=False)
class _ReadarrBlocklistFilter(BaseModel):
    """Readarr blocklist attributes."""

    key: str
    value: str


@dataclass(init=False)
class _ReadarrAuthorBase(_ReadarrCommon2, _ReadarrCommon, _ReadarrCommon3):
    """Readarr author attributes."""

    addOptions: type[_ReadarrAuthorAddOptions] = field(default=_ReadarrAuthorAddOptions)
    authorName: str
    authorNameLastFirst: str
    disambiguation: str
    ended: bool
    images: list[_ReadarrImage] | None = None
    lastBook: type[_ReadarrAuthorBook] = field(default=_ReadarrAuthorBook)
    monitorNewItems: str
    nextBook: type[_ReadarrAuthorBook] = field(default=_ReadarrAuthorBook)
    ratings: type[_ReadarrRating] = field(default=_ReadarrRating)
    remotePoster: str
    rootFolderPath: str
    statistics: type[_ReadarrAuthorStatistics] = field(default=_ReadarrAuthorStatistics)

    def __post_init__(self):
        """Post init."""
        super().__post_init__()
        self.addOptions = _ReadarrAuthorAddOptions(self.addOptions)
        self.images = [_ReadarrImage(image) for image in self.images or []]
        self.lastBook = _ReadarrAuthorBook(self.lastBook)
        self.nextBook = _ReadarrAuthorBook(self.nextBook)
        self.ratings = _ReadarrRating(self.ratings)
        self.statistics = _ReadarrAuthorStatistics(self.statistics)


@dataclass(init=False)
class _ReadarrBlocklistRecord(_Common7):
    """Readarr blocklist record attributes."""

    author: type[_ReadarrAuthorBase] = field(default=_ReadarrAuthorBase)
    authorId: int
    bookIds: list[int]
    date: datetime
    message: str
    quality: type[_Quality] = field(default=_Quality)
    sourceTitle: str

    def __post_init__(self):
        """Post init."""
        super().__post_init__()
        self.author = _ReadarrAuthorBase(self.author)
        self.quality = _Quality(self.quality)


@dataclass(init=False)
class _ReadarrCountry(BaseModel):
    """Readarr country attributes."""

    name: str
    twoLetterCode: str


@dataclass(init=False)
class _ReadarrAudioTags(BaseModel):
    """Readarr audio tags attributes."""

    asin: str
    authorMBId: str
    authors: list[str]
    authorTitle: str
    bookMBId: str
    bookTitle: str
    catalogNumber: str
    cleanTitle: str
    country: type[_ReadarrCountry] = field(default=_ReadarrCountry)
    disambiguation: str
    discCount: int
    discNumber: int
    duration: str
    goodreadsId: str
    isbn: str
    label: str
    language: str
    mediaInfo: type[_ReadarrEditionsValueBookFilesValueMediaInfo] = field(
        default=_ReadarrEditionsValueBookFilesValueMediaInfo
    )
    publisher: str
    quality: type[_Quality] = field(default=_Quality)
    recordingMBId: str
    releaseGroup: str
    releaseHash: str
    releaseMBId: str
    seriesIndex: str
    seriesTitle: str
    source: str
    title: str
    trackMBId: str
    trackNumbers: list[int]
    year: int

    def __post_init__(self):
        """Post init."""
        self.country = _ReadarrCountry(self.country)
        self.mediaInfo = _ReadarrEditionsValueBookFilesValueMediaInfo(self.mediaInfo)
        self.quality = _Quality(self.quality)


@dataclass(init=False)
class _ReadarrBookFileMediaInfo(_ReadarrEditionsValueBookFilesValueMediaInfo):
    """Readarr book file media info attributes."""

    id: int


@dataclass(init=False)
class _ReadarrParsedBookInfo(BaseModel):
    """Readarr parsed book info attributes."""

    authorName: str
    authorTitleInfo: type[_TitleInfo] = field(default=_TitleInfo)
    bookTitle: str
    discography: bool
    discographyEnd: int
    discographyStart: int
    quality: type[_Quality] = field(default=_Quality)
    releaseDate: datetime
    releaseGroup: str
    releaseHash: str
    releaseVersion: str

    def __post_init__(self):
        """Post init."""
        super().__post_init__()
        self.authorTitleInfo = _TitleInfo(self.authorTitleInfo)
        self.quality = _Quality(self.quality)


@dataclass(init=False)
class _ReadarrSearchAuthor(_ReadarrCommon2, _ReadarrCommon3):
    """Readarr search author attributes."""

    authorMetadataId: int
    authorName: str
    authorNameLastFirst: str
    ended: bool
    id: int
    images: list[_ReadarrImage] | None = None
    links: list[_Link] | None = None
    monitorNewItems: str
    ratings: type[_ReadarrRating] = field(default=_ReadarrRating)
    remotePoster: str
    statistics: type[_ReadarrAuthorStatistics] = field(default=_ReadarrAuthorStatistics)
    titleSlug: int

    def __post_init__(self):
        """Post init."""
        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)
        self.statistics = _ReadarrAuthorStatistics(self.statistics)


@dataclass(init=False)
class _ReadarrCategory(_SelectOption):
    """Readarr category attributes."""

    hint: str
    parentValue: int