rekordbox-edit 0.6.0.dev40__tar.gz → 0.6.0.dev43__tar.gz

{rekordbox_edit-0.6.0.dev40 → rekordbox_edit-0.6.0.dev43}/.github/workflows/cd.yml

@@ -10,6 +10,7 @@ on:
       - ".agent-style"
       - "logos/**"
       - "**/*.md"
+      - "mkdocs.yml"
       - ".pre-commit-config.yaml"
       - ".readthedocs.yaml"
       - "renovate.json5"

{rekordbox_edit-0.6.0.dev40 → rekordbox_edit-0.6.0.dev43}/CHANGELOG.md

@@ -1,6 +1,9 @@
-## v0.6.0.dev40 (2026-06-11)
+## v0.6.0.dev43 (2026-06-11)
 
 
+- refactor: rename CommandArgs types to CommandRequest
+- docs: open external links in a new tab with an icon
+- docs: render signatures and model fields in api reference
 - docs: add api reference page
 - docs: add convert command page
 - docs: add edit command page

{rekordbox_edit-0.6.0.dev40 → rekordbox_edit-0.6.0.dev43}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rekordbox-edit
-Version: 0.6.0.dev40
+Version: 0.6.0.dev43
 Summary: Tools for managing and modifying a RekordBox library en-masse
 Project-URL: Homepage, https://github.com/jviall/rekordbox-edit
 Project-URL: Repository, https://github.com/jviall/rekordbox-edit

{rekordbox_edit-0.6.0.dev40 → rekordbox_edit-0.6.0.dev43}/docs/api.md

@@ -5,10 +5,10 @@ Everything the CLI does is available from Python. The public surface is the thre
 ```python
 from pyrekordbox import Rekordbox6Database
 from rekordbox_edit.api import search
-from rekordbox_edit.models import SearchArgs
+from rekordbox_edit.models import SearchRequest
 
 db = Rekordbox6Database()
-response = search(db, SearchArgs(artist=["Daft Punk"], format=["flac"], match_all=True))
+response = search(db, SearchRequest(artist=["Daft Punk"], format=["flac"], match_all=True))
 for track in response.tracks:
     print(track.ID, track.Title)
 ```

rekordbox_edit-0.6.0.dev43/docs/stylesheets/extra.css

@@ -0,0 +1,19 @@
+/* External links (opened in a new tab by the open-in-new-tab plugin) get an
+   "open in new" icon. Scoped to content so theme chrome is unaffected. The
+   mask + currentColor keeps the icon in sync with the surrounding text color
+   across light and dark palettes. */
+.md-typeset a[target="_blank"]::after {
+  content: "";
+  display: inline-block;
+  width: 0.7em;
+  height: 0.7em;
+  margin-left: 0.2em;
+  vertical-align: text-top;
+  background-color: currentColor;
+  mask-repeat: no-repeat;
+  mask-size: contain;
+  -webkit-mask-repeat: no-repeat;
+  -webkit-mask-size: contain;
+  mask-image: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M14,3V5H17.59L7.76,14.83L9.17,16.24L19,6.41V10H21V3M19,19H5V5H12V3H5C3.89,3 3,3.9 3,5V19A2,2 0 0,0 5,21H19A2,2 0 0,0 21,19V12H19V19Z"/></svg>');
+  -webkit-mask-image: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M14,3V5H17.59L7.76,14.83L9.17,16.24L19,6.41V10H21V3M19,19H5V5H12V3H5C3.89,3 3,3.9 3,5V19A2,2 0 0,0 5,21H19A2,2 0 0,0 21,19V12H19V19Z"/></svg>');
+}

{rekordbox_edit-0.6.0.dev40 → rekordbox_edit-0.6.0.dev43}/mkdocs.yml

@@ -25,14 +25,19 @@ theme:
 
 plugins:
   - search
+  - open-in-new-tab
   - mkdocstrings:
       handlers:
         python:
           options:
-            filters: ["!^_"]
+            filters: ["!^_", "!^model_config$"]
             show_root_heading: true
             show_source: false
             members_order: source
+            show_if_no_docstring: true
+            show_signature_annotations: true
+            separate_signature: true
+            docstring_section_style: table
 
 markdown_extensions:
   - admonition
@@ -44,6 +49,9 @@ markdown_extensions:
       check_paths: true
   - pymdownx.superfences
 
+extra_css:
+  - stylesheets/extra.css
+
 nav:
   - Getting Started: index.md
   - Filtering: filtering.md

