Add scoped library schedule modes by YozoraXCII · Pull Request #3466 · Kometa-Team/Kometa

YozoraXCII · 2026-08-03T11:51:57Z

What type of PR is this?

Bug Fix (non-breaking change which fixes an issue)
Feature/Tweak (non-breaking change which adds new functionality or enhances existing functionality)
Breaking Change (fix or feature that would break any existing functionality for users)
Documentation Update
Chore (maintenance, dependency bumps, housekeeping - no functional change)
Other

Description

Adds library schedule modes using an explicit YAML list of schedule and mode mappings.

Schedule modifiers

Modifier	What it does	Example
`.not`	Inverts one schedule expression.	`weekly.not(monday)` matches every day except Monday.

Modes

Mode	What it does
`full`	Processes every top-level item in the library.
`added(days)`	Processes items added to Plex within the specified number of days. For TV Show libraries, also includes existing shows with a recently added episode.
`diff`	Processes top-level items whose Plex rating keys were absent from the previous cached library snapshot.
`diff_episode`	TV Show libraries only. Processes newly seen episode rating keys and their parent shows.
`index(A-F)`	Processes titles beginning with the inclusive A–F range.
`index(A-F#)`	Processes A–F plus titles beginning with a number, symbol, or other non-alphabetical character.

Example configuration

libraries:
  Movies:
    schedule:
      - schedule: weekly(monday)
        mode: added(7)
      - schedule: weekly(tuesday)
        mode: index(A-F#)
      - schedule: weekly.not(monday|tuesday)
        mode: full

  TV Shows:
    schedule:
      - schedule: weekly(monday)
        mode: diff_episode
      - schedule: weekly.not(monday)
        mode: full

Related Issues [optional]

Related Issue #
Closes #

Have you updated the Documentation to reflect changes (if necessary)?

Yes
No
Not Applicable

Have you updated the JSON Schema files (if necessary)?

Yes
No
Not Applicable

Have you updated the CHANGELOG.md?

Yes
No

github-actions · 2026-08-03T13:07:51Z

Docker image pushed: kometateam/kometa:library-filters

badja-dev

Two things to possible settle before merge, neither causing the biggest headache:

Schedule list is evaluated twice (config.py at load time, library.py at run time) with two different current_time sources. Worth consolidating to one evaluation
Scope enforcement is spread across three call sites in the Plex/builder code. Would like to see this run against a real library with a list-based collection (imdb_list, trakt_list, etc) on a scoped schedule to confirm nothing outside scheduled_item_keys sneaks through

badja-dev · 2026-08-03T18:37:36Z

library._all_items is accessed directly here to build the cache snapshot, reaching into a "private" attribute on the Plex subclass from kometa.py. Works fine since Plex is the only Library subclass, but might be worth a small accessor method on Library instead, for cleanliness

Addressed. I added Library.get_cached_items() as the public accessor for the unscoped per-run snapshot, and replaced the direct _all_items access in kometa.py.

badja-dev · 2026-08-03T18:38:34Z

filter_and_save_items guards with getattr(self, "library", None) before checking schedule scope. Is there a real path where a builder has no library set, or was this just to satisfy a test fixture?
If it's just for the test, might be cleaner to fix the fixture instead of adding a runtime guard for a case that can't happen in a real run

There is a real no-library path: playlist builders. I replaced the generic runtime guard with the explicit not self.playlist condition, and fixed the non-playlist test fixture so it supplies the required library.

badja-dev · 2026-08-03T18:39:29Z

The schedule list gets evaluated here to decide skip_library (using current_time), then evaluated again in library._schedule_item_keys (using a fresh datetime.now()) to pick the actual mode.

Basically, can we calculate the mode once and pass it through, so there is one source of truth?

Addressed. Config loading now selects the first matching schedule mode using the existing current_time, stores it in params["schedule_mode"], and Library only consumes that selected value. It no longer re-evaluates schedules with a separate clock source.

badja-dev · 2026-08-03T18:40:28Z

Scope is enforced in get_all, search, exact_search, and filter_and_save_items.
With how cumbersome builder.py is, is there a fetch path (direct rating-key lookup, list-based collection sources, etc) that could pull in an item outside scheduled_item_keys and skip these checks?

Added a regression test for the direct ratingKey path used after list builders resolve IDs. It fetches an item outside scheduled_item_keys and verifies filter_and_save_items excludes it. This is the shared final path for list-derived IDs, including IMDb/Trakt list results. I haven’t run it against a live Plex library from this environment.

badja-dev · 2026-08-03T18:41:06Z

Added a regression test for the direct ratingKey path used after list builders resolve IDs. It fetches an item outside scheduled_item_keys and verifies filter_and_save_items excludes it. This is the shared final path for list-derived IDs, including IMDb/Trakt list results. I haven’t run it against a live Plex library from this environment.

… into library-filters # Conflicts: # CHANGELOG.md

YozoraXCII · 2026-08-05T20:50:34Z

@badja-dev to re-review please

badja-dev

LGTM

YozoraXCII added 4 commits August 3, 2026 12:48

Add scoped library schedule modes

bde93b6

tweak wording

d5f297c

flake8

b936ad1

perf

2e993a1

YozoraXCII added the docker Build Pull Request in Docker label Aug 3, 2026

YozoraXCII requested a review from badja-dev August 3, 2026 13:15

badja-dev requested changes Aug 3, 2026

View reviewed changes

YozoraXCII and others added 4 commits August 3, 2026 20:15

Push fixes following badja review

179a66a

Merge branch 'nightly' into library-filters

9c21341

tests

a86be4e

Merge branch 'library-filters' of https://github.com/Kometa-Team/Kometa…

da20375

… into library-filters # Conflicts: # CHANGELOG.md

Merge branch 'nightly' into library-filters

c501afc

badja-dev approved these changes Aug 10, 2026

View reviewed changes

Merge branch 'nightly' into library-filters

be5055f

Uh oh!

Uh oh!

Conversation

YozoraXCII commented Aug 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What type of PR is this?

Description

Schedule modifiers

Modes

Example configuration

Related Issues [optional]

Have you updated the Documentation to reflect changes (if necessary)?

Have you updated the JSON Schema files (if necessary)?

Have you updated the CHANGELOG.md?

Uh oh!

github-actions Bot commented Aug 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

badja-dev left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

YozoraXCII commented Aug 5, 2026

Uh oh!

badja-dev left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

YozoraXCII commented Aug 3, 2026 •

edited

Loading

github-actions Bot commented Aug 3, 2026 •

edited

Loading