Coverage for src/lcdoc/mkdocs/find_pages/__init__.py: 86.00%

1""" 

2## Find Pages 

3 

4Adds pages to nav 

5""" 

6 

7import string 1 ctxlp

8import time 1 ctxlp

9from ast import literal_eval 1 ctxlp

10from functools import partial 1 ctxlp

11 

12from lcdoc.mkdocs.tools import MDPlugin, app, config_options, find_md_files 1 ctxlp

13from lcdoc.tools import dirname, exists, OD, unflatten, flatten, os, project, read_file 1 ctxlp

14from lcdoc.mkdocs.find_pages.autodocs import autodocs, find_pages 1 ctxlp

15 

16 

17def repl_src_refs(s): 1 ctxlp

18 if not s.startswith(':srcref:'): 1 ctxlp

19 return s 1 ctxlp

20 s = s.split(',t=', 1) 1 ctxlp

21 if len(s) == 1: 21 ↛ 22line 21 didn't jump to line 22, because the condition on line 21 was never true1 ctxlp

22 return '' 

23 return s[-1].split(',', 1)[0] 1 ctxlp

24 

25 

26def uppercase_words(s): 1 ctxlp

27 """titles in nav should only contain the strings, not e.g. links 

28 

29 s: "Local LP Blocks :srcref:fn=src/lcdoc/mkdocs/lp/plugs/python/pyplugs/lprunner/__init__.py,t=Runner" 

30 

31 """ 

32 L = [repl_src_refs(i) for i in s.split(' ')] 1 ctxlp

33 r = [] 1 ctxlp

34 for l in L: 1 ctxlp

35 if l and l[0] == l[0].upper() and l[0] in string.ascii_letters: 1 ctxlp

36 r.append(l) 1 ctxlp

37 return ' '.join(r) 1 ctxlp

38 

39 

40def is_after(fn, hfn): 1 ctxlp

41 

42 breakpoint() # FIXME BREAKPOINT 

43 

44 

45def get_insert_pos(fn, have): 1 ctxlp

46 """when "after" is not given we have to find out ourselves""" 

47 while fn: 47 ↛ exitline 47 didn't return from function 'get_insert_pos', because the condition on line 47 was never false1 ctxlp

48 fn, post = fn.rsplit('/', 1) 1 ctxlp

49 for i in range(len(have)): 1 ctxlp

50 if not have[i].startswith(fn): 1 ctxlp

51 continue 1 ctxlp

52 while ( 1 ctxlp

53 (i < len(have) - 1) 

54 and have[i] < (fn + '/' + post) 

55 and have[i].startswith(fn) 

56 ): 

57 i += 1 1 ctxlp

58 return have[i - 1], have[i] 1 ctxlp

59 

60 

61# get_insert_pos( './features', ['index.md', 'install.md', 'features/index.md', 'features/blacklist/index.md'],) 

62now = time.time 1 ctxlp

63 

64 

65def clear_digits(t): 1 ctxlp

66 return '.'.join([k for k in t.split('.') if not k.isdigit()]) 1 ctxlp

67 

68 

69def get_title(fn_page, dd): 1 ctxlp

70 # TODO: find the mkdocs way of deriving the title from the header within content 

71 s = read_file(dd + '/' + fn_page, dflt='') 1 ctxlp

72 h = '\n' + s + '\n# Found\n' # so that we find *something* when there is no head 1 ctxlp

73 tit = '' 1 ctxlp

74 # find the highest header, could be also "### My Title" 

75 for k in range(5, 0, -1): 1 ctxlp

76 head = '\n' + k * '#' + ' ' # "\n#### " for k = 3 1 ctxlp

77 _ = h.split(head) 1 ctxlp

78 if len(_) == 1: 1 ctxlp

79 continue 1 ctxlp

80 h = _[0] # the content above, is there a higher header? 1 ctxlp

81 tit = _[1].split('\n', 1)[0] 1 ctxlp

82 if not tit: 82 ↛ 83line 82 didn't jump to line 83, because the condition on line 82 was never true1 ctxlp

83 tit = fn_page 

84 h = uppercase_words(tit) 1 ctxlp

85 if not h: 1 ctxlp

86 # e.g. # `bash` alone has no uppercase word. then take the filename: 

87 l = fn_page.rsplit('/', 2) 1 ctxlp

88 if l[-1] == 'index.md': 88 ↛ 91line 88 didn't jump to line 91, because the condition on line 88 was never false1 ctxlp

89 h = l[-2] 1 ctxlp

90 else: 

91 h = fn_page.rsplit('/', 1)[-1].split('.', 1)[0] 

92 return h 1 ctxlp

93 

94 

95def find_pages_and_add_to_nav(find, config, stats): 1 ctxlp

96 found = find_pages(find, config, stats) 1 ctxlp

97 if not found: 97 ↛ 98line 97 didn't jump to line 98, because the condition on line 97 was never true1 ctxlp

