Clean up allocated TLS socket @ PyPI filter #226
Closed
Conversation
This file contains 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
Invoking `python -Werror -m sphinx -b spelling ...` surfaces a resource warning related to not releasing the TLS socket that `xmlrpc.client.ServerProxy()` opens. There's no explicit mention of a cleanup method in the stdlib docs but there's one example with a context manager. I inspected the source code and it seems like we should either use a CM or a rather weird callable interface (`xmlrpc.client.ServerProxy()('close')()`). I opted for a CM.
```python-traceback
[...]
Ignoring wiki words
Ignoring acronyms
Adding package names from PyPI to local dictionary…
Exception ignored in: <ssl.SSLSocket fd=3, family=2, type=1, proto=6, laddr=('192.168.1.114', 53560), raddr=('146.75.120.223', 443)>
Traceback (most recent call last):
File "~/src/github/a/project/.tox/build-docs/lib/python3.12/site-packages/sphinxcontrib/spelling/builder.py", line 65, in init
f.append(filters.PyPIFilterFactory())
^^^^^^^^^^^^^^^^^^^^^^^^^^^
ResourceWarning: unclosed <ssl.SSLSocket fd=3, family=2, type=1, proto=6, laddr=('192.168.1.114', 53560), raddr=('146.75.120.223', 443)>
Ignoring Python builtins
Ignoring importable module names
Ignoring contributor names
[...]
```
## Disclaimer
This patch is coded in-browser on the GH UI w/ no testing. It might need some love and/or tests.
|
The change looks generally OK. The linter doesn't like the line length and some of the test jobs are failing. |
|
I don't think I'll have time to work on this, just wanted to put it out there so it's not lost in my brain and forgotten ;) |
|
With #227, it doesn't make sense to fix it. XML-RPC should instead be deleted. |
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Invoking
python -Werror -m sphinx -b spelling ...surfaces a resource warning related to not releasing the TLS socket thatxmlrpc.client.ServerProxy()opens. There's no explicit mention of a cleanup method in the stdlib docs but there's one example with a context manager. I inspected the source code and it seems like we should either use a CM or a rather weird callable interface (xmlrpc.client.ServerProxy()('close')()). I opted for a CM.[...] Ignoring wiki words Ignoring acronyms Adding package names from PyPI to local dictionary… Exception ignored in: <ssl.SSLSocket fd=3, family=2, type=1, proto=6, laddr=('192.168.1.114', 53560), raddr=('146.75.120.223', 443)> Traceback (most recent call last): File "~/src/github/a/project/.tox/build-docs/lib/python3.12/site-packages/sphinxcontrib/spelling/builder.py", line 65, in init f.append(filters.PyPIFilterFactory()) ^^^^^^^^^^^^^^^^^^^^^^^^^^^ ResourceWarning: unclosed <ssl.SSLSocket fd=3, family=2, type=1, proto=6, laddr=('192.168.1.114', 53560), raddr=('146.75.120.223', 443)> Ignoring Python builtins Ignoring importable module names Ignoring contributor names [...]Disclaimer
This patch is coded in-browser on the GH UI w/ no testing. It might need some love and/or tests.