Coverage for src/lcdoc/tools.py: 60.31%

Hot-keys on this page

r m x p toggle line displays

j k next/prev highlighted chunk

0 (zero) top of page

1 (one) first highlighted chunk

1"""

2Common tools for all modules

4"""

5import collections 2 ctxlppytest

6import hashlib 2 ctxlppytest

7import json 2 ctxlppytest

8import os 2 ctxlppytest

9import socket 2 ctxlppytest

10import sys 2 ctxlppytest

11import time 2 ctxlppytest

13import toml 2 ctxlppytest

15from lcdoc.log import app, now 2 ctxlppytest

17exists = os.path.exists 2 ctxlppytest

19# fastest algo:

20def file_hash(fn, algo='blake2b'): 2 ctxlppytest

21 return getattr(hashlib, algo)(open(fn, 'rb').read()).hexdigest() 1 ctxlp|features/lp/plugs/drawio/index.md

24def dirname(fn, create=False): 2 ctxlppytest

27 os.makedirs(d, exist_ok=True)

31def require(cmd, name=None, die=True, _have=set()): 2 ctxlppytest

32 '''cmd e.g. "rg --version"'''

36 if os.system(cmd + ' >/dev/null') == 0: 36 ↛ 40line 36 didn't jump to line 40, because the condition on line 36 was never false2 ctxlplp|features/lp/eval.md

37 _have.add(cmd) 2 ctxlplp|features/lp/eval.md

38 return True 2 ctxlplp|features/lp/eval.md

40 msg = 'Missing required command: %s' % name

41 if die:

42 app.die(msg, tried=cmd)

43 else:

44 app.warning(msg, tried=cmd)

45 return False

48def hostname(c=[0]): 2 ctxlppytest

49 i = c[0]

50 if i:

51 return i

52 c[0] = socket.gethostname()

53 return c[0]

56def into(d, k, v): 2 ctxlppytest

57 """the return is important for e.g. rx"""

58 d[k] = v

59 return d

62def to_list(o): 2 ctxlppytest

63 o = [] if o is None else o 2 ctxlp|features/lp/python/call_flow_logging/index.mdpytest|tests.test_cfl.test_one

64 t = type(o) 2 ctxlp|features/lp/python/call_flow_logging/index.mdpytest|tests.test_cfl.test_one

65 return o if t == list else list(o) if t == tuple else [o] 2 ctxlp|features/lp/python/call_flow_logging/index.mdpytest|tests.test_cfl.test_one

68# ----------------------------------------------------------------------------- file ops

69def walk_dir(directory, crit=None): 2 ctxlppytest

70 crit = (lambda *a: True) if crit is None else crit

71 files = []

72 j = os.path.join

73 for (dirpath, dirnames, filenames) in os.walk(directory):

74 files += [j(dirpath, file) for file in filenames if crit(dirpath, file)]

75 return files

78def read_file(fn, dflt=None, bytes=-1, strip_comments=False): 2 ctxlppytest

79 """

80 API function.

81 read a file - return a default if it does not exist"""

85 raise Exception(fn, 'does not exist')

87 # no idea why but __etc__hostname always contains a linesep at end

88 # not present in source => rstrip(), hope this does not break templs

92 lines = res.splitlines()

93 res = '\n'.join([l for l in lines if not l.startswith('#')])

97def insert_file(fn, content, sep): 2 ctxlppytest

98 s = read_file(fn).split(sep) 1 ctxlp|index.md

99 if not len(s) == 3: 99 ↛ 100line 99 didn't jump to line 100, because the condition on line 99 was never true1 ctxlp|index.md

100 raise Exception(f'No 2 times occurrance of sep in file. sep: {sep}, fn: {fn}')

101 write_file(fn, s[0] + sep + content + sep + s[2]) 1 ctxlp|index.md

102

103

104def write_file(fn, s, log=0, mkdir=0, chmod=None, mode='w', only_on_change=False): 2 ctxlppytest

105 'API: Write a file. chmod e.g. 0o755 (as octal integer)'

106

108

110 s = '\n'.join(s)

112 so = read_file(fn, dflt='xxx') 3 ctxlp|features/lp/parameters.mdlp|features/lp/plugs/make_badges/index.mdlp|index.md

