Is there a way to automatically format a script for reporting?

Hello everyone,

I have an Ansys Mechanical (24R2) project that uses a bunch of scripts. As they are fundamental to the information that is generated, I would like to add them to a project report, and have this be as accessible as possible to its readers.

In the scripting editor, the script is given colors to make it more legible. That's just automatic formatting of the editor, though. Not something inherent to the script.

I initially copy-pasted the code as a figure from the editor. However, the scripting editor doesn't really have a word wrap option. So that copy-pasting of code is hard when portions of lines run out of the visible bounds. And the amount has code I'm dealing with has grown to the point this method is no longer really workable.

Does anyone know of an easy way to convert an Ansys Mechanical python scripts to some other text format and have it be colored as it is in the scripting editor? And perhaps word wrapped automatically where necessary too, possibly with line breaks (" \") at convenient locations (spaces, interpunction symbols, slashes etc.) as to keep everything readable?

There has to be an easier way than copying the code bit-by-bit from my monitor for my report, or manually going over everything to insert line-breaks so it will fit normal page width when copy pasted as a figure.

Any help with exporting/modifying scripts like this will be appreciated. Thanks in advance.

Find more posts tagged with

Mechanical

scripting

Accepted answers

All comments

If you would move your script over to a Python Code Object in the tree, then you can grab the text in the python code object, with some more python, and could then edit it for export.

MvdM-SPIE

I tried what you said, and could somewhat get it to work. Thanks.

It made the script easily accessible at least, although I think it's also possible to read the script files directly using "import os" and things like "g = open(file location, "at")", and then "g.write()", or "g.read()", or something. But I didn't  feel like figuring out again how that worked, not to mention that coding errors might endanger my original script files. So just copying scripts to a Python Object and retrieving/modifying them there was a quick and safe way to do things.

I applied the following code to automatically apply linebreaks to scripts I put in Python Objects, while keeping the code mostly functional. Admittedly, I suspect it'll have issues with strings that contain "#" symbols, and I likely didn't cover all my bases. I ran into the former issue when testing the code on itself, but I generally don't have that in the actual code I've written, so it shouldn't be a problem. This was just something to quickly get things done, so it's good enough for now.

In the Python Object, the script is still just flat text, so I don't think I can extract the script editor coloring. But if everything fits within a certain width I can at least copy everything relatively easy as a figure, even if that leaves the script inaccessible to CTRL-F searches in the eventual digital document.

#Check Python Code objects and modify the code to split lines after every so many symbols
import time
start_time = time.time()
project = ExtAPI.DataModel.Project
model = project.Model


SymbolCount = 100 #Symbols on a line, excl. /n
SplitLen = SymbolCount - 2 #Symbols on a splitline, with two less spaces for " /""
Max_Indent = 52 #Max indentation that is kept, to prevent indent overflow.
SplitSearch = [" ", "\n", ".", ",", ":", "+", "-", "*", "/", ")", "("] #strings that are looked for as possible split points.
FeedBack = True


PythonObjects = model.GetChildren(DataModelObjectCategory.PythonCode, False)


for Script in PythonObjects:
    OldScript = Script.Text
    OldScript = OldScript.splitlines(True)
    NewScript = []
    
    for line in OldScript:
        if len(line)-1 > SymbolCount:
            if FeedBack: print line
            #start data to loop over to split and clean line
            OriginalIndent = len(line)-len(line.lstrip())
            CurrentIndent = min(Max_Indent, OriginalIndent)
            if CurrentIndent ==0:
                Indent = ""
            else:
                Indent = "".join([" " for i in range(CurrentIndent)])
            SplitLenTemp = SplitLen-CurrentIndent
            
            if CurrentIndent != OriginalIndent:
                NewScript.append("#!!!!Next line was shifted to fit code, original indentation was "+ str(OriginalIndent) + " spaces!!!!\n")
            StringLeft = line.lstrip()
            InlineComment = False
            
            while StringLeft != "":
                #check if remaining string will fit in a line
                if len(StringLeft)-1>=SplitLenTemp:
                    # if not, try and find a good split point
                    NextSplitPoint = -1
                    for chrctr in SplitSearch:
                        NextSplitPoint = max(NextSplitPoint,StringLeft[1:SplitLenTemp].rfind(chrctr))
                    
                    if NextSplitPoint != -1: #if split point found, print that section and remove 
                        if StringLeft[:NextSplitPoint+1][-1]== "\n": #if the nextsplit is the endline, add it as final section.
                            NewScript.append(Indent + StringLeft[:NextSplitPoint+1])
                            StringLeft = ""
                        else: 
                            #if the next section is not the end, add it, 
                            #check it for inline comment marker and trim the StringLeft variable
                            NewScript.append(Indent + StringLeft[:NextSplitPoint+1] + " \\\n")
                            
                            if InlineComment == False:
                                if StringLeft[:NextSplitPoint+1].find("#") != -1:
                                    InlineComment = True
                            
                            StringLeft = ("#" if InlineComment else "") + StringLeft[NextSplitPoint+1:]
                            if FeedBack: print StringLeft
                    
                    else: #if no good split point, print the rest of the line with a remark in between.
                        NewScript.append(Indent + "#next line could not be split, may run out.\n")
                        NewScript.append(Indent +  StringLeft)
                        StringLeft = ""
                    
                else: #if remaining string fits the line, add it as final split line section.
                    NewScript.append(Indent + StringLeft)
                    StringLeft = ""
        
        else: #if line doesn't need to be split, just write it as is.
            NewScript.append(line)
            
    #after all lines have been reworked into NewScript, join all lines to a single string, reset OldScript, print NewScript to Python item.
    OldScript = NewScript
    NewScript = ""
    for line in OldScript:
        NewScript = NewScript + line
    OldScript = Script.Text
    Script.Text = NewScript


print ""
print "Script Modifier has succesfully run to completion."
#print "Start time: %s" % start_time
print "Run time: %s seconds" % str(time.time()-start_time)
#print "End time: %s" % time.time()

MvdM-SPIE

Urgh, annoying that I can't figure out how to make the comments I make behave. Everything became a code block for some reason in the post above. At least the code behaves well.

So as an aside, does anyone know how to edit a comment after you post it, or at least preview it before you do so?

I previewed the earlier post by making a new post that I didn't send. There at least there is a preview button. (Although I had to replace the code block by " ``` " encapsulation.) But that's also not a perfect solution.