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

markdown_include_variants-0.0.1/.github/workflows/check-labels.yml → markdown_include_variants-0.0.3/.github/workflows/labeler.yml

@@ -1,4 +1,4 @@
-name: Check Labels
+name: Labels
 on:
   pull_request_target:
     types:
@@ -10,7 +10,19 @@ on:
       - unlabeled
 
 jobs:
+  labeler:
+    permissions:
+      contents: read
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/labeler@v5
+      if: ${{ github.event.action != 'labeled' && github.event.action != 'unlabeled' }}
+    - run: echo "Done adding labels"
+  # Run this after labeler applied labels
   check-labels:
+    needs:
+      - labeler
     permissions:
       pull-requests: read
     runs-on: ubuntu-latest

{markdown_include_variants-0.0.1 → markdown_include_variants-0.0.3}/.github/workflows/publish.yml

@@ -27,4 +27,4 @@ jobs:
       - name: Build distribution
         run: python -m build
       - name: Publish
-        uses: pypa/gh-action-pypi-publish@v1.9.0
+        uses: pypa/gh-action-pypi-publish@v1.10.3

{markdown_include_variants-0.0.1 → markdown_include_variants-0.0.3}/.github/workflows/smokeshow.yml

@@ -23,6 +23,7 @@ jobs:
         env:
           GITHUB_CONTEXT: ${{ toJson(github) }}
         run: echo "$GITHUB_CONTEXT"
+      - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
           python-version: '3.9'
@@ -39,7 +40,7 @@ jobs:
           path: htmlcov
           github-token: ${{ secrets.GITHUB_TOKEN }}
           run-id: ${{ github.event.workflow_run.id }}
-      - run: uvx smokeshow upload htmlcov
+      - run: uv run smokeshow upload htmlcov
         env:
           SMOKESHOW_GITHUB_STATUS_DESCRIPTION: Coverage {coverage-percentage}
           SMOKESHOW_GITHUB_COVERAGE_THRESHOLD: 100

{markdown_include_variants-0.0.1 → markdown_include_variants-0.0.3}/.github/workflows/test.yml

@@ -33,7 +33,7 @@ jobs:
       - name: Install Dependencies
         run: uv sync
       - name: Lint
-        run: bash scripts/lint.sh
+        run: uv run bash scripts/lint.sh
 
   test:
     runs-on: ubuntu-latest
@@ -61,7 +61,7 @@ jobs:
         run: uv sync
       - run: mkdir coverage
       - name: Test
-        run: uvx bash scripts/test.sh
+        run: uv run bash scripts/test.sh
         env:
           COVERAGE_FILE: coverage/.coverage.${{ runner.os }}-py${{ matrix.python-version }}
           CONTEXT: ${{ runner.os }}-py${{ matrix.python-version }}
@@ -98,9 +98,9 @@ jobs:
           merge-multiple: true
       - run: uv sync
       - run: ls -la coverage
-      - run: uvx coverage combine coverage
-      - run: uvx coverage report
-      - run: uvx coverage html --title "Coverage for ${{ github.sha }}"
+      - run: uv run coverage combine coverage
+      - run: uv run coverage report
+      - run: uv run coverage html --title "Coverage for ${{ github.sha }}"
       - name: Store coverage HTML
         uses: actions/upload-artifact@v4
         with:

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: markdown-include-variants
-Version: 0.0.1
+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
@@ -43,25 +43,54 @@ There are no guarantees about behavior, it is made to suit the needs of these pr
 
 If you're still here it's probably because you are getting involved in one of the projects that use it. 🤓
 
-Here's how it works:
+Here's how it works. 🚀
+
+### Configure Plugin in MkDocs Material
+
+Make sure `mkdocs.yml` has a section with at least these configs:
+
+```yaml
+markdown_extensions:
+  # Python Markdown Extensions
+  pymdownx.highlight:
+  pymdownx.superfences:
+
+  # pymdownx blocks
+  pymdownx.blocks.admonition:
+    types:
+    - tip
+  pymdownx.blocks.details:
+  pymdownx.blocks.tab:
+    alternate_style: True
+
+  # Other extensions
+  mdx_include:
+  markdown_include_variants:
+```
+
+The last config is the one specific to this extension, `markdown-include-variants`.
+
+The other configs are for the extensions that actually render the output, this extension (`markdown-include-variants`) just generates the content to be rendered by those other extensions.
+
+### Workflow
 
 * You add a Python source example to the `docs_src` directory, with the minimum Python version supported by the project, and using the old format without `Annotated`, if that applies, it would be named something like `tutorial001.py`.
