edwh-editorjs 2.3.2__py3-none-any.whl → 2.5.0__py3-none-any.whl

editorjs/__about__.py

@@ -1 +1 @@
-__version__ = "2.3.2"
+__version__ = "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]:
@@ -406,7 +418,17 @@ class ImageBlock(EditorJSBlock):
     def to_markdown(cls, data: EditorChildData) -> str:
         url = data.get("url", "") or data.get("file", {}).get("url", "")
         caption = data.get("caption", "")
-        return f"""![{caption}]({url} "{caption}")\n\n"""
+
+        with_border = "1" if data.get("withBorder") else ""
+        with_background = "1" if data.get("withBackground") else ""
+        stretched = "1" if data.get("stretched") else ""
+
+        # 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):
+        return node.get("alt") or node.get("caption") or ""
 
     @classmethod
     def to_json(cls, node: MDChildNode) -> list[dict]:
@@ -414,15 +436,37 @@ class ImageBlock(EditorJSBlock):
             {
                 "type": "image",
                 "data": {
-                    "caption": cls.to_text(node),
                     "file": {"url": node.get("url")},
+                    "caption": cls._caption(node),
+                    "withBorder": bool(node.get("border", False)),
+                    "stretched": bool(node.get("stretched", False)),
+                    "withBackground": bool(node.get("background", False)),
                 },
             }
         ]
 
     @classmethod
     def to_text(cls, node: MDChildNode) -> str:
-        return node.get("alt") or node.get("caption") or ""
+        caption = cls._caption(node)
+        url = node.get("url")
+
+        background = node.get("background") or ""
+        stretched = node.get("stretched") or ""
+        border = node.get("border") or ""
+
+        return f"""
+        <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="image-tool__image">
+                    <figure>
+                        <img class="image-tool__image-picture" src="{url}" title="{caption}" alt="{caption}">
+                        <figcaption>{caption}</figcaption>
+                    </figure>
+                </div>
+            </div>
+        </div>
+        """
 
 
 @block("blockquote", "quote")
@@ -435,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]:
@@ -461,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", "")
@@ -489,7 +534,6 @@ class RawBlock(EditorJSBlock):
 
 @block("table")
 class TableBlock(EditorJSBlock):
