Issue 42542: weakref documentation does not fully describe proxies

➜

This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

This issue has been migrated to GitHub: https://github.com/python/cpython/issues/86708

classification

Title:	weakref documentation does not fully describe proxies
Type:		Stage:
Components:	Documentation	Versions:	Python 3.9

process

Status:	open	Resolution:
Dependencies:		Superseder:
Assigned To:	docs@python	Nosy List:	docs@python, rgov
Priority:	normal	Keywords:

Created on 2020-12-02 15:18 by rgov, last changed 2022-04-11 14:59 by admin.

Messages (1)
msg382319 - (view)	Author: Ryan Govostes (rgov)	Date: 2020-12-02 15:18
The documentation for weakref.proxy() does not describe how the proxy object behaves when the object it references is gone. The apparent behavior is that it raises a ReferenceError when an attribute of the proxy object is accessed. It would probably be a good idea to describe what the proxy object does in general, for those who are unfamiliar with the concept: attribute accesses on the proxy object are forwarded to the referenced object, if it exists.

msg382319 - (view)

Author: Ryan Govostes (rgov)

Date: 2020-12-02 15:18

The documentation for weakref.proxy() does not describe how the proxy object behaves when the object it references is gone.

The apparent behavior is that it raises a ReferenceError when an attribute of the proxy object is accessed.

It would probably be a good idea to describe what the proxy object does in general, for those who are unfamiliar with the concept: attribute accesses on the proxy object are forwarded to the referenced object, if it exists.

History
Date	User	Action	Args
2022-04-11 14:59:38	admin	set	github: 86708
2020-12-02 15:18:59	rgov	create