Mercurial > libervia-backend
annotate sat_frontends/jp/constants.py @ 2593:d78eff6b4487
tools (common): new files_utils module:
get_unique_name find a name not conflicting with an existing file
author | Goffi <goffi@goffi.org> |
---|---|
date | Fri, 25 May 2018 10:52:01 +0200 |
parents | 26edcf3a30eb |
children | 12bf089f0bf3 |
rev | line source |
---|---|
1934
2daf7b4c6756
use of /usr/bin/env instead of /usr/bin/python in shebang
Goffi <goffi@goffi.org>
parents:
1766
diff
changeset
|
1 #!/usr/bin/env python2 |
970
2e052998c7eb
jp: using C.APP_URL for application url
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
2 # -*- coding: utf-8 -*- |
2e052998c7eb
jp: using C.APP_URL for application url
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
3 |
2e052998c7eb
jp: using C.APP_URL for application url
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
4 # Primitivus: a SAT frontend |
2483 | 5 # Copyright (C) 2009-2018 Jérôme Poisson (goffi@goffi.org) |
970
2e052998c7eb
jp: using C.APP_URL for application url
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
6 |
2e052998c7eb
jp: using C.APP_URL for application url
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
7 # This program is free software: you can redistribute it and/or modify |
2e052998c7eb
jp: using C.APP_URL for application url
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
8 # it under the terms of the GNU Affero General Public License as published by |
2e052998c7eb
jp: using C.APP_URL for application url
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
9 # the Free Software Foundation, either version 3 of the License, or |
2e052998c7eb
jp: using C.APP_URL for application url
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
10 # (at your option) any later version. |
2e052998c7eb
jp: using C.APP_URL for application url
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
11 |
2e052998c7eb
jp: using C.APP_URL for application url
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
12 # This program is distributed in the hope that it will be useful, |
2e052998c7eb
jp: using C.APP_URL for application url
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of |
2e052998c7eb
jp: using C.APP_URL for application url
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
2e052998c7eb
jp: using C.APP_URL for application url
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
15 # GNU Affero General Public License for more details. |
2e052998c7eb
jp: using C.APP_URL for application url
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
16 |
2e052998c7eb
jp: using C.APP_URL for application url
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
17 # You should have received a copy of the GNU Affero General Public License |
2e052998c7eb
jp: using C.APP_URL for application url
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
18 # along with this program. If not, see <http://www.gnu.org/licenses/>. |
2e052998c7eb
jp: using C.APP_URL for application url
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
19 |
2e052998c7eb
jp: using C.APP_URL for application url
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
20 from sat_frontends.quick_frontend import constants |
2232
4f389486667d
jp: added constant to handle ANSI code for header and subheaders
Goffi <goffi@goffi.org>
parents:
2190
diff
changeset
|
21 from sat.tools.common.ansi import ANSI as A |
970
2e052998c7eb
jp: using C.APP_URL for application url
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
22 |
2e052998c7eb
jp: using C.APP_URL for application url
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
23 |
2e052998c7eb
jp: using C.APP_URL for application url
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
24 class Const(constants.Const): |
2e052998c7eb
jp: using C.APP_URL for application url
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
25 |
2163
75667727c500
jp (output): template output first draft:
Goffi <goffi@goffi.org>
parents:
2156
diff
changeset
|
26 APP_NAME = u"jp" |
75667727c500
jp (output): template output first draft:
Goffi <goffi@goffi.org>
parents:
2156
diff
changeset
|
27 PLUGIN_CMD = u"commands" |
75667727c500
jp (output): template output first draft:
Goffi <goffi@goffi.org>
parents:
2156
diff
changeset
|
28 PLUGIN_OUTPUT = u"outputs" |
75667727c500
jp (output): template output first draft:
Goffi <goffi@goffi.org>
parents:
2156
diff
changeset
|
29 OUTPUT_TEXT = u'text' # blob of unicode text |
75667727c500
jp (output): template output first draft:
Goffi <goffi@goffi.org>
parents:
2156
diff
changeset
|
30 OUTPUT_DICT = u'dict' # simple key/value dictionary |
75667727c500
jp (output): template output first draft:
Goffi <goffi@goffi.org>
parents:
2156
diff
changeset
|
31 OUTPUT_LIST = u'list' |
2233
bf998d8626d9
jp (output): added LIST_DICT output, to handle list of dictionaries
Goffi <goffi@goffi.org>
parents:
2232
diff
changeset
|
32 OUTPUT_LIST_DICT = u'list_dict' # list of dictionaries |
2295
31f586d6ab16
jp (constants): added OUTPUT_DICT_DICT for dictionaries of nested dictionaries
Goffi <goffi@goffi.org>
parents:
2278
diff
changeset
|
33 OUTPUT_DICT_DICT = u'dict_dict' # dict of nested dictionaries |
2163
75667727c500
jp (output): template output first draft:
Goffi <goffi@goffi.org>
parents:
2156
diff
changeset
|
34 OUTPUT_COMPLEX = u'complex' # complex data (e.g. multi-level dictionary) |
2190
d823a0cdbcc2
jp (outputs): new xml and list_xml outputs, handling pretty formatting and syntax highlighting
Goffi <goffi@goffi.org>
parents:
2163
diff
changeset
|
35 OUTPUT_XML = u'xml' # XML node (as unicode string) |
d823a0cdbcc2
jp (outputs): new xml and list_xml outputs, handling pretty formatting and syntax highlighting
Goffi <goffi@goffi.org>
parents:
2163
diff
changeset
|
36 OUTPUT_LIST_XML = u'list_xml' # list of XML nodes (as unicode strings) |
2295
31f586d6ab16
jp (constants): added OUTPUT_DICT_DICT for dictionaries of nested dictionaries
Goffi <goffi@goffi.org>
parents:
2278
diff
changeset
|
37 OUTPUT_TYPES = (OUTPUT_TEXT, OUTPUT_DICT, OUTPUT_LIST, OUTPUT_LIST_DICT, OUTPUT_DICT_DICT, OUTPUT_COMPLEX, OUTPUT_XML, OUTPUT_LIST_XML) |
1951
ac89f455fcbf
jp: added consts for exit codes, not used yet
Goffi <goffi@goffi.org>
parents:
1950
diff
changeset
|
38 |
2532 | 39 # Pubsub options flags |
40 SERVICE = u'service' # service required | |
41 NODE = u'node' # node required | |
2552
38e1e29c48e9
jp (base): added C.ITEM pubsub flag when --item is required
Goffi <goffi@goffi.org>
parents:
2550
diff
changeset
|
42 ITEM = u'item' # item required |
2532 | 43 SINGLE_ITEM = u'single_item' # only one item is allowed |
44 MULTI_ITEMS = u'multi_items' # multiple items are allowed | |
2539 | 45 NO_MAX = u'no_max' # don't add --max option for multi items |
2532 | 46 |
2232
4f389486667d
jp: added constant to handle ANSI code for header and subheaders
Goffi <goffi@goffi.org>
parents:
2190
diff
changeset
|
47 # ANSI |
4f389486667d
jp: added constant to handle ANSI code for header and subheaders
Goffi <goffi@goffi.org>
parents:
2190
diff
changeset
|
48 A_HEADER = A.BOLD + A.FG_YELLOW |
4f389486667d
jp: added constant to handle ANSI code for header and subheaders
Goffi <goffi@goffi.org>
parents:
2190
diff
changeset
|
49 A_SUBHEADER = A.BOLD + A.FG_RED |
2485
512c443a58ba
jp (forums): forums handling commands, first draft
Goffi <goffi@goffi.org>
parents:
2483
diff
changeset
|
50 # A_LEVEL_COLORS may be used to cycle on colors according to depth of data |
512c443a58ba
jp (forums): forums handling commands, first draft
Goffi <goffi@goffi.org>
parents:
2483
diff
changeset
|
51 A_LEVEL_COLORS = (A_HEADER, A.BOLD + A.FG_BLUE, A.FG_MAGENTA, A.FG_CYAN) |
2278
489efbda377c
jp (input): input command first draft:
Goffi <goffi@goffi.org>
parents:
2268
diff
changeset
|
52 A_SUCCESS = A.BOLD + A.FG_GREEN |
489efbda377c
jp (input): input command first draft:
Goffi <goffi@goffi.org>
parents:
2268
diff
changeset
|
53 A_FAILURE = A.BOLD + A.FG_RED |
2309
c7a72b75232b
jp (shell): shell command (REPL mode), first draft:
Goffi <goffi@goffi.org>
parents:
2295
diff
changeset
|
54 # A_PROMPT_* is for shell |
2355 | 55 A_PROMPT_PATH = A.BOLD + A.FG_CYAN |
2309
c7a72b75232b
jp (shell): shell command (REPL mode), first draft:
Goffi <goffi@goffi.org>
parents:
2295
diff
changeset
|
56 A_PROMPT_SUF = A.BOLD |
2505
8e770ac05b0c
jp (file): file sharing + improvments:
Goffi <goffi@goffi.org>
parents:
2485
diff
changeset
|
57 # Files |
8e770ac05b0c
jp (file): file sharing + improvments:
Goffi <goffi@goffi.org>
parents:
2485
diff
changeset
|
58 A_DIRECTORY = A.BOLD + A.FG_CYAN |
8e770ac05b0c
jp (file): file sharing + improvments:
Goffi <goffi@goffi.org>
parents:
2485
diff
changeset
|
59 A_FILE = A.FG_WHITE |
2232
4f389486667d
jp: added constant to handle ANSI code for header and subheaders
Goffi <goffi@goffi.org>
parents:
2190
diff
changeset
|
60 |
1951
ac89f455fcbf
jp: added consts for exit codes, not used yet
Goffi <goffi@goffi.org>
parents:
1950
diff
changeset
|
61 # exit codes |
ac89f455fcbf
jp: added consts for exit codes, not used yet
Goffi <goffi@goffi.org>
parents:
1950
diff
changeset
|
62 EXIT_OK = 0 |
2550
1d754bc14381
jp (base): new confirmOrQuit helper method to ask confirmation to user, and quit if he cancel
Goffi <goffi@goffi.org>
parents:
2539
diff
changeset
|
63 EXIT_ERROR = 1 # generic error, when nothing else match |
1d754bc14381
jp (base): new confirmOrQuit helper method to ask confirmation to user, and quit if he cancel
Goffi <goffi@goffi.org>
parents:
2539
diff
changeset
|
64 EXIT_BAD_ARG = 2 # arguments given by user are bad |
1d754bc14381
jp (base): new confirmOrQuit helper method to ask confirmation to user, and quit if he cancel
Goffi <goffi@goffi.org>
parents:
2539
diff
changeset
|
65 EXIT_BRIDGE_ERROR = 3 # can't connect to bridge |
1d754bc14381
jp (base): new confirmOrQuit helper method to ask confirmation to user, and quit if he cancel
Goffi <goffi@goffi.org>
parents:
2539
diff
changeset
|
66 EXIT_BRIDGE_ERRBACK = 4 # something went wrong when calling a bridge method |
1d754bc14381
jp (base): new confirmOrQuit helper method to ask confirmation to user, and quit if he cancel
Goffi <goffi@goffi.org>
parents:
2539
diff
changeset
|
67 EXIT_NOT_FOUND = 16 # an item required by a command was not found |
1d754bc14381
jp (base): new confirmOrQuit helper method to ask confirmation to user, and quit if he cancel
Goffi <goffi@goffi.org>
parents:
2539
diff
changeset
|
68 EXIT_DATA_ERROR = 17 # data needed for a command is invalid |
1d754bc14381
jp (base): new confirmOrQuit helper method to ask confirmation to user, and quit if he cancel
Goffi <goffi@goffi.org>
parents:
2539
diff
changeset
|
69 EXIT_USER_CANCELLED = 20 # user cancelled action |
1d754bc14381
jp (base): new confirmOrQuit helper method to ask confirmation to user, and quit if he cancel
Goffi <goffi@goffi.org>
parents:
2539
diff
changeset
|
70 EXIT_FILE_NOT_EXE = 126 # a file to be executed was found, but it was not an executable utility (cf. man 1 exit) |
1d754bc14381
jp (base): new confirmOrQuit helper method to ask confirmation to user, and quit if he cancel
Goffi <goffi@goffi.org>
parents:
2539
diff
changeset
|
71 EXIT_CMD_NOT_FOUND = 127 # a utility to be executed was not found (cf. man 1 exit) |
1d754bc14381
jp (base): new confirmOrQuit helper method to ask confirmation to user, and quit if he cancel
Goffi <goffi@goffi.org>
parents:
2539
diff
changeset
|
72 EXIT_SIGNAL_INT = 128 # a command was interrupted by a signal (cf. man 1 exit) |