lightroom-cli 1.0.0__py3-none-any.whl

cli/commands/ai_mask.py

@@ -0,0 +1,228 @@
+"""AI Mask CLI commands — lr develop ai <type>"""
+
+import json
+
+import click
+
+from cli.decorators import json_input_options
+from cli.helpers import execute_command
+from cli.output import OutputFormatter
+
+AI_SELECTION_TYPES = ["subject", "sky", "background", "objects", "people", "landscape"]
+
+
+@click.group("ai")
+def ai():
+    """AI mask commands (subject, sky, background, people, landscape, objects)"""
+    pass
+
+
+def _make_ai_type_command(selection_type: str, has_part: bool = False, part_choices: list[str] | None = None):
+    """各 AI マスクタイプコマンドのファクトリ関数"""
+
+    params = [
+        click.Option(["--adjust"], default=None, help="JSON adjustment settings"),
+        click.Option(
+            ["--adjust-preset"],
+            default=None,
+            help="Named preset (darken-sky, brighten-subject, etc)",
+        ),
+        click.Option(["--dry-run"], is_flag=True, default=False, help="Preview without executing"),
+        click.Option(["--json", "json_str"], default=None, help="JSON string with all parameters"),
+        click.Option(
+            ["--json-stdin", "json_stdin"],
+            is_flag=True,
+            default=False,
+            help="Read JSON parameters from stdin",
+        ),
+    ]
+    # --part is hidden until SDK support is verified
+    if has_part and part_choices:
+        params.insert(
+            0,
+            click.Option(
+                ["--part"],
+                default=None,
+                type=click.Choice(part_choices),
+                help="Specific part to mask",
+                hidden=True,
+            ),
+        )
+
+    @click.pass_context
+    def command_func(ctx, **kwargs):
+        adjust = kwargs.get("adjust")
+        adjust_preset = kwargs.get("adjust_preset")
+        part = kwargs.get("part")
+
+        # Build params
+        cmd_params: dict = {"selectionType": selection_type}
+        if part:
+            cmd_params["part"] = part
+
+        # Resolve adjustments
+        adjustments = _resolve_adjustments(adjust, adjust_preset)
+        if isinstance(adjustments, str):
+            # Error message
+            click.echo(OutputFormatter.format_error(adjustments))
+            return
+        if adjustments:
+            cmd_params["adjustments"] = adjustments
+
+        execute_command(ctx, "develop.createAIMaskWithAdjustments", cmd_params, timeout=60.0)
+
+    cmd = click.Command(
+        name=selection_type,
+        callback=command_func,
+        params=params,
+        help=f"Create AI {selection_type} mask",
+    )
+    return cmd
+
+
+def _resolve_adjustments(adjust_json: str | None, adjust_preset: str | None) -> dict | str | None:
+    """--adjust JSON と --adjust-preset を解決する。エラー時は文字列を返す。"""
+    if adjust_json and adjust_preset:
+        return "Cannot use both --adjust and --adjust-preset"
+
+    if adjust_preset:
+        from lightroom_sdk.presets import get_preset
+
+        preset = get_preset(adjust_preset)
+        if preset is None:
+            from lightroom_sdk.presets import list_presets
+
+            available = ", ".join(list_presets())
+            return f"Unknown preset '{adjust_preset}'. Available: {available}"
+        return preset
+
+    if adjust_json:
+        try:
+            parsed = json.loads(adjust_json)
+            if not isinstance(parsed, dict):
+                return "--adjust must be a JSON object"
+            return parsed
+        except json.JSONDecodeError as e:
+            return f"Invalid JSON in --adjust: {e}"
+
+    return None
+
+
+# Register type commands
+ai.add_command(_make_ai_type_command("subject"))
+ai.add_command(_make_ai_type_command("sky"))
+ai.add_command(_make_ai_type_command("background"))
+ai.add_command(_make_ai_type_command("objects"))
+ai.add_command(
+    _make_ai_type_command(
+        "people",
+        has_part=True,
+        part_choices=["eyes", "hair", "skin", "lips", "teeth", "clothes"],
+    )
+)
+ai.add_command(
+    _make_ai_type_command(
+        "landscape",
+        has_part=True,
+        part_choices=["mountain", "tree", "water", "building", "road"],
+    )
+)
+
+
+@ai.command("presets")
+@click.pass_context
+def ai_presets(ctx):
+    """List available adjustment presets"""
+    fmt = ctx.obj.get("output", "text") if ctx.obj else "text"
+    from lightroom_sdk.presets import AI_MASK_PRESETS
+
+    click.echo(OutputFormatter.format(AI_MASK_PRESETS, fmt))
+
+
+@ai.command("reset")
+@click.option(
+    "--confirm",
+    is_flag=True,
+    default=False,
+    help="Required confirmation flag (removes all masks)",
+)
+@click.option("--dry-run", is_flag=True, default=False, help="Preview without executing")
+@json_input_options
+@click.pass_context
+def ai_reset(ctx, confirm, dry_run, **kwargs):
+    """Remove all masks from the current photo (requires --confirm)"""
+    if not confirm and not dry_run:
+        fmt = ctx.obj.get("output", "text") if ctx.obj else "text"
+        click.echo(
+            OutputFormatter.format_error(
+                "This will remove all masks. Pass --confirm to proceed.",
+                fmt,
+                code="CONFIRMATION_REQUIRED",
+                suggestions=[
+                    "Add --confirm flag: lr develop ai reset --confirm",
+                    "Use --dry-run first to preview: lr develop ai reset --dry-run",
+                ],
+            ),
+            err=True,
+        )
+        ctx.exit(2)
+        return
+    execute_command(ctx, "develop.resetMasking", {})
+
+
+@ai.command("list")
+@json_input_options
+@click.pass_context
+def ai_list(ctx, **kwargs):
+    """List all masks on the current photo"""
+    execute_command(ctx, "develop.getAllMasks", {})
+
+
+@ai.command("batch")
+@click.argument("type", type=click.Choice(AI_SELECTION_TYPES))
+@click.option("--photos", default=None, help="Comma-separated photo IDs")
+@click.option("--all-selected", is_flag=True, help="Apply to all selected photos")
+@click.option("--adjust", default=None, help="JSON adjustment settings")
+@click.option("--adjust-preset", default=None, help="Named preset")
+@click.option("--dry-run", is_flag=True, help="Show targets without applying")
+@click.option("--continue-on-error", is_flag=True, default=False, help="Continue on errors")
+@json_input_options
+@click.pass_context
+def ai_batch(
+    ctx,
+    type,
+    photos,
+    all_selected,
+    adjust,
+    adjust_preset,
+    dry_run,
+    continue_on_error,
+    **kwargs,
+):
+    """Apply AI mask to multiple photos"""
+    if not photos and not all_selected:
+        click.echo(OutputFormatter.format_error("Specify --photos or --all-selected"))
+        return
+
+    if dry_run:
+        target = "all selected photos" if all_selected else f"photos: {photos}"
+        click.echo(f"Dry run: would apply AI {type} mask to {target}")
+        return
+
+    # Resolve adjustments
+    adjustments = _resolve_adjustments(adjust, adjust_preset)
+    if isinstance(adjustments, str):
+        click.echo(OutputFormatter.format_error(adjustments))
+        return
+
+    cmd_params: dict = {
+        "selectionType": type,
+        "allSelected": all_selected,
+        "continueOnError": continue_on_error,
+    }
+    if photos:
+        cmd_params["photoIds"] = [p.strip() for p in photos.split(",")]
+    if adjustments:
+        cmd_params["adjustments"] = adjustments
+
+    execute_command(ctx, "develop.batchAIMask", cmd_params, timeout=300.0)

