niklas/tracetools_analysis
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Deprecate 'convert' verb since it is just an implementation detail

Browse source 
Signed-off-by: Christophe Bedard <bedard.christophe@gmail.com>
This commit is contained in:
Christophe Bedard 2021-09-28 14:27:15 -04:00
parent 92544235d8
commit 40deb51ba4
2 changed files with 10 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
ros2trace_analysis/ros2trace_analysis/verb/convert.py
View file

@ -18,12 +18,14 @@ from tracetools_analysis.convert import convert
class ConvertVerb(VerbExtension): 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): def add_arguments(self, parser, cli_name):
add_args(parser) add_args(parser)
def main(self, *, args): def main(self, *, args):
import warnings
warnings.warn("'convert' is deprecated, use 'process' directly instead", stacklevel=2)
return convert( return convert(
args.trace_directory, args.trace_directory,
args.output_file_name, args.output_file_name,

8
tracetools_analysis/tracetools_analysis/convert.py
View file

@ -41,7 +41,11 @@ def add_args(parser: argparse.ArgumentParser) -> None:
def parse_args() -> argparse.Namespace: def parse_args() -> argparse.Namespace:
parser = argparse.ArgumentParser( 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) add_args(parser)
return parser.parse_args() return parser.parse_args()
@ -79,4 +83,6 @@ def main():
trace_directory = args.trace_directory trace_directory = args.trace_directory
output_file_name = args.output_file_name 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) convert(trace_directory, output_file_name)