prefig 0.4.6.dev20250928053207__py3-none-any.whl → 0.4.7__py3-none-any.whl

prefig/core/arrow.py

@@ -5,6 +5,7 @@ import numpy as np
 from . import utilities as util
 from . import CTM
 from . import user_namespace as un
+from . import repeat
 
 log = logging.getLogger('prefigure')
 
@@ -189,6 +190,11 @@ def add_arrowhead_marker(diagram,
             arrow_width = 13/3
         dims = (1, arrow_width) #11/3)
 
+    # EPUB does not allow some characters to appear in @id
+    # There is a possibility that we have # or . so we will
+    # replace them with this function call
+    id = repeat.epub_clean(id)
+
     # If we've already created this one, we'll just move on
     if diagram.has_reusable(id):
         return id

prefig/core/diagram.py

@@ -3,6 +3,7 @@ import lxml.etree as ET
 import numpy as np
 import logging
 import copy
+import re
 from . import tags
 from . import user_namespace as un
 from . import utilities as util
@@ -10,9 +11,13 @@ from . import CTM
 from . import label
 from . import math_utilities as math_util
 from . import annotations
+from . import repeat
 
 log = logging.getLogger('prefigure')
 
+# regular expression to check if id is EPUB compliant
+epub_id_check = re.compile('^[A-Za-z0-9_-]+$')
+
 class Diagram:
     def __init__(self,
                  diagram_element,
@@ -129,9 +134,25 @@ class Diagram:
             for child in templates_element:
                 self.defaults[child.tag] = child
 
+        annotations = self.diagram_element.xpath('.//annotations')
+        if len(annotations) > 0:
+            self.check_annotation_ref(annotations[0])
+
         if self.defaults.get('macros', None) is not None:
             label.add_macros(self.defaults.get('macros').text)
 
+    def check_annotation_ref(self, element):
+        ref = element.get('ref', None)
+        if ref is not None:
+            if not bool(epub_id_check.fullmatch(ref)):
+                log.error(f"@ref {ref} in an annotation has characters disallowed by EPUB")
+                log.error("  We will replace these characters but there may be unexpected behavior")
+                log.error("  Search for EPUB in the PreFigure documentation https://prefigure.org")
+                ref = repeat.epub_clean(ref)
+                element.set('ref', ref)
+        for child in element:
+            self.check_annotation_ref(child)
+
     def add_legend(self, legend):
         self.legends.append(legend)
         
@@ -436,6 +457,15 @@ class Diagram:
             # we're publicly using 'at' rather than 'id' for handles
             if child.get('at') is not None:
                 child.set('id', child.get('at'))
+
+            child_id = child.get('id', None)
+            if child_id is not None:
+                if not bool(epub_id_check.fullmatch(child_id)):
+                    log.error(f"The id {child_id} has characters disallowed by EPUB")
+                    log.error("  We will substitute disallowed characters to make the id EPUB compliant")
+                    log.error("  Search for EPUB in the PreFigure documentation at https://prefigure.org")
+                    child.set('id', repeat.epub_clean(child_id))
+
             # see if the publication flie has any defaults
             defaults = self.defaults.get(child.tag, None)
             if defaults is not None:

prefig/core/repeat.py

@@ -2,6 +2,7 @@ import lxml.etree as ET
 import logging
 from . import user_namespace as un
 import copy
+import re
 import numpy as np
 from . import group
 from . import label
@@ -9,6 +10,25 @@ from . import utilities
 
 log = logging.getLogger('prefigure')
 
+# EPUB restricts the characters that can appear in an id to
+#   a-z|A-Z|0-9|_|-
+# This is an issue here since <repeat> elements can create id's
+# This regular expression checks characters to see if they are allowed
+epub_check = re.compile(r'[A-Za-z0-9_-]')
+
+# We also define substitutions for the most common disallowed characters
+epub_dict = {'(': 'p',
+             ')': 'q',
+             '[': 'p',
+             ']': 'q',
+             '{': 'p',
+             '}': 'q',
+             ',': 'c',
+             '.': 'd',
+             '=': '_',
+             r'#': 'h'}
+
+
 # Allows a block of XML to repeat with a changing parameter
 
 def repeat(element, diagram, parent, outline_status):
@@ -48,11 +68,12 @@ def repeat(element, diagram, parent, outline_status):
         else:
             k_str = str(k)
 
-        un.enter_namespace(k_str, k)
+        k_str_clean = epub_clean(k_str)
+        # This is a change since we use the syntax "var_str" for the id suffix
         if count:
-            suffix_str = var + "=" + k_str
+            suffix_str = var + "_" + k_str_clean
         else:
-            suffix_str = var + "=" + str(num)
+            suffix_str = var + "_" + str(num)
 
         definition = ET.SubElement(element, 'definition')
         definition.text = var + '=' + k_str
@@ -78,3 +99,13 @@ def repeat(element, diagram, parent, outline_status):
 
     if annotation is not None:
         diagram.pop_from_annotation_branch()
+
+def epub_clean(s):
+    epub_clean = [bool(epub_check.fullmatch(ch)) for ch in s]
+    chars = []
+    for index, ch in enumerate(s):
+        if epub_clean[index]:
+            chars.append(ch)
+            continue
+        chars.append(epub_dict.get(ch, '_'))
+    return "".join(chars)

prefig/resources/schema/pf_schema.rnc

@@ -48,7 +48,7 @@ DefinitionElements =
     Derivative?,
     DE-Solution?,
     Define-Shapes?,
-    Read
+    Read?
 
 Definition = element definition {
     text,
@@ -177,7 +177,9 @@ LabelAttributes =
     attribute rotate {text}?,
     attribute clear-background {"yes"|"no"}?,
     attribute background-margin {text}?,
-    attribute color {text}?
+    attribute color {text}?,
+    attribute font {text}?,
+    attribute font-size {text}?
 
 Math = element m {attribute color {text}? & text}
 Bold = element b {attribute color {text}? & text & Italic*}