tries refactoring

Author: WolfgangFahl

frontend/forms/form_field.py

@@ -4,10 +4,12 @@
 @author: wf
 """
 
+from dataclasses import dataclass
 from typing import Any, Dict, List, Optional, Union
 
 from basemkit.yamlable import lod_storable
 
+
 # Type alias: a translatable string is either a plain str or a
 # language-keyed dict, e.g. {"en": "Name", "de": "Name", "fr": "Nom"}.
 I18nStr = Optional[Union[str, Dict[str, str]]]
@@ -34,51 +36,36 @@ def resolve(value: I18nStr, lang: str = "en") -> str:
         Returns:
             str: the resolved string for the requested language
         """
-        if value is None:
-            return ""
-        if isinstance(value, dict):
-            resolved = value.get(lang) or value.get("en")
-            if resolved is None and value:
-                resolved = next(iter(value.values()))
-            return resolved or ""
-        return value
+        i18n=""
+        if value is not None:
+            if isinstance(value, dict):
+                i18n = value.get(lang) or value.get("en")
+                if i18n is None and value:
+                    i18n= next(iter(value.values()))
+                i18n=i18n or ""
+        return i18n
 
 
 def resolve_i18n(value: I18nStr, lang: str = "en") -> str:
     """Backward compatible alias for I18n.resolve()"""
-    return I18n.resolve(value, lang)
-
+    i18n=I18n.resolve(value, lang)
+    return i18n
 
+@dataclass
 class HtmlElement:
     """
     Base class for HTML elements with common attributes.
     """
-
     css_class: str = ""  # e.g. "form-control selectpicker"
     size: str = ""  # xs, sm, md, lg
 
 
 @lod_storable
-class FormLabel:
+class FormLabel(HtmlElement):
     """
     Label element with i18n support for form fields.
-
-    Can be defined as a simple string/dict (backward compatible) or as an object:
-
-    # Simple (backward compatible):
-    label: "Name"  or  label: {en: "Name", de: "Name"}
-
-    # Object with CSS class:
-    label:
-      text:
-        en: "Name"
-        de: "Name"
-      css_class: "bitplanorange"
     """
-
     text: I18nStr = ""  # the label text
-    css_class: str = ""  # additional CSS class (e.g., "bitplanorange")
-    size: str = ""  # xs, sm, md, lg
 
 
 @lod_storable
@@ -103,16 +90,15 @@ class FormField(HtmlElement):
             max: 100
           - type: Email
     """
-
     name: str = ""  # required but defaults to empty for compatibility
     field_type: str = "text"  # text | textarea | select | hidden | email
-    label: Any = None  # I18nStr or FormLabel object
-    placeholder: Any = None  # I18nStr
+    label: FormLabel = None
+    placeholder: I18nStr = None  # I18nStr
     glyphicon: Optional[str] = None
     required: bool = False
-    error_msg: Any = None  # I18nStr
+    error_msg: I18nStr= None  # I18nStr
     value: Optional[str] = None  # for hidden fields / pre-filled defaults
-    choices: Optional[List[str]] = None  # for select fields
+    choices: Optional[List[I18nStr]] = None  # for select fields
     placeholder_choice: I18nStr = None  # e.g. "Bitte wählen" for select fields
     validators: Optional[List[Dict[str, Any]]] = None  # WTForms validator descriptors
 
@@ -130,9 +116,9 @@ class FormDefinition:
     legend: Any  # I18nStr — required, no default
     fields: List[FormField]
     action: str = ""
-    submit_label: Any = None  # I18nStr; defaults to {"en": "Send", "de": "Absenden"}
+    submit_label: I18nStr = None  # I18nStr; defaults to {"en": "Send", "de": "Absenden"}
     submit_glyphicon: Optional[str] = None
-    success_message: Any = None  # I18nStr
+    success_message: I18nStr = None  # I18nStr
 
     def resolved_submit_label(self, lang: str = "en") -> str:
         """

frontend/forms/renderer.py

