object doesn't have an __enter__/__exit__ yet docs say it does
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 36k
- PR merge metrics
- PR metrics pending
Description
Documentation
Here's the current docs in the Python data model on object.__enter__:
object.__enter__(self)
And object.__exit__:
object.__exit__(self, exc_type, exc_value, traceback)
However, with Python 3.10.3, we see neither of these methods belong to object:
>>> object.__enter__
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
AttributeError: type object 'object' has no attribute '__enter__'. Did you mean: '__ne__'?
>>> object.__exit__
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
AttributeError: type object 'object' has no attribute '__exit__'. Did you mean: '__init__'?
I think the docs could be:
- More clear that
__enter__and__exit__are not methods onobject - Mention where they come from (just being defined within your object to match the interface)
Thank you for your consideration!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Python data model documentation sections for object.enter and object.exit linked in the issue, and verify their current wording against Python 3.10.3. Update the documentation to clarify that these methods are not defined on object and explain that context manager objects define them to provide the interface; done means the documented behavior matches the runtime.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100