← 返回首页
gh-101819: Prepare to modernize the _io extension by vstinner · Pull Request #104178 · python/cpython · GitHub
Skip to content

Navigation Menu

Toggle navigation
Sign in
Appearance settings
Search or jump to...

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted
Cancel Submit feedback

Saved searches

Use saved searches to filter your results more quickly

Cancel Create saved search
Appearance settings
Resetting focus

gh-101819: Prepare to modernize the _io extension#104178

Merged
vstinner merged 1 commit into
python:mainfrom
vstinner:io_prepare
May 5, 2023
Merged

gh-101819: Prepare to modernize the _io extension#104178
vstinner merged 1 commit into
python:mainfrom
vstinner:io_prepare

Conversation

vstinner commented May 4, 2023 •
edited
Loading

Copy link
Copy Markdown
Member

  • Add references to static types to _PyIO_State:

    • PyBufferedIOBase_Type
    • PyBytesIOBuffer_Type
    • PyIncrementalNewlineDecoder_Type
    • PyRawIOBase_Type
    • PyTextIOBase_Type

  • Add the defining class to methods:

    • _io.BytesIO.getbuffer()
    • _io.FileIO.close()

  • Add get_io_state_by_cls() function.

  • Add state parameter to _textiowrapper_decode()

  • io_TextIOWrapper___init_() now sets self->state before calling _textiowrapper_set_decoder().

bedevere-bot mentioned this pull request May 4, 2023
Closed
vstinner mentioned this pull request May 4, 2023
Merged

vstinner commented May 4, 2023

Copy link
Copy Markdown
Member Author

This PR is based on @erlend-aasland's PR #101948. Changes:

  • Don't convert static types to heap types: it will be done on a separated PR
  • _io_StringIO___init___impl() only calls find_io_state_by_def() once
  • _io__WindowsConsoleIO___init___impl() doesn't declare a variable which is only used by an assertion, to avoid the risk of getting a compiler warning. If the line is too long, I can make the declaration conditional on the NDEBUG macro.
  • _io_FileIO_close_impl() and _io__WindowsConsoleIO_close_impl(): move variable declaration (minor coding style change).
  • Don't add PyIOBase_Type since such change would have no point for now.

I copied the clinic_state() macros.

Add the defining class to methods: (...)

I was not sure that it works on static types... but it seems like it does :-) I didn't get any crash.

vstinner commented May 4, 2023

Copy link
Copy Markdown
Member Author

@corona10 @erlend-aasland: Would you mind to review it?

corona10 commented May 4, 2023

Copy link
Copy Markdown
Member

sure

corona10 self-requested a review May 4, 2023 17:32

vstinner commented May 5, 2023

Copy link
Copy Markdown
Member Author

Oh, the Windows change didn't go well:

0:20:02 load avg: 8.57 [317/463/2] test_winconsoleio crashed (Exit code 3) -- (...) Assertion failed: mod != NULL, file D:\a\cpython\cpython\Modules\_io\_iomodule.h, line 192 Fatal Python error: Aborted Current thread 0x000004a0 (most recent call first): File "D:\a\cpython\cpython\Lib\test\test_winconsoleio.py", line 104 in test_conin_conout_names (...)

vstinner commented May 5, 2023

Copy link
Copy Markdown
Member Author

The failed assertion is:

assert(PyObject_TypeCheck(self, find_io_state_by_def(Py_TYPE(self))->PyWindowsConsoleIO_Type));

in _io__WindowsConsoleIO___init___impl(). The assertion fails because PyType_GetModuleByDef() returns NULL.

vstinner commented May 5, 2023

Copy link
Copy Markdown
Member Author

On static types, PyType_GetModuleByDef() always returns NULL, since the function reads PyHeapTypeObject.ht_module which only exists in heap types:

