From 40deb51ba4ebe90427104c2cf30335410bf52197 Mon Sep 17 00:00:00 2001 From: Christophe Bedard Date: Tue, 28 Sep 2021 14:27:15 -0400 Subject: [PATCH] Deprecate 'convert' verb since it is just an implementation detail Signed-off-by: Christophe Bedard --- ros2trace_analysis/ros2trace_analysis/verb/convert.py | 4 +++- tracetools_analysis/tracetools_analysis/convert.py | 8 +++++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/ros2trace_analysis/ros2trace_analysis/verb/convert.py b/ros2trace_analysis/ros2trace_analysis/verb/convert.py index 62ea13f..9e0af21 100644 --- a/ros2trace_analysis/ros2trace_analysis/verb/convert.py +++ b/ros2trace_analysis/ros2trace_analysis/verb/convert.py @@ -18,12 +18,14 @@ from tracetools_analysis.convert import convert class ConvertVerb(VerbExtension): - """Convert trace data to a file.""" + """Convert trace data to a file. DEPRECATED: use the 'process' verb directly.""" def add_arguments(self, parser, cli_name): add_args(parser) def main(self, *, args): + import warnings + warnings.warn("'convert' is deprecated, use 'process' directly instead", stacklevel=2) return convert( args.trace_directory, args.output_file_name, diff --git a/tracetools_analysis/tracetools_analysis/convert.py b/tracetools_analysis/tracetools_analysis/convert.py index 80d92ae..a79904a 100644 --- a/tracetools_analysis/tracetools_analysis/convert.py +++ b/tracetools_analysis/tracetools_analysis/convert.py @@ -41,7 +41,11 @@ def add_args(parser: argparse.ArgumentParser) -> None: def parse_args() -> argparse.Namespace: parser = argparse.ArgumentParser( - description='Convert trace data to a file.') + description=( + 'Convert trace data to a file. ' + "DEPRECATED: use the 'process' verb directly." + ), + ) add_args(parser) return parser.parse_args() @@ -79,4 +83,6 @@ def main(): trace_directory = args.trace_directory output_file_name = args.output_file_name + import warnings + warnings.warn("'convert' is deprecated, use 'process' directly instead", stacklevel=2) convert(trace_directory, output_file_name)