Summary

Allow third-party packages to register new rbt commands.

Review Request #5046 — Created Dec. 3, 2013 and submitted Dec. 16, 2013, 1:52 p.m.

Information

Owner

mike_conley

Repository

RBTools

Branch

master

Bugs

Depends On

Reviewers

Groups

rbtools

People

Description

Allow third-party packages to register new rbt commands.

rbt will now scan for commands that are registered for
the 'rbtools_commands' entrypoint.

Testing Done

Created a simple Python package that registered a new command, and sure enough, it showed up in rbt help, and could be invoked via rbt [command].
I created a third-party commands that tried to override the built-in "post" command, and tested to make sure that only one "post" command was listed with rbt help, and that only the built-in post command could be invoked.

Issues

Description	From	Last Updated
Maybe we should default to commands provided by the rbtools package. So, if rbtools specifies the entry point, we use …	SM smacleod	Dec. 6, 2013, 3:01 p.m.
The {.. for ...} is only in Python 2.7+. It'll need to be rewritten to work with 2.4+.	chipx86	Dec. 15, 2013, 12:24 p.m.
This will end up getting the RBTools ones twice. We should probably filter that out.	chipx86	Dec. 11, 2013, 2:36 p.m.

rbtools/commands/main.py (Diff revision 1)

If another package specifies the same command as rbtools, we'll have a repeat in this list. Think we need to bother de-duplicating?

rbtools/commands/main.py (Diff revision 1)

The issue has been resolved. Show all issues

Maybe we should default to commands provided by the rbtools package. So, if rbtools specifies the entry point, we use that as the command, and only check other packages if it doesn't. Something like:
ep = (pkg_resources.get_entry_info("rbtools", "rbtools_commands", args[0]) ||
      pkg_resources.iter_entry_points("rbtools_commands", args[0]).next())

smacleod Dec. 4, 2013, 12:59 p.m.

Sorry, brain in JS land there for a second. Code should be:
ep = (pkg_resources.get_entry_info("rbtools", "rbtools_commands", args[0]) or
      pkg_resources.iter_entry_points("rbtools_commands", args[0]).next())

Change Summary:

Good call, smacleod. I've modified the patch to de-dupe command names, and to try to use the RBTools built-in commands before checking for third-party commands.

Diff:

Revision 2 (+9 -3)

Show changes

rbtools/commands/main.py

rbtools/commands/main.py (Diff revision 2)

The issue has been resolved. Show all issues

The {.. for ...} is only in Python 2.7+. It'll need to be rewritten to work with 2.4+.

rbtools/commands/main.py (Diff revision 2)

The issue has been dropped. Show all issues

This will end up getting the RBTools ones twice. We should probably filter that out.

smacleod Dec. 10, 2013, 8:23 a.m.

It shouldn't. We're only searching for the value of args[0], so if the command
exists in rbtools get_entry_info() will shortcircuit the or, and we'll never
call iter_entry_points. In the case where rbtools doesn't have the command, it
won't be there for iter_entry_points.

chipx86 Dec. 11, 2013, 2:36 p.m.
```
That's fair.
```

Change Summary:

Thanks for the feedback! I just cast to a set and back to a list to dedupe the commands instead of a set comprehension. Seems to do the job.

Testing Done:

		Created a simple Python package that registered a new command, and sure enough, it showed up in rbt help, and could be invoked via rbt [command].

~		Not sure if further testing is required / desired...
	~	I created a third-party commands that tried to override the built-in "post" command, and tested to make sure that only one "post" command was listed with rbt help, and that only the built-in post command could be invoked.

Diff:

Revision 3 (+10 -3)

Show changes

rbtools/commands/main.py

Ship it!

```
Ship It!
```

Status: Closed (submitted)

Change Summary:

Pushed to master (6474d851ff5074a460b9dec2e684df689f4e7636).