{rekordbox_edit-0.6.0.dev40 → rekordbox_edit-0.6.0.dev43}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "rekordbox-edit"
-version = "0.6.0.dev40"
+version = "0.6.0.dev43"
 description = "Tools for managing and modifying a RekordBox library en-masse"
 authors = [{ name = "James Viall", email= "jamesviall@pm.me"}]
 license = "MIT"
@@ -38,6 +38,7 @@ docs = [
     "mkdocstrings[python]>=0.27,<1",
     "mkdocs-click>=0.8,<1",
     "markdown-callouts>=0.4,<1",
+    "mkdocs-open-in-new-tab>=1.0,<2",
 ]
 
 [tool.pytest.ini_options]

{rekordbox_edit-0.6.0.dev40 → rekordbox_edit-0.6.0.dev43}/rekordbox_edit/api/convert.py

@@ -14,7 +14,7 @@ from sqlalchemy import select
 
 from rekordbox_edit.api._utils import _order_tracks_by_op
 from rekordbox_edit.models import (
-    ConvertArgs,
+    ConvertRequest,
     ConvertOp,
     ConvertResponse,
     ConvertResult,
@@ -209,7 +209,7 @@ def _get_output_path(content, output_format) -> Tuple[str, str, str]:
 # ── Classifier ────────────────────────────────────────────────────────────
 
 
-def _classify_convert(content, args: ConvertArgs) -> ConvertOp | SkippedTrack:
+def _classify_convert(content, args: ConvertRequest) -> ConvertOp | SkippedTrack:
     """Return ConvertOp if this track should be converted, or SkippedTrack with
     reason if not."""
     target = get_file_type_for_format(args.format_out)
@@ -239,7 +239,7 @@ def _classify_convert(content, args: ConvertArgs) -> ConvertOp | SkippedTrack:
 
 def convert(
     db: Rekordbox6Database,
-    args: ConvertArgs,
+    args: ConvertRequest,
     *,
     dry_run: bool = False,
 ) -> ConvertResponse:

{rekordbox_edit-0.6.0.dev40 → rekordbox_edit-0.6.0.dev43}/rekordbox_edit/api/edit.py

@@ -6,7 +6,7 @@ from pyrekordbox import Rekordbox6Database
 
 from rekordbox_edit.api._utils import _order_tracks_by_op
 from rekordbox_edit.models import (
-    EditArgs,
+    EditRequest,
     EditOp,
     EditResponse,
     EditResult,
@@ -33,7 +33,7 @@ def _compute_new_value(
     return replace_value
 
 
-def _classify_edit(content, args: EditArgs) -> EditOp | SkippedTrack:
+def _classify_edit(content, args: EditRequest) -> EditOp | SkippedTrack:
     """Return EditOp if this track should be edited, or SkippedTrack with
     reason if not."""
     col_name = FIELD_COLUMNS[args.field]
@@ -50,7 +50,7 @@ def _classify_edit(content, args: EditArgs) -> EditOp | SkippedTrack:
 
 def edit(
     db: Rekordbox6Database,
-    args: EditArgs,
+    args: EditRequest,
     *,
     dry_run: bool = False,
 ) -> EditResponse:

{rekordbox_edit-0.6.0.dev40 → rekordbox_edit-0.6.0.dev43}/rekordbox_edit/api/search.py

@@ -5,13 +5,13 @@ import logging
 from pyrekordbox import Rekordbox6Database
 
 from rekordbox_edit.api._utils import _track_from_content
-from rekordbox_edit.models import SearchArgs, SearchResponse
+from rekordbox_edit.models import SearchRequest, SearchResponse
 from rekordbox_edit.query import get_filtered_content
 
 logger = logging.getLogger(__name__)
 
 
-def search(db: Rekordbox6Database, args: SearchArgs) -> SearchResponse:
+def search(db: Rekordbox6Database, args: SearchRequest) -> SearchResponse:
     logger.debug("search start")
     result = get_filtered_content(db, args)
     tracks = [_track_from_content(c) for c in result.scalars().all()]

{rekordbox_edit-0.6.0.dev40 → rekordbox_edit-0.6.0.dev43}/rekordbox_edit/cli/convert.py

@@ -26,7 +26,7 @@ from rekordbox_edit.cli._utils import (
 )
 from rekordbox_edit.display import PrintableField, print_track_info
 from rekordbox_edit.logger import get_debug_file_path, set_level
-from rekordbox_edit.models import ConvertArgs
+from rekordbox_edit.models import ConvertRequest
 from rekordbox_edit.utils import UserQuit, confirm
 
 logger = logging.getLogger(__name__)
@@ -56,7 +56,7 @@ def convert_command(db, **kwargs):
     dry_run = kwargs.pop("dry_run", False)
     yes = kwargs.pop("yes", False)
     interactive = kwargs.pop("interactive", False)
-    args = _build_args(ConvertArgs, kwargs)
+    args = _build_args(ConvertRequest, kwargs)
     set_level(print_opt)
     piped_stdin = _handle_stdin(args)
     _validate_scripting_preconditions(

{rekordbox_edit-0.6.0.dev40 → rekordbox_edit-0.6.0.dev43}/rekordbox_edit/cli/edit.py

@@ -26,7 +26,7 @@ from rekordbox_edit.cli._utils import (
 )
 from rekordbox_edit.display import PrintableField, print_track_info
 from rekordbox_edit.logger import get_debug_file_path, set_level
-from rekordbox_edit.models import EditArgs
+from rekordbox_edit.models import EditRequest
 from rekordbox_edit.utils import UserQuit, confirm
 
 logger = logging.getLogger(__name__)
@@ -52,11 +52,11 @@ logger = logging.getLogger(__name__)
 def edit_command(db, **kwargs):
     """Edit a metadata field on tracks in the RekordBox database."""
     print_opt = kwargs.pop("print_opt", None)
-    # CLI-only flags pulled out of kwargs before constructing EditArgs.
+    # CLI-only flags pulled out of kwargs before constructing EditRequest.
     dry_run = kwargs.pop("dry_run", False)
     yes = kwargs.pop("yes", False)
     interactive = kwargs.pop("interactive", False)
-    args = _build_args(EditArgs, kwargs)
+    args = _build_args(EditRequest, kwargs)
     set_level(print_opt)
     piped_stdin = _handle_stdin(args)
 

{rekordbox_edit-0.6.0.dev40 → rekordbox_edit-0.6.0.dev43}/rekordbox_edit/cli/search.py

@@ -21,7 +21,7 @@ from rekordbox_edit.cli._utils import (
 )
 from rekordbox_edit.display import print_track_info
 from rekordbox_edit.logger import get_debug_file_path, set_level
-from rekordbox_edit.models import SearchArgs
+from rekordbox_edit.models import SearchRequest
 
 logger = logging.getLogger(__name__)
 
@@ -34,7 +34,7 @@ logger = logging.getLogger(__name__)
 def search_command(db, **kwargs):
     """Search the RekordBox database."""
     print_opt = kwargs.pop("print_opt", None)
-    args = _build_args(SearchArgs, kwargs)
+    args = _build_args(SearchRequest, kwargs)
     set_level(print_opt)
     _handle_stdin(args)
 

{rekordbox_edit-0.6.0.dev40 → rekordbox_edit-0.6.0.dev43}/rekordbox_edit/models.py

@@ -4,7 +4,7 @@ Three layers:
 
 - **Filter base** (`FilterArgs`) declares track-selection criteria shared by all
   commands.
-- **Command args** (`SearchArgs`, `EditArgs`, `ConvertArgs`) extend `FilterArgs`
+- **Command args** (`SearchRequest`, `EditRequest`, `ConvertRequest`) extend `FilterArgs`
   with command-specific fields.
 - **Domain types** (`Track`, `EditOp`, `ConvertOp`, `SkippedTrack`) and
   **response envelopes** (`SearchResponse`, `EditResponse`, `ConvertResponse`)
@@ -25,7 +25,6 @@ from typing import Literal, TypeAlias
 
 from pydantic import BaseModel, ConfigDict, Field, model_validator
 
-
 # ── Filter base ───────────────────────────────────────────────────────────
 
 
@@ -61,17 +60,12 @@ class FilterArgs(BaseModel):
 # ── Command args ──────────────────────────────────────────────────────────
 
 
-class SearchArgs(FilterArgs):
-    """Inputs for search().
-
-    Currently equivalent to FilterArgs. Kept as a distinct type so the public
-    signature reads `search(db, SearchArgs)` and so search-specific fields
-    can be added later without changing the call surface.
-    """
+class SearchRequest(FilterArgs):
+    """Inputs for search(): the shared track filters, with no search-specific fields."""
 
 
-class EditArgs(FilterArgs):
-    """Inputs for edit()."""
+class EditRequest(FilterArgs):
+    """Inputs for edit(): the shared track filters plus the field to change and its new value."""
 
     field: str
     replace_value: str
@@ -79,15 +73,14 @@ class EditArgs(FilterArgs):
     multi: bool = False
 
 
-class ConvertArgs(FilterArgs):
-    """Inputs for convert().
-
-    `delete` is tri-state: None defers to a per-format default in convert()
-    (True for lossless, False for MP3).
-    """
+class ConvertRequest(FilterArgs):
+    """Inputs for convert(): the shared track filters plus output format and original-file handling."""
 
     format_out: str = "aiff"
     delete: bool | None = None
+    """Whether to delete the original files after conversion: True deletes them,
+    False keeps them, and None applies the per-format default (delete for
+    lossless output, keep for MP3)."""
     overwrite: bool = False
 
 
@@ -95,9 +88,10 @@ class ConvertArgs(FilterArgs):
 
 
 class Track(BaseModel):
-    """A Rekordbox track. Field names mirror DjmdContent column names.
-
-    `extra="allow"` lets undeclared columns ride along as untyped attributes.
+    """A Rekordbox track.
+    Field names mirror the [DjmdContent](https://pyrekordbox.readthedocs.io/en/latest/formats/db6.html#djmdcontent) table's column names,
+    except where additional derived fields have been added for convenience. All database columns are silently included in each object
+    for convenience, but what's defined here is just what RBE cares about.
     """
 
     model_config = ConfigDict(extra="allow")

{rekordbox_edit-0.6.0.dev40 → rekordbox_edit-0.6.0.dev43}/tests/api/test_convert.py

@@ -15,7 +15,7 @@ from rekordbox_edit.api.convert import (
     convert,
 )
 from rekordbox_edit.models import (
-    ConvertArgs,
+    ConvertRequest,
     ConvertOp,
     ConvertResponse,
     SkippedTrack,
@@ -31,7 +31,7 @@ class TestClassifyConvert:
         )
         content = make_djmd_content_item(ID="1", FileType=1)  # already AIFF
 
-        result = _classify_convert(content, ConvertArgs(format_out="aiff"))
+        result = _classify_convert(content, ConvertRequest(format_out="aiff"))
 
         assert isinstance(result, SkippedTrack)
         assert result.reason == "already_target_format"
@@ -43,7 +43,7 @@ class TestClassifyConvert:
         )
         content = make_djmd_content_item(ID="2", FileType=5)  # MP3
 
-        result = _classify_convert(content, ConvertArgs(format_out="aiff"))
+        result = _classify_convert(content, ConvertRequest(format_out="aiff"))
 
         assert isinstance(result, SkippedTrack)
         assert result.reason == "already_target_format"
@@ -61,7 +61,7 @@ class TestClassifyConvert:
         content = make_djmd_content_item(ID="3", FileType=11)  # WAV
 
         result = _classify_convert(
-            content, ConvertArgs(format_out="aiff", overwrite=False)
+            content, ConvertRequest(format_out="aiff", overwrite=False)
         )
 
         assert isinstance(result, SkippedTrack)
@@ -80,7 +80,7 @@ class TestClassifyConvert:
         content = make_djmd_content_item(ID="3", FileType=11, FolderPath="/in.wav")
 
         result = _classify_convert(
-            content, ConvertArgs(format_out="aiff", overwrite=True)
+            content, ConvertRequest(format_out="aiff", overwrite=True)
         )
 
         assert isinstance(result, ConvertOp)
@@ -101,7 +101,7 @@ class TestClassifyConvert:
             ID="4", FileType=11, FolderPath="/music/song.wav"
         )
 
-        result = _classify_convert(content, ConvertArgs(format_out="aiff"))
+        result = _classify_convert(content, ConvertRequest(format_out="aiff"))
 
         assert isinstance(result, ConvertOp)
         assert result.id == "4"
@@ -143,7 +143,7 @@ class TestConvertDryRun:
         content = make_djmd_content_item(ID="1", FileType=11, FolderPath="/in.wav")
         _seed_filter(mock_gfc, content)
 
-        response = convert(mock_db, ConvertArgs(format_out="aiff"), dry_run=True)
+        response = convert(mock_db, ConvertRequest(format_out="aiff"), dry_run=True)
 
         assert isinstance(response, ConvertResponse)
         assert response.result.format_out == "aiff"
@@ -169,7 +169,7 @@ class TestConvertDryRun:
         content = make_djmd_content_item(ID="1", FileType=1)  # already AIFF
         _seed_filter(mock_gfc, content)
 
-        response = convert(mock_db, ConvertArgs(format_out="aiff"), dry_run=True)
+        response = convert(mock_db, ConvertRequest(format_out="aiff"), dry_run=True)
 
         assert response.result.converted == []
         assert response.tracks == []
@@ -181,7 +181,7 @@ class TestConvertRealRun:
     @patch("rekordbox_edit.utils.ffmpeg_in_path", return_value=False)
     def test_no_ffmpeg_raises_immediately(self, _, mock_db):
         with pytest.raises(RuntimeError, match="FFmpeg"):
-            convert(mock_db, ConvertArgs(format_out="aiff"))
+            convert(mock_db, ConvertRequest(format_out="aiff"))
 
     @patch("rekordbox_edit.utils.ffmpeg_in_path", return_value=True)
     @patch("rekordbox_edit.api.convert.get_filtered_content")
@@ -190,7 +190,7 @@ class TestConvertRealRun:
     ):
         _seed_filter(mock_gfc)
 
-        response = convert(mock_db, ConvertArgs(format_out="aiff"))
+        response = convert(mock_db, ConvertRequest(format_out="aiff"))
 
         assert response.result.converted == []
         assert response.tracks == []
@@ -224,7 +224,7 @@ class TestConvertRealRun:
         _seed_db(mock_db, content)  # post-commit re-query returns the same row
 
         response = convert(
-            mock_db, ConvertArgs(format_out="aiff", delete=False, overwrite=True)
+            mock_db, ConvertRequest(format_out="aiff", delete=False, overwrite=True)
         )
 
         mock_lossless.assert_called_once_with("/in.wav", "/out.aif", OutputFormats.AIFF)
@@ -264,7 +264,7 @@ class TestConvertRealRun:
         _seed_db(mock_db, content)
 
         response = convert(
-            mock_db, ConvertArgs(format_out="aiff", delete=True, overwrite=True)
+            mock_db, ConvertRequest(format_out="aiff", delete=True, overwrite=True)
         )
 
         mock_remove.assert_called_once_with("/in.wav")
@@ -297,7 +297,7 @@ class TestConvertRealRun:
         _seed_filter(mock_gfc, content)
 
         with pytest.raises(RuntimeError, match="Conversion failed"):
-            convert(mock_db, ConvertArgs(format_out="aiff", overwrite=True))
+            convert(mock_db, ConvertRequest(format_out="aiff", overwrite=True))
 
         mock_rollback.assert_called_once()
 
@@ -336,7 +336,7 @@ class TestConvertRealRun:
 
         with pytest.raises(KeyboardInterrupt):
             convert(
-                mock_db, ConvertArgs(format_out="aiff", delete=True, overwrite=True)
+                mock_db, ConvertRequest(format_out="aiff", delete=True, overwrite=True)
             )
 
         mock_db.session.commit.assert_called_once()
@@ -380,7 +380,7 @@ class TestConvertRealRun:
         _seed_db(mock_db, contents[2], contents[0], contents[1])
 
         response = convert(
-            mock_db, ConvertArgs(format_out="aiff", delete=False, overwrite=True)
+            mock_db, ConvertRequest(format_out="aiff", delete=False, overwrite=True)
         )
 
         assert [op.id for op in response.result.converted] == ["A", "B", "C"]
@@ -415,7 +415,7 @@ class TestConvertRealRun:
         mock_db.session.execute.side_effect = RuntimeError("post-commit query failed")
 
         response = convert(
-            mock_db, ConvertArgs(format_out="aiff", delete=False, overwrite=True)
+            mock_db, ConvertRequest(format_out="aiff", delete=False, overwrite=True)
         )
 
         # Commit happened
@@ -450,7 +450,7 @@ class TestConvertRealRun:
         _seed_filter(mock_gfc, content)
 
         # Default overwrite=False with output path existing -> classifier should skip.
-        response = convert(mock_db, ConvertArgs(format_out="aiff"))
+        response = convert(mock_db, ConvertRequest(format_out="aiff"))
 
         assert response.result.converted == []
         assert len(response.result.skipped) == 1
@@ -482,7 +482,7 @@ class TestConvertRealRun:
         _seed_filter(mock_gfc, content)
 
         with pytest.raises(RuntimeError, match="Source not found"):
-            convert(mock_db, ConvertArgs(format_out="aiff", overwrite=True))
+            convert(mock_db, ConvertRequest(format_out="aiff", overwrite=True))
         mock_rollback.assert_called_once()
 
     @patch("rekordbox_edit.api.convert._rollback_and_cleanup")
@@ -517,7 +517,7 @@ class TestConvertRealRun:
         _seed_filter(mock_gfc, content)
 
         with pytest.raises(RuntimeError, match="DB error"):
-            convert(mock_db, ConvertArgs(format_out="aiff", overwrite=True))
+            convert(mock_db, ConvertRequest(format_out="aiff", overwrite=True))
         mock_rollback.assert_called_once()
 
     @patch("rekordbox_edit.api.convert._update_database_record")
@@ -547,7 +547,7 @@ class TestConvertRealRun:
         _seed_filter(mock_gfc, content)
         _seed_db(mock_db, content)
 
-        convert(mock_db, ConvertArgs(format_out="mp3", overwrite=True))
+        convert(mock_db, ConvertRequest(format_out="mp3", overwrite=True))
 
         mock_mp3.assert_called_once_with("/in.wav", "/out.mp3")
 
@@ -581,7 +581,7 @@ class TestConvertRealRun:
         _seed_db(mock_db, content)
 
         response = convert(
-            mock_db, ConvertArgs(format_out="aiff", delete=False, overwrite=True)
+            mock_db, ConvertRequest(format_out="aiff", delete=False, overwrite=True)
         )
 
         mock_remove.assert_not_called()

{rekordbox_edit-0.6.0.dev40 → rekordbox_edit-0.6.0.dev43}/tests/api/test_edit.py

@@ -3,7 +3,7 @@ from unittest.mock import patch
 
 from rekordbox_edit.api.edit import _classify_edit, edit
 from rekordbox_edit.models import (
-    EditArgs,
+    EditRequest,
     EditOp,
     EditResponse,
     SkippedTrack,
@@ -13,7 +13,7 @@ from rekordbox_edit.models import (
 class TestClassifyEdit:
     def test_returns_edit_op_when_value_would_change(self, make_djmd_content_item):
         content = make_djmd_content_item(ID="1", Title="Old")
-        args = EditArgs(field="Title", replace_value="New")
+        args = EditRequest(field="Title", replace_value="New")
 
         result = _classify_edit(content, args)
 
@@ -23,7 +23,7 @@ class TestClassifyEdit:
 
     def test_returns_skipped_when_value_equals_current(self, make_djmd_content_item):
         content = make_djmd_content_item(ID="1", Title="Same")
-        args = EditArgs(field="Title", replace_value="Same")
+        args = EditRequest(field="Title", replace_value="Same")
 
         result = _classify_edit(content, args)
 
@@ -33,7 +33,7 @@ class TestClassifyEdit:
 
     def test_returns_skipped_when_current_is_none(self, make_djmd_content_item):
         content = make_djmd_content_item(ID="1", Title=None)
-        args = EditArgs(field="Title", replace_value="New")
+        args = EditRequest(field="Title", replace_value="New")
 
         result = _classify_edit(content, args)
 
@@ -42,7 +42,7 @@ class TestClassifyEdit:
 
     def test_match_pattern_applied(self, make_djmd_content_item):
         content = make_djmd_content_item(ID="1", Title="Hello World")
-        args = EditArgs(field="Title", replace_value="Earth", match_pattern="World")
+        args = EditRequest(field="Title", replace_value="Earth", match_pattern="World")
 
         result = _classify_edit(content, args)
 
@@ -59,7 +59,7 @@ class TestEditDryRun:
         mock_gfc.return_value.scalars.return_value.all.return_value = [content]
 
         response = edit(
-            mock_db, EditArgs(field="Title", replace_value="New"), dry_run=True
+            mock_db, EditRequest(field="Title", replace_value="New"), dry_run=True
         )
 
         assert isinstance(response, EditResponse)
@@ -74,7 +74,7 @@ class TestEditDryRun:
         mock_gfc.return_value.scalars.return_value.all.return_value = [content]
 
         response = edit(
-            mock_db, EditArgs(field="Title", replace_value="Same"), dry_run=True
+            mock_db, EditRequest(field="Title", replace_value="Same"), dry_run=True
         )
 
         assert response.result.edits == []
@@ -97,7 +97,7 @@ class TestEditDryRun:
         with pytest.raises(ValueError, match="multi"):
             edit(
                 mock_db,
-                EditArgs(field="Title", replace_value="New", multi=False),
+                EditRequest(field="Title", replace_value="New", multi=False),
                 dry_run=True,
             )
 
@@ -110,7 +110,7 @@ class TestEditRealRun:
         content = make_djmd_content_item(ID="1", Title="Old")
         mock_gfc.return_value.scalars.return_value.all.return_value = [content]
 
-        response = edit(mock_db, EditArgs(field="Title", replace_value="New"))
+        response = edit(mock_db, EditRequest(field="Title", replace_value="New"))
 
         assert content.Title == "New"
         mock_db.session.commit.assert_called_once()
@@ -123,7 +123,7 @@ class TestEditRealRun:
     ):
         mock_gfc.return_value.scalars.return_value.all.return_value = []
 
-        response = edit(mock_db, EditArgs(field="Title", replace_value="New"))
+        response = edit(mock_db, EditRequest(field="Title", replace_value="New"))
 
         assert response.result.edits == []
         assert response.tracks == []
@@ -140,7 +140,7 @@ class TestEditRealRun:
         mock_gfc.return_value.scalars.return_value.all.return_value = contents
 
         response = edit(
-            mock_db, EditArgs(field="Title", replace_value="New", multi=True)
+            mock_db, EditRequest(field="Title", replace_value="New", multi=True)
         )
 
         assert len(response.result.edits) == 2
@@ -158,7 +158,7 @@ class TestEditRealRun:
         ]
         mock_gfc.return_value.scalars.return_value.all.return_value = contents
 
-        response = edit(mock_db, EditArgs(field="Title", replace_value="x", multi=True))
+        response = edit(mock_db, EditRequest(field="Title", replace_value="x", multi=True))
 
         # The order of result.edits follows the classifier (i.e. the order
         # of contents). tracks aligns to edits.

{rekordbox_edit-0.6.0.dev40 → rekordbox_edit-0.6.0.dev43}/tests/api/test_search.py

@@ -1,7 +1,7 @@
 from unittest.mock import Mock, patch
 
 from rekordbox_edit.api.search import search
-from rekordbox_edit.models import SearchArgs, SearchResponse, Track
+from rekordbox_edit.models import SearchRequest, SearchResponse, Track
 
 
 class TestSearch:
@@ -12,7 +12,7 @@ class TestSearch:
         mock_result.scalars.return_value.all.return_value = [content]
         mock_gfc.return_value = mock_result
 
-        response = search(mock_db, SearchArgs())
+        response = search(mock_db, SearchRequest())
 
         assert isinstance(response, SearchResponse)
         assert len(response.tracks) == 1
@@ -25,7 +25,7 @@ class TestSearch:
         mock_result.scalars.return_value.all.return_value = []
         mock_gfc.return_value = mock_result
 
-        response = search(mock_db, SearchArgs())
+        response = search(mock_db, SearchRequest())
 
         assert response.tracks == []
 
@@ -35,7 +35,7 @@ class TestSearch:
         mock_result.scalars.return_value.all.return_value = []
         mock_gfc.return_value = mock_result
 
-        args = SearchArgs(artist=["Daft Punk"], match_all=True)
+        args = SearchRequest(artist=["Daft Punk"], match_all=True)
         search(mock_db, args)
 
         mock_gfc.assert_called_once_with(mock_db, args)

{rekordbox_edit-0.6.0.dev40 → rekordbox_edit-0.6.0.dev43}/tests/cli/test_utils.py

@@ -12,15 +12,15 @@ from rekordbox_edit.cli._utils import (
     _validate_scripting_preconditions,
 )
 from rekordbox_edit.models import (
-    ConvertArgs,
+    ConvertRequest,
     ConvertOp,
     ConvertResponse,
     ConvertResult,
-    EditArgs,
+    EditRequest,
     EditOp,
     EditResponse,
     EditResult,
-    SearchArgs,
+    SearchRequest,
     SearchResponse,
     Track,
 )
@@ -88,7 +88,7 @@ class TestValidateScriptingPreconditions:
 
 class TestNarrowToTrackIds:
     def test_clears_other_filter_criteria(self):
-        args = ConvertArgs(
+        args = ConvertRequest(
             artist=["X"],
             format=["flac"],
             format_out="aiff",
@@ -107,7 +107,7 @@ class TestNarrowToTrackIds:
         assert narrowed.delete is True
 
     def test_works_for_edit_args(self):
-        args = EditArgs(
+        args = EditRequest(
             artist=["X"],
             field="Title",
             replace_value="N",
@@ -126,7 +126,7 @@ class TestNarrowToTrackIds:
         assert narrowed.multi is True
 
     def test_clears_first(self):
-        args = SearchArgs(first=2)
+        args = SearchRequest(first=2)
 
         narrowed = _narrow_to_track_ids(args, ["a", "b", "c"])
 
@@ -134,7 +134,7 @@ class TestNarrowToTrackIds:
         assert narrowed.track_ids == ["a", "b", "c"]
 
     def test_clears_last(self):
-        args = SearchArgs(last=2)
+        args = SearchRequest(last=2)
 
         narrowed = _narrow_to_track_ids(args, ["a"])
 

{rekordbox_edit-0.6.0.dev40 → rekordbox_edit-0.6.0.dev43}/tests/test_models.py

@@ -4,16 +4,16 @@ import pytest
 from pydantic import ValidationError
 
 from rekordbox_edit.models import (
-    ConvertArgs,
+    ConvertRequest,
     ConvertOp,
     ConvertResponse,
     ConvertResult,
-    EditArgs,
+    EditRequest,
     EditOp,
     EditResponse,
     EditResult,
     FilterArgs,
-    SearchArgs,
+    SearchRequest,
     SearchResponse,
     SkippedTrack,
     Track,
@@ -74,16 +74,16 @@ class TestFilterArgs:
             FilterArgs(first=2, last=3)
 
 
-class TestSearchArgs:
+class TestSearchRequest:
     def test_is_filter_args(self):
-        args = SearchArgs(artist=["X"])
+        args = SearchRequest(artist=["X"])
         assert isinstance(args, FilterArgs)
         assert args.artist == ["X"]
 
 
-class TestEditArgs:
+class TestEditRequest:
     def test_has_filter_and_edit_fields(self):
-        args = EditArgs(field="Title", replace_value="New", artist=["X"])
+        args = EditRequest(field="Title", replace_value="New", artist=["X"])
         assert isinstance(args, FilterArgs)
         assert args.field == "Title"
         assert args.replace_value == "New"
@@ -91,9 +91,9 @@ class TestEditArgs:
         assert args.multi is False
 
 
-class TestConvertArgs:
+class TestConvertRequest:
     def test_has_filter_and_convert_fields(self):
-        args = ConvertArgs(format_out="mp3", overwrite=True, artist=["X"])
+        args = ConvertRequest(format_out="mp3", overwrite=True, artist=["X"])
         assert isinstance(args, FilterArgs)
         assert args.format_out == "mp3"
         assert args.overwrite is True

{rekordbox_edit-0.6.0.dev40 → rekordbox_edit-0.6.0.dev43}/uv.lock

@@ -713,6 +713,18 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/5b/54/662a4743aa81d9582ee9339d4ffa3c8fd40a4965e033d77b9da9774d3960/mkdocs_material_extensions-1.3.1-py3-none-any.whl", hash = "sha256:adff8b62700b25cb77b53358dad940f3ef973dd6db797907c49e3c2ef3ab4e31", size = 8728, upload-time = "2023-11-22T19:09:43.465Z" },
 ]
 
+[[package]]
+name = "mkdocs-open-in-new-tab"
+version = "1.0.8"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "mkdocs" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/0a/0e/f72a506a21bdb27b807124e00c688226848a388d1fd3980b80ae3cc27203/mkdocs_open_in_new_tab-1.0.8.tar.gz", hash = "sha256:3e0dad08cc9938b0b13097be8e0aa435919de1eeb2d1a648e66b5dee8d57e048", size = 5791, upload-time = "2024-11-18T13:15:13.977Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/21/94/44f3c868495481c868d08eea065c82803f1affd8553d3383b782f497613c/mkdocs_open_in_new_tab-1.0.8-py3-none-any.whl", hash = "sha256:051d767a4467b12d89827e1fea0ec660b05b027c726317fe4fceee5456e36ad2", size = 7717, upload-time = "2024-11-18T13:15:12.286Z" },
+]
+
 [[package]]
 name = "mkdocstrings"
 version = "0.30.1"
@@ -1256,7 +1268,7 @@ wheels = [
 
 [[package]]
 name = "rekordbox-edit"
-version = "0.6.0.dev40"
+version = "0.6.0.dev43"
 source = { editable = "." }
 dependencies = [
     { name = "click" },
@@ -1284,6 +1296,7 @@ docs = [
     { name = "markdown-callouts" },
     { name = "mkdocs-click" },
     { name = "mkdocs-material" },
+    { name = "mkdocs-open-in-new-tab" },
     { name = "mkdocstrings", extra = ["python"] },
 ]
 
@@ -1314,6 +1327,7 @@ docs = [
     { name = "markdown-callouts", specifier = ">=0.4,<1" },
     { name = "mkdocs-click", specifier = ">=0.8,<1" },
     { name = "mkdocs-material", specifier = ">=9.5,<10" },
+    { name = "mkdocs-open-in-new-tab", specifier = ">=1.0,<2" },
     { name = "mkdocstrings", extras = ["python"], specifier = ">=0.27,<1" },
 ]