pyio

The pyio.* api functions are useful for persisting settings / values between executions of the plugin as well as for accessing and writing files on the local file system.

Settings:

• pyio.load_values
• pyio.save_values

Note

To persistently store and load any length values it is recommended to convert these values to a standard unit when saving and to the active length unit when loading by multiplying/dividing with the unit conversion factor returned by get_length_unit.

Reading:

• pyio.parse_lines
• pyio.parse_csv
• pyio.parse_json
• pyio.parse_xml

Writing:

• pyio.write_lines
• pyio.write_csv
• pyio.write_json
• pyio.write_xml

XML Utilities:

• pyio.xml_find
• pyio.xml_find_all

Path Handles:

• pyio.list_folder
• pyio.append_path

These are the global forms of the path handle methods of the same name.

Plugin Folder:

• pyio.get_plugin_folder_path
• pyio.get_scratch_folder_path

Materials:

• pyio.list_materials

Note

Access to the file system is by design limited in the context of PYTHA plugins. File system paths are only made available through opaque handles ("path handle") and even for those, only limited file management functionality is provided.

See also:

pytha, pyui, get_length_unit