edwh-editorjs 2.4.0__tar.gz → 2.5.0__tar.gz

{edwh_editorjs-2.4.0 → edwh_editorjs-2.5.0}/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 <!--next-version-placeholder-->
 
+## v2.5.0 (2025-03-20)
+
+### Feature
+
+* Improve markdown conversion and image handling in EditorJS blocks ([`80d0fc0`](https://github.com/educationwarehouse/edwh-editorjs/commit/80d0fc00a4e39b279de35998d1a85a37282c58a7))
+
 ## v2.4.0 (2024-12-02)
 
 ### Feature

{edwh_editorjs-2.4.0 → edwh_editorjs-2.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: edwh-editorjs
-Version: 2.4.0
+Version: 2.5.0
 Summary: EditorJS.py
 Project-URL: Homepage, https://github.com/educationwarehouse/edwh-EditorJS
 Author-email: SKevo <skevo.cw@gmail.com>, Robin van der Noord <robin.vdn@educationwarehouse.nl>
@@ -13,6 +13,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.10
+Requires-Dist: html2markdown
 Requires-Dist: humanize
 Requires-Dist: markdown2
 Requires-Dist: mdast

edwh_editorjs-2.5.0/editorjs/__about__.py

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

{edwh_editorjs-2.4.0 → edwh_editorjs-2.5.0}/editorjs/blocks.py

@@ -8,6 +8,7 @@ import typing as t
 from html.parser import HTMLParser
 from urllib.parse import urlparse
 
+import html2markdown
 import humanize
 import markdown2
 
@@ -53,6 +54,7 @@ def process_styled_content(item: MDChildNode, strict: bool = True) -> str:
         A formatted HTML string based on the item type.
     """
     _type = item.get("type")
+
     html_wrappers = {
         "text": "{value}",
         "html": "{value}",
@@ -82,9 +84,16 @@ def process_styled_content(item: MDChildNode, strict: bool = True) -> str:
 
 
 def default_to_text(node: MDChildNode):
-    return "".join(
-        process_styled_content(child) for child in node.get("children", [])
-    ) or process_styled_content(node)
+    if node["type"] == "paragraph":
+        return "".join(
+            process_styled_content(child) for child in node.get("children", [])
+        )
+    else:
+        return process_styled_content(node)
+
+    # return "".join(
+    #     process_styled_content(child) for child in node.get("children", [])
+    # ) or process_styled_content(node)
 
 
 @block("heading", "header")
@@ -173,6 +182,9 @@ class ParagraphBlock(EditorJSBlock):
                 }
             )
 
+        # deal with bold etc:
+        text = html2markdown.convert(text)
+
         return f"{text}\n\n"
 
     @classmethod
@@ -384,7 +396,7 @@ class CodeBlock(EditorJSBlock):
     @classmethod
     def to_markdown(cls, data: EditorChildData) -> str:
         code = data.get("code", "")
-        return f"```\n" f"{code}" f"\n```\n"
+        return f"```\n{code}\n```\n"
 
     @classmethod
     def to_json(cls, node: MDChildNode) -> list[dict]:
@@ -411,11 +423,8 @@ class ImageBlock(EditorJSBlock):
         with_background = "1" if data.get("withBackground") else ""
         stretched = "1" if data.get("stretched") else ""
 
-        if any((with_border, with_background, stretched)):
-            # custom type to support custom options:
-            return f"""<editorjs type="image" caption="{caption}" border="{with_border}" background="{with_background}" stretched="{stretched}" url="{url}" />\n\n"""
-        else:
-            return f"""![{caption}]({url} "{caption}")\n\n"""
+        # always custom type so we can render as <figure> instead of markdown2's default (simple <img>)
+        return f"""<editorjs type="image" caption="{caption}" border="{with_border}" background="{with_background}" stretched="{stretched}" url="{url}" />\n\n"""
 
     @classmethod
     def _caption(cls, node: MDChildNode):
@@ -446,11 +455,14 @@ class ImageBlock(EditorJSBlock):
         border = node.get("border") or ""
 
         return f"""
-        <div class="ce-block {stretched and 'ce-block--stretched'}">
+        <div class="ce-block {stretched and "ce-block--stretched"}">
             <div class="ce-block__content">
-            <div class="cdx-block image-tool image-tool--filled {background and 'image-tool--withBackground'} {stretched and 'image-tool--stretched'} {border and 'image-tool--withBorder'}">
+            <div class="cdx-block image-tool image-tool--filled {background and "image-tool--withBackground"} {stretched and "image-tool--stretched"} {border and "image-tool--withBorder"}">
                 <div class="image-tool__image">
-                    <img class="image-tool__image-picture" src="{url}" title="{caption}" alt="{caption}">
+                    <figure>
+                        <img class="image-tool__image-picture" src="{url}" title="{caption}" alt="{caption}">
+                        <figcaption>{caption}</figcaption>
+                    </figure>
                 </div>
             </div>
         </div>
@@ -467,7 +479,7 @@ class QuoteBlock(EditorJSBlock):
         result = f"> {text}\n"
         if caption := data.get("caption", ""):
             result += f"> <cite>{caption}</cite>\n"
-        return result
+        return result + "\n"
 
     @classmethod
     def to_json(cls, node: MDChildNode) -> list[dict]:
@@ -493,12 +505,13 @@ class QuoteBlock(EditorJSBlock):
 
     @classmethod
     def to_text(cls, node: MDChildNode) -> str:
-        return default_to_text(node)
+        return "".join(
+            process_styled_content(child) for child in node.get("children", [])
+        )
 
 
 @block("raw", "html")
 class RawBlock(EditorJSBlock):
-
     @classmethod
     def to_markdown(cls, data: EditorChildData) -> str:
         text = data.get("html", "")
@@ -521,7 +534,6 @@ class RawBlock(EditorJSBlock):
 
 @block("table")
 class TableBlock(EditorJSBlock):
-
     @classmethod
     def to_markdown(cls, data: EditorChildData) -> str:
         """
@@ -640,7 +652,6 @@ class LinkBlock(EditorJSBlock):
 
 @block("attaches")
 class AttachmentBlock(EditorJSBlock):
-
     @classmethod
     def to_markdown(cls, data: EditorChildData) -> str:
         title = data.get("title", "")
@@ -705,7 +716,7 @@ class AttachmentBlock(EditorJSBlock):
                 </div>
                 {file_size}
             </div>
-            <a class="cdx-attaches__download-button" href="{node.get('file', '')}" target="_blank" rel="nofollow noindex noreferrer" title="{node.get('name', '')}">
+            <a class="cdx-attaches__download-button" href="{node.get("file", "")}" target="_blank" rel="nofollow noindex noreferrer" title="{node.get("name", "")}">
                 <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="none" viewBox="0 0 24 24"><path stroke="currentColor" stroke-linecap="round" stroke-width="2" d="M7 10L11.8586 14.8586C11.9367 14.9367 12.0633 14.9367 12.1414 14.8586L17 10"></path></svg>
             </a>
         </div>
@@ -757,7 +768,6 @@ class AlignmentBlock(EditorJSBlock):
 
 @block("embed")
 class EmbedBlock(EditorJSBlock):
-
     @classmethod
     def to_markdown(cls, data: EditorChildData) -> str:
         service = data.get("service", "")

{edwh_editorjs-2.4.0 → edwh_editorjs-2.5.0}/editorjs/core.py

@@ -135,7 +135,6 @@ class EditorJS:
         Export HTML string
         """
         md = self.to_markdown()
-        # todo: deal with custom elements like linktool, attaches
         return self._md.convert(md)
 
     def __repr__(self):

{edwh_editorjs-2.4.0 → edwh_editorjs-2.5.0}/pyproject.toml

@@ -27,8 +27,9 @@ requires-python = ">=3.10"
 
 dependencies = [
     # "bleach",
-    "mdast",
-    "markdown2",
+    "mdast", # markdown -> ast
+    "markdown2",  # markdown -> html
+    "html2markdown", # html -> markdown
     "humanize",
 ]
 

{edwh_editorjs-2.4.0 → edwh_editorjs-2.5.0}/tests/test_core.py

@@ -185,7 +185,8 @@ asdfsdajgdsjaklgkjds
 
 
 def test_code():
-    e = EditorJS.from_markdown(textwrap.dedent("""
+    e = EditorJS.from_markdown(
+        textwrap.dedent("""
     Read code:
     
     ```
@@ -193,7 +194,8 @@ def test_code():
     ```
     
     End of code
-    """))
+    """)
+    )
 
     blocks = json.loads(e.to_json())
 
@@ -256,3 +258,38 @@ def test_image_options():
     print(e.to_markdown())
     print(e.to_html())
     print(e.to_json())
+
+
+def test_figcaption():
+    js = """{"time":1742471258492,"blocks":[{"id":"ZoA3rbc05C","type":"image","data":{"caption":"Party Time!","withBorder":false,"withBackground":false,"stretched":false,"file":{"url":"https://py4web.leiden.dockers.local/img/upload/23.png?hash=979795a433fc15cb94eccb3159f1f1e4054b1664"}}}],"version":"2.30.7"}"""
+    e = EditorJS.from_json(js)
+
+    html = e.to_html()
+
+    assert "figcaption" in html
+
+
+def test_bold():
+    js = """{"time":1742475802066,"blocks":[{"id":"v_Kc51dnJH","type":"paragraph","data":{"text":"Deze tekst is <b>half bold</b> en half niet"},"tunes":{"alignmentTune":{"alignment":"left"}}},{"id":"q_fkuEFcY5","type":"paragraph","data":{"text":"<b>Deze tekst is heel bold</b>"},"tunes":{"alignmentTune":{"alignment":"left"}}}],"version":"2.30.7"}"""
+
+    e = EditorJS.from_json(js)
+
+    print(
+        e._mdast,
+        e.to_json(),
+        e.to_html(),
+        e.to_markdown(),
+    )
+
+
+def test_quotes():
+    js = """{"time":1742477286420,"blocks":[{"id":"PpmEaxeSkq","type":"quote","data":{"text":"To baldly go where no bald man has ever gone before","caption":"a bald guy","alignment":"left"}},{"id":"26ERFQ6U3V","type":"quote","data":{"text":"Einstein was een sukkel","caption":"Einstein's ex vrouw","alignment":"left"}},{"id":"RB8AdaCd86","type":"quote","data":{"text":"Asdf","caption":"fsda-man","alignment":"left"}},{"id":"BCSus2rhUr","type":"paragraph","data":{"text":"groetjes"},"tunes":{"alignmentTune":{"alignment":"left"}}}],"version":"2.30.7"}"""
+
+    e = EditorJS.from_json(js)
+
+    print(
+        e._mdast,
+        e.to_json(),
+        e.to_html(),
+        e.to_markdown(),
+    )

edwh_editorjs-2.4.0/editorjs/__about__.py

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