Coverage for src/lcdoc/mkdocs/tools.py: 82.56%

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

1import datetime 2 ctxlppytest

2import sys 2 ctxlppytest

3import time 2 ctxlppytest

4from functools import partial 2 ctxlppytest

6from mkdocs.config import config_options 2 ctxlppytest

7from mkdocs.plugins import BasePlugin 2 ctxlppytest

8from mkdocs.plugins import log as mkdlog 2 ctxlppytest

10from lcdoc.const import AttrDict, PageStats, Stats, now_ms, t0 2 ctxlppytest

11from lcdoc.tools import ( 2 ctxlppytest

12 app,

13 dirname,

14 exists,

15 now,

16 os,

17 project,

18 read_file,

19 require,

20 write_file,

21)

24script = lambda s: '<script>\n%s\n</script>' % s 4 ctxlplp|features/lp/plugs/lightbox/index.mdlp|index.mdpytest

25style = lambda s: '<style>\n%s\n</style>' % s 6 ctxlplp|features/lp/examples.mdlp|features/lp/plugs/lightbox/index.mdlp|features/lp/syntax.mdlp|index.mdpytest

28def add_post_page_func(kw, f, once=False): 2 ctxlppytest

29 p = kw['LP'].page 2 ctxlp|index.mdlp|index.md

30 h = getattr(p, 'lp_on_post_page', []) 2 ctxlp|index.mdlp|index.md

31 if once and f in h: 31 ↛ 32line 31 didn't jump to line 32, because the condition on line 31 was never true2 ctxlp|index.mdlp|index.md

32 return

33 h.append(f) 2 ctxlp|index.mdlp|index.md

34 p.lp_on_post_page = h 2 ctxlp|index.mdlp|index.md

37# -------------------------------------------------------- replacements

40def srclink(fn, config, line=None, match=None, title=''): 2 ctxlppytest

41 # TODO: allow others:

46 else:

50 s = read_file(r + fnr, dflt='') 2 ctxlp|about/credits.mdlp|features/lp/examples.md

51 m = s.split(match, 1) 2 ctxlp|about/credits.mdlp|features/lp/examples.md

52 if len(m) > 1: 52 ↛ 54line 52 didn't jump to line 54, because the condition on line 52 was never false2 ctxlp|about/credits.mdlp|features/lp/examples.md

53 line = len(m[0].splitlines()) 2 ctxlp|about/credits.mdlp|features/lp/examples.md

56 # return T

58 return {

59 'link': '[%s:fontawesome-brands-git-alt:](%s)' % (title, lnk),

60 'url': lnk,

61 } # {align=right}'

64# used in mdreplace

65def srcref(**kw): 2 ctxlppytest

66 """Often used as replacement function

67 In mdreplace.py:

68 'srcref': inline_srclink,

69 """

73 fn = fn[:-1] 1 ctxlp|about/credits.md

76 if '=' in fn: 76 ↛ 77line 76 didn't jump to line 77, because the condition on line 76 was never true1 ctxlp|about/credits.md

77 l = fn.split('=')

78 spec = {'fn': l[0], 'm': l[1]}

79 else:

80 spec = {'fn': fn} 1 ctxlp|about/credits.md

81 else:

84 except Exception as ex:

85 app.error('inline_srclink failed', line=line, page=kw['page'])

86 return {'line': line}

89 spec['t'] = spec['m'] 1 ctxlp|about/credits.md

90 # if 'changelog' in line: breakpoint() # FIXME BREAKPOINT

95def find_md_files(match, config): 2 ctxlppytest

96 flw = '' 1 ctxlp

97 if ':follow' in match: 97 ↛ 101line 97 didn't jump to line 101, because the condition on line 97 was never false1 ctxlp

98 match = match.replace(':follow', '') 1 ctxlp

99 flw = '-L' 1 ctxlp

100

101 require('fd --version') 1 ctxlp

