FM / c-api

/usr/share/doc/python2-docs/html/_sources/c-api/

/usr/share/doc/python2-docs/html/_sources/c-api

Name	Size	Mode	Actions
abstract.rst.txt	702	0644	edit dl rm
allocation.rst.txt	4796	0644	edit dl rm
arg.rst.txt	26004	0644	edit dl rm
bool.rst.txt	1304	0644	edit dl rm
buffer.rst.txt	22965	0644	edit dl rm
bytearray.rst.txt	2181	0644	edit dl rm
capsule.rst.txt	5741	0644	edit dl rm
cell.rst.txt	1940	0644	edit dl rm
class.rst.txt	1866	0644	edit dl rm
cobject.rst.txt	1870	0644	edit dl rm
code.rst.txt	1635	0644	edit dl rm
codec.rst.txt	4643	0644	edit dl rm
complex.rst.txt	4079	0644	edit dl rm
concrete.rst.txt	1963	0644	edit dl rm
conversion.rst.txt	7092	0644	edit dl rm
datetime.rst.txt	6413	0644	edit dl rm
descriptor.rst.txt	1296	0644	edit dl rm
dict.rst.txt	7757	0644	edit dl rm
exceptions.rst.txt	35304	0644	edit dl rm
file.rst.txt	6198	0644	edit dl rm
float.rst.txt	3371	0644	edit dl rm
function.rst.txt	2421	0644	edit dl rm
gcsupport.rst.txt	6587	0644	edit dl rm
gen.rst.txt	920	0644	edit dl rm
import.rst.txt	11221	0644	edit dl rm
index.rst.txt	578	0644	edit dl rm
init.rst.txt	49160	0644	edit dl rm
int.rst.txt	4578	0644	edit dl rm
intro.rst.txt	28473	0644	edit dl rm
iter.rst.txt	1390	0644	edit dl rm
iterator.rst.txt	1796	0644	edit dl rm
list.rst.txt	6362	0644	edit dl rm
long.rst.txt	7987	0644	edit dl rm
mapping.rst.txt	2874	0644	edit dl rm
marshal.rst.txt	3985	0644	edit dl rm
memory.rst.txt	11556	0644	edit dl rm
method.rst.txt	2099	0644	edit dl rm
module.rst.txt	3867	0644	edit dl rm
none.rst.txt	697	0644	edit dl rm
number.rst.txt	11939	0644	edit dl rm
objbuffer.rst.txt	2516	0644	edit dl rm
object.rst.txt	17491	0644	edit dl rm
objimpl.rst.txt	305	0644	edit dl rm
refcounting.rst.txt	2934	0644	edit dl rm
reflection.rst.txt	1567	0644	edit dl rm
sequence.rst.txt	8716	0644	edit dl rm
set.rst.txt	6588	0644	edit dl rm
slice.rst.txt	2979	0644	edit dl rm
string.rst.txt	15422	0644	edit dl rm
structures.rst.txt	14966	0644	edit dl rm
sys.rst.txt	5714	0644	edit dl rm
tuple.rst.txt	5491	0644	edit dl rm
type.rst.txt	2761	0644	edit dl rm
typeobj.rst.txt	66936	0644	edit dl rm
unicode.rst.txt	45126	0644	edit dl rm
utilities.rst.txt	415	0644	edit dl rm
veryhigh.rst.txt	13363	0644	edit dl rm
weakref.rst.txt	2820	0644	edit dl rm

Edit: /usr/share/doc/python2-docs/html/_sources/c-api/module.rst.txt (3867B)

.. highlightlang:: c

.. _moduleobjects:

Module Objects
--------------

.. index:: object: module

There are only a few functions special to module objects.

.. c:var:: PyTypeObject PyModule_Type

.. index:: single: ModuleType (in module types)

This instance of :c:type:`PyTypeObject` represents the Python module type.  This
   is exposed to Python programs as ``types.ModuleType``.

.. c:function:: int PyModule_Check(PyObject *p)

Return true if *p* is a module object, or a subtype of a module object.

.. versionchanged:: 2.2
      Allowed subtypes to be accepted.

.. c:function:: int PyModule_CheckExact(PyObject *p)

Return true if *p* is a module object, but not a subtype of
   :c:data:`PyModule_Type`.

.. versionadded:: 2.2

.. c:function:: PyObject* PyModule_New(const char *name)

.. index::
      single: __name__ (module attribute)
      single: __doc__ (module attribute)
      single: __file__ (module attribute)

Return a new module object with the :attr:`__name__` attribute set to *name*.
   Only the module's :attr:`__doc__` and :attr:`__name__` attributes are filled in;
   the caller is responsible for providing a :attr:`__file__` attribute.

.. c:function:: PyObject* PyModule_GetDict(PyObject *module)

.. index:: single: __dict__ (module attribute)

Return the dictionary object that implements *module*'s namespace; this object
   is the same as the :attr:`~object.__dict__` attribute of the module object.  This
   function never fails.  It is recommended extensions use other
   :c:func:`PyModule_\*` and :c:func:`PyObject_\*` functions rather than directly
   manipulate a module's :attr:`~object.__dict__`.

.. c:function:: char* PyModule_GetName(PyObject *module)

.. index::
      single: __name__ (module attribute)
      single: SystemError (built-in exception)

Return *module*'s :attr:`__name__` value.  If the module does not provide one,
   or if it is not a string, :exc:`SystemError` is raised and *NULL* is returned.

.. c:function:: char* PyModule_GetFilename(PyObject *module)

.. index::
      single: __file__ (module attribute)
      single: SystemError (built-in exception)

Return the name of the file from which *module* was loaded using *module*'s
   :attr:`__file__` attribute.  If this is not defined, or if it is not a string,
   raise :exc:`SystemError` and return *NULL*.

.. c:function:: int PyModule_AddObject(PyObject *module, const char *name, PyObject *value)

Add an object to *module* as *name*.  This is a convenience function which can
   be used from the module's initialization function.  This steals a reference to
   *value*.  Return ``-1`` on error, ``0`` on success.

.. versionadded:: 2.0

.. c:function:: int PyModule_AddIntConstant(PyObject *module, const char *name, long value)

Add an integer constant to *module* as *name*.  This convenience function can be
   used from the module's initialization function. Return ``-1`` on error, ``0`` on
   success.

.. versionadded:: 2.0

.. c:function:: int PyModule_AddStringConstant(PyObject *module, const char *name, const char *value)

Add a string constant to *module* as *name*.  This convenience function can be
   used from the module's initialization function.  The string *value* must be
   null-terminated.  Return ``-1`` on error, ``0`` on success.

.. versionadded:: 2.0

.. c:function:: int PyModule_AddIntMacro(PyObject *module, macro)

Add an int constant to *module*. The name and the value are taken from
   *macro*. For example ``PyModule_AddIntMacro(module, AF_INET)`` adds the int
   constant *AF_INET* with the value of *AF_INET* to *module*.
   Return ``-1`` on error, ``0`` on success.

.. versionadded:: 2.6

.. c:function:: int PyModule_AddStringMacro(PyObject *module, macro)

Add a string constant to *module*.

.. versionadded:: 2.6

cmd: