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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
# Copyright 2021 The Pigweed Authors
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not
# use this file except in compliance with the License. You may obtain a copy of
# the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations under
# the License.
"""Pigweed Console entry point."""
import argparse
import inspect
import logging
from pathlib import Path
import sys
from typing import Optional, Dict
from pw_cli import log as pw_cli_log
from pw_cli import argument_types
from pw_console import PwConsoleEmbed
from pw_console.python_logging import create_temp_log_file
from pw_console.log_store import LogStore
from pw_console.plugins.calc_pane import CalcPane
from pw_console.plugins.clock_pane import ClockPane
from pw_console.plugins.twenty48_pane import Twenty48Pane
from pw_console.test_mode import FAKE_DEVICE_LOGGER_NAME
_LOG = logging.getLogger(__package__)
_ROOT_LOG = logging.getLogger('')
def _build_argument_parser() -> argparse.ArgumentParser:
"""Setup argparse."""
parser = argparse.ArgumentParser(
prog="python -m pw_console", description=__doc__
)
parser.add_argument(
'-l',
'--loglevel',
type=argument_types.log_level,
default=logging.DEBUG,
help='Set the log level' '(debug, info, warning, error, critical)',
)
parser.add_argument('--logfile', help='Pigweed Console log file.')
parser.add_argument(
'--test-mode',
action='store_true',
help='Enable fake log messages for testing purposes.',
)
parser.add_argument(
'--config-file',
type=Path,
help='Path to a pw_console yaml config file.',
)
parser.add_argument(
'--console-debug-log-file',
help='Log file to send console debug messages to.',
)
return parser
def main(args: Optional[argparse.Namespace] = None) -> int:
"""Pigweed Console."""
parser = _build_argument_parser()
if args is None:
args = parser.parse_args()
if not args.logfile:
# Create a temp logfile to prevent logs from appearing over stdout. This
# would corrupt the prompt toolkit UI.
args.logfile = create_temp_log_file()
pw_cli_log.install(
level=args.loglevel,
use_color=True,
hide_timestamp=False,
log_file=args.logfile,
)
if args.console_debug_log_file:
pw_cli_log.install(
level=logging.DEBUG,
use_color=True,
hide_timestamp=False,
log_file=args.console_debug_log_file,
logger=logging.getLogger('pw_console'),
)
global_vars = None
default_loggers = {}
if args.test_mode:
root_log_store = LogStore()
_ROOT_LOG.addHandler(root_log_store)
_ROOT_LOG.debug('pw_console test-mode starting...')
fake_logger = logging.getLogger(FAKE_DEVICE_LOGGER_NAME)
default_loggers = {
# Don't include pw_console package logs (_LOG) in the log pane UI.
# Add the fake logger for test_mode.
'Fake Device': [fake_logger],
'PwConsole Debug': [logging.getLogger('pw_console')],
'All Logs': root_log_store,
}
# Give access to adding log messages from the repl via: `LOG.warning()`
global_vars = dict(LOG=fake_logger)
help_text = None
app_title = None
if args.test_mode:
app_title = 'Console Test Mode'
help_text = inspect.cleandoc(
"""
Welcome to the Pigweed Console Test Mode!
Example commands:
rpcs.pw.rpc.EchoService.Echo(msg='hello!')
LOG.warning('Message appears console log window.')
"""
)
console = PwConsoleEmbed(
global_vars=global_vars,
loggers=default_loggers,
test_mode=args.test_mode,
help_text=help_text,
app_title=app_title,
config_file_path=args.config_file,
)
overriden_window_config: Optional[Dict] = None
# Add example plugins and log panes used to validate behavior in the Pigweed
# Console manual test procedure: https://pigweed.dev/pw_console/testing.html
if args.test_mode:
fake_logger.propagate = False
console.setup_python_logging(loggers_with_no_propagation=[fake_logger])
_ROOT_LOG.debug('pw_console.PwConsoleEmbed init complete')
_ROOT_LOG.debug('Adding plugins...')
console.add_window_plugin(ClockPane())
console.add_window_plugin(CalcPane())
console.add_floating_window_plugin(
Twenty48Pane(include_resize_handle=False), left=4
)
_ROOT_LOG.debug('Starting prompt_toolkit full-screen application...')
overriden_window_config = {
'Split 1 stacked': {
'Fake Device': None,
'Fake Keys': {
'duplicate_of': 'Fake Device',
'filters': {
'keys': {'regex': '[^ ]+'},
},
},
'Fake USB': {
'duplicate_of': 'Fake Device',
'filters': {
'module': {'regex': 'USB'},
},
},
},
'Split 2 tabbed': {
'Python Repl': None,
'All Logs': None,
'PwConsole Debug': None,
'Calculator': None,
'Clock': None,
},
}
console.embed(override_window_config=overriden_window_config)
if args.logfile:
print(f'Logs saved to: {args.logfile}')
return 0
if __name__ == '__main__':
sys.exit(main())
|
