annotate frontends/src/jp/output_std.py @ 1950:227a4e617549

jp: --output option: - new --output option can be added wich use_output. use_output can be True (in which case it wild default to C.OUTPUT_TEXT), or any of C.OUTPUT_TYPES (currently text, list and dict) - output change the output format mainly to make command result parsing more easy, but it can also be use to add fancy effects (like coloration) - outputs are added with plugins in the same way as commands (import of both is done in the same method) - in the command class, output need to be declared with use_output=C.OUTPUT_xxx, then the data only need to be processed with self.output(data) - outputs can have description (not used yet) - use_xxx argument handling has been refactored (minor refactoring) to be more generic - first outputs are "default", "json" (pretty printed) and "json_raw" (compact json) - the first command to use them is "profile list"
author Goffi <goffi@goffi.org>
date Sat, 23 Apr 2016 23:10:03 +0200
parents
children 8f96c242fa89
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
1 #! /usr/bin/python
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
2 # -*- coding: utf-8 -*-
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
3
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
4 # jp: a SàT command line tool
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
5 # Copyright (C) 2009-2016 Jérôme Poisson (goffi@goffi.org)
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
6
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
7 # This program is free software: you can redistribute it and/or modify
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
8 # it under the terms of the GNU Affero General Public License as published by
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
9 # the Free Software Foundation, either version 3 of the License, or
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
10 # (at your option) any later version.
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
11
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
12 # This program is distributed in the hope that it will be useful,
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
15 # GNU Affero General Public License for more details.
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
16
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
17 # You should have received a copy of the GNU Affero General Public License
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
19 """Standard outputs"""
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
20
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
21
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
22 from sat_frontends.jp.constants import Const as C
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
23 import json
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
24
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
25 __outputs__ = ["Default", "Json"]
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
26 DEFAULT = u'default'
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
27 JSON = u'json'
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
28 JSON_RAW = u'json_raw'
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
29
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
30
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
31 class Default(object):
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
32 """Default outputs"""
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
33
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
34 def __init__(self, jp):
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
35 jp.register_output(C.OUTPUT_TEXT, DEFAULT, self.text)
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
36 jp.register_output(C.OUTPUT_LIST, DEFAULT, self.list)
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
37
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
38 def text(self, data):
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
39 print data
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
40
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
41 def list(self, data):
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
42 print u'\n'.join(data)
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
43
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
44
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
45 class Json(object):
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
46 """outputs in json format"""
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
47
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
48 def __init__(self, jp):
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
49 jp.register_output(C.OUTPUT_LIST, JSON, self.dump_pretty)
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
50 jp.register_output(C.OUTPUT_LIST, JSON_RAW, self.dump)
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
51 jp.register_output(C.OUTPUT_DICT, JSON, self.dump_pretty)
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
52 jp.register_output(C.OUTPUT_DICT, JSON_RAW, self.dump)
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
53
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
54 def dump(self, data):
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
55 print json.dumps(data)
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
56
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
57 def dump_pretty(self, data):
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents:
diff changeset
58 print json.dumps(data, indent=4)