markdown-include-variants 0.0.2__tar.gz → 0.0.3__tar.gz

{markdown_include_variants-0.0.2 → markdown_include_variants-0.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: markdown-include-variants
-Version: 0.0.2
+Version: 0.0.3
 Summary: Markdown extension to expand directives to include source example files to also include their variants. Only useful to tiangolo's projets. Don't use it. 😅
 Project-URL: Homepage, https://github.com/tiangolo/markdown-include-variants
 Project-URL: Repository, https://github.com/tiangolo/markdown-include-variants

{markdown_include_variants-0.0.2 → markdown_include_variants-0.0.3}/release-notes.md

@@ -2,6 +2,12 @@
 
 ## Latest Changes
 
+## 0.0.3
+
+### Features
+
+* ✨ Add highlight for full file preview. PR [#10](https://github.com/tiangolo/markdown-include-variants/pull/10) by [@tiangolo](https://github.com/tiangolo).
+
 ## 0.0.2
 
 ### Refactors

{markdown_include_variants-0.0.2 → markdown_include_variants-0.0.3}/src/markdown_include_variants/_main.py

@@ -167,6 +167,16 @@ def calculate_includes(
     return lines_groups
 
 
+def generate_hl_string(hl_lines: list[tuple[int, int]]) -> str:
+    hl_lines_strs: list[str] = []
+    for hl_line in hl_lines:
+        if hl_line[0] == hl_line[1]:
+            hl_lines_strs.append(str(hl_line[0]))
+        else:
+            hl_lines_strs.append(f"{hl_line[0]}-{hl_line[1]}")
+    return " ".join(hl_lines_strs)
+
+
 re_line = r"^\{\*\s*(\S+)\s*(.*)\*\}$"
 re_config = r"(\w+)\[([^\]]+)\]"
 
@@ -203,13 +213,7 @@ class IncludeVariantsPreprocessor(Preprocessor):
                         use_hl_lines.extend(info.computed_hl_lines())
                 else:
                     use_hl_lines = highlight_lines
-            use_hl_lines_strs: list[str] = []
-            for hl_line in use_hl_lines:
-                if hl_line[0] == hl_line[1]:
-                    use_hl_lines_strs.append(str(hl_line[0]))
-                else:
-                    use_hl_lines_strs.append(f"{hl_line[0]}-{hl_line[1]}")
-            use_hl_lines_str = " ".join(use_hl_lines_strs)
+            use_hl_lines_str = generate_hl_string(use_hl_lines)
 
             variants = calculate_variants(base_path)
             if len(variants) == 0:
@@ -275,11 +279,15 @@ class IncludeVariantsPreprocessor(Preprocessor):
                 ]
             )
             if include_lines:
+                first_line_full = "```python"
+                if highlight_lines:
+                    hl_lines_full_str = generate_hl_string(highlight_lines)
+                    first_line_full += f' hl_lines="{hl_lines_full_str}"'
                 block_lines.extend(
                     [
                         "//// details | 👀 Full file preview",
                         "",
-                        "```python",
+                        first_line_full,
                         f"{{!{preferred_variant.path}!}}",
                         "```",
                         "",

markdown_include_variants-0.0.3/src/markdown_include_variants/_version.py

@@ -0,0 +1 @@
+__version__ = "0.0.3"

{markdown_include_variants-0.0.2 → markdown_include_variants-0.0.3}/tests/test_all_variants.py

@@ -79,7 +79,7 @@ def test_all_variants_ln_hl():
             <p>```</p>
             <p>////</p>
             <p>//// details | 👀 Full file preview</p>
-            <p><code>python
+            <p><code>python hl_lines="4-5"
             {!docs_src/all_variants/tutorial001_an_py310.py!}</code></p>
             <p>////</p>
             <p>///// details | 🤓 Other versions and variants</p>
@@ -151,9 +151,9 @@ def test_all_variants_ln_hl_include():
             <div class="highlight"><pre><span></span><code><span class="nb">print</span><span class="p">(</span><span class="s2">&quot;an py310 line 1&quot;</span><span class="p">)</span>
             <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;an py310 line 2&quot;</span><span class="p">)</span>
             <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;an py310 line 3&quot;</span><span class="p">)</span>
-            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;an py310 line 4&quot;</span><span class="p">)</span>
-            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;an py310 line 5&quot;</span><span class="p">)</span>
-            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;an py310 line 6&quot;</span><span class="p">)</span>
+            <span class="hll"><span class="nb">print</span><span class="p">(</span><span class="s2">&quot;an py310 line 4&quot;</span><span class="p">)</span>
+            </span><span class="hll"><span class="nb">print</span><span class="p">(</span><span class="s2">&quot;an py310 line 5&quot;</span><span class="p">)</span>
+            </span><span class="nb">print</span><span class="p">(</span><span class="s2">&quot;an py310 line 6&quot;</span><span class="p">)</span>
             <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;an py310 line 7&quot;</span><span class="p">)</span>
             <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;an py310 line 8&quot;</span><span class="p">)</span>
             <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;an py310 line 9&quot;</span><span class="p">)</span>

{markdown_include_variants-0.0.2 → markdown_include_variants-0.0.3}/tests/test_simple_ln_hl.py

@@ -32,7 +32,7 @@ def test_simple_ln_hl():
             <p>```</p>
             <p>////</p>
             <p>//// details | 👀 Full file preview</p>
-            <p><code>python
+            <p><code>python hl_lines="1-3"
             {!docs_src/simple/tutorial001.py!}</code></p>
             <p>////</p>
             """
@@ -64,7 +64,7 @@ def test_simple_ln_hl_middle_block():
             <p>```</p>
             <p>////</p>
             <p>//// details | 👀 Full file preview</p>
-            <p><code>python
+            <p><code>python hl_lines="2-3"
             {!docs_src/simple/tutorial001.py!}</code></p>
             <p>////</p>
             """
@@ -97,7 +97,7 @@ def test_simple_ln_hl_middle_block_end_block():
             ```</p>
             <p>////</p>
             <p>//// details | 👀 Full file preview</p>
-            <p><code>python
+            <p><code>python hl_lines="2-3 8-10"
             {!docs_src/simple/tutorial001.py!}</code></p>
             <p>////</p>
             """
@@ -132,7 +132,7 @@ def test_simple_ln_hl_middle_block_middle_block_end_block():
             ```</p>
             <p>////</p>
             <p>//// details | 👀 Full file preview</p>
-            <p><code>python
+            <p><code>python hl_lines="2-3 5-6 8-10"
             {!docs_src/simple/tutorial001.py!}</code></p>
             <p>////</p>
             """
@@ -167,7 +167,7 @@ def test_simple_ln_hl_middle_middle_block_end():
             ```</p>
             <p>////</p>
             <p>//// details | 👀 Full file preview</p>
-            <p><code>python
+            <p><code>python hl_lines="2 5-6 10"
             {!docs_src/simple/tutorial001.py!}</code></p>
             <p>////</p>
             """
@@ -201,7 +201,7 @@ def test_simple_ln_hl_first_middle_end():
             ```</p>
             <p>////</p>
             <p>//// details | 👀 Full file preview</p>
-            <p><code>python
+            <p><code>python hl_lines="1 6-8 10"
             {!docs_src/simple/tutorial001.py!}</code></p>
             <p>////</p>
             """
@@ -234,7 +234,7 @@ def test_simple_ln_hl_middle_block_end_block_hl_middle_block():
             ```</p>
             <p>////</p>
             <p>//// details | 👀 Full file preview</p>
-            <p><code>python
+            <p><code>python hl_lines="2"
             {!docs_src/simple/tutorial001.py!}</code></p>
             <p>////</p>
             """
@@ -267,7 +267,7 @@ def test_simple_ln_hl_middle_block_end_block_hl_end_block():
             ```</p>
             <p>////</p>
             <p>//// details | 👀 Full file preview</p>
-            <p><code>python
+            <p><code>python hl_lines="8-9"
             {!docs_src/simple/tutorial001.py!}</code></p>
             <p>////</p>
             """
@@ -316,9 +316,9 @@ def test_simple_ln_hl_middle_block_end_block_hl_end_block_include():
             <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;simple line 5&quot;</span><span class="p">)</span>
             <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;simple line 6&quot;</span><span class="p">)</span>
             <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;simple line 7&quot;</span><span class="p">)</span>
