8000 Support method plugin hooks on unions by ilevkivskyi · Pull Request #6560 · python/mypy · GitHub
[go: up one dir, main page]
Skip to content

Support method plugin hooks on unions #6560

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.

Sign up for GitHub

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 17 commits into from
Jul 4, 2019
Merged

Support method plugin hooks on unions #6560

Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
ae0f78d
Support plugin hooks on unions (normal methods)
ilevkivskyi Mar 4, 2019
b3633bc
Support plugin hooks on unions (special methods)
ilevkivskyi Mar 4, 2019
39301bb
Merge remote-tracking branch 'upstream/master' into union-plugin-other
ilevkivskyi Mar 17, 2019
15fafd3
Simplify logic
ilevkivskyi Mar 18, 2019
efd04a6
Add comments and docstrings (and some more simplification)
ilevkivskyi Mar 18, 2019
2dbbefb
Add dedicated tests
ilevkivskyi Mar 18, 2019
72870a7
Fix self-check
ilevkivskyi Mar 18, 2019
8d1dcff
More tests
ilevkivskyi Mar 18, 2019
bd6e18d
Merge branch 'master' into union-plugin-other
ilevkivskyi Mar 29, 2019
1d8a32f
Merge remote-tracking branch 'upstream/master' into union-plugin-other
ilevkivskyi Jun 29, 2019
4d7aa10
Update after merge
ilevkivskyi Jun 29, 2019
a643bbd
Address CR
ilevkivskyi Jun 29, 2019
b3b8d89
A cleaner solution for non-overlapping types
ilevkivskyi Jun 29, 2019
55b4624
Fix lint
ilevkivskyi Jun 29, 2019
2bdb8be
Try fixing Python 3.5.1
ilevkivskyi Jun 29, 2019
8000
12b4303
Merge remote-tracking branch 'upstream/master' into union-plugin-other
Jul 3, 2019
d36ea3c
Address CR
Jul 3, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Address CR
  • Loading branch information
@ilevkivskyi
ilevkivskyi committed Jun 29, 2019
commit a643bbd47cff914ff7f9263dc47c3053f56375b9
99 changes: 61 additions & 38 deletions mypy/checkexpr.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -640,10 +640,11 @@ def check_call_expr_with_callee_type(self,
member: Optional[str] = None) -> Type:
"""Type check call expression.

The given callee type overrides the type of the callee
expression.
The callee_type should be used as the type of callee expression. In particular,
in case of a union type this can be a particular item of the union, so that we can
apply plugin hooks to each item.

Copy link
Collaborator

Choose a reason for hiding this comment

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

The above docstring part was a bit confusing. It looks like we aren't actually overriding the callee type but to reusing a previously calculated callee type. This looks like an optimization. Maybe update the docstring to mention that? Otherwise it's not clear whether recalculating the callee type is correct.

The 'callable_name' and 'object_type' are used to call plugin hooks.
The 'member', 'callable_name' and 'object_type' are only used to call plugin hooks.
If 'callable_name' is None but 'member' is not None (member call), try constructing
'callable_name' using 'object_type' (the base type on which the method is called),
for example 'typing.Mapping.get'.
Expand All @@ -657,33 +658,36 @@ def check_call_expr_with_callee_type(self,
callable_name, callee_type, e.args, e.arg_kinds, e, e.arg_names, object_type)
# Unions are special-cased to allow plugins to act on each item in the union.
elif member is not None and isinstance(object_type, UnionType):
res = [] # type: List[Type]
for typ in object_type.items:
# Member access errors are already reported when visiting the member expression.
self.msg.disable_errors()
item = analyze_member_access(member, typ, e, False, False, False,
self.msg, original_type=object_type, chk=self.chk,
in_literal_context=self.is_literal_context())
self.msg.enable_errors()
item = self.narrow_type_from_binder(e.callee, item)
# TODO: This check is not one-to-one with non-special-cased behavior.
# Ideas for more precise checks:
# * reverse-engineering of mypy.meet.narrow_declared_type()
# * apply special-casing only if we know some hooks will be applied
if (isinstance(item, NoneType) and not state.strict_optional or
isinstance(item, UninhabitedType) and state.strict_optional):
continue
callable_name = self.method_fullname(typ, member)
item_object_type = typ if callable_name else None
res.append(self.check_call_expr_with_callee_type(item, e, callable_name,
item_object_type))
return UnionType.make_simplified_union(res)

return self.check_union_call_expr(e, object_type, member)
return self.check_call(callee_type, e.args, e.arg_kinds, e,
e.arg_names, callable_node=e.callee,
callable_name=callable_name,
object_type=object_type)[0]

def check_union_call_expr(self, e: CallExpr, object_type: UnionType, member: str) -> Type:
""""Type check calling a member expression where the base type is a union."""
res = [] # type: List[Type]
for typ in object_type.relevant_items():
# Member access errors are already reported when visiting the member expression.
self.msg.disable_errors()
item = analyze_member_access(member, typ, e, False, False, False,
self.msg, original_type=object_type, chk=self.chk,
in_literal_context=self.is_literal_context())
self.msg.enable_errors()
item = self.narrow_type_from_binder(e.callee, item)
# TODO: This check is not one-to-one with non-special-cased behavior.
# Ideas for more precise checks:
# * reverse-engineering of mypy.meet.narrow_declared_type()
# * apply special-casing only if we know some hooks will be applied
if (isinstance(item, NoneType) and not state.strict_optional or
isinstance(item, UninhabitedType) and state.strict_optional):
continue
callable_name = self.method_fullname(typ, member)
item_object_type = typ if callable_name else None
res.append(self.check_call_expr_with_callee_type(item, e, callable_name,
item_object_type))
return UnionType.make_simplified_union(res)

