Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add command line interface for file parsing and conversion #57

Merged
merged 3 commits into from
Dec 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,24 @@ print(urdf_string)

</details>

## Command Line Interface

ROD provides a command line interface (CLI) for processing robot description files. You can use the CLI to display file attributes or convert files between URDF and SDF formats.

### Usage

- Display the attributes of an SDF file:

```sh
rod --file /path/to/file.sdf --show
```

- Convert an SDF file to URDF:

```sh
rod --file /path/to/file.sdf -o /path/to/file.urdf
```

## Similar projects

- https://github.com/gazebosim/sdformat
Expand Down
115 changes: 115 additions & 0 deletions src/rod/__main__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
import argparse
import importlib.metadata
import logging
import sys

from rod import logging as rodlogging


def main() -> None:
"""
Main function of the ROD command line interface.
"""
parser = argparse.ArgumentParser(
prog="rod",
description="ROD: The ultimate Python tool for RObot Descriptions processing.",
usage="%(prog)s [options] file",
)

# Version.
parser.add_argument(
"-V",
"--version",
action="version",
version=f"%(prog)s {importlib.metadata.version('rod')}",
)

# Verbose output.
parser.add_argument(
"-vv",
"--verbose",
action="store_true",
help="enable verbose output.",
)

# File to parse.
parser.add_argument(
"-f",
"--file",
type=str,
help="path to the file to parse.",
required=False,
)

# Option to display the parser file attributes.
parser.add_argument(
"-s",
"--show",
action="store_true",
help="show the robot model attributes.",
)

# Option to output a URDF or SDF file.
parser.add_argument(
"-o",
"--output",
type=str,
help="Output file path.",
)

args = parser.parse_args()

log_level = logging.DEBUG if args.verbose else logging.INFO

flferretti marked this conversation as resolved.
Show resolved Hide resolved
logging.basicConfig(level=log_level)

from rod.urdf.exporter import UrdfExporter

# Ensure file argument is provided if output or `show` is specified.
if not args.file and (args.output or args.show):
parser.error(
"The `--file` argument is required when using `--output` or `--show`."
)

# Show the file attributes if no output file is specified.
if args.file and not (args.output or args.show):
args.show = True

# Display the parsed file attributes.
if args.file:
from rod import Sdf

try:
sdf = Sdf.load(sdf=args.file)
except Exception as e:
rodlogging.error(f"Error loading file: {e}")
sys.exit(1)

if args.show:
print(sdf.to_string())

# Output the URDF or SDF file.
if args.output:

try:
if args.output.endswith(".urdf"):
with open(args.output, "w") as file:
file.write(UrdfExporter(pretty=True).to_urdf_string(sdf=sdf))

elif args.output.endswith(".sdf"):
with open(args.output, "w") as file:
file.write(sdf.serialize(pretty=True))

else:
rodlogging.error(
f"Unsupported output file extension for '{args.output}'. Supported extensions are '.urdf' and '.sdf'."
)
sys.exit(1)

except Exception as e:
rodlogging.exception(f"Error writing output file: {e}")
sys.exit(1)


if __name__ == "__main__":
main()
Loading