First-cut auto-generated no-meaning operators

Author: rocky

mathics/builtin/no_meaning.py

@@ -5,38 +5,49 @@
 Operators without Built-in Meanings
 
 Not all operators recognized by the Mathics3 are associated with functions that have built‐in meanings.
-You can use these operators as a way to build up your own notation within the Mathics3.
+You can use these operators as a way to build up your own notation within Mathics3.
 """
 
-from mathics.core.attributes import A_NO_ATTRIBUTES
-from mathics.core.builtin import InfixOperator
+from inspect import getmembers, isclass
+from sys import modules
 
+from mathics.core.builtin import OPERATOR_DATA, NoMeaningInfixOperator
 
-class Star(InfixOperator):
-    r"""
-    Star <url>
-    :WML link:
-    https://reference.wolfram.com/language/ref/Star.html</url>
+# Note: classes in this file must *only* be "no-meaning"
+# builtin operator classes.
 
-    <dl>
-      <dt>'Star[$x$, $y$, ...]'
-      <dd>displays $x$ ⋆ $y$ ⋆ ...
-    </dl>
 
-    >> Star[x, y, z]
-     = x ⋆ y ⋆ z
+class Because(NoMeaningInfixOperator):
+    r"""This text is replaced! But it needs to be here for documentation detection."""
 
-    >> a \[Star] b
-     = a ⋆ b
-    """
 
-    attributes = A_NO_ATTRIBUTES
-    default_formats = False  # Don't use any default format rules. Instead, see below.
-    formats = {
-        (("InputForm", "OutputForm", "StandardForm"), "Star[args__]"): (
-            'Infix[{args}, "⋆"]'
-        ),
-    }
+class Cap(NoMeaningInfixOperator):
+    r"""This text is replaced! But it needs to be here for documentation detection."""
 
-    operator = "⋆"  # \u22C6
-    summary_text = "star symbol"
+
+class CenterDot(NoMeaningInfixOperator):
+    r"""This text is replaced! But it needs to be here for documentation detection."""
+
+
+class Star(NoMeaningInfixOperator):
+    r"""This text is replaced! But it needs to be here for documentation detection."""
+
+
+# Generate Builtin No-meaning Builtin Infix operators, using
+# the Operator name and Operator Unicode found by reading
+# the operators JSON file.
+for name, operator_class in getmembers(modules[__name__]):
+    if isclass(operator_class):
+        operator_name = operator_class.__name__
+        operator_string = OPERATOR_DATA["no-meaning-infix-operators"].get(operator_name)
+        if operator_string is not None:
+            operator_class.operator = operator_string
+            operator_class.__doc__ = NoMeaningInfixOperator.__doc_pattern__.format(
+                operator_name=operator_name, operator_string=operator_string
+            )
+        operator_class.summary_text = f"""{operator_name} infix operator "{operator_string}" (no pre-set meaning attached)"""
+        operator_class.formats = {
+            (("InputForm", "OutputForm", "StandardForm"), f"{operator_name}[args__]"): (
+                ('Infix[{args}, "%s"]' % operator_string)
+            )
+        }

mathics/core/builtin.py

@@ -1254,6 +1254,36 @@ def __init__(self, *args, **kwargs):
             self.rules = default_rules
 
 
+class NoMeaningInfixOperator(InfixOperator, ABC):
+    """
+    Operators that have no pre-defined meaning are derived from this class.
+    """
+
+    # This will be used to create a docstring
+    __doc_pattern__ = r"""
+    {operator_name} <url>
+    :WML link:
+    https://reference.wolfram.com/language/ref/{operator_name}.html</url>
+
+    <dl>
+      <dt>'{operator_name}[$x$, $y$, ...]'
+      <dd>displays $x$ {operator_string} $y$ {operator_string} ...
+    </dl>
+
+    >> {operator_name}[x, y, z]
+     = x {operator_string} y {operator_string} z
+
+    >> a \[{operator_name}] b
+     = a {operator_string} b
+
+    """
+    attributes = A_NO_ATTRIBUTES
+    default_formats = False  # Don't use any default format rules. Instead, see below.
+
+    operator = "This should be overwritten"
+    summary_text = "This should be overwritten"
+
+
 class Predefined(Builtin, ABC):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)