/
console.py
122 lines (90 loc) · 3.72 KB
/
console.py
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
#!/usr/bin/env python
# -*- encoding: utf-8; py-indent-offset: 4 -*-
# +------------------------------------------------------------------+
# | ____ _ _ __ __ _ __ |
# | / ___| |__ ___ ___| | __ | \/ | |/ / |
# | | | | '_ \ / _ \/ __| |/ / | |\/| | ' / |
# | | |___| | | | __/ (__| < | | | | . \ |
# | \____|_| |_|\___|\___|_|\_\___|_| |_|_|\_\ |
# | |
# | Copyright Mathias Kettner 2014 mk@mathias-kettner.de |
# +------------------------------------------------------------------+
#
# This file is part of Check_MK.
# The official homepage is at http://mathias-kettner.de/check_mk.
#
# check_mk 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 in version 2. check_mk is distributed
# in the hope that it will be useful, but WITHOUT ANY WARRANTY; with-
# out even the implied warranty of MERCHANTABILITY or FITNESS FOR A
# PARTICULAR PURPOSE. See the GNU General Public License for more de-
# tails. You should have received a copy of the GNU General Public
# License along with GNU Make; see the file COPYING. If not, write
# to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
# Boston, MA 02110-1301 USA.
"""Utiliy module for holding generic methods that implement handling
of console input / output"""
import logging
import sys
from typing import AnyStr, Text, IO # pylint: disable=unused-import
import six
from cmk.utils.log import VERBOSE
import cmk.utils.tty as tty
from cmk.utils.encoding import (
ensure_bytestr,
ensure_unicode,
)
# NOTE: This is a hack! We abuse the global logger just to pass around the
# verbosity setting.
logger = logging.getLogger("cmk.base")
#
# Generic / low level functions
#
# would rather use "def output(text, *args, stream=sys.stdout)", but this is not possible
# with python 2.7
def output(text, *args, **kwargs):
# type: (AnyStr, *AnyStr, **IO[Text]) -> None
if args:
text = text % args
if six.PY3:
ensured_text = ensure_unicode(text) # type: unicode
else:
ensured_text = ensure_bytestr(text) # type: bytes
stream = kwargs.get("stream", sys.stdout)
try:
stream.write(ensured_text)
stream.flush()
except Exception:
# TODO: Way to generic!
pass # avoid exception on broken pipe (e.g. due to | head)
# Output text if opt_verbose is set (-v). Adds no linefeed
def verbose(text, *args, **kwargs):
if logger.isEnabledFor(VERBOSE):
output(text, *args, **kwargs)
# Output text if, opt_verbose >= 2 (-vv).
def vverbose(text, *args, **kwargs):
if logger.isEnabledFor(logging.DEBUG):
verbose(text, *args, **kwargs)
#
# More top level wrappers
#
# TODO: Inconsistent -> Adds newline and other functions don't
def warning(text, *args, **kwargs):
kwargs.setdefault("stream", sys.stderr)
stripped = text.lstrip()
indent = text[:len(text) - len(stripped)]
text = "%s%s%sWARNING:%s %s\n" % (indent, tty.bold, tty.yellow, tty.normal, stripped)
output(text, *args, **kwargs)
def error(text, *args):
output(text, *args, stream=sys.stderr)
def section_begin(text, *args, **kwargs):
verbose(tty.bold + text + tty.normal + ":\n")
def section_success(text):
verbose("%sSUCCESS%s - %s\n" % (tty.green, tty.normal, text))
def section_error(text):
verbose("%sERROR%s - %s\n" % (tty.red, tty.normal, text))
def step(text):
verbose("%s+%s %s\n" % (tty.yellow, tty.normal, text.upper()))
def step_error(text):
verbose(text + "\n")