Document-Specific scripts?

[Bayesian]

I know that I can put Python scripts into macros (or notebooks now). But I increasingly find myself writing code for individual documents, for example to change values, recompute, export and so on. It may even be a good idea in terms of organizing/distributing files to have the script inside the FC file.

Is there any way put a Python script inside a document file? If not, regard this as a Feature suggestion

[Chris_G]

Here is an interesting related topic.

[vocx]

...to have the script inside the FC file.

Is there any way put a Python script inside a document file? If not, regard this as a Feature suggestion

Besides the thread already mentioned, How to embed a Python code into the document?

I finally found these other two references that I also wanted to mention:

• [Feature request] Storing python code/macros as Tree-element inside .fcstd
• PDF inside the project

In particular, microelly2 mentions using a StringList property. This is actually how the Draft Text object is implemented.

Code: Select all

import FreeCAD as App
obj = App.ActiveDocument.addObject("App::FeaturePython", "Textual_block")
obj.addProperty("App::PropertyStringList", "Text", "Base", "The text content displayed by this object")

Now arbitrary text can be placed inside the Text attribute, maybe even entire lines of code.

Code: Select all

obj.Text="""
import FreeCAD as App
obj = App.ActiveDocument.addObject("App::FeaturePython", "Textual_block")
obj.addProperty("App::PropertyStringList", "Text", "Base", "The text content displayed by this object")

# Some functions
def bla():
    blah, bloh = something()
"""

The text can be simply retrieved by printing to the terminal

Code: Select all

print(obj.Text[0])

Then you could add a button to display the text in the macro editor, or in another text box.

Code: Select all

import PySide
Text = PySide.QtGui.QTextEdit()
Text.setText(obj.Text[0])
Text.setFont(PySide.QtGui.QFont("Mono"))
Text.show()

In the second thread above, Yorik mentions about the FileIncluded property. It can be used to save any file into the .FCstd file, for example, an entire text file (macro code).

Code: Select all

obj.addProperty("App::PropertyFileIncluded", "AttachedTextFile", "Base", "A file to save inside this document")

The important thing is to never run automatically external arbitrary text. Loading is one thing, but running the text must be done manually by the user.