application.py — Application Module

Wraps SpinFire.Scripting.API.Utilities.ApplicationUtilities. Handles opening and closing SpinFire files. OpenFile and OpenFiles go through spinfirecontext.DefaultScriptManager. CloseFile passes both DefaultScriptManager and the active spinfirecontext.ScriptManager.

Function

Parameters

Returns

Description

OpenFile(filePath)

filePath (str) — path to the file

Result message

Opens the SpinFire file at the given path.

OpenFiles(filePaths)

filePaths (list of str) — paths to the files

Collection of result messages

Opens multiple SpinFire files.

CloseFile()

none

Result message

Closes the current SpinFire file.

Usage

1import spinfirescript as sfs
2
3print(sfs.OpenFile("pathToFile"))
4print(sfs.OpenFiles(["pathToFile1", "pathToFile2"]))
5print(sfs.CloseFile())