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

{edwh_editorjs-2.3.1 → edwh_editorjs-2.4.0}/.gitignore

@@ -11,6 +11,7 @@ dist/*
 .env
 venv*
 *coverage*
+htmlcov/*
 dist/
 build/
 example.*

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

@@ -2,6 +2,22 @@
 
 <!--next-version-placeholder-->
 
+## v2.4.0 (2024-12-02)
+
+### Feature
+
+* **image:** Support more options for the image block ([`c74dcce`](https://github.com/educationwarehouse/edwh-editorjs/commit/c74dccef5c1115038f6de0f08250dfa6cff18796))
+
+### Fix
+
+* Less exceptions, more warnings for better ease-of-use ([`891fca1`](https://github.com/educationwarehouse/edwh-editorjs/commit/891fca198e774c53a8b6365b927a080f61c0b2c8))
+
+## v2.3.2 (2024-11-27)
+
+### Fix
+
+* (refactor) clean up todo's, add `Unreachable` for when some branch/function should never be used ([`3226642`](https://github.com/educationwarehouse/edwh-editorjs/commit/3226642cfc8adb9a3cad6052d02ea6fc6c048058))
+
 ## v2.3.1 (2024-11-27)
 
 ### Fix

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

@@ -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/editorjs/__about__.py

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

{edwh_editorjs-2.3.1 → edwh_editorjs-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

{edwh_editorjs-2.3.1 → edwh_editorjs-2.4.0}/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}
 

edwh_editorjs-2.4.0/editorjs/exceptions.py

@@ -0,0 +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 → edwh_editorjs-2.4.0}/tests/test_core.py

@@ -246,3 +246,13 @@ def test_embed():
     print(e.to_markdown())
     print(e.to_html())
     print(e.to_json())
+
+
+def test_image_options():
+    json_blocks = r"""{"time":1733155142016,"blocks":[{"id":"e7_WBThzLQ","type":"image","data":{"caption":"border","withBorder":true,"withBackground":false,"stretched":false,"file":{"url":"https://py4web.leiden.dockers.local/img/upload/5.jpg?hash=b39755c8a568cbf45d329e3a3128fb43065b1d1b","name":"kat.jpg","title":"kat","extension":"jpg","size":3682051}}},{"id":"B5qVcjqBuB","type":"image","data":{"caption":"stretch","withBorder":false,"withBackground":false,"stretched":true,"file":{"url":"https://py4web.leiden.dockers.local/img/upload/6.jpg?hash=b39755c8a568cbf45d329e3a3128fb43065b1d1b","name":"kat.jpg","title":"kat","extension":"jpg","size":3682051}}},{"id":"ft32yP2_cv","type":"image","data":{"caption":"background","withBorder":false,"withBackground":true,"stretched":false,"file":{"url":"https://py4web.leiden.dockers.local/img/upload/7.jpg?hash=b39755c8a568cbf45d329e3a3128fb43065b1d1b","name":"kat.jpg","title":"kat","extension":"jpg","size":3682051}}}],"version":"2.30.7"}"""
+
+    e = EditorJS.from_json(json_blocks)
+
+    print(e.to_markdown())
+    print(e.to_html())
+    print(e.to_json())

edwh_editorjs-2.3.1/.github/workflows/build_documentation.yml

@@ -1,36 +0,0 @@
-name: Build documentation
-
-on:
-  workflow_dispatch:
-  release:
-    types: [published]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: ['3.10']
-
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
-        with:
-          python-version: ${{ matrix.python-version }}
-
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install pdoc
-          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-      - name: Build docs
-        run: |
-          chmod +x ./scripts/build_documentation.sh
-          bash ./scripts/build_documentation.sh
-      - name: Deploy
-        uses: JamesIves/github-pages-deploy-action@4.1.4
-        with:
-          branch: documentation
-          folder: ./documentation

edwh_editorjs-2.3.1/.github/workflows/publish_to_pypi.yml

@@ -1,40 +0,0 @@
-name: Upload Python Package to PyPI
-
-on:
-  release:
-    types: [published]
-
-jobs:
-  deploy:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: ['3.10']
-
-    steps:
-    - uses: actions/checkout@v2
-
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
-      with:
-        python-version: ${{ matrix.python-version }}
-
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        python -m pip install pytest
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-    
-    - name: Test with pyTest
-      run: |
-        python -m pytest -v
-
-    - name: Build package
-      run: |
-        bash ./scripts/compile_for_pypi.sh
-
-    - name: Publish package
-      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
-      with:
-        user: __token__
-        password: ${{ secrets.PYPI_API_TOKEN }}

edwh_editorjs-2.3.1/.github/workflows/pytest.yml

@@ -1,30 +0,0 @@
-name: Test with pyTest
-
-on: [workflow_dispatch, push, pull_request]
-
-jobs:
-  deploy:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: ['3.10']
-      fail-fast: false
-
-    steps:
-    - uses: actions/checkout@v2
-
-    - name: Set up Python
-      uses: actions/setup-python@v2
-      with:
-        python-version: ${{ matrix.python-version }}
-        cache: 'pip'
-
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        python -m pip install pytest
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-    
-    - name: Test with pyTest
-      run: |
-        python -m pytest -v

edwh_editorjs-2.3.1/editorjs/__about__.py

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

edwh_editorjs-2.3.1/editorjs/exceptions.py

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

edwh_editorjs-2.3.1/htmlcov/.gitignore

@@ -1,2 +0,0 @@
-# Created by coverage.py
-*