[Python-checkins] python/dist/src/Doc/ref ref3.tex,1.120,1.121
mwh at users.sourceforge.net
mwh at users.sourceforge.net
Thu Aug 12 20:12:46 CEST 2004
Update of /cvsroot/python/python/dist/src/Doc/ref
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv2096/Doc/ref
Modified Files:
ref3.tex
Log Message:
This is my patch
[ 1004703 ] Make func_name writable
plus fixing a couple of nits in the documentation changes spotted by MvL
and a Misc/NEWS entry.
Index: ref3.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/ref/ref3.tex,v
retrieving revision 1.120
retrieving revision 1.121
diff -C2 -d -r1.120 -r1.121
*** ref3.tex 29 Jun 2004 04:14:02 -0000 1.120
--- ref3.tex 12 Aug 2004 18:12:43 -0000 1.121
***************
*** 434,459 ****
\obindex{user-defined function}
! Special attributes: \member{func_doc} or \member{__doc__} is the
! function's documentation string, or \code{None} if unavailable;
! \member{func_name} or \member{__name__} is the function's name;
! \member{__module__} is the name of the module the function was defined
! in, or \code{None} if unavailable;
! \member{func_defaults} is a tuple containing default argument values for
! those arguments that have defaults, or \code{None} if no arguments
! have a default value; \member{func_code} is the code object representing
! the compiled function body; \member{func_globals} is (a reference to)
! the dictionary that holds the function's global variables --- it
! defines the global namespace of the module in which the function was
! defined; \member{func_dict} or \member{__dict__} contains the
! namespace supporting arbitrary function attributes;
! \member{func_closure} is \code{None} or a tuple of cells that contain
! bindings for the function's free variables.
! Of these, \member{func_code}, \member{func_defaults},
! \member{func_doc}/\member{__doc__}, and
! \member{func_dict}/\member{__dict__} may be writable; the
! others can never be changed. Additional information about a
! function's definition can be retrieved from its code object; see the
! description of internal types below.
\withsubitem{(function attribute)}{
--- 434,486 ----
\obindex{user-defined function}
! Special attributes:
! \begin{tableiii}{lll}{member}{Attribute}{Meaning}{}
! \lineiii{func_doc}{The function's documentation string, or
! \code{None} if unavailable}{Writable}
!
! \lineiii{__doc__}{Another way of spelling
! \member{func_doc}}{Writable}
!
! \lineiii{func_name}{The function's name}{Writable}
!
! \lineiii{__name__}{Another way of spelling
! \member{func_name}}{Writable}
!
! \lineiii{__module__}{The name of the module the function was defined
! in, or \code{None} if unavailable.}{Writable}
!
! \lineiii{func_defaults}{Atuple containing default argument values
! for those arguments that have defaults, or \code{None} if no
! arguments have a default value}{Writable}
!
! \lineiii{func_code}{The code object representing the compiled
! function body.}{Writable}
!
! \lineiii{func_globals}{A reference to the dictionary that holds the
! function's global variables --- the global namespace of the module
! in which the function was defined.}{Read-only}
!
! \lineiii{func_dict}{The namespace supporting arbitrary function
! attributes.}{Writable}
!
! \lineiii{func_closure}{\code{None} or a tuple of cells that contain
! bindings for the function's free variables.}{Read-only}
! \end{tableiii}
!
! Most of the attributes labelled ``Writable'' check the type of the
! assigned value.
!
! \versionchanged[\code{func_name} is now writable]{2.4}
!
! Function objects also support getting and setting arbitrary
! attributes, which can be used, for example, to attach metadata to
! functions. Regular attribute dot-notation is used to get and set such
! attributes. \emph{Note that the current implementation only supports
! function attributes on user-defined functions. Function attributes on
! built-in functions may be supported in the future.}
!
! Additional information about a function's definition can be retrieved
! from its code object; see the description of internal types below.
\withsubitem{(function attribute)}{
More information about the Python-checkins
mailing list