Next: Frames In Python, Previous: Progspaces In Python, Up: Python API

##### 23.2.2.22 Objfiles In Python

gdb loads symbols for an inferior from various symbol-containing files (see Files). These include the primary executable file, any shared libraries used by the inferior, and any separate debug info files (see Separate Debug Files). gdb calls these symbol-containing files objfiles.

The following objfile-related functions are available in the `gdb` module:

— Function: gdb.current_objfile ()

> When auto-loading a Python script (see Python Auto-loading), gdb sets the “current objfile” to the corresponding objfile. This function returns the current objfile. If there is no current objfile, this function returns `None`.

— Function: gdb.objfiles ()

> Return a sequence of all the objfiles current known to gdb. See Objfiles In Python.

Each objfile is represented by an instance of the `gdb.Objfile` class.

— Variable: Objfile.filename

> The file name of the objfile as a string.

— Variable: Objfile.pretty_printers

> The `pretty_printers` attribute is a list of functions. It is used to look up pretty-printers. A `Value` is passed to each function in order; if the function returns `None`, then the search continues. Otherwise, the return value should be an object which is used to format the value. See Pretty Printing API, for more information.

— Variable: Objfile.type_printers

> The `type_printers` attribute is a list of type printer objects. See Type Printing API, for more information.

— Variable: Objfile.frame_filters

> The `frame_filters` attribute is a dictionary of frame filter objects. See Frame Filter API, for more information.

A `gdb.Objfile` object has the following methods:

— Function: Objfile.is_valid ()

> Returns `True` if the `gdb.Objfile` object is valid, `False` if not. A `gdb.Objfile` object can become invalid if the object file it refers to is not loaded in gdb any longer. All other `gdb.Objfile` methods will throw an exception if it is invalid at the time the method is called.