annotate sqlex/main.py @ 5:3a7f515571dc

can list column names
author Jeff Hammel <k0scist@gmail.com>
date Sat, 01 Apr 2017 11:11:28 -0700
parents b440206930ac
children 22fbe50d92e8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
1 #!/usr/bin/env python
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
2 # -*- coding: utf-8 -*-
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
3
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
4 """
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
5 sql(ite) explorer/exporter
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
6 """
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
7
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
8 # imports
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
9 import argparse
5
3a7f515571dc can list column names
Jeff Hammel <k0scist@gmail.com>
parents: 4
diff changeset
10 import csv
0
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
11 import os
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
12 import sys
3
5f1e1ac96aa7 stub works with SELECT
Jeff Hammel <k0scist@gmail.com>
parents: 2
diff changeset
13 from .model import SQLEx
5f1e1ac96aa7 stub works with SELECT
Jeff Hammel <k0scist@gmail.com>
parents: 2
diff changeset
14
0
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
15
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
16 def ensure_dir(directory):
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
17 """ensure a directory exists"""
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
18 if os.path.exists(directory):
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
19 if not os.path.isdir(directory):
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
20 raise OSError("Not a directory: '{}'".format(directory))
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
21 return directory
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
22 os.makedirs(directory)
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
23 return directory
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
24
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
25
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
26 class SQLExParser(argparse.ArgumentParser):
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
27 """CLI option parser"""
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
28
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
29 def __init__(self, **kwargs):
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
30 kwargs.setdefault('formatter_class', argparse.RawTextHelpFormatter)
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
31 kwargs.setdefault('description', __doc__)
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
32 argparse.ArgumentParser.__init__(self, **kwargs)
1
1cfdb859f9d2 skeleton
Jeff Hammel <k0scist@gmail.com>
parents: 0
diff changeset
33 self.add_argument('db',
1cfdb859f9d2 skeleton
Jeff Hammel <k0scist@gmail.com>
parents: 0
diff changeset
34 help="sqlite `.db` file")
4
b440206930ac stub table optional positional argument
Jeff Hammel <k0scist@gmail.com>
parents: 3
diff changeset
35 self.add_argument('table', nargs='?',
b440206930ac stub table optional positional argument
Jeff Hammel <k0scist@gmail.com>
parents: 3
diff changeset
36 help="table to operate on")
3
5f1e1ac96aa7 stub works with SELECT
Jeff Hammel <k0scist@gmail.com>
parents: 2
diff changeset
37 self.add_argument('--tables', '--list-tables', dest='list_tables',
5f1e1ac96aa7 stub works with SELECT
Jeff Hammel <k0scist@gmail.com>
parents: 2
diff changeset
38 action='store_true', default=False,
5f1e1ac96aa7 stub works with SELECT
Jeff Hammel <k0scist@gmail.com>
parents: 2
diff changeset
39 help="list tables and exit")
5
3a7f515571dc can list column names
Jeff Hammel <k0scist@gmail.com>
parents: 4
diff changeset
40 self.add_argument('--columns', '--list-columns', dest='list_columns',
3a7f515571dc can list column names
Jeff Hammel <k0scist@gmail.com>
parents: 4
diff changeset
41 action='store_true', default=False,
3a7f515571dc can list column names
Jeff Hammel <k0scist@gmail.com>
parents: 4
diff changeset
42 help="list columns in `table` and exit")
0
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
43 self.options = None
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
44
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
45 def parse_args(self, *args, **kw):
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
46 options = argparse.ArgumentParser.parse_args(self, *args, **kw)
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
47 self.validate(options)
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
48 self.options = options
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
49 return options
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
50
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
51 def validate(self, options):
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
52 """validate options"""
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
53
1
1cfdb859f9d2 skeleton
Jeff Hammel <k0scist@gmail.com>
parents: 0
diff changeset
54 try:
3
5f1e1ac96aa7 stub works with SELECT
Jeff Hammel <k0scist@gmail.com>
parents: 2
diff changeset
55 open(options.db).close()
1
1cfdb859f9d2 skeleton
Jeff Hammel <k0scist@gmail.com>
parents: 0
diff changeset
56 except Exception as e:
1cfdb859f9d2 skeleton
Jeff Hammel <k0scist@gmail.com>
parents: 0
diff changeset
57 self.error("Could not open '{}': {}".format(options.db, e))
1cfdb859f9d2 skeleton
Jeff Hammel <k0scist@gmail.com>
parents: 0
diff changeset
58
5
3a7f515571dc can list column names
Jeff Hammel <k0scist@gmail.com>
parents: 4
diff changeset
59 if options.list_columns and not options.table:
3a7f515571dc can list column names
Jeff Hammel <k0scist@gmail.com>
parents: 4
diff changeset
60 self.error("`--list-columns` requires `table`")
2
63a75d318b06 stub a model
Jeff Hammel <k0scist@gmail.com>
parents: 1
diff changeset
61
0
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
62 def main(args=sys.argv[1:]):
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
63 """CLI"""
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
64
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
65 # parse command line options
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
66 parser = SQLExParser()
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
67 options = parser.parse_args(args)
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
68
3
5f1e1ac96aa7 stub works with SELECT
Jeff Hammel <k0scist@gmail.com>
parents: 2
diff changeset
69 # connect to database
5f1e1ac96aa7 stub works with SELECT
Jeff Hammel <k0scist@gmail.com>
parents: 2
diff changeset
70 db = SQLEx(options.db)
5f1e1ac96aa7 stub works with SELECT
Jeff Hammel <k0scist@gmail.com>
parents: 2
diff changeset
71
5f1e1ac96aa7 stub works with SELECT
Jeff Hammel <k0scist@gmail.com>
parents: 2
diff changeset
72 if options.list_tables:
4
b440206930ac stub table optional positional argument
Jeff Hammel <k0scist@gmail.com>
parents: 3
diff changeset
73 # list tables and return
b440206930ac stub table optional positional argument
Jeff Hammel <k0scist@gmail.com>
parents: 3
diff changeset
74 # if `table` argument is provided, exit 1
b440206930ac stub table optional positional argument
Jeff Hammel <k0scist@gmail.com>
parents: 3
diff changeset
75 # if not available. Otherwise exit 0
3
5f1e1ac96aa7 stub works with SELECT
Jeff Hammel <k0scist@gmail.com>
parents: 2
diff changeset
76 tables = db.tables()
5f1e1ac96aa7 stub works with SELECT
Jeff Hammel <k0scist@gmail.com>
parents: 2
diff changeset
77 print ('\n'.join(tables))
4
b440206930ac stub table optional positional argument
Jeff Hammel <k0scist@gmail.com>
parents: 3
diff changeset
78 retval = 0
b440206930ac stub table optional positional argument
Jeff Hammel <k0scist@gmail.com>
parents: 3
diff changeset
79 if options.table:
b440206930ac stub table optional positional argument
Jeff Hammel <k0scist@gmail.com>
parents: 3
diff changeset
80 retval = int(options.table not in tables)
b440206930ac stub table optional positional argument
Jeff Hammel <k0scist@gmail.com>
parents: 3
diff changeset
81 return retval
3
5f1e1ac96aa7 stub works with SELECT
Jeff Hammel <k0scist@gmail.com>
parents: 2
diff changeset
82
5
3a7f515571dc can list column names
Jeff Hammel <k0scist@gmail.com>
parents: 4
diff changeset
83 if options.table:
3a7f515571dc can list column names
Jeff Hammel <k0scist@gmail.com>
parents: 4
diff changeset
84 # ensure selected table exists
3a7f515571dc can list column names
Jeff Hammel <k0scist@gmail.com>
parents: 4
diff changeset
85 if options.table not in db.tables():
3a7f515571dc can list column names
Jeff Hammel <k0scist@gmail.com>
parents: 4
diff changeset
86 parser.error("No table '{}' in {} tables:\n{}".format(options.table, options.db, ', '.join(db.tables())))
3a7f515571dc can list column names
Jeff Hammel <k0scist@gmail.com>
parents: 4
diff changeset
87
3a7f515571dc can list column names
Jeff Hammel <k0scist@gmail.com>
parents: 4
diff changeset
88 if options.list_columns:
3a7f515571dc can list column names
Jeff Hammel <k0scist@gmail.com>
parents: 4
diff changeset
89 # list columns and return
3a7f515571dc can list column names
Jeff Hammel <k0scist@gmail.com>
parents: 4
diff changeset
90 print ('\n'.join(db.columns(options.table).keys()))
3a7f515571dc can list column names
Jeff Hammel <k0scist@gmail.com>
parents: 4
diff changeset
91 return
3a7f515571dc can list column names
Jeff Hammel <k0scist@gmail.com>
parents: 4
diff changeset
92
0
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
93 if __name__ == '__main__':
a05c70cc24be initial commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
94 main()