markdown-include-variants 0.0.4__tar.gz → 0.0.5__tar.gz

{markdown_include_variants-0.0.4 → markdown_include_variants-0.0.5}/.github/workflows/publish.yml

@@ -3,7 +3,7 @@ name: Publish
 on:
   release:
     types:
-      - created
+      - released
   workflow_dispatch:
     inputs:
       debug_enabled:
@@ -27,4 +27,4 @@ jobs:
       - name: Build distribution
         run: python -m build
       - name: Publish
-        uses: pypa/gh-action-pypi-publish@v1.12.3
+        uses: pypa/gh-action-pypi-publish@v1.12.4

{markdown_include_variants-0.0.4 → markdown_include_variants-0.0.5}/.github/workflows/smokeshow.yml

@@ -28,7 +28,7 @@ jobs:
         with:
           python-version: '3.9'
       - name: Setup uv
-        uses: astral-sh/setup-uv@v5
+        uses: astral-sh/setup-uv@v6
         with:
           version: "0.4.15"
           enable-cache: true

{markdown_include_variants-0.0.4 → markdown_include_variants-0.0.5}/.github/workflows/test.yml

@@ -26,7 +26,7 @@ jobs:
         with:
           python-version: "3.11"
       - name: Setup uv
-        uses: astral-sh/setup-uv@v5
+        uses: astral-sh/setup-uv@v6
         with:
           version: "0.4.15"
           enable-cache: true
@@ -53,7 +53,7 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
       - name: Setup uv
-        uses: astral-sh/setup-uv@v5
+        uses: astral-sh/setup-uv@v6
         with:
           version: "0.4.15"
           enable-cache: true
@@ -86,7 +86,7 @@ jobs:
         with:
           python-version: '3.11'
       - name: Setup uv
-        uses: astral-sh/setup-uv@v5
+        uses: astral-sh/setup-uv@v6
         with:
           version: "0.4.15"
           enable-cache: true