-* Copy the file and update it to use `Annotated` (if that applies), and name the file with a "tag" (a prefix) of `an`, like: `tutorial001_an.py`.
+* Copy the file and update it to use `Annotated` (if that applies), and name the file with a "tag" (a prefix) of `_an`, like: `tutorial001_an.py`.
 * Run the internal script to generate the variants of the files for superior versions of Python, like `3.9`, `3.10`, etc. (this internal script is in the project itself). This would generate files like `tutorial001_py39.py`, `tutorial001_py310.py`, etc. and `tutorial001_an_py39.py`, `tutorial001_an_py310.py`, etc.
-* In the Markdown file, include the simplest version of the file, using this syntax:
+* In the Markdown file, include the preferred version of the file, using this syntax:
 
 ```markdown
-{* ./docs_src/first_steps/tutorial001.py *}
+{* ./docs_src/first_steps/tutorial001_an_py310.py *}
 ```
 
-That will be automatically expanded with [mdx-include](https://github.com/neurobin/mdx_include) to include the recommended version of the file (the highest version of Python, using `Annotated`), and will include the variants below in a collapsed `details` box.
+That will be automatically expanded with [mdx-include](https://github.com/neurobin/mdx_include) to include the other variants below in a collapsed `details` box.
 
 ### Include Lines
 
 To include specific line ranges, use the config `ln`:
 
 ```markdown
-{* ./docs_src/first_steps/tutorial001.py ln[3:6,8,10:11] *}
+{* ./docs_src/first_steps/tutorial001_an_py310.py ln[3:6,8,10:11] *}
 ```
 
 That will include only:
@@ -83,7 +112,7 @@ If you include specific lines, it will also add another collapsed `details` box
 You can highlight specific lines using the config `hl`:
 
 ```markdown
-{* ./docs_src/first_steps/tutorial001.py hl[3,5:7,10] *}
+{* ./docs_src/first_steps/tutorial001_an_py310.py hl[3,5:7,10] *}
 ```
 
 That will highlight:
@@ -101,7 +130,7 @@ So, when deciding which lines to highlight, do that based on the highest version
 You can combine both `ln` and `hl`:
 
 ```markdown
-{* ./docs_src/first_steps/tutorial001.py ln[3:6,8,10:11] hl[3,5:6,10] *}
+{* ./docs_src/first_steps/tutorial001_an_py310.py ln[3:6,8,10:11] hl[3,5:6,10] *}
 ```
 
 The highlighted lines refer to the source file (for the highest/recommended version), not the final rendered code block.
@@ -125,7 +154,7 @@ print("line 7")
 Using a declaration like this:
 
 ```markdown
-{* ./docs_src/first_steps/tutorial001.py ln[5:7] hl[6] *}
+{* ./docs_src/first_steps/tutorial001_an_py310.py ln[5:7] hl[6] *}
 ```
 
 Could render something like:

{markdown_include_variants-0.0.1 → markdown_include_variants-0.0.3}/README.md

@@ -26,25 +26,54 @@ There are no guarantees about behavior, it is made to suit the needs of these pr
 
 If you're still here it's probably because you are getting involved in one of the projects that use it. 🤓
 
-Here's how it works:
+Here's how it works. 🚀
+
+### Configure Plugin in MkDocs Material
+
+Make sure `mkdocs.yml` has a section with at least these configs:
+
+```yaml
+markdown_extensions:
+  # Python Markdown Extensions
+  pymdownx.highlight:
+  pymdownx.superfences:
+
+  # pymdownx blocks
+  pymdownx.blocks.admonition:
+    types:
+    - tip
+  pymdownx.blocks.details:
+  pymdownx.blocks.tab:
+    alternate_style: True
+
+  # Other extensions
+  mdx_include:
+  markdown_include_variants:
+```
+
+The last config is the one specific to this extension, `markdown-include-variants`.
+
+The other configs are for the extensions that actually render the output, this extension (`markdown-include-variants`) just generates the content to be rendered by those other extensions.
+
+### Workflow
 
 * You add a Python source example to the `docs_src` directory, with the minimum Python version supported by the project, and using the old format without `Annotated`, if that applies, it would be named something like `tutorial001.py`.
-* Copy the file and update it to use `Annotated` (if that applies), and name the file with a "tag" (a prefix) of `an`, like: `tutorial001_an.py`.
+* Copy the file and update it to use `Annotated` (if that applies), and name the file with a "tag" (a prefix) of `_an`, like: `tutorial001_an.py`.
 * Run the internal script to generate the variants of the files for superior versions of Python, like `3.9`, `3.10`, etc. (this internal script is in the project itself). This would generate files like `tutorial001_py39.py`, `tutorial001_py310.py`, etc. and `tutorial001_an_py39.py`, `tutorial001_an_py310.py`, etc.
-* In the Markdown file, include the simplest version of the file, using this syntax:
+* In the Markdown file, include the preferred version of the file, using this syntax:
 
 ```markdown
-{* ./docs_src/first_steps/tutorial001.py *}
+{* ./docs_src/first_steps/tutorial001_an_py310.py *}
 ```
 
-That will be automatically expanded with [mdx-include](https://github.com/neurobin/mdx_include) to include the recommended version of the file (the highest version of Python, using `Annotated`), and will include the variants below in a collapsed `details` box.
+That will be automatically expanded with [mdx-include](https://github.com/neurobin/mdx_include) to include the other variants below in a collapsed `details` box.
 
 ### Include Lines
 
 To include specific line ranges, use the config `ln`:
 
 ```markdown
-{* ./docs_src/first_steps/tutorial001.py ln[3:6,8,10:11] *}
+{* ./docs_src/first_steps/tutorial001_an_py310.py ln[3:6,8,10:11] *}
 ```
 
 That will include only:
@@ -66,7 +95,7 @@ If you include specific lines, it will also add another collapsed `details` box
 You can highlight specific lines using the config `hl`:
 
 ```markdown
-{* ./docs_src/first_steps/tutorial001.py hl[3,5:7,10] *}
+{* ./docs_src/first_steps/tutorial001_an_py310.py hl[3,5:7,10] *}
 ```
 
 That will highlight:
@@ -84,7 +113,7 @@ So, when deciding which lines to highlight, do that based on the highest version
 You can combine both `ln` and `hl`:
 
 ```markdown
-{* ./docs_src/first_steps/tutorial001.py ln[3:6,8,10:11] hl[3,5:6,10] *}
+{* ./docs_src/first_steps/tutorial001_an_py310.py ln[3:6,8,10:11] hl[3,5:6,10] *}
 ```
 
 The highlighted lines refer to the source file (for the highest/recommended version), not the final rendered code block.
@@ -108,7 +137,7 @@ print("line 7")
 Using a declaration like this:
 
 ```markdown
-{* ./docs_src/first_steps/tutorial001.py ln[5:7] hl[6] *}
+{* ./docs_src/first_steps/tutorial001_an_py310.py ln[5:7] hl[6] *}
 ```
 
 Could render something like:

markdown_include_variants-0.0.3/release-notes.md

@@ -0,0 +1,28 @@
+# Release Notes
+
+## 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
+
+* ♻️ Make the preferred variant the one used in the include. PR [#9](https://github.com/tiangolo/markdown-include-variants/pull/9) by [@tiangolo](https://github.com/tiangolo).
+
+### Docs
+
+* 📝 Fix MkDocs config example. PR [#8](https://github.com/tiangolo/markdown-include-variants/pull/8) by [@tiangolo](https://github.com/tiangolo).
+* 📝 Update README with mkdocs.yml configs. PR [#6](https://github.com/tiangolo/markdown-include-variants/pull/6) by [@tiangolo](https://github.com/tiangolo).
+
+### Internal
+
+* ⬆ Bump pypa/gh-action-pypi-publish from 1.9.0 to 1.10.3. PR [#1](https://github.com/tiangolo/markdown-include-variants/pull/1) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* 👷 Tweak labeler GitHub Action. PR [#7](https://github.com/tiangolo/markdown-include-variants/pull/7) by [@tiangolo](https://github.com/tiangolo).
+* 👷 Fix smokeshow setup. PR [#4](https://github.com/tiangolo/markdown-include-variants/pull/4) by [@tiangolo](https://github.com/tiangolo).
+* 👷 Tweak labeler GitHub Action to not change labels on manual labels. PR [#5](https://github.com/tiangolo/markdown-include-variants/pull/5) by [@tiangolo](https://github.com/tiangolo).
+* 👷 Tweak CI and types. PR [#2](https://github.com/tiangolo/markdown-include-variants/pull/2) by [@tiangolo](https://github.com/tiangolo).

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

@@ -1,7 +1,7 @@
 import re
 from dataclasses import dataclass
 from pathlib import Path
-from typing import Literal, Union
+from typing import Any, Literal, Union
 
 from markdown import Extension, Markdown
 from markdown.preprocessors import Preprocessor
@@ -15,8 +15,17 @@ class Variant:
     version: Literal["py38", "py39", "py310"]
 
 
+def remove_suffixes(base_name: str, suffixes: list[str]) -> str:
+    for suffix in suffixes:
+        if base_name.endswith(suffix):
+            base_name = base_name[: -len(suffix)]
+            return remove_suffixes(base_name, suffixes)
+    return base_name
+
+
 def calculate_variants(base_path: Path) -> dict[tuple[str, Union[bool, None]], Variant]:
-    base_name = base_path.stem
+    preferred_name = base_path.stem
+    base_name = remove_suffixes(preferred_name, ["_an", "_py39", "_py310"])
     base_dir = base_path.parent
     variants: dict[tuple[str, Union[bool, None]], Variant] = {}
     an = "_an"
@@ -24,12 +33,16 @@ def calculate_variants(base_path: Path) -> dict[tuple[str, Union[bool, None]], V
     py310 = "_py310"
     an_p310_path = base_dir / f"{base_name}{an}{py310}.py"
     an_p39_path = base_dir / f"{base_name}{an}{py39}.py"
-    an_path = base_dir / f"{base_name}{an}.py"
+    an_p38_path = base_dir / f"{base_name}{an}.py"
     p310_path = base_dir / f"{base_name}{py310}.py"
     p39_path = base_dir / f"{base_name}{py39}.py"
+    p38_path = base_dir / f"{base_name}.py"
     if an_p310_path.exists():
         v = Variant(
-            path=an_p310_path, title="Python 3.10+", is_annotated=True, version="py310"
+            path=an_p310_path,
+            title="Python 3.10+",
+            is_annotated=True,
+            version="py310",
         )
         variants[(v.version, v.is_annotated)] = v
         if p310_path.exists():
@@ -42,12 +55,18 @@ def calculate_variants(base_path: Path) -> dict[tuple[str, Union[bool, None]], V
             variants[(v.version, v.is_annotated)] = v
     elif p310_path.exists():
         v = Variant(
-            path=p310_path, title="Python 3.10+", is_annotated=None, version="py310"
+            path=p310_path,
+            title="Python 3.10+",
+            is_annotated=None,
+            version="py310",
         )
         variants[(v.version, v.is_annotated)] = v
     if an_p39_path.exists():
         v = Variant(
-            path=an_p39_path, title="Python 3.9+", is_annotated=True, version="py39"
+            path=an_p39_path,
+            title="Python 3.9+",
+            is_annotated=True,
+            version="py39",
         )
         variants[(v.version, v.is_annotated)] = v
         if p39_path.exists():
@@ -60,25 +79,34 @@ def calculate_variants(base_path: Path) -> dict[tuple[str, Union[bool, None]], V
             variants[(v.version, v.is_annotated)] = v
     elif p39_path.exists():
         v = Variant(
-            path=p39_path, title="Python 3.9+", is_annotated=None, version="py39"
+            path=p39_path,
+            title="Python 3.9+",
+            is_annotated=None,
+            version="py39",
         )
         variants[(v.version, v.is_annotated)] = v
-    if an_path.exists():
+    if an_p38_path.exists():
         v = Variant(
-            path=an_path, title="Python 3.8+", is_annotated=True, version="py38"
+            path=an_p38_path,
+            title="Python 3.8+",
+            is_annotated=True,
+            version="py38",
         )
         variants[(v.version, v.is_annotated)] = v
-        if base_path.exists():
+        if p38_path.exists():
             v = Variant(
-                path=base_path,
+                path=p38_path,
                 title="Python 3.8+ - non-Annotated",
                 is_annotated=False,
                 version="py38",
             )
             variants[(v.version, v.is_annotated)] = v
-    elif base_path.exists():
+    elif p38_path.exists():
         v = Variant(
-            path=base_path, title="Python 3.8+", is_annotated=None, version="py38"
+            path=p38_path,
+            title="Python 3.8+",
+            is_annotated=None,
+            version="py38",
         )
         variants[(v.version, v.is_annotated)] = v
     return variants
@@ -139,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+)\[([^\]]+)\]"
 
@@ -175,25 +213,23 @@ 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:
                 raise FileNotFoundError(f"Could not find any variants for {base_path}")
             sorted_variants: list[Variant] = []
+            preferred_variant = None
             for an in [True, False, None]:
                 for version in ["py310", "py39", "py38"]:
                     v = variants.get((version, an))
                     if v:
-                        sorted_variants.append(v)
-            assert sorted_variants
-            preferred_variant = sorted_variants[0]
+                        if v.path == base_path:
+                            assert preferred_variant is None
+                            preferred_variant = v
+                        else:
+                            sorted_variants.append(v)
+            assert preferred_variant is not None
             content_lines = preferred_variant.path.read_text().splitlines()
 
             internal_block_lines: list[str] = []
@@ -243,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}!}}",
                         "```",
                         "",
@@ -255,7 +295,7 @@ class IncludeVariantsPreprocessor(Preprocessor):
                         "",
                     ]
                 )
-            if len(sorted_variants) > 1:
+            if len(sorted_variants):
                 block_lines.extend(
                     [
                         "///// details | 🤓 Other versions and variants",
@@ -263,7 +303,7 @@ class IncludeVariantsPreprocessor(Preprocessor):
                     ]
                 )
 
-                for variant in sorted_variants[1:]:
+                for variant in sorted_variants:
                     block_lines.extend([f"//// tab | {variant.title}", ""])
                     if variant.is_annotated is False:
                         block_lines.extend(
@@ -304,5 +344,7 @@ class IncludeVariantsExtension(Extension):
         )
 
 
-def makeExtension(*args, **kwargs):  # pragma: no cover
+def makeExtension(
+    *args: Any, **kwargs: Any
+) -> IncludeVariantsExtension:  # pragma: no cover
     return IncludeVariantsExtension(*args, **kwargs)

markdown_include_variants-0.0.3/src/markdown_include_variants/_version.py

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

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

@@ -12,7 +12,7 @@ from markdown_include_variants import IncludeVariantsExtension
 def test_all_variants_plain():
     input_md = inspect.cleandoc(
         """
-        {* docs_src/all_variants/tutorial001.py *}
+        {* docs_src/all_variants/tutorial001_an_py310.py *}
         """
     )
 
@@ -63,7 +63,7 @@ def test_all_variants_plain():
 def test_all_variants_ln_hl():
     input_md = inspect.cleandoc(
         """
-        {* docs_src/all_variants/tutorial001.py ln[3:5] hl[4:5] *}
+        {* docs_src/all_variants/tutorial001_an_py310.py ln[3:5] hl[4:5] *}
         """
     )
 
@@ -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>
@@ -121,7 +121,7 @@ def test_all_variants_ln_hl():
 def test_all_variants_ln_hl_include():
     input_md = inspect.cleandoc(
         """
-        {* docs_src/all_variants/tutorial001.py ln[3:5] hl[4:5] *}
+        {* docs_src/all_variants/tutorial001_an_py310.py ln[3:5] hl[4:5] *}
         """
     )
 
@@ -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.3/tests/test_another_preferred_variant.py

@@ -0,0 +1,57 @@
+import inspect
+
+import markdown
+from inline_snapshot import snapshot
+
+from markdown_include_variants import IncludeVariantsExtension
+
+
+def test_all_variants_plain():
+    input_md = inspect.cleandoc(
+        """
+        {* docs_src/all_variants/tutorial001_an_py39.py *}
+        """
+    )
+
+    result = markdown.markdown(input_md, extensions=[IncludeVariantsExtension()])
+    assert result == snapshot(
+        inspect.cleandoc(
+            """
+            <p>//// tab | Python 3.9+
+            <code>python
+            {!docs_src/all_variants/tutorial001_an_py39.py!}</code></p>
+            <p>////</p>
+            <p>///// details | 🤓 Other versions and variants</p>
+            <p>//// tab | Python 3.10+</p>
+            <p><code>python
+            {!docs_src/all_variants/tutorial001_an_py310.py!}</code>
+            ////
+            //// tab | Python 3.8+</p>
+            <p><code>python
+            {!docs_src/all_variants/tutorial001_an.py!}</code>
+            ////
+            //// tab | Python 3.10+ - non-Annotated</p>
+            <p>/// tip</p>
+            <p>Prefer to use the <code>Annotated</code> version if possible.</p>
+            <p>///</p>
+            <p><code>python
+            {!docs_src/all_variants/tutorial001_py310.py!}</code>
+            ////
+            //// tab | Python 3.9+ - non-Annotated</p>
+            <p>/// tip</p>
+            <p>Prefer to use the <code>Annotated</code> version if possible.</p>
+            <p>///</p>
+            <p><code>python
+            {!docs_src/all_variants/tutorial001_py39.py!}</code>
+            ////
+            //// tab | Python 3.8+ - non-Annotated</p>
+            <p>/// tip</p>
+            <p>Prefer to use the <code>Annotated</code> version if possible.</p>
+            <p>///</p>
+            <p><code>python
+            {!docs_src/all_variants/tutorial001.py!}</code>
+            ////</p>
+            <p>/////</p>
+            """
+        )
+    )

{markdown_include_variants-0.0.1 → markdown_include_variants-0.0.3}/tests/test_no_py39.py

@@ -9,7 +9,7 @@ from markdown_include_variants import IncludeVariantsExtension
 def test_all_variants_plain():
     input_md = inspect.cleandoc(
         """
-        {* docs_src/no_py39/tutorial001.py *}
+        {* docs_src/no_py39/tutorial001_an_py310.py *}
         """
     )
 

{markdown_include_variants-0.0.1 → markdown_include_variants-0.0.3}/tests/test_only_py310.py

@@ -9,7 +9,7 @@ from markdown_include_variants import IncludeVariantsExtension
 def test_all_variants_plain():
     input_md = inspect.cleandoc(
         """
-        {* docs_src/only_py310/tutorial001.py *}
+        {* docs_src/only_py310/tutorial001_an_py310.py *}
         """
     )
 

{markdown_include_variants-0.0.1 → markdown_include_variants-0.0.3}/tests/test_only_py_no_an.py

@@ -9,7 +9,7 @@ from markdown_include_variants import IncludeVariantsExtension
 def test_all_variants_plain():
     input_md = inspect.cleandoc(
         """
-        {* docs_src/only_py_no_an/tutorial001.py *}
+        {* docs_src/only_py_no_an/tutorial001_py310.py *}
         """
     )
 

{markdown_include_variants-0.0.1 → 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.1 → markdown_include_variants-0.0.3}/tests/test_up_to_py39.py

@@ -9,7 +9,7 @@ from markdown_include_variants import IncludeVariantsExtension
 def test_all_variants_plain():
     input_md = inspect.cleandoc(
         """
-        {* docs_src/up_to_py39/tutorial001.py *}
+        {* docs_src/up_to_py39/tutorial001_an_py39.py *}
         """
     )
 
@@ -49,7 +49,7 @@ def test_all_variants_plain():
 def test_all_variants_ln_hl():
     input_md = inspect.cleandoc(
         """
-        {* docs_src/up_to_py39/tutorial001.py ln[3:5] hl[4:5] *}
+        {* docs_src/up_to_py39/tutorial001_an_py39.py ln[3:5] hl[4:5] *}
         """
     )
 
@@ -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.1/.github/workflows/add-labels.yml

@@ -1,16 +0,0 @@
-name: Add Labels
-on:
-  pull_request_target:
-    types:
-      - opened
-      - synchronize
-      - reopened
-
-jobs:
-  labeler:
-    permissions:
-      contents: read
-      pull-requests: write
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/labeler@v5

markdown_include_variants-0.0.1/release-notes.md

@@ -1,3 +0,0 @@
-# Release Notes
-
-## Latest Changes

markdown_include_variants-0.0.1/src/markdown_include_variants/_version.py

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