Mercurial > libervia-backend
annotate sat/tools/common/regex.py @ 3101:ab7e8ade848a
plugin XEP-0045: added room statuses to metadata:
room statuses are now sent with other metadata on bridge signals, and saved in Room
instance. They give useful data on the room, for instance they can be used to know if a
full jid is used in this room.
author | Goffi <goffi@goffi.org> |
---|---|
date | Mon, 30 Dec 2019 20:44:02 +0100 |
parents | ab2696e34d29 |
children | 9d0df638c8b4 |
rev | line source |
---|---|
3028 | 1 #!/usr/bin/env python3 |
1920
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
2 # -*- coding: utf-8 -*- |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
3 |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
4 # Salut à Toi: an XMPP client |
2771 | 5 # Copyright (C) 2009-2019 Jérôme Poisson (goffi@goffi.org) |
1920
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
6 |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
7 # This program is free software: you can redistribute it and/or modify |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
8 # it under the terms of the GNU Affero General Public License as published by |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
9 # the Free Software Foundation, either version 3 of the License, or |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
10 # (at your option) any later version. |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
11 |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
12 # This program is distributed in the hope that it will be useful, |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
15 # GNU Affero General Public License for more details. |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
16 |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
17 # You should have received a copy of the GNU Affero General Public License |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
18 # along with this program. If not, see <http://www.gnu.org/licenses/>. |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
19 |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
20 """ regex tools common to backend and frontends """ |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
21 |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
22 import re |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
23 |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
24 path_escape = {"%": "%25", "/": "%2F", "\\": "%5c"} |
3028 | 25 path_escape_rev = {re.escape(v): k for k, v in path_escape.items()} |
26 path_escape = {re.escape(k): v for k, v in path_escape.items()} | |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
27 # thanks to Martijn Pieters (https://stackoverflow.com/a/14693789) |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
28 RE_ANSI_REMOVE = re.compile(r"\x1b[^m]*m") |
1920
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
29 |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
30 |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
31 def reJoin(exps): |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
32 """Join (OR) various regexes""" |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
33 return re.compile("|".join(exps)) |
1920
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
34 |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
35 |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
36 def reSubDict(pattern, repl_dict, string): |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
37 """Replace key, value found in dict according to pattern |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
38 |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
39 @param pattern(basestr): pattern using keys found in repl_dict |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
40 @repl_dict(dict): keys found in this dict will be replaced by |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
41 corresponding values |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
42 @param string(basestr): string to use for the replacement |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
43 """ |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
44 return pattern.sub(lambda m: repl_dict[re.escape(m.group(0))], string) |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
45 |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
46 |
3028 | 47 path_escape_re = reJoin(list(path_escape.keys())) |
48 path_escape_rev_re = reJoin(list(path_escape_rev.keys())) | |
1920
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
49 |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
50 |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
51 def pathEscape(string): |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
52 """Escape string so it can be use in a file path |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
53 |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
54 @param string(basestr): string to escape |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
55 @return (str, unicode): escaped string, usable in a file path |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
56 """ |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
57 return reSubDict(path_escape_re, path_escape, string) |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
58 |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
59 |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
60 def pathUnescape(string): |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
61 """Unescape string from value found in file path |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
62 |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
63 @param string(basestr): string found in file path |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
64 @return (str, unicode): unescaped string |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
65 """ |
03526c8abeb0
tools (common): added regex module with path (un)escaping methods
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
66 return reSubDict(path_escape_rev_re, path_escape_rev, string) |
2297
ad2a8e8b52da
core (tools/common/regex): new ansiRemove method to remove ANSI escape codes from a string
Goffi <goffi@goffi.org>
parents:
1934
diff
changeset
|
67 |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
68 |
2297
ad2a8e8b52da
core (tools/common/regex): new ansiRemove method to remove ANSI escape codes from a string
Goffi <goffi@goffi.org>
parents:
1934
diff
changeset
|
69 def ansiRemove(string): |
ad2a8e8b52da
core (tools/common/regex): new ansiRemove method to remove ANSI escape codes from a string
Goffi <goffi@goffi.org>
parents:
1934
diff
changeset
|
70 """Remove ANSI escape codes from string |
ad2a8e8b52da
core (tools/common/regex): new ansiRemove method to remove ANSI escape codes from a string
Goffi <goffi@goffi.org>
parents:
1934
diff
changeset
|
71 |
ad2a8e8b52da
core (tools/common/regex): new ansiRemove method to remove ANSI escape codes from a string
Goffi <goffi@goffi.org>
parents:
1934
diff
changeset
|
72 @param string(basestr): string to filter |
ad2a8e8b52da
core (tools/common/regex): new ansiRemove method to remove ANSI escape codes from a string
Goffi <goffi@goffi.org>
parents:
1934
diff
changeset
|
73 @return (str, unicode): string without ANSI escape codes |
ad2a8e8b52da
core (tools/common/regex): new ansiRemove method to remove ANSI escape codes from a string
Goffi <goffi@goffi.org>
parents:
1934
diff
changeset
|
74 """ |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
75 return RE_ANSI_REMOVE.sub("", string) |