From a355a9f76add5b7b91b31b9e8b07c4f0fbc9ce3a 2011-10-14 20:41:52
From: Thomas Kluyver <takowl@gmail.com>
Date: 2011-10-14 20:41:52
Subject: [PATCH] Add example script for extracting history from the database.

---

diff --git a/docs/examples/core/ipython-get-history.py b/docs/examples/core/ipython-get-history.py
new file mode 100755
index 0000000..d6d51ec
--- /dev/null
+++ b/docs/examples/core/ipython-get-history.py
@@ -0,0 +1,38 @@
+#!/usr/bin/env python
+"""Extract a session from the IPython input history.
+
+Usage:
+  ipython-get-history.py sessionnumber [outputfile]
+
+If outputfile is not given, the relevant history is written to stdout. If
+outputfile has a .py extension, the translated history (without IPython's
+special syntax) will be extracted.
+
+Example:
+  ./ipython-get-history.py 57 record.ipy
+
+
+This script is a simple demonstration of HistoryAccessor. It should be possible
+to build much more flexible and powerful tools to browse and pull from the
+history database.
+"""
+import sys
+import codecs
+
+from IPython.core.history import HistoryAccessor
+
+session_number = int(sys.argv[1])
+if len(sys.argv) > 2:
+    dest = open(sys.argv[2], "w")
+    raw = not sys.argv[2].endswith('.py')
+else:
+    dest = sys.stdout
+    raw = True
+dest.write("# coding: utf-8\n")
+
+# Profiles other than 'default' can be specified here with a profile= argument:
+hist = HistoryAccessor()
+
+for session, lineno, cell in hist.get_range(session=session_number, raw=raw):
+    # To use this in Python 3, remove the .encode() here:
+    dest.write(cell.encode('utf-8') + '\n')