Repository navigation
Reuse of “exc” name in __init__.py confuses Pylint #1587
Description
Activity
No matter what the intention was, it appears the documentation could be updated to mention these can be imported using multiple paths.
Further, it appears
except E as exccan be fixed as well, and a contribution for all of that is definitely welcome.No matter what the intention was, it appears the documentation could be updated to mention these can be imported using multiple paths.
I was thinking, if it wasn’t intentional, it would be better not to document it since if it’s documented, people might rely on it, but if it’s not documented, it’s OK to break it in future versions. So I figured it was up to you.
Further, it appears
except E as exccan be fixed as well, and a contribution for all of that is definitely welcome.PEP 8 appears to suggest using a leading underscore for module-private global variables; is that your preference here? If so I can throw together an MR that does that.
I think the only fix possible is to turn
… as excinto… as _exc, and a PR is very welcome. Thanks for your help.
It’s not entirely clear how one is supposed to name GitPython’s exceptions:
git.excmodule.__init__.py, the very first line doesfrom git.exp import *, meaning they can actually just be referenced in thegitmodule instead if one wishes (is that intentional/public knowledge?).Then, further down
__init__.py, there are two places whereexcept Something as excis done in module-level code. While those won’t execute on success (and will prevent the module from importing on failure), they do confuse Pylint: if I try toexcept git.exc.InvalidGitRepositoryErrorin my own code and then lint it, Pylint complains thatInstance of 'GitError' has no 'InvalidGitRepositoryError' member, because it believes the namegit.excitself might actually be an instance ofGitError(as it would be if thisexceptclause were taken).Is it intended that we refer to exception classes from
gitrather thangit.exc? If so, could the documentation be updated? If not—if we are not supposed to know about thefrom git.exc import *—could the variable names used in thoseexceptblocks be modified to not collide with a submodule name?