Make FuncItem.arguments optional

When FuncDef is deserialized we don't reconstruct the arguments.
Previous code was deleting the attribute, leading to #11899; instead,
always set the attribute, maybe to None, and mypy can remind us to
check for not None before use.

Author: fperrin

mypy/checker.py

@@ -1005,6 +1005,7 @@ def check_func_def(self, defn: FuncItem, typ: CallableType, name: Optional[str])
                             arg_type = self.named_generic_type('builtins.dict',
                                                                [self.str_type(),
                                                                 arg_type])
+                    assert item.arguments is not None
                     item.arguments[i].variable.type = arg_type
 
                 # Type check initialization expressions.
@@ -1051,6 +1052,7 @@ def check_func_def(self, defn: FuncItem, typ: CallableType, name: Optional[str])
             self.binder = old_binder
 
     def check_default_args(self, item: FuncItem, body_is_trivial: bool) -> None:
+        assert item.arguments is not None
         for arg in item.arguments:
             if arg.initializer is None:
                 continue

mypy/checkexpr.py

@@ -3618,6 +3618,7 @@ def infer_lambda_type_using_context(self, e: LambdaExpr) -> Tuple[Optional[Calla
             # See https://github.com/python/mypy/issues/9927
             return None, None
 
+        assert e.arguments is not None
         arg_kinds = [arg.kind for arg in e.arguments]
 
         if callable_ctx.is_ellipsis_args or ctx.param_spec() is not None:

mypy/messages.py

@@ -1950,10 +1950,12 @@ def [T <: int] f(self, x: int, y: T) -> None
             s += ' = ...'
 
     # If we got a "special arg" (i.e: self, cls, etc...), prepend it to the arg list
-    if isinstance(tp.definition, FuncDef) and tp.definition.name is not None:
+    if isinstance(tp.definition, FuncDef) and \
+       tp.definition.name is not None and \
+       tp.definition.arguments is not None:
         definition_args = [arg.variable.name for arg in tp.definition.arguments]
         if definition_args and tp.arg_names != definition_args \
-                and len(definition_args) > 0 and definition_args[0]:
+           and len(definition_args) > 0 and definition_args[0]:
             if s:
                 s = ', ' + s
             s = definition_args[0] + s

mypy/nodes.py

@@ -642,7 +642,7 @@ def set_line(self,
 class FuncItem(FuncBase):
     """Base class for nodes usable as overloaded function items."""
 
-    __slots__ = ('arguments',  # Note that can be None if deserialized (type is a lie!)
+    __slots__ = ('arguments',  # Note that can be None if deserialized
                  'arg_names',  # Names of arguments
                  'arg_kinds',  # Kinds of arguments
                  'min_args',  # Minimum number of arguments
@@ -658,14 +658,14 @@ class FuncItem(FuncBase):
                  'expanded',  # Variants of function with type variables with values expanded
                  )
 
-    __deletable__ = ('arguments', 'max_pos', 'min_args')
+    __deletable__ = ('max_pos', 'min_args')
 
     def __init__(self,
                  arguments: List[Argument],
                  body: 'Block',
                  typ: 'Optional[mypy.types.FunctionLike]' = None) -> None:
         super().__init__()
-        self.arguments = arguments
+        self.arguments: Optional[List[Argument]] = arguments
         self.arg_names = [None if arg.pos_only else arg.variable.name for arg in arguments]
         self.arg_kinds: List[ArgKind] = [arg.kind for arg in self.arguments]
         self.max_pos: int = (
@@ -693,6 +693,7 @@ def set_line(self,
                  column: Optional[int] = None,
                  end_line: Optional[int] = None) -> None:
         super().set_line(target, column, end_line)
+        assert self.arguments is not None
         for arg in self.arguments:
             arg.set_line(self.line, self.column, self.end_line)
 
@@ -772,7 +773,7 @@ def deserialize(cls, data: JsonDict) -> 'FuncDef':
         ret.arg_names = data['arg_names']
         ret.arg_kinds = [ArgKind(x) for x in data['arg_kinds']]
         # Leave these uninitialized so that future uses will trigger an error
-        del ret.arguments
+        ret.arguments = None
         del ret.max_pos
         del ret.min_args
         return ret

mypy/renaming.py

@@ -86,6 +86,7 @@ def visit_func_def(self, fdef: FuncDef) -> None:
         self.reject_redefinition_of_vars_in_scope()
 
         with self.enter_scope(FUNCTION), self.enter_block():
+            assert fdef.arguments is not None
             for arg in fdef.arguments:
                 name = arg.variable.name
                 # 'self' can't be redefined since it's special as it allows definition of
@@ -442,6 +443,7 @@ def visit_mypy_file(self, file_node: MypyFile) -> None:
     def visit_func_def(self, fdef: FuncDef) -> None:
         self.reject_redefinition_of_vars_in_scope()
         with self.enter_scope():
+            assert fdef.arguments is not None
             for arg in fdef.arguments:
                 self.record_skipped(arg.variable.name)
             super().visit_func_def(fdef)

mypy/semanal.py

@@ -607,6 +607,7 @@ def visit_func_def(self, defn: FuncDef) -> None:
         self.statement = defn
 
         # Visit default values because they may contain assignment expressions.
+        assert defn.arguments is not None
         for arg in defn.arguments:
             if arg.initializer:
                 arg.initializer.accept(self)
@@ -980,6 +981,7 @@ def add_function_to_symbol_table(self, func: Union[FuncDef, OverloadedFuncDef])
     def analyze_arg_initializers(self, defn: FuncItem) -> None:
         with self.tvar_scope_frame(self.tvar_scope.method_frame()):
             # Analyze default arguments
+            assert defn.arguments is not None
             for arg in defn.arguments:
                 if arg.initializer:
                     arg.initializer.accept(self)
@@ -993,6 +995,7 @@ def analyze_function_body(self, defn: FuncItem) -> None:
                 a.bind_function_type_variables(cast(CallableType, defn.type), defn)
             self.function_stack.append(defn)
             with self.enter(defn):
+                assert defn.arguments is not None
                 for arg in defn.arguments:
                     self.add_local(arg.variable, defn)
 
@@ -1021,6 +1024,7 @@ def check_classvar_in_signature(self, typ: ProperType) -> None:
     def check_function_signature(self, fdef: FuncItem) -> None:
         sig = fdef.type
         assert isinstance(sig, CallableType)
+        assert fdef.arguments is not None
         if len(sig.arg_types) < len(fdef.arguments):
             self.fail('Type signature has too few arguments', fdef)
             # Add dummy Any arguments to prevent crashes later.
@@ -1073,6 +1077,7 @@ def visit_decorator(self, dec: Decorator) -> None:
                 elif refers_to_fullname(d, 'functools.cached_property'):
                     dec.var.is_settable_property = True
                 self.check_decorated_function_is_method('property', dec)
+                assert dec.func.arguments is not None
                 if len(dec.func.arguments) > 1:
                     self.fail('Too many arguments', dec.func)
             elif refers_to_fullname(d, 'typing.no_type_check'):

mypy/strconv.py

@@ -64,6 +64,7 @@ def func_helper(self, o: 'mypy.nodes.FuncItem') -> List[object]:
         """
         args: List[Union[mypy.nodes.Var, Tuple[str, List[mypy.nodes.Node]]]] = []
         extra: List[Tuple[str, List[mypy.nodes.Var]]] = []
+        assert o.arguments is not None
         for arg in o.arguments:
             kind: mypy.nodes.ArgKind = arg.kind
             if kind.is_required():
@@ -131,6 +132,7 @@ def visit_import_all(self, o: 'mypy.nodes.ImportAll') -> str:
     def visit_func_def(self, o: 'mypy.nodes.FuncDef') -> str:
         a = self.func_helper(o)
         a.insert(0, o.name)
+        assert o.arguments is not None
         arg_kinds = {arg.kind for arg in o.arguments}
         if len(arg_kinds & {mypy.nodes.ARG_NAMED, mypy.nodes.ARG_NAMED_OPT}) > 0:
             a.insert(1, 'MaxPos({})'.format(o.max_pos))

mypy/stubgen.py

@@ -633,6 +633,7 @@ def visit_func_def(self, o: FuncDef, is_abstract: bool = False,
         self.add("%s%sdef %s(" % (self._indent, 'async ' if o.is_coroutine else '', o.name))
         self.record_name(o.name)
         args: List[str] = []
+        assert o.arguments is not None
         for i, arg_ in enumerate(o.arguments):
             var = arg_.variable
             kind = arg_.kind

mypy/stubtest.py

@@ -495,6 +495,7 @@ def get_desc(arg: Any) -> str:
     @staticmethod
     def from_funcitem(stub: nodes.FuncItem) -> "Signature[nodes.Argument]":
         stub_sig: Signature[nodes.Argument] = Signature()
+        assert stub.arguments is not None
         stub_args = maybe_strip_cls(stub.name, stub.arguments)
         for stub_arg in stub_args:
             if stub_arg.kind.is_positional():
@@ -544,6 +545,7 @@ def from_overloadedfuncdef(stub: nodes.OverloadedFuncDef) -> "Signature[nodes.Ar
         all_args: Dict[str, List[Tuple[nodes.Argument, int]]] = {}
         for func in map(_resolve_funcitem_from_decorator, stub.items):
             assert func is not None
+            assert func.arguments is not None
             args = maybe_strip_cls(stub.name, func.arguments)
             for index, arg in enumerate(args):
                 # For positional-only args, we allow overloads to have different names for the same
@@ -916,9 +918,11 @@ def apply_decorator_to_funcitem(
         ):
             return func
         if decorator.fullname == "builtins.classmethod":
+            assert func.arguments is not None
             assert func.arguments[0].variable.name in ("cls", "metacls")
             ret = copy.copy(func)
             # Remove the cls argument, since it's not present in inspect.signature of classmethods
+            assert ret.arguments
             ret.arguments = ret.arguments[1:]
             return ret
         # Just give up on any other decorators. After excluding properties, we don't run into

mypy/suggestions.py

@@ -144,6 +144,7 @@ class ArgUseFinder(TraverserVisitor):
     """
     def __init__(self, func: FuncDef, typemap: Dict[Expression, Type]) -> None:
         self.typemap = typemap
+        assert func.arguments is not None
         self.arg_types: Dict[SymbolNode, List[Type]] = {arg.variable: [] for arg in func.arguments}
 
     def visit_call_expr(self, o: CallExpr) -> None:
@@ -179,6 +180,7 @@ def test(x, y):
     """
     finder = ArgUseFinder(func, typemap)
     func.body.accept(finder)
+    assert func.arguments is not None
     return [finder.arg_types[arg.variable] for arg in func.arguments]
 
 
@@ -345,6 +347,7 @@ def get_args(self, is_method: bool,
         return types
 
     def get_default_arg_types(self, fdef: FuncDef) -> List[Optional[Type]]:
+        assert fdef.arguments is not None
         return [
             self.manager.all_types[arg.initializer] if arg.initializer else None
             for arg in fdef.arguments
@@ -418,6 +421,7 @@ def get_guesses_from_parent(self, node: FuncDef) -> List[CallableType]:
             if pnode and isinstance(pnode.node, (FuncDef, Decorator)):
                 typ = get_proper_type(pnode.node.type)
                 # FIXME: Doesn't work right with generic tyeps
+                assert node.arguments is not None
                 if isinstance(typ, CallableType) and len(typ.arg_types) == len(node.arguments):
                     # Return the first thing we find, since it probably doesn't make sense
                     # to grab things further up in the chain if an earlier parent has it.

mypy/treetransform.py

@@ -110,6 +110,7 @@ def visit_func_def(self, node: FuncDef) -> FuncDef:
         for stmt in node.body.body:
             stmt.accept(init)
 
+        assert node.arguments is not None
         new = FuncDef(node.name,
                       [self.copy_argument(arg) for arg in node.arguments],
                       self.block(node.body),
@@ -139,6 +140,7 @@ def visit_func_def(self, node: FuncDef) -> FuncDef:
             return new
 
     def visit_lambda_expr(self, node: LambdaExpr) -> LambdaExpr:
+        assert node.arguments is not None
         new = LambdaExpr([self.copy_argument(arg) for arg in node.arguments],
                          self.block(node.body),
                          cast(Optional[FunctionLike], self.optional_type(node.type)))
@@ -630,6 +632,7 @@ def __init__(self, transformer: TransformVisitor) -> None:
     def visit_func_def(self, node: FuncDef) -> None:
         if node not in self.transformer.func_placeholder_map:
             # Haven't seen this FuncDef before, so create a placeholder node.
+            assert node.arguments is not None
             self.transformer.func_placeholder_map[node] = FuncDef(
                 node.name, node.arguments, node.body, None)
         super().visit_func_def(node)

mypy/types.py

@@ -1262,16 +1262,13 @@ def __init__(self,
             # after serialization, but it is useful in error messages.
             # TODO: decide how to add more info here (file, line, column)
             # without changing interface hash.
-            self.def_extras = {
-                'first_arg': (
-                    definition.arguments[0].variable.name
-                    if (getattr(definition, 'arguments', None)
-                        and definition.arg_names
-                        and definition.info
-                        and not definition.is_static)
-                    else None
-                ),
-            }
+            first_arg: Optional[str] = None
+            if definition.info and not definition.is_static:
+                if definition.arguments:
+                    first_arg = definition.arguments[0].variable.name
+                elif definition.arg_names:
+                    first_arg = definition.arg_names[0]
+            self.def_extras = {'first_arg': first_arg}
         else:
             self.def_extras = {}
         self.type_guard = type_guard

mypyc/irbuild/builder.py

@@ -1184,6 +1184,7 @@ def gen_arg_defaults(builder: IRBuilder) -> None:
     value to the argument.
     """
     fitem = builder.fn_info.fitem
+    assert fitem.arguments is not None
     for arg in fitem.arguments:
         if arg.initializer:
             target = builder.lookup(arg.variable)

mypyc/irbuild/env_class.py

@@ -160,6 +160,7 @@ def add_args_to_env(builder: IRBuilder,
                     base: Optional[Union[FuncInfo, ImplicitClass]] = None,
                     reassign: bool = True) -> None:
     fn_info = builder.fn_info
+    assert fn_info.fitem.arguments is not None
     if local:
         for arg in fn_info.fitem.arguments:
             rtype = builder.type_to_rtype(arg.variable.type)

mypyc/irbuild/function.py

@@ -122,6 +122,7 @@ def transform_lambda_expr(builder: IRBuilder, expr: LambdaExpr) -> Value:
     assert isinstance(typ, CallableType)
 
     runtime_args = []
+    assert expr.arguments is not None
     for arg, arg_type in zip(expr.arguments, typ.arg_types):
         arg.variable.type = arg_type
         runtime_args.append(
@@ -467,6 +468,7 @@ def calculate_arg_defaults(builder: IRBuilder,
     still stored computed on demand).
     """
     fitem = fn_info.fitem
+    assert fitem.arguments is not None
     for arg in fitem.arguments:
         # Constant values don't get stored but just recomputed
         if arg.initializer and not is_constant(arg.initializer):

mypyc/irbuild/mapper.py

@@ -128,6 +128,7 @@ def fdef_to_sig(self, fdef: FuncDef) -> FuncSignature:
             ret = self.type_to_rtype(fdef.type.ret_type)
         else:
             # Handle unannotated functions
+            assert fdef.arguments is not None
             arg_types = [object_rprimitive for arg in fdef.arguments]
             arg_pos_onlys = [arg.pos_only for arg in fdef.arguments]
             # We at least know the return type for __init__ methods will be None.
@@ -145,7 +146,7 @@ def fdef_to_sig(self, fdef: FuncDef) -> FuncSignature:
         # deserialized FuncDef that lacks arguments. We won't ever
         # need to use those inside of a FuncIR, so we just make up
         # some crap.
-        if hasattr(fdef, 'arguments'):
+        if fdef.arguments is not None:
             arg_names = [arg.variable.name for arg in fdef.arguments]
         else:
             arg_names = [name or '' for name in fdef.arg_names]