Mercurial > libervia-backend

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/frontends/src/jp/output_std.py	Sat Apr 23 23:10:03 2016 +0200
@@ -0,0 +1,58 @@
+#! /usr/bin/python
+# -*- coding: utf-8 -*-
+
+# jp: a SàT command line tool
+# Copyright (C) 2009-2016 Jérôme Poisson (goffi@goffi.org)
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""Standard outputs"""
+
+
+from sat_frontends.jp.constants import Const as C
+import json
+
+__outputs__ = ["Default", "Json"]
+DEFAULT = u'default'
+JSON = u'json'
+JSON_RAW = u'json_raw'
+
+
+class Default(object):
+    """Default outputs"""
+
+    def __init__(self, jp):
+        jp.register_output(C.OUTPUT_TEXT, DEFAULT, self.text)
+        jp.register_output(C.OUTPUT_LIST, DEFAULT, self.list)
+
+    def text(self, data):
+        print data
+
+    def list(self, data):
+        print u'\n'.join(data)
+
+
+class Json(object):
+    """outputs in json format"""
+
+    def __init__(self, jp):
+        jp.register_output(C.OUTPUT_LIST, JSON, self.dump_pretty)
+        jp.register_output(C.OUTPUT_LIST, JSON_RAW, self.dump)
+        jp.register_output(C.OUTPUT_DICT, JSON, self.dump_pretty)
+        jp.register_output(C.OUTPUT_DICT, JSON_RAW, self.dump)
+
+    def dump(self, data):
+        print json.dumps(data)
+
+    def dump_pretty(self, data):
+        print json.dumps(data, indent=4)