102 dd = config['docs_dir'] 1 ctxlp

103 # no --type file because we want also symlinks:

104 cmd = "cd '%s' && fd %s -I -e md | grep '%s'" % (dd, flw, match) 1 ctxlp

105 r = os.popen(cmd).read().strip().splitlines() 1 ctxlp

106 # split off docs dir:

107 return r 1 ctxlp

108

109

110def theme_dir(config): 2 ctxlppytest

111 """strangly we don't see custom_dir in config.theme - it only inserts it, when given, into config.theme.dirs

112 """

113 cd = config['theme'].dirs[0]

114 if cd.endswith('/' + config['theme'].name):

115 app.debug('Theme dir is docs dir')

116 return config['docs_dir']

117 app.info('Theme dir is custom', dir=cd)

118 return cd

119

120

121def link_assets(plugin, fn_plugin, config): 2 ctxlppytest

122 """Linking assets folder content into D/lcd/<pluginname>, where D is either docs dir or custom_dir

123 Setting plugin.d_assets to that folder.

124 """

125 # extra css and js has be in docs dir, even with custom dir:

126 d = dirname(fn_plugin) + '/assets' 1 ctxlp

127 if not exists(d): 127 ↛ 128line 127 didn't jump to line 128, because the condition on line 127 was never true1 ctxlp

128 app.die('Cannot link: No assets found', dir=d)

129 n = fn_plugin.rsplit('/', 2)[-2] 1 ctxlp

130 to = config['docs_dir'] + '/lcd' 1 ctxlp

131 t = to + '/' + n 1 ctxlp

132 plugin.d_assets = t 1 ctxlp

133 if exists(t): 133 ↛ 134line 133 didn't jump to line 134, because the condition on line 133 was never true1 ctxlp

134 app.debug('Assets link exists already', linkdest=t)

135 return t

136 app.warning('Linking', frm=d, to=t) 1 ctxlp

137 os.makedirs(dirname(t), exist_ok=True) 1 ctxlp

138 cmd = 'ln -s "%s" "%s"' % (d, t) 1 ctxlp

139 if os.system(cmd): 139 ↛ 140line 139 didn't jump to line 140, because the condition on line 139 was never true1 ctxlp

140 app.die('Could not link assets')

141 app.info('Assets for git changelog linked', frm=d, to=t) 1 ctxlp

142 return t 1 ctxlp

143

144

145def split_off_fenced_blocks(markdown, fc_crit=None, fc_process=None, fcb='```'): 2 ctxlppytest

152 # if 'lp:bash' in l: breakpoint() # FIXME BREAKPOINT

165 # an fc but crit is not met (e.g. not lp) -> ignore all till closed:

175

187 msg = 'Closing fenced block. Your markdown will not be correctly rendered'

188 app.warning(msg, block=fc)

189 lines.append(beg)

195

196

197hooks = [

198 'on_serve',

199 'on_config',

200 'on_pre_build',

201 # 'on_files',

202 # 'on_nav',

203 # 'on_env',

204 'on_post_build',

205 # 'on_build_error',

206 # 'on_pre_template',

207 # 'on_template_context',

208 # 'on_post_template',

209 # 'on_pre_page',

210 # 'on_page_read_source',

211 'on_page_markdown',

212 'on_page_content',

213 # 'on_page_context',

214 'on_post_page',

215]

216

217clsn = lambda o: o.__class__.__name__ 2 ctxlppytest

218

219

220def get_page(hookname, a, kw, c={}): 2 ctxlppytest

221 """return the page passed to a hook, if any (run within the hook deco)"""

226 else:

227 h = None 1 ctxlp

228 for i, arg in zip(range(len(a)), a): 1 ctxlp

229 if getattr(arg, 'is_page', None): 229 ↛ 230line 229 didn't jump to line 230, because the condition on line 229 was never true1 ctxlp

230 h = i

231 break

