mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-03 19:34:08 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

Marked the unmarked AttributeError. (AMK)

Browse source 
"Protect the class instance" --> "Protect the object"  It works for anything
with attributes to look up!  (AMK)

Logical markup.
This commit is contained in:
Fred Drake 1998-02-23 14:42:00 +00:00
parent 71f894ad56
commit a705da7aa0
2 changed files with 18 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

17
Doc/lib/libbastion.tex
View file

@ -11,28 +11,29 @@ According to the dictionary, a bastion is ``a fortified area or
position'', or ``something that is considered a stronghold.'' It's a position'', or ``something that is considered a stronghold.'' It's a
suitable name for this module, which provides a way to forbid access suitable name for this module, which provides a way to forbid access
to certain attributes of an object. It must always be used with the to certain attributes of an object. It must always be used with the
\code{rexec} module, in order to allow restricted-mode programs access \module{rexec} module, in order to allow restricted-mode programs access
to certain safe attributes of an object, while denying access to to certain safe attributes of an object, while denying access to
other, unsafe attributes. other, unsafe attributes.
% I've punted on the issue of documenting keyword arguments for now. % I've punted on the issue of documenting keyword arguments for now.
\begin{funcdesc}{Bastion}{object\optional{\, filter\, name\, class}} \begin{funcdesc}{Bastion}{object\optional{\, filter\, name\, class}}
Protect the class instance \var{object}, returning a bastion for the Protect the object \var{object}, returning a bastion for the
object. Any attempt to access one of the object's attributes will object. Any attempt to access one of the object's attributes will
have to be approved by the \var{filter} function; if the access is have to be approved by the \var{filter} function; if the access is
denied an AttributeError exception will be raised. denied an \exception{AttributeError} exception will be raised.
If present, \var{filter} must be a function that accepts a string If present, \var{filter} must be a function that accepts a string
containing an attribute name, and returns true if access to that containing an attribute name, and returns true if access to that
attribute will be permitted; if \var{filter} returns false, the access attribute will be permitted; if \var{filter} returns false, the access
is denied. The default filter denies access to any function beginning is denied. The default filter denies access to any function beginning
with an underscore (\code{_}). The bastion's string representation with an underscore (\samp{_}). The bastion's string representation
will be \code{<Bastion for \var{name}>} if a value for will be \samp{<Bastion for \var{name}>} if a value for
\var{name} is provided; otherwise, \code{repr(\var{object})} will be used. \var{name} is provided; otherwise, \samp{repr(\var{object})} will be
used.
\var{class}, if present, would be a subclass of \code{BastionClass}; \var{class}, if present, would be a subclass of \class{BastionClass};
see the code in \file{bastion.py} for the details. Overriding the see the code in \file{bastion.py} for the details. Overriding the
default \code{BastionClass} will rarely be required. default \class{BastionClass} will rarely be required.
\end{funcdesc} \end{funcdesc}

17
Doc/libbastion.tex
View file

@ -11,28 +11,29 @@ According to the dictionary, a bastion is ``a fortified area or
position'', or ``something that is considered a stronghold.'' It's a position'', or ``something that is considered a stronghold.'' It's a
suitable name for this module, which provides a way to forbid access suitable name for this module, which provides a way to forbid access
to certain attributes of an object. It must always be used with the to certain attributes of an object. It must always be used with the
\code{rexec} module, in order to allow restricted-mode programs access \module{rexec} module, in order to allow restricted-mode programs access
to certain safe attributes of an object, while denying access to to certain safe attributes of an object, while denying access to
other, unsafe attributes. other, unsafe attributes.
% I've punted on the issue of documenting keyword arguments for now. % I've punted on the issue of documenting keyword arguments for now.
\begin{funcdesc}{Bastion}{object\optional{\, filter\, name\, class}} \begin{funcdesc}{Bastion}{object\optional{\, filter\, name\, class}}
Protect the class instance \var{object}, returning a bastion for the Protect the object \var{object}, returning a bastion for the
object. Any attempt to access one of the object's attributes will object. Any attempt to access one of the object's attributes will
have to be approved by the \var{filter} function; if the access is have to be approved by the \var{filter} function; if the access is
denied an AttributeError exception will be raised. denied an \exception{AttributeError} exception will be raised.
If present, \var{filter} must be a function that accepts a string If present, \var{filter} must be a function that accepts a string
containing an attribute name, and returns true if access to that containing an attribute name, and returns true if access to that
attribute will be permitted; if \var{filter} returns false, the access attribute will be permitted; if \var{filter} returns false, the access
is denied. The default filter denies access to any function beginning is denied. The default filter denies access to any function beginning
with an underscore (\code{_}). The bastion's string representation with an underscore (\samp{_}). The bastion's string representation
will be \code{<Bastion for \var{name}>} if a value for will be \samp{<Bastion for \var{name}>} if a value for
\var{name} is provided; otherwise, \code{repr(\var{object})} will be used. \var{name} is provided; otherwise, \samp{repr(\var{object})} will be
used.
\var{class}, if present, would be a subclass of \code{BastionClass}; \var{class}, if present, would be a subclass of \class{BastionClass};
see the code in \file{bastion.py} for the details. Overriding the see the code in \file{bastion.py} for the details. Overriding the
default \code{BastionClass} will rarely be required. default \class{BastionClass} will rarely be required.
\end{funcdesc} \end{funcdesc}