Add typing to the parent attribute of ExceptHandler #1385
Conversation
DanielNoord
added
the
Maintenance
There was a problem hiding this comment.
I recommend not to move forward with this exact PR at this time.
It would be better to implement the parent decorator first (if it works as expected). Furthermore, I'm working on some extensive rebuilder changes. It's probably better to consider it after those are done. There is also the rewrite for the Try nodes I mentioned in #1384 (review). Lastly, assuming the parent should be a TryExcept node might make sense here. That doesn't mean though that similar cases also do. In general we should be cautious about such assumptions, not all astroid plugins might adhere to the official Python AST. Adding an additional isinstance check in pylint certainly doesn't hurt.
| def __init__( | ||
| self, | ||
| lineno: Optional[int] = None, | ||
| col_offset: Optional[int] = None, | ||
| parent: Optional[NodeNG] = None, | ||
| # TODO: Make parent non-optional |
There was a problem hiding this comment.
This wouldn't really work for plugins / brain modules. They might want to construct a Node outside the tree first before inserting it in the end.
| # TODO: Make parent non-optional | ||
| parent: Optional["nodes.TryExcept"] |
There was a problem hiding this comment.
Saying the parent attribute is required (except for Module nodes), might work with a decorator.
def __init__(..., parent: Optional["NodeNG"], ...):
self._parent = parent # this needs to stay optional
@property
def parent(self) -> "NodeNG":
assert self._parent # here, we make sure it has actually been assigned
return self._parent
@parent.setter
def parent(self, value: "NodeNG") -> None:
self._parent = valueIf you would like to explore that further in a new PR, an additional tip. Since Module inherits from NodeNG and doesn't have a parent, the decorator can't be added there. You'd probably need to create a new subclass which all nodes (except for Module) inherit from to implement it.
|
Good points @cdce8p! I'll wait on the rebuilder refactor before doing anything like this. Let me know if I can be of any help anywhere! |
I'll probably need to write some kind of design doc (either in the PR or in a separate issue). Will make sure to let you know when I do, feedback should definitely help! The |
It's also something I hope to use for attributes that are currently defined as optional but never are. Like the |
|
I can certainly take a look at the decorator concept when I get some time. Probably after |
Steps
Description
Inspired by the work of @jacobtylerwalls in pylint-dev/pylint#5764.
Is there a good way to make
parentnon-optional?Type of Changes
Related Issue