232 if h is None: 232 ↛ 235line 232 didn't jump to line 235, because the condition on line 232 was never false1 ctxlp

233 c[hookname] = -1 1 ctxlp

234 return 1 ctxlp

237 if pos < 0: 237 ↛ 239line 237 didn't jump to line 239, because the condition on line 237 was never false1 ctxlp

238 return 1 ctxlp

239 return a[pos]

240

241

242def wrap_hook(plugin, hook, hookname): 2 ctxlppytest

243 """Decorates the actual lcd- plugin hooks with stats and logging"""

244 n = clsn(plugin) 2 ctxlppytest

245 Stats[n][hookname] = {} 2 ctxlppytest

246 PageStats[n][hookname] = {} 2 ctxlppytest

247

248 def wrapped_hook(*a, plugin=plugin, hook=hook, name=n, hookname=hookname, **kw): 2 ctxlppytest

267

268 setattr(plugin, hookname, wrapped_hook) 2 ctxlppytest

269

270

271def page_dir(kw): 2 ctxlppytest

272 page = kw.get('page') or kw['LP'].page 3 ctxlp|features/lp/plugs/drawio/index.mdlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

273 return dirname(page.file.abs_src_path) + '/' 3 ctxlp|features/lp/plugs/drawio/index.mdlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

274

275

276last_img_hash = {} 2 ctxlppytest

277

278

279def make_img(create_func, fn=None, kw=None): 2 ctxlppytest

280 """Takes care about

281

282 - fn in docs dir or not

283 - creation of containing dir

284 - creates fn also in site_dir always, i.e. change detection for svg may be disabled

285

286 Returns the image link

287 """

288 if not fn: 288 ↛ 291line 288 didn't jump to line 291, because the condition on line 288 was never false2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

289 fn = kw.get('fn') # default 2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

290 # if fn and 'call_fl' in fn: breakpoint() # FIXME BREAKPOINT

291 if fn and not fn.endswith('.svg'): 291 ↛ 293line 291 didn't jump to line 293, because the condition on line 291 was never false2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

292 fn += '.svg' 2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

293 f = create_func # string or creation func 2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

294 if isinstance(f, str): 294 ↛ 296line 294 didn't jump to line 296, because the condition on line 294 was never false2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

295 create_func = lambda fn, s=f: write_file(fn, s) 2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

296 LP = kw['LP'] 2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

297 page = kw.get('page') or LP.page 2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

298 config = LP.config 2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

299

300 def make(fn_abs, copy_frm=None, kw=kw): 2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

301 os.makedirs(dirname(fn_abs), exist_ok=True) 2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

302 if not exists(fn_abs) or last_img_hash.get(fn_abs) != kw['id']: 302 ↛ exitline 302 didn't return from function 'make', because the condition on line 302 was never false2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

303 if copy_frm: 303 ↛ 304line 303 didn't jump to line 304, because the condition on line 303 was never true2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

304 app.info('Copying svg', frm=copy_frm, to=fn_abs)

305 shutil.copyfile(copy_frm, fn_abs)

306 else:

307 app.info('Creating svg', fn=fn_abs) 2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

308 create_func(fn_abs) 2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

309

310 fn_abs_docs = False 2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

311 if fn: 311 ↛ 322line 311 didn't jump to line 322, because the condition on line 311 was never false2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

312 in_docs = True 2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

313 # image wanted within docs dir:

314 if fn.startswith('/'): 314 ↛ 315line 314 didn't jump to line 315, because the condition on line 314 was never true2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

315 app.error('no absolute filename allowed', fn=fn, page=page)

316 raise

317 # fn parameter was given -> create in docs dir:

318 fn_abs = fn_abs_docs = os.path.abspath(page_dir(kw) + fn) 2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

319 make(fn_abs) 2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

320

321 # should work even with svg change detection off:

322 if 'serve' in sys.argv or not fn: 322 ↛ 323line 322 didn't jump to line 323, because the condition on line 322 was never true2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md