cli/commands/catalog.py

@@ -0,0 +1,378 @@
+import json
+
+import click
+
+from cli.decorators import json_input_options
+from cli.helpers import execute_command
+from cli.output import OutputFormatter
+
+
+@click.group()
+def catalog():
+    """Catalog commands (list, search, find, get-selected, get-info, set-rating, add-keywords, etc.)"""
+    pass
+
+
+@catalog.command("get-selected")
+@json_input_options
+@click.pass_context
+def get_selected(ctx, **kwargs):
+    """Get currently selected photos"""
+    execute_command(ctx, "catalog.getSelectedPhotos", {})
+
+
+@catalog.command("list")
+@click.option("--limit", default=50, type=int, help="Max photos to return")
+@click.option("--offset", default=0, type=int, help="Offset for pagination")
+@json_input_options
+@click.pass_context
+def list_photos(ctx, limit, offset, **kwargs):
+    """List photos in catalog"""
+    execute_command(ctx, "catalog.getAllPhotos", {"limit": limit, "offset": offset}, timeout=60.0)
+
+
+@catalog.command("search")
+@click.argument("query")
+@click.option("--limit", default=50, type=int)
+@json_input_options
+@click.pass_context
+def search(ctx, query, limit, **kwargs):
+    """Search photos by keyword"""
+    execute_command(ctx, "catalog.searchPhotos", {"query": query, "limit": limit}, timeout=60.0)
+
+
+@catalog.command("get-info")
+@click.argument("photo_id")
+@json_input_options
+@click.pass_context
+def get_info(ctx, photo_id, **kwargs):
+    """Get detailed info for a photo"""
+    execute_command(ctx, "catalog.getPhotoMetadata", {"photoId": photo_id})
+
+
+@catalog.command("set-rating")
+@click.argument("photo_id")
+@click.argument("rating", type=click.IntRange(0, 5))
+@click.option("--dry-run", is_flag=True, default=False, help="Preview without executing")
+@json_input_options
+@click.pass_context
+def set_rating(ctx, photo_id, rating, dry_run, **kwargs):
+    """Set photo rating (0-5)"""
+    execute_command(ctx, "catalog.setRating", {"photoId": photo_id, "rating": rating})
+
+
+@catalog.command("add-keywords")
+@click.argument("photo_id")
+@click.argument("keywords", nargs=-1, required=True)
+@click.option("--dry-run", is_flag=True, default=False, help="Preview without executing")
+@json_input_options
+@click.pass_context
+def add_keywords(ctx, photo_id, keywords, dry_run, **kwargs):
+    """Add keywords to a photo"""
+    execute_command(ctx, "catalog.addKeywords", {"photoId": photo_id, "keywords": list(keywords)})
+
+
+@catalog.command("set-flag")
+@click.argument("photo_id")
+@click.argument("flag", type=click.Choice(["pick", "reject", "none"]))
+@click.option("--dry-run", is_flag=True, default=False, help="Preview without executing")
+@json_input_options
+@click.pass_context
+def set_flag(ctx, photo_id, flag, dry_run, **kwargs):
+    """Set photo flag (pick/reject/none)"""
+    flag_map = {"pick": 1, "reject": -1, "none": 0}
+    execute_command(ctx, "catalog.setFlag", {"photoId": photo_id, "flag": flag_map[flag]})
+
+
+@catalog.command("get-flag")
+@click.argument("photo_id")
+@json_input_options
+@click.pass_context
+def get_flag(ctx, photo_id, **kwargs):
+    """Get photo flag status"""
+    execute_command(ctx, "catalog.getFlag", {"photoId": photo_id})
+
+
+@catalog.command("find")
+@click.option("--flag", type=click.Choice(["pick", "reject", "none"]), help="Flag condition")
+@click.option("--rating", type=int, help="Rating (0-5)")
+@click.option(
+    "--rating-op",
+    default="==",
+    type=click.Choice(["==", ">=", "<=", ">", "<"]),
+    help="Rating comparison operator",
+)
+@click.option("--color-label", help="Color label (red/yellow/green/blue/purple/none)")
+@click.option("--camera", help="Camera model name")
+@click.option("--limit", default=50, type=int, help="Max results")
+@click.option("--offset", default=0, type=int, help="Offset for pagination")
+@json_input_options
+@click.pass_context
+def find_photos(ctx, flag, rating, rating_op, color_label, camera, limit, offset, **kwargs):
+    """Find photos by structured criteria"""
+    search_desc = {}
+    if flag:
+        search_desc["flag"] = flag
+    if rating is not None:
+        search_desc["rating"] = rating
+        search_desc["ratingOp"] = rating_op
+    if color_label:
+        search_desc["colorLabel"] = color_label
+    if camera:
+        search_desc["camera"] = camera
+
+    execute_command(
+        ctx,
+        "catalog.findPhotos",
+        {"searchDesc": search_desc, "limit": limit, "offset": offset},
+    )
+
+
+@catalog.command("select")
+@click.argument("photo_ids", nargs=-1, required=True)
+@click.option("--dry-run", is_flag=True, default=False, help="Preview without executing")
+@json_input_options
+@click.pass_context
+def select_photos(ctx, photo_ids, dry_run, **kwargs):
+    """Select photos by ID"""
+    execute_command(ctx, "catalog.setSelectedPhotos", {"photoIds": list(photo_ids)})
+
+
+@catalog.command("find-by-path")
+@click.argument("path")
+@json_input_options
+@click.pass_context
+def find_by_path(ctx, path, **kwargs):
+    """Find photo by file path"""
+    execute_command(ctx, "catalog.findPhotoByPath", {"path": path})
+
+
+@catalog.command("collections")
+@json_input_options
+@click.pass_context
+def collections(ctx, **kwargs):
+    """List collections in catalog"""
+    execute_command(ctx, "catalog.getCollections", {})
+
+
+@catalog.command("keywords")
+@json_input_options
+@click.pass_context
+def keywords(ctx, **kwargs):
+    """List keywords in catalog"""
+    execute_command(ctx, "catalog.getKeywords", {})
+
+
+@catalog.command("folders")
+@click.option("--recursive", is_flag=True, help="Include subfolders")
+@json_input_options
+@click.pass_context
+def folders(ctx, recursive, **kwargs):
+    """List folders in catalog"""
+    execute_command(ctx, "catalog.getFolders", {"includeSubfolders": recursive})
+
+
+@catalog.command("set-title")
+@click.argument("photo_id")
+@click.argument("title")
+@click.option("--dry-run", is_flag=True, default=False, help="Preview without executing")
+@json_input_options
+@click.pass_context
+def set_title(ctx, photo_id, title, dry_run, **kwargs):
+    """Set photo title"""
+    execute_command(ctx, "catalog.setTitle", {"photoId": photo_id, "title": title})
+
+
+@catalog.command("set-caption")
+@click.argument("photo_id")
+@click.argument("caption")
+@click.option("--dry-run", is_flag=True, default=False, help="Preview without executing")
+@json_input_options
+@click.pass_context
+def set_caption(ctx, photo_id, caption, dry_run, **kwargs):
+    """Set photo caption"""
+    execute_command(ctx, "catalog.setCaption", {"photoId": photo_id, "caption": caption})
+
+
+@catalog.command("set-color-label")
+@click.argument("photo_id")
+@click.argument("label", type=click.Choice(["red", "yellow", "green", "blue", "purple", "none"]))
+@click.option("--dry-run", is_flag=True, default=False, help="Preview without executing")
+@json_input_options
+@click.pass_context
+def set_color_label(ctx, photo_id, label, dry_run, **kwargs):
+    """Set photo color label"""
+    execute_command(ctx, "catalog.setColorLabel", {"photoId": photo_id, "label": label})
+
+
+@catalog.command("batch-metadata")
+@click.argument("photo_ids", nargs=-1, required=True)
+@click.option(
+    "--keys",
+    default="fileName,dateTimeOriginal,rating",
+    help="Comma-separated metadata keys",
+)
+@json_input_options
+@click.pass_context
+def batch_metadata(ctx, photo_ids, keys, **kwargs):
+    """Get formatted metadata for multiple photos"""
+    execute_command(
+        ctx,
+        "catalog.batchGetFormattedMetadata",
+        {"photoIds": list(photo_ids), "keys": keys.split(",")},
+    )
+
+
+@catalog.command("rotate-left")
+@click.option("--dry-run", is_flag=True, default=False, help="Preview without executing")
+@json_input_options
+@click.pass_context
+def rotate_left(ctx, dry_run, **kwargs):
+    """Rotate selected photo left"""
+    execute_command(ctx, "catalog.rotateLeft", {})
+
+
+@catalog.command("rotate-right")
+@click.option("--dry-run", is_flag=True, default=False, help="Preview without executing")
+@json_input_options
+@click.pass_context
+def rotate_right(ctx, dry_run, **kwargs):
+    """Rotate selected photo right"""
+    execute_command(ctx, "catalog.rotateRight", {})
+
+
+@catalog.command("create-virtual-copy")
+@click.option("--dry-run", is_flag=True, default=False, help="Preview without executing")
+@json_input_options
+@click.pass_context
+def create_virtual_copy(ctx, dry_run, **kwargs):
+    """Create virtual copy of selected photo"""
+    execute_command(ctx, "catalog.createVirtualCopy", {})
+
+
+@catalog.command("set-metadata")
+@click.argument("photo_id")
+@click.argument("key")
+@click.argument("value")
+@click.option("--dry-run", is_flag=True, default=False, help="Preview without executing")
+@json_input_options
+@click.pass_context
+def set_metadata(ctx, photo_id, key, value, dry_run, **kwargs):
+    """Set arbitrary metadata key/value for a photo"""
+    execute_command(ctx, "catalog.setMetadata", {"photoId": photo_id, "key": key, "value": value})
+
+
+@catalog.command("create-collection")
+@click.argument("name")
+@click.option("--dry-run", is_flag=True, default=False, help="Preview without executing")
+@json_input_options
+@click.pass_context
+def create_collection(ctx, name, dry_run, **kwargs):
+    """Create a new collection"""
+    execute_command(ctx, "catalog.createCollection", {"name": name})
+
+
+@catalog.command("create-smart-collection")
+@click.argument("name")
+@click.option("--search-desc", default=None, help="JSON search descriptor")
+@click.option("--dry-run", is_flag=True, default=False, help="Preview without executing")
+@json_input_options
+@click.pass_context
+def create_smart_collection(ctx, name, search_desc, dry_run, **kwargs):
+    """Create a smart collection"""
+    params = {"name": name}
+    if search_desc:
+        try:
+            params["searchDesc"] = json.loads(search_desc)
+        except json.JSONDecodeError as e:
+            click.echo(OutputFormatter.format_error(f"Invalid JSON for --search-desc: {e}"))
+            ctx.exit(1)
+            return
+    execute_command(ctx, "catalog.createSmartCollection", params)
+
+
+@catalog.command("create-collection-set")
+@click.argument("name")
+@click.option("--dry-run", is_flag=True, default=False, help="Preview without executing")
+@json_input_options
+@click.pass_context
+def create_collection_set(ctx, name, dry_run, **kwargs):
+    """Create a collection set"""
+    execute_command(ctx, "catalog.createCollectionSet", {"name": name})
+
+
+@catalog.command("create-keyword")
+@click.argument("keyword")
+@click.option("--dry-run", is_flag=True, default=False, help="Preview without executing")
+@json_input_options
+@click.pass_context
+def create_keyword(ctx, keyword, dry_run, **kwargs):
+    """Create a keyword in catalog"""
+    execute_command(ctx, "catalog.createKeyword", {"keyword": keyword})
+
+
+@catalog.command("remove-keyword")
+@click.argument("photo_id")
+@click.argument("keyword")
+@click.option("--dry-run", is_flag=True, default=False, help="Preview without executing")
+@json_input_options
+@click.pass_context
+def remove_keyword(ctx, photo_id, keyword, dry_run, **kwargs):
+    """Remove keyword from a photo"""
+    execute_command(ctx, "catalog.removeKeyword", {"photoId": photo_id, "keyword": keyword})
+
+
+@catalog.command("set-view-filter")
+@click.option("--filter", "filter_json", required=True, help="JSON filter descriptor")
+@click.option("--dry-run", is_flag=True, default=False, help="Preview without executing")
+@json_input_options
+@click.pass_context
+def set_view_filter(ctx, filter_json, dry_run, **kwargs):
+    """Set view filter"""
+    try:
+        filter_data = json.loads(filter_json)
+    except json.JSONDecodeError as e:
+        click.echo(OutputFormatter.format_error(f"Invalid JSON for --filter: {e}"))
+        ctx.exit(1)
+        return
+    execute_command(ctx, "catalog.setViewFilter", {"filter": filter_data})
+
+
+@catalog.command("get-view-filter")
+@json_input_options
+@click.pass_context
+def get_view_filter(ctx, **kwargs):
+    """Get current view filter"""
+    execute_command(ctx, "catalog.getCurrentViewFilter", {})
+
+
+@catalog.command("remove-from-catalog")
+@click.argument("photo_id")
+@click.option(
+    "--confirm",
+    is_flag=True,
+    default=False,
+    help="Required confirmation flag (this operation is irreversible)",
+)
+@click.option("--dry-run", is_flag=True, default=False, help="Preview without executing")
+@json_input_options
+@click.pass_context
+def remove_from_catalog(ctx, photo_id, confirm, dry_run, **kwargs):
+    """Remove photo from catalog (irreversible, requires --confirm)"""
+    if not confirm and not dry_run:
+        fmt = ctx.obj.get("output", "text") if ctx.obj else "text"
+        click.echo(
+            OutputFormatter.format_error(
+                "This operation is irreversible. Pass --confirm to proceed.",
+                fmt,
+                code="CONFIRMATION_REQUIRED",
+                suggestions=[
+                    "Add --confirm flag: lr catalog remove-from-catalog PHOTO_ID --confirm",
+                    "Use --dry-run first to preview: lr catalog remove-from-catalog PHOTO_ID --dry-run",
+                ],
+            ),
+            err=True,
+        )
+        ctx.exit(2)
+        return
+    execute_command(ctx, "catalog.removeFromCatalog", {"photoId": photo_id})