def check_call(self,
callee: Type,
args: List[Expression],
Expand Down Expand Up @@ -2057,19 +2061,9 @@ def check_method_call_by_name(self,
original_type = original_type or base_type
# Unions are special-cased to allow plugins to act on each element of the union.
if isinstance(base_type, UnionType):
res = [] # type: List[Type]
meth_res = [] # type: List[Type]
for typ in base_type.relevant_items():
# Format error messages consistently with
# mypy.checkmember.analyze_union_member_access().
local_errors.disable_type_names += 1
item, meth_item = self.check_method_call_by_name(method, typ, args, arg_kinds,
context, local_errors,
original_type)
local_errors.disable_type_names -= 1
res.append(item)
meth_res.append(meth_item)
return UnionType.make_simplified_union(res), UnionType.make_simplified_union(meth_res)
return self.check_union_method_call_by_name(method, base_type,
args, arg_kinds,
context, local_errors, original_type)

method_type = analyze_member_access(method, base_type, context, False, False, True,
local_errors, original_type=original_type,
Expand All @@ -2078,6 +2072,35 @@ def check_method_call_by_name(self,
return self.check_method_call(
method, base_type, method_type, args, arg_kinds, context, local_errors)

def check_union_method_call_by_name(self,
method: str,
base_type: UnionType,
args: List[Expression],
arg_kinds: List[int],
context: Context,
local_errors: Optional[MessageBuilder] = None,
original_type: Optional[Type] = None
) -> Tuple[Type, Type]:
"""Type check a call to a named method on an object with union type.

This essentially checks the call using check_method_call_by_name() for each
union item and unions the result. We do this to allow plugins to act on
individual union items.
"""
res = [] # type: List[Type]
meth_res = [] # type: List[Type]
for typ in base_type.relevant_items():
# Format error messages consistently with
# mypy.checkmember.analyze_union_member_access().
local_errors.disable_type_names += 1
item, meth_item = self.check_method_call_by_name(method, typ, args, arg_kinds,
context, local_errors,
original_type)
local_errors.disable_type_names -= 1
res.append(item)
meth_res.append(meth_item)
return UnionType.make_simplified_union(res), UnionType.make_simplified_union(meth_res)

def check_method_call(self,
method_name: str,
base_type: Type,
Expand Down
0