[go: up one dir, main page]

File: output.py

package info (click to toggle)
kiwi 9.24.56-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 6,844 kB
  • sloc: python: 58,147; sh: 3,261; xml: 2,919; makefile: 304; ansic: 132
file content (96 lines) | stat: -rw-r--r-- 2,869 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
# Copyright (c) 2015 SUSE Linux GmbH.  All rights reserved.
#
# This file is part of kiwi.
#
# kiwi is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# kiwi 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with kiwi.  If not, see <http://www.gnu.org/licenses/>
#
import json
import os
import logging

# project
from kiwi.utils.temporary import Temporary
from kiwi.path import Path

log = logging.getLogger('kiwi')


class DataOutput:
    """
    **Converts dict or list variables to a print friendly json format**

    Output controller for data dictionary. The class expects a
    python dict or list to hold the data to become displayed. So
    far the output format is set to json

    :param data: python dict or list which holds the data
    :type data: dict, list
    :param str style: output style could be either standard or color
    """
    def __init__(self, data, style='standard'):
        self.data = data
        self.style = style
        self.color_json = Path.which('pjson')

    def display(self):
        """
        Show data in json output format and selected style
        """
        self._json()

    @staticmethod
    def display_file(filename, message=None):
        """
        Show data from file
        """
        if message:
            log.info(message)
        with open(filename) as data:
            print(data.read())

    def _json(self):
        """
        Show data in json output format and selected style
        """
        if self.style == 'color':
            if self.color_json:
                self._color_json()
            else:
                log.warning('pjson for color output not installed')
                log.warning('run: pip install pjson')
                self._standard_json()
        else:
            self._standard_json()

    def _standard_json(self):
        """
        Show data in plain json output format without any highlighting
        """
        print(
            json.dumps(
                self.data, sort_keys=True, indent=4, separators=(',', ': ')
            )
        )

    def _color_json(self):
        """
        Show data in json output format with nice color highlighting
        """
        out_file = Temporary().new_file()
        out_file.write(json.dumps(self.data, sort_keys=True).encode())
        out_file.flush()
        pjson_cmd = ''.join(
            ['cat ', out_file.name, ' | pjson']
        )
        os.system(pjson_cmd)