pymcap-cli 0.8.0__tar.gz → 0.9.0__tar.gz

{pymcap_cli-0.8.0 → pymcap_cli-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pymcap-cli
-Version: 0.8.0
+Version: 0.9.0
 Summary: High-performance Python CLI for MCAP file processing with advanced recovery, filtering, and optimization capabilities
 Keywords: mcap,cli,robotics,ros,ros2,recovery,filtering,compression
 Author: Marko Bausch

{pymcap_cli-0.8.0 → pymcap_cli-0.9.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pymcap-cli"
-version = "0.8.0"
+version = "0.9.0"
 description = "High-performance Python CLI for MCAP file processing with advanced recovery, filtering, and optimization capabilities"
 readme = "README.md"
 requires-python = ">=3.10"

{pymcap_cli-0.8.0 → pymcap_cli-0.9.0}/src/pymcap_cli/cli.py

@@ -1,8 +1,8 @@
 """Main CLI entry point for pymcap-cli using Cyclopts."""
 
-import sys
+from typing import Annotated
 
-from cyclopts import App, Group
+from cyclopts import App, Group, Parameter
 
 from pymcap_cli.cmd import (
     bag2mcap_cmd,
@@ -12,6 +12,7 @@ from pymcap_cli.cmd import (
     diag_cmd,
     diff_cmd,
     du_cmd,
+    duplicates_cmd,
     export_csv_cmd,
     export_geo_cmd,
     export_json_cmd,
@@ -29,6 +30,7 @@ from pymcap_cli.cmd import (
     tftree_cmd,
     topic_chunks_cmd,
 )
+from pymcap_cli.log_setup import ERR, setup_logging
 
 try:
     from pymcap_cli.cmd.video_cmd import video
@@ -41,12 +43,11 @@ except ImportError:
 
             uv add --group video pymcap-cli
         """
-        print(  # noqa: T201
-            "Error:\n"
+        ERR.print(
+            "[red]Error:[/red]\n"
             "Video command is unavailable because the 'av' and/or 'numpy' are not installed.\n"
             "To enable video functionality, please install pymcap-cli with the 'video' extra:\n\n"
-            "    uv add --group video pymcap-cli\n",
-            file=sys.stderr,
+            "    uv add --group video pymcap-cli\n"
         )
         return 1
 
@@ -62,12 +63,11 @@ except ImportError:
 
             uv add --group plot pymcap-cli
         """
-        print(  # noqa: T201
-            "Error:\n"
+        ERR.print(
+            "[red]Error:[/red]\n"
             "Plot command is unavailable because 'plotly' is not installed.\n"
             "To enable plot functionality, please install pymcap-cli with the 'plot' extra:\n\n"
-            "    uv add --group plot pymcap-cli\n",
-            file=sys.stderr,
+            "    uv add --group plot pymcap-cli\n"
         )
         return 1
 
@@ -83,12 +83,11 @@ except ImportError:
 
             uv add --group video pymcap-cli
         """
-        print(  # noqa: T201
-            "Error:\n"
+        ERR.print(
+            "[red]Error:[/red]\n"
             "ROS compress command is unavailable because the 'av' package is not installed.\n"
             "To enable this functionality, please install pymcap-cli with the 'video' extra:\n\n"
-            "    uv add --group video pymcap-cli\n",
-            file=sys.stderr,
+            "    uv add --group video pymcap-cli\n"
         )
         return 1
 
@@ -104,12 +103,11 @@ except ImportError:
 
             uv add 'pymcap-cli[parquet]'
         """
-        print(  # noqa: T201
-            "Error:\n"
+        ERR.print(
+            "[red]Error:[/red]\n"
             "Export to Parquet is unavailable because 'pyarrow' is not installed.\n"
             "Install with:\n\n"
-            "    uv add 'pymcap-cli[parquet]'\n",
-            file=sys.stderr,
+            "    uv add 'pymcap-cli[parquet]'\n"
         )
         return 1
 
@@ -125,10 +123,9 @@ except ImportError:
 
             uv add 'pymcap-cli[pointcloud]'
         """
-        print(  # noqa: T201
-            "Error:\nPCD export requires numpy + pointcloud2.\n"
-            "Install with:\n\n    uv add 'pymcap-cli[pointcloud]'\n",
-            file=sys.stderr,
+        ERR.print(
+            "[red]Error:[/red]\nPCD export requires numpy + pointcloud2.\n"
+            "Install with:\n\n    uv add 'pymcap-cli[pointcloud]'\n"
         )
         return 1
 
@@ -144,10 +141,9 @@ except ImportError:
 
             uv add 'pymcap-cli[image]'
         """
-        print(  # noqa: T201
-            "Error:\nImage export requires the 'image' extra (imagecodecs).\n"
-            "Install with:\n\n    uv add 'pymcap-cli[image]'\n",
-            file=sys.stderr,
+        ERR.print(
+            "[red]Error:[/red]\nImage export requires the 'image' extra (imagecodecs).\n"
+            "Install with:\n\n    uv add 'pymcap-cli[image]'\n"
         )
         return 1
 
@@ -163,12 +159,11 @@ except ImportError:
 
             uv add --group video pymcap-cli
         """
-        print(  # noqa: T201
-            "Error:\n"
+        ERR.print(
+            "[red]Error:[/red]\n"
             "ROS decompress command is unavailable because the 'av' package is not installed.\n"
             "To enable this functionality, please install pymcap-cli with the 'video' extra:\n\n"
-            "    uv add --group video pymcap-cli\n",
-            file=sys.stderr,
+            "    uv add --group video pymcap-cli\n"
         )
         return 1
 
@@ -177,6 +172,7 @@ app = App(
     name="pymcap-cli",
     help="CLI tool for slicing and dicing MCAP files.",
     help_format="rich",
+    default_parameter=Parameter(negative_iterable=""),
 )
 
 inspect_group = Group("Inspect", sort_key=0)
@@ -187,6 +183,7 @@ app.command(name="cat", group=inspect_group)(cat_cmd.cat)
 app.command(name="diag", group=inspect_group)(diag_cmd.diag)
 app.command(name="du", group=inspect_group)(du_cmd.du)
 app.command(name="diff", group=inspect_group)(diff_cmd.diff_cmd)
+app.command(name="duplicates", group=inspect_group)(duplicates_cmd.duplicates)
 app.command(name="info", group=inspect_group)(info_cmd.info)
 app.command(name="info-json", group=inspect_group)(info_json_cmd.info_json)
 list_cmd.list_app.group = (inspect_group,)
@@ -218,8 +215,32 @@ app.command(name="rosdecompress", group=transform_group)(rosdecompress)
 app.command(name="video", group=transform_group)(video)
 
 
+@app.meta.default
+def launcher(
+    *tokens: Annotated[str, Parameter(allow_leading_hyphen=True)],
+    verbose: Annotated[
+        int,
+        Parameter(
+            name=["--verbose", "-v"],
+            count=True,
+            help="Increase log verbosity. -v: DEBUG.",
+        ),
+    ] = 0,
+    quiet: Annotated[
+        int,
+        Parameter(
+            name=["--quiet"],
+            count=True,
+            help="Decrease log verbosity. Once: WARNING; twice: ERROR.",
+        ),
+    ] = 0,
+) -> int | None:
+    setup_logging(verbose=verbose, quiet=quiet)
+    return app(tokens)
+
+
 def main() -> None:
-    app()
+    app.meta()
 
 
 if __name__ == "__main__":

{pymcap_cli-0.8.0 → pymcap_cli-0.9.0}/src/pymcap_cli/cmd/_run_processor.py

@@ -1,9 +1,13 @@
 """Shared processor pipeline for transform commands."""
 
 import contextlib
+import logging
 from dataclasses import dataclass
 from pathlib import Path
 from typing import BinaryIO
+from urllib.parse import urlparse
+
+from small_mcap import InvalidMagicError, McapError
 
 from pymcap_cli.core.input_handler import open_input
 from pymcap_cli.core.mcap_processor import (
@@ -15,7 +19,9 @@ from pymcap_cli.core.mcap_processor import (
     ProcessingOptions,
     ProcessingStats,
 )
-from pymcap_cli.utils import confirm_output_overwrite
+from pymcap_cli.utils import confirm_output_overwrite, read_info
+
+logger = logging.getLogger(__name__)
 
 
 @dataclass(slots=True)
@@ -79,3 +85,62 @@ def run_processor(
         stats = processor.process(output_stream)
 
     return ProcessorResult(stats=stats, processor=processor)
+
+
+def validate_mcap_output(path: Path) -> bool:
+    """Return True iff the MCAP at ``path`` has a readable header and summary."""
+    try:
+        with path.open("rb") as f:
+            read_info(f)
+    except (McapError, InvalidMagicError, OSError, AssertionError) as e:
+        logger.debug(f"Output validation failed for {path}: {e}")
+        return False
+    return True
+
+
+def delete_source_files(sources: list[str], outputs: list[Path]) -> None:
+    """Delete each local source file. Skip URLs and any source path that
+    resolves to one of ``outputs`` (with a warning).
+    """
+    output_resolved = {p.resolve() for p in outputs}
+    for src in sources:
+        scheme = urlparse(src).scheme
+        if scheme in ("http", "https"):
+            logger.warning(f"Skipping delete: '{src}' is a remote URL")
+            continue
+        path = Path(src)
+        try:
+            resolved = path.resolve()
+        except OSError as e:
+            logger.warning(f"Skipping delete '{src}': {e}")
+            continue
+        if resolved in output_resolved:
+            logger.warning(f"Skipping delete: source '{src}' is also an output")
+            continue
+        try:
+            path.unlink()
+            logger.info(f"Deleted source: {src}")
+        except FileNotFoundError:
+            logger.debug(f"Source already gone: {src}")
+        except OSError:
+            logger.exception(f"Failed to delete '{src}'")
+
+
+def finalize_delete_source(
+    *,
+    sources: list[str],
+    outputs: list[Path],
+) -> int:
+    """Validate every output and, if all valid, delete the eligible sources.
+
+    Returns 0 on success (sources deleted or skipped with warning) and 1 if
+    any output failed validation (no sources are deleted in that case).
+    """
+    invalid = [p for p in outputs if not validate_mcap_output(p)]
+    if invalid:
+        for p in invalid:
+            logger.error(f"[red]Output failed validation: {p}[/red]")
+        logger.error("Source file(s) preserved — output not safe to replace source.")
+        return 1
+    delete_source_files(sources, outputs)
+    return 0

{pymcap_cli-0.8.0 → pymcap_cli-0.9.0}/src/pymcap_cli/cmd/bag2mcap_cmd.py

@@ -249,7 +249,7 @@ def bag2mcap(
     """
     input_path = Path(file)
     if not input_path.exists():
-        console.print(f"[red]Error: Input file '{file}' does not exist[/red]")
+        logger.error(f"Input file '{file}' does not exist")
         return 1
 
     confirm_output_overwrite(output, force)
@@ -266,20 +266,20 @@ def bag2mcap(
         compression=writer_compression,
     )
 
-    console.print(f"[blue]Converting '{file}' to '{output}'[/blue]")
+    logger.info(f"Converting '{file}' to '{output}'")
 
     with output.open("wb") as output_stream:
         try:
             stats = convert_bag_to_mcap(input_path, output_stream, options)
 
-            console.print("[green]Conversion completed successfully[/green]")
+            logger.info("[green]Conversion completed successfully[/green]")
             console.print(
                 f"Converted {stats.topic_count} topics, "
                 f"{stats.message_count:,} messages, "
                 f"{stats.schema_count} schemas"
             )
-        except Exception as e:  # noqa: BLE001
-            console.print(f"[red]Error during conversion: {e}[/red]")
+        except Exception:
+            logger.exception("Error during conversion")
             return 1
 
     return 0

{pymcap_cli-0.8.0 → pymcap_cli-0.9.0}/src/pymcap_cli/cmd/cat_cmd.py

@@ -2,6 +2,7 @@
 
 import base64
 import json
+import logging
 import re
 import sys
 from contextlib import ExitStack
@@ -26,7 +27,7 @@ from small_mcap import Channel, JSONDecoderFactory, read_message_decoded
 from pymcap_cli.core.input_handler import open_input
 from pymcap_cli.utils import MAX_INT64, ProgressTrackingIO, file_progress, parse_timestamp_args
 
-console_err = Console(stderr=True)
+logger = logging.getLogger(__name__)
 console_out = Console()
 
 FILTERING_GROUP = Group("Filtering")
@@ -220,8 +221,8 @@ def cat(
     if query:
         try:
             parsed_query = parse_message_path(query)
-        except Exception as e:  # noqa: BLE001
-            console_err.print(f"[red]Invalid query syntax: {e}[/red]")
+        except Exception:
+            logger.exception("Invalid query syntax")
             return 1
 
     # Determine output mode
@@ -256,18 +257,12 @@ def cat(
                 root_msgdef = all_definitions.get(f"{parts[0]}/{parts[-1]}")
 
             if root_msgdef is None:
-                console_err.print(
-                    f"[yellow]Warning: Could not find message definition "
-                    f"for schema '{msg_schema_name}'[/yellow]"
-                )
+                logger.warning(f"Could not find message definition for schema '{msg_schema_name}'")
             else:
                 parsed_query.validate(root_msgdef, all_definitions)  # type: ignore[union-attr]
-        except ValidationError as e:
-            console_err.print(f"[red]Query validation error for topic '{topic}':[/red]")
-            console_err.print(f"[red]{e}[/red]")
-            console_err.print(
-                f"\n[yellow]Query:[/yellow] {query}\n[yellow]Schema:[/yellow] {msg_schema_name}"
-            )
+        except ValidationError:
+            logger.exception(f"Query validation error for topic '{topic}'")
+            logger.exception(f"Query: {query}  Schema: {msg_schema_name}")
             return 1
         return None
 
@@ -288,7 +283,7 @@ def cat(
         with open_input(file) as (input_stream, file_size), ExitStack() as stack:
             stream: IO[bytes] = input_stream
             if writing_to_file and file_size:
-                progress = file_progress("[bold blue]Reading MCAP...", console_err)
+                progress = file_progress("[bold blue]Reading MCAP...")
                 progress.start()
                 stack.callback(progress.stop)
                 task = progress.add_task("Processing", total=file_size)
@@ -312,9 +307,9 @@ def cat(
                     validated_topics.add(msg.channel.topic)
 
                     if msg.schema is None:
-                        console_err.print(
-                            f"[yellow]Warning: Cannot validate query for topic "
-                            f"'{msg.channel.topic}' (no schema available)[/yellow]"
+                        logger.warning(
+                            f"Cannot validate query for topic '{msg.channel.topic}' "
+                            "(no schema available)"
                         )
                     else:
                         err = _validate_query(msg.schema.name, msg.schema.data, msg.channel.topic)
@@ -328,9 +323,7 @@ def cat(
                         if data is None:
                             continue
                     except MessagePathError as e:
-                        console_err.print(
-                            f"[yellow]Filter error on {msg.channel.topic}: {e}[/yellow]",
-                        )
+                        logger.warning(f"Filter error on {msg.channel.topic}: {e}")
                         continue
                 else:
                     data = msg.decoded_message
@@ -369,22 +362,18 @@ def cat(
                         print(line, file=sys.stdout)  # noqa: T201
 
         if writing_to_file:
-            console_err.print(
-                f"Wrote [bold]{message_count:,}[/bold] messages to [cyan]{output}[/cyan]"
-            )
+            logger.info(f"Wrote {message_count:,} messages to {output}")
 
         if parsed_query and not validated_topics:
-            console_err.print(
-                f"[red]Error: Topic '{parsed_query.topic}' not found in MCAP file[/red]"
-            )
+            logger.error(f"Topic '{parsed_query.topic}' not found in MCAP file")
             return 1
 
     except KeyboardInterrupt:
-        console_err.print("\n[yellow]Interrupted by user[/yellow]")
+        logger.warning("Interrupted by user")
         return 0
 
-    except Exception as e:  # noqa: BLE001
-        console_err.print(f"[red]Error reading MCAP: {e}[/red]")
+    except Exception:
+        logger.exception("Error reading MCAP")
         return 1
 
     return 0

{pymcap_cli-0.8.0 → pymcap_cli-0.9.0}/src/pymcap_cli/cmd/compress_cmd.py

@@ -1,8 +1,14 @@
 """Compress command for pymcap-cli."""
 
+import logging
+
 from rich.console import Console
 
-from pymcap_cli.cmd._run_processor import resolve_overwrite_policy, run_processor
+from pymcap_cli.cmd._run_processor import (
+    finalize_delete_source,
+    resolve_overwrite_policy,
+    run_processor,
+)
 from pymcap_cli.core.mcap_processor import (
     InputOptions,
     OutputOptions,
@@ -12,11 +18,13 @@ from pymcap_cli.types.types_manual import (
     DEFAULT_COMPRESSION,
     ChunkSizeOption,
     CompressionOption,
+    DeleteSourceOption,
     ForceOverwriteOption,
     NoClobberOption,
     OutputPathOption,
 )
 
+logger = logging.getLogger(__name__)
 console = Console()
 
 
@@ -28,6 +36,7 @@ def compress(
     compression: CompressionOption = DEFAULT_COMPRESSION,
     force: ForceOverwriteOption = False,
     no_clobber: NoClobberOption = False,
+    delete_source: DeleteSourceOption = False,
 ) -> int:
     """Create a compressed copy of an MCAP file.
 
@@ -47,6 +56,9 @@ def compress(
         Force overwrite of output file without confirmation.
     no_clobber
         Fail instead of prompting if the output file already exists.
+    delete_source
+        Delete source file(s) after the output is validated (header + summary).
+        URL inputs and any source whose path equals the output are skipped.
 
     Examples
     --------
@@ -56,10 +68,10 @@ def compress(
     """
     overwrite_policy = resolve_overwrite_policy(force=force, no_clobber=no_clobber)
     if overwrite_policy is None:
-        console.print("[red]Error: --force and --no-clobber cannot be used together.[/red]")
+        logger.error("--force and --no-clobber cannot be used together.")
         return 1
 
-    console.print(f"[blue]Compressing '{file}' to '{output}'[/blue]")
+    logger.info(f"Compressing '{file}' to '{output}'")
 
     try:
         result = run_processor(
@@ -74,10 +86,13 @@ def compress(
                 overwrite_policy=overwrite_policy,
             ),
         )
-        console.print("[green]✓ Compression completed successfully![/green]")
+        logger.info("[green]✓ Compression completed successfully![/green]")
         console.print(result.stats)
-    except Exception as e:  # noqa: BLE001
-        console.print(f"[red]Error during compression: {e}[/red]")
+    except Exception:
+        logger.exception("Error during compression")
         return 1
 
+    if delete_source:
+        return finalize_delete_source(sources=[file], outputs=[output])
+
     return 0

{pymcap_cli-0.8.0 → pymcap_cli-0.9.0}/src/pymcap_cli/cmd/convert_cmd.py

@@ -522,7 +522,7 @@ def convert(
     # Validate input file
     input_path = Path(file)
     if not input_path.exists():
-        console.print(f"[red]Error: Input file '{file}' does not exist[/red]")
+        logger.error(f"Input file '{file}' does not exist")
         return 1
 
     # Confirm overwrite if needed
@@ -546,17 +546,17 @@ def convert(
         use_chunking=True,
     )
 
-    console.print(f"[blue]Converting '{file}' to '{output}'[/blue]")
-    console.print(f"[dim]ROS2 distro: {distro.value}[/dim]")
+    logger.info(f"Converting '{file}' to '{output}'")
+    logger.info(f"ROS2 distro: {distro.value}")
     if extra_path:
-        console.print(f"[dim]Extra paths: {', '.join(str(p) for p in extra_path)}[/dim]")
+        logger.info(f"Extra paths: {', '.join(str(p) for p in extra_path)}")
 
     # Perform conversion
     with output.open("wb") as output_stream:
         try:
             stats = convert_db3_to_mcap(input_path, output_stream, options)
 
-            console.print("[green]✓ Conversion completed successfully![/green]")
+            logger.info("[green]✓ Conversion completed successfully![/green]")
             console.print(
                 f"Converted {stats.topic_count} topics, "
                 f"{stats.message_count:,} messages, "
@@ -565,18 +565,16 @@ def convert(
 
             # Report skipped topics if any
             if stats.skipped_topics:
-                console.print(
-                    "[yellow]"
-                    f"⚠ Skipped {len(stats.skipped_topics)} topics "
+                logger.warning(
+                    f"Skipped {len(stats.skipped_topics)} topics "
                     f"({stats.skipped_message_count:,} messages) due to missing message definitions"
-                    "[/]"
                 )
                 console.print("[dim]Skipped topics:[/dim]")
                 for topic in sorted(stats.skipped_topics):
                     console.print(f"  [dim]- {topic}[/dim]")
 
-        except Exception as e:  # noqa: BLE001
-            console.print(f"[red]Error during conversion: {e}[/red]")
+        except Exception:
+            logger.exception("Error during conversion")
             return 1
 
     return 0

{pymcap_cli-0.8.0 → pymcap_cli-0.9.0}/src/pymcap_cli/cmd/diag_cmd.py

@@ -1,6 +1,7 @@
 """Diag command - inspect ROS2 diagnostics from MCAP files."""
 
 import json
+import logging
 import re
 import sys
 from dataclasses import dataclass, field
@@ -18,9 +19,10 @@ from small_mcap import include_topics, read_message_decoded
 
 from pymcap_cli.core.input_handler import open_input
 from pymcap_cli.display.sparkline import sparkline
+from pymcap_cli.log_setup import ERR
 
+logger = logging.getLogger(__name__)
 console = Console()
-console_err = Console(stderr=True)
 
 LEVEL_NAMES = {0: "OK", 1: "WARN", 2: "ERROR", 3: "STALE"}
 LEVEL_STYLES = {0: "green", 1: "yellow", 2: "red", 3: "dim"}
@@ -64,7 +66,7 @@ def _collect_diagnostics(file: str, topics: list[str]) -> dict[str, DiagEntry]:
             TextColumn("[cyan]{task.fields[msgs]} msgs"),
             TextColumn("[dim]{task.fields[components]} components"),
             TimeElapsedColumn(),
-            console=console_err,
+            console=ERR,
             transient=True,
         ) as progress,
     ):
@@ -186,7 +188,7 @@ def _compile_pattern(pattern: str, flag_name: str) -> re.Pattern[str]:
     try:
         return re.compile(pattern, re.IGNORECASE)
     except re.error as e:
-        console_err.print(f"[red]Invalid regex for {flag_name}: {e}[/red]")
+        logger.exception(f"Invalid regex for {flag_name}")
         raise SystemExit(1) from e
 
 
@@ -559,16 +561,16 @@ def diag(
 
     try:
         entries = _collect_diagnostics(file, resolved_topics)
-    except (OSError, ValueError, RuntimeError) as e:
-        console_err.print(f"[red]Error reading MCAP file: {e}[/red]")
+    except (OSError, ValueError, RuntimeError):
+        logger.exception("Error reading MCAP file")
         return 1
     except KeyboardInterrupt:
-        console_err.print("\n[yellow]Interrupted by user[/yellow]")
+        logger.warning("Interrupted by user")
         return 0
 
     if not entries:
         topic_str = ", ".join(resolved_topics)
-        console_err.print(f"[yellow]No diagnostics found on topic(s) '{topic_str}'[/yellow]")
+        logger.warning(f"No diagnostics found on topic(s) '{topic_str}'")
         return 0
 
     level_totals: dict[int, int] = {0: 0, 1: 0, 2: 0, 3: 0}
@@ -592,7 +594,7 @@ def diag(
     if inspect_re:
         matched = [e for e in filtered if inspect_re.search(e.name)]
         if not matched:
-            console_err.print(f"[yellow]No components matching '{inspect}'[/yellow]")
+            logger.warning(f"No components matching '{inspect}'")
             return 0
 
         for renderable in _build_inspect_view(matched):