{markdown_include_variants-0.0.4 → markdown_include_variants-0.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: markdown-include-variants
-Version: 0.0.4
+Version: 0.0.5
 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.5/docs_src/all_variants/tutorial001_an_py311.py

@@ -0,0 +1,10 @@
+print("an py311 line 1")
+print("an py311 line 2")
+print("an py311 line 3")
+print("an py311 line 4")
+print("an py311 line 5")
+print("an py311 line 6")
+print("an py311 line 7")
+print("an py311 line 8")
+print("an py311 line 9")
+print("an py311 line 10")

markdown_include_variants-0.0.5/docs_src/all_variants/tutorial001_py311.py

@@ -0,0 +1,10 @@
+print("py311 line 1")
+print("py311 line 2")
+print("py311 line 3")
+print("py311 line 4")
+print("py311 line 5")
+print("py311 line 6")
+print("py311 line 7")
+print("py311 line 8")
+print("py311 line 9")
+print("py311 line 10")

markdown_include_variants-0.0.5/docs_src/only_py_no_an/tutorial001_py311.py

@@ -0,0 +1,10 @@
+print("py311 line 1")
+print("py311 line 2")
+print("py311 line 3")
+print("py311 line 4")
+print("py311 line 5")
+print("py311 line 6")
+print("py311 line 7")
+print("py311 line 8")
+print("py311 line 9")
+print("py311 line 10")

{markdown_include_variants-0.0.4 → markdown_include_variants-0.0.5}/release-notes.md

@@ -2,6 +2,18 @@
 
 ## Latest Changes
 
+## 0.0.5
+
+### Features
+
+* ✨ Support Python 3.11. PR [#28](https://github.com/tiangolo/markdown-include-variants/pull/28) by [@svlandeg](https://github.com/svlandeg).
+
+### Internal
+
+* ⬆ Bump astral-sh/setup-uv from 5 to 6. PR [#22](https://github.com/tiangolo/markdown-include-variants/pull/22) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* ⬆ Bump pypa/gh-action-pypi-publish from 1.12.3 to 1.12.4. PR [#21](https://github.com/tiangolo/markdown-include-variants/pull/21) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* 👷 Publish on release released. PR [#20](https://github.com/tiangolo/markdown-include-variants/pull/20) by [@tiangolo](https://github.com/tiangolo).
+
 ## 0.0.4
 
 ### Features

{markdown_include_variants-0.0.4 → markdown_include_variants-0.0.5}/src/markdown_include_variants/_main.py

@@ -12,7 +12,7 @@ class Variant:
     path: Path
     title: str
     is_annotated: Union[bool, None]
-    version: Literal["py38", "py39", "py310"]
+    version: Literal["py38", "py39", "py310", "py311"]
 
 
 def remove_suffixes(base_name: str, suffixes: list[str]) -> str:
@@ -25,18 +25,45 @@ def remove_suffixes(base_name: str, suffixes: list[str]) -> str:
 
 def calculate_variants(base_path: Path) -> dict[tuple[str, Union[bool, None]], Variant]:
     preferred_name = base_path.stem
-    base_name = remove_suffixes(preferred_name, ["_an", "_py39", "_py310"])
+    base_name = remove_suffixes(preferred_name, ["_an", "_py39", "_py310", "_py311"])
     base_dir = base_path.parent
     variants: dict[tuple[str, Union[bool, None]], Variant] = {}
     an = "_an"
     py39 = "_py39"
     py310 = "_py310"
+    py311 = "_py311"
+    an_p311_path = base_dir / f"{base_name}{an}{py311}.py"
     an_p310_path = base_dir / f"{base_name}{an}{py310}.py"
     an_p39_path = base_dir / f"{base_name}{an}{py39}.py"
     an_p38_path = base_dir / f"{base_name}{an}.py"
+    p311_path = base_dir / f"{base_name}{py311}.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_p311_path.exists():
+        v = Variant(
+            path=an_p311_path,
+            title="Python 3.11+",
+            is_annotated=True,
+            version="py311",
+        )
+        variants[(v.version, v.is_annotated)] = v
+        if p311_path.exists():
+            v = Variant(
+                path=p311_path,
+                title="Python 3.11+ - non-Annotated",
+                is_annotated=False,
+                version="py311",
+            )
+            variants[(v.version, v.is_annotated)] = v
+    elif p311_path.exists():
+        v = Variant(
+            path=p311_path,
+            title="Python 3.11+",
+            is_annotated=None,
+            version="py311",
+        )
+        variants[(v.version, v.is_annotated)] = v
     if an_p310_path.exists():
         v = Variant(
             path=an_p310_path,
@@ -221,7 +248,7 @@ class IncludeVariantsPreprocessor(Preprocessor):
             sorted_variants: list[Variant] = []
             preferred_variant = None
             for an in [True, False, None]:
-                for version in ["py310", "py39", "py38"]:
+                for version in ["py311", "py310", "py39", "py38"]:
                     v = variants.get((version, an))
                     if v:
                         if v.path == base_path:

markdown_include_variants-0.0.5/src/markdown_include_variants/_version.py

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

{markdown_include_variants-0.0.4 → markdown_include_variants-0.0.5}/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_an_py310.py *}
+        {* docs_src/all_variants/tutorial001_an_py311.py *}
         """
     )
 
@@ -20,12 +20,16 @@ def test_all_variants_plain():
     assert result == snapshot(
         inspect.cleandoc(
             """
-            <p>//// tab | Python 3.10+
+            <p>//// tab | Python 3.11+
             <code>python
-            {!docs_src/all_variants/tutorial001_an_py310.py!}</code></p>
+            {!docs_src/all_variants/tutorial001_an_py311.py!}</code></p>
             <p>////</p>
             <p>///// details | 🤓 Other versions and variants</p>
-            <p>//// tab | Python 3.9+</p>
+            <p>//// tab | Python 3.10+</p>
+            <p><code>python
+            {!docs_src/all_variants/tutorial001_an_py310.py!}</code>
+            ////
+            //// tab | Python 3.9+</p>
             <p><code>python
             {!docs_src/all_variants/tutorial001_an_py39.py!}</code>
             ////
@@ -33,6 +37,13 @@ def test_all_variants_plain():
             <p><code>python
             {!docs_src/all_variants/tutorial001_an.py!}</code>
             ////
+            //// tab | Python 3.11+ - 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_py311.py!}</code>
+            ////
             //// tab | Python 3.10+ - non-Annotated</p>
             <p>/// tip</p>
             <p>Prefer to use the <code>Annotated</code> version if possible.</p>
@@ -63,7 +74,7 @@ def test_all_variants_plain():
 def test_all_variants_ln_hl():
     input_md = inspect.cleandoc(
         """
-        {* docs_src/all_variants/tutorial001_an_py310.py ln[3:5] hl[4:5] *}
+        {* docs_src/all_variants/tutorial001_an_py311.py ln[3:5] hl[4:5] *}
         """
     )
 
@@ -71,21 +82,25 @@ def test_all_variants_ln_hl():
     assert result == snapshot(
         inspect.cleandoc(
             """
-            <p>//// tab | Python 3.10+
+            <p>//// tab | Python 3.11+
             ```python hl_lines="4-5"</p>
             <h1>Code above omitted 👆</h1>
-            <p>{!docs_src/all_variants/tutorial001_an_py310.py[ln:3-5]!}</p>
+            <p>{!docs_src/all_variants/tutorial001_an_py311.py[ln:3-5]!}</p>
             <h1>Code below omitted 👇</h1>
             <p>```</p>
             <p>////</p>
             <p>///// details | 👀 Full file preview</p>
-            <p>//// tab | Python 3.10+</p>
+            <p>//// tab | Python 3.11+</p>
             <p><code>python hl_lines="4-5"
-            {!docs_src/all_variants/tutorial001_an_py310.py!}</code></p>
+            {!docs_src/all_variants/tutorial001_an_py311.py!}</code></p>
             <p>////</p>
             <p>/////</p>
             <p>///// details | 🤓 Other versions and variants</p>
-            <p>//// tab | Python 3.9+</p>
+            <p>//// tab | Python 3.10+</p>
+            <p><code>python
+            {!docs_src/all_variants/tutorial001_an_py310.py!}</code>
+            ////
+            //// tab | Python 3.9+</p>
             <p><code>python
             {!docs_src/all_variants/tutorial001_an_py39.py!}</code>
             ////
@@ -93,6 +108,13 @@ def test_all_variants_ln_hl():
             <p><code>python
             {!docs_src/all_variants/tutorial001_an.py!}</code>
             ////
+            //// tab | Python 3.11+ - 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_py311.py!}</code>
+            ////
             //// tab | Python 3.10+ - non-Annotated</p>
             <p>/// tip</p>
             <p>Prefer to use the <code>Annotated</code> version if possible.</p>
@@ -123,7 +145,7 @@ def test_all_variants_ln_hl():
 def test_all_variants_ln_hl_include():
     input_md = inspect.cleandoc(
         """
-        {* docs_src/all_variants/tutorial001_an_py310.py ln[3:5] hl[4:5] *}
+        {* docs_src/all_variants/tutorial001_an_py311.py ln[3:5] hl[4:5] *}
         """
     )
 
@@ -139,33 +161,46 @@ def test_all_variants_ln_hl_include():
     assert result == snapshot(
         inspect.cleandoc(
             """
-            <p>//// tab | Python 3.10+
+            <p>//// tab | Python 3.11+
             <div class="highlight"><pre><span></span><code><span class="c1"># Code above omitted 👆</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="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 class="nb">print</span><span class="p">(</span><span class="s2">&quot;an py311 line 3&quot;</span><span class="p">)</span>
+            <span class="hll"><span class="nb">print</span><span class="p">(</span><span class="s2">&quot;an py311 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 py311 line 5&quot;</span><span class="p">)</span>
             </span>
             <span class="c1"># Code below omitted 👇</span>
             </code></pre></div></p>
             <p>////</p>
             <p>///// details | 👀 Full file preview</p>
+            <p>//// tab | Python 3.11+</p>
+            <div class="highlight"><pre><span></span><code><span class="nb">print</span><span class="p">(</span><span class="s2">&quot;an py311 line 1&quot;</span><span class="p">)</span>
+            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;an py311 line 2&quot;</span><span class="p">)</span>
+            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;an py311 line 3&quot;</span><span class="p">)</span>
+            <span class="hll"><span class="nb">print</span><span class="p">(</span><span class="s2">&quot;an py311 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 py311 line 5&quot;</span><span class="p">)</span>
+            </span><span class="nb">print</span><span class="p">(</span><span class="s2">&quot;an py311 line 6&quot;</span><span class="p">)</span>
+            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;an py311 line 7&quot;</span><span class="p">)</span>
+            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;an py311 line 8&quot;</span><span class="p">)</span>
+            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;an py311 line 9&quot;</span><span class="p">)</span>
+            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;an py311 line 10&quot;</span><span class="p">)</span>
+            </code></pre></div>
+            <p>////</p>
+            <p>/////</p>
+            <p>///// details | 🤓 Other versions and variants</p>
             <p>//// tab | Python 3.10+</p>
