python · ilai-deutel · Oct 16, 2019 · Oct 25, 2019 · Nov 11, 2019 · Nov 11, 2019
diff --git a/mypy/plugins/default.py b/mypy/plugins/default.py
@@ -1,8 +1,8 @@
 from functools import partial
-from typing import Callable, Optional, List
+from typing import Callable, Optional, List, Tuple
 
 from mypy import message_registry
-from mypy.nodes import Expression, StrExpr, IntExpr, DictExpr, UnaryExpr
+from mypy.nodes import Context, Expression, StrExpr, IntExpr, DictExpr, UnaryExpr
 from mypy.plugin import (
     Plugin, FunctionContext, MethodContext, MethodSigContext, AttributeContext, ClassDefContext,
     CheckerPluginInterface,
@@ -107,55 +107,65 @@ def get_class_decorator_hook(self, fullname: str
 
 
 def open_callback(ctx: FunctionContext) -> Type:
-    """Infer a better return type for 'open'."""
-    return _analyze_open_signature(
+    """Verify argument types for 'open'."""
+    _verify_open_signature(
         arg_types=ctx.arg_types,
         args=ctx.args,
+        arg_names=ctx.callee_arg_names,
         mode_arg_index=1,
-        default_return_type=ctx.default_return_type,
+        text_only_arg_indices=(3, 4, 5),
         api=ctx.api,
+        context=ctx.context,
     )
+    return ctx.default_return_type
 
 
 def path_open_callback(ctx: MethodContext) -> Type:
-    """Infer a better return type for 'pathlib.Path.open'."""
-    return _analyze_open_signature(
+    """Verify argument types for 'pathlib.Path.open'."""
+    _verify_open_signature(
         arg_types=ctx.arg_types,
         args=ctx.args,
+        arg_names=ctx.callee_arg_names,
         mode_arg_index=0,
-        default_return_type=ctx.default_return_type,
+        text_only_arg_indices=(2, 3, 4),
         api=ctx.api,
+        context=ctx.context,
     )
+    return ctx.default_return_type
 
 
-def _analyze_open_signature(arg_types: List[List[Type]],
-                            args: List[List[Expression]],
-                            mode_arg_index: int,
-                            default_return_type: Type,
-                            api: CheckerPluginInterface,
-                            ) -> Type:
-    """A helper for analyzing any function that has approximately
-    the same signature as the builtin 'open(...)' function.
-
-    Currently, the only thing the caller can customize is the index
-    of the 'mode' argument. If the mode argument is omitted or is a
-    string literal, we refine the return type to either 'TextIO' or
-    'BinaryIO' as appropriate.
+def _verify_open_signature(
+        arg_types: List[List[Type]],
+        args: List[List[Expression]],
+        arg_names: List[Optional[str]],
+        mode_arg_index: int,
+        text_only_arg_indices: Tuple[int, ...],
+        api: CheckerPluginInterface,
+        context: Context,
+) -> None:
+    """A helper for verifying any function that has approximately the same
+    signature as the builtin 'open(...)' function.
+
+    If mode is detected to be binary, verify that text-only arguments
+    (encoding, errors, newline) are None.
     """
-    mode = None
     if not arg_types or len(arg_types[mode_arg_index]) != 1:
-        mode = 'r'
-    else:
-        mode_expr = args[mode_arg_index][0]
-        if isinstance(mode_expr, StrExpr):
-            mode = mode_expr.value
-    if mode is not None:
-        assert isinstance(default_return_type, Instance)  # type: ignore
-        if 'b' in mode:
-            return api.named_generic_type('typing.BinaryIO', [])
-        else:
-            return api.named_generic_type('typing.TextIO', [])
-    return default_return_type
+        return None
+
+    mode_str = try_getting_str_literals(
+        args[mode_arg_index][0], arg_types[mode_arg_index][0]
+    )
+    if mode_str is None or len(mode_str) != 1 or 'b' not in mode_str[0]:
+        # mode cannot be found, or is not binary
+        return None
+
+    # Verify that text-only arguments are None if mode is binary
+    for arg_index in text_only_arg_indices:
+        if (len(arg_types[arg_index]) == 1
+                and not is_subtype(arg_types[arg_index][0], NoneType())):
+            api.fail("Binary mode doesn't take an argument for {}"
+                     .format(arg_names[arg_index]),
+                     context)
 
 
 def contextmanager_callback(ctx: FunctionContext) -> Type:

diff --git a/mypy/typeshed b/mypy/typeshed
diff --git a/test-data/unit/python2eval.test b/test-data/unit/python2eval.test
@@ -189,7 +189,6 @@ f.write(u'foo')
 f.write('bar')
 f.close()
 [out]
-_program.py:3: error: Argument 1 to "write" of "IO" has incompatible type "unicode"; expected "str"
 
 [case testPrintFunctionWithFileArg_python2]
 from __future__ import print_function

diff --git a/test-data/unit/pythoneval.test b/test-data/unit/pythoneval.test
@@ -287,17 +287,32 @@ _program.py:3: note: Revealed type is 'typing.BinaryIO'
 _program.py:5: note: Revealed type is 'typing.IO[Any]'
 
 [case testOpenReturnTypeInferenceSpecialCases]
+from typing_extensions import Literal
 reveal_type(open())
 reveal_type(open(mode='rb', file='x'))
 reveal_type(open(file='x', mode='rb'))
 mode = 'rb'
-reveal_type(open(mode=mode, file='r'))
-[out]
-_testOpenReturnTypeInferenceSpecialCases.py:1: error: Too few arguments for "open"
-_testOpenReturnTypeInferenceSpecialCases.py:1: note: Revealed type is 'typing.TextIO'
-_testOpenReturnTypeInferenceSpecialCases.py:2: note: Revealed type is 'typing.BinaryIO'
+reveal_type(open(mode=mode, file='r', errors='replace'))
+open('x', mode='rb', errors='replace')
+open('x', errors='replace', mode='rb')
+errors: Literal['strict', 'ignore'] = 'ignore'
+open('x', 'rb', -1, 'UTF-8', errors, '\n')
+[out]
+_testOpenReturnTypeInferenceSpecialCases.py:2: error: All overload variants of "open" require at least one argument
+_testOpenReturnTypeInferenceSpecialCases.py:2: note: Possible overload variants:
+_testOpenReturnTypeInferenceSpecialCases.py:2: note:     def open(file: Union[str, bytes, int, _PathLike[Any]], mode: <union: 53 items> = ..., buffering: int = ..., encoding: Optional[str] = ..., errors: Optional[str] = ..., newline: Optional[str] = ..., closefd: bool = ..., opener: Optional[Callable[[str, int], int]] = ...) -> TextIO
+_testOpenReturnTypeInferenceSpecialCases.py:2: note:     def open(file: Union[str, bytes, int, _PathLike[Any]], mode: <union: 38 items>, buffering: int = ..., encoding: None = ..., errors: None = ..., newline: None = ..., closefd: bool = ..., opener: Optional[Callable[[str, int], int]] = ...) -> BinaryIO
+_testOpenReturnTypeInferenceSpecialCases.py:2: note:     def open(file: Union[str, bytes, int, _PathLike[Any]], mode: str, buffering: int = ..., encoding: Optional[str] = ..., errors: Optional[str] = ..., newline: Optional[str] = ..., closefd: bool = ..., opener: Optional[Callable[[str, int], int]] = ...) -> IO[Any]
+_testOpenReturnTypeInferenceSpecialCases.py:2: note: Revealed type is 'Any'
 _testOpenReturnTypeInferenceSpecialCases.py:3: note: Revealed type is 'typing.BinaryIO'
-_testOpenReturnTypeInferenceSpecialCases.py:5: note: Revealed type is 'typing.IO[Any]'
+_testOpenReturnTypeInferenceSpecialCases.py:4: note: Revealed type is 'typing.BinaryIO'
+_testOpenReturnTypeInferenceSpecialCases.py:6: note: Revealed type is 'typing.IO[Any]'
+_testOpenReturnTypeInferenceSpecialCases.py:7: error: Binary mode doesn't take an argument for errors
+_testOpenReturnTypeInferenceSpecialCases.py:8: error: Binary mode doesn't take an argument for errors
+_testOpenReturnTypeInferenceSpecialCases.py:10: error: Binary mode doesn't take an argument for encoding
+_testOpenReturnTypeInferenceSpecialCases.py:10: error: Binary mode doesn't take an argument for errors
+_testOpenReturnTypeInferenceSpecialCases.py:10: error: Binary mode doesn't take an argument for newline
+
 
 [case testPathOpenReturnTypeInference]
 from pathlib import Path
@@ -315,15 +330,25 @@ _program.py:7: note: Revealed type is 'typing.IO[Any]'
 
 [case testPathOpenReturnTypeInferenceSpecialCases]
 from pathlib import Path
+from typing import Optional
+from typing_extensions import Literal
 p = Path("x")
-reveal_type(p.open(mode='rb', errors='replace'))
-reveal_type(p.open(errors='replace', mode='rb'))
+p.open(mode='rb', errors='replace')
+p.open(errors='replace', mode='rb')
 mode = 'rb'
 reveal_type(p.open(mode=mode, errors='replace'))
-[out]
-_program.py:3: note: Revealed type is 'typing.BinaryIO'
-_program.py:4: note: Revealed type is 'typing.BinaryIO'
-_program.py:6: note: Revealed type is 'typing.IO[Any]'
+mode2: Literal['rb'] = 'rb'
+p.open(mode=mode2, errors='replace')
+errors: Optional[Literal['strict', 'ignore']] = None
+p.open('rb', -1, 'UTF-8', errors, '\n')
+[out]
+_program.py:5: error: Binary mode doesn't take an argument for errors
+_program.py:6: error: Binary mode doesn't take an argument for errors
+_program.py:8: note: Revealed type is 'typing.IO[Any]'
+_program.py:10: error: Binary mode doesn't take an argument for errors
+_program.py:12: error: Binary mode doesn't take an argument for encoding
+_program.py:12: error: Binary mode doesn't take an argument for errors
+_program.py:12: error: Binary mode doesn't take an argument for newline
 
 [case testGenericPatterns]
 from typing import Pattern
+1 −1		CONTRIBUTING.md
+1 −1		requirements-tests-py3.txt
+2 −1		stdlib/2/SocketServer.pyi
+61 −11		stdlib/2/__builtin__.pyi
+5 −6		stdlib/2/fcntl.pyi
+2 −2		stdlib/2/functools.pyi
+14 −0		stdlib/2/io.pyi
+2 −5		stdlib/2/posix.pyi
+3 −0		stdlib/2/typing.pyi
+23 −15		stdlib/2/unittest.pyi
+7 −6		stdlib/2and3/_csv.pyi
+10 −0		stdlib/2and3/_types.pyi
+54 −24		stdlib/2and3/_warnings.pyi
+5 −0		stdlib/2and3/antigravity.pyi
+2 −1		stdlib/2and3/asyncore.pyi
+4 −1		stdlib/2and3/binascii.pyi
+61 −11		stdlib/2and3/builtins.pyi
+44 −18		stdlib/2and3/bz2.pyi
+38 −1		stdlib/2and3/codecs.pyi
+8 −3		stdlib/2and3/csv.pyi
+4 −0		stdlib/2and3/datetime.pyi
+3 −1		stdlib/2and3/imaplib.pyi
+92 −6		stdlib/2and3/logging/__init__.pyi
+8 −0		stdlib/2and3/msvcrt.pyi
+46 −6		stdlib/2and3/pprint.pyi
+13 −16		stdlib/2and3/select.pyi
+23 −13		stdlib/2and3/shutil.pyi
+1 −1		stdlib/2and3/sqlite3/dbapi2.pyi
+25 −6		stdlib/2and3/ssl.pyi
+7 −7		stdlib/2and3/termios.pyi
+7 −0		stdlib/2and3/token.pyi
+17 −9		stdlib/2and3/warnings.pyi
+32 −0		stdlib/2and3/winsound.pyi
+35 −7		stdlib/2and3/zipfile.pyi
+3 −0		stdlib/3/ast.pyi
+5 −5		stdlib/3/asyncio/base_events.pyi
+5 −5		stdlib/3/asyncio/events.pyi
+3 −3		stdlib/3/asyncio/protocols.pyi
+11 −0		stdlib/3/dbm/__init__.pyi
+31 −0		stdlib/3/dbm/dumb.pyi
+36 −0		stdlib/3/dbm/gnu.pyi
+36 −0		stdlib/3/dbm/ndbm.pyi
+6 −9		stdlib/3/faulthandler.pyi
+5 −6		stdlib/3/fcntl.pyi
+7 −7		stdlib/3/functools.pyi
+54 −5		stdlib/3/gzip.pyi
+2 −0		stdlib/3/http/__init__.pyi
+4 −4		stdlib/3/http/client.pyi
+9 −2		stdlib/3/http/cookiejar.pyi
+1 −1		stdlib/3/http/server.pyi
+3 −1		stdlib/3/inspect.pyi
+21 −0		stdlib/3/io.pyi
+99 −33		stdlib/3/lzma.pyi
+30 −14		stdlib/3/os/__init__.pyi
+21 −5		stdlib/3/pathlib.pyi
+26 −31		stdlib/3/selectors.pyi
+5 −0		stdlib/3/signal.pyi
+2 −1		stdlib/3/socketserver.pyi
+5 −1		stdlib/3/typing.pyi
+1 −1		stdlib/3/unittest/__init__.pyi
+3 −1		stdlib/3/unittest/case.pyi
+10 −4		stdlib/3/unittest/result.pyi
+26 −5		stdlib/3/urllib/parse.pyi
+0 −4		stdlib/3/urllib/request.pyi
+3 −1		stdlib/3/urllib/robotparser.pyi
+1 −0		tests/mypy_test.py
+1 −1		third_party/2/fb303/FacebookService.pyi
+21 −5		third_party/2/pathlib2.pyi
+1 −1		third_party/2/scribe/scribe.pyi
+5 −1		third_party/2and3/Crypto/Random/__init__.pyi
+15 −13		third_party/2and3/Crypto/Random/random.pyi
+2 −2		third_party/2and3/cryptography/hazmat/primitives/asymmetric/rsa.pyi
+2 −1		third_party/2and3/google/protobuf/internal/containers.pyi
+3 −0		third_party/2and3/jinja2/environment.pyi
+5 −0		third_party/2and3/jinja2/nodes.pyi
+5 −1		third_party/2and3/redis/client.pyi
+2 −2		third_party/2and3/requests/adapters.pyi
+12 −12		third_party/2and3/requests/models.pyi
+1 −1		third_party/2and3/requests/sessions.pyi
+4 −0		third_party/2and3/requests/utils.pyi