cpython.git - https://github.com/python/cpython.git

summary refs log tree commit diff stats

path: root/Include/descrobject.h

	Commit message (Expand)	Author	Age	Files	Lines
*	bpo-32240: Add the const qualifier to declarations of PyObject* array argumen...	Serhiy Storchaka	2017-12-15	1	-1/+1

*	Issue #29263: LOAD_METHOD support for C methods	INADA Naoki	2017-02-02	1	-0/+3

*	Issue #28761: The fields name and doc of structures PyMemberDef, PyGetSetDef,	Serhiy Storchaka	2016-11-22	1	-4/+4

*	Issue #26900: Excluded underscored names and other private API from limited API.	Serhiy Storchaka	2016-09-11	1	-0/+2

*	Issue #13577: various kinds of descriptors now have a __qualname__ attribute.	Antoine Pitrou	2011-12-12	1	-0/+1

*	make sure to initialize the method wrapper type	Benjamin Peterson	2011-09-01	1	-0/+1

*	Merge branches/pep-0384.	Martin v. Löwis	2010-12-03	1	-0/+5

*	Recorded merge of revisions 81029 via svnmerge from	Antoine Pitrou	2010-05-09	1	-29/+29

*	Issue #6151: Make PyDescr_COMMON conform to standard C.	Alexandre Vassalotti	2009-07-22	1	-6/+8

*	remove duplicate declartions #6405	Benjamin Peterson	2009-07-03	1	-2/+0

*	Merged revisions 71734,71738-71739 via svnmerge from	Benjamin Peterson	2009-04-20	1	-0/+2

*	#1629: Renamed Py_Size, Py_Type and Py_Refcnt to Py_SIZE, Py_TYPE and Py_REFCNT.	Christian Heimes	2007-12-19	1	-1/+1

*	Added all PyTypeObjects to the appropriate header files.	Christian Heimes	2007-11-29	1	-0/+5

*	Merged revisions 56467-56482 via svnmerge from	Martin v. Löwis	2007-07-21	1	-1/+1

*	SF 548651: Fix the METH_CLASS implementation.	Tim Peters	2002-12-09	1	-0/+1

*	Make PyDescr_IsData() a macro. It's too simple to be a function.	Guido van Rossum	2002-08-19	1	-1/+1

*	Excise DL_EXPORT from Include.	Mark Hammond	2002-08-12	1	-9/+9

*	Patch #536908: Add missing #include guards/extern "C".	Martin v. Löwis	2002-03-30	1	-0/+10

*	Methods of built-in types now properly check for keyword arguments	Guido van Rossum	2001-10-22	1	-0/+7

*	Big internal change that should have no external effects: unify the	Guido van Rossum	2001-10-21	1	-0/+3

*	EXPERIMENTAL speedup of slot_sq_item. This sped up the following	Guido van Rossum	2001-10-03	1	-0/+34

*	Add optional docstrings to getset descriptors. Fortunately, there's	Guido van Rossum	2001-09-20	1	-4/+5

*	Add optional docstrings to member descriptors. For backwards	Guido van Rossum	2001-09-20	1	-1/+1

*	Rename 'getset' to 'property'.	Guido van Rossum	2001-09-06	1	-1/+1

*	Add new built-in type 'getset' (PyGetSet_Type).	Guido van Rossum	2001-08-23	1	-0/+3

*	Merge of descr-branch back into trunk.	Tim Peters	2001-08-02	1	-0/+32

'ctx'> using \function{btopen()}), if \var{key} does not actually exist in

@@ -139,32 +139,32 @@ and return that key and value. For other databases,

database.

\end{methoddesc}

-\begin{methoddesc}{first}{}

+\begin{methoddesc}[bsddbobject]{first}{}

Set the cursor to the first item in the DB file and return it. The order of

keys in the file is unspecified, except in the case of B-Tree databases.

This method raises \exception{bsddb.error} if the database is empty.

\end{methoddesc}

-\begin{methoddesc}{next}{}

+\begin{methoddesc}[bsddbobject]{next}{}

Set the cursor to the next item in the DB file and return it. The order of

keys in the file is unspecified, except in the case of B-Tree databases.

\end{methoddesc}

-\begin{methoddesc}{previous}{}

+\begin{methoddesc}[bsddbobject]{previous}{}

Set the cursor to the previous item in the DB file and return it. The

order of keys in the file is unspecified, except in the case of B-Tree

