GNU Info

(python2.1-api.info)Module Objects

---

Next: CObjects Prev: Instance Objects Up: Other Objects

---

Enter node , (file) or (file)node

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

There are only a few functions special to module objects.

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

`int PyModule_Check(PyObject *p)'
     Returns true if its argument is a module object.

`PyObject* PyModule_New(char *name)'
     Return a new module object with the `__name__' attribute set to
     NAME.  Only the module's `__doc__' and `__name__' attributes are
     filled in; the caller is responsible for providing a `__file__'
     attribute.

`PyObject* PyModule_GetDict(PyObject *module)'
     Return the dictionary object that implements MODULE's namespace;
     this object is the same as the `__dict__' attribute of the module
     object.  This function never fails.

`char* PyModule_GetName(PyObject *module)'
     Return MODULE's `__name__' value.  If the module does not provide
     one, or if it is not a string, `SystemError' is raised and `NULL'
     is returned.

`char* PyModule_GetFilename(PyObject *module)'
     Return the name of the file from which MODULE was loaded using
     MODULE's `__file__' attribute.  If this is not defined, or if it
     is not a string, raise `SystemError' and return `NULL'.

`int PyModule_AddObject(PyObject *module, 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.  Returns `-1' on error, `0' on
     success.  _Added in Python version 2.0_

`int PyModule_AddIntConstant(PyObject *module, char *name, int value)'
     Add an integer constant to MODULE as NAME.  This convenience
     function can be used from the module's initialization function.
     Returns `-1' on error, `0' on success.  _Added in Python version
     2.0_

`int PyModule_AddStringConstant(PyObject *module, char *name, 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.  Returns `-1' on error,
     `0' on success.  _Added in Python version 2.0_