Skip to content

Commit b8fe1d2

Browse files
ntnontno
authored
move tile-grid rendering to pluglet (#88)
* disable search by default in local server * move tile templates to pluglet * works but isn't using the general jinja environment * save mkdocs config information, create new jinja2 environment to use to render tiles partial from macro * refactor into singleton * refactor and new tests * move plugin logging to debug level * cleaned up tests, verified that mock is called as expected * backward compatability * dont break people that are using tiles but have not enabled plugin * use markup only if plugin is enabled * revert, tile change should be backwards compatible * mock attribute on singleton * check if md-to-html plugin is enabled before adding plugin to macro environment * add pluglet/plugin names to test interface * refactor to keep theme api in interface folder * refactor for readability/standardization * test setup fixes * update test coverage * troubleshooting tox failure on github * move macro implementation out of __init__ (troubleshooting wip) * access as if real mkdocs_config (because it will be, should not have src code weird just to pass test data) * coverage update * notes * enable markup * watch local tile-grid partials (only watches for tiles included via theme partial // does not watch tiles included by pluglet macro) * somewhere along the way broke the pluglet --- now 'show tiles first' renders with markup but macro included tiles do not * log formatting * coverage update * refactor, save mkdocs config because we need it to check plugins list * FIX: pass saved mkdocs config to jinja2 template * better debug page * flake8 fixes * remove scratch work * test when markup filter not used * coverage update
1 parent c96531f commit b8fe1d2

40 files changed

+915
-163
lines changed

‎documentation/docs/about/coverage-report/d_23bf7247bda4ebb4_plugin_py.html‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html>
33
<head>
44
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
5-
<title>Coverage for terminal/plugins/md_to_html/plugin.py: 54%</title>
5+
<title>Coverage for terminal/plugins/md_to_html/plugin.py: 62%</title>
66
<link rel="icon" sizes="32x32" href="favicon_32.png">
77
<link rel="stylesheet" href="style.css" type="text/css">
88
<script type="text/javascript" src="coverage_html.js" defer></script>
@@ -12,7 +12,7 @@
1212
<div class="content">
1313
<h1>
1414
<span class="text">Coverage for </span><b>terminal/plugins/md_to_html/plugin.py</b>:
15-
<span class="pc_cov">54%</span>
15+
<span class="pc_cov">62%</span>
1616
</h1>
1717
<aside id="help_panel_wrapper">
1818
<input id="help_panel_state" type="checkbox">
@@ -56,8 +56,8 @@ <h1>
5656
</aside>
5757
<h2>
5858
<span class="text">26 statements &nbsp;</span>
59-
<button type="button" class="run button_toggle_run" value="run" data-shortcut="r" title="Toggle lines run">14<span class="text"> run</span></button>
60-
<button type="button" class="mis show_mis button_toggle_mis" value="mis" data-shortcut="m" title="Toggle lines missing">12<span class="text"> missing</span></button>
59+
<button type="button" class="run button_toggle_run" value="run" data-shortcut="r" title="Toggle lines run">16<span class="text"> run</span></button>
60+
<button type="button" class="mis show_mis button_toggle_mis" value="mis" data-shortcut="m" title="Toggle lines missing">10<span class="text"> missing</span></button>
6161
<button type="button" class="exc show_exc button_toggle_exc" value="exc" data-shortcut="x" title="Toggle lines excluded">0<span class="text"> excluded</span></button>
6262
<button type="button" class="par run show_par button_toggle_par" value="par" data-shortcut="p" title="Toggle lines partially run">0<span class="text"> partial</span></button>
6363
</h2>
@@ -67,7 +67,7 @@ <h2>
6767
<a id="nextFileLink" class="nav" href="d_7e1d11d1cf628cf7___init___py.html">&#xbb; next</a>
6868
&nbsp; &nbsp; &nbsp;
6969
<a class="nav" href="https://coverage.readthedocs.io">coverage.py v7.0.5</a>,
70-
created at 2023-01-21 21:53 +0000
70+
created at 2023-01-21 22:08 +0000
7171
</p>
7272
<aside class="hidden">
7373
<button type="button" class="button_next_chunk" data-shortcut="j"/>
@@ -93,33 +93,33 @@ <h2>
9393
<p class="run"><span class="n"><a id="t9" href="#t9">9</a></span><span class="t"><span class="key">class</span> <span class="nam">MarkdownToHtmlFilterPlugin</span><span class="op">(</span><span class="nam">BasePlugin</span><span class="op">)</span><span class="op">:</span>&nbsp;</span><span class="r"></span></p>
9494
<p class="pln"><span class="n"><a id="t10" href="#t10">10</a></span><span class="t">&nbsp;</span><span class="r"></span></p>
9595
<p class="run"><span class="n"><a id="t11" href="#t11">11</a></span><span class="t"> <span class="key">def</span> <span class="nam">__init__</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span><span class="op">:</span>&nbsp;</span><span class="r"></span></p>
96-
<p class="mis show_mis"><span class="n"><a id="t12" href="#t12">12</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">md</span> <span class="op">=</span> <span class="key">None</span>&nbsp;</span><span class="r"></span></p>
96+
<p class="run"><span class="n"><a id="t12" href="#t12">12</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">md</span> <span class="op">=</span> <span class="key">None</span>&nbsp;</span><span class="r"></span></p>
9797
<p class="pln"><span class="n"><a id="t13" href="#t13">13</a></span><span class="t">&nbsp;</span><span class="r"></span></p>
9898
<p class="run"><span class="n"><a id="t14" href="#t14">14</a></span><span class="t"> <span class="key">def</span> <span class="nam">setup_markdown</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">config</span><span class="op">)</span><span class="op">:</span>&nbsp;</span><span class="r"></span></p>
99-
<p class="mis show_mis"><span class="n"><a id="t15" href="#t15">15</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">md</span> <span class="op">=</span> <span class="nam">markdown</span><span class="op">.</span><span class="nam">Markdown</span><span class="op">(</span>&nbsp;</span><span class="r"></span></p>
99+
<p class="run"><span class="n"><a id="t15" href="#t15">15</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">md</span> <span class="op">=</span> <span class="nam">markdown</span><span class="op">.</span><span class="nam">Markdown</span><span class="op">(</span>&nbsp;</span><span class="r"></span></p>
100100
<p class="pln"><span class="n"><a id="t16" href="#t16">16</a></span><span class="t"> <span class="nam">extensions</span><span class="op">=</span><span class="nam">config</span><span class="op">.</span><span class="nam">markdown_extensions</span> <span class="key">or</span> <span class="op">[</span><span class="op">]</span><span class="op">,</span>&nbsp;</span><span class="r"></span></p>
101101
<p class="pln"><span class="n"><a id="t17" href="#t17">17</a></span><span class="t"> <span class="nam">extension_configs</span><span class="op">=</span><span class="nam">config</span><span class="op">.</span><span class="nam">mdx_configs</span> <span class="key">or</span> <span class="op">{</span><span class="op">}</span>&nbsp;</span><span class="r"></span></p>
102102
<p class="pln"><span class="n"><a id="t18" href="#t18">18</a></span><span class="t"> <span class="op">)</span>&nbsp;</span><span class="r"></span></p>
103103
<p class="pln"><span class="n"><a id="t19" href="#t19">19</a></span><span class="t">&nbsp;</span><span class="r"></span></p>
104104
<p class="run"><span class="n"><a id="t20" href="#t20">20</a></span><span class="t"> <span class="key">def</span> <span class="nam">on_pre_build</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">config</span><span class="op">,</span> <span class="op">**</span><span class="nam">kwargs</span><span class="op">)</span><span class="op">:</span>&nbsp;</span><span class="r"></span></p>
105-
<p class="mis show_mis"><span class="n"><a id="t21" href="#t21">21</a></span><span class="t"> <span class="nam">logger</span><span class="op">.</span><span class="nam">info</span><span class="op">(</span><span class="str">"MarkdownToHtmlFilterPlugin::on_pre_build::markdown_extensions: %s"</span><span class="op">,</span> <span class="nam">config</span><span class="op">.</span><span class="nam">markdown_extensions</span><span class="op">)</span>&nbsp;</span><span class="r"></span></p>
106-
<p class="mis show_mis"><span class="n"><a id="t22" href="#t22">22</a></span><span class="t"> <span class="nam">logger</span><span class="op">.</span><span class="nam">info</span><span class="op">(</span><span class="str">"MarkdownToHtmlFilterPlugin::on_pre_build::mdx_configs': %s"</span><span class="op">,</span> <span class="nam">config</span><span class="op">.</span><span class="nam">mdx_configs</span><span class="op">)</span>&nbsp;</span><span class="r"></span></p>
105+
<p class="mis show_mis"><span class="n"><a id="t21" href="#t21">21</a></span><span class="t"> <span class="nam">logger</span><span class="op">.</span><span class="nam">debug</span><span class="op">(</span><span class="str">"MarkdownToHtmlFilterPlugin::on_pre_build::markdown_extensions: %s"</span><span class="op">,</span> <span class="nam">config</span><span class="op">.</span><span class="nam">markdown_extensions</span><span class="op">)</span>&nbsp;</span><span class="r"></span></p>
106+
<p class="mis show_mis"><span class="n"><a id="t22" href="#t22">22</a></span><span class="t"> <span class="nam">logger</span><span class="op">.</span><span class="nam">debug</span><span class="op">(</span><span class="str">"MarkdownToHtmlFilterPlugin::on_pre_build::mdx_configs': %s"</span><span class="op">,</span> <span class="nam">config</span><span class="op">.</span><span class="nam">mdx_configs</span><span class="op">)</span>&nbsp;</span><span class="r"></span></p>
107107
<p class="mis show_mis"><span class="n"><a id="t23" href="#t23">23</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">setup_markdown</span><span class="op">(</span><span class="nam">config</span><span class="op">)</span>&nbsp;</span><span class="r"></span></p>
108-
<p class="mis show_mis"><span class="n"><a id="t24" href="#t24">24</a></span><span class="t"> <span class="nam">logger</span><span class="op">.</span><span class="nam">info</span><span class="op">(</span><span class="str">"MarkdownToHtmlFilterPlugin::on_pre_build::md: %s"</span><span class="op">,</span> <span class="nam">self</span><span class="op">.</span><span class="nam">md</span><span class="op">)</span>&nbsp;</span><span class="r"></span></p>
108+
<p class="mis show_mis"><span class="n"><a id="t24" href="#t24">24</a></span><span class="t"> <span class="nam">logger</span><span class="op">.</span><span class="nam">debug</span><span class="op">(</span><span class="str">"MarkdownToHtmlFilterPlugin::on_pre_build::md: %s"</span><span class="op">,</span> <span class="nam">self</span><span class="op">.</span><span class="nam">md</span><span class="op">)</span>&nbsp;</span><span class="r"></span></p>
109109
<p class="mis show_mis"><span class="n"><a id="t25" href="#t25">25</a></span><span class="t"> <span class="key">return</span>&nbsp;</span><span class="r"></span></p>
110110
<p class="pln"><span class="n"><a id="t26" href="#t26">26</a></span><span class="t">&nbsp;</span><span class="r"></span></p>
111111
<p class="run"><span class="n"><a id="t27" href="#t27">27</a></span><span class="t"> <span class="key">def</span> <span class="nam">markupsafe_jinja2_filter</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">text</span><span class="op">,</span> <span class="op">**</span><span class="nam">kwargs</span><span class="op">)</span><span class="op">:</span>&nbsp;</span><span class="r"></span></p>
112112
<p class="mis show_mis"><span class="n"><a id="t28" href="#t28">28</a></span><span class="t"> <span class="key">return</span> <span class="nam">markupsafe</span><span class="op">.</span><span class="nam">Markup</span><span class="op">(</span><span class="nam">self</span><span class="op">.</span><span class="nam">md</span><span class="op">.</span><span class="nam">convert</span><span class="op">(</span><span class="nam">text</span><span class="op">)</span><span class="op">)</span>&nbsp;</span><span class="r"></span></p>
113113
<p class="pln"><span class="n"><a id="t29" href="#t29">29</a></span><span class="t">&nbsp;</span><span class="r"></span></p>
114114
<p class="run"><span class="n"><a id="t30" href="#t30">30</a></span><span class="t"> <span class="key">def</span> <span class="nam">on_env</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">env</span><span class="op">,</span> <span class="nam">config</span><span class="op">,</span> <span class="nam">files</span><span class="op">,</span> <span class="op">**</span><span class="nam">kwargs</span><span class="op">)</span><span class="op">:</span>&nbsp;</span><span class="r"></span></p>
115115
<p class="mis show_mis"><span class="n"><a id="t31" href="#t31">31</a></span><span class="t"> <span class="nam">env</span><span class="op">.</span><span class="nam">filters</span><span class="op">[</span><span class="nam">DEFAULT_MARKUP_FILTER_NAME</span><span class="op">]</span> <span class="op">=</span> <span class="nam">self</span><span class="op">.</span><span class="nam">markupsafe_jinja2_filter</span>&nbsp;</span><span class="r"></span></p>
116-
<p class="mis show_mis"><span class="n"><a id="t32" href="#t32">32</a></span><span class="t"> <span class="nam">logger</span><span class="op">.</span><span class="nam">info</span><span class="op">(</span><span class="str">"MarkdownToHtmlFilterPlugin::on_env::%s: %s"</span><span class="op">,</span> <span class="nam">DEFAULT_MARKUP_FILTER_NAME</span><span class="op">,</span> <span class="nam">self</span><span class="op">.</span><span class="nam">markupsafe_jinja2_filter</span><span class="op">)</span>&nbsp;</span><span class="r"></span></p>
116+
<p class="mis show_mis"><span class="n"><a id="t32" href="#t32">32</a></span><span class="t"> <span class="nam">logger</span><span class="op">.</span><span class="nam">debug</span><span class="op">(</span><span class="str">"MarkdownToHtmlFilterPlugin::on_env::%s: %s"</span><span class="op">,</span> <span class="nam">DEFAULT_MARKUP_FILTER_NAME</span><span class="op">,</span> <span class="nam">self</span><span class="op">.</span><span class="nam">markupsafe_jinja2_filter</span><span class="op">)</span>&nbsp;</span><span class="r"></span></p>
117117
<p class="mis show_mis"><span class="n"><a id="t33" href="#t33">33</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">env</span> <span class="op">=</span> <span class="nam">env</span>&nbsp;</span><span class="r"></span></p>
118118
<p class="mis show_mis"><span class="n"><a id="t34" href="#t34">34</a></span><span class="t"> <span class="key">return</span> <span class="nam">env</span>&nbsp;</span><span class="r"></span></p>
119119
<p class="pln"><span class="n"><a id="t35" href="#t35">35</a></span><span class="t">&nbsp;</span><span class="r"></span></p>
120120
<p class="pln"><span class="n"><a id="t36" href="#t36">36</a></span><span class="t">&nbsp;</span><span class="r"></span></p>
121121
<p class="pln"><span class="n"><a id="t37" href="#t37">37</a></span><span class="t"><span class="com"># Set up logging</span>&nbsp;</span><span class="r"></span></p>
122-
<p class="run"><span class="n"><a id="t38" href="#t38">38</a></span><span class="t"><span class="nam">logger</span> <span class="op">=</span> <span class="nam">logging</span><span class="op">.</span><span class="nam">getLogger</span><span class="op">(</span><span class="str">"mkdocs"</span><span class="op">)</span>&nbsp;</span><span class="r"></span></p>
122+
<p class="run"><span class="n"><a id="t38" href="#t38">38</a></span><span class="t"><span class="nam">logger</span> <span class="op">=</span> <span class="nam">logging</span><span class="op">.</span><span class="nam">getLogger</span><span class="op">(</span><span class="str">"mkdocs.terminal.md_to_html"</span><span class="op">)</span>&nbsp;</span><span class="r"></span></p>
123123
<p class="run"><span class="n"><a id="t39" href="#t39">39</a></span><span class="t"><span class="nam">logger</span><span class="op">.</span><span class="nam">addFilter</span><span class="op">(</span><span class="nam">DuplicateFilter</span><span class="op">(</span><span class="op">)</span><span class="op">)</span>&nbsp;</span><span class="r"></span></p>
124124
</main>
125125
<footer>
@@ -130,7 +130,7 @@ <h2>
130130
<a id="nextFileLink" class="nav" href="d_7e1d11d1cf628cf7___init___py.html">&#xbb; next</a>
131131
&nbsp; &nbsp; &nbsp;
132132
<a class="nav" href="https://coverage.readthedocs.io">coverage.py v7.0.5</a>,
133-
created at 2023-01-21 21:53 +0000
133+
created at 2023-01-21 22:08 +0000
134134
</p>
135135
</div>
136136
</footer>

0 commit comments

Comments
 (0)