Coverage for src/robotide/utils/__init__.py: 86%

1# Copyright 2008-2015 Nokia Networks 

2# Copyright 2016- Robot Framework Foundation 

3# 

4# Licensed under the Apache License, Version 2.0 (the "License"); 

5# you may not use this file except in compliance with the License. 

6# You may obtain a copy of the License at 

7# 

8# http://www.apache.org/licenses/LICENSE-2.0 

9# 

10# Unless required by applicable law or agreed to in writing, software 

11# distributed under the License is distributed on an "AS IS" BASIS, 

12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 

13# See the License for the specific language governing permissions and 

14# limitations under the License. 

15 

16import os 2 ctx1ab

17import re 2 ctx1ab

18import sys 2 ctx1ab

19import inspect 2 ctx1ab

20import subprocess 2 ctx1ab

21 

22import robotide.lib.robot.utils 2 ctx1ab

23from robotide.lib.robot.utils.encoding import SYSTEM_ENCODING 2 ctx1ab

24from robotide.lib.robot.utils import printable_name, normalize, _normalize, eq, ET, \ 2 ctx1ab

25 HtmlWriter, NormalizedDict, timestr_to_secs, secs_to_timestr, normpath,\ 

26 unic, asserts, unescape, html_escape, attribute_escape, robottime,\ 

27 get_timestamp, Matcher, is_list_like, is_dict_like, system_decode,\ 

28 ArgumentParser, get_error_details, is_unicode, is_string, py2to3 

29from .eventhandler import RideFSWatcherHandler 2 ctx1ab

30from .printing import Printing 2 ctx1ab

31 

32 

33def html_format(text): 2 ctx1ab

34 return robotide.lib.robot.utils.html_format(text) 2 ctx2]b^b

35 

36 

37def name_from_class(item, drop=None): 2 ctx1ab

38 cls = inspect.isclass(item) and item or item.__class__ (empty)

39 name = cls.__name__ (empty)

40 if drop and name.endswith(drop): (empty)

41 name = name[:-len(drop)] (empty)

42 return printable_name(name, code_style=True) (empty)

43 

44 

45def split_value(value, sep='|'): 2 ctx1ab

46 if not value: 69 ctx2a K Q p R L M yb+b,bzbAbBbCb-b.bDbEbFb/bGbHbo Ib:bJbKbLb;bMbNbObPbQbJ N d RbSbTb=bUbVbWb?bXbYbZb0b1b2b3b4b5b6b7b8b9b!b#b@b$b%b'b(be )b*bT

47 return [] 17 ctx2a Q p R +b,b-b.b/b:b;bMbNbJ =b?b@b

48 return [v.strip() for v in _split_value(value, sep)] 53 ctx2K L M ybzbAbBbCbDbEbFbGbHbo IbJbKbLbObPbQbJ N d RbSbTbUbVbWbXbYbZb0b1b2b3b4b5b6b7b8b9b!b#b$b%b'b(be )b*bT

49 

50 

51def _split_value(value, sep): 2 ctx1ab

52 if '\\' not in value: 53 ctx2K L M ybzbAbBbCbDbEbFbGbHbo IbJbKbLbObPbQbJ N d RbSbTbUbVbWbXbYbZb0b1b2b3b4b5b6b7b8b9b!b#b$b%b'b(be )b*bT

53 return value.split(sep) 52 ctx2K L M ybzbAbBbCbDbEbFbGbHbIbJbKbLbObPbQbJ N d RbSbTbUbVbWbXbYbZb0b1b2b3b4b5b6b7b8b9b!b#b$b%b'b(be )b*bT

54 ret = [] 2 ctx1oe

55 catenate_next = False 2 ctx1oe

56 for item in value.split(sep): 2 ctx1oe

57 bslash_count = len(item) - len(item.rstrip('\\')) 2 ctx1oe

58 escaped = bslash_count % 2 == 1 2 ctx1oe

59 if escaped: 2 ctx1oe

60 item = item[:-1] 2 ctx1oe

