importpython-markdown 0.1.0__py3-none-any.whl → 0.1.2__py3-none-any.whl

importpython_markdown/__init__.py

@@ -14,8 +14,11 @@ time in the element's own vocabulary, so an authoring mistake is
 a loud build failure rather than a silent page.
 
 The emitted markup follows the element's contract exactly: each
-part is a bare ``<pre>``, a direct child of the element, in the
-order the author wrote it.
+part is a ``<pre>`` holding one ``<code>``, the pre a direct
+child of the element, in the order the author wrote it. The
+element reads a ``<pre><code>`` pair and a bare ``<pre>``
+identically; the inner ``<code>`` is for the surrounding theme,
+whose block styling and copy button expect it.
 """
 
 import html
@@ -49,8 +52,9 @@ ATTRIBUTE = re.compile(r'([\w-]+)(?:="([^"]*)")?')
 # fail the build, not be silently ignored in every reader's
 # browser.
 TYPES = ("py", "mpy")
-FLAGS = ("terminal", "debug")
-VALUED = ("title", "run-label", "stop-label", "theme", "class", "id")
+FLAGS = ("terminal", "debug", "send-embedder-url")
+VALUED = ("title", "run-label", "stop-label", "theme", "class",
+          "id", "terminal-rows", "terminal-cols")
 
 
 class ExampleError(ValueError):
@@ -106,6 +110,23 @@ def parse_gate(header, line):
         raise ExampleError(
             line, f'cannot parse attributes at "{rest[span:]}"'
         )
+    # The terminal's explicit size: each dimension needs the
+    # terminal it sizes, and only a positive whole number will do
+    # - the same rules the element applies, failing the build
+    # here instead of a reader's browser there.
+    for name in ("terminal-rows", "terminal-cols"):
+        if name in attributes:
+            if "terminal" not in attributes:
+                raise ExampleError(
+                    line, f"{name} requires the terminal flag"
+                )
+            value = attributes[name]
+            if not (value.isdigit() and int(value) >= 1):
+                raise ExampleError(
+                    line,
+                    f'{name} is "{value}"; use a positive whole '
+                    "number",
+                )
     return attributes
 
 
@@ -173,7 +194,7 @@ def split_example(lines, first_line):
     return pieces
 
 
-def validate(pieces, line):
+def validate(pieces, attributes, line):
     """
     The element's own rules, applied at build time: exactly one
     program, no duplicate filenames, at most one config (as valid
@@ -201,12 +222,37 @@ def validate(pieces, line):
             )
     for piece in [p for p in pieces if p["part"] == "config"]:
         try:
-            json.loads("\n".join(piece["text"]))
+            settings = json.loads("\n".join(piece["text"]))
         except json.JSONDecodeError as error:
             raise ExampleError(
                 piece["line"],
                 f"the config block is not valid JSON: {error}",
             ) from None
+        # send-embedder-url writes importpython.py, so while the
+        # flag is on the name is reserved - here in the author's
+        # own config files too, matching the element's rule.
+        if "send-embedder-url" in attributes:
+            names = (settings.get("files") or {}).values()
+            if any(
+                str(name).removeprefix("./") == "importpython.py"
+                for name in names
+            ):
+                raise ExampleError(
+                    piece["line"],
+                    "the send-embedder-url flag reserves the "
+                    'file "importpython.py"',
+                )
+    if "send-embedder-url" in attributes:
+        for piece in pieces:
+            if (
+                piece["part"] == "file"
+                and piece["title"] == "importpython.py"
+            ):
+                raise ExampleError(
+                    piece["line"],
+                    "the send-embedder-url flag reserves the "
+                    'file "importpython.py"',
+                )
 
 
 class ImportPythonPreprocessor(Preprocessor):
@@ -301,7 +347,7 @@ class ImportPythonPreprocessor(Preprocessor):
         """
         attributes = parse_gate(header, first_line)
         pieces = split_example(lines, first_line + 1)
-        validate(pieces, first_line)
+        validate(pieces, attributes, first_line)
         parts = ["<import-python"]
         for name, value in attributes.items():
             if value is None:
@@ -331,22 +377,29 @@ class ImportPythonPreprocessor(Preprocessor):
             )
             return inner.convert("\n".join(piece["text"])) + "\n"
         text, lit = self.paint("\n".join(piece["text"]), piece)
+        # One code element inside every pre, highlighted or not:
+        # MkDocs-family themes hang block styling and the copy
+        # button on pre > code, and the element reads both shapes
+        # identically. No newline before the text - a pre swallows
+        # one after its own tag, a code does not - so textContent
+        # stays byte-identical to the bare-pre form.
+        text = f"<code>{text}\n</code>"
         if piece["part"] == "file":
             title = html.escape(piece["title"])
-            return f'<pre{lit} title="{title}">\n{text}\n</pre>\n'
+            return f'<pre{lit} title="{title}">{text}</pre>\n'
         if piece["part"] in ("config", "body"):
             role = piece["part"]
-            return f'<pre{lit} data-role="{role}">\n{text}\n</pre>\n'
-        return f"<pre{lit}>\n{text}\n</pre>\n"
+            return f'<pre{lit} data-role="{role}">{text}</pre>\n'
+        return f"<pre{lit}>{text}</pre>\n"
 
     def paint(self, code, piece):
         """
         Highlight a part's code as Pygments spans with no wrapper
