Skip to content
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.

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

Document socket property of Response objects #199

Merged
merged 1 commit into from
Jul 4, 2024

Conversation

jepler
Copy link
Member

@jepler jepler commented Jul 1, 2024

The socket property is a CircuitPython addition not present in "standard requests" (which provides similar but not quite identical functionality via the "raw" property of response objects).

As discussed in the linked issue, having a documented way to access the underlying socket is needed for MP3 streaming over http/https.

Closes #198

Copy link

github-actions bot commented Jul 1, 2024

👋 Thanks for this pull request! Unfortunately, it looks like the automated continuous integration (CI) test(s) failed. These can be tricky to fix so we've written a guide on how to fix them locally. It has pages about running pre-commit locally and another about building the docs locally with sphinx. Thanks for contributing to CircuitPython! If you have more questions, feel free to join the Adafruit Discord and post in #circuitpython-dev.

@jepler jepler requested a review from dhalbert July 4, 2024 01:18
Copy link
Contributor

@dhalbert dhalbert left a comment

Choose a reason for hiding this comment

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

Thanks for documenting this. As noted, CPython doesn't provide a good way to get the socket -- this is better.

@dhalbert dhalbert merged commit 347a527 into main Jul 4, 2024
2 checks passed
@dhalbert dhalbert deleted the document-socket-property branch July 4, 2024 03:43
adafruit-adabot added a commit to adafruit/Adafruit_CircuitPython_Bundle that referenced this pull request Jul 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Need supported way to "steal" socket from requests library for mp3 streaming
2 participants