@@ -66,14 +66,13 @@ def render(
         parts.append(Markup(f"<fieldset>\n<legend>{escape(legend)}</legend>\n"))
 
         for field in form_def.fields:
-            parts.append(
-                self._render_field(
+            field_html=self._render_field(
                     field,
                     values.get(field.name, ""),
                     errors.get(field.name, []),
                     lang,
                 )
-            )
+            parts.append(field_html)
 
         parts.append(self._render_submit(form_def, lang))
         parts.append(Markup("</fieldset>\n</form>"))

frontend/htmlfilter.py

@@ -11,6 +11,7 @@
 
 from frontend.forms.registry import FormRegistry
 from frontend.forms.renderer import FormRenderer
+from duckdb.experimental.spark.errors.exceptions.base import IllegalArgumentException
 
 
 @lod_storable
@@ -107,32 +108,22 @@ def filter(self, pc: PageContent):
         """
         filter the given page content
         """
-        soup = self.doFilter(pc.html, self.filterKeys)
-        html_to_filter = soup.decode_contents()
-        temp_pc = PageContent(html=html_to_filter, lang=pc.lang)
-        temp_pc = self.filter_html(temp_pc)
-        pc.content = temp_pc.html
+        self.doFilter(pc, self.filterKeys)
+        self.filter_html(pc)
         return pc
 
-    def filter_html(self, pc_or_html) -> PageContent:
+    def filter_html(self, pc:PageContent):
         """
-        Apply filters directly on the raw HTML string without re-parsing,
-        to avoid lxml re-serialization mangling content.
+        Apply filters
         Detects wikicms-form divs and replaces them with rendered form HTML
         when a form_registry is set.
 
         Args:
-            pc_or_html: either a PageContent object or a string (for backward compatibility)
+            pc: a PageContent object
 
-        Returns:
-            If given a string, returns the filtered string.
-            If given a PageContent, returns the PageContent with filtered html.
         """
-        return_string = isinstance(pc_or_html, str)
-        if return_string:
-            pc = PageContent(html=pc_or_html)
-        else:
-            pc = pc_or_html
+        if not isinstance(pc, PageContent):
+            raise IllegalArgumentException("Expecting PageContent but got",type(pc))
         if "editsection" in self.filterKeys:
             pc.html = re.sub(
                 r'<span class="mw-editsection">.*?</span>\s*</span>',
@@ -141,12 +132,9 @@ def filter_html(self, pc_or_html) -> PageContent:
                 flags=re.DOTALL,
             )
         if self.form_registry is not None:
-            pc = self.replace_form_divs(pc)
-        if return_string:
-            return pc.html
-        return pc
+            self.replace_form_divs(pc)
 
-    def replace_form_divs(self, pc: PageContent) -> PageContent:
+    def replace_form_divs(self, pc: PageContent):
         """
         Find all <div class="wikicms-form" data-form-name="..."> elements and
         replace each with the rendered form HTML from the registry.
@@ -157,7 +145,6 @@ def replace_form_divs(self, pc: PageContent) -> PageContent:
         Returns:
             PageContent: the page content with forms replaced
         """
-
         renderer = FormRenderer()
 
         def replace_match(m: re.Match) -> str:
@@ -173,11 +160,10 @@ def replace_match(m: re.Match) -> str:
             pc.html,
             flags=re.DOTALL,
         )
-        return pc
 
-    def doFilter(self, html, filterKeys):
+    def doFilter(self, pc:PageContent, filterKeys)->BeautifulSoup:
         # https://stackoverflow.com/questions/5598524/can-i-remove-script-tags-with-beautifulsoup
-        soup = BeautifulSoup(html, self.parser)
+        soup = BeautifulSoup(pc.html, self.parser)
         if "parser-output" in filterKeys:
             parserdiv = soup.find("div", {"class": "mw-parser-output"})
             if parserdiv:
@@ -190,7 +176,7 @@ def doFilter(self, html, filterKeys):
                 s.extract()
         for comments in soup.findAll(text=lambda text: isinstance(text, Comment)):
             comments.extract()
-        return soup
+        pc.soup=soup
 
     def fixNode(self, node, attribute, prefix, delim=None):
         """

tests/test_forms.py

@@ -13,7 +13,7 @@
 from frontend.forms.registry import FormRegistry
 from frontend.forms.renderer import FormRenderer
 from frontend.forms.validators import build_wtforms_validators, validate_with_wtforms
-from frontend.htmlfilter import MediaWikiHtmlFilter
+from frontend.htmlfilter import MediaWikiHtmlFilter, PageContent
 
 # Path to the built-in contact.yaml shipped with the package
 _CONTACT_YAML = (
@@ -389,15 +389,14 @@ def test_htmlfilter_replaces_form_div(self):
         """
         form_def = make_contact_form()
         FormRegistry.register(form_def)
-
-        html = (
+        pc=PageContent()
+        pc.html = (
             '<div class="wikicms-form" data-form-name="contact">'
             '<a href="http://www.bitplan.com/Contact">Contact form</a>'
             "</div>"
         )
-
         mwf = MediaWikiHtmlFilter()
-        result = mwf.filter_html(html)
+        result = mwf.filter_html(pc)
         if self.debug:
             print(result)
         self.assertNotIn("wikicms-form", result)

tests/test_frontend.py

@@ -28,6 +28,7 @@
 class TestFrontend(WebserverTest):
     """
     test the frontend
+    14 tests in 9.8 secs
     """
 
     instance = None
@@ -397,7 +398,9 @@ def testFixHtml(self):
             self.fail(pc.error)
         self.assertEqual(pc.page_title, "Welcome")
         content = pc.content
-        if self.debug:
+        debug=self.debug
+        debug=True
+        if debug:
             print(content)
 
         self.assertFalse("""href="/index.php""" in content)

tests/test_htmlfilter.py

@@ -12,9 +12,10 @@
 class TestHtmlFilter(Basetest):
     """
     test MediaWiki HTML filter
+    2 tests in 0.07 secs
     """
 
-    def setUp(self, debug=True, profile=True):
+    def setUp(self, debug=False, profile=True):
         Basetest.setUp(self, debug=debug, profile=profile)
 
     def testToReveal(self):

tests/test_parser.py

@@ -31,6 +31,7 @@ def endElement(self, name):
 class TestParser(Basetest):
     """
     test different parser approaches
+    2 tests in 0.01 secs
     """
 
     def setUp(self):
@@ -43,7 +44,7 @@ def setUp(self):
         <h2><span id="⌘⌘_Slide1"></span><span class="mw-headline" id=".E2.8C.98.E2.8C.98_Slide1">⌘⌘ Slide1</span><span class="mw-editsection"><span class="mw-editsection-bracket">[</span><a href="/index.php?title=RevealTest&amp;action=edit&amp;section=1" title="Edit section: ⌘⌘ Slide1">edit</a><span class="mw-editsection-bracket">]</span></span></h2>
 <p>Content for slide 1</p>
 <h2><span id="⌘⌘_Slide2"></span><span class="mw-headline" id=".E2.8C.98.E2.8C.98_Slide2">⌘⌘ Slide2</span><span class="mw-editsection"><span class="mw-editsection-bracket">[</span><a href="/index.php?title=RevealTest&amp;action=edit&amp;section=2" title="Edit section: ⌘⌘ Slide2">edit</a><span class="mw-editsection-bracket">]</span></span></h2>
-<p>Content for slide 2</p>    
+<p>Content for slide 2</p>
                 </div>
             </body>
         </html>"""

tests/test_site.py

@@ -14,6 +14,7 @@
 class TestSite(Basetest):
     """
     test wiki
+    4 tests in 3.4 secs
     """
 
     def setUp(self, debug=True, profile=True):

tests/test_wikicms.py

@@ -14,6 +14,7 @@
 class TestWikiCMS(Basetest):
     """
     test the Mediawiki based Content Management System
+    2 tests in 0.2 secs
     """
 
     def setUp(self):

tests/test_wikis.py

@@ -19,7 +19,9 @@ def setUp(self, debug=False, profile=True):
 
     def testWikis(self):
         """
-        test wikis"""
+        test wiki
+        e.g. 91 wikis in 2.16 secs
+        """
         wikis = Wikis()
         graph = MogwaiGraph()
         wikis.add_to_graph(graph, with_progress=True)