-        of any kind, so the pre stays a bare direct child and its
-        textContent stays exactly the code. The class="highlight"
-        the coloured path adds is what lets a Material or
-        Zensical site's existing Pygments stylesheet colour these
-        blocks, palettes and all, with no CSS of ours.
+        of any kind - render_piece adds the one code element both
+        paths share, and the pre stays the direct child. The 
+        class="highlight" the coloured path adds is what lets a
+        Material or Zensical site's existing Pygments stylesheet
+        colour these blocks, palettes and all, with no CSS of ours.
 
         The language comes from the fence, or a file's name, with
         json and html assumed for config and body; an unknown or
@@ -385,7 +438,7 @@ class ImportPythonExtension(Extension):
     def __init__(self, **kwargs):
         self.config = {
             "script_url": [
-                "https://importpython.org/bfp/test/embed.js",
+                "https://importpython.org/v/test/embed.js",
                 "Where embed.js is served from; point this at "
                 "your own copy to use one.",
             ],

{importpython_markdown-0.1.0.dist-info → importpython_markdown-0.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: importpython-markdown
-Version: 0.1.0
+Version: 0.1.2
 Summary: Runnable Python examples in Markdown, via importpython.org.
 Author-email: "Nicholas H.Tollervey" <ntoll@ntoll.org>
 License: MIT
@@ -43,9 +43,11 @@ reader presses Run. Plain fences are the program; a fence with
 `title="name.py"` is a file delivered beside it; `config` and
 `body` fences carry BFP settings and page markup (escaped for
 you). The `py` and `mpy` types choose Pyodide or MicroPython,
-and `terminal`, `debug`, `title="..."`, `run-label="..."`,
-`stop-label="..."`, `theme="..."`, `class` and `id` pass through
-to the element.
+and `terminal`, `debug`, `send-embedder-url`, `title="..."`,
+`run-label="..."`, `stop-label="..."`, `theme="..."`,
+`terminal-rows="..."`, `terminal-cols="..."`, `class` and `id`
+pass through to the element - each documented at
+[importpython.org](https://importpython.org/docs/writing-markdown/).
 
 Install and enable:
 

importpython_markdown-0.1.2.dist-info/RECORD

@@ -0,0 +1,7 @@
+importpython_markdown/__init__.py,sha256=C9tEDiPB7CCeW76X0D-X2Rv3lCnPcwYDhH9fVNUnKjI,18453
+importpython_markdown-0.1.2.dist-info/licenses/LICENSE,sha256=ksfiPPZ3bBB4_KgmDo6-NLda44B_-onAZ3JLVxYSIVg,1077
+importpython_markdown-0.1.2.dist-info/METADATA,sha256=Pp5BqSH9hVCCrlFih5572ePkMcQedzY7q6JrJ61rH_s,2335
+importpython_markdown-0.1.2.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+importpython_markdown-0.1.2.dist-info/entry_points.txt,sha256=0Fo68SFJa3rmdmuysJyRTCu35rve3xGdegmhOutPs18,81
+importpython_markdown-0.1.2.dist-info/top_level.txt,sha256=gZT7U42MZK8PK1UxWpt0IGHGv8ynHvdYlxn-OjZRQ-0,22
+importpython_markdown-0.1.2.dist-info/RECORD,,

importpython_markdown-0.1.0.dist-info/RECORD

@@ -1,7 +0,0 @@
-importpython_markdown/__init__.py,sha256=hT7LSHnfozBbaNInQD6vsTC5dO4EcKRV9KY2zLBjyw8,15955
-importpython_markdown-0.1.0.dist-info/licenses/LICENSE,sha256=ksfiPPZ3bBB4_KgmDo6-NLda44B_-onAZ3JLVxYSIVg,1077
-importpython_markdown-0.1.0.dist-info/METADATA,sha256=uzuRuKzAGStQHOnMMAKbp6G4iayeKl8SzOJLDpqt8Rk,2179
-importpython_markdown-0.1.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
-importpython_markdown-0.1.0.dist-info/entry_points.txt,sha256=0Fo68SFJa3rmdmuysJyRTCu35rve3xGdegmhOutPs18,81
-importpython_markdown-0.1.0.dist-info/top_level.txt,sha256=gZT7U42MZK8PK1UxWpt0IGHGv8ynHvdYlxn-OjZRQ-0,22
-importpython_markdown-0.1.0.dist-info/RECORD,,