Use plugins to define rhino installable packages #614
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
10 tasks
|
ping |
tomvanmele
approved these changes
Sep 16, 2020
Comment on lines
+122
to
+142
| @compas.plugins.pluggable(category='install', selector='collect_all') | ||
| def installable_rhino_packages(): | ||
| """Provide a list of packages to make available inside Rhino. | ||
|
|
||
| Extensions providing Rhino or Grasshopper features | ||
| can implement this pluggable interface to automatically | ||
| have their packages made available inside Rhino when | ||
| COMPAS is installed into it. | ||
|
|
||
| Examples | ||
| -------- | ||
| >>> import compas.plugins | ||
| >>> @compas.plugins.plugin(category='install') | ||
| ... def installable_rhino_packages(): | ||
| ... return ['compas_fab'] | ||
|
|
||
| Returns | ||
| ------- | ||
| :obj:`list` of :obj:`str` | ||
| List of package names to make available inside Rhino. | ||
| """ |
There was a problem hiding this comment.
so in some other package you would basically write a plugin for this function that adds itself to the list of installable packages?
There was a problem hiding this comment.
yep, eg. compas_fab: compas-dev/compas_fab#200
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The main goal of this PR is to change the way other packages install themselves into Rhino to make it a more straightforward experience for the user.
Currently, non-core packages (eg.
compas_fab) need to be explicitly installed using something likepython -m compas_rhino.install -p compas_fab. This works fine for simple packages, but as soon as packages have other dependencies, the thing gets messy. In the case ofcompas_fab, we provide a wrapped installer that takes care of both compas core and compas_fab+dependencies (python -m compas_fab.rhino.install) but this means extra code on each package that needs this behavior, and a confusing situation with similar but not entirely identical commands to install compas stuff.So this PR leverages the new plugin system, defines a new
pluggableextension point for packages to announce which packages they need and changes the install process to discover all existing plugins on that extension point and retrieve all the required rhino-installable packages.For this purpose, the plugin system now has two types of plugins (
first_match(default) andcollect_all), and as an almost side note, I create a doc page to list all available extension points, otherwise it's very hard to discover them (eventually, this page generation should be automated):There are already 3 examples of using this new end-point, two are in this PR:
compas_rhinoandcompas_ghpython, instead of hard-coding the package names that need to go to Rhino, they define them using the same extension point. And forcompas_fab, just opened a pr to do the same.What type of change is this?
Checklist
Put an
xin the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.CHANGELOG.mdfile in theUnreleasedsection under the most fitting heading (e.g.Added,Changed,Removed).invoke test).invoke lint).compas.datastructures.Mesh.