98 return 

99 

100 # m = OD({p: None for p in found}) 

101 nav = config['nav'] 1 ctxlp

102 navl = flatten(nav, '.') 1 ctxlp

103 navll = [[fn, k] for k, fn in navl.items()] 1 ctxlp

104 have = [fn[0] for fn in navll] 1 ctxlp

105 ins = {} 1 ctxlp

106 for spec in found: 1 ctxlp

107 while spec['found']: 1 ctxlp

108 fn = spec['found'].pop(0) 1 ctxlp

109 if fn in have: 1 ctxlp

110 continue 1 ctxlp

111 aft = spec.get('after') 1 ctxlp

112 if not aft: 112 ↛ 114line 112 didn't jump to line 114, because the condition on line 112 was never false1 ctxlp

113 aft, _ = get_insert_pos(fn, have) 1 ctxlp

114 ins.setdefault(have.index(aft), []).insert(0, fn) 1 ctxlp

115 l = {} 1 ctxlp

116 for k in reversed(sorted([i for i in ins])): 1 ctxlp

117 fns = ins[k] 1 ctxlp

118 [have.insert(k + 1, fn) for fn in fns] 1 ctxlp

119 l[have[k]] = fns 1 ctxlp

120 app.info('Inserting %s pages into nav' % sum([len(i) for i in ins.values()]), json=l) 1 ctxlp

121 # have now the complete list with found ones inserted at right places 

122 # 'features/lp/python/_tech.md', 

123 # 'features/lp/python/data_table/index.md', 

124 navl_rev = {v: k for k, v in navl.items()} 1 ctxlp

125 r = OD() 1 ctxlp

126 

127 dd = config['docs_dir'] 1 ctxlp

128 

129 to = None 1 ctxlp

130 for h in have: 1 ctxlp

131 tit = navl_rev.get(h) 1 ctxlp

132 if not tit: 1 ctxlp

133 t = to.rsplit('.', 2) 1 ctxlp

134 try: 1 ctxlp

135 T = get_title(h, dd) 1 ctxlp

136 if t[-1].isdigit(): 136 ↛ 137line 136 didn't jump to line 137, because the condition on line 136 was never true1 ctxlp

137 tit = '.'.join((t[0], t[1], str(int(t[2]) + 1), T)) 

138 else: 

139 tit = '.'.join((t[0], str(int(t[-2]) + 1), T)) 1 ctxlp

140 except Exception as ex: 

141 hint = 'Your filenames in that folder must match mkdocs config' 

142 msg = 'Cannot find position or title for page' 

143 app.error(msg, page=h, to=to, hint=hint) 

144 raise 

145 r[tit] = h 1 ctxlp

146 to = tit 1 ctxlp

147 

148 n = OD() 1 ctxlp

149 for k, v in r.items(): 1 ctxlp

150 n[clear_digits(k)] = v 1 ctxlp

151 

152 r = unflatten(n, '.') 1 ctxlp

153 r = to_list(r) 1 ctxlp

154 config['nav'].clear() 1 ctxlp

155 config['nav'].extend(r) 1 ctxlp

156 

157 

158def to_list(d): 1 ctxlp

159 l = [] 1 ctxlp

160 for k, v in d.items(): 1 ctxlp

161 if k == None: # inserted by unflatten, when there was no title 1 ctxlp

162 l.append(v) 1 ctxlp

163 continue 1 ctxlp

164 v = v if not isinstance(v, dict) else to_list(v) 1 ctxlp

165 l.append({k: v}) 1 ctxlp

166 return l 1 ctxlp

167 

168 

169def into_path(item, after, last_title): 1 ctxlp

170 """ 

171 (Pdb) pp item, after, last_title 

172 ('features/termcasts/zab/baz.md', 'features/termcasts/index.md', '3.Features.3.TermCasts.0.Overview') 

173 

174 Then we return '3.Features.3.TermCasts.0' 

175 """ 

176 while not item.startswith(after): 

177 after = after.rsplit('/', 1)[0] 

178 parts = after.split('/') 

179 return '.'.join(last_title.split('.', 2 * len(parts) + 1)[:-1]) 

180 

181 

182class MDFindPagesPlugin(MDPlugin): 1 ctxlp

183 config_scheme = ( 

184 ('find-pages', config_options.Type(list, default=[])), 

185 ('autodocs', config_options.Type(dict, default={}),), 

186 ) 

187 

188 def on_config(self, config): 1 ctxlp

189 # t0 = now() 

190 ad = self.config['autodocs'] 1 ctxlp

191 if ad: 191 ↛ 192line 191 didn't jump to line 192, because the condition on line 191 was never true1 ctxlp

192 [autodocs.do_spec(ad, k, v, config, self.stats) for k, v in ad.items()] 

193 find_pages_and_add_to_nav(self.config['find-pages'], config, self.stats) 1 ctxlp

194 # print(now() - t0) # = 0.02 for docutools. Could be improved