-            <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>
+            <p><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="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 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="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>
             <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;an py310 line 10&quot;</span><span class="p">)</span>
             </code></pre></div>
-            <p>////</p>
-            <p>/////</p>
-            <p>///// details | 🤓 Other versions and variants</p>
-            <p>//// tab | Python 3.9+</p>
+            ////
+            //// tab | Python 3.9+</p>
             <p><div class="highlight"><pre><span></span><code><span class="nb">print</span><span class="p">(</span><span class="s2">&quot;an py39 line 1&quot;</span><span class="p">)</span>
             <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;an py39 line 2&quot;</span><span class="p">)</span>
             <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;an py39 line 3&quot;</span><span class="p">)</span>
@@ -191,6 +226,22 @@ def test_all_variants_ln_hl_include():
             <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;an line 10&quot;</span><span class="p">)</span>
             </code></pre></div>
             ////
+            //// tab | Python 3.11+ - non-Annotated</p>
+            <p>/// tip</p>
+            <p>Prefer to use the <code>Annotated</code> version if possible.</p>
+            <p>///</p>
+            <p><div class="highlight"><pre><span></span><code><span class="nb">print</span><span class="p">(</span><span class="s2">&quot;py311 line 1&quot;</span><span class="p">)</span>
+            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;py311 line 2&quot;</span><span class="p">)</span>
+            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;py311 line 3&quot;</span><span class="p">)</span>
+            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;py311 line 4&quot;</span><span class="p">)</span>
+            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;py311 line 5&quot;</span><span class="p">)</span>
+            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;py311 line 6&quot;</span><span class="p">)</span>
+            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;py311 line 7&quot;</span><span class="p">)</span>
+            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;py311 line 8&quot;</span><span class="p">)</span>
+            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;py311 line 9&quot;</span><span class="p">)</span>
+            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;py311 line 10&quot;</span><span class="p">)</span>
+            </code></pre></div>
+            ////
             //// tab | Python 3.10+ - non-Annotated</p>
             <p>/// tip</p>
             <p>Prefer to use the <code>Annotated</code> version if possible.</p>

