Coverage for src/lcdoc/mkdocs/replace/__init_

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"""

2## Markdown Replace

4Allows to add replacements into the markdown source, which are replaced by values given

5by a python module.

7The python module (default is: docs/mdreplace.py) must have a table attribute, either

8dict or callable.

10When callable and kw args in the signature, it will be called with a lot of context, incl. the mkdocs config and the

11current line. Otherwise it will be simply called.

14### Features

16- The replace values can themselves be callable, and if so, are called at replacement

17 time with contextual information:

19 ```python

20 replace(

21 mdblock=md,

22 plugin=self,

23 plugin_file=__file__,

24 config=config,

25 page=page,

26 markdown=markdown,

27 )

28 ```

30- If the callable does not require kw args (e.g. time.ctime) we will not pass them

31- The callable can return a replacement for the whole line, by returning a dict like

32 `{'line': ....}`, i.e. with a "line" key.

33- If the replace values are lists (also as returned by the callable), they will be

34 properly indented as multiline text.

36#### Controlling Replacements Within Fenced Blocks

37 - fenced blocks are omitted EXCEPT:

38 - if the replacement key is specified like this `key:all:` - then even `:key:` in

39 fenced blocks is replaced

41### Config

43- `seperator`: ':' by default.

44 Example: `':curtime:'`, for `{"cur_time": time.ctime}` based replacements.

45- `replacement_file`: when not starting with '/' we'll prefix with docs_dir. Default: "mdreplace.py"

46"""

49import importlib 1 ctxlp

51from mkdocs.config import config_options 1 ctxlp

53from lcdoc.mkdocs.tools import MDPlugin, app, split_off_fenced_blocks 1 ctxlp

54from lcdoc.tools import exists, now, os, read_file, sys 1 ctxlp

55import inspect 1 ctxlp

57fn_ts = [0] 1 ctxlp

58last_check = [0] 1 ctxlp

61def load_replacement_file(plugin, config): 1 ctxlp

64 return

70 app.info('Change detected - reloading', fn=fn)

71 # cannot reload - have to exec second time. No breaks work then with linenr

72 s = read_file(fn)

73 m = {}

74 exec(s, globals(), m)

75 table = m.get('table')

78 else:

79 app.info('Loading replacement file', fn=fn) 1 ctxlp

80 if not exists(fn): 80 ↛ 81line 80 didn't jump to line 81, because the condition on line 80 was never true1 ctxlp

81 app.warning('Cannot replace, no lookup file found', fn=fn)

82 sys.path.append(os.path.dirname(fn)) 1 ctxlp

83 mod = importlib.import_module(fnmod) 1 ctxlp

84 table = getattr(mod, 'table', None) 1 ctxlp

85 fn_ts[0] = os.stat(fn)[7] 1 ctxlp

86 if not table: 86 ↛ 87line 86 didn't jump to line 87, because the condition on line 86 was never true1 ctxlp

87 app.warning(

88 'Replacement mod requires table attribute', fn=fn, err='no md-replace'

89 )

90 plugin.table = {}

91 return

92 d = table(config) if callable(table) else table 1 ctxlp

93 s = plugin.config['seperator'] 1 ctxlp

94 l = lambda v: v.splitlines() if isinstance(v, str) and '\n' in v else v 1 ctxlp

95 d1 = {k: v for k, v in d.items() if not ':all:' in k} 1 ctxlp

96 d2 = {k: v for k, v in d.items() if ':all:' in k} 1 ctxlp

97 d2 = {k.replace(':all:', ''): v for k, v in d2.items()} 1 ctxlp

98 plugin.table = dict([('%s%s%s' % (s, k, s), l(v)) for k, v in d1.items()]) 1 ctxlp

99 plugin.t_all = dict([('%s%s%s' % (s, k, s), l(v)) for k, v in d2.items()]) 1 ctxlp

100 except Exception as ex:

101 app.warning('replacement table load error', exc=ex)

102 plugin.table = {}

103

104

105def has_kw(func, _h={}): 1 ctxlp

108 r = _h[func] = '**' in str(inspect.signature(func)) 2 ctxlp|about/credits.mdlp|features/lp/bash/sessions.md

109 return r 2 ctxlp|about/credits.mdlp|features/lp/bash/sessions.md

110

111

112def replace(**kw): 1 ctxlp

120 # if 'plugin_do' in str(l): breakpoint() # FIXME BREAKPOINT

130 else:

131 v = v() # simple funcs like time.ctime

133 stats['multiline'] = stats.get('multiline', 0) + 1

134 ind = ' ' * len(l.split(k, 1)[0])

135 v = ind.join([i for i in v])

137 # a replacement func may deliver the whole new line:

139 else:

143

144

145from functools import partial 1 ctxlp

146

147

148class MDReplacePlugin(MDPlugin): 1 ctxlp

149 table = None 1 ctxlp

150 fn_replace = None 1 ctxlp

151 fn_replace_ts = None 1 ctxlp

152

153 config_scheme = (

154 ('seperator', config_options.Type(str, default=':')),

155 ('replacement_file', config_options.Type(str, default='mdreplace.py')),

156 )

157

158 def on_pre_build(self, config): 1 ctxlp

159 load_replacement_file(self, config) 1 ctxlp

160

161 def on_page_markdown(self, markdown, page, config, files): 1 ctxlp

162 # a lot of context for the replacement funcs:

164 replace,

165 plugin=self,

166 plugin_file=__file__,

167 config=config,

168 page=page,

169 markdown=markdown,

170 )

171 # hot reload feature:

176

177 # if 'features' in page.url: breakpoint() # FIXME BREAKPOINT

Coverage for src/lcdoc/mkdocs/replace/init.py : 81.51%

98 statements

Coverage for src/lcdoc/mkdocs/replace/__init__.py : 81.51%

98 statements 81 run 17 missing 0 excluded 8 partial

Coverage for src/lcdoc/mkdocs/replace/init.py : 81.51%

98 statements