##// END OF EJS Templates
add --keep alias for history trim
Paul Ivanov -
Show More
@@ -1,119 +1,123 b''
1 1 # encoding: utf-8
2 2 """
3 3 An application for managing IPython history.
4 4
5 5 To be invoked as the `ipython history` subcommand.
6 6 """
7 7 from __future__ import print_function
8 8
9 9 import os
10 10 import sqlite3
11 11
12 12 from IPython.config.application import Application
13 13 from IPython.core.application import BaseIPythonApplication
14 14 from IPython.utils.traitlets import Bool, Int, Dict
15 15
16 16 trim_hist_help = """Trim the IPython history database to the last 1000 entries.
17 17
18 18 This actually copies the last 1000 entries to a new database, and then replaces
19 19 the old file with the new.
20 20 """
21 21
22 22 class HistoryTrim(BaseIPythonApplication):
23 23 description = trim_hist_help
24 24
25 25 backup = Bool(False, config=True,
26 26 help="Keep the old history file as history.sqlite.<N>")
27 27
28 28 keep = Int(1000, config=True,
29 29 help="Number of recent lines to keep in the database.")
30 30
31 31 flags = Dict(dict(
32 32 backup = ({'HistoryTrim' : {'backup' : True}},
33 "Keep the old history file as history.sqlite.<N>"
33 backup.get_metadata('help')
34 34 )
35 35 ))
36 36
37 aliases=Dict(dict(
38 keep = 'HistoryTrim.keep'
39 ))
40
37 41 def start(self):
38 42 profile_dir = self.profile_dir.location
39 43 hist_file = os.path.join(profile_dir, 'history.sqlite')
40 44 con = sqlite3.connect(hist_file)
41 45
42 46 # Grab the recent history from the current database.
43 47 inputs = list(con.execute('SELECT session, line, source, source_raw FROM '
44 48 'history ORDER BY session DESC, line DESC LIMIT ?', (self.keep+1,)))
45 49 if len(inputs) <= self.keep:
46 50 print("There are already at most %d entries in the history database." % self.keep)
47 print("Not doing anything.")
51 print("Not doing anything. Use --keep= argument to keep fewer entries")
48 52 return
49 53
50 54 print("Trimming history to the most recent %d entries." % self.keep)
51 55
52 56 inputs.pop() # Remove the extra element we got to check the length.
53 57 inputs.reverse()
54 58 first_session = inputs[0][0]
55 59 outputs = list(con.execute('SELECT session, line, output FROM '
56 60 'output_history WHERE session >= ?', (first_session,)))
57 61 sessions = list(con.execute('SELECT session, start, end, num_cmds, remark FROM '
58 62 'sessions WHERE session >= ?', (first_session,)))
59 63 con.close()
60 64
61 65 # Create the new history database.
62 66 new_hist_file = os.path.join(profile_dir, 'history.sqlite.new')
63 67 i = 0
64 68 while os.path.exists(new_hist_file):
65 69 # Make sure we don't interfere with an existing file.
66 70 i += 1
67 71 new_hist_file = os.path.join(profile_dir, 'history.sqlite.new'+str(i))
68 72 new_db = sqlite3.connect(new_hist_file)
69 73 new_db.execute("""CREATE TABLE IF NOT EXISTS sessions (session integer
70 74 primary key autoincrement, start timestamp,
71 75 end timestamp, num_cmds integer, remark text)""")
72 76 new_db.execute("""CREATE TABLE IF NOT EXISTS history
73 77 (session integer, line integer, source text, source_raw text,
74 78 PRIMARY KEY (session, line))""")
75 79 new_db.execute("""CREATE TABLE IF NOT EXISTS output_history
76 80 (session integer, line integer, output text,
77 81 PRIMARY KEY (session, line))""")
78 82 new_db.commit()
79 83
80 84
81 85 with new_db:
82 86 # Add the recent history into the new database.
83 87 new_db.executemany('insert into sessions values (?,?,?,?,?)', sessions)
84 88 new_db.executemany('insert into history values (?,?,?,?)', inputs)
85 89 new_db.executemany('insert into output_history values (?,?,?)', outputs)
86 90 new_db.close()
87 91
88 92 if self.backup:
89 93 i = 1
90 94 backup_hist_file = os.path.join(profile_dir, 'history.sqlite.old.%d' % i)
91 95 while os.path.exists(backup_hist_file):
92 96 i += 1
93 97 backup_hist_file = os.path.join(profile_dir, 'history.sqlite.old.%d' % i)
94 98 os.rename(hist_file, backup_hist_file)
95 99 print("Backed up longer history file to", backup_hist_file)
96 100 else:
97 101 os.remove(hist_file)
98 102
99 103 os.rename(new_hist_file, hist_file)
100 104
101 105
102 106 class HistoryApp(Application):
103 107 name = u'ipython-history'
104 108 description = "Manage the IPython history database."
105 109
106 110 subcommands = Dict(dict(
107 111 trim = (HistoryTrim, HistoryTrim.description.splitlines()[0]),
108 112 ))
109 113
110 114 def start(self):
111 115 if self.subapp is None:
112 116 print("No subcommand specified. Must specify one of: %s" % \
113 117 (self.subcommands.keys()))
114 118 print()
115 119 self.print_description()
116 120 self.print_subcommands()
117 121 self.exit(1)
118 122 else:
119 123 return self.subapp.start()
General Comments 0
You need to be logged in to leave comments. Login now