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

1import datetime 2 ctxlppytest

2import importlib 2 ctxlppytest

3import shutil 2 ctxlppytest

4import sys 2 ctxlppytest

5import time 2 ctxlppytest

6from functools import partial 2 ctxlppytest

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

9from lcdoc.tools import ( 2 ctxlppytest

10 app,

11 dirname,

12 exists,

13 now,

14 os,

15 project,

16 read_file,

17 require,

18 write_file,

19)

20from mkdocs.config import config_options 2 ctxlppytest

21from mkdocs.plugins import BasePlugin 2 ctxlppytest

22from mkdocs.plugins import log as mkdlog 2 ctxlppytest

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

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

38 # TODO: allow others:

43 else:

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

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

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

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

53 # return T

55 return {

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

57 'url': lnk,

58 } # {align=right}'

61def find_md_files(match, config): 2 ctxlppytest

62 flw = '' 1 ctxlp

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

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

65 flw = '-L' 1 ctxlp

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

68 dd = config['docs_dir'] 1 ctxlp

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

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

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

72 # print('cmd find', cmd)

73 # some versions of fd deliver ./foo others foo -> normalize to the latter:

74 r = [fn[2:] if fn.startswith('./') else fn for fn in r] 1 ctxlp

75 # split off docs dir:

76 return r 1 ctxlp

79def theme_dir(config): 2 ctxlppytest

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

81 """

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

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

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

85 return config['docs_dir']

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

87 return cd

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

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

92 Setting plugin.d_assets to that folder.

93 """

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

95 d = dirname(fn_plugin) + '/assets' 2 ctxlplp|about/changelog.md

96 if not exists(d): 96 ↛ 97line 96 didn't jump to line 97, because the condition on line 96 was never true2 ctxlplp|about/changelog.md

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

98 n = fn_plugin.rsplit('/', 2)[-2] 2 ctxlplp|about/changelog.md

99 to = config['docs_dir'] + '/lcd' 2 ctxlplp|about/changelog.md

100 t = to + '/' + n 2 ctxlplp|about/changelog.md

101 plugin.d_assets = t 2 ctxlplp|about/changelog.md

102 if exists(t): 102 ↛ 103line 102 didn't jump to line 103, because the condition on line 102 was never true2 ctxlplp|about/changelog.md

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

104 return t

105 app.warning('Linking', frm=d, to=t) 2 ctxlplp|about/changelog.md

106 os.makedirs(dirname(t), exist_ok=True) 2 ctxlplp|about/changelog.md

107 cmd = 'ln -s "%s" "%s"' % (d, t) 2 ctxlplp|about/changelog.md

108 if os.system(cmd): 108 ↛ 109line 108 didn't jump to line 109, because the condition on line 108 was never true2 ctxlplp|about/changelog.md

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

110 app.info('Assets for git changelog linked', frm=d, to=t) 2 ctxlplp|about/changelog.md

111 return t 2 ctxlplp|about/changelog.md

112

113

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

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

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

144

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

157 app.warning(msg, block=fc)

158 lines.append(beg)

164

165

166hooks = [

167 'on_serve',

168 'on_config',

169 'on_pre_build',

170 # 'on_files',

171 # 'on_nav',

172 # 'on_env',

173 'on_post_build',

174 # 'on_build_error',

175 # 'on_pre_template',

176 # 'on_template_context',

177 # 'on_post_template',

178 # 'on_pre_page',

179 # 'on_page_read_source',

180 'on_page_markdown',

181 'on_page_content',

182 # 'on_page_context',

183 'on_post_page',

184]

185

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

187

188

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

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

195 else:

196 h = None 1 ctxlp

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

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

199 h = i

200 break

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

202 c[hookname] = -1 1 ctxlp

203 return 1 ctxlp

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

207 return 1 ctxlp

208 return a[pos]

209

210

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

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

213 n = clsn(plugin) 2 ctxlppytest

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

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

216

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

236

237 setattr(plugin, hookname, wrapped_hook) 2 ctxlppytest

238

239

240def run_docs_hooks(hookname, config): 2 ctxlppytest

241 d = project.root(config) + '/scripts/docs/hooks/' + hookname 1 ctxlp

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

243 return

244 sys.path.insert(0, d) 1 ctxlp

245 for h in [i for i in os.listdir(d) if i.endswith('.py')]: 1 ctxlp

246 mod = importlib.import_module(h[:-3]) 1 ctxlp

247 mod.run(config) 1 ctxlp

248

249

250def page_dir(kw): 2 ctxlppytest

251 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

252 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

253

254

255last_img_hash = {} 2 ctxlppytest

256

257

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

259 """Takes care about

260

261 - fn in docs dir or not

262 - creation of containing dir

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

264

265 Returns the image link

266 """

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

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

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

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

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

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

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

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

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

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

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

278

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

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

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

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

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

284 shutil.copyfile(copy_frm, fn_abs)

285 else:

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

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

288

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

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

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

292 # image wanted within docs dir:

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

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

295 raise

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

297 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

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

299

300 # should work even with svg change detection off:

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