61 if catenate_next: 2 ctx1oe

62 ret[-1] += sep + item 2 ctx1oe

63 else: 

64 ret.append(item) 2 ctx1oe

65 catenate_next = escaped 2 ctx1oe

66 return ret 2 ctx1oe

67 

68 

69def join_value(value, sep='|', joiner=None): 2 ctx1ab

70 if not joiner: 70 ↛ 72line 70 didn't jump to line 72 because the condition on line 70 was always true1 ctx1T

71 joiner = ' %s ' % sep 1 ctx1T

72 return joiner.join([v.replace(sep, '\\' + sep) for v in value]) 1 ctx1T

73 

74 

75def find_from_pythonpath(name): 2 ctx1ab

76 for dirpath in sys.path: 23 ctx1apYZ0S12dcU3V4WX56789!#

77 if not os.path.isdir(dirpath): 23 ctx1apYZ0S12dcU3V4WX56789!#

78 continue 23 ctx1apYZ0S12dcU3V4WX56789!#

79 path = os.path.join(dirpath, name) 23 ctx1apYZ0S12dcU3V4WX56789!#

80 if os.path.isfile(path): 23 ctx1apYZ0S12dcU3V4WX56789!#

81 return path 9 ctx1acUVWX678

82 return None 20 ctx1apYZ0S12dcU3V4WX59!#

83 

84 

85def replace_extension(path, new_extension): 2 ctx1ab

