Skip to content

Document the args to create an addinfourl object #111235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document the args to create an addinfourl object #111235

wants to merge 1 commit into from

Conversation

brondsem
Copy link

@brondsem brondsem commented Oct 23, 2023 •
edited by github-actions bot
Loading

The docs for the urllib.response.addinfourl class weren't showing what parameters it took to create a new instance.

📚 Documentation preview 📚: https://cpython-previews--111235.org.readthedocs.build/

@bedevere-app bedevere-app bot added awaiting review docs Documentation in the Doc dir skip news labels Oct 23, 2023
@hugovk hugovk changed the title Document the args to create a addinfourl object Document the args to create an addinfourl object Oct 31, 2023
@serhiy-storchaka
Copy link
Member

addinfourl is documented because it is the type of the result of urllib.request.urlopen(). It is not intended to be created in user code.

@brondsem
Copy link
Author

My use case was using mock.patch on urlopen, and I wanted to create my own addinfourl response for the mock

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
awaiting review docs Documentation in the Doc dir skip issue skip news
Projects
Docs PRs
Status: Todo
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@brondsem @serhiy-storchaka @hugovk