Move schemas and related code out of Tasks #1076
Conversation
Schemas are generic, this PR moves the Schema code out of pyface.tasks and into pyface.action, making it available for use outside of tasks. Additionally a version of ActionManagerBuilder is included to provide a Tasks-indpendednt way of assembling the Schemas into action managers. Additionally, the code is slightly modified so that it does not import toolkit code as a side-effect. The old locations are kept so imports should still work. They will be removed at some yet-to-be-determined future point.
|
Note that while there is a more immediate need of this change, this opens up the possibility of using Schemas in TraitsUI instead of directly creating pyface.action objects. |
| manager = self._create_action_manager_recurse(schema, additions_map) | ||
| manager.controller = self.controller | ||
| return manager | ||
|
|
||
| def create_menu_bar_manager(self): | ||
| """ Create a menu bar manager from the task's menu bar schema and | ||
| additions. |
There was a problem hiding this comment.
nit: in create_tool_bar_managers we go through self.task.extra_actions instead of self.additions. They are equivalent, but using self.additions feels more consistent
There was a problem hiding this comment.
It should be changed because if a subclass or other user of the class messes with how the additions are built then we will get inconsistent results.
There was a problem hiding this comment.
Thought about this some more, and decided that a lot of this logic for discovering new toolbars really belonged in the base class, so I ended up creating a new get_additional_toolbar_schemas method that takes the additions and produces new objects.
Otherwise users who wanted to have multiple toolbars would need to replicate this method's behaviour.
| Return a dictionary {item_id: list_of_items}, and a list containing | ||
| all the ids ordered by their appearance in the `all_items` list. The | ||
| ordered IDs are used as a replacement for an ordered dictionary, to | ||
| keep compatibility with Python <2.7 . |
There was a problem hiding this comment.
not relevant to this PR, but doing special things to keep py 2.7 compatibility could be removed / refactored at some point
There was a problem hiding this comment.
Yes,I noticed this and decided not to mess with it in this PR.
| @@ -8,6 +8,7 @@ | |||
| # | |||
| # Thanks for using Enthought open source! | |||
|
|
|||
| from contextlib import contextmanager | |||
| import unittest | |||
|
|
|||
|
|
|||
There was a problem hiding this comment.
imports from pyface.tasks.action.api below mayb should get updated to use new pyface.actions.schema.api
There was a problem hiding this comment.
Yep - missed this. There are more places that the imports need to be changed (eg. examples, docs).
Co-authored-by: aaronayres35 <[email protected]>
Co-authored-by: aaronayres35 <[email protected]>
Good catch - my search only looked for imports. Corrected, and I will merge after this. |
Schemas are generic, this PR moves the Schema code out of pyface.tasks and into pyface.action, making it available for use outside of tasks. Additionally a version of
ActionManagerBuilderis included to provide a Tasks-independent way of assembling the Schemas into action managers, which fixes #658.Additionally, the code is slightly modified so that it does not import toolkit code as a side-effect.
The old locations are kept so imports should still work. They will be removed at some yet-to-be-determined future point.