comparison sat/tools/common/regex.py @ 2562:26edcf3a30eb

core, setup: huge cleaning: - moved directories from src and frontends/src to sat and sat_frontends, which is the recommanded naming convention - move twisted directory to root - removed all hacks from setup.py, and added missing dependencies, it is now clean - use https URL for website in setup.py - removed "Environment :: X11 Applications :: GTK", as wix is deprecated and removed - renamed sat.sh to sat and fixed its installation - added python_requires to specify Python version needed - replaced glib2reactor which use deprecated code by gtk3reactor sat can now be installed directly from virtualenv without using --system-site-packages anymore \o/
author Goffi <goffi@goffi.org>
date Mon, 02 Apr 2018 19:44:50 +0200
parents src/tools/common/regex.py@0046283a285d
children 56f94936df1e
comparison
equal deleted inserted replaced
2561:bd30dc3ffe5a 2562:26edcf3a30eb
1 #!/usr/bin/env python2
2 # -*- coding: utf-8 -*-
3
4 # Salut à Toi: an XMPP client
5 # Copyright (C) 2009-2018 Jérôme Poisson (goffi@goffi.org)
6
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU Affero General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
11
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU Affero General Public License for more details.
16
17 # You should have received a copy of the GNU Affero General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
19
20 """ regex tools common to backend and frontends """
21
22 import re
23 path_escape = {'%': '%25', '/': '%2F', '\\': '%5c'}
24 path_escape_rev = {re.escape(v):k for k, v in path_escape.iteritems()}
25 path_escape = {re.escape(k):v for k, v in path_escape.iteritems()}
26 # thanks to Martijn Pieters (https://stackoverflow.com/a/14693789)
27 RE_ANSI_REMOVE = re.compile(r'\x1b[^m]*m')
28
29
30 def reJoin(exps):
31 """Join (OR) various regexes"""
32 return re.compile('|'.join(exps))
33
34
35 def reSubDict(pattern, repl_dict, string):
36 """Replace key, value found in dict according to pattern
37
38 @param pattern(basestr): pattern using keys found in repl_dict
39 @repl_dict(dict): keys found in this dict will be replaced by
40 corresponding values
41 @param string(basestr): string to use for the replacement
42 """
43 return pattern.sub(lambda m: repl_dict[re.escape(m.group(0))], string)
44
45 path_escape_re = reJoin(path_escape.keys())
46 path_escape_rev_re = reJoin(path_escape_rev.keys())
47
48
49 def pathEscape(string):
50 """Escape string so it can be use in a file path
51
52 @param string(basestr): string to escape
53 @return (str, unicode): escaped string, usable in a file path
54 """
55 return reSubDict(path_escape_re, path_escape, string)
56
57
58 def pathUnescape(string):
59 """Unescape string from value found in file path
60
61 @param string(basestr): string found in file path
62 @return (str, unicode): unescaped string
63 """
64 return reSubDict(path_escape_rev_re, path_escape_rev, string)
65
66 def ansiRemove(string):
67 """Remove ANSI escape codes from string
68
69 @param string(basestr): string to filter
70 @return (str, unicode): string without ANSI escape codes
71 """
72 return RE_ANSI_REMOVE.sub('', string)