113 if s == so: 3 ctxlp|features/lp/parameters.mdlp|features/lp/plugs/make_badges/index.mdlp|index.md

114 return 1 ctxlp|index.md

115

117 app.info('Writing file', fn=fn)

119 sep = '\n----------------------\n'

120 ps = (

121 s

122 if not 'key' in fn and not 'assw' in fn and not 'ecret' in fn

123 else '<hidden>'

124 )

125 app.debug('Content', content=sep + ps + sep[:-1])

132 if not isinstance(chmod, (list, tuple)):

133 chmod = [int(chmod)]

134 for s in chmod:

135 os.chmod(fn, s)

137 except IOError as ex: 137 ↛ 144line 137 didn't jump to line 1441 ctxlp|features/lp/python/call_flow_logging/index.md

138 if mkdir: 138 ↛ 143line 138 didn't jump to line 143, because the condition on line 138 was never false1 ctxlp|features/lp/python/call_flow_logging/index.md

139 mkdir = 0 1 ctxlp|features/lp/python/call_flow_logging/index.md

140 d = os.path.dirname(fn) 1 ctxlp|features/lp/python/call_flow_logging/index.md

141 os.makedirs(d) 1 ctxlp|features/lp/python/call_flow_logging/index.md

142 continue 1 ctxlp|features/lp/python/call_flow_logging/index.md

143 e = ex

144 except Exception as ex:

145 e = ex

146 app.die('Could not write file', filename=fn, exc=e)

147

148

149have_tty = lambda: sys.stdin.isatty() and sys.stdout.isatty() 149 ↛ exitline 149 didn't run the lambda on line 1492 ctxlppytest

150

151

152def flatten(d, sep='_', tpljoin=None): 2 ctxlppytest

153 """when tpljoin is given we detect them as keys and join

154 (enables json serialization)"""

155

156 obj = collections.OrderedDict() 1 ctxlp

157

158 def recurse(t, parent_key=''): 1 ctxlp

159

160 if isinstance(t, list): 1 ctxlp

161 for i in range(len(t)): 1 ctxlp

162 recurse(t[i], parent_key + sep + str(i) if parent_key else str(i)) 1 ctxlp

163 elif isinstance(t, dict): 1 ctxlp

164 for k, v in t.items(): 1 ctxlp

165 if isinstance(k, tuple): 165 ↛ 166line 165 didn't jump to line 166, because the condition on line 165 was never true1 ctxlp

166 k = tpljoin.join(k)

167 recurse(v, parent_key + sep + k if parent_key else k) 1 ctxlp

168 else:

169 obj[parent_key] = t 1 ctxlp

170

171 recurse(d) 1 ctxlp

172

173 return obj 1 ctxlp

174

175

176class project: 2 ctxlppytest

177 """loads the project config

178

179 Main app config put into project.cfg['app']

180 An optional tool.lc.app section will be merged into that

181

182 TODO: other formats than pyproject.toml

183

184 """

185

186 config, dir_home, fn_cfg = {}, None, None 2 ctxlppytest

187

188 def root(config=None, root=None, c=[0]): 2 ctxlppytest

189 # config maybe given. Understood currently: mkdocs config

191 c[0] = root # for tests, to force it 1 ctxpytest

194 ret = 0 2 ctxlppytest

195 try: 2 ctxlppytest

196 if config and hasattr(config, '__getitem__'): 196 ↛ 202line 196 didn't jump to line 202, because the condition on line 196 was never false2 ctxlppytest

197 dd = config.get('docs_dir') 2 ctxlppytest

198 if dd: 198 ↛ 202line 198 didn't jump to line 202, because the condition on line 198 was never false2 ctxlppytest

199 ret = dirname(dd) 2 ctxlppytest

200 return ret 2 ctxlppytest

201 # todo: look at git here

202 raise Exception('Cannot derive project root')

203 finally:

204 c[0] = ret 2 ctxlppytest

205

206 fn_config = lambda: project.root() + '/pyproject.toml' 4 ctxlplp|features/lp/plugs/make_badges/index.mdlp|index.mdpytest

207 d_autodocs = lambda: project.root() + '/build/autodocs' 207 ↛ exitline 207 didn't run the lambda on line 2072 ctxlppytest

208

209 def abs_path(fn, config=None, mkdirs=False): 2 ctxlppytest

