Unable to specify a default value for a generic parameter

[rowillia]

Simplified Example:

from typing import TypeVar

_T = TypeVar('_T')
def foo(a: _T = 42) -> _T: # E: Incompatible types in assignment (expression has type "int", variable has type "_T")
 return a

Real World example is something closer to:

_T = TypeVar('_T')
def noop_parser(x: str) -> str:
 return x

def foo(value: str, parser: Callable[[str], _T] = noop_parser) -> _T:
 return parser(value)

[gvanrossum]

I think the problem here is that in general, e.g. if there are other parameters also using _T in their type, the default value won't work. Since this is the only parameter, you could say that this is overly restrictive, and if there are no parameters, the return type should just be determined by that default value (in your simplified example, you'd want it to return int). But I'm not so keen on doing that, since it breaks as soon as another generic parameter is used.

To make this work, you can use @overload, e.g.

@overload
def foo() -> int: ...
@overload
def foo(a: _T) -> _T: ...
def foo(a = 42): # Implementation, assuming this isn't a stub
 return a

That's what we do in a few places in typeshed too (without the implementation though), e.g. check out Mapping.get() in typing.pyi.

[OddBloke]

I'm running in to a similar issue when trying to iron out a bug in the configparser stubs. Reducing RawConfigParser to the relevant parts gives:

_section = Mapping[str, str]

class RawConfigParser:
 def __init__(self, dict_type: Mapping[str, str] = ...) -> None: ...

 def defaults(self) -> _section: ...

This is incorrect at the moment, because dict_type should (as the name indicates) be a type. Furthermore, defaults() returns an instance of dict_type, so this seems like a good application of generics. The following works as expected when a dict_type is passed (i.e. reveal_type(RawConfigParser(dict_type=dict).default()) gives builtins.dict*[Any, Any]):

_T1 = TypeVar('_T1', bound=Mapping)

class RawConfigParser(Generic[_T1]):
 def __init__(self, dict_type: Type[_T1] = ...) -> None: ...

 def defaults(self) -> _T1: ...

but when you don't pass a dict_type, mypy can't infer what type it should be using and asks for a type annotation where it is being used. This is less than ideal for the default instantiation of the class (which will be what the overwhelming majority of people are using). So I tried adding the appropriate default to the definition:

_T1 = TypeVar('_T1', bound=Mapping)

class RawConfigParser(_parser, Generic[_T1]):
 def __init__(self, dict_type: Type[_T1] = OrderedDict) -> None: ...

 def defaults(self) -> _T1: ...

but then I hit the error that OP was seeing:

stdlib/3/configparser.pyi:51: error: Incompatible default for argument "dict_type" (default has type Type[OrderedDict[Any, Any]], argument has type Type[_T1])

This feels like something that isn't currently supported, but I'm not sure if I'm missing a way that I could do this...

[ilevkivskyi]

@OddBloke
This default is, strictly speaking, not safe. This would require a lower bound for _T1 in order to be safe.

[OddBloke]

@ilevkivskyi I don't follow, I'm afraid; could you expand on that a little, please?

[ilevkivskyi]

Consider this code:

class UserMapping(Mapping):
 ...
RawConfigParser[UserMapping]()

In this case OrderedDict will be "assigned" to dict_type, which will be Type[UserMapping], which is not a supertype of Type[OrderedDict]. In order for the default value to be safe it is necessary to have some guarantee that _T1 will be always a supertype of OrderedDict (this is called a lower bound), but this is not supported, only upper bounds are allowed for type variables.

[OddBloke]

@ilevkivskyi Thanks, that makes sense. Do you think what I'm trying to do is unrepresentable as things stand?

[ilevkivskyi]

I didn't think enough about this, but my general rule is not to be "obsessed" with precise types, sometimes Any is OK. If a certain problem appears repeatedly, then maybe we need to improve something (also now we have plugin system). In this particular case my naive guess would be to play with overloads, as Guido suggested (note that __init__ can also be overloaded).

[nematsakis]

Allowing default values for generic parameters might also enable using type constraints to ensure that generics are only used in specified ways. This is a bit esoteric, but here is an example of how you might use the same implementation for a dict and a set while requiring that consumers of the dict type always provide a value to insert() while consumers of the set type never do.

class Never(Enum):
 """An uninhabited type"""

class Only(Enum):
 """A type with one member (kind of like NoneType)"""
 ONE = 1

NOT_PASSED = Only(1)

class MyGenericMap(Generic[K, V]):

 def insert(key, value=cast(Never, NOT_PASSED)):
 # type: (K, V) -> None
 ...
 if value is NOT_PASSED:
 ....

class MySet(MyGenericMap[K, Never]):
 pass

class MyDict(MyGenericMap[K, V]):
 pass

my_set = MySet[str]()
my_set.insert('hi') # this is fine, default value matches concrete type
my_set.insert('hi', 'hello') # type error, because 'hello' is not type never

my_dict = MyDict[str, int]()
my_dict.insert('hi') # type error because value is type str, not Never
my_dict.insert('hi', 22) # this is fine, because the default value is not used

[gvanrossum]

Huh, this just came up in our code.