feat: promote font force heat flux and integer set properties

scripts/freecad-property-force-failure.py

@@ -0,0 +1,154 @@
+import json
+
+import FreeCAD as App
+
+
+FREECAD_COMMIT = "0108fd4b4850cc46e625b60e53cea7a7bbe69f8d"
+INVALID_INPUTS = [
+    ("wrong-dimension", "5 mm"),
+    ("malformed-text", "not-a-quantity"),
+]
+
+
+def value_snapshot(obj, property_name):
+    value = getattr(obj, property_name)
+    return {"raw": str(value), "numeric": round(float(value.Value), 9), "unit": str(value.Unit)}
+
+
+def object_snapshot(document):
+    return [{"name": obj.Name, "typeId": obj.TypeId} for obj in document.Objects]
+
+
+def exception_snapshot(callback):
+    try:
+        callback()
+    except Exception as error:
+        return {"type": type(error).__name__, "message": str(error)}
+    return None
+
+
+def active_transaction_snapshot():
+    active = App.getActiveTransaction()
+    if not active:
+        return {"name": "", "id": 0}
+    return {"name": str(active[0]), "id": int(active[1])}
+
+
+def run():
+    document = App.newDocument("PropertyForceFailure")
+    try:
+        force = document.addObject("Fem::ConstraintForce", "ForceProbe")
+        rigid = document.addObject("Fem::ConstraintRigidBody", "RigidForceProbe")
+        document.recompute()
+        document.UndoMode = 1
+        initial = value_snapshot(force, "Force")
+        initial_objects = object_snapshot(document)
+        failures = []
+        for case_id, requested in INVALID_INPUTS:
+            before = value_snapshot(force, "Force")
+            before_objects = object_snapshot(document)
+            exception = exception_snapshot(lambda: setattr(force, "Force", requested))
+            after = value_snapshot(force, "Force")
+            after_objects = object_snapshot(document)
+            failures.append({
+                "id": case_id,
+                "requested": requested,
+                "exception": exception,
+                "before": before,
+                "after": after,
+                "beforeObjects": before_objects,
+                "afterObjects": after_objects,
+                "valuePreserved": before == after,
+                "objectsPreserved": before_objects == after_objects,
+                "polluted": before_objects != after_objects,
+            })
+
+        disabled_before = value_snapshot(force, "Force")
+        disabled_objects_before = object_snapshot(document)
+        force.setEditorMode("Force", ["ReadOnly"])
+        force.setPropertyStatus("Force", "Immutable")
+        disabled_status = [str(item) for item in force.getPropertyStatus("Force")]
+        disabled_editor_mode = [str(item) for item in force.getEditorMode("Force")]
+        disabled_exception = exception_snapshot(lambda: setattr(force, "Force", "750 N"))
+        disabled_after = value_snapshot(force, "Force")
+        disabled_objects_after = object_snapshot(document)
+        force.setPropertyStatus("Force", "-Immutable")
+        force.setEditorMode("Force", 0)
+        disabled = {
+            "classification": "editor-read-only-and-python-immutable",
+            "requested": "750 N",
+            "status": disabled_status,
+            "editorMode": disabled_editor_mode,
+            "exception": disabled_exception,
+            "before": disabled_before,
+            "after": disabled_after,
+            "valuePreserved": disabled_before == disabled_after,
+            "objectsPreserved": disabled_objects_before == disabled_objects_after,
+            "restoredStatus": [str(item) for item in force.getPropertyStatus("Force")],
+            "restoredEditorMode": [str(item) for item in force.getEditorMode("Force")],
+        }
+
+        output_before = value_snapshot(rigid, "ForceX")
+        output_status = [str(item) for item in rigid.getPropertyStatus("ForceX")]
+        output_editor_mode = [str(item) for item in rigid.getEditorMode("ForceX")]
+        output_assignment_exception = exception_snapshot(lambda: setattr(rigid, "ForceX", "125 N"))
+        output_after = value_snapshot(rigid, "ForceX")
+        rigid.ForceX = "0 N"
+        output_restored = value_snapshot(rigid, "ForceX")
+        output = {
+            "classification": "prop-output-ui-read-only-python-mutable",
+            "property": {"name": "ForceX", "typeId": rigid.getTypeIdOfProperty("ForceX")},
+            "status": output_status,
+            "editorMode": output_editor_mode,
+            "assignmentException": output_assignment_exception,
+            "before": output_before,
+            "after": output_after,
+            "restored": output_restored,
+            "restoredExactly": output_before == output_restored,
+        }
+
+        document.openTransaction("property-force-cancel")
+        transaction_before = value_snapshot(force, "Force")
+        transaction_objects_before = object_snapshot(document)
+        force.Force = "250 N"
+        transaction_edited = value_snapshot(force, "Force")
+        transaction_pending_after_edit = bool(document.HasPendingTransaction)
+        transaction_active_after_edit = active_transaction_snapshot()
+        document.abortTransaction()
+        transaction_after = value_snapshot(force, "Force")
+        transaction_objects_after = object_snapshot(document)
+        final_objects = object_snapshot(document)
+        return {
+            "schemaVersion": 1,
+            "status": "pass",
+            "baselineId": "freecad-1.1.1-property-force-failure",
+            "freecadVersion": ".".join(str(value) for value in App.Version()[:3]),
+            "gitCommit": FREECAD_COMMIT,
+            "object": {"name": force.Name, "typeId": force.TypeId},
+            "property": {"name": "Force", "typeId": force.getTypeIdOfProperty("Force")},
+            "initial": initial,
+            "failures": failures,
+            "disabled": disabled,
+            "outputBoundary": output,
+            "transaction": {
+                "before": transaction_before,
+                "edited": transaction_edited,
+                "afterAbort": transaction_after,
+                "objectsBefore": transaction_objects_before,
+                "objectsAfter": transaction_objects_after,
+                "undoMode": int(document.UndoMode),
+                "pendingAfterEdit": transaction_pending_after_edit,
+                "pendingAfterAbort": bool(document.HasPendingTransaction),
+                "activeAfterEdit": transaction_active_after_edit,
+                "activeAfterAbort": active_transaction_snapshot(),
+                "restored": transaction_before == transaction_after,
+                "objectsRestored": transaction_objects_before == transaction_objects_after,
+            },
+            "cancellationBoundary": {"supported": False, "classification": "synchronous-property-setter", "reason": "no-native-cancel-hook", "replacement": "abort-active-document-transaction"},
+            "documentIntegrity": {"initialObjects": initial_objects, "finalObjects": final_objects, "objectsPreserved": initial_objects == final_objects, "objectCount": len(final_objects)},
+        }
+    finally:
+        App.closeDocument(document.Name)
+
+
+print("FREECAD_PROPERTY_FORCE_FAILURE_RESULT=" + json.dumps(run(), sort_keys=True))