Skip to content

Declare global variables that are created elsewhere #10689

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

Merged
merged 1 commit into from
Apr 1, 2018

Conversation

cclauss
Copy link

@cclauss cclauss commented Mar 5, 2018

Fixes #10502

PR Summary

Declare show and FigureManager as global variables because they are created by an _@Backend.export decorator at the bottom or each file. The global declaration and associated comment helps both humans and linters make sense of this non-intuitive situation.

PR Checklist

  • Has Pytest style unit tests
  • Code is PEP 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

@jklymak jklymak added this to the v3.0 milestone Mar 5, 2018
@cclauss
Copy link
Author

cclauss commented Mar 13, 2018

@tacaswell @anntzer Your review of this approach?

Copy link
Contributor

@anntzer anntzer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's kind of funny that this placates flake8 but I guess the point is that it cannot know all the places where a global could be introduced. I think it's a reasonable compromise.

Given that the global declaration is not actually needed, I'd make the comment more explicit: "...; declaration placates pyflakes" (something like that) (otherwise someone could just remove it at some point thinking it's redundant)

@cclauss
Copy link
Author

cclauss commented Mar 14, 2018

Comments updated as requested.

@jkseppan jkseppan merged commit b5b0003 into matplotlib:master Apr 1, 2018
@cclauss cclauss deleted the declare-globals branch April 1, 2018 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

'FigureManager' is an undefined name in backend_wx.py
4 participants