python / python/mypy

Return type "str" of "readline" incompatible with return type "bytes" in supertype "IOBase" [override]

Open
#9,643 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Python
Stars
20.6k
Forks
3.3k
PR merge metrics
PR metrics pending

Description

Since https://github.com/python/typeshed/pull/4145 (released with mypy 0.790) mypy fails with:

import io

class MyStringIO(io.StringIO):
    def readline(self, size=None) -> str:
        return super().readline(size)

Return type "str" of "readline" incompatible with return type "bytes" in supertype "IOBase" [override]

According to https://github.com/python/typeshed/pull/4145#issuecomment-639543492 this is likely a bug in mypy.

(mypy 0.800+dev.f220ce50725ed7f117832b9f03aed4d1a9508e00 (current master))

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Run the supplied StringIO reproducer with mypy and investigate override checking for io.StringIO.readline against IOBase. Add regression coverage for the reported error and verify that the override is accepted without introducing related type-checking regressions.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
devtools
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.