210 r = project.root(config)

211 if not fn:

212 return r

213 if fn[0] != '/':

214 fn = r + '/' + fn

215 if mkdirs:

216 os.makedirs(dirname(fn), exist_ok=True)

217 return fn

218

219 # TODO: understand also poetry and piptools:

220 def load_config(): 2 ctxlppytest

221

222 fn = project.fn_config() 2 ctxlp|features/lp/plugs/make_badges/index.mdlp|index.md

223 if not exists(fn): 223 ↛ 224line 223 didn't jump to line 224, because the condition on line 223 was never true2 ctxlp|features/lp/plugs/make_badges/index.mdlp|index.md

224 app.die('no config found', fn=fn)

225

226 cfg = toml.load(fn) 2 ctxlp|features/lp/plugs/make_badges/index.mdlp|index.md

227 app.info('loaded config', filename=fn) 2 ctxlp|features/lp/plugs/make_badges/index.mdlp|index.md

228 c = project.config 2 ctxlp|features/lp/plugs/make_badges/index.mdlp|index.md

229 c.update(cfg) 2 ctxlp|features/lp/plugs/make_badges/index.mdlp|index.md

230 if not 'project' in c: 230 ↛ 231line 230 didn't jump to line 231, because the condition on line 230 was never true2 ctxlp|features/lp/plugs/make_badges/index.mdlp|index.md

231 c['project'] = {'urls': {}}

232 if 'tool' in c and 'poetry' in c['tool']: 232 ↛ 237line 232 didn't jump to line 237, because the condition on line 232 was never false2 ctxlp|features/lp/plugs/make_badges/index.mdlp|index.md

233 c['project'].update(c['tool']['poetry']) 2 ctxlp|features/lp/plugs/make_badges/index.mdlp|index.md

234 c['project']['urls']['homepage'] = c['project']['homepage'] 2 ctxlp|features/lp/plugs/make_badges/index.mdlp|index.md

235 c['project']['urls']['repository'] = c['project']['repository'] 2 ctxlp|features/lp/plugs/make_badges/index.mdlp|index.md

236

237 t = cfg['tool'] 2 ctxlp|features/lp/plugs/make_badges/index.mdlp|index.md

238 # breakpoint() # FIXME BREAKPOINT

239 # c['app'] = t['poetry']

240 # c['app'].update(t.get('lc', {}).get('app', {}))

241 project.fn_cfg = fn 2 ctxlp|features/lp/plugs/make_badges/index.mdlp|index.md

242 # app.die('Did not find a pyproject.toml file with badges declared')

243 return project.config 2 ctxlp|features/lp/plugs/make_badges/index.mdlp|index.md

244

245 def conf(): 2 ctxlppytest

246 return project.config or project.load_config() 2 ctxlp|about/credits.mdlp|index.md

247

248 def name(): 2 ctxlppytest

249 p = project.conf() 2 ctxlp|about/credits.mdlp|index.md

250 return p['project']['name'] 2 ctxlp|about/credits.mdlp|index.md

251

252 def urls(): 2 ctxlppytest

253 p = project.conf()['project'] 1 ctxlp|index.md

254 if 'urls' in p: 254 ↛ 256line 254 didn't jump to line 256, because the condition on line 254 was never false1 ctxlp|index.md

255 return p['urls'] 1 ctxlp|index.md

256 urls = 'packagehome', 'discusshome', 'homepage', 'repository'

257 return {k: p.get(k, '') for k in urls}

258

259 def homepage(): 2 ctxlppytest

260 return project.urls().get('homepage', 'n.a.')

261

262 def repository(): 2 ctxlppytest

263 return project.urls().get('repository', 'n.a.')

264

265 def packagehome(): 2 ctxlppytest

266 return (

267 project.urls().get('packagehome')

268 or 'https://pypi.org/project/%s/_VERSION_/' % project.name()

269 ).replace('_VERSION_', project.version())

270

271 def version(): 2 ctxlppytest

272 p = project.conf()['project'] 1 ctxlp|index.md

273 v = p['version'] 1 ctxlp|index.md

274 if isinstance(v, dict) and v.get('use_scm'): 274 ↛ 275line 274 didn't jump to line 275, because the condition on line 274 was never true1 ctxlp|index.md