annotate libervia/cli/base.py @ 4307:6a0155f410bd

test (unit): add test for plugin XEP-0033: those replace the legacy XEP-0033 test from libervia/backend/test/test_plugin_xep_0033.py. rel 450
author Goffi <goffi@goffi.org>
date Thu, 26 Sep 2024 16:12:01 +0200
parents 0d7bb4df2343
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3043
3df611adb598 jp: handle dbus bridge with asyncio:
Goffi <goffi@goffi.org>
parents: 3040
diff changeset
1 #!/usr/bin/env python3
0
goffi@necton2
parents:
diff changeset
2
4075
47401850dec6 refactoring: rename `libervia.frontends.jp` to `libervia.cli`
Goffi <goffi@goffi.org>
parents: 4074
diff changeset
3 # Libervia CLI
3479
be6d91572633 date update
Goffi <goffi@goffi.org>
parents: 3412
diff changeset
4 # Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org)
0
goffi@necton2
parents:
diff changeset
5
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 601
diff changeset
6 # This program is free software: you can redistribute it and/or modify
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 601
diff changeset
7 # it under the terms of the GNU Affero General Public License as published by
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 601
diff changeset
8 # the Free Software Foundation, either version 3 of the License, or
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 601
diff changeset
9 # (at your option) any later version.
0
goffi@necton2
parents:
diff changeset
10
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 601
diff changeset
11 # This program is distributed in the hope that it will be useful,
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 601
diff changeset
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 601
diff changeset
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 601
diff changeset
14 # GNU Affero General Public License for more details.
0
goffi@necton2
parents:
diff changeset
15
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 601
diff changeset
16 # You should have received a copy of the GNU Affero General Public License
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 601
diff changeset
17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
0
goffi@necton2
parents:
diff changeset
18
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
19 import asyncio
4071
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend`
Goffi <goffi@goffi.org>
parents: 4042
diff changeset
20 from libervia.backend.core.i18n import _
402
f03688bdb858 jp: use with statement to open fifo
Goffi <goffi@goffi.org>
parents: 401
diff changeset
21
0
goffi@necton2
parents:
diff changeset
22 ### logging ###
1605
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
23 import logging as log
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
24
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
25 log.basicConfig(level=log.WARNING, format="[%(name)s] %(message)s")
0
goffi@necton2
parents:
diff changeset
26 ###
goffi@necton2
parents:
diff changeset
27
goffi@necton2
parents:
diff changeset
28 import sys
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
29 import os
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
30 import os.path
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
31 import argparse
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
32 import inspect
3046
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
33 import tty
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
34 import termios
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
35 from pathlib import Path
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
36 from glob import iglob
3938
6939594ba77e cli (pubsub/get): add `--no-decrypt` flag to disable automatic decryption:
Goffi <goffi@goffi.org>
parents: 3893
diff changeset
37 from typing import Optional, Set, Union
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
38 from importlib import import_module
4074
26b7ed2817da refactoring: rename `sat_frontends` to `libervia.frontends`
Goffi <goffi@goffi.org>
parents: 4071
diff changeset
39 from libervia.frontends.tools.jid import JID
4071
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend`
Goffi <goffi@goffi.org>
parents: 4042
diff changeset
40 from libervia.backend.tools import config
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend`
Goffi <goffi@goffi.org>
parents: 4042
diff changeset
41 from libervia.backend.tools.common import dynamic_import
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend`
Goffi <goffi@goffi.org>
parents: 4042
diff changeset
42 from libervia.backend.tools.common import uri
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend`
Goffi <goffi@goffi.org>
parents: 4042
diff changeset
43 from libervia.backend.tools.common import date_utils
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend`
Goffi <goffi@goffi.org>
parents: 4042
diff changeset
44 from libervia.backend.tools.common import utils
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend`
Goffi <goffi@goffi.org>
parents: 4042
diff changeset
45 from libervia.backend.tools.common import data_format
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend`
Goffi <goffi@goffi.org>
parents: 4042
diff changeset
46 from libervia.backend.tools.common.ansi import ANSI as A
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend`
Goffi <goffi@goffi.org>
parents: 4042
diff changeset
47 from libervia.backend.core import exceptions
4075
47401850dec6 refactoring: rename `libervia.frontends.jp` to `libervia.cli`
Goffi <goffi@goffi.org>
parents: 4074
diff changeset
48 import libervia.cli
47401850dec6 refactoring: rename `libervia.frontends.jp` to `libervia.cli`
Goffi <goffi@goffi.org>
parents: 4074
diff changeset
49 from libervia.cli.loops import QuitException, get_libervia_cli_loop
47401850dec6 refactoring: rename `libervia.frontends.jp` to `libervia.cli`
Goffi <goffi@goffi.org>
parents: 4074
diff changeset
50 from libervia.cli.constants import Const as C
4074
26b7ed2817da refactoring: rename `sat_frontends` to `libervia.frontends`
Goffi <goffi@goffi.org>
parents: 4071
diff changeset
51 from libervia.frontends.bridge.bridge_frontend import BridgeException
4142
783bbdbf8567 cli (base): new `a_quit` method to run async cleaning methods:
Goffi <goffi@goffi.org>
parents: 4133
diff changeset
52 from libervia.frontends.tools import aio, misc
1840
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
53 import xml.etree.ElementTree as ET # FIXME: used temporarily to manage XMLUI
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
54 from collections import OrderedDict
4129
51744ad00a42 cli: `rich` initial integration
Goffi <goffi@goffi.org>
parents: 4075
diff changeset
55 from rich import console
1872
df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors:
Goffi <goffi@goffi.org>
parents: 1869
diff changeset
56
2098
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge:
Goffi <goffi@goffi.org>
parents: 2086
diff changeset
57 ## bridge handling
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
58 # we get bridge name from conf and initialise the right class accordingly
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
59 main_config = config.parse_main_conf()
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
60 bridge_name = config.config_get(main_config, "", "bridge", "dbus")
4075
47401850dec6 refactoring: rename `libervia.frontends.jp` to `libervia.cli`
Goffi <goffi@goffi.org>
parents: 4074
diff changeset
61 LiberviaCLILoop = get_libervia_cli_loop(bridge_name)
2098
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge:
Goffi <goffi@goffi.org>
parents: 2086
diff changeset
62
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge:
Goffi <goffi@goffi.org>
parents: 2086
diff changeset
63
0
goffi@necton2
parents:
diff changeset
64 try:
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
65 import progressbar
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
66 except ImportError:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
67 msg = _(
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
68 "ProgressBar not available, please download it at "
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
69 "http://pypi.python.org/pypi/progressbar\n"
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
70 "Progress bar deactivated\n--\n"
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
71 )
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
72 print(msg, file=sys.stderr)
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
73 progressbar = None
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
74
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
75 # consts
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
76 DESCRIPTION = (
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
77 """This software is a command line tool for XMPP.
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
78 Get the latest version at """
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
79 + C.APP_URL
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
80 )
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
81
4233
d01b8d002619 cli (call, file), frontends: implement webRTC data channel transfer:
Goffi <goffi@goffi.org>
parents: 4224
diff changeset
82 COPYLEFT = """Copyright (C) 2009-2024 Jérôme Poisson, Adrien Cossa
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
83 This program comes with ABSOLUTELY NO WARRANTY;
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
84 This is free software, and you are welcome to redistribute it under certain conditions.
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
85 """
0
goffi@necton2
parents:
diff changeset
86
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
87 PROGRESS_DELAY = 0.1 # the progression will be checked every PROGRESS_DELAY s
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
88
0
goffi@necton2
parents:
diff changeset
89
2704
ab37d1c7c38c jp (base): new date_decoder to specify dates in arguments
Goffi <goffi@goffi.org>
parents: 2692
diff changeset
90 def date_decoder(arg):
ab37d1c7c38c jp (base): new date_decoder to specify dates in arguments
Goffi <goffi@goffi.org>
parents: 2692
diff changeset
91 return date_utils.date_parse_ext(arg, default_tz=date_utils.TZ_LOCAL)
ab37d1c7c38c jp (base): new date_decoder to specify dates in arguments
Goffi <goffi@goffi.org>
parents: 2692
diff changeset
92
ab37d1c7c38c jp (base): new date_decoder to specify dates in arguments
Goffi <goffi@goffi.org>
parents: 2692
diff changeset
93
3481
7892585b7e17 core (setup), jp, primitivus: update console scripts + classifiers:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
94 class LiberviaCli:
814
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
95 """
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
96 This class can be use to establish a connection with the
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
97 bridge. Moreover, it should manage a main loop.
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
98
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
99 To use it, you mainly have to redefine the method run to perform
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
100 specify what kind of operation you want to perform.
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
101
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
102 """
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
103
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
104 def __init__(self):
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
105 """
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
106
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
107 @attribute quit_on_progress_end (bool): set to False if you manage yourself
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
108 exiting, or if you want the user to stop by himself
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
109 @attribute progress_success(callable): method to call when progress just started
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
110 by default display a message
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
111 @attribute progress_success(callable): method to call when progress is
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
112 successfully finished by default display a message
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
113 @attribute progress_failure(callable): method to call when progress failed
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
114 by default display a message
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
115 """
4129
51744ad00a42 cli: `rich` initial integration
Goffi <goffi@goffi.org>
parents: 4075
diff changeset
116 self.console = console.Console(theme=C.THEME_DEFAULT)
3046
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
117 self.sat_conf = main_config
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
118 self.set_color_theme()
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
119 bridge_module = dynamic_import.bridge(bridge_name, "libervia.frontends.bridge")
2098
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge:
Goffi <goffi@goffi.org>
parents: 2086
diff changeset
120 if bridge_module is None:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
121 log.error("Can't import {} bridge".format(bridge_name))
165
8a2053de6f8c Frontends: management of unlaunched SàT Backend (information message and exit)
Goffi <goffi@goffi.org>
parents: 156
diff changeset
122 sys.exit(1)
814
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
123
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
124 self.bridge = bridge_module.AIOBridge()
4133
33fd658d9d00 cli (base): catch `SystemExit` to do a proper `quit` when `Ctrl-C` is pressed.
Goffi <goffi@goffi.org>
parents: 4129
diff changeset
125 self._on_quit_callbacks = []
2098
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge:
Goffi <goffi@goffi.org>
parents: 2086
diff changeset
126
3555
53fec6309fa3 cli: update constants to use new name
Goffi <goffi@goffi.org>
parents: 3547
diff changeset
127 def get_config(self, name, section=C.CONFIG_SECTION, default=None):
3046
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
128 """Retrieve a setting value from sat.conf"""
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
129 return config.config_get(self.sat_conf, section, name, default=default)
3046
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
130
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
131 def guess_background(self):
3704
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
132 # cf. https://unix.stackexchange.com/a/245568 (thanks!)
3046
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
133 try:
3704
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
134 # for VTE based terminals
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
135 vte_version = int(os.getenv("VTE_VERSION", 0))
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
136 except ValueError:
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
137 vte_version = 0
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
138
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
139 color_fg_bg = os.getenv("COLORFGBG")
3046
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
140
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
141 if (
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
142 sys.stdin.isatty()
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
143 and sys.stdout.isatty()
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
144 and (
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
145 # XTerm
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
146 os.getenv("XTERM_VERSION")
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
147 # Konsole
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
148 or os.getenv("KONSOLE_VERSION")
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
149 # All VTE based terminals
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
150 or vte_version >= 3502
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
151 )
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
152 ):
3704
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
153 # ANSI escape sequence
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
154 stdin_fd = sys.stdin.fileno()
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
155 old_settings = termios.tcgetattr(stdin_fd)
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
156 try:
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
157 tty.setraw(sys.stdin.fileno())
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
158 # we request background color
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
159 sys.stdout.write("\033]11;?\a")
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
160 sys.stdout.flush()
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
161 expected = "\033]11;rgb:"
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
162 for c in expected:
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
163 ch = sys.stdin.read(1)
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
164 if ch != c:
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
165 # background id is not supported, we default to "dark"
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
166 # TODO: log something?
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
167 return "dark"
3704
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
168 red, green, blue = [
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
169 int(c, 16) / 65535 for c in sys.stdin.read(14).split("/")
3704
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
170 ]
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
171 # '\a' is the last character
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
172 sys.stdin.read(1)
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
173 finally:
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
174 termios.tcsetattr(stdin_fd, termios.TCSADRAIN, old_settings)
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
175
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
176 lum = utils.per_luminance(red, green, blue)
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
177 if lum <= 0.5:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
178 return "dark"
3704
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
179 else:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
180 return "light"
3704
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
181 elif color_fg_bg:
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
182 # no luck with ANSI escape sequence, we try COLORFGBG environment variable
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
183 try:
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
184 bg = int(color_fg_bg.split(";")[-1])
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
185 except ValueError:
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
186 return "dark"
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
187 if bg in list(range(7)) + [8]:
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
188 return "dark"
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
189 else:
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
190 return "light"
3046
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
191 else:
3704
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
192 # no autodetection method found
c143e7f35074 cli (base): better background detection:
Goffi <goffi@goffi.org>
parents: 3636
diff changeset
193 return "dark"
3046
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
194
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
195 def set_color_theme(self):
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
196 background = self.get_config("background", default="auto")
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
197 if background == "auto":
3046
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
198 background = self.guess_background()
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
199 if background not in ("dark", "light"):
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
200 raise exceptions.ConfigError(
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
201 _(
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
202 'Invalid value set for "background" ({background}), please check '
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
203 "your settings in libervia.conf"
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
204 ).format(background=repr(background))
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
205 )
3705
691dbd78981c cli (debug/theme): display currently used background
Goffi <goffi@goffi.org>
parents: 3704
diff changeset
206 self.background = background
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
207 if background == "light":
3046
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
208 C.A_HEADER = A.FG_MAGENTA
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
209 C.A_SUBHEADER = A.BOLD + A.FG_RED
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
210 C.A_LEVEL_COLORS = (C.A_HEADER, A.BOLD + A.FG_BLUE, A.FG_MAGENTA, A.FG_CYAN)
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
211 C.A_SUCCESS = A.FG_GREEN
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
212 C.A_FAILURE = A.BOLD + A.FG_RED
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
213 C.A_WARNING = A.FG_RED
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
214 C.A_PROMPT_PATH = A.FG_BLUE
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
215 C.A_PROMPT_SUF = A.BOLD
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
216 C.A_DIRECTORY = A.BOLD + A.FG_MAGENTA
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
217 C.A_FILE = A.FG_BLACK
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
218
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
219 def _bridge_connected(self):
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
220 self.parser = argparse.ArgumentParser(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
221 formatter_class=argparse.RawDescriptionHelpFormatter, description=DESCRIPTION
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
222 )
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
223 self._make_parents()
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
224 self.add_parser_options()
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
225 self.subparsers = self.parser.add_subparsers(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
226 title=_("Available commands"), dest="command", required=True
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
227 )
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
228
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
229 # progress attributes
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
230 self._progress_id = None # TODO: manage several progress ids
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
231 self.quit_on_progress_end = True
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
232
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
233 # outputs
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
234 self._outputs = {}
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
235 for type_ in C.OUTPUT_TYPES:
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
236 self._outputs[type_] = OrderedDict()
2189
a25a256688e2 jp (base): output can now specify a default when registering
Goffi <goffi@goffi.org>
parents: 2188
diff changeset
237 self.default_output = {}
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
238
2705
0bb811aaf11d jp (base): new own_jid host attribute:
Goffi <goffi@goffi.org>
parents: 2704
diff changeset
239 self.own_jid = None # must be filled at runtime if needed
0bb811aaf11d jp (base): new own_jid host attribute:
Goffi <goffi@goffi.org>
parents: 2704
diff changeset
240
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
241 @property
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
242 def progress_id(self):
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
243 return self._progress_id
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
244
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
245 async def set_progress_id(self, progress_id):
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
246 # because we use async, we need an explicit setter
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
247 self._progress_id = progress_id
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
248 await self.replay_cache("progress_ids_cache")
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
249
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
250 @property
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
251 def watch_progress(self):
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
252 try:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
253 self.pbar
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
254 except AttributeError:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
255 return False
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
256 else:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
257 return True
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
258
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
259 @watch_progress.setter
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
260 def watch_progress(self, watch_progress):
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
261 if watch_progress:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
262 self.pbar = None
1604
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
263
1605
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
264 @property
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
265 def verbosity(self):
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
266 try:
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
267 return self.args.verbose
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
268 except AttributeError:
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
269 return 0
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
270
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
271 async def replay_cache(self, cache_attribute):
1642
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
272 """Replay cached signals
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
273
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
274 @param cache_attribute(str): name of the attribute containing the cache
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
275 if the attribute doesn't exist, there is no cache and the call is ignored
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
276 else the cache must be a list of tuples containing the replay callback as
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
277 first item, then the arguments to use
1642
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
278 """
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
279 try:
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
280 cache = getattr(self, cache_attribute)
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
281 except AttributeError:
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
282 pass
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
283 else:
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
284 for cache_data in cache:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
285 await cache_data[0](*cache_data[1:])
1642
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
286
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
287 def disp(self, msg, verbosity=0, error=False, end="\n"):
1605
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
288 """Print a message to user
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
289
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
290 @param msg(unicode): message to print
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
291 @param verbosity(int): minimal verbosity to display the message
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
292 @param error(bool): if True, print to stderr instead of stdout
3407
2f0be2b7de68 jp: replace `no_lf` argument by `end` in `disp` (same as in `print`)
Goffi <goffi@goffi.org>
parents: 3378
diff changeset
293 @param end(str): string appended after the last value, default a newline
1605
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
294 """
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
295 if self.verbosity >= verbosity:
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
296 if error:
3407
2f0be2b7de68 jp: replace `no_lf` argument by `end` in `disp` (same as in `print`)
Goffi <goffi@goffi.org>
parents: 3378
diff changeset
297 print(msg, end=end, file=sys.stderr)
1605
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
298 else:
3407
2f0be2b7de68 jp: replace `no_lf` argument by `end` in `disp` (same as in `print`)
Goffi <goffi@goffi.org>
parents: 3378
diff changeset
299 print(msg, end=end)
1605
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
300
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
301 async def output(self, type_, name, extra_outputs, data):
2155
cee6561ad086 jp (core): added extra_outputs:
Goffi <goffi@goffi.org>
parents: 2151
diff changeset
302 if name in extra_outputs:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
303 method = extra_outputs[name]
2155
cee6561ad086 jp (core): added extra_outputs:
Goffi <goffi@goffi.org>
parents: 2151
diff changeset
304 else:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
305 method = self._outputs[type_][name]["callback"]
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
306
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
307 ret = method(data)
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
308 if inspect.isawaitable(ret):
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
309 await ret
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
310
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
311 def add_on_quit_callback(self, callback, *args, **kwargs):
1604
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
312 """Add a callback which will be called on quit command
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
313
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
314 @param callback(callback): method to call
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
315 """
4133
33fd658d9d00 cli (base): catch `SystemExit` to do a proper `quit` when `Ctrl-C` is pressed.
Goffi <goffi@goffi.org>
parents: 4129
diff changeset
316 self._on_quit_callbacks.append((callback, args, kwargs))
1604
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
317
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
318 def get_output_choices(self, output_type):
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
319 """Return valid output filters for output_type
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
320
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
321 @param output_type: True for default,
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
322 else can be any registered type
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
323 """
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
324 return list(self._outputs[output_type].keys())
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
325
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
326 def _make_parents(self):
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
327 self.parents = {}
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
328
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
329 # we have a special case here as the start-session option is present only if
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
330 # connection is not needed, so we create two similar parents, one with the
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
331 # option, the other one without it
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
332 for parent_name in ("profile", "profile_session"):
1594
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
333 parent = self.parents[parent_name] = argparse.ArgumentParser(add_help=False)
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
334 parent.add_argument(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
335 "-p",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
336 "--profile",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
337 action="store",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
338 type=str,
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
339 default="@DEFAULT@",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
340 help=_("Use PROFILE profile key (default: %(default)s)"),
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
341 )
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
342 parent.add_argument(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
343 "--pwd",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
344 action="store",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
345 metavar="PASSWORD",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
346 help=_("Password used to connect profile, if necessary"),
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
347 )
1594
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
348
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
349 profile_parent, profile_session_parent = (
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
350 self.parents["profile"],
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
351 self.parents["profile_session"],
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
352 )
1594
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
353
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
354 connect_short, connect_long, connect_action, connect_help = (
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
355 "-c",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
356 "--connect",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
357 "store_true",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
358 _("Connect the profile before doing anything else"),
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
359 )
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
360 profile_parent.add_argument(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
361 connect_short, connect_long, action=connect_action, help=connect_help
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
362 )
1594
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
363
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
364 profile_session_connect_group = (
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
365 profile_session_parent.add_mutually_exclusive_group()
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
366 )
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
367 profile_session_connect_group.add_argument(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
368 connect_short, connect_long, action=connect_action, help=connect_help
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
369 )
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
370 profile_session_connect_group.add_argument(
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
371 "--start-session",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
372 action="store_true",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
373 help=_("Start a profile session without connecting"),
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
374 )
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
375
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
376 progress_parent = self.parents["progress"] = argparse.ArgumentParser(
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
377 add_help=False
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
378 )
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
379 if progressbar:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
380 progress_parent.add_argument(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
381 "-P", "--progress", action="store_true", help=_("Show progress bar")
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
382 )
0
goffi@necton2
parents:
diff changeset
383
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
384 verbose_parent = self.parents["verbose"] = argparse.ArgumentParser(add_help=False)
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
385 verbose_parent.add_argument(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
386 "--verbose",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
387 "-v",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
388 action="count",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
389 default=0,
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
390 help=_("Add a verbosity level (can be used multiple times)"),
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
391 )
1600
8d41cd4da2f6 jp: added a --verbose command
Goffi <goffi@goffi.org>
parents: 1594
diff changeset
392
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
393 quiet_parent = self.parents["quiet"] = argparse.ArgumentParser(add_help=False)
3412
7b4ae3dbc041 jp (base, pubsub/set): new `--quiet` argument:
Goffi <goffi@goffi.org>
parents: 3409
diff changeset
394 quiet_parent.add_argument(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
395 "--quiet",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
396 "-q",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
397 action="store_true",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
398 help=_("be quiet (only output machine readable data)"),
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
399 )
3412
7b4ae3dbc041 jp (base, pubsub/set): new `--quiet` argument:
Goffi <goffi@goffi.org>
parents: 3409
diff changeset
400
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
401 draft_parent = self.parents["draft"] = argparse.ArgumentParser(add_help=False)
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
402 draft_group = draft_parent.add_argument_group(_("draft handling"))
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
403 draft_group.add_argument(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
404 "-D", "--current", action="store_true", help=_("load current draft")
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
405 )
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
406 draft_group.add_argument(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
407 "-F", "--draft-path", type=Path, help=_("path to a draft file to retrieve")
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
408 )
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
409
2547
2d69a0afe039 jp: new argument pubsub_default can be used in Commands to replace default value in help string
Goffi <goffi@goffi.org>
parents: 2539
diff changeset
410 def make_pubsub_group(self, flags, defaults):
3600
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
411 """Generate pubsub options according to flags
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
412
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
413 @param flags(iterable[unicode]): see [CommandBase.__init__]
2547
2d69a0afe039 jp: new argument pubsub_default can be used in Commands to replace default value in help string
Goffi <goffi@goffi.org>
parents: 2539
diff changeset
414 @param defaults(dict[unicode, unicode]): help text for default value
2d69a0afe039 jp: new argument pubsub_default can be used in Commands to replace default value in help string
Goffi <goffi@goffi.org>
parents: 2539
diff changeset
415 key can be "service" or "node"
2d69a0afe039 jp: new argument pubsub_default can be used in Commands to replace default value in help string
Goffi <goffi@goffi.org>
parents: 2539
diff changeset
416 value will be set in " (DEFAULT: {value})", or can be None to remove DEFAULT
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
417 @return (ArgumentParser): parser to add
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
418 """
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
419 flags = misc.FlagsHandler(flags)
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
420 parent = argparse.ArgumentParser(add_help=False)
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
421 pubsub_group = parent.add_argument_group("pubsub")
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
422 pubsub_group.add_argument(
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
423 "-u", "--pubsub-url", help=_("Pubsub URL (xmpp or http)")
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
424 )
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
425
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
426 service_help = _("JID of the PubSub service")
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
427 if not flags.service:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
428 default = defaults.pop("service", _("PEP service"))
2547
2d69a0afe039 jp: new argument pubsub_default can be used in Commands to replace default value in help string
Goffi <goffi@goffi.org>
parents: 2539
diff changeset
429 if default is not None:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
430 service_help += _(" (DEFAULT: {default})".format(default=default))
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
431 pubsub_group.add_argument("-s", "--service", default="", help=service_help)
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
432
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
433 node_help = _("node to request")
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
434 if not flags.node:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
435 default = defaults.pop("node", _("standard node"))
2547
2d69a0afe039 jp: new argument pubsub_default can be used in Commands to replace default value in help string
Goffi <goffi@goffi.org>
parents: 2539
diff changeset
436 if default is not None:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
437 node_help += _(" (DEFAULT: {default})".format(default=default))
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
438 pubsub_group.add_argument("-n", "--node", default="", help=node_help)
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
439
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
440 if flags.single_item:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
441 item_help = "item to retrieve"
2552
38e1e29c48e9 jp (base): added C.ITEM pubsub flag when --item is required
Goffi <goffi@goffi.org>
parents: 2550
diff changeset
442 if not flags.item:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
443 default = defaults.pop("item", _("last item"))
2552
38e1e29c48e9 jp (base): added C.ITEM pubsub flag when --item is required
Goffi <goffi@goffi.org>
parents: 2550
diff changeset
444 if default is not None:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
445 item_help += _(" (DEFAULT: {default})".format(default=default))
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
446 pubsub_group.add_argument("-i", "--item", default="", help=item_help)
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
447 pubsub_group.add_argument(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
448 "-L", "--last-item", action="store_true", help=_("retrieve last item")
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
449 )
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
450 elif flags.multi_items:
2764
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
451 # mutiple items, this activate several features: max-items, RSM, MAM
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
452 # and Orbder-by
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
453 pubsub_group.add_argument(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
454 "-i",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
455 "--item",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
456 action="append",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
457 dest="items",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
458 default=[],
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
459 help=_("items to retrieve (DEFAULT: all)"),
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
460 )
2539
dcc77f23e370 jp (base): add --max option:
Goffi <goffi@goffi.org>
parents: 2538
diff changeset
461 if not flags.no_max:
2775
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
462 max_group = pubsub_group.add_mutually_exclusive_group()
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
463 # XXX: defaut value for --max-items or --max is set in parse_pubsub_args
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
464 max_group.add_argument(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
465 "-M",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
466 "--max-items",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
467 dest="max",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
468 type=int,
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
469 help=_(
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
470 "maximum number of items to get ({no_limit} to get all items)".format(
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
471 no_limit=C.NO_LIMIT
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
472 )
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
473 ),
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
474 )
2775
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
475 # FIXME: it could be possible to no duplicate max (between pubsub
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
476 # max-items and RSM max)should not be duplicated, RSM could be
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
477 # used when available and pubsub max otherwise
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
478 max_group.add_argument(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
479 "-m",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
480 "--max",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
481 dest="rsm_max",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
482 type=int,
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
483 help=_("maximum number of items to get per page (DEFAULT: 10)"),
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
484 )
2764
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
485
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
486 # RSM
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
487
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
488 rsm_page_group = pubsub_group.add_mutually_exclusive_group()
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
489 rsm_page_group.add_argument(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
490 "-a",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
491 "--after",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
492 dest="rsm_after",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
493 help=_("find page after this item"),
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
494 metavar="ITEM_ID",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
495 )
2764
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
496 rsm_page_group.add_argument(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
497 "-b",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
498 "--before",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
499 dest="rsm_before",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
500 help=_("find page before this item"),
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
501 metavar="ITEM_ID",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
502 )
2764
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
503 rsm_page_group.add_argument(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
504 "--index",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
505 dest="rsm_index",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
506 type=int,
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
507 help=_("index of the first item to retrieve"),
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
508 )
2764
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
509
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
510 # MAM
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
511
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
512 pubsub_group.add_argument(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
513 "-f",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
514 "--filter",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
515 dest="mam_filters",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
516 nargs=2,
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
517 action="append",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
518 default=[],
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
519 help=_("MAM filters to use"),
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
520 metavar=("FILTER_NAME", "VALUE"),
2764
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
521 )
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
522
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
523 # Order-By
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
524
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
525 # TODO: order-by should be a list to handle several levels of ordering
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
526 # but this is not yet done in SàT (and not really useful with
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
527 # current specifications, as only "creation" and "modification" are
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
528 # available)
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
529 pubsub_group.add_argument(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
530 "-o",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
531 "--order-by",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
532 choices=[C.ORDER_BY_CREATION, C.ORDER_BY_MODIFICATION],
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
533 help=_("how items should be ordered"),
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
534 )
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
535
3600
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
536 if flags[C.CACHE]:
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
537 pubsub_group.add_argument(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
538 "-C",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
539 "--no-cache",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
540 dest="use_cache",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
541 action="store_false",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
542 help=_("don't use Pubsub cache"),
3600
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
543 )
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
544
2615
b4ecbcc2fd08 tools (misc): do not remove flags while using them anymore, instead added "all_used" and "unused" properties in FlagsHandler
Goffi <goffi@goffi.org>
parents: 2614
diff changeset
545 if not flags.all_used:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
546 raise exceptions.InternalError(
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
547 "unknown flags: {flags}".format(flags=", ".join(flags.unused))
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
548 )
2547
2d69a0afe039 jp: new argument pubsub_default can be used in Commands to replace default value in help string
Goffi <goffi@goffi.org>
parents: 2539
diff changeset
549 if defaults:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
550 raise exceptions.InternalError(f"unused defaults: {defaults}")
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
551
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
552 return parent
2235
4db836386641 jp: added use_pubsub and use_pubsub_node_req arguments to CommandBase
Goffi <goffi@goffi.org>
parents: 2213
diff changeset
553
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
554 def add_parser_options(self):
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
555 self.parser.add_argument(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
556 "--version",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
557 action="version",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
558 version=(
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
559 "{name} {version} {copyleft}".format(
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
560 name=C.APP_NAME, version=self.version, copyleft=COPYLEFT
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
561 )
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
562 ),
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
563 )
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
564
2189
a25a256688e2 jp (base): output can now specify a default when registering
Goffi <goffi@goffi.org>
parents: 2188
diff changeset
565 def register_output(self, type_, name, callback, description="", default=False):
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
566 if type_ not in C.OUTPUT_TYPES:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
567 log.error("Invalid output type {}".format(type_))
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
568 return
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
569 self._outputs[type_][name] = {"callback": callback, "description": description}
2189
a25a256688e2 jp (base): output can now specify a default when registering
Goffi <goffi@goffi.org>
parents: 2188
diff changeset
570 if default:
a25a256688e2 jp (base): output can now specify a default when registering
Goffi <goffi@goffi.org>
parents: 2188
diff changeset
571 if type_ in self.default_output:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
572 self.disp(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
573 _(
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
574 "there is already a default output for {type}, ignoring new one"
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
575 ).format(type=type_)
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
576 )
2189
a25a256688e2 jp (base): output can now specify a default when registering
Goffi <goffi@goffi.org>
parents: 2188
diff changeset
577 else:
a25a256688e2 jp (base): output can now specify a default when registering
Goffi <goffi@goffi.org>
parents: 2188
diff changeset
578 self.default_output[type_] = name
a25a256688e2 jp (base): output can now specify a default when registering
Goffi <goffi@goffi.org>
parents: 2188
diff changeset
579
2187
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods
Goffi <goffi@goffi.org>
parents: 2178
diff changeset
580 def parse_output_options(self):
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods
Goffi <goffi@goffi.org>
parents: 2178
diff changeset
581 options = self.command.args.output_opts
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods
Goffi <goffi@goffi.org>
parents: 2178
diff changeset
582 options_dict = {}
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods
Goffi <goffi@goffi.org>
parents: 2178
diff changeset
583 for option in options:
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods
Goffi <goffi@goffi.org>
parents: 2178
diff changeset
584 try:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
585 key, value = option.split("=", 1)
2187
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods
Goffi <goffi@goffi.org>
parents: 2178
diff changeset
586 except ValueError:
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods
Goffi <goffi@goffi.org>
parents: 2178
diff changeset
587 key, value = option, None
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods
Goffi <goffi@goffi.org>
parents: 2178
diff changeset
588 options_dict[key.strip()] = value.strip() if value is not None else None
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods
Goffi <goffi@goffi.org>
parents: 2178
diff changeset
589 return options_dict
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods
Goffi <goffi@goffi.org>
parents: 2178
diff changeset
590
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods
Goffi <goffi@goffi.org>
parents: 2178
diff changeset
591 def check_output_options(self, accepted_set, options):
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods
Goffi <goffi@goffi.org>
parents: 2178
diff changeset
592 if not accepted_set.issuperset(options):
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
593 self.disp(
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
594 _("The following output options are invalid: {invalid_options}").format(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
595 invalid_options=", ".join(set(options).difference(accepted_set))
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
596 ),
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
597 error=True,
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
598 )
2187
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods
Goffi <goffi@goffi.org>
parents: 2178
diff changeset
599 self.quit(C.EXIT_BAD_ARG)
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods
Goffi <goffi@goffi.org>
parents: 2178
diff changeset
600
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
601 def import_plugins(self):
4075
47401850dec6 refactoring: rename `libervia.frontends.jp` to `libervia.cli`
Goffi <goffi@goffi.org>
parents: 4074
diff changeset
602 """Automaticaly import commands and outputs in CLI frontend
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
603
4075
47401850dec6 refactoring: rename `libervia.frontends.jp` to `libervia.cli`
Goffi <goffi@goffi.org>
parents: 4074
diff changeset
604 looks from modules names cmd_*.py in CLI frontend path and import them
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
605 """
4075
47401850dec6 refactoring: rename `libervia.frontends.jp` to `libervia.cli`
Goffi <goffi@goffi.org>
parents: 4074
diff changeset
606 path = os.path.dirname(libervia.cli.__file__)
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
607 # XXX: outputs must be imported before commands as they are used for arguments
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
608 for type_, pattern in (
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
609 (C.PLUGIN_OUTPUT, "output_*.py"),
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
610 (C.PLUGIN_CMD, "cmd_*.py"),
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
611 ):
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
612 modules = (
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
613 os.path.splitext(module)[0]
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
614 for module in map(os.path.basename, iglob(os.path.join(path, pattern)))
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
615 )
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
616 for module_name in modules:
4075
47401850dec6 refactoring: rename `libervia.frontends.jp` to `libervia.cli`
Goffi <goffi@goffi.org>
parents: 4074
diff changeset
617 module_path = "libervia.cli." + module_name
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
618 try:
2162
c9a67eb5bf72 jp (base): improved module import:
Goffi <goffi@goffi.org>
parents: 2161
diff changeset
619 module = import_module(module_path)
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
620 self.import_plugin_module(module, type_)
2162
c9a67eb5bf72 jp (base): improved module import:
Goffi <goffi@goffi.org>
parents: 2161
diff changeset
621 except exceptions.CancelError:
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
622 continue
2162
c9a67eb5bf72 jp (base): improved module import:
Goffi <goffi@goffi.org>
parents: 2161
diff changeset
623 except exceptions.MissingModule as e:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
624 self.disp(
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
625 _(
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
626 "Missing module for plugin {name}: {missing}".format(
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
627 name=module_path, missing=e
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
628 )
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
629 ),
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
630 error=True,
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
631 )
4253
5115976e1e3d cli (base): catch all failure on plugin importing.
Goffi <goffi@goffi.org>
parents: 4233
diff changeset
632 except Exception as e:
5115976e1e3d cli (base): catch all failure on plugin importing.
Goffi <goffi@goffi.org>
parents: 4233
diff changeset
633 self.disp(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
634 _("Can't import {module_path} plugin, ignoring it: {e}").format(
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
635 module_path=module_path, e=e
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
636 ),
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
637 error=True,
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
638 )
0
goffi@necton2
parents:
diff changeset
639
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
640 def import_plugin_module(self, module, type_):
4075
47401850dec6 refactoring: rename `libervia.frontends.jp` to `libervia.cli`
Goffi <goffi@goffi.org>
parents: 4074
diff changeset
641 """add commands or outpus from a module to CLI frontend
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
642
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
643 @param module: module containing commands or outputs
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
644 @param type_(str): one of C_PLUGIN_*
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
645 """
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
646 try:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
647 class_names = getattr(module, "__{}__".format(type_))
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
648 except AttributeError:
3568
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
649 log.disp(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
650 _("Invalid plugin module [{type}] {module}").format(
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
651 type=type_, module=module
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
652 ),
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
653 error=True,
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
654 )
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
655 raise ImportError
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
656 else:
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
657 for class_name in class_names:
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
658 cls = getattr(module, class_name)
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
659 cls(self)
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
660
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
661 def get_xmpp_uri_from_http(self, http_url):
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
662 """parse HTML page at http(s) URL, and looks for xmpp: uri"""
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
663 if http_url.startswith("https"):
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
664 scheme = "https"
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
665 elif http_url.startswith("http"):
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
666 scheme = "http"
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
667 else:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
668 raise exceptions.InternalError("An HTTP scheme is expected in this method")
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
669 self.disp(f"{scheme.upper()} URL found, trying to find associated xmpp: URI", 1)
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
670 # HTTP URL, we try to find xmpp: links
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
671 try:
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
672 from lxml import etree
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
673 except ImportError:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
674 self.disp(
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
675 "lxml module must be installed to use http(s) scheme, please install it "
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
676 'with "pip install lxml"',
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
677 error=True,
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
678 )
2672
0bed6df9ee5d jp: fixed bad call to quit
Goffi <goffi@goffi.org>
parents: 2671
diff changeset
679 self.quit(1)
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
680 import urllib.request, urllib.error, urllib.parse
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
681
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
682 parser = etree.HTMLParser()
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
683 try:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
684 root = etree.parse(urllib.request.urlopen(http_url), parser)
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
685 except etree.XMLSyntaxError as e:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
686 self.disp(_("Can't parse HTML page : {msg}").format(msg=e))
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
687 links = []
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
688 else:
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
689 links = root.xpath("//link[@rel='alternate' and starts-with(@href, 'xmpp:')]")
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
690 if not links:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
691 self.disp(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
692 _(
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
693 'Could not find alternate "xmpp:" URI, can\'t find associated XMPP '
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
694 "PubSub node/item"
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
695 ),
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
696 error=True,
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
697 )
2672
0bed6df9ee5d jp: fixed bad call to quit
Goffi <goffi@goffi.org>
parents: 2671
diff changeset
698 self.quit(1)
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
699 xmpp_uri = links[0].get("href")
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
700 return xmpp_uri
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
701
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
702 def parse_pubsub_args(self):
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
703 if self.args.pubsub_url is not None:
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
704 url = self.args.pubsub_url
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
705
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
706 if url.startswith("http"):
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
707 # http(s) URL, we try to retrieve xmpp one from there
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
708 url = self.get_xmpp_uri_from_http(url)
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
709
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
710 try:
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
711 uri_data = uri.parse_xmpp_uri(url)
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
712 except ValueError:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
713 self.parser.error(_("invalid XMPP URL: {url}").format(url=url))
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
714 else:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
715 if uri_data["type"] == "pubsub":
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
716 # URL is alright, we only set data not already set by other options
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
717 if not self.args.service:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
718 self.args.service = uri_data["path"]
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
719 if not self.args.node:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
720 self.args.node = uri_data["node"]
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
721 uri_item = uri_data.get("item")
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
722 if uri_item:
2556
340128e0b354 jp (base): fixed URI's item with use_pubsub
Goffi <goffi@goffi.org>
parents: 2552
diff changeset
723 # there is an item in URI
340128e0b354 jp (base): fixed URI's item with use_pubsub
Goffi <goffi@goffi.org>
parents: 2552
diff changeset
724 # we use it only if item is not already set
340128e0b354 jp (base): fixed URI's item with use_pubsub
Goffi <goffi@goffi.org>
parents: 2552
diff changeset
725 # and item_last is not used either
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
726 try:
2556
340128e0b354 jp (base): fixed URI's item with use_pubsub
Goffi <goffi@goffi.org>
parents: 2552
diff changeset
727 item = self.args.item
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
728 except AttributeError:
2609
75d2ac872965 jp (base): do not crash when item is specified (e.g. in URL) but not needed in command, but display a message on stderr.
Goffi <goffi@goffi.org>
parents: 2588
diff changeset
729 try:
75d2ac872965 jp (base): do not crash when item is specified (e.g. in URL) but not needed in command, but display a message on stderr.
Goffi <goffi@goffi.org>
parents: 2588
diff changeset
730 items = self.args.items
75d2ac872965 jp (base): do not crash when item is specified (e.g. in URL) but not needed in command, but display a message on stderr.
Goffi <goffi@goffi.org>
parents: 2588
diff changeset
731 except AttributeError:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
732 self.disp(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
733 _(
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
734 "item specified in URL but not needed in command, "
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
735 "ignoring it"
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
736 ),
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
737 error=True,
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
738 )
2609
75d2ac872965 jp (base): do not crash when item is specified (e.g. in URL) but not needed in command, but display a message on stderr.
Goffi <goffi@goffi.org>
parents: 2588
diff changeset
739 else:
75d2ac872965 jp (base): do not crash when item is specified (e.g. in URL) but not needed in command, but display a message on stderr.
Goffi <goffi@goffi.org>
parents: 2588
diff changeset
740 if not items:
75d2ac872965 jp (base): do not crash when item is specified (e.g. in URL) but not needed in command, but display a message on stderr.
Goffi <goffi@goffi.org>
parents: 2588
diff changeset
741 self.args.items = [uri_item]
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
742 else:
2556
340128e0b354 jp (base): fixed URI's item with use_pubsub
Goffi <goffi@goffi.org>
parents: 2552
diff changeset
743 if not item:
340128e0b354 jp (base): fixed URI's item with use_pubsub
Goffi <goffi@goffi.org>
parents: 2552
diff changeset
744 try:
340128e0b354 jp (base): fixed URI's item with use_pubsub
Goffi <goffi@goffi.org>
parents: 2552
diff changeset
745 item_last = self.args.item_last
340128e0b354 jp (base): fixed URI's item with use_pubsub
Goffi <goffi@goffi.org>
parents: 2552
diff changeset
746 except AttributeError:
340128e0b354 jp (base): fixed URI's item with use_pubsub
Goffi <goffi@goffi.org>
parents: 2552
diff changeset
747 item_last = False
340128e0b354 jp (base): fixed URI's item with use_pubsub
Goffi <goffi@goffi.org>
parents: 2552
diff changeset
748 if not item_last:
340128e0b354 jp (base): fixed URI's item with use_pubsub
Goffi <goffi@goffi.org>
parents: 2552
diff changeset
749 self.args.item = uri_item
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
750 else:
3568
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
751 self.parser.error(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
752 _("XMPP URL is not a pubsub one: {url}").format(url=url)
3568
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
753 )
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
754 flags = self.args._cmd._pubsub_flags
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
755 # we check required arguments here instead of using add_arguments' required option
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
756 # because the required argument can be set in URL
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
757 if C.SERVICE in flags and not self.args.service:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
758 self.parser.error(_("argument -s/--service is required"))
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
759 if C.NODE in flags and not self.args.node:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
760 self.parser.error(_("argument -n/--node is required"))
2552
38e1e29c48e9 jp (base): added C.ITEM pubsub flag when --item is required
Goffi <goffi@goffi.org>
parents: 2550
diff changeset
761 if C.ITEM in flags and not self.args.item:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
762 self.parser.error(_("argument -i/--item is required"))
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
763
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
764 # FIXME: mutually groups can't be nested in a group and don't support title
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
765 # so we check conflict here. This may be fixed in Python 3, to be checked
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
766 try:
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
767 if self.args.item and self.args.item_last:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
768 self.parser.error(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
769 _("--item and --item-last can't be used at the same time")
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
770 )
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
771 except AttributeError:
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
772 pass
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
773
2775
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
774 try:
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
775 max_items = self.args.max
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
776 rsm_max = self.args.rsm_max
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
777 except AttributeError:
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
778 pass
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
779 else:
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
780 # we need to set a default value for max, but we need to know if we want
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
781 # to use pubsub's max or RSM's max. The later is used if any RSM or MAM
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
782 # argument is set
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
783 if max_items is None and rsm_max is None:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
784 to_check = (
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
785 "mam_filters",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
786 "rsm_max",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
787 "rsm_after",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
788 "rsm_before",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
789 "rsm_index",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
790 )
2775
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
791 if any((getattr(self.args, name) for name in to_check)):
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
792 # we use RSM
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
793 self.args.rsm_max = 10
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
794 else:
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
795 # we use pubsub without RSM
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
796 self.args.max = 10
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
797 if self.args.max is None:
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
798 self.args.max = C.NO_LIMIT
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
799
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
800 async def main(self, args, namespace):
1884
0fe69871b71f jp: moved KeyboardInterrupt catch one level higher, so it is also catched if the loop is not started
Goffi <goffi@goffi.org>
parents: 1872
diff changeset
801 try:
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
802 await self.bridge.bridge_connect()
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
803 except Exception as e:
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
804 if isinstance(e, exceptions.BridgeExceptionNoService):
3834
3260401fdb98 cli: helper method to retrieve profile's jid:
Goffi <goffi@goffi.org>
parents: 3765
diff changeset
805 print(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
806 _(
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
807 "Can't connect to Libervia backend, are you sure that it's "
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
808 "launched ?"
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
809 )
3834
3260401fdb98 cli: helper method to retrieve profile's jid:
Goffi <goffi@goffi.org>
parents: 3765
diff changeset
810 )
3490
509f7a1c67dc frontends: use new EXIT_BACKEND_NOT_FOUND exit code:
Goffi <goffi@goffi.org>
parents: 3486
diff changeset
811 self.quit(C.EXIT_BACKEND_NOT_FOUND, raise_exc=False)
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
812 elif isinstance(e, exceptions.BridgeInitError):
3568
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
813 print(_("Can't init bridge"))
3490
509f7a1c67dc frontends: use new EXIT_BACKEND_NOT_FOUND exit code:
Goffi <goffi@goffi.org>
parents: 3486
diff changeset
814 self.quit(C.EXIT_BRIDGE_ERROR, raise_exc=False)
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
815 else:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
816 print(_("Error while initialising bridge: {e}").format(e=e))
3490
509f7a1c67dc frontends: use new EXIT_BACKEND_NOT_FOUND exit code:
Goffi <goffi@goffi.org>
parents: 3486
diff changeset
817 self.quit(C.EXIT_BRIDGE_ERROR, raise_exc=False)
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
818 return
4193
730f542e4ad0 core: add new `init_script_path` option:
Goffi <goffi@goffi.org>
parents: 4142
diff changeset
819 # we wait on init_pre_script instead of ready_get, so the CLI frontend can be used
730f542e4ad0 core: add new `init_script_path` option:
Goffi <goffi@goffi.org>
parents: 4142
diff changeset
820 # in init script.
730f542e4ad0 core: add new `init_script_path` option:
Goffi <goffi@goffi.org>
parents: 4142
diff changeset
821 await self.bridge.init_pre_script()
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
822 self.version = await self.bridge.version_get()
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
823 self._bridge_connected()
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
824 self.import_plugins()
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
825 try:
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
826 self.args = self.parser.parse_args(args, namespace=None)
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
827 if self.args._cmd._use_pubsub:
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
828 self.parse_pubsub_args()
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
829 await self.args._cmd.run()
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
830 except SystemExit as e:
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
831 self.quit(e.code, raise_exc=False)
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
832 return
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
833 except QuitException:
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
834 return
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
835
3481
7892585b7e17 core (setup), jp, primitivus: update console scripts + classifiers:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
836 def _run(self, args=None, namespace=None):
4075
47401850dec6 refactoring: rename `libervia.frontends.jp` to `libervia.cli`
Goffi <goffi@goffi.org>
parents: 4074
diff changeset
837 self.loop = LiberviaCLILoop()
4133
33fd658d9d00 cli (base): catch `SystemExit` to do a proper `quit` when `Ctrl-C` is pressed.
Goffi <goffi@goffi.org>
parents: 4129
diff changeset
838 try:
33fd658d9d00 cli (base): catch `SystemExit` to do a proper `quit` when `Ctrl-C` is pressed.
Goffi <goffi@goffi.org>
parents: 4129
diff changeset
839 self.loop.run(self, args, namespace)
4224
8499b3ad5edb cli (base): fix exit code transmission when `SystemExit` is catched.
Goffi <goffi@goffi.org>
parents: 4193
diff changeset
840 except SystemExit as e:
4142
783bbdbf8567 cli (base): new `a_quit` method to run async cleaning methods:
Goffi <goffi@goffi.org>
parents: 4133
diff changeset
841 # The loop is stopped, but we execute it one more time to call `a_quit` which
783bbdbf8567 cli (base): new `a_quit` method to run async cleaning methods:
Goffi <goffi@goffi.org>
parents: 4133
diff changeset
842 # will call any cleaning method including async ones.
4224
8499b3ad5edb cli (base): fix exit code transmission when `SystemExit` is catched.
Goffi <goffi@goffi.org>
parents: 4193
diff changeset
843 asyncio.get_event_loop().run_until_complete(self.a_quit(e.code))
0
goffi@necton2
parents:
diff changeset
844
3481
7892585b7e17 core (setup), jp, primitivus: update console scripts + classifiers:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
845 @classmethod
7892585b7e17 core (setup), jp, primitivus: update console scripts + classifiers:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
846 def run(cls):
7892585b7e17 core (setup), jp, primitivus: update console scripts + classifiers:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
847 cls()._run()
7892585b7e17 core (setup), jp, primitivus: update console scripts + classifiers:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
848
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
849 def _read_stdin(self, stdin_fut):
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
850 """Callback called by ainput to read stdin"""
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
851 line = sys.stdin.readline()
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
852 if line:
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
853 stdin_fut.set_result(line.rstrip(os.linesep))
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
854 else:
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
855 stdin_fut.set_exception(EOFError())
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
856
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
857 async def ainput(self, msg=""):
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
858 """Asynchronous version of buildin "input" function"""
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
859 self.disp(msg, end=" ")
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
860 sys.stdout.flush()
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
861 loop = asyncio.get_running_loop()
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
862 stdin_fut = loop.create_future()
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
863 loop.add_reader(sys.stdin, self._read_stdin, stdin_fut)
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
864 return await stdin_fut
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
865
3409
4ca5bc6b44b6 jp: new `confirm` method:
Goffi <goffi@goffi.org>
parents: 3408
diff changeset
866 async def confirm(self, message):
4ca5bc6b44b6 jp: new `confirm` method:
Goffi <goffi@goffi.org>
parents: 3408
diff changeset
867 """Request user to confirm action, return answer as boolean"""
4ca5bc6b44b6 jp: new `confirm` method:
Goffi <goffi@goffi.org>
parents: 3408
diff changeset
868 res = await self.ainput(f"{message} (y/N)? ")
4ca5bc6b44b6 jp: new `confirm` method:
Goffi <goffi@goffi.org>
parents: 3408
diff changeset
869 return res in ("y", "Y")
4ca5bc6b44b6 jp: new `confirm` method:
Goffi <goffi@goffi.org>
parents: 3408
diff changeset
870
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
871 async def confirm_or_quit(
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
872 self, message, cancel_message=_("action cancelled by user")
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
873 ):
2550
1d754bc14381 jp (base): new confirmOrQuit helper method to ask confirmation to user, and quit if he cancel
Goffi <goffi@goffi.org>
parents: 2547
diff changeset
874 """Request user to confirm action, and quit if he doesn't"""
3409
4ca5bc6b44b6 jp: new `confirm` method:
Goffi <goffi@goffi.org>
parents: 3408
diff changeset
875 confirmed = await self.confirm(message)
4ca5bc6b44b6 jp: new `confirm` method:
Goffi <goffi@goffi.org>
parents: 3408
diff changeset
876 if not confirmed:
2550
1d754bc14381 jp (base): new confirmOrQuit helper method to ask confirmation to user, and quit if he cancel
Goffi <goffi@goffi.org>
parents: 2547
diff changeset
877 self.disp(cancel_message)
1d754bc14381 jp (base): new confirmOrQuit helper method to ask confirmation to user, and quit if he cancel
Goffi <goffi@goffi.org>
parents: 2547
diff changeset
878 self.quit(C.EXIT_USER_CANCELLED)
1d754bc14381 jp (base): new confirmOrQuit helper method to ask confirmation to user, and quit if he cancel
Goffi <goffi@goffi.org>
parents: 2547
diff changeset
879
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
880 def quit_from_signal(self, exit_code=0):
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
881 r"""Same as self.quit, but from a signal handler
1604
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
882
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
883 /!\: return must be used after calling this method !
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
884 """
1918
01d56efd488b jp: fixed traceback shown on a normal quit when a progression is finished
Goffi <goffi@goffi.org>
parents: 1884
diff changeset
885 # XXX: python-dbus will show a traceback if we exit in a signal handler
1604
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
886 # so we use this little timeout trick to avoid it
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
887 self.loop.call_later(0, self.quit, exit_code)
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
888
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
889 def quit(self, exit_code=0, raise_exc=True):
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
890 """Terminate the execution with specified exit_code
1604
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
891
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
892 This will stop the loop.
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
893 @param exit_code(int): code to return when quitting the program
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
894 @param raise_exp(boolean): if True raise a QuitException to stop code execution
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
895 The default value should be used most of time.
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
896 """
1604
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
897 # first the onQuitCallbacks
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
898 try:
4133
33fd658d9d00 cli (base): catch `SystemExit` to do a proper `quit` when `Ctrl-C` is pressed.
Goffi <goffi@goffi.org>
parents: 4129
diff changeset
899 callbacks_list = self._on_quit_callbacks
1604
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
900 except AttributeError:
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
901 pass
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
902 else:
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
903 for callback, args, kwargs in callbacks_list:
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
904 callback(*args, **kwargs)
4133
33fd658d9d00 cli (base): catch `SystemExit` to do a proper `quit` when `Ctrl-C` is pressed.
Goffi <goffi@goffi.org>
parents: 4129
diff changeset
905 callbacks_list.clear()
1604
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
906
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
907 self.loop.quit(exit_code)
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
908 if raise_exc:
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
909 raise QuitException
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
910
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
911 async def a_quit(self, exit_code: int = 0, raise_exc=True):
4142
783bbdbf8567 cli (base): new `a_quit` method to run async cleaning methods:
Goffi <goffi@goffi.org>
parents: 4133
diff changeset
912 """Execute async quit callback before actually quitting
783bbdbf8567 cli (base): new `a_quit` method to run async cleaning methods:
Goffi <goffi@goffi.org>
parents: 4133
diff changeset
913
783bbdbf8567 cli (base): new `a_quit` method to run async cleaning methods:
Goffi <goffi@goffi.org>
parents: 4133
diff changeset
914 This method should be prefered to ``quit``, as it executes async quit callbacks
783bbdbf8567 cli (base): new `a_quit` method to run async cleaning methods:
Goffi <goffi@goffi.org>
parents: 4133
diff changeset
915 which may be necessary for proper cleaning of session.
783bbdbf8567 cli (base): new `a_quit` method to run async cleaning methods:
Goffi <goffi@goffi.org>
parents: 4133
diff changeset
916 """
783bbdbf8567 cli (base): new `a_quit` method to run async cleaning methods:
Goffi <goffi@goffi.org>
parents: 4133
diff changeset
917 try:
783bbdbf8567 cli (base): new `a_quit` method to run async cleaning methods:
Goffi <goffi@goffi.org>
parents: 4133
diff changeset
918 callbacks_list = self._on_quit_callbacks
783bbdbf8567 cli (base): new `a_quit` method to run async cleaning methods:
Goffi <goffi@goffi.org>
parents: 4133
diff changeset
919 except AttributeError:
783bbdbf8567 cli (base): new `a_quit` method to run async cleaning methods:
Goffi <goffi@goffi.org>
parents: 4133
diff changeset
920 pass
783bbdbf8567 cli (base): new `a_quit` method to run async cleaning methods:
Goffi <goffi@goffi.org>
parents: 4133
diff changeset
921 else:
783bbdbf8567 cli (base): new `a_quit` method to run async cleaning methods:
Goffi <goffi@goffi.org>
parents: 4133
diff changeset
922 for callback, args, kwargs in callbacks_list:
783bbdbf8567 cli (base): new `a_quit` method to run async cleaning methods:
Goffi <goffi@goffi.org>
parents: 4133
diff changeset
923 await aio.maybe_async(callback(*args, **kwargs))
783bbdbf8567 cli (base): new `a_quit` method to run async cleaning methods:
Goffi <goffi@goffi.org>
parents: 4133
diff changeset
924 callbacks_list.clear()
783bbdbf8567 cli (base): new `a_quit` method to run async cleaning methods:
Goffi <goffi@goffi.org>
parents: 4133
diff changeset
925 self.quit(exit_code, raise_exc)
783bbdbf8567 cli (base): new `a_quit` method to run async cleaning methods:
Goffi <goffi@goffi.org>
parents: 4133
diff changeset
926
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
927 async def check_jids(self, jids):
814
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
928 """Check jids validity, transform roster name to corresponding jids
110
cb904fa7de3c jp: profile management (new option: --profile)
Goffi <goffi@goffi.org>
parents: 70
diff changeset
929
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
930 @param profile: profile name
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
931 @param jids: list of jids
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
932 @return: List of jids
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
933
814
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
934 """
401
b2caa2615c4c jp roster name manegement + Pipe transfer
Goffi <goffi@goffi.org>
parents: 393
diff changeset
935 names2jid = {}
493
b7c4bb2c0668 jp: - better expandJid: roster's jids' nodes are used after names to expand jid
Goffi <goffi@goffi.org>
parents: 480
diff changeset
936 nodes2jid = {}
393
393b35aa86d2 jp: added --connect option
Goffi <goffi@goffi.org>
parents: 391
diff changeset
937
3765
ea204216a505 CLI: don't fail when calling `getContacts` with a component profile
Goffi <goffi@goffi.org>
parents: 3709
diff changeset
938 try:
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
939 contacts = await self.bridge.contacts_get(self.profile)
3765
ea204216a505 CLI: don't fail when calling `getContacts` with a component profile
Goffi <goffi@goffi.org>
parents: 3709
diff changeset
940 except BridgeException as e:
ea204216a505 CLI: don't fail when calling `getContacts` with a component profile
Goffi <goffi@goffi.org>
parents: 3709
diff changeset
941 if e.classname == "AttributeError":
ea204216a505 CLI: don't fail when calling `getContacts` with a component profile
Goffi <goffi@goffi.org>
parents: 3709
diff changeset
942 # we may get an AttributeError if we use a component profile
ea204216a505 CLI: don't fail when calling `getContacts` with a component profile
Goffi <goffi@goffi.org>
parents: 3709
diff changeset
943 # as components don't have roster
ea204216a505 CLI: don't fail when calling `getContacts` with a component profile
Goffi <goffi@goffi.org>
parents: 3709
diff changeset
944 contacts = []
ea204216a505 CLI: don't fail when calling `getContacts` with a component profile
Goffi <goffi@goffi.org>
parents: 3709
diff changeset
945 else:
ea204216a505 CLI: don't fail when calling `getContacts` with a component profile
Goffi <goffi@goffi.org>
parents: 3709
diff changeset
946 raise e
ea204216a505 CLI: don't fail when calling `getContacts` with a component profile
Goffi <goffi@goffi.org>
parents: 3709
diff changeset
947
ea204216a505 CLI: don't fail when calling `getContacts` with a component profile
Goffi <goffi@goffi.org>
parents: 3709
diff changeset
948 for contact in contacts:
1395
1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node
Goffi <goffi@goffi.org>
parents: 1290
diff changeset
949 jid_s, attr, groups = contact
1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node
Goffi <goffi@goffi.org>
parents: 1290
diff changeset
950 _jid = JID(jid_s)
1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node
Goffi <goffi@goffi.org>
parents: 1290
diff changeset
951 try:
1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node
Goffi <goffi@goffi.org>
parents: 1290
diff changeset
952 names2jid[attr["name"].lower()] = jid_s
1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node
Goffi <goffi@goffi.org>
parents: 1290
diff changeset
953 except KeyError:
1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node
Goffi <goffi@goffi.org>
parents: 1290
diff changeset
954 pass
1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node
Goffi <goffi@goffi.org>
parents: 1290
diff changeset
955
1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node
Goffi <goffi@goffi.org>
parents: 1290
diff changeset
956 if _jid.node:
1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node
Goffi <goffi@goffi.org>
parents: 1290
diff changeset
957 nodes2jid[_jid.node.lower()] = jid_s
401
b2caa2615c4c jp roster name manegement + Pipe transfer
Goffi <goffi@goffi.org>
parents: 393
diff changeset
958
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
959 def expand_jid(jid):
401
b2caa2615c4c jp roster name manegement + Pipe transfer
Goffi <goffi@goffi.org>
parents: 393
diff changeset
960 _jid = jid.lower()
493
b7c4bb2c0668 jp: - better expandJid: roster's jids' nodes are used after names to expand jid
Goffi <goffi@goffi.org>
parents: 480
diff changeset
961 if _jid in names2jid:
b7c4bb2c0668 jp: - better expandJid: roster's jids' nodes are used after names to expand jid
Goffi <goffi@goffi.org>
parents: 480
diff changeset
962 expanded = names2jid[_jid]
b7c4bb2c0668 jp: - better expandJid: roster's jids' nodes are used after names to expand jid
Goffi <goffi@goffi.org>
parents: 480
diff changeset
963 elif _jid in nodes2jid:
b7c4bb2c0668 jp: - better expandJid: roster's jids' nodes are used after names to expand jid
Goffi <goffi@goffi.org>
parents: 480
diff changeset
964 expanded = nodes2jid[_jid]
b7c4bb2c0668 jp: - better expandJid: roster's jids' nodes are used after names to expand jid
Goffi <goffi@goffi.org>
parents: 480
diff changeset
965 else:
b7c4bb2c0668 jp: - better expandJid: roster's jids' nodes are used after names to expand jid
Goffi <goffi@goffi.org>
parents: 480
diff changeset
966 expanded = jid
2588
4011e4ee3151 jp (base): fixed jid encoding
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
967 return expanded
401
b2caa2615c4c jp roster name manegement + Pipe transfer
Goffi <goffi@goffi.org>
parents: 393
diff changeset
968
b2caa2615c4c jp roster name manegement + Pipe transfer
Goffi <goffi@goffi.org>
parents: 393
diff changeset
969 def check(jid):
b2caa2615c4c jp roster name manegement + Pipe transfer
Goffi <goffi@goffi.org>
parents: 393
diff changeset
970 if not jid.is_valid:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
971 log.error(_("%s is not a valid JID !"), jid)
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
972 self.quit(1)
401
b2caa2615c4c jp roster name manegement + Pipe transfer
Goffi <goffi@goffi.org>
parents: 393
diff changeset
973
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
974 dest_jids = []
401
b2caa2615c4c jp roster name manegement + Pipe transfer
Goffi <goffi@goffi.org>
parents: 393
diff changeset
975 try:
814
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
976 for i in range(len(jids)):
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
977 dest_jids.append(expand_jid(jids[i]))
814
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
978 check(dest_jids[i])
401
b2caa2615c4c jp roster name manegement + Pipe transfer
Goffi <goffi@goffi.org>
parents: 393
diff changeset
979 except AttributeError:
b2caa2615c4c jp roster name manegement + Pipe transfer
Goffi <goffi@goffi.org>
parents: 393
diff changeset
980 pass
0
goffi@necton2
parents:
diff changeset
981
814
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
982 return dest_jids
0
goffi@necton2
parents:
diff changeset
983
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
984 async def a_pwd_input(self, msg=""):
3049
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
985 """Like ainput but with echo disabled (useful for passwords)"""
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
986 # we disable echo, code adapted from getpass standard module which has been
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
987 # written by Piers Lauder (original), Guido van Rossum (Windows support and
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
988 # cleanup) and Gregory P. Smith (tty support & GetPassWarning), a big thanks
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
989 # to them (and for all the amazing work on Python).
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
990 stdin_fd = sys.stdin.fileno()
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
991 old = termios.tcgetattr(sys.stdin)
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
992 new = old[:]
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
993 new[3] &= ~termios.ECHO
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
994 tcsetattr_flags = termios.TCSAFLUSH
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
995 if hasattr(termios, "TCSASOFT"):
3049
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
996 tcsetattr_flags |= termios.TCSASOFT
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
997 try:
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
998 termios.tcsetattr(stdin_fd, tcsetattr_flags, new)
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
999 pwd = await self.ainput(msg=msg)
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
1000 finally:
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
1001 termios.tcsetattr(stdin_fd, tcsetattr_flags, old)
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
1002 sys.stderr.flush()
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1003 self.disp("")
3049
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
1004 return pwd
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
1005
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1006 async def connect_or_prompt(self, method, err_msg=None):
3049
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
1007 """Try to connect/start profile session and prompt for password if needed
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
1008
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
1009 @param method(callable): bridge method to either connect or start profile session
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
1010 It will be called with password as sole argument, use lambda to do the call
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
1011 properly
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
1012 @param err_msg(str): message to show if connection fail
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
1013 """
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
1014 password = self.args.pwd
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
1015 while True:
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
1016 try:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1017 await method(password or "")
3049
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
1018 except Exception as e:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1019 if (
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1020 isinstance(e, BridgeException)
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1021 and e.classname == "PasswordError"
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1022 and self.args.pwd is None
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1023 ):
3049
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
1024 if password is not None:
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
1025 self.disp(A.color(C.A_WARNING, _("invalid password")))
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1026 password = await self.a_pwd_input(_("please enter profile password:"))
3049
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
1027 else:
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
1028 self.disp(err_msg.format(profile=self.profile, e=e), error=True)
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
1029 self.quit(C.EXIT_ERROR)
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
1030 else:
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
1031 break
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
1032
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1033 async def connect_profile(self):
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1034 """Check if the profile is connected and do it if requested
1401
265ff2bd8d67 jp: fixed crash on commands using profile without "connect" option
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
1035
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1036 @exit: - 1 when profile is not connected and --connect is not set
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1037 - 1 when the profile doesn't exists
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1038 - 1 when there is a connection error
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1039 """
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1040 # FIXME: need better exit codes
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1041
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1042 self.profile = await self.bridge.profile_name_get(self.args.profile)
0
goffi@necton2
parents:
diff changeset
1043
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1044 if not self.profile:
3568
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
1045 log.error(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1046 _("The profile [{profile}] doesn't exist").format(
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1047 profile=self.args.profile
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1048 )
3568
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
1049 )
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1050 self.quit(C.EXIT_ERROR)
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1051
1594
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
1052 try:
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
1053 start_session = self.args.start_session
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
1054 except AttributeError:
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
1055 pass
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
1056 else:
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
1057 if start_session:
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1058 await self.connect_or_prompt(
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1059 lambda pwd: self.bridge.profile_start_session(pwd, self.profile),
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1060 err_msg="Can't start {profile}'s session: {e}",
3049
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
1061 )
1594
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
1062 return
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1063 elif not await self.bridge.profile_is_session_started(self.profile):
1594
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
1064 if not self.args.connect:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1065 self.disp(
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1066 _(
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1067 "Session for [{profile}] is not started, please start it "
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1068 "before using libervia-cli, or use either --start-session or "
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1069 "--connect option".format(profile=self.profile)
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1070 ),
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1071 error=True,
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1072 )
1594
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
1073 self.quit(1)
2692
7d4679ee7ded jp (base): fixed connection when start_session arg exists but is False
Goffi <goffi@goffi.org>
parents: 2672
diff changeset
1074 elif not getattr(self.args, "connect", False):
1594
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
1075 return
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
1076
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1077 if not hasattr(self.args, "connect"):
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1078 # a profile can be present without connect option (e.g. on profile
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1079 # creation/deletion)
1401
265ff2bd8d67 jp: fixed crash on commands using profile without "connect" option
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
1080 return
1588
823a385235ef jp: fixed bad --connect option check
Goffi <goffi@goffi.org>
parents: 1544
diff changeset
1081 elif self.args.connect is True: # if connection is asked, we connect the profile
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1082 await self.connect_or_prompt(
3049
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
1083 lambda pwd: self.bridge.connect(self.profile, pwd, {}),
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1084 err_msg='Can\'t connect profile "{profile!s}": {e}',
3049
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
1085 )
814
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
1086 return
1594
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
1087 else:
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1088 if not await self.bridge.is_connected(self.profile):
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1089 log.error(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1090 _(
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1091 "Profile [{profile}] is not connected, please connect it "
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1092 "before using libervia-cli, or use --connect option"
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1093 ).format(profile=self.profile)
3568
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
1094 )
1594
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
1095 self.quit(1)
0
goffi@necton2
parents:
diff changeset
1096
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1097 async def get_full_jid(self, param_jid):
1290
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit):
Goffi <goffi@goffi.org>
parents: 1139
diff changeset
1098 """Return the full jid if possible (add main resource when find a bare jid)"""
3408
19bc03743aeb jp (file/send): don't add main resource to bare jid anymore:
Goffi <goffi@goffi.org>
parents: 3407
diff changeset
1099 # TODO: to be removed, bare jid should work with all commands, notably for file
19bc03743aeb jp (file/send): don't add main resource to bare jid anymore:
Goffi <goffi@goffi.org>
parents: 3407
diff changeset
1100 # as backend now handle jingles message initiation
401
b2caa2615c4c jp roster name manegement + Pipe transfer
Goffi <goffi@goffi.org>
parents: 393
diff changeset
1101 _jid = JID(param_jid)
b2caa2615c4c jp roster name manegement + Pipe transfer
Goffi <goffi@goffi.org>
parents: 393
diff changeset
1102 if not _jid.resource:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1103 # if the resource is not given, we try to add the main resource
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1104 main_resource = await self.bridge.main_resource_get(param_jid, self.profile)
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1105 if main_resource:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1106 return f"{_jid.bare}/{main_resource}"
401
b2caa2615c4c jp roster name manegement + Pipe transfer
Goffi <goffi@goffi.org>
parents: 393
diff changeset
1107 return param_jid
b2caa2615c4c jp roster name manegement + Pipe transfer
Goffi <goffi@goffi.org>
parents: 393
diff changeset
1108
3834
3260401fdb98 cli: helper method to retrieve profile's jid:
Goffi <goffi@goffi.org>
parents: 3765
diff changeset
1109 async def get_profile_jid(self):
3260401fdb98 cli: helper method to retrieve profile's jid:
Goffi <goffi@goffi.org>
parents: 3765
diff changeset
1110 """Retrieve current profile bare JID if possible"""
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1111 full_jid = await self.bridge.param_get_a_async(
3834
3260401fdb98 cli: helper method to retrieve profile's jid:
Goffi <goffi@goffi.org>
parents: 3765
diff changeset
1112 "JabberID", "Connection", profile_key=self.profile
3260401fdb98 cli: helper method to retrieve profile's jid:
Goffi <goffi@goffi.org>
parents: 3765
diff changeset
1113 )
3260401fdb98 cli: helper method to retrieve profile's jid:
Goffi <goffi@goffi.org>
parents: 3765
diff changeset
1114 return full_jid.rsplit("/", 1)[0]
3260401fdb98 cli: helper method to retrieve profile's jid:
Goffi <goffi@goffi.org>
parents: 3765
diff changeset
1115
814
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
1116
3938
6939594ba77e cli (pubsub/get): add `--no-decrypt` flag to disable automatic decryption:
Goffi <goffi@goffi.org>
parents: 3893
diff changeset
1117 class CommandBase:
814
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
1118
3938
6939594ba77e cli (pubsub/get): add `--no-decrypt` flag to disable automatic decryption:
Goffi <goffi@goffi.org>
parents: 3893
diff changeset
1119 def __init__(
6939594ba77e cli (pubsub/get): add `--no-decrypt` flag to disable automatic decryption:
Goffi <goffi@goffi.org>
parents: 3893
diff changeset
1120 self,
6939594ba77e cli (pubsub/get): add `--no-decrypt` flag to disable automatic decryption:
Goffi <goffi@goffi.org>
parents: 3893
diff changeset
1121 host: LiberviaCli,
6939594ba77e cli (pubsub/get): add `--no-decrypt` flag to disable automatic decryption:
Goffi <goffi@goffi.org>
parents: 3893
diff changeset
1122 name: str,
6939594ba77e cli (pubsub/get): add `--no-decrypt` flag to disable automatic decryption:
Goffi <goffi@goffi.org>
parents: 3893
diff changeset
1123 use_profile: bool = True,
6939594ba77e cli (pubsub/get): add `--no-decrypt` flag to disable automatic decryption:
Goffi <goffi@goffi.org>
parents: 3893
diff changeset
1124 use_output: Union[bool, str] = False,
6939594ba77e cli (pubsub/get): add `--no-decrypt` flag to disable automatic decryption:
Goffi <goffi@goffi.org>
parents: 3893
diff changeset
1125 extra_outputs: Optional[dict] = None,
6939594ba77e cli (pubsub/get): add `--no-decrypt` flag to disable automatic decryption:
Goffi <goffi@goffi.org>
parents: 3893
diff changeset
1126 need_connect: Optional[bool] = None,
6939594ba77e cli (pubsub/get): add `--no-decrypt` flag to disable automatic decryption:
Goffi <goffi@goffi.org>
parents: 3893
diff changeset
1127 help: Optional[str] = None,
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1128 **kwargs,
3938
6939594ba77e cli (pubsub/get): add `--no-decrypt` flag to disable automatic decryption:
Goffi <goffi@goffi.org>
parents: 3893
diff changeset
1129 ):
2098
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge:
Goffi <goffi@goffi.org>
parents: 2086
diff changeset
1130 """Initialise CommandBase
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge:
Goffi <goffi@goffi.org>
parents: 2086
diff changeset
1131
4075
47401850dec6 refactoring: rename `libervia.frontends.jp` to `libervia.cli`
Goffi <goffi@goffi.org>
parents: 4074
diff changeset
1132 @param host: LiberviaCli instance
3938
6939594ba77e cli (pubsub/get): add `--no-decrypt` flag to disable automatic decryption:
Goffi <goffi@goffi.org>
parents: 3893
diff changeset
1133 @param name: name of the new command
6939594ba77e cli (pubsub/get): add `--no-decrypt` flag to disable automatic decryption:
Goffi <goffi@goffi.org>
parents: 3893
diff changeset
1134 @param use_profile: if True, add profile selection/connection commands
6939594ba77e cli (pubsub/get): add `--no-decrypt` flag to disable automatic decryption:
Goffi <goffi@goffi.org>
parents: 3893
diff changeset
1135 @param use_output: if not False, add --output option
6939594ba77e cli (pubsub/get): add `--no-decrypt` flag to disable automatic decryption:
Goffi <goffi@goffi.org>
parents: 3893
diff changeset
1136 @param extra_outputs: list of command specific outputs:
2155
cee6561ad086 jp (core): added extra_outputs:
Goffi <goffi@goffi.org>
parents: 2151
diff changeset
1137 key is output name ("default" to use as main output)
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1138 value is a callable which will format the output (data will be used as only
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1139 argument)
2155
cee6561ad086 jp (core): added extra_outputs:
Goffi <goffi@goffi.org>
parents: 2151
diff changeset
1140 if a key already exists with normal outputs, the extra one will be used
3938
6939594ba77e cli (pubsub/get): add `--no-decrypt` flag to disable automatic decryption:
Goffi <goffi@goffi.org>
parents: 3893
diff changeset
1141 @param need_connect: True if profile connection is needed
1594
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
1142 False else (profile session must still be started)
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
1143 None to set auto value (i.e. True if use_profile is set)
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
1144 Can't be set if use_profile is False
3938
6939594ba77e cli (pubsub/get): add `--no-decrypt` flag to disable automatic decryption:
Goffi <goffi@goffi.org>
parents: 3893
diff changeset
1145 @param help: help message to display
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1146 @param **kwargs: args passed to ArgumentParser
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
1147 use_* are handled directly, they can be:
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
1148 - use_progress(bool): if True, add progress bar activation option
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
1149 progress* signals will be handled
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
1150 - use_verbose(bool): if True, add verbosity option
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
1151 - use_pubsub(bool): if True, add pubsub options
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
1152 mandatory arguments are controlled by pubsub_req
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
1153 - use_draft(bool): if True, add draft handling options
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
1154 ** other arguments **
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1155 - pubsub_flags(iterable[unicode]): tuple of flags to set pubsub options,
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1156 can be:
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
1157 C.SERVICE: service is required
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
1158 C.NODE: node is required
2614
a5b96950b81a jp (event): fixed crash on missing item in get and inviteeGet by making it mandatory.
Goffi <goffi@goffi.org>
parents: 2609
diff changeset
1159 C.ITEM: item is required
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
1160 C.SINGLE_ITEM: only one item is allowed
814
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
1161 """
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1162 try: # If we have subcommands, host is a CommandBase and we need to use host.host
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1163 self.host = host.host
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1164 except AttributeError:
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1165 self.host = host
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1166
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
1167 # --profile option
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1168 parents = kwargs.setdefault("parents", set())
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1169 if use_profile:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1170 # self.host.parents['profile'] is an ArgumentParser with profile connection
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1171 # arguments
1594
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
1172 if need_connect is None:
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
1173 need_connect = True
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1174 parents.add(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1175 self.host.parents["profile" if need_connect else "profile_session"]
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1176 )
1594
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
1177 else:
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
1178 assert need_connect is None
1860
afc7f6328394 jp (base): use need_connect attribue to detect if connection is needed instead of self.args.profile, as profile argument can be used by any command even if use_profile is False
Goffi <goffi@goffi.org>
parents: 1840
diff changeset
1179 self.need_connect = need_connect
afc7f6328394 jp (base): use need_connect attribue to detect if connection is needed instead of self.args.profile, as profile argument can be used by any command even if use_profile is False
Goffi <goffi@goffi.org>
parents: 1840
diff changeset
1180 # from this point, self.need_connect is None if connection is not needed at all
afc7f6328394 jp (base): use need_connect attribue to detect if connection is needed instead of self.args.profile, as profile argument can be used by any command even if use_profile is False
Goffi <goffi@goffi.org>
parents: 1840
diff changeset
1181 # False if session starting is needed, and True if full connection is needed
1594
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
1182
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
1183 # --output option
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
1184 if use_output:
2155
cee6561ad086 jp (core): added extra_outputs:
Goffi <goffi@goffi.org>
parents: 2151
diff changeset
1185 if extra_outputs is None:
cee6561ad086 jp (core): added extra_outputs:
Goffi <goffi@goffi.org>
parents: 2151
diff changeset
1186 extra_outputs = {}
cee6561ad086 jp (core): added extra_outputs:
Goffi <goffi@goffi.org>
parents: 2151
diff changeset
1187 self.extra_outputs = extra_outputs
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
1188 if use_output == True:
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
1189 use_output = C.OUTPUT_TEXT
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
1190 assert use_output in C.OUTPUT_TYPES
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
1191 self._output_type = use_output
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
1192 output_parent = argparse.ArgumentParser(add_help=False)
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1193 choices = set(self.host.get_output_choices(use_output))
2155
cee6561ad086 jp (core): added extra_outputs:
Goffi <goffi@goffi.org>
parents: 2151
diff changeset
1194 choices.update(extra_outputs)
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
1195 if not choices:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1196 raise exceptions.InternalError(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1197 "No choice found for {} output type".format(use_output)
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1198 )
2189
a25a256688e2 jp (base): output can now specify a default when registering
Goffi <goffi@goffi.org>
parents: 2188
diff changeset
1199 try:
a25a256688e2 jp (base): output can now specify a default when registering
Goffi <goffi@goffi.org>
parents: 2188
diff changeset
1200 default = self.host.default_output[use_output]
a25a256688e2 jp (base): output can now specify a default when registering
Goffi <goffi@goffi.org>
parents: 2188
diff changeset
1201 except KeyError:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1202 if "default" in choices:
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1203 default = "default"
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1204 elif "simple" in choices:
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1205 default = "simple"
2189
a25a256688e2 jp (base): output can now specify a default when registering
Goffi <goffi@goffi.org>
parents: 2188
diff changeset
1206 else:
a25a256688e2 jp (base): output can now specify a default when registering
Goffi <goffi@goffi.org>
parents: 2188
diff changeset
1207 default = list(choices)[0]
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1208 output_parent.add_argument(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1209 "--output",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1210 "-O",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1211 choices=sorted(choices),
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1212 default=default,
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1213 help=_("select output format (default: {})".format(default)),
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1214 )
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1215 output_parent.add_argument(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1216 "--output-option",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1217 "--oo",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1218 action="append",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1219 dest="output_opts",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1220 default=[],
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1221 help=_("output specific option"),
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1222 )
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
1223 parents.add(output_parent)
2155
cee6561ad086 jp (core): added extra_outputs:
Goffi <goffi@goffi.org>
parents: 2151
diff changeset
1224 else:
cee6561ad086 jp (core): added extra_outputs:
Goffi <goffi@goffi.org>
parents: 2151
diff changeset
1225 assert extra_outputs is None
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1226
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1227 self._use_pubsub = kwargs.pop("use_pubsub", False)
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
1228 if self._use_pubsub:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1229 flags = kwargs.pop("pubsub_flags", [])
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1230 defaults = kwargs.pop("pubsub_defaults", {})
2547
2d69a0afe039 jp: new argument pubsub_default can be used in Commands to replace default value in help string
Goffi <goffi@goffi.org>
parents: 2539
diff changeset
1231 parents.add(self.host.make_pubsub_group(flags, defaults))
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
1232 self._pubsub_flags = flags
2235
4db836386641 jp: added use_pubsub and use_pubsub_node_req arguments to CommandBase
Goffi <goffi@goffi.org>
parents: 2213
diff changeset
1233
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
1234 # other common options
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1235 use_opts = {k: v for k, v in kwargs.items() if k.startswith("use_")}
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
1236 for param, do_use in use_opts.items():
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1237 opt = param[4:] # if param is use_verbose, opt is verbose
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
1238 if opt not in self.host.parents:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
1239 raise exceptions.InternalError("Unknown parent option {}".format(opt))
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
1240 del kwargs[param]
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
1241 if do_use:
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
1242 parents.add(self.host.parents[opt])
1600
8d41cd4da2f6 jp: added a --verbose command
Goffi <goffi@goffi.org>
parents: 1594
diff changeset
1243
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1244 self.parser = host.subparsers.add_parser(name, help=help, **kwargs)
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1245 if hasattr(self, "subcommands"):
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1246 self.subparsers = self.parser.add_subparsers(dest="subcommand", required=True)
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1247 else:
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
1248 self.parser.set_defaults(_cmd=self)
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1249 self.add_parser_options()
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1250
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1251 @property
3046
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
1252 def sat_conf(self):
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
1253 return self.host.sat_conf
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
1254
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
1255 @property
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1256 def args(self):
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1257 return self.host.args
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1258
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1259 @property
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1260 def profile(self):
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1261 return self.host.profile
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1262
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1263 @property
2490
b4bf282d6354 jp (base): added verbosity property to CommandBase
Goffi <goffi@goffi.org>
parents: 2486
diff changeset
1264 def verbosity(self):
b4bf282d6354 jp (base): added verbosity property to CommandBase
Goffi <goffi@goffi.org>
parents: 2486
diff changeset
1265 return self.host.verbosity
b4bf282d6354 jp (base): added verbosity property to CommandBase
Goffi <goffi@goffi.org>
parents: 2486
diff changeset
1266
b4bf282d6354 jp (base): added verbosity property to CommandBase
Goffi <goffi@goffi.org>
parents: 2486
diff changeset
1267 @property
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1268 def progress_id(self):
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1269 return self.host.progress_id
814
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
1270
4129
51744ad00a42 cli: `rich` initial integration
Goffi <goffi@goffi.org>
parents: 4075
diff changeset
1271 @property
51744ad00a42 cli: `rich` initial integration
Goffi <goffi@goffi.org>
parents: 4075
diff changeset
1272 def console(self):
51744ad00a42 cli: `rich` initial integration
Goffi <goffi@goffi.org>
parents: 4075
diff changeset
1273 return self.host.console
51744ad00a42 cli: `rich` initial integration
Goffi <goffi@goffi.org>
parents: 4075
diff changeset
1274
51744ad00a42 cli: `rich` initial integration
Goffi <goffi@goffi.org>
parents: 4075
diff changeset
1275 def print(self, *args, **kwargs):
51744ad00a42 cli: `rich` initial integration
Goffi <goffi@goffi.org>
parents: 4075
diff changeset
1276 self.host.console.print(*args, **kwargs)
51744ad00a42 cli: `rich` initial integration
Goffi <goffi@goffi.org>
parents: 4075
diff changeset
1277
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1278 async def set_progress_id(self, progress_id):
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1279 return await self.host.set_progress_id(progress_id)
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1280
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1281 async def progress_started_handler(self, uid, metadata, profile):
1627
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1282 if profile != self.profile:
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1283 return
1642
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
1284 if self.progress_id is None:
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
1285 # the progress started message can be received before the id
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1286 # so we keep progress_started signals in cache to replay they
1642
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
1287 # when the progress_id is received
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1288 cache_data = (self.progress_started_handler, uid, metadata, profile)
1642
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
1289 try:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1290 cache = self.host.progress_ids_cache
1642
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
1291 except AttributeError:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1292 cache = self.host.progress_ids_cache = []
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1293 cache.append(cache_data)
1642
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
1294 else:
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
1295 if self.host.watch_progress and uid == self.progress_id:
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1296 await self.on_progress_started(metadata)
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1297 while True:
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1298 await asyncio.sleep(PROGRESS_DELAY)
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1299 cont = await self.progress_update()
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1300 if not cont:
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1301 break
1627
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1302
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1303 async def progress_finished_handler(self, uid, metadata, profile):
1627
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1304 if profile != self.profile:
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1305 return
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1306 if uid == self.progress_id:
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1307 try:
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1308 self.host.pbar.finish()
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1309 except AttributeError:
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1310 pass
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1311 await self.on_progress_finished(metadata)
1627
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1312 if self.host.quit_on_progress_end:
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1313 self.host.quit_from_signal()
1627
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1314
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1315 async def progress_error_handler(self, uid, message, profile):
1627
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1316 if profile != self.profile:
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1317 return
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1318 if uid == self.progress_id:
1641
44a14f83e64b jp (base): fixed verbose option + there is a new line on ProgressErrorHandler only if the progress bar is actually displayed
Goffi <goffi@goffi.org>
parents: 1627
diff changeset
1319 if self.args.progress:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1320 self.disp("") # progress is not finished, so we skip a line
1627
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1321 if self.host.quit_on_progress_end:
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1322 await self.on_progress_error(message)
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1323 self.host.quit_from_signal(C.EXIT_ERROR)
1627
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1324
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1325 async def progress_update(self):
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1326 """This method is continualy called to update the progress bar
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1327
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1328 @return (bool): False to stop being called
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1329 """
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1330 data = await self.host.bridge.progress_get(self.progress_id, self.profile)
1832
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1331 if data:
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1332 try:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1333 size = data["size"]
1832
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1334 except KeyError:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1335 self.disp(
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1336 _("file size is not known, we can't show a progress bar"),
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1337 1,
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1338 error=True,
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1339 )
1832
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1340 return False
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1341 if self.host.pbar is None:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1342 # first answer, we must construct the bar
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1343
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1344 # if the instance has a pbar_template attribute, it is used has model,
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1345 # else default one is used
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1346 # template is a list of part, where part can be either a str to show directly
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1347 # or a list where first argument is a name of a progressbar widget, and others
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1348 # are used as widget arguments
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1349 try:
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1350 template = self.pbar_template
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1351 except AttributeError:
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1352 template = [
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1353 _("Progress: "),
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1354 ["Percentage"],
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1355 " ",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1356 ["Bar"],
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1357 " ",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1358 ["FileTransferSpeed"],
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1359 " ",
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1360 ["ETA"],
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1361 ]
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1362
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1363 widgets = []
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1364 for part in template:
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1365 if isinstance(part, str):
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1366 widgets.append(part)
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1367 else:
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1368 widget = getattr(progressbar, part.pop(0))
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1369 widgets.append(widget(*part))
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1370
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1371 self.host.pbar = progressbar.ProgressBar(
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1372 max_value=int(size), widgets=widgets
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1373 )
1832
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1374 self.host.pbar.start()
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1375
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1376 self.host.pbar.update(int(data["position"]))
1832
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1377
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1378 elif self.host.pbar is not None:
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1379 return False
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1380
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1381 await self.on_progress_update(data)
1832
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1382
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1383 return True
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1384
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1385 async def on_progress_started(self, metadata):
1832
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1386 """Called when progress has just started
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1387
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1388 can be overidden by a command
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1389 @param metadata(dict): metadata as sent by bridge.progress_started
1832
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1390 """
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
1391 self.disp(_("Operation started"), 2)
1627
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1392
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1393 async def on_progress_update(self, metadata):
1832
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1394 """Method called on each progress updata
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1395
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1396 can be overidden by a command to handle progress metadata
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1397 @para metadata(dict): metadata as returned by bridge.progress_get
1832
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1398 """
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1399 pass
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1400
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1401 async def on_progress_finished(self, metadata):
1832
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1402 """Called when progress has just finished
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1403
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1404 can be overidden by a command
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1405 @param metadata(dict): metadata as sent by bridge.progress_finished
1832
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1406 """
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
1407 self.disp(_("Operation successfully finished"), 2)
1627
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1408
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1409 async def on_progress_error(self, e):
1832
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1410 """Called when a progress failed
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1411
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1412 @param error_msg(unicode): error message as sent by bridge.progress_error
1832
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1413 """
3568
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
1414 self.disp(_("Error while doing operation: {e}").format(e=e), error=True)
1627
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1415
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1416 def disp(self, msg, verbosity=0, error=False, end="\n"):
3407
2f0be2b7de68 jp: replace `no_lf` argument by `end` in `disp` (same as in `print`)
Goffi <goffi@goffi.org>
parents: 3378
diff changeset
1417 return self.host.disp(msg, verbosity, error, end)
1605
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
1418
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
1419 def output(self, data):
2193
33b82250eadd jp (base): raise InternalError if output is used when use_output is not declared
Goffi <goffi@goffi.org>
parents: 2189
diff changeset
1420 try:
33b82250eadd jp (base): raise InternalError if output is used when use_output is not declared
Goffi <goffi@goffi.org>
parents: 2189
diff changeset
1421 output_type = self._output_type
33b82250eadd jp (base): raise InternalError if output is used when use_output is not declared
Goffi <goffi@goffi.org>
parents: 2189
diff changeset
1422 except AttributeError:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1423 raise exceptions.InternalError(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1424 _("trying to use output when use_output has not been set")
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1425 )
2193
33b82250eadd jp (base): raise InternalError if output is used when use_output is not declared
Goffi <goffi@goffi.org>
parents: 2189
diff changeset
1426 return self.host.output(output_type, self.args.output, self.extra_outputs, data)
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
1427
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1428 def get_pubsub_extra(self, extra: Optional[dict] = None) -> str:
2761
4b693ea24d5f jp (base, pubsub, ticket): handle order-by:
Goffi <goffi@goffi.org>
parents: 2706
diff changeset
1429 """Helper method to compute extra data from pubsub arguments
4b693ea24d5f jp (base, pubsub, ticket): handle order-by:
Goffi <goffi@goffi.org>
parents: 2706
diff changeset
1430
3586
5f65f4e9f8cb plugin XEP-0060: getItems extra is now serialised dict
Goffi <goffi@goffi.org>
parents: 3568
diff changeset
1431 @param extra: base extra dict, or None to generate a new one
3893
045af0eeda3f core, CLI (base), tools (common/data_format): typing/core readability
Goffi <goffi@goffi.org>
parents: 3866
diff changeset
1432 @return: serialised dict which can be used directly in the bridge for pubsub
2761
4b693ea24d5f jp (base, pubsub, ticket): handle order-by:
Goffi <goffi@goffi.org>
parents: 2706
diff changeset
1433 """
4b693ea24d5f jp (base, pubsub, ticket): handle order-by:
Goffi <goffi@goffi.org>
parents: 2706
diff changeset
1434 if extra is None:
4b693ea24d5f jp (base, pubsub, ticket): handle order-by:
Goffi <goffi@goffi.org>
parents: 2706
diff changeset
1435 extra = {}
4b693ea24d5f jp (base, pubsub, ticket): handle order-by:
Goffi <goffi@goffi.org>
parents: 2706
diff changeset
1436 else:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
1437 intersection = {C.KEY_ORDER_BY}.intersection(list(extra.keys()))
2764
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1438 if intersection:
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1439 raise exceptions.ConflictError(
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
1440 "given extra dict has conflicting keys with pubsub keys "
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1441 "{intersection}".format(intersection=intersection)
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1442 )
2764
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1443
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1444 # RSM
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1445
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1446 for attribute in ("max", "after", "before", "index"):
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1447 key = "rsm_" + attribute
2764
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1448 if key in extra:
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1449 raise exceptions.ConflictError(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1450 "This key already exists in extra: u{key}".format(key=key)
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1451 )
2764
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1452 value = getattr(self.args, key, None)
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1453 if value is not None:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
1454 extra[key] = str(value)
2764
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1455
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1456 # MAM
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1457
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1458 if hasattr(self.args, "mam_filters"):
2764
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1459 for key, value in self.args.mam_filters:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1460 key = "filter_" + key
2764
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1461 if key in extra:
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1462 raise exceptions.ConflictError(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1463 "This key already exists in extra: u{key}".format(key=key)
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1464 )
2764
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1465 extra[key] = value
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1466
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1467 # Order-By
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1468
2761
4b693ea24d5f jp (base, pubsub, ticket): handle order-by:
Goffi <goffi@goffi.org>
parents: 2706
diff changeset
1469 try:
4b693ea24d5f jp (base, pubsub, ticket): handle order-by:
Goffi <goffi@goffi.org>
parents: 2706
diff changeset
1470 order_by = self.args.order_by
4b693ea24d5f jp (base, pubsub, ticket): handle order-by:
Goffi <goffi@goffi.org>
parents: 2706
diff changeset
1471 except AttributeError:
4b693ea24d5f jp (base, pubsub, ticket): handle order-by:
Goffi <goffi@goffi.org>
parents: 2706
diff changeset
1472 pass
4b693ea24d5f jp (base, pubsub, ticket): handle order-by:
Goffi <goffi@goffi.org>
parents: 2706
diff changeset
1473 else:
4b693ea24d5f jp (base, pubsub, ticket): handle order-by:
Goffi <goffi@goffi.org>
parents: 2706
diff changeset
1474 if order_by is not None:
4b693ea24d5f jp (base, pubsub, ticket): handle order-by:
Goffi <goffi@goffi.org>
parents: 2706
diff changeset
1475 extra[C.KEY_ORDER_BY] = self.args.order_by
3600
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
1476
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
1477 # Cache
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
1478 try:
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
1479 use_cache = self.args.use_cache
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
1480 except AttributeError:
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
1481 pass
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
1482 else:
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
1483 if not use_cache:
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
1484 extra[C.KEY_USE_CACHE] = use_cache
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
1485
3586
5f65f4e9f8cb plugin XEP-0060: getItems extra is now serialised dict
Goffi <goffi@goffi.org>
parents: 3568
diff changeset
1486 return data_format.serialise(extra)
2761
4b693ea24d5f jp (base, pubsub, ticket): handle order-by:
Goffi <goffi@goffi.org>
parents: 2706
diff changeset
1487
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1488 def add_parser_options(self):
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1489 try:
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1490 subcommands = self.subcommands
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1491 except AttributeError:
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1492 # We don't have subcommands, the class need to implements add_parser_options
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1493 raise NotImplementedError
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1494
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1495 # now we add subcommands to ourself
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1496 for cls in subcommands:
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1497 cls(self)
814
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
1498
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1499 def override_pubsub_flags(self, new_flags: Set[str]) -> None:
3866
915fb230cb28 cli (blog, pubsub): new `attachments` subcommands:
Goffi <goffi@goffi.org>
parents: 3834
diff changeset
1500 """Replace pubsub_flags given in __init__
915fb230cb28 cli (blog, pubsub): new `attachments` subcommands:
Goffi <goffi@goffi.org>
parents: 3834
diff changeset
1501
915fb230cb28 cli (blog, pubsub): new `attachments` subcommands:
Goffi <goffi@goffi.org>
parents: 3834
diff changeset
1502 useful when a command is extending an other command (e.g. blog command which does
915fb230cb28 cli (blog, pubsub): new `attachments` subcommands:
Goffi <goffi@goffi.org>
parents: 3834
diff changeset
1503 the same as pubsub command, but with a default node)
915fb230cb28 cli (blog, pubsub): new `attachments` subcommands:
Goffi <goffi@goffi.org>
parents: 3834
diff changeset
1504 """
915fb230cb28 cli (blog, pubsub): new `attachments` subcommands:
Goffi <goffi@goffi.org>
parents: 3834
diff changeset
1505 self._pubsub_flags = new_flags
915fb230cb28 cli (blog, pubsub): new `attachments` subcommands:
Goffi <goffi@goffi.org>
parents: 3834
diff changeset
1506
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1507 async def run(self):
1862
6d9c87bdc452 jp (base): added a CommandBase.start method which is called by run or connected, so subclasses can implement it (this is for simplicity sake, as it's not always clear if run or connected must be used)
Goffi <goffi@goffi.org>
parents: 1860
diff changeset
1508 """this method is called when a command is actually run
1395
1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node
Goffi <goffi@goffi.org>
parents: 1290
diff changeset
1509
1862
6d9c87bdc452 jp (base): added a CommandBase.start method which is called by run or connected, so subclasses can implement it (this is for simplicity sake, as it's not always clear if run or connected must be used)
Goffi <goffi@goffi.org>
parents: 1860
diff changeset
1510 It set stuff like progression callbacks and profile connection
6d9c87bdc452 jp (base): added a CommandBase.start method which is called by run or connected, so subclasses can implement it (this is for simplicity sake, as it's not always clear if run or connected must be used)
Goffi <goffi@goffi.org>
parents: 1860
diff changeset
1511 You should not overide this method: you should call self.start instead
6d9c87bdc452 jp (base): added a CommandBase.start method which is called by run or connected, so subclasses can implement it (this is for simplicity sake, as it's not always clear if run or connected must be used)
Goffi <goffi@goffi.org>
parents: 1860
diff changeset
1512 """
2155
cee6561ad086 jp (core): added extra_outputs:
Goffi <goffi@goffi.org>
parents: 2151
diff changeset
1513 # we keep a reference to run command, it may be useful e.g. for outputs
cee6561ad086 jp (core): added extra_outputs:
Goffi <goffi@goffi.org>
parents: 2151
diff changeset
1514 self.host.command = self
1863
b2ddd7f5dcdf jp (base): refactored need_loop so it is set only when the command is run. It can now be set in __init__ methods of commands classes
Goffi <goffi@goffi.org>
parents: 1862
diff changeset
1515
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1516 try:
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1517 show_progress = self.args.progress
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1518 except AttributeError:
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1519 # the command doesn't use progress bar
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1520 pass
1395
1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node
Goffi <goffi@goffi.org>
parents: 1290
diff changeset
1521 else:
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1522 if show_progress:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1523 self.host.watch_progress = True
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1524 # we need to register the following signal even if we don't display the
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1525 # progress bar
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1526 self.host.bridge.register_signal(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1527 "progress_started", self.progress_started_handler
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1528 )
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1529 self.host.bridge.register_signal(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1530 "progress_finished", self.progress_finished_handler
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1531 )
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1532 self.host.bridge.register_signal(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1533 "progress_error", self.progress_error_handler
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1534 )
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1535
1862
6d9c87bdc452 jp (base): added a CommandBase.start method which is called by run or connected, so subclasses can implement it (this is for simplicity sake, as it's not always clear if run or connected must be used)
Goffi <goffi@goffi.org>
parents: 1860
diff changeset
1536 if self.need_connect is not None:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1537 await self.host.connect_profile()
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1538 await self.start()
1862
6d9c87bdc452 jp (base): added a CommandBase.start method which is called by run or connected, so subclasses can implement it (this is for simplicity sake, as it's not always clear if run or connected must be used)
Goffi <goffi@goffi.org>
parents: 1860
diff changeset
1539
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1540 async def start(self):
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1541 """This is the starting point of the command, this method must be overriden
1862
6d9c87bdc452 jp (base): added a CommandBase.start method which is called by run or connected, so subclasses can implement it (this is for simplicity sake, as it's not always clear if run or connected must be used)
Goffi <goffi@goffi.org>
parents: 1860
diff changeset
1542
6d9c87bdc452 jp (base): added a CommandBase.start method which is called by run or connected, so subclasses can implement it (this is for simplicity sake, as it's not always clear if run or connected must be used)
Goffi <goffi@goffi.org>
parents: 1860
diff changeset
1543 at this point, profile are connected if needed
6d9c87bdc452 jp (base): added a CommandBase.start method which is called by run or connected, so subclasses can implement it (this is for simplicity sake, as it's not always clear if run or connected must be used)
Goffi <goffi@goffi.org>
parents: 1860
diff changeset
1544 """
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1545 raise NotImplementedError
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1546
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1547
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1548 class CommandAnswering(CommandBase):
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1549 """Specialised commands which answer to specific actions
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1550
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1551 to manage action_types answer,
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1552 """
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1553
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1554 action_callbacks = {} # XXX: set managed action types in a dict here:
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1555 # key is the action_type, value is the callable
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1556 # which will manage the answer. profile filtering is
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1557 # already managed when callback is called
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1558
2486
031aa3cc67ac jp (base): fixed assertion error when using CommandAnswering
Goffi <goffi@goffi.org>
parents: 2483
diff changeset
1559 def __init__(self, *args, **kwargs):
031aa3cc67ac jp (base): fixed assertion error when using CommandAnswering
Goffi <goffi@goffi.org>
parents: 2483
diff changeset
1560 super(CommandAnswering, self).__init__(*args, **kwargs)
031aa3cc67ac jp (base): fixed assertion error when using CommandAnswering
Goffi <goffi@goffi.org>
parents: 2483
diff changeset
1561
4041
2594e1951cf7 core (bridge): `action_new` now use serialised dict for extra data.
Goffi <goffi@goffi.org>
parents: 4037
diff changeset
1562 async def on_action_new(
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1563 self, action_data_s: str, action_id: str, security_limit: int, profile: str
4041
2594e1951cf7 core (bridge): `action_new` now use serialised dict for extra data.
Goffi <goffi@goffi.org>
parents: 4037
diff changeset
1564 ) -> None:
538
2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles
Goffi <goffi@goffi.org>
parents: 493
diff changeset
1565 if profile != self.profile:
2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles
Goffi <goffi@goffi.org>
parents: 493
diff changeset
1566 return
4041
2594e1951cf7 core (bridge): `action_new` now use serialised dict for extra data.
Goffi <goffi@goffi.org>
parents: 4037
diff changeset
1567 action_data = data_format.deserialise(action_data_s)
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1568 try:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1569 action_type = action_data["type"]
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1570 except KeyError:
1840
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1571 try:
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1572 xml_ui = action_data["xmlui"]
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1573 except KeyError:
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1574 pass
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1575 else:
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1576 self.on_xmlui(xml_ui)
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1577 else:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1578 try:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1579 callback = self.action_callbacks[action_type]
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1580 except KeyError:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1581 pass
0
goffi@necton2
parents:
diff changeset
1582 else:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1583 await callback(action_data, action_id, security_limit, profile)
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
1584
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1585 def on_xmlui(self, xml_ui):
1840
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1586 """Display a dialog received from the backend.
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1587
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1588 @param xml_ui (unicode): dialog XML representation
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1589 """
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1590 # FIXME: we temporarily use ElementTree, but a real XMLUI managing module
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1591 # should be available in the future
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1592 # TODO: XMLUI module
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1593 ui = ET.fromstring(xml_ui.encode("utf-8"))
1840
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1594 dialog = ui.find("dialog")
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1595 if dialog is not None:
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1596 self.disp(dialog.findtext("message"), error=dialog.get("level") == "error")
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1597
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1598 async def start_answering(self):
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1599 """Auto reply to confirmation requests"""
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1600 self.host.bridge.register_signal("action_new", self.on_action_new)
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3938
diff changeset
1601 actions = await self.host.bridge.actions_get(self.profile)
4041
2594e1951cf7 core (bridge): `action_new` now use serialised dict for extra data.
Goffi <goffi@goffi.org>
parents: 4037
diff changeset
1602 for action_data_s, action_id, security_limit in actions:
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1603 await self.on_action_new(
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1604 action_data_s, action_id, security_limit, self.profile
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4253
diff changeset
1605 )