Coverage for src/lcdoc/mkdocs/lp/plugs/kroki/__init__.py: 73.08%

1""" 

2Adds kroki support to the page. 

3 

4""" 

5 

6import json 1 ctxlp

7 

8import httpx 1 ctxlp

9 

10from lcdoc import lp 1 ctxlp

11from lcdoc.mkdocs.tools import os, make_img 1 ctxlp

12from lcdoc.tools import dirname, os, read_file, exists 1 ctxlp

13 

14# dflt_server = 'https://kroki.io/' 

15# dflt_server = os.environ.get('lp_kroki_server', dflt_server) 

16# dflt_puml = os.environ.get('lp_kroki_puml', 'dark_blue') 

17s = 'mkdocs/lp/' 1 ctxlp

18d_assets = dirname(__file__).split(s, 1)[0] + s + '/assets/plantuml' 1 ctxlp

19pumls = {} 1 ctxlp

20 

21env = os.environ.get 1 ctxlp

22# :docs:lp_kroki_dflts 

23lp_kroki_dflts = { 

24 'server': env('lp_kroki_server', 'https://kroki.io/'), 

25 'puml': env('lp_kroki_puml', 'dark_blue'), 

26 'kroki_mode': 'plantuml', # when user gave no kroki mode we set this 

27} 

28# :docs:lp_kroki_dflts 

29 

30 

31def read_puml_file(puml, kw): 1 ctxlp

32 ofn = puml 1 ctxlp|features/lp/plugs/kroki/index.md

33 p = pumls.get(puml) 1 ctxlp|features/lp/plugs/kroki/index.md

34 if p: 34 ↛ 35line 34 didn't jump to line 35, because the condition on line 34 was never true1 ctxlp|features/lp/plugs/kroki/index.md

35 return p 

36 if not '/' in puml: 36 ↛ 39line 36 didn't jump to line 39, because the condition on line 36 was never false1 ctxlp|features/lp/plugs/kroki/index.md

37 # default dir: 

38 puml = '%s/%s.puml' % (d_assets, puml) 1 ctxlp|features/lp/plugs/kroki/index.md

39 elif puml[0] == '/': 

40 puml = puml 

41 else: 

42 fnp = dirname(kw['LP'].page.file.abs_src_path) 

43 puml = fnp + '/' + puml 

44 return pumls.setdefault(ofn, read_file(puml, '')) 1 ctxlp|features/lp/plugs/kroki/index.md

45 

46 

47def run(cmd, kw): 1 ctxlp

48 

49 d = dict(lp_kroki_dflts) 2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

50 d.update(kw) 2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

51 

52 if not cmd.strip(): 2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

53 src = kw.get('abs_src') 1 ctxlp|features/lp/plugs/kroki/index.md

54 if not src: 54 ↛ 55line 54 didn't jump to line 55, because the condition on line 54 was never true1 ctxlp|features/lp/plugs/kroki/index.md

55 return lp.err('Require a diag source') 

56 

57 if not exists(src): 57 ↛ 58line 57 didn't jump to line 58, because the condition on line 57 was never true1 ctxlp|features/lp/plugs/kroki/index.md

58 return lp.err('Not found', src=src) 

59 cmd = read_file(src) 1 ctxlp|features/lp/plugs/kroki/index.md

60 

61 # lp:kroki:plantuml 

62 typ = (kw['mode'] + ':' + d['kroki_mode'] + ':').split(':', 2)[1] 2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

63 if typ == 'plantuml': 2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

64 cmd = cmd.replace('@startuml', '') 1 ctxlp|features/lp/plugs/kroki/index.md

65 cmd = cmd.replace('@enduml', '') 1 ctxlp|features/lp/plugs/kroki/index.md

66 puml = read_puml_file(d['puml'], kw) 1 ctxlp|features/lp/plugs/kroki/index.md

67 cmd = puml + '\n' + cmd 1 ctxlp|features/lp/plugs/kroki/index.md

68 cmd = '@startuml\n%s\n@enduml' % cmd 1 ctxlp|features/lp/plugs/kroki/index.md

69 

70 if isinstance(cmd, (dict, list, tuple)): 70 ↛ 71line 70 didn't jump to line 71, because the condition on line 70 was never true2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

71 data = json.dumps(cmd) 

72 else: 

73 data = cmd 2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

74 # {'diagram_source': cmd, 'diagram_type': typ, 'output_format': 'svg'} 

75 # ) 

76 server = d['server'] 2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

77 server = server[:-1] if server[-1] == '/' else server 2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

78 server += '/%s/svg' % typ 2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

79 res = httpx.post(server, data=data) 2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

80 if res.status_code > 299: 80 ↛ 81line 80 didn't jump to line 81, because the condition on line 80 was never true2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

81 return lp.err( 

82 'Server returned error', 

83 status=res.status_code, 

84 txt=getattr(res, 'text', 'n.a.')[:200], 

85 ) 

86 

87 res = res.text.replace('\r\n', '\n') 2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

88 if kw.get('get_svg'): 88 ↛ 89line 88 didn't jump to line 89, because the condition on line 88 was never true2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

89 return res 

90 imglnk = make_img(res, kw=kw) 2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

91 r = {'res': imglnk, 'formatted': True} 2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

92 if kw.get('add_svg'): 92 ↛ 93line 92 didn't jump to line 93, because the condition on line 92 was never true2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md

93 r['svg'] = res 

94 return r 2 ctxlp|features/lp/plugs/kroki/index.mdlp|features/lp/plugs/kroki/index.md