{markdown_include_variants-0.0.4 → markdown_include_variants-0.0.5}/tests/test_another_preferred_variant.py

@@ -22,7 +22,11 @@ def test_all_variants_plain():
             {!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>//// tab | Python 3.11+</p>
+            <p><code>python
+            {!docs_src/all_variants/tutorial001_an_py311.py!}</code>
+            ////
+            //// tab | Python 3.10+</p>
             <p><code>python
             {!docs_src/all_variants/tutorial001_an_py310.py!}</code>
             ////
@@ -30,6 +34,13 @@ def test_all_variants_plain():
             <p><code>python
             {!docs_src/all_variants/tutorial001_an.py!}</code>
             ////
+            //// tab | Python 3.11+ - 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_py311.py!}</code>
+            ////
             //// tab | Python 3.10+ - non-Annotated</p>
             <p>/// tip</p>
             <p>Prefer to use the <code>Annotated</code> version if possible.</p>

{markdown_include_variants-0.0.4 → markdown_include_variants-0.0.5}/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_py310.py *}
+        {* docs_src/only_py_no_an/tutorial001_py311.py *}
         """
     )
 
@@ -17,12 +17,16 @@ def test_all_variants_plain():
     assert result == snapshot(
         inspect.cleandoc(
             """
-            <p>//// tab | Python 3.10+
+            <p>//// tab | Python 3.11+
             <code>python
-            {!docs_src/only_py_no_an/tutorial001_py310.py!}</code></p>
+            {!docs_src/only_py_no_an/tutorial001_py311.py!}</code></p>
             <p>////</p>
             <p>///// details | 🤓 Other versions and variants</p>
-            <p>//// tab | Python 3.9+</p>
+            <p>//// tab | Python 3.10+</p>
+            <p><code>python
+            {!docs_src/only_py_no_an/tutorial001_py310.py!}</code>
+            ////
+            //// tab | Python 3.9+</p>
             <p><code>python
             {!docs_src/only_py_no_an/tutorial001_py39.py!}</code>
             ////

markdown_include_variants-0.0.4/src/markdown_include_variants/_version.py

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