databases. This is not supported on hashtable databases (those opened

with \function{hashopen()}).

\end{methoddesc}

-\begin{methoddesc}{last}{}

+\begin{methoddesc}[bsddbobject]{last}{}

Set the cursor to the last item in the DB file and return it. The

order of keys in the file is unspecified. This is not supported on

hashtable databases (those opened with \function{hashopen()}).

This method raises \exception{bsddb.error} if the database is empty.

\end{methoddesc}

-\begin{methoddesc}{sync}{}

+\begin{methoddesc}[bsddbobject]{sync}{}

Synchronize the database on disk.

\end{methoddesc}

diff --git a/Doc/lib/libcgitb.tex b/Doc/lib/libcgitb.tex
index c686fe6..ca9959f 100644
--- a/Doc/lib/libcgitb.tex
+++ b/Doc/lib/libcgitb.tex

@@ -38,7 +38,7 @@ to a file for later analysis.

context\optional{, format}}}}}

This function causes the \module{cgitb} module to take over the

interpreter's default handling for exceptions by setting the

- value of \code{\refmodule{sys}.excepthook}.

+ value of \member{\refmodule{sys}.excepthook}.

\withsubitem{(in module sys)}{\ttindex{excepthook()}}

The optional argument \var{display} defaults to \code{1} and can be set

@@ -61,7 +61,7 @@ to a file for later analysis.

report it using \module{cgitb}. The optional \var{info} argument

should be a 3-tuple containing an exception type, exception

value, and traceback object, exactly like the tuple returned by

- \code{\refmodule{sys}.exc_info()}. If the \var{info} argument

+ \function{\refmodule{sys}.exc_info()}. If the \var{info} argument

is not supplied, the current exception is obtained from

- \code{\refmodule{sys}.exc_info()}.

+ \function{\refmodule{sys}.exc_info()}.

\end{funcdesc}

diff --git a/Doc/lib/libcodecs.tex b/Doc/lib/libcodecs.tex
index 05c0375..43995c1 100644
--- a/Doc/lib/libcodecs.tex
+++ b/Doc/lib/libcodecs.tex

@@ -307,7 +307,7 @@ The set of allowed values can be extended via \method{register_error}.

The \class{Codec} class defines these methods which also define the

function interfaces of the stateless encoder and decoder:

-\begin{methoddesc}{encode}{input\optional{, errors}}

+\begin{methoddesc}[Codec]{encode}{input\optional{, errors}}

Encodes the object \var{input} and returns a tuple (output object,

length consumed). While codecs are not restricted to use with Unicode, in

a Unicode context, encoding converts a Unicode object to a plain string

@@ -325,7 +325,7 @@ function interfaces of the stateless encoder and decoder:

empty object of the output object type in this situation.

\end{methoddesc}

-\begin{methoddesc}{decode}{input\optional{, errors}}

+\begin{methoddesc}[Codec]{decode}{input\optional{, errors}}

Decodes the object \var{input} and returns a tuple (output object,

length consumed). In a Unicode context, decoding converts a plain string

encoded using a particular character set encoding to a Unicode object.

@@ -1197,9 +1197,8 @@ listed as operand type in the table.

\lineiv{idna}

{}

{Unicode string}

- {Implements \rfc{3490}.

- \versionadded{2.3}

- See also \refmodule{encodings.idna}}

+ {Implements \rfc{3490},

+ see also \refmodule{encodings.idna}}

\lineiv{mbcs}

{dbcs}

@@ -1214,8 +1213,7 @@ listed as operand type in the table.

\lineiv{punycode}

{}

{Unicode string}

- {Implements \rfc{3492}.

- \versionadded{2.3}}

+ {Implements \rfc{3492}}

\lineiv{quopri_codec}

{quopri, quoted-printable, quotedprintable}

@@ -1269,6 +1267,8 @@ listed as operand type in the table.

\end{tableiv}

+\versionadded[The \code{idna} and \code{punycode} encodings]{2.3}

+

\subsection{\module{encodings.idna} ---

Internationalized Domain Names in Applications}

diff --git a/Doc/lib/libcollections.tex b/Doc/lib/libcollections.tex
index 9e755b1..475567a 100644
--- a/Doc/lib/libcollections.tex
+++ b/Doc/lib/libcollections.tex

@@ -17,7 +17,7 @@ Future additions may include balanced trees and ordered dictionaries.

\subsection{\class{deque} objects \label{deque-objects}}

