diff options
Diffstat (limited to 'src/zope/security/proxy.py')
| -rw-r--r-- | src/zope/security/proxy.py | 17 |
1 files changed, 15 insertions, 2 deletions
diff --git a/src/zope/security/proxy.py b/src/zope/security/proxy.py index 8f6d7c3..10f0353 100644 --- a/src/zope/security/proxy.py +++ b/src/zope/security/proxy.py @@ -11,7 +11,10 @@ # FOR A PARTICULAR PURPOSE. # ############################################################################## -"""Helper functions for Proxies. +""" +Helper functions for proxies. + +.. seealso:: :ref:`proxy-known-issues` """ import functools import sys @@ -60,6 +63,16 @@ def _fmt_address(obj): class ProxyPy(PyProxyBase): + """ + The pure-Python reference implementation of a security proxy. + + This should normally not be created directly, instead use the + :func:`~.ProxyFactory`. + + You can choose to use this implementation instead of the C implementation + by default by setting the ``PURE_PYTHON`` environment variable before + :mod:`zope.security` is imported. + """ __slots__ = ('_wrapped', '_checker') def __new__(cls, value, checker): @@ -394,7 +407,7 @@ def getTestProxyItems(proxy): def isinstance(object, cls): - """Test whether an object is an instance of a type. + """Test whether an *object* is an instance of a type. This works even if the object is security proxied. """ |