ScriptProject

No flags set.

Controls whether whitespace changes are ignored (some object comparers ignore this parameter).

Controls whether comment changes are ignored (some object comparers ignore this parameter).

Controls whether property changes are ignored (some object comparers ignore this propertyparameter).

Controls whether renames are split into a add and remove operation. If set to True, renamed objects are recorded as addition and deletion. If set to False, renamed objects are marked with ScriptProject.ObjectDifferences.RENAMED.

Controls whether transient objects are ignored. Transient objects (like task call objects sitting below a ScriptTaskObject or SVN_VERSION_INFO objects) are not saved with the project, they’re based on data stored elsewhere and will be recreated on the fly, thus they’re not compared by default.

Controls whether hidden objects are ignored. As they’re not visible to the user, and usually represented by some other visible objects, they’re not compared by default.

The objects are equal.

The object was added.

The object has been deleted.

The contents of the object are different.

The parent folder of the object is different.

The acces rights of the object are different.

The mets properties of the object are different.

The name of the object was changed.

This covers any changes we can detect now and in the future. (=0xFFFFFF)

The import did not change anything at all.

The import was successful

The import skipped some entries

Errors happened during the import

Replace the object.

Skip the object

Cancel the import

The existing object is replaced by the imported object.

The existing object remains with its original name, and the imported object is renamed so that is does not conflict any more.

The object to be imported is skipped.

Closes this project.

The corresponding Object Manager project will also be closed. If this project has got unsaved changes, these changes will be discarded.

Saves this project at its physical location (see path).

The encryption settings are not changed.

Saves the project under a new filename and with different encryption.

If no password is given (None is passed), encryption stays as it is. If the password given, but an empty string, encryption is disabled. Otherwise, the password is used as new password to encrypt the project.

Saves the project as an archive.

All additional categories which are selected by default are included, but no extra files.

Gets a boolean value indicating whether this project has been changed since the last call to save().

Gets a boolean value indicating whether the primary attribute has been set for this project.

The primary project is the one the user is currently working with.

The other, non-primary projects (aka background projects) can serve several purposes, for example:

• Libraries referenced by the primary project.

• Projects opened for comparison by the “Compare Project” command.

• Temporary projects created for various purposes, e. G. by the V2.3 import converter,

• or the CODESYS SVN add-on.

Those projects are not directly user visible, and you should not modify or close them from within your scripts.

Gets a boolean value indicating whether the project is a background library project.

Those projects represent a library which was loaded because it is referenced by the primary project (directly or indirectly). It will automatically be closed when the primary project is closed.

If you want to check whether the primary project is a library or not, check whether the path() ends with “.library” or “.project”.

Gets the absolute path where this project is physically stored.

To change that path, use save_as().

Gets or sets the active application.

This is a property. You can read or assign a ScriptObject for the application you want to be the active application.

Prints the specified database objects, including chapter headings and chapter numbering, a title page and table of contents.

The current printer settings as specified by the user are used. Currently, printing only works when the UI is present, not in –noUI mode.

Exports the given objects in PLCopenXML format into a string, or a file at the given path.

All non-exportable objects are reported as error, but the export may still continue.

Imports the contents of the specified PLCopenXML file into the top level of the project.

The heuristics to find out whether the content is a file or directly an XML string currently is as follows: if it contains the ‘<’ character, it is regarded as an XML file. Rationale: On windows, < is an invalid char in path names, and it is contained in every XML file. (On other common platforms like unix and OSX, < is uncommon and discouraged in file names.) This heuristics may be replaced by a more sophisticated heuristics in the future.

Export the specified objects in the CoDeSys native export format.

The parameter destination must point to a directory if one_file_per_subtree is set to True, and to a file in the other case.

Imports the specified files in the native xml format in the top level of this project.

Log into the project using the specified credentials.

Log out from the project (back to the user “nobody”).

Returns the user management object for this project.

Gets a value indicating whether this ScriptProject already has a project information object.

Gets the project information object, implicitly creating one if not existing yet.

Checks all pool objects. This command only works reliable for libraries, and when called on primary projects.

You can use the System.get_messages() and System.get_message_objects() calls to check whether any messages were added.

Generates the specified destination_directory.

At least one of generate_m4 and generate_c must be set.

Performs a “Clean All”.

Save the current project as a compiled library.

This command currently only works for the primary project.

The destination_name has the following semantics: If it is omitted or the empty string, the full project path will be used, with the extension changed to “.compiled_library”. If the name of an existing directory is given, the library will be saved there, using the project base name and the extension changed to “.compiled_library”. Otherwise, the destination name will be interpreted as the path relative to where the current project re.

Creates a folder with the specified folder name.

There are three predefined structured views, and the guids are provided as constants:

• SV_DEV The device view, SV_DEV = Guid("{D9B2B2CC-EA99-4c3b-AA42-1E5C49E65B84}")

• SV_POU The POU view, SV_POU = Guid("{21AF5390-2942-461a-BF89-951AAF6999F1}")

The Modules View currently does not support folders, so no GUID is provided.

Exports the documentation for primary project in JSON format into a string, or a file at the given path.

Compares two script projects.

Returns the management object for ScriptProjectSettings.

Enables the integrity checked project format.

Disables password, CodeMeter(TM) dongle and X509 certificate-based encryption or integrity check for the specified project.

Returns whether the integrity checked project format is is_integrity_check_enabled.

Gets a list of all available ScriptProjectArchiveCategories that can be used for ScriptProjectSettings.set_sourcedownload().

Sets the source download settings to the project.

Gets or sets the project defines (a comma separated list).

This is a property. You can read or assign a string (a comma separated list) containing the project defines. This property can be only used for compilerversion 3.5.20.0 or newer.

The object from the ScriptComparison.left_project, or None for deleted objects.

The object from the ScriptComparisonResult.right_project, or None for added objects.

The exact object differences.

The first or left project which was compared.

The second or right project which was compared.

Returns all changed objects with a matching diff state (any of the given flags have to be set).

Gets the diff state for a specific object.

This method is called when an error has occurred during export_xml.

This method is called when a warning has occurred during export_xml.

This method is called when we find out that a given object is not exportable.

This is only called for objects given directly as parameters - non-exportable children are silently ignored. The script can decide to abort the export by setting aborting to true during this phase.

This method will be called for all non-exportable objects even when aborting is set to true. The flag will be checked after all objects have been checked for exportability, just before the actual export is going to start (and thus before the destination file is opened). This allows scripts to find out about all non-exportable objects in one run.

This allows abortion when we report non-exportable objects.

This method is called when an error has occurred during import_xml.

This method is called when a warning has occurred during import_xml.

This method is called when an object to import is already existing.

This method is called whenever an object has been successfully added during import.

This method is called whenever an object has been successfully replaced during import.

This method is called whenever an object has been skipped during import.

Gets a boolean value indicating whether importing should be aborted or not.

This method is called when data has been effectively skipped during serialization or deserialization.

This method is called when a warning occurs during serialization or deserialization.

This method is called when an error occurs during serialization or deserialization.

The code that triggered the serialization should discard the resulting stream because it will not be correctly formatted in this case. The code that triggered the deserialization should discard the resulting object because it might be inconsistent.

Queries how to resolve a conflict.

Reports progress of import.

Informs about skipped objects.