-\begin{funcdesc}{deque}{\optional{iterable}}

+\begin{classdesc}{deque}{\optional{iterable}}

Returns a new deque object initialized left-to-right (using

\method{append()}) with data from \var{iterable}. If \var{iterable}

is not specified, the new deque is empty.

@@ -32,7 +32,7 @@ Future additions may include balanced trees and ordered dictionaries.

for \samp{pop(0)} and \samp{insert(0, v)} operations which change both the

size and position of the underlying data representation.

\versionadded{2.4}

-\end{funcdesc}

+\end{classdesc}

Deque objects support the following methods:

diff --git a/Doc/lib/libconsts.tex b/Doc/lib/libconsts.tex
index a7b4498..7aa0ea0 100644
--- a/Doc/lib/libconsts.tex
+++ b/Doc/lib/libconsts.tex

@@ -13,7 +13,7 @@ A small number of constants live in the built-in namespace. They are:

\end{datadesc}

\begin{datadesc}{None}

- The sole value of \code{\refmodule{types}.NoneType}. \code{None} is

+ The sole value of \member{\refmodule{types}.NoneType}. \code{None} is

frequently used to represent the absence of a value, as when default

arguments are not passed to a function.

\end{datadesc}

diff --git a/Doc/lib/libcursespanel.tex b/Doc/lib/libcursespanel.tex
index 1f96717..14d83e3 100644
--- a/Doc/lib/libcursespanel.tex
+++ b/Doc/lib/libcursespanel.tex

@@ -45,52 +45,52 @@ responsible for the window's depth in the panel stack.

Panel objects have the following methods:

-\begin{methoddesc}{above}{}

+\begin{methoddesc}[Panel]{above}{}

Returns the panel above the current panel.

\end{methoddesc}

-\begin{methoddesc}{below}{}

+\begin{methoddesc}[Panel]{below}{}

Returns the panel below the current panel.

\end{methoddesc}

-\begin{methoddesc}{bottom}{}

+\begin{methoddesc}[Panel]{bottom}{}

Push the panel to the bottom of the stack.

\end{methoddesc}

-\begin{methoddesc}{hidden}{}

+\begin{methoddesc}[Panel]{hidden}{}

Returns true if the panel is hidden (not visible), false otherwise.

\end{methoddesc}

-\begin{methoddesc}{hide}{}

+\begin{methoddesc}[Panel]{hide}{}

Hide the panel. This does not delete the object, it just makes the

window on screen invisible.

\end{methoddesc}

-\begin{methoddesc}{move}{y, x}

+\begin{methoddesc}[Panel]{move}{y, x}

Move the panel to the screen coordinates \code{(\var{y}, \var{x})}.

\end{methoddesc}

-\begin{methoddesc}{replace}{win}

+\begin{methoddesc}[Panel]{replace}{win}

Change the window associated with the panel to the window \var{win}.

\end{methoddesc}

-\begin{methoddesc}{set_userptr}{obj}

+\begin{methoddesc}[Panel]{set_userptr}{obj}

Set the panel's user pointer to \var{obj}. This is used to associate an

arbitrary piece of data with the panel, and can be any Python object.

\end{methoddesc}

-\begin{methoddesc}{show}{}

+\begin{methoddesc}[Panel]{show}{}

Display the panel (which might have been hidden).

\end{methoddesc}

-\begin{methoddesc}{top}{}

+\begin{methoddesc}[Panel]{top}{}

Push panel to the top of the stack.

\end{methoddesc}

-\begin{methoddesc}{userptr}{}

+\begin{methoddesc}[Panel]{userptr}{}

Returns the user pointer for the panel. This might be any Python object.

\end{methoddesc}

-\begin{methoddesc}{window}{}

+\begin{methoddesc}[Panel]{window}{}

Returns the window object associated with the panel.

\end{methoddesc}

diff --git a/Doc/lib/libdl.tex b/Doc/lib/libdl.tex
index 325724c..d4a799e 100644
--- a/Doc/lib/libdl.tex
+++ b/Doc/lib/libdl.tex

@@ -67,11 +67,11 @@ example of the fact that using this module is usually a bad alternative.

Dl objects, as returned by \function{open()} above, have the

following methods:

-\begin{methoddesc}{close}{}

+\begin{methoddesc}[dl]{close}{}

Free all resources, except the memory.

\end{methoddesc}

-\begin{methoddesc}{sym}{name}