if(!_PyType_HasFeature((PyTypeObject *)super, Py_TPFLAGS_HEAPTYPE)) { // Static types in the MRO need to be skipped continue; }

This comment was marked as outdated.

Sign in to view
pythongh-101819: Prepare to modernize the _io extension …
dfc1e9e
* Add references to static types to _PyIO_State: * PyBufferedIOBase_Type * PyBytesIOBuffer_Type * PyIncrementalNewlineDecoder_Type * PyRawIOBase_Type * PyTextIOBase_Type * Add the defining class to methods: * _io.BytesIO.getbuffer() * _io.FileIO.close() * Add get_io_state_by_cls() function. * Add state parameter to _textiowrapper_decode() * _io_TextIOWrapper___init__() now sets self->state before calling _textiowrapper_set_decoder(). Co-Authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>

vstinner commented May 5, 2023

Copy link
Copy Markdown
Member Author

Using APIs to get the module state from a type works on heap types like _io.FileIO, but failed on _io.WindowsConsoleIO which remains a static type with my PR.

I fixed my PR by reverting changes related to WindowsConsoleIO: this type should be modified in a following PR.

vstinner commented May 5, 2023

Copy link
Copy Markdown
Member Author

I reverted changes related to PyWindowsConsoleIO_Type and _io._WindowsConsoleIO.close().

erlend-aasland commented May 5, 2023

Copy link
Copy Markdown
Contributor

I prefer doing Windows only changes in separate PRs. Everytime I touch Windows stuff, something weird happen :)

vstinner commented May 5, 2023 •
edited
Loading

Copy link
Copy Markdown
Member Author

Aha, now the CI pass. I would feel more comfortable with a review. @erlend-aasland: you can also review if you want, to check if i picked the right parts or tour code 😁

corona10 added the 🔨 test-with-refleak-buildbots Test PR w/ refleak buildbots; report in status section label May 5, 2023

bedevere-bot commented May 5, 2023

Copy link
Copy Markdown

🤖 New build scheduled with the buildbot fleet by @corona10 for commit dfc1e9e 🤖

If you want to schedule another build, you need to add the 🔨 test-with-refleak-buildbots label again.

bedevere-bot removed the 🔨 test-with-refleak-buildbots Test PR w/ refleak buildbots; report in status section label May 5, 2023
corona10 approved these changes May 5, 2023
View reviewed changes

corona10 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

lgtm, let's wait refleak bot.

vstinner commented May 5, 2023

Copy link
Copy Markdown
Member Author

I was not sure that it works on static types... but it seems like it does :-) I didn't get any crash.

I missed something: Erlend already converted multiple _io types to heap types: see commit c00faf7. Types used in this PR are heap types, that's why it just works!

vstinner commented May 5, 2023

Copy link
Copy Markdown
Member Author

let's wait refleak bot

Thanks for running these jobs. I ran refleaks locally on test_io, but i don't trust myself 🤣 So having reliable buildbot checks sound safer.

I will merge my PR once the Refleaks jobs pass, unless someome wants me to wait for their second review.

erlend-aasland commented May 5, 2023

Copy link
Copy Markdown
Contributor

No refleaks; good bot 🤖 ✅

vstinner merged commit c840291 into python:main May 5, 2023
vstinner deleted the io_prepare branch May 5, 2023 23:54
jbower-fb pushed a commit to jbower-fb/cpython that referenced this pull request May 8, 2023
pythongh-101819: Prepare to modernize the _io extension (python#104178) …
88482c7
* Add references to static types to _PyIO_State: * PyBufferedIOBase_Type * PyBytesIOBuffer_Type * PyIncrementalNewlineDecoder_Type * PyRawIOBase_Type * PyTextIOBase_Type * Add the defining class to methods: * _io.BytesIO.getbuffer() * _io.FileIO.close() * Add get_io_state_by_cls() function. * Add state parameter to _textiowrapper_decode() * _io_TextIOWrapper___init__() now sets self->state before calling _textiowrapper_set_decoder(). Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

corona10 corona10 approved these changes
erlend-aasland erlend-aasland approved these changes
kumaraditya303 Awaiting requested review from kumaraditya303

Assignees

No one assigned

Labels

skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

Footer

© 2026 GitHub, Inc.