MEP22: Navigation by events #3652
- Loading branch information
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3230,41 +3230,27 @@ class NavigationBase(object): | |
|
|
||
| Attributes | ||
|
Member
There was a problem hiding this comment. This isn't lined up with the underscores below |
||
| ---------- | ||
| manager : `FigureManager` instance | ||
| toolbar : `Toolbar` instance that is controlled by this `Navigation` | ||
| keypresslock : `LockDraw` to know if the `canvas` key_press_event is | ||
| locked | ||
| messagelock : `LockDraw` to know if the message is available to write | ||
| """ | ||
|
|
||
| _default_cursor = cursors.POINTER | ||
|
|
||
| def __init__(self, manager): | ||
| """.. automethod:: _toolbar_callback""" | ||
|
|
||
| self.manager = manager | ||
| self.canvas = manager.canvas | ||
| self.toolbar = manager.toolbar | ||
|
|
||
| self._key_press_handler_id = self.canvas.mpl_connect( | ||
| 'key_press_event', self._key_press) | ||
|
|
||
| self._idDrag = self.canvas.mpl_connect( | ||
| 'motion_notify_event', self._mouse_move) | ||
|
|
||
| # a dict from axes index to a list of view limits | ||
| self.views = cbook.Stack() | ||
|
|
@@ -3280,36 +3266,15 @@ def __init__(self, canvas, toolbar=None): | |
| # to write into toolbar message | ||
| self.messagelock = widgets.LockDraw() | ||
|
|
||
| for name, tool in tools.tools: | ||
| if tool is None: | ||
| if self.toolbar is not None: | ||
| self.toolbar.add_separator(-1) | ||
| else: | ||
| self.add_tool(name, tool, None) | ||
|
|
||
| self._last_cursor = self._default_cursor | ||
|
|
||
| @property | ||
| def active_toggle(self): | ||
| """Toggled Tool | ||
|
|
@@ -3381,8 +3346,7 @@ def unregister(self, name): | |
| This method is used by `PersistentTools` to remove the reference kept | ||
| by `Navigation`. | ||
|
|
||
| It is usually called by the `unregister` method | ||
|
|
||
| If called, next time the `Tool` is used it will be reinstantiated | ||
| instead of using the existing instance. | ||
|
|
@@ -3411,29 +3375,27 @@ def remove_tool(self, name): | |
| if self.toolbar: | ||
| self.toolbar._remove_toolitem(name) | ||
|
|
||
| def add_tool(self, name, tool, position=None): | ||
| """Add tool to `Navigation` | ||
|
|
||
| Parameters | ||
| ---------- | ||
| name : string | ||
| Name of the tool, treated as the ID, has to be unique | ||
| tool : string or `Tool` class | ||
| Reference to find the class of the Tool to be added | ||
| position : int or None (default) | ||
| Position in the toolbar, if None, is positioned at the end | ||
| """ | ||
|
|
||
| tool_cls = self._get_cls_to_instantiate(tool) | ||
| if tool_cls is False: | ||
|
Member
There was a problem hiding this comment. probably should do a
Member
Author
There was a problem hiding this comment. Sorry, I don't see the pep8 error here.
Member
There was a problem hiding this comment. I think this should be Wouldn't be simpler to just have I suspect @WeatherGod also has a pyflake/pylint turned on.
Member
There was a problem hiding this comment. also, I am reading and commenting top-down. Sorry if some of these seem dumb in light of code I have not read yet.
Member
Author
There was a problem hiding this comment. done @tacaswell change, but still not see the pep8 error
Member
There was a problem hiding this comment. Different versions of pep8? I find myself curious to learn about this as Travis doesn't complain. |
||
| warnings.warn('Impossible to find class for %s' % str(tool)) | ||
|
Member
There was a problem hiding this comment. Shouldn't this raise an exception? The function failed to achieve its goal and no new tool was added. |
||
| return | ||
|
|
||
| if name in self._tools: | ||
|
Member
There was a problem hiding this comment. Should this be done first in this function? Do we want to check to make sure that they are the same type? Again, why warn rather than raise?
Member
Author
There was a problem hiding this comment. I used warn because i don't think that adding twice the same tool represents a major fault and your program will keep working as expected (you already have the tool) |
||
| warnings.warn('A tool_cls with the same name already exist, ' | ||
|
Member
There was a problem hiding this comment. a user won't know what Also, "exist" --> "exists". |
||
| 'not added') | ||
| return | ||
|
|
||
| self._tools[name] = tool_cls | ||
|
|
@@ -3444,7 +3406,7 @@ def add_tool(self, tool): | |
| (k, self._keys[k], name)) | ||
| self._keys[k] = name | ||
|
|
||
| if self.toolbar and tool_cls.intoolbar: | ||
| # TODO: better search for images, they are not always in the | ||
| # datapath | ||
| basedir = os.path.join(rcParams['datapath'], 'images') | ||
|
|
@@ -3453,10 +3415,11 @@ def add_tool(self, tool): | |
| else: | ||
| fname = None | ||
| toggle = issubclass(tool_cls, tools.ToolToggleBase) | ||
| self.toolbar._add_toolitem(name, | ||
| tool_cls.description, | ||
| fname, | ||
| position, | ||
| toggle) | ||
|
|
||
| def _get_cls_to_instantiate(self, callback_class): | ||
| if isinstance(callback_class, six.string_types): | ||
|
|
@@ -3505,7 +3468,7 @@ def _key_press(self, event): | |
|
|
||
| def _get_instance(self, name): | ||
| if name not in self._instances: | ||
| instance = self._tools[name](self.canvas.figure, name) | ||
| # register instance | ||
| self._instances[name] = instance | ||
|
|
||
|
|
@@ -3551,26 +3514,23 @@ def _handle_toggle(self, name, event=None, from_toolbar=False): | |
| for a in self.canvas.figure.get_axes(): | ||
| a.set_navigate_mode(self._toggled) | ||
|
|
||
| def get_tools(self): | ||
| """Return the tools controlled by `Navigation`""" | ||
|
|
||
| d = {} | ||
| for name in sorted(self._tools.keys()): | ||
| tool = self._tools[name] | ||
| keys = [k for k, i in six.iteritems(self._keys) if i == name] | ||
| d[name] = {'cls': tool, | ||
| 'description': tool.description, | ||
| 'keymap': keys} | ||
| return d | ||
|
|
||
| def update(self): | ||
| """Reset the axes stack""" | ||
|
|
||
| self.views.clear() | ||
| self.positions.clear() | ||
|
|
||
| def _mouse_move(self, event): | ||
| if not event.inaxes or not self._toggled: | ||
|
|
@@ -3667,7 +3627,6 @@ def push_current(self): | |
| a.get_position().frozen())) | ||
| self.views.push(lims) | ||
| self.positions.push(pos) | ||
|
|
||
| def draw_rubberband(self, event, caller, x0, y0, x1, y1): | ||
| """Draw a rectangle rubberband to indicate zoom limits | ||
|
|
@@ -3719,7 +3678,7 @@ def __init__(self, manager): | |
| self.manager = manager | ||
|
|
||
| def _add_toolitem(self, name, description, image_file, position, | ||
| toggle): | ||
| """Add a toolitem to the toolbar | ||
|
|
||
| The callback associated with the button click event, | ||
|
|
@@ -3776,7 +3735,8 @@ def _toggle(self, name, callback=False): | |
|
|
||
| """ | ||
|
|
||
| # carefull, callback means to perform or not the callback while | ||
| # toggling | ||
| raise NotImplementedError | ||
|
|
||
| def _remove_toolitem(self, name): | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since these are examples, I would suggest getting rid of extraneous commented out code, and also highlight important lines of code such as this one. For example, is it important that it gets called before importing pyplot? What is it for? Perhaps a short docstring at the top of this example would help explain its purpose/goal that it is demonstrating?