Re: [PATCH] Add support for gdb.PYTHONDIR as $gdb_datadir/python.

[Joel Brobecker <brobecker at adacore dot com>]

> Joel> 2010-06-24  Joel Brobecker  <brobecker@adacore.com>
> Joel>         * python/python.c (_initialize_python): Add new "constant"
> Joel>         PYTHONDIR in gdb module.  Insert this path at the head of
> Joel>         sys.path. Set gdb.__path__ to gdb.PYTHONDIR + '/gdb' and
> Joel>         exec its __init__.py script if it exists in that directory.
> 
> This is fine with me.

Thanks! Following Doug's comments, here is the patch that I just
checked in.

NEWS and docs next.

-- 
Joel

commit 2de53ec24130ae79b8f5eb138185173f900ccb29
Author: Joel Brobecker <brobecker@adacore.com>
Date:   Thu Jun 24 10:59:55 2010 -0700

    Add support for  gdb.PYTHONDIR as $gdb_datadir/python.
    
    Python scripts to be used by GDB can be stored in that directory,
    and will be automatically found by the interpreter when importing them.
    This patch also sets up <gdb_pythondir>/gdb as the directory where gdb
    submodules can be stored.  For now, there is nothing there, but it can
    now be added easily without further code changes.
    
    gdb/ChangeLog:
    2010-06-24  Joel Brobecker  <brobecker@adacore.com>
    
            * python/python.c (_initialize_python): Add new "constant"
            PYTHONDIR in gdb module.  Insert this path at the head of
            sys.path. Set gdb.__path__ to gdb.PYTHONDIR + '/gdb' and
            exec its __init__.py script if it exists in that directory.

diff --git a/gdb/python/python.c b/gdb/python/python.c
index 31880c1..18b2cdc 100644
--- a/gdb/python/python.c
+++ b/gdb/python/python.c
@@ -668,6 +668,13 @@ Enables or disables printing of Python stack traces."),
   PyModule_AddStringConstant (gdb_module, "VERSION", (char*) version);
   PyModule_AddStringConstant (gdb_module, "HOST_CONFIG", (char*) host_name);
   PyModule_AddStringConstant (gdb_module, "TARGET_CONFIG", (char*) target_name);
+  {
+    char *gdb_pythondir;
+
+    gdb_pythondir = concat (gdb_datadir, SLASH_STRING, "python", NULL);
+    PyModule_AddStringConstant (gdb_module, "PYTHONDIR", gdb_pythondir);
+    xfree (gdb_pythondir);
+  }
 
   gdbpy_gdberror_exc = PyErr_NewException ("gdb.GdbError", NULL, NULL);
   PyModule_AddObject (gdb_module, "GdbError", gdbpy_gdberror_exc);
@@ -720,6 +727,20 @@ class GdbOutputFile:\n\
 \n\
 sys.stderr = GdbOutputFile()\n\
 sys.stdout = GdbOutputFile()\n\
+\n\
+# GDB's python scripts are stored inside gdb.PYTHONDIR.  So insert\n\
+# that directory name at the start of sys.path to allow the Python\n\
+# interpreter to find them.\n\
+sys.path.insert(0, gdb.PYTHONDIR)\n\
+\n\
+# The gdb module is implemented in C rather than in Python.  As a result,\n\
+# the associated __init.py__ script is not not executed by default when\n\
+# the gdb module gets imported.  Execute that script manually if it exists.\n\
+gdb.__path__ = [gdb.PYTHONDIR + '/gdb']\n\
+from os.path import exists\n\
+ipy = gdb.PYTHONDIR + '/gdb/__init__.py'\n\
+if exists (ipy):\n\
+  execfile (ipy)\n\
 ");
 
   /* Release the GIL while gdb runs.  */