-
     @classmethod
     def to_markdown(cls, data: EditorChildData) -> str:
         """
@@ -608,7 +652,6 @@ class LinkBlock(EditorJSBlock):
 
 @block("attaches")
 class AttachmentBlock(EditorJSBlock):
-
     @classmethod
     def to_markdown(cls, data: EditorChildData) -> str:
         title = data.get("title", "")
@@ -673,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>
@@ -725,7 +768,6 @@ class AlignmentBlock(EditorJSBlock):
 
 @block("embed")
 class EmbedBlock(EditorJSBlock):
-
     @classmethod
     def to_markdown(cls, data: EditorChildData) -> str:
         service = data.get("service", "")

editorjs/core.py

@@ -1,11 +1,13 @@
 import json
 import typing as t
+import warnings
 
 import markdown2
 import mdast
 from typing_extensions import Self
 
 from .blocks import BLOCKS
+from .exceptions import TODO
 from .helpers import unix_timestamp
 from .types import MDRootNode
 
@@ -41,13 +43,26 @@ class EditorJS:
         for child in blocks:
             _type = child["type"]
             if not (block := BLOCKS.get(_type)):
-                raise TypeError(f"from_json: Unsupported block type `{_type}`")
-
-            data = child.get("data", {})
-            # forward any 'tunes' via data:
-            data["tunes"] = data.get("tunes") or child.get("tunes") or {}
-
-            markdown_items.append(block.to_markdown(data))
+                warnings.warn(
+                    f"from_json: Unsupported block type `{_type}`",
+                    category=RuntimeWarning,
+                )
+                continue
+
+            try:
+                data = child.get("data", {})
+                # forward any 'tunes' via data:
+                data["tunes"] = data.get("tunes") or child.get("tunes") or {}
+
+                markdown_items.append(block.to_markdown(data))
+            except Exception as e:
+                warnings.warn(
+                    "from_json: Oh oh, unexpected block failure!",
+                    category=RuntimeWarning,
+                    source=e,
+                )
+                # if isinstance(e, TODO):
+                #     raise e
 
         markdown = "".join(markdown_items)
         return cls.from_markdown(markdown)
@@ -76,9 +91,22 @@ class EditorJS:
         for child in self._mdast["children"]:
             _type = child["type"]
             if not (block := BLOCKS.get(_type)):
-                raise TypeError(f"to_json: Unsupported block type `{_type}`")
-
-            blocks.extend(block.to_json(child))
+                warnings.warn(
+                    f"to_json: Unsupported block type `{_type}`",
+                    category=RuntimeWarning,
+                )
+                continue
+
+            try:
+                blocks.extend(block.to_json(child))
+            except Exception as e:
+                warnings.warn(
+                    "to_json: Oh oh, unexpected block failure!",
+                    category=RuntimeWarning,
+                    source=e,
+                )
+                # if isinstance(e, TODO):
+                #     raise e
 
         data = {"time": unix_timestamp(), "blocks": blocks, "version": EDITORJS_VERSION}
 
@@ -107,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.3.2.dist-info → edwh_editorjs-2.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: edwh-editorjs
-Version: 2.3.2
+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.dist-info/RECORD

@@ -0,0 +1,10 @@
+editorjs/__about__.py,sha256=fMbNgIJqxiZEaSBLadLBt4rZpCHqarzb4Okt-aWsp2E,22
+editorjs/__init__.py,sha256=-OHUf7ZXfkbdFB1r85eIjpHRfql-GCNUCKuBEdEt2Rc,58
+editorjs/blocks.py,sha256=e46ZTxx4M_t2K3o3-bSDjhOfj9OWvSwTTQLK4r_7fv4,29061
+editorjs/core.py,sha256=4igv2l8Rm1S92kxKrIXGIUlNHh6pnjq8F28XQr91I9o,4510
+editorjs/exceptions.py,sha256=oKuWqi4CSnFGZfVZWtTZ2XZeHXm5xF-nAtX_1YLm6sI,230
+editorjs/helpers.py,sha256=q861o5liNibMTp-Ozay17taF7CTNsRe901lYhhxdwHg,73
+editorjs/types.py,sha256=W7IZWMWgzJaQulybIt0Gx5N63rVj4mEy73VJWo4VAQA,1029
+edwh_editorjs-2.5.0.dist-info/METADATA,sha256=Qv3LORc9vuDoS8Z_1yVms5DZOyhP8tMuiuVzcE7nPGE,1025
+edwh_editorjs-2.5.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+edwh_editorjs-2.5.0.dist-info/RECORD,,

edwh_editorjs-2.3.2.dist-info/RECORD

@@ -1,10 +0,0 @@
-editorjs/__about__.py,sha256=J4CRnpR3v72FGOMp8gqSua_XWZpAfXuqgVWiQFB-gTY,22
-editorjs/__init__.py,sha256=-OHUf7ZXfkbdFB1r85eIjpHRfql-GCNUCKuBEdEt2Rc,58
-editorjs/blocks.py,sha256=dT54-wCL4sm9fO7OiJO8Q0SgTuHq3wtv7KQiOF81oks,27138
-editorjs/core.py,sha256=WSBmAIKwSqHIP_NFmUVUJiyHPgq7D8902Jm9HRf1nSk,3669
-editorjs/exceptions.py,sha256=oKuWqi4CSnFGZfVZWtTZ2XZeHXm5xF-nAtX_1YLm6sI,230
-editorjs/helpers.py,sha256=q861o5liNibMTp-Ozay17taF7CTNsRe901lYhhxdwHg,73
-editorjs/types.py,sha256=W7IZWMWgzJaQulybIt0Gx5N63rVj4mEy73VJWo4VAQA,1029
-edwh_editorjs-2.3.2.dist-info/METADATA,sha256=798OipvvgiexYoOa7x3KFac2MouJVMYQA5KzF6bR1ss,996
-edwh_editorjs-2.3.2.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-edwh_editorjs-2.3.2.dist-info/RECORD,,