86 base = path.rsplit('.', 1) 5 ctx2a [bMbS Nb

87 return '%s.%s' % (base[0], new_extension.lower()) 5 ctx2a [bMbS Nb

88 

89 

90def overrides(interface_class): 2 ctx1ab

91 # type: (object) -> object 

92 """ 

93 A decorator that can be used to validate method override 

94 

95 http://stackoverflow.com/questions/1167617/in-python-how-do-i-indicate-im-overriding-a-method/8313042#8313042 

96 """ 

97 def overrider(method): (empty)

98 assert(method.__name__ in dir(interface_class)) (empty)

99 return method (empty)

100 return overrider (empty)

101 

102 

103def is_same_drive(path1, path2): 2 ctx1ab

104 return os.path.splitdrive(path1)[0].lower() == \ 

105 os.path.splitdrive(path2)[0].lower() 

106 

107 

108def run_python_command(command, mode='c'): 2 ctx1ab

109 cmd = [sys.executable, '-{0}'.format(mode)] + command (empty)

110 # DEBUG: Let the user select which robot to use 

111 process = subprocess.Popen( (empty)

112 cmd, 

113 stdout=subprocess.PIPE, 

114 stderr=subprocess.PIPE) 

115 output, _ = process.communicate() (empty)

116 return output (empty)

117 

118 

119def converttypes(data, prefer_str=True): 2 ctx1ab

120 """ 

121 Convert all types from Python2 to Python3 

122 """ 

123 enc = sys.stdout and sys.stdout.encoding or "utf-8" 

124 data_type = type(data) 

125 

126 if data_type == bytes: 

127 if prefer_str: 

128 return str(data.decode(enc)) 

129 return data.decode(enc) 

130 if data_type in (str, int): 

131 return str(data) 

132 

133 if data_type == dict: 

134 data = data.items() 

135 return data_type(map(converttypes, data)) 

136 

137 

138_regexps = (re.compile(r'(\\+)r\\n'), 2 ctx1ab

139 re.compile(r'(\\+)n'), 

140 re.compile(r'(\\+)r'), 

141 re.compile(r'(\\+) ')) 

142 

143 

144def unescape_newlines_and_whitespaces(item): 2 ctx1ab

145 for regexp in _regexps: 14 ctx2a O P nbobpbqbrbsbtbubvbwbxb

146 if regexp.pattern.endswith(' '): 14 ctx2a O P nbobpbqbrbsbtbubvbwbxb

147 item = regexp.sub(_whitespace_replacer, item) 14 ctx2a O P nbobpbqbrbsbtbubvbwbxb

148 else: 

149 item = regexp.sub(_newline_replacer, item) 14 ctx2a O P nbobpbqbrbsbtbubvbwbxb

150 return item 14 ctx2a O P nbobpbqbrbsbtbubvbwbxb

151 

152 

153def _whitespace_replacer(match): 2 ctx1ab

154 return _replacer(' ', match) (empty)

155 

156 

157def _newline_replacer(match): 2 ctx1ab

158 return _replacer(os.linesep, match) 3 ctx1aOP

159 

160 

161def _replacer(char, match): 2 ctx1ab

162 slashes = len(match.group(1)) 3 ctx1aOP

163 if slashes % 2 == 1: 3 ctx1aOP

164 return '\\' * (slashes - 1) + char 3 ctx1aOP

165 return match.group() 2 ctx1aO

166 

167 

168def normalize_lc(string, remove='', spaces=True): 2 ctx1ab

169 string = string.lower() 77 ctx2a $ K Q p R L M % ' ( ) * + , - . / : ; = ? @ [ ] ^ _ ` { | } ~ abbbcbdbebfbgbhbJ N d ibf q r s t u v w x y z g A B C D E F G H h c i j k l I m n jbkblbmb

170 if spaces: 77 ctx2a $ K Q p R L M % ' ( ) * + , - . / : ; = ? @ [ ] ^ _ ` { | } ~ abbbcbdbebfbgbhbJ N d ibf q r s t u v w x y z g A B C D E F G H h c i j k l I m n jbkblbmb

171 remove = remove + ' ' 30 ctx1afqrstuvwxyzgABCDEFGHhcijklImn

172 for char in remove: 77 ctx2a $ K Q p R L M % ' ( ) * + , - . / : ; = ? @ [ ] ^ _ ` { | } ~ abbbcbdbebfbgbhbJ N d ibf q r s t u v w x y z g A B C D E F G H h c i j k l I m n jbkblbmb

173 if char in string: 30 ctx1afqrstuvwxyzgABCDEFGHhcijklImn

174 string = string.replace(char, '') 30 ctx1afqrstuvwxyzgABCDEFGHhcijklImn

175 return string 77 ctx2a $ K Q p R L M % ' ( ) * + , - . / : ; = ? @ [ ] ^ _ ` { | } ~ abbbcbdbebfbgbhbJ N d ibf q r s t u v w x y z g A B C D E F G H h c i j k l I m n jbkblbmb

176 

177 

178def normalize_dict(table: dict) -> dict: 2 ctx1ab

179 ndict = {} 30 ctx1afqrstuvwxyzgABCDEFGHhcijklImn

180 for key, value in table.items(): 30 ctx1afqrstuvwxyzgABCDEFGHhcijklImn

181 if key: 30 ctx1afqrstuvwxyzgABCDEFGHhcijklImn

182 k = normalize_lc(key) 30 ctx1afqrstuvwxyzgABCDEFGHhcijklImn

183 v = normalize_lc(value) 30 ctx1afqrstuvwxyzgABCDEFGHhcijklImn

184 ndict[k] = v 30 ctx1afqrstuvwxyzgABCDEFGHhcijklImn

185 return ndict 30 ctx1afqrstuvwxyzgABCDEFGHhcijklImn

186 

187 

188def normalize_pipe_list(data: list, spaces: bool = True) -> str: 2 ctx1ab

189 pipe_list = "|".join(data) 58 ctx2a $ K Q p R L M % ' ( ) * + , - . / : ; = ? @ [ ] ^ _ ` { | } ~ abbbcbdbebfbgbhbJ N d ibf g h c i j k l m n jbkblbmb

190 return normalize_lc(pipe_list, spaces=spaces) 58 ctx2a $ K Q p R L M % ' ( ) * + , - . / : ; = ? @ [ ] ^ _ ` { | } ~ abbbcbdbebfbgbhbJ N d ibf g h c i j k l m n jbkblbmb

191