+\begin{methoddesc}[dl]{sym}{name}

Return the pointer for the function named \var{name}, as a number, if

it exists in the referenced shared object, otherwise \code{None}. This

is useful in code like:

@@ -87,7 +87,7 @@ is useful in code like:

\NULL{} pointer)

\end{methoddesc}

-\begin{methoddesc}{call}{name\optional{, arg1\optional{, arg2\ldots}}}

+\begin{methoddesc}[dl]{call}{name\optional{, arg1\optional{, arg2\ldots}}}

Call the function named \var{name} in the referenced shared object.

The arguments must be either Python integers, which will be

passed as is, Python strings, to which a pointer will be passed,

diff --git a/Doc/lib/libdoctest.tex b/Doc/lib/libdoctest.tex
index 4060236..5e28c2a 100644
--- a/Doc/lib/libdoctest.tex
+++ b/Doc/lib/libdoctest.tex

@@ -1741,7 +1741,7 @@ Doctest provides several mechanisms for debugging doctest examples:

>>>

\end{verbatim}

- \versionchanged[The ability to use \code{\refmodule{pdb}.set_trace()}

+ \versionchanged[The ability to use \function{\refmodule{pdb}.set_trace()}

usefully inside doctests was added]{2.4}

\end{itemize}

@@ -1825,10 +1825,10 @@ print doctest.testsource(a, "a.f")

used. If \var{pm} has a true value, the script file is run directly, and

the debugger gets involved only if the script terminates via raising an

unhandled exception. If it does, then post-mortem debugging is invoked,

- via \code{\refmodule{pdb}.post_mortem()}, passing the traceback object

+ via \function{\refmodule{pdb}.post_mortem()}, passing the traceback object

from the unhandled exception. If \var{pm} is not specified, or is false,

the script is run under the debugger from the start, via passing an

- appropriate \function{execfile()} call to \code{\refmodule{pdb}.run()}.

+ appropriate \function{execfile()} call to \function{\refmodule{pdb}.run()}.

\versionadded{2.3}

diff --git a/Doc/lib/libdumbdbm.tex b/Doc/lib/libdumbdbm.tex
index 4495774..d0917be 100644
--- a/Doc/lib/libdumbdbm.tex
+++ b/Doc/lib/libdumbdbm.tex

@@ -57,7 +57,7 @@ only when the database has to be created. It defaults to octal

In addition to the methods provided by the \class{UserDict.DictMixin} class,

\class{dumbdbm} objects provide the following methods.

-\begin{methoddesc}{sync}{}

+\begin{methoddesc}[dumbdbm]{sync}{}

Synchronize the on-disk directory and data files. This method is called by

the \method{sync} method of \class{Shelve} objects.

\end{methoddesc}

diff --git a/Doc/lib/libetree.tex b/Doc/lib/libetree.tex
index f769c63..6f20ee3 100644
--- a/Doc/lib/libetree.tex
+++ b/Doc/lib/libetree.tex

@@ -144,12 +144,12 @@ Returns a tuple containing an Element instance and a dictionary.

Element objects returned by Element or SubElement have the

following methods and attributes.

-\begin{memberdesc}{tag}

+\begin{memberdesc}[Element]{tag}

A string identifying what kind of data this element represents

(the element type, in other words).

\end{memberdesc}

-\begin{memberdesc}{text}

+\begin{memberdesc}[Element]{text}

The \var{text} attribute can be used to hold additional data

associated with the element.

As the name implies this attribute is usually a string but may be any

@@ -158,7 +158,7 @@ If the element is created from an XML file the attribute will contain

any text found between the element tags.

\end{memberdesc}

-\begin{memberdesc}{tail}

+\begin{memberdesc}[Element]{tail}

The \var{tail} attribute can be used to hold additional data

associated with the element.

This attribute is usually a string but may be any application-specific object.

@@ -166,7 +166,7 @@ If the element is created from an XML file the attribute will contain

any text found after the element's end tag and before the next tag.

\end{memberdesc}

-\begin{memberdesc}{attrib}

+\begin{memberdesc}[Element]{attrib}

A dictionary containing the element's attributes.

Note that while the \var{attrib} value is always a real mutable Python

dictionary, an ElementTree implementation may choose to use another

@@ -177,52 +177,52 @@ dictionary methods below whenever possible.

The following dictionary-like methods work on the element attributes.

-\begin{methoddesc}{clear}{}

+\begin{methoddesc}[Element]{clear}{}

Resets an element. This function removes all subelements, clears

all attributes, and sets the text and tail attributes to None.

\end{methoddesc}

-\begin{methoddesc}{get}{key\optional{, default=None}}

+\begin{methoddesc}[Element]{get}{key\optional{, default=None}}

Gets the element attribute named \var{key}.

Returns the attribute value, or \var{default} if the

attribute was not found.

\end{methoddesc}

-\begin{methoddesc}{items}{}

+\begin{methoddesc}[Element]{items}{}

Returns the element attributes as a sequence of (name, value) pairs.

The attributes are returned in an arbitrary order.

\end{methoddesc}

-\begin{methoddesc}{keys}{}

+\begin{methoddesc}[Element]{keys}{}

Returns the elements attribute names as a list.

The names are returned in an arbitrary order.

\end{methoddesc}

-\begin{methoddesc}{set}{key, value}

+\begin{methoddesc}[Element]{set}{key, value}

Set the attribute \var{key} on the element to \var{value}.

\end{methoddesc}

The following methods work on the element's children (subelements).

-\begin{methoddesc}{append}{subelement}

+\begin{methoddesc}[Element]{append}{subelement}

Adds the element \var{subelement} to the end of this elements internal list

of subelements.

\end{methoddesc}

-\begin{methoddesc}{find}{match}

+\begin{methoddesc}[Element]{find}{match}

Finds the first subelement matching \var{match}.

\var{match} may be a tag name or path.

Returns an element instance or \code{None}.

\end{methoddesc}

-\begin{methoddesc}{findall}{match}

+\begin{methoddesc}[Element]{findall}{match}

Finds all subelements matching \var{match}.

\var{match} may be a tag name or path.

Returns an iterable yielding all matching elements in document order.

\end{methoddesc}

-\begin{methoddesc}{findtext}{condition\optional{, default=None}}

+\begin{methoddesc}[Element]{findtext}{condition\optional{, default=None}}

Finds text for the first subelement matching \var{condition}.

\var{condition} may be a tag name or path.

Returns the text content of the first matching element, or

@@ -230,11 +230,11 @@ Returns the text content of the first matching element, or

matching element has no text content an empty string is returned.

\end{methoddesc}

-\begin{methoddesc}{getchildren}{}

+\begin{methoddesc}[Element]{getchildren}{}

Returns all subelements. The elements are returned in document order.

\end{methoddesc}

-\begin{methoddesc}{getiterator}{\optional{tag=None}}

+\begin{methoddesc}[Element]{getiterator}{\optional{tag=None}}

Creates a tree iterator with the current element as the root.

The iterator iterates over this element and all elements below it

that match the given tag. If tag

@@ -243,16 +243,16 @@ Returns an iterable that provides element objects in document (depth first)

order.

\end{methoddesc}

-\begin{methoddesc}{insert}{index, element}

+\begin{methoddesc}[Element]{insert}{index, element}

Inserts a subelement at the given position in this element.

\end{methoddesc}

-\begin{methoddesc}{makeelement}{tag, attrib}

+\begin{methoddesc}[Element]{makeelement}{tag, attrib}

Creates a new element object of the same type as this element.

Do not call this method, use the SubElement factory function instead.

\end{methoddesc}

-\begin{methoddesc}{remove}{subelement}

+\begin{methoddesc}[Element]{remove}{subelement}

Removes \var{subelement} from the element.

Unlike the findXXX methods this method compares elements based on

the instance identity, not on tag value or contents.

diff --git a/Doc/lib/libhmac.tex b/Doc/lib/libhmac.tex
index 5ca24d1..5329cb5 100644
--- a/Doc/lib/libhmac.tex
+++ b/Doc/lib/libhmac.tex

@@ -15,7 +15,7 @@ This module implements the HMAC algorithm as described by \rfc{2104}.

Return a new hmac object. If \var{msg} is present, the method call

\code{update(\var{msg})} is made. \var{digestmod} is the digest

constructor or module for the HMAC object to use. It defaults to

- the \code{\refmodule{hashlib}.md5} constructor. \note{The md5 hash

+ the \function{\refmodule{hashlib}.md5} constructor. \note{The md5 hash

has known weaknesses but remains the default for backwards compatibility.

Choose a better one for your application.}

\end{funcdesc}

diff --git a/Doc/lib/liblogging.tex b/Doc/lib/liblogging.tex