edwh-editorjs 2.3.1__py3-none-any.whl → 2.4.0__py3-none-any.whl

editorjs/__about__.py

@@ -1 +1 @@
-__version__ = "2.3.1"
+__version__ = "2.4.0"

editorjs/blocks.py

@@ -4,7 +4,6 @@ mdast to editorjs
 
 import abc
 import re
-import traceback
 import typing as t
 from html.parser import HTMLParser
 from urllib.parse import urlparse
@@ -12,7 +11,7 @@ from urllib.parse import urlparse
 import humanize
 import markdown2
 
-from .exceptions import TODO
+from .exceptions import TODO, Unreachable
 from .types import EditorChildData, MDChildNode
 
 
@@ -62,7 +61,6 @@ def process_styled_content(item: MDChildNode, strict: bool = True) -> str:
         "strongEmphasis": "<b><i>{value}</i></b>",
         "link": '<a href="{url}">{value}</a>',
         "inlineCode": '<code class="inline-code">{value}</code>',
-        # todo: <mark>, linktool
     }
 
     if _type in BLOCKS:
@@ -314,12 +312,6 @@ class ListBlock(EditorJSBlock):
                 }
             )
 
-        # todo: detect 'checklist':
-        """
-        type: checklist
-        data: {items: [{text: "a", checked: false}, {text: "b", checked: false}, {text: "c", checked: true},…]}
-        """
-
         if could_be_checklist:
             return [
                 {
@@ -414,7 +406,20 @@ 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 ""
+
+        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"""
+
+    @classmethod
+    def _caption(cls, node: MDChildNode):
+        return node.get("alt") or node.get("caption") or ""
 
     @classmethod
     def to_json(cls, node: MDChildNode) -> list[dict]:
@@ -422,15 +427,34 @@ 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">
+                    <img class="image-tool__image-picture" src="{url}" title="{caption}" alt="{caption}">
+                </div>
+            </div>
+        </div>
+        """
 
 
 @block("blockquote", "quote")
@@ -482,10 +506,10 @@ class RawBlock(EditorJSBlock):
 
     @classmethod
     def to_json(cls, node: MDChildNode) -> list[dict]:
-        # todo: apply same logic as paragraph block to find <editorjs/> items!!!
         raw = cls.to_text(node)
 
         if raw.startswith("<editorjs"):
+            # not a raw block but (probably) a self-closing editorjs block
             return EditorJSCustom.to_json({"children": [node]})
         else:
             return [raw_block(raw)]
@@ -559,7 +583,8 @@ class TableBlock(EditorJSBlock):
 
     @classmethod
     def to_text(cls, node: MDChildNode) -> str:
-        raise TODO(node)
+        # I think this might be triggered if there is a table (deeply) within a paragraph block?
+        raise TODO(["TableBlock.to_text", node])
 
 
 @block("linkTool")
@@ -712,7 +737,7 @@ class AlignmentBlock(EditorJSBlock):
             data["level"] = int(tag.removeprefix("h"))
         else:
             # doesn't support alignment
-            raise TODO(f"Unsupported tag for alignment: {tag}")
+            raise NotImplementedError(f"Unsupported tag for alignment: {tag}")
 
         return [
             {
@@ -777,7 +802,9 @@ class AttributeParser(HTMLParser):
 
 class EditorJSCustom(EditorJSBlock, markdown2.Extra):
     """
-    Special type of block to deal with custom attributes
+    Special type of block to deal with custom attributes.
+
+    This is both a special editorjs block as well as a markdown2 plugin!
     """
 
     name = "editorjs"
@@ -792,23 +819,31 @@ class EditorJSCustom(EditorJSBlock, markdown2.Extra):
 
     @classmethod
     def to_markdown(cls, data: EditorChildData) -> str:
-        raise TODO()
+        raise Unreachable("Custom Blocks have their own to_markdown logic.")
 
     @classmethod
-    def to_json(cls, node: MDChildNode) -> list[dict]:
-        html = "".join(_["value"] for _ in node.get("children", []))
+    def _find_right_block(cls, html: str) -> tuple[EditorJSBlock, dict]:
         attrs, body = cls.parse_html(html)
         _type = attrs.get("type", "")
         attrs.setdefault("body", body)  # only if there is no such attribute yet
 
-        if not (handler := BLOCKS.get(_type)):
+        handler = BLOCKS.get(_type)
+
+        if not handler:
             raise ValueError(f"Unknown custom type {_type}")
 
+        return handler, attrs
+
+    @classmethod
+    def to_json(cls, node: MDChildNode) -> list[dict]:
+        html = "".join(_["value"] for _ in node.get("children", []))
+        handler, attrs = cls._find_right_block(html)
         return handler.to_json(attrs)
 
     @classmethod
     def to_text(cls, node: MDChildNode) -> str:
-        raise TODO()
+        handler, attrs = cls._find_right_block(node.get("value", ""))
+        return handler.to_text(attrs)
 
     # markdown2:
     re_short = re.compile(r"<editorjs.*?/>")
@@ -816,13 +851,7 @@ class EditorJSCustom(EditorJSBlock, markdown2.Extra):
 
     def run(self, text: str) -> str:
         def replace_html(match):
-            attrs, body = self.parse_html(match.group())
-            _type = attrs.get("type", "")
-            attrs.setdefault("body", body)  # only if there is no such attribute yet
-
-            if not (handler := BLOCKS.get(_type)):
-                raise ValueError(f"Unknown custom type {_type}")
-
+            handler, attrs = self._find_right_block(match.group())
             return handler.to_text(attrs)
 
         # Substitute using the replacement functions

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}
 

editorjs/exceptions.py

@@ -1,3 +1,8 @@
 class TODO(NotImplementedError):
     def __init__(self, msg: str = "todo"):
         super().__init__(msg)
+
+
+class Unreachable(NotImplementedError):
+    def __init__(self, msg: str = "unimplemented"):
+        super().__init__(msg)

{edwh_editorjs-2.3.1.dist-info → edwh_editorjs-2.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: edwh-editorjs
-Version: 2.3.1
+Version: 2.4.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>

edwh_editorjs-2.4.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+editorjs/__about__.py,sha256=yLaFvd-K80rs_ClRVYULStijkok4RfYSaanIt_E-aKM,22
+editorjs/__init__.py,sha256=-OHUf7ZXfkbdFB1r85eIjpHRfql-GCNUCKuBEdEt2Rc,58
+editorjs/blocks.py,sha256=QDUJ55UmDDZxZOxkigGHZ-JC7CP_sDH94Y_z-PRVXf8,28648
+editorjs/core.py,sha256=ra1LADSPiZpbzeAZaVzsJ8aGc3m3xYUO4bpyQLPV3h0,4576
+editorjs/exceptions.py,sha256=oKuWqi4CSnFGZfVZWtTZ2XZeHXm5xF-nAtX_1YLm6sI,230
+editorjs/helpers.py,sha256=q861o5liNibMTp-Ozay17taF7CTNsRe901lYhhxdwHg,73
+editorjs/types.py,sha256=W7IZWMWgzJaQulybIt0Gx5N63rVj4mEy73VJWo4VAQA,1029
+edwh_editorjs-2.4.0.dist-info/METADATA,sha256=Jwtr4YkhOPCssoqI4pLpvl7kpvHMFgpU74tHPQyG7Gc,996
+edwh_editorjs-2.4.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+edwh_editorjs-2.4.0.dist-info/RECORD,,

edwh_editorjs-2.3.1.dist-info/RECORD

@@ -1,10 +0,0 @@
-editorjs/__about__.py,sha256=neZxeMmEfjhVZM6xetRikrBdHWt5T5ehL72ZYdPtJ-E,22
-editorjs/__init__.py,sha256=-OHUf7ZXfkbdFB1r85eIjpHRfql-GCNUCKuBEdEt2Rc,58
-editorjs/blocks.py,sha256=iJI6-UzMHjaYbFKzON_6DRe05OdXMu-gQkRQfsgN_P4,27073
-editorjs/core.py,sha256=WSBmAIKwSqHIP_NFmUVUJiyHPgq7D8902Jm9HRf1nSk,3669
-editorjs/exceptions.py,sha256=TyfHvk2Z5RbKxTDK7lrjgwAgVgInXIuDW63eO5jzVFw,106
-editorjs/helpers.py,sha256=q861o5liNibMTp-Ozay17taF7CTNsRe901lYhhxdwHg,73
-editorjs/types.py,sha256=W7IZWMWgzJaQulybIt0Gx5N63rVj4mEy73VJWo4VAQA,1029
-edwh_editorjs-2.3.1.dist-info/METADATA,sha256=cwC8hA7CozYCK2z9H-ZH_t8ozqWpnACbGhcqs3ig_qI,996
-edwh_editorjs-2.3.1.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-edwh_editorjs-2.3.1.dist-info/RECORD,,