summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2010-08-02 19:23:34 +0000
committerGeorg Brandl <georg@python.org>2010-08-02 19:23:34 +0000
commita1891953d0cb9daa7c5cddfeb9f9fe9f7e77aa31 (patch)
treeba41b7e5a277c827996034be8ccb2c69e9e9c5fd
parent8e204bd0ee8766a47e19e33fe32f92932c01842b (diff)
downloadcpython-a1891953d0cb9daa7c5cddfeb9f9fe9f7e77aa31.tar.gz
#8172: how does one use a property?
-rw-r--r--Doc/library/functions.rst5
1 files changed, 4 insertions, 1 deletions
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index 5c21f34a3f..5fb4f70240 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -847,7 +847,7 @@ are always available. They are listed here in alphabetical order.
*fget* is a function for getting an attribute value, likewise *fset* is a
function for setting, and *fdel* a function for del'ing, an attribute. Typical
- use is to define a managed attribute x::
+ use is to define a managed attribute ``x``::
class C(object):
def __init__(self):
@@ -861,6 +861,9 @@ are always available. They are listed here in alphabetical order.
del self._x
x = property(getx, setx, delx, "I'm the 'x' property.")
+ If then *c* is an instance of *C*, ``c.x`` will invoke the getter,
+ ``c.x = value`` will invoke the setter and ``del c.x`` the deleter.
+
If given, *doc* will be the docstring of the property attribute. Otherwise, the
property will copy *fget*'s docstring (if it exists). This makes it possible to
create read-only properties easily using :func:`property` as a :term:`decorator`::