-            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;simple line 8&quot;</span><span class="p">)</span>
-            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;simple line 9&quot;</span><span class="p">)</span>
-            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;simple line 10&quot;</span><span class="p">)</span>
+            <span class="hll"><span class="nb">print</span><span class="p">(</span><span class="s2">&quot;simple line 8&quot;</span><span class="p">)</span>
+            </span><span class="hll"><span class="nb">print</span><span class="p">(</span><span class="s2">&quot;simple line 9&quot;</span><span class="p">)</span>
+            </span><span class="nb">print</span><span class="p">(</span><span class="s2">&quot;simple line 10&quot;</span><span class="p">)</span>
             </code></pre></div>
             <p>////</p>
             """

{markdown_include_variants-0.0.2 → markdown_include_variants-0.0.3}/tests/test_up_to_py39.py

@@ -65,7 +65,7 @@ def test_all_variants_ln_hl():
             <p>```</p>
             <p>////</p>
             <p>//// details | 👀 Full file preview</p>
-            <p><code>python
+            <p><code>python hl_lines="4-5"
             {!docs_src/up_to_py39/tutorial001_an_py39.py!}</code></p>
             <p>////</p>
             <p>///// details | 🤓 Other versions and variants</p>

markdown_include_variants-0.0.2/src/markdown_include_variants/_version.py

@@ -1 +0,0 @@
-__version__ = "0.0.2"