PYFLAME
LIBRARY_
v5.5.3 · FLAME 2025.2+ · PYTHON 3.11 – 3.13 · PYSIDE6
A Python library for Autodesk Flame.
PyFlame is a Python library containing a set of custom Qt widgets for Autodesk Flame — all styled to match Flame's native UI — along with layout helpers, window classes, a config system, and utility functions for script development.
The library file should be renamed per-script to pyflame_lib_<script_name>.py and placed in the script's lib/ folder, avoiding version conflicts when multiple scripts coexist in the Flame Python folder. It requires the Montserrat font family (included in assets/fonts/) to render correctly. These fonts are included in the PyFlame library.
| Flame Version | 2025.2+ |
| Python Version | 3.11 – 3.13 |
| Qt Binding | PySide6 |
| Platform | Rocky Linux · MacOS |
| Version | 5.5.3 · Updated 10.16.26 |
| Licence | MIT License · see the LICENSE file |
- Changed license from GPL-3.0 to MIT. See LICENSE file for details.
- Fixed "screenGeometry" error for Flame 2027.2
- Widgets
- PyFlameMenu
- Updated stylesheet - menu bar now changes to grey when disabled.
- PyFlameMenu
- PyFlameConfig
- Now neatly prints lists and dictionaries to the console.
Full history: CHANGELOG.md
All scripts using PyFlame must follow this layout. Rename the library file per-script to avoid conflicts when multiple scripts are installed simultaneously.
The script folder, script name, and library file name must all be the same.
Folder structure:
├── main_script.py
├── lib/
│ └── pyflame_lib_<script_name>.py
│ └── README.md # optional
│ └── CHANGELOG.md # optional
└── assets/
└── fonts/
└── Montserrat-Regular.ttf
└── Montserrat-Light.ttf
└── Montserrat-Thin.ttf
Example folder structure for script named "rename_shots":
├── rename_shots.py
├── lib/
│ └── pyflame_lib_rename_shots.py
│ └── README.md # optional
│ └── CHANGELOG.md # optional
└── assets/
└── fonts/
└── Montserrat-Regular.ttf
└── Montserrat-Light.ttf
└── Montserrat-Thin.ttf
Import everything from the library into the script's namespace. Call the utility functions through the pyflame object (the library's _PyFlame helper class) and instantiate widgets directly by class name.
from lib.pyflame_lib_my_script import *
# Call utility functions via the pyflame object
pyflame.print("Script loaded")
flame_version = pyflame.get_flame_version()
# Instantiate widgets directly
window = PyFlameWindow(title='My Script')
button = PyFlamePushButton(text='Run', connect=my_function)
menu = PyFlameMenu(text='Options', menu_options=['A', 'B', 'C'])
window.grid_layout.addWidget(button, 0, 0)
window.grid_layout.addWidget(menu, 0, 1)
window.show()
Click any widget to see its description, parameters, and a usage example.
| PARAM | TYPE | DESCRIPTION |
| text | str | Text displayed on the button. Default: '' |
| connect | callable | Function to call when the button is clicked. Default: None |
| color | Color | Button color. Color Options Color.GRAY: Standard gray button Color.BLUE: Blue button Color.RED: Red button Default: Color.GRAY |
| enabled | bool | Whether the button is enabled. Default: True |
| width | int | Width of the button in pixels. If None, it expands to fit the layout. Minimum width is 25. Default: None |
| height | int | Height of the button in pixels. If None, defaults to 28. Default: None |
| tooltip | str | Tooltip text shown on hover. Default: None |
| tooltip_delay | int | Delay in seconds before the tooltip is shown. Default: 3 |
| tooltip_duration | int | Duration in seconds the tooltip remains visible. Default: 5 |
| PROPERTY | TYPE | DESCRIPTION |
| text | str | Get or set the button text. |
| color | Color | Get or set the button color. |
| enabled | bool | Get or set whether the widget is enabled. |
| width | int | None | Get or set the widget width. |
| height | int | None | Get or set the widget height. |
| tooltip | str | None | Get or set the tooltip text. |
| tooltip_delay | int | Get or set the tooltip delay in seconds. |
| tooltip_duration | int | Get or set the tooltip duration in seconds. |
| connect_callback(callback) Connect a callback function to the button click event. | ||
| enterEvent(event) No description in the library. | ||
| leaveEvent(event) No description in the library. |
| PARAM | TYPE | DESCRIPTION |
| text | str | Text shown in entry. Default: '' |
| align | Align | Align text to left, right, or center. Align Options Align.LEFT: Aligns text to the left side of the entry. Align.RIGHT: Aligns text to the right side of the entry. Align.CENTER: Centers text within the entry. Default: Align.LEFT |
| text_changed | callable | Function to be called whenever the text in the entry changes. This is typically used to perform live updates based on user input. Default: None |
| placeholder_text | str | Temporary text to display when entry is empty. Default: '' |
| read_only | bool | Sets the entry to be read-only if True, disabling user input and applying a distinct visual style to indicate this state. Text is not selectable. Default: False |
| password_echo | bool | If True, the entry will display asterisks instead of the actual characters. Default: False |
| enabled | bool | Whether the entry is enabled. Default: True |
| width | int | Width of the entry in pixels. If None, it expands to fit the layout. Minimum width is 25. Default: None |
| height | int | Height of the entry in pixels. If None, defaults to 28. Default: None |
| tooltip | str | Tooltip text shown on hover. Default: None |
| tooltip_delay | int | Delay in seconds before the tooltip is shown. Default: 3 |
| tooltip_duration | int | Duration in seconds the tooltip remains visible. Default: 5 |
| PROPERTY | TYPE | DESCRIPTION |
| text | str | Get or set entry text. |
| align | Align | Get or set text alignment. |
| placeholder_text | str | Get or set placeholder text. |
| read_only | bool | Get or set read-only state. |
| password_echo | bool | Get or set password echo mode. |
| enabled | bool | Get or set whether the widget is enabled. |
| width | int | None | Get or set the widget width. |
| height | int | None | Get or set the widget height. |
| tooltip | str | None | Get or set the tooltip text. |
| tooltip_delay | int | Get or set the tooltip delay in seconds. |
| tooltip_duration | int | Get or set the tooltip duration in seconds. |
| set_focus() Sets focus to the entry. | ||
| text_changed(connected_function) Connects a function to be called when the entry text changes. | ||
| mousePressEvent(event) No description in the library. | ||
| mouseMoveEvent(event) No description in the library. | ||
| keyPressEvent(event) No description in the library. | ||
| mouseDoubleClickEvent(event) No description in the library. | ||
| enterEvent(event) No description in the library. | ||
| leaveEvent(event) No description in the library. | ||
| eventFilter(obj, event) Filter events for PyFlameEntry. Used to show tooltip when Alt+Click. |
| PARAM | TYPE | DESCRIPTION |
| path required | str | Path to be displayed in entry. |
| placeholder_text | str | Text displayed when the entry is empty. Default: None |
| browser_type | BrowserType | Type of browser to open. Must be either BrowserType.FILE or BrowserType.DIRECTORY. Default: BrowserType.FILE |
| browser_ext | list[str] | List of file extensions to filter by when using BrowserType.FILE. Ignored if browser_type is BrowserType.DIRECTORY. Default: [] |
| browser_title | str | Title of the browser window. Default: 'Select File' |
| window_to_hide | list[QtWidgets.QWidget] | QtWidgets.QWidget | Window to hide while the browser is open. Default: None |
| connect | callable | Function to call after the file browser closes. Default: None |
| enabled | bool | Whether the entry is enabled. Default: True |
| width | int | Width of the entry in pixels. If None, it expands to fit the layout. Minimum width is 25. Default: None |
| height | int | Height of the entry in pixels. If None, defaults to 28. Default: None |
| tooltip | str | Tooltip text shown on hover. Default: None |
| tooltip_delay | int | Delay in seconds before the tooltip is shown. Default: 3 |
| tooltip_duration | int | Duration in seconds the tooltip remains visible. Default: 5 |
| PROPERTY | TYPE | DESCRIPTION |
| path | str | Get or set the current path in the entry field. |
| placeholder_text | str | Get or set the placeholder text. |
| enabled | bool | Get or set whether the widget is enabled. |
| width | int | None | Get or set the widget width. |
| height | int | None | Get or set the widget height. |
| tooltip | str | None | Get or set the tooltip text. |
| tooltip_delay | int | Get or set the tooltip delay in seconds. |
| tooltip_duration | int | Get or set the tooltip duration in seconds. |
| connect_callback(callback) Connect a callback function to the button click event. | ||
| open_file_browser(browser_type, browser_ext, browser_title, window_to_hide=None) Open flame file browser to select file or directory. | ||
| mousePressEvent(event) No description in the library. | ||
| mouseMoveEvent(event) No description in the library. | ||
| keyPressEvent(event) No description in the library. | ||
| enterEvent(event) No description in the library. | ||
| leaveEvent(event) No description in the library. |
| PARAM | TYPE | DESCRIPTION |
| image | str | QPixmap | None | Path to an image file, a QPixmap, or None to show an empty frame. Supports any format that QPixmap can decode (PNG, JPG, EXR via plugins, DPX, TIFF, etc.). Default: None |
| show_info | bool | Enable to show image filename and resolution at the botttom of the widget. Default: False |
| show_border | bool | Draws a 1-pixel border around the image area. Default: False |
| popup_viewer | bool | When True, double-clicking the image opens a standalone popup viewer window. When False, double-clicks are ignored. Default: False |
| width | int | None | Optional fixed width in pixels. When None the widget expands to fill available horizontal space. Default: None |
| height | int | None | Optional fixed height in pixels. When None the widget expands to fill available vertical space. Default: None |
| parent | QWidget | None | Optional parent widget. Default: None |
| PROPERTY | TYPE | DESCRIPTION |
| image | str | QPixmap | None | Get or set the displayed image. Accepts a file path, a QPixmap, or None to clear the display. |
| image_path | str | None | Read-only. The file-system path of the currently loaded image, or None if no image is loaded or the image was set via QPixmap. |
| has_image | bool | Read-only. True if a valid image is currently loaded. |
| image_size | tuple[int, int] | None | Read-only. Pixel dimensions of the loaded image as (width, height), or None if no image is loaded. |
| show_info | bool | Read-only. True if the info bar entry is present. |
| info_text | str | Get or set the text shown in the info bar. Only meaningful when show_info=True. Setting this property overrides the automatically generated filename/resolution string until the next time image is assigned. |
| background_color | Color | Color used to fill the areas not covered by the scaled image. Defaults to Color.DARK_GRAY. |
| border_color | Color | Color of the 1-pixel border surrounding the image area. Defaults to Color.BORDER. |
| sizeHint() Default size hint when no explicit size is set. | ||
| minimumSizeHint() Minimum sensible size for the widget. | ||
| resizeEvent(event) Repositions the info bar entry at the bottom of the widget whenever the widget is resized. | ||
| enterEvent(event) No description in the library. | ||
| leaveEvent(event) No description in the library. | ||
| paintEvent(event) Draws: 1. A 1-pixel border around the image area (Color.BORDER). 2. A dark grey background fill inside the border (Color.DARK_GRAY). 3. The image, scaled to fit inside the border while preserving the original aspect ratio, centered within the inner area. | ||
| mouseDoubleClickEvent(event) Open the popup image viewer on a left double-click when popup_viewer is enabled. |
| PARAM | TYPE | DESCRIPTION |
| folder | str | None | Path to the folder to load images from. Can be changed later via the folder property. Default: None |
| columns | int | None | Number of grid columns. Must be >= 1. Cannot be combined with rows. When set, images flow left-to-right and wrap into new rows with a vertical scrollbar. Defaults to 4 when neither columns nor rows is provided. Default: None |
| rows | int | None | Number of grid rows. Must be >= 1. Cannot be combined with columns. When set, images flow top-to-bottom and wrap into new columns with a horizontal scrollbar. Default: None |
| show_info | bool | When True, a read-only PyFlameEntry is displayed below the grid showing the selected image filename and resolution. Default: False |
| popup_viewer | bool | When True, double-clicking a gallery image opens a standalone popup viewer window. When False, double-clicks are ignored. Default: False |
| sort_ascending | bool | Filename sort order. True = A-Z, False = Z-A. Default: True |
| extensions | list[str] | None | File extensions to include, e.g. ['.png', '.exr']. When None the default set of common image formats is used. Default: None |
| image_selected | Callable[[str], None] | None | Callback invoked with the full path of the selected image whenever the selection changes. Default: None |
| width | int | None | Optional fixed widget width in pixels. Default: None |
| height | int | None | Optional fixed widget height in pixels. Default: None |
| parent | QWidget | None | Optional parent widget. Default: None |
| PROPERTY | TYPE | DESCRIPTION |
| folder | str | None | Get or set the folder path. Setting reloads the gallery. |
| columns | int | None | Get or set the number of grid columns. Only valid when the gallery was created in columns mode. Setting rebuilds the grid. |
| rows | int | None | Get or set the number of grid rows. Only valid when the gallery was created in rows mode. Setting rebuilds the grid. |
| sort_ascending | bool | Get or set the sort direction. Setting resorts and rebuilds. |
| extensions | list[str] | Get or set the allowed extensions. Setting reloads. |
| show_info | bool | Read-only. True if the info bar is present. |
| image_count | int | Read-only. Total images currently loaded. |
| selected_path | str | None | Read-only. Full path of the selected image. |
| selected_name | str | None | Read-only. Filename of the selected image. |
| selected_size | tuple[int, int] | None | Read-only. (width, height) of the selected image pixmap. |
| selected_index | int | None | Read-only. Zero-based grid index of the selected image. |
| sizeHint() Default size hint based on mode. | ||
| refresh() Re-scan the current folder and rebuild the grid without recreating the gallery widget itself. Useful when the folder contents may have changed on disk. | ||
| showEvent(event) No description in the library. | ||
| resizeEvent(event) Reposition children and recompute cell sizes. | ||
| enterEvent(event) No description in the library. | ||
| leaveEvent(event) No description in the library. | ||
| keyPressEvent(event) Arrow key navigation between cells. | ||
| eventFilter(obj, event) Intercept mouse and hover events on cell widgets. |
| PARAM | TYPE | DESCRIPTION |
| text | str | Text to display in the label. Default: '' |
| style | Style | Set the label text style. Style Options Style.NORMAL: Standard label without styling (left-aligned). Style.UNDERLINE: Underlines the text (centered). Style.BORDER: White border with dark background (centered). Style.BACKGROUND: Darker background (left-aligned). Style.BACKGROUND_THIN: Dark background with thin font weight (left-aligned). Default: Style.NORMAL |
| align | Align | Align text to the left, right, or center. Overrides alignment defined by style. Align Options None: Uses alignment from the style. Align.LEFT: Aligns text to the left. Align.RIGHT: Aligns text to the right. Align.CENTER: Centers text. Default: None |
| underline_color | Color | Color of underline when using Style.UNDERLINE. Can be a Color enum or an (R, G, B, A) tuple. Default: Color.TEXT_UNDERLINE |
| enabled | bool | Whether the label is enabled. Default: True |
| width | int | Width of the label in pixels. If None, it expands to fit the layout. Minimum width is 25. Default: None |
| height | int | Height of the label in pixels. If None, defaults to 28. Default: None |
| font_size | int | Font size for the label text. If None, uses the default constant FONT_SIZE. Default: None |
| parent | QtWidgets.QWidget | Parent widget (e.g. for tooltips). Default: None |
| PROPERTY | TYPE | DESCRIPTION |
| text | str | Get or set the label text. |
| style | Style | Get or set the label style. |
| align | Align | Get or set text alignment. Overrides style alignment. |
| underline_color | Color | Get or set the underline color. Accepts a Color enum or RGBA tuple. |
| enabled | bool | Get or set whether the widget is enabled. |
| width | int | None | Get or set the widget width. |
| height | int | None | Get or set the widget height. |
| font_size | int | Get or set font size. |
| PARAM | TYPE | DESCRIPTION |
| items | List[str] | List of items to populate the list widget. Default: [] |
| header | str | Text for a header shown above the list, styled to match the PyFlameTreeWidget column header. If None, no header is displayed. Default: None |
| header_align | Align | Alignment of the header text. One of Align.LEFT, Align.CENTER, or Align.RIGHT. Default: Align.CENTER |
| alternating_row_colors | bool | Enable alternating row background colors. Default: True |
| multi_selection | bool | No description in the library. Default: True |
| enabled | bool | Whether the list wideggt is enabled. Default: True |
| width | int | Width of the list widget in pixels. If None, it expands to fit the layout. Minimum width is 25. Default: None |
| height | int | Height of the list widget in pixels. If None, it expands to fit the layour. Minimum height is 28. Default: None |
| tooltip | str | Tooltip text shown on hover. Default: None |
| tooltip_delay | int | Delay in seconds before the tooltip is shown. Default: 3 |
| tooltip_duration | int | Duration in seconds the tooltip remains visible. Default: 5 |
| PROPERTY | TYPE | DESCRIPTION |
| items | List[str] | Get or set the list of items. Replaces all existing items. |
| header | str | None | Get or set the header text shown above the list. Set to None to hide the header. |
| header_align | Align | Get or set the alignment of the header text (Align.LEFT, Align.CENTER, or Align.RIGHT). |
| selected_items | List[str] | Get the currently selected items. |
| alternating_row_colors | bool | Enable or disable alternating row colors. |
| enabled | bool | Get or set whether the widget is enabled. |
| width | int | None | Get or set the widget width. |
| height | int | None | Get or set the widget height. |
| tooltip | str | None | Get or set the tooltip text. |
| tooltip_delay | int | Get or set the tooltip delay in seconds. |
| tooltip_duration | int | Get or set the tooltip duration in seconds. |
| add_items(items) Append a list of strings to the existing items in the widget. | ||
| replace_items(items) Replace all items in list with new list. | ||
| resizeEvent(event) Keep the header label spanning the width of the list, directly above the item area. | ||
| paintEvent(event) Draw a 1px border around the current item, matching the selected-item border in PyFlameTreeWidget. | ||
| mousePressEvent(event) Prevents items in list from being deselected when clicking off list. | ||
| enterEvent(event) No description in the library. | ||
| leaveEvent(event) No description in the library. |
| PARAM | TYPE | DESCRIPTION |
| text | str | Text displated on button. Default: '' |
| checked | bool | Whether the button is checked. Default: False |
| connect | callable | Function to be called when button is pressed. Default: None |
| enabled | bool | Whether the button is enabled. Default: True |
| width | int | Width of the button in pixels. If None, it expands to fit the layout. Minimum width is 25. Default: None |
| height | int | Height of the button in pixels. If None, defaults to 28. Default: None |
| tooltip | str | Tooltip text shown on hover. Default: None |
| tooltip_delay | int | Delay in seconds before the tooltip is shown. Default: 3 |
| tooltip_duration | int | Duration in seconds the tooltip remains visible. Default: 5 |
| PROPERTY | TYPE | DESCRIPTION |
| text | str | Text displayed on button. |
| checked | bool | Whether the button is currently checked. |
| enabled | bool | Get or set whether the widget is enabled. |
| width | int | None | Get or set the widget width. |
| height | int | None | Get or set the widget height. |
| tooltip | str | None | Get or set the tooltip text. |
| tooltip_delay | int | Get or set the tooltip delay in seconds. |
| tooltip_duration | int | Get or set the tooltip duration in seconds. |
| connect_callback(callback) Connect a callback function to the button click event. | ||
| enterEvent(event) No description in the library. | ||
| leaveEvent(event) No description in the library. |
| PARAM | TYPE | DESCRIPTION |
| text | str | Current menu selection. Default: '' |
| align | Align | Set text alignment. Align Options Align.LEFT: Aligns text to the left side of the menu. Align.RIGHT: Aligns text to the right side of the menu. Align.CENTER: Centers text within the menu. Default: Align.LEFT |
| menu_options | list[str] | List of menu options. Default: [] |
| menu_indicator | bool | Whether the menu indicator arrow is shown. Default: False |
| connect | callable | Function called when menu selection is changed. Default: None |
| enabled | bool | Whether the menu is enabled. Default: True |
| width | int | Width of the menu in pixels. If None, it expands to fit the layout. Minimum width is 25. Default: None |
| height | int | Height of the menu in pixels. If None, defaults to 28. Default: None |
| tooltip | str | Tooltip text shown on hover. Default: None |
| tooltip_delay | int | Delay in seconds before the tooltip is shown. Default: 3 |
| tooltip_duration | int | Duration in seconds the tooltip remains visible. Default: 5 |
| PROPERTY | TYPE | DESCRIPTION |
| text | str | Get or set current menu selection. |
| align | Align | Get or set alignment of text on menu. |
| menu_options | List[str] | Get or set list of menu options. |
| menu_indicator | bool | Get or set whether the menu indicator arrow is shown. |
| enabled | bool | Get or set whether the widget is enabled. |
| width | int | None | Get or set the widget width. |
| height | int | None | Get or set the widget height. |
| tooltip | str | None | Get or set the tooltip text. |
| tooltip_delay | int | Get or set the tooltip delay in seconds. |
| tooltip_duration | int | Get or set the tooltip duration in seconds. |
| update_menu(text, menu_options, connect=None) Use to update an existing button menu. | ||
| refresh_menu() Use to refresh the menu after a change has been made to the menu options. | ||
| enterEvent(event) No description in the library. | ||
| leaveEvent(event) No description in the library. |
| PARAM | TYPE | DESCRIPTION |
| color_options | dict | Dictionary of color names and their RGBA values. Values must be normalized floats between 0.0 and 1.0. Default: {'No Color': (0.0, 0.0, 0.0, 0.0), 'Red': (0.31, 0.078, 0.078, 1.0), 'Green': (0.125, 0.224, 0.165, 1.0), 'Bright Green': (0.118, 0.396, 0.196, 1.0), 'Blue': (0.176, 0.227, 0.322, 1.0), 'Light Blue': (0.227, 0.325, 0.396, 1.0), 'Purple': (0.318, 0.263, 0.424, 1.0), 'Orange': (0.467, 0.29, 0.161, 1.0), 'Gold': (0.38, 0.38, 0.235, 1.0), 'Yellow': (0.592, 0.592, 0.18, 1.0), 'Grey': (0.537, 0.537, 0.537, 1.0), 'Black': (0.0, 0.0, 0.0, 1.0)} |
| color | str | Current color selection. Must exist in color_options. Default: 'No Color' |
| menu_indicator | bool | Whether the menu indicator arrow is shown. Default: False |
| enabled | bool | Whether the menu is enabled. Default: True |
| width | int | Width of the menu in pixels. If None, it expands to fit the layout. Minimum width is 25. Default: None |
| height | int | Height of the menu in pixels. If None, defaults to 28. Default: None |
| tooltip | str | Tooltip text shown on hover. Default: None |
| tooltip_delay | int | Delay in seconds before the tooltip is shown. Default: 3 |
| tooltip_duration | int | Duration in seconds the tooltip remains visible. Default: 5 |
| PROPERTY | TYPE | DESCRIPTION |
| color_options | Dict[float, float, float, float] | Get or set dictionary of available color names and RGBA values. |
| color | str | Get or set the color name of the selected color. |
| color_value | tuple[float, float, float, float] | Get the RGBA(Tuple) color value of the selected color. |
| menu_indicator | bool | Get or set whether the menu indicator arrow is shown. |
| enabled | bool | Get or set whether the widget is enabled. |
| width | int | None | Get or set the widget width. |
| height | int | None | Get or set the widget height. |
| tooltip | str | None | Get or set the tooltip text. |
| tooltip_delay | int | Get or set the tooltip delay in seconds. |
| tooltip_duration | int | Get or set the tooltip duration in seconds. |
| enterEvent(event) No description in the library. | ||
| leaveEvent(event) No description in the library. |
| PARAM | TYPE | DESCRIPTION |
| text | str | Text displayed on button. Default: 'Add Token' |
| token_dict | dict | Dictionary defining tokens. {'Token Name': '<Token>'}. Default: None |
| token_dest | PyFlameEntry | PyFlameEntry that token value will be applied to. Default: None |
| clear_dest | bool | Clear destination PyFlameEntry before inserting token. Default: False |
| enabled | bool | Whether the menu is enabled. Default: True |
| width | int | Width of the menu in pixels. If None, it expands to fit the layout. Minimum width is 25. Default: None |
| height | int | Height of the menu in pixels. If None, defaults to 28. Default: None |
| tooltip | str | Tooltip text shown on hover. Default: None |
| tooltip_delay | int | Delay in seconds before the tooltip is shown. Default: 3 |
| tooltip_duration | int | Duration in seconds the tooltip remains visible. Default: 5 |
| PROPERTY | TYPE | DESCRIPTION |
| text | str | Get or set current token menu text. |
| token_dict | Dict[str, str] | Get or set token dictionary. |
| token_dest | PyFlameEntry | None | Get or set token destination. Usually a PyFlameEntry widget. |
| clear_dest | bool | Get or set whether or not to clear the token destination. True to clear, otherwise False. |
| enabled | bool | Get or set whether the widget is enabled. |
| width | int | None | Get or set the widget width. |
| height | int | None | Get or set the widget height. |
| tooltip | str | None | Get or set the tooltip text. |
| tooltip_delay | int | Get or set the tooltip delay in seconds. |
| tooltip_duration | int | Get or set the tooltip duration in seconds. |
| add_menu_options(new_options) Clears existing menu and adds new menu options PyFlameTokenMenu menu. | ||
| enterEvent(event) No description in the library. | ||
| leaveEvent(event) No description in the library. |
| PARAM | TYPE | DESCRIPTION |
| min_value | int or float | Minimum value. Default: 0 |
| max_value | int or float | Maximum value. Default: 100 |
| start_value | int or float | Initial value. Default: 0 |
| rate | int or float | Slider sensitivity. The value should be between 1 and 10. Lower values are more sensitive. Default: 10 |
| connect | callable | Function called when slider value is changed. Default: None |
| enabled | bool | Whether the slider is enabled. Default: True |
| width | int | Width of the slider in pixels. If None, it expands to fit the layout. Minimum width is 25. Default: None |
| height | int | Height of the slider in pixels. If None, defaults to 28. Default: None |
| tooltip | str | Tooltip text shown on hover. Default: None |
| tooltip_delay | int | Delay in seconds before the tooltip is shown. Default: 3 |
| tooltip_duration | int | Duration in seconds the tooltip remains visible. Default: 5 |
| PROPERTY | TYPE | DESCRIPTION |
| min_value | int or float | Get or set the minimum Slider value. |
| max_value | int or float | Get or set the maximum Slider value. |
| value | int or float | Get or set the current Slider value. |
| value_str | str | Get the current Slider value as a string. |
| rate | int | Get or set the Slider sensitivity rate. |
| connect | callable | Get or set the function to be called when the Slider value is changed. |
| enabled | bool | Get or set whether the widget is enabled. |
| width | int | None | Get or set the widget width. |
| height | int | None | Get or set the widget height. |
| tooltip | str | None | Get or set the tooltip text. |
| tooltip_delay | int | Get or set the tooltip delay in seconds. |
| tooltip_duration | int | Get or set the tooltip duration in seconds. |
| connect_callback(callback) Connect a callback function to the Slider value change event. | ||
| mousePressEvent(event) No description in the library. | ||
| mouseReleaseEvent(event) No description in the library. | ||
| mouseMoveEvent(event) No description in the library. | ||
| getStepsMultiplier(event) No description in the library. | ||
| setMinimum(value) No description in the library. | ||
| setMaximum(value) No description in the library. | ||
| setValue(value) No description in the library. | ||
| enterEvent(event) No description in the library. | ||
| leaveEvent(event) No description in the library. |
| PARAM | TYPE | DESCRIPTION |
| csv_file_path | str | The path to the CSV file to load. Default: None |
| alternating_row_colors | bool | Enable alternating row background colors. Default: True |
| enabled | bool | Whether the table is enabled. Default: True |
| width | int | Width of the table in pixels. If None, it expands to fit the layout. Minimum width is 25. Default: None |
| height | int | Height of the table in pixels. If None, it expands to fit the layout. Minimum height is 28. Default: None |
| tooltip | str | None | Get or set the tooltip text. Default: None |
| tooltip_delay | int | Get or set the tooltip delay in seconds. Default: 3 |
| tooltip_duration | int | Get or set the tooltip duration in seconds. Default: 5 |
| PROPERTY | TYPE | DESCRIPTION |
| csv_file_path | str | Get or set the file path to the loaded CSV file. |
| alternating_row_colors | bool | Get or set alternating row colors. |
| enabled | bool | Get or set whether the widget is enabled. |
| width | int | None | Get or set the widget width. |
| height | int | None | Get or set the widget height. |
| tooltip | str | None | Get or set the tooltip text. |
| tooltip_delay | int | Get or set the tooltip delay in seconds. |
| tooltip_duration | int | Get or set the tooltip duration in seconds. |
| load_csv(csv_file_path=None) Load CSV file into the table. | ||
| save_csv_file(csv_file_path) Save the CSV file to the given path. | ||
| contextMenuEvent(event) Custom context menu on right-click for table body. | ||
| enterEvent(event) No description in the library. | ||
| leaveEvent(event) No description in the library. |
| PARAM | TYPE | DESCRIPTION |
| tab_names | list[str] | Names of tabs to add. Default: [] |
| grid_layout_columns | int | No description in the library. Default: 4 |
| grid_layout_rows | int | No description in the library. Default: 3 |
| grid_layout_column_width | int | No description in the library. Default: 150 |
| grid_layout_row_height | int | No description in the library. Default: 28 |
| grid_layout_adjust_column_widths | dict[int, int] | No description in the library. Default: {} |
| grid_layout_adjust_row_heights | dict[int, int] | No description in the library. Default: {} |
| tab_label_width | int | Width of each tab. Default: 150 |
| tab_label_height | int | Height of each tab. Default: 28 |
| enabled | bool | Whether to enable the tab widget. Default: True |
| parent | QtWidgets.QWidget | Parent widget. Default: None |
| PROPERTY | TYPE | DESCRIPTION |
| tab_names | list[str] | The names of the tabs in the tab widget. |
| grid_layout_columns | int | The number of columns in the grid layout. |
| grid_layout_rows | int | The number of rows in the grid layout. |
| grid_layout_column_width | int | The width of the columns in the grid layout. |
| grid_layout_row_height | int | The height of the rows in the grid layout. |
| grid_layout_adjust_column_widths | dict[int, int] | The adjusted widths of the columns in the grid layout. |
| grid_layout_adjust_row_heights | dict[int, int] | The adjusted heights of the rows in the grid layout. |
| tab_label_width | int | The width of the tab labels. |
| tab_label_height | int | The height of the tab labels. |
| tab_pages | dict[str, PyFlameTabWidget.TabContainer] | The tab containers in the tab widget. |
| enabled | bool | Whether to enable the tab widget. This is passed to the tab containers. |
| add_tab(name) Add a tab to the tab widget. | ||
| get_current_tab_name() Get Current Tab Name | ||
| get_current_tab_index() Get the index of the current tab | ||
| set_current_tab(tab) Set the current tab by name or index |
| PARAM | TYPE | DESCRIPTION |
| text | str | Text displayed in widget. Default: '' |
| text_type | TextType | Type of text being input. Options: TextType.PLAIN: Plain text. TextType.MARKDOWN: Markdown text. Rendered Markdown is automatically styled - headers are colored gold, **bold** spans are colored gold-tan, `code` spans are colored with a dark background and a thin, mostly-transparent border, body text under a header is indented, and text uses the Montserrat Light font at normal (non-condensed) glyph widths. See _style_markdown_text(). TextType.HTML: HTML text. Default: TextType.PLAIN |
| text_style | TextStyle | Text style. Options: TextStyle.EDITABLE: Editable text. TextStyle.READ_ONLY: Read only text. TextStyle.READ_ONLY_SELECTABLE: Read only text that is selectable. TextStyle.UNSELECTABLE: Unselectable text. Default: TextStyle.EDITABLE |
| enabled | bool | Whether the text edit widget is enabled. Default: True |
| width | int | Width of the text edit widget in pixels. If None, it expands to fit the layout. Minimum width is 25. Default: None |
| height | int | Height of the text edit widget in pixels. If None, it expands to fit the layout. Minimum height is 28. Default: None |
| tooltip | str | Tooltip text shown on hover. Default: None |
| tooltip_delay | int | Delay in seconds before the tooltip is shown. Default: 3 |
| tooltip_duration | int | Duration in seconds the tooltip remains visible. Default: 5 |
| PROPERTY | TYPE | DESCRIPTION |
| text | str | Get or set text displayed in widget. Text is returned as the same type as the text_type property. To get the text as a plain text string, use the text_str property. |
| text_str | str | Returns text as a plain text string. |
| text_type | TextType | Get or set text type. |
| text_style | TextStyle | Get or set text style. |
| enabled | bool | Get or set whether the widget is enabled. |
| width | int | None | Get or set the widget width. |
| height | int | None | Get or set the widget height. |
| tooltip | str | None | Get or set the tooltip text. |
| tooltip_delay | int | Get or set the tooltip delay in seconds. |
| tooltip_duration | int | Get or set the tooltip duration in seconds. |
| set_focus() Sets focus to the TextEdit. | ||
| paintEvent(event) Draws a thin border, in the same color as the widget's regular text at 25% opacity, around each rendered Markdown code span after the normal paint pass. | ||
| enterEvent(event) No description in the library. | ||
| leaveEvent(event) No description in the library. |
| PARAM | TYPE | DESCRIPTION |
| text | str | Text displayed in widget. Default: '' |
| text_type | TextType | Type of text being input. Options: TextType.PLAIN: Plain text. TextType.MARKDOWN: Markdown text. TextType.HTML: HTML text. Default: TextType.PLAIN |
| text_style | TextStyle | Text style. Options: TextStyle.EDITABLE: Editable text. TextStyle.READ_ONLY: Read only text. TextStyle.UNSELECTABLE: Unselectable text. Default: TextStyle.EDITABLE |
| open_external_links | bool | Whether the text browser opens external links in an external browser. Default: True |
| enabled | bool | Whether the text browser widget is enabled. Default: True |
| width | int | Width of the text browser widget in pixels. If None, it expands to fit the layout. Minimum width is 25. Default: None |
| height | int | Height of the text browser widget in pixels. If None, it expands to fit the layout. Minimum height is 28. Default: None |
| tooltip | str | Tooltip text shown on hover. Default: None |
| tooltip_delay | int | Delay in seconds before the tooltip is shown. Default: 3 |
| tooltip_duration | int | Duration in seconds the tooltip remains visible. Default: 5 |
| PROPERTY | TYPE | DESCRIPTION |
| text | str | Get or set text displayed in widget. Text is returned as the same type as the text_type property. To get the text as a plain text string, use the text_str property. |
| text_str | str | Get text as a plain text string. |
| text_type | TextType | Get or set text type. |
| text_style | TextStyle | Get or set text style. |
| open_external_links | bool | Get or set whether the text browser should open external links in an external browser. |
| enabled | bool | Get or set whether the widget is enabled. |
| width | int | None | Get or set the widget width. |
| height | int | None | Get or set the widget height. |
| tooltip | str | None | Get or set the tooltip text. |
| tooltip_delay | int | Get or set the tooltip delay in seconds. |
| tooltip_duration | int | Get or set the tooltip duration in seconds. |
| enterEvent(event) No description in the library. | ||
| leaveEvent(event) No description in the library. |
| PARAM | TYPE | DESCRIPTION |
| column_names required | list[str] | List of names to be used for column names in tree. |
| sort | bool | Whether to enable sorting in the tree widget. Default: False |
| tree_dict | Dict[str, Dict[str, str]] | Dictionary of items to populate the tree widget. Useful when dealing with folder trees. Default: {} |
| tree_list | List[str] | List of items to populate the tree widget. Useful when dealing with batch group schematic reels shelf reels and desktop reels. Default: [] |
| top_level_item | str | Name of the root item that tree_list items are placed under. Only used together with tree_list. Default: None |
| connect | callable | Function to call when item in tree is clicked on. Default: None |
| update_connect | callable | Function to call when an item is edited, inserted, or deleted. Default: None |
| top_level_editable | bool | Whether the top-level items can be renamed by double-clicking them. When False, top-level items cannot be edited while their child items remain editable. Default: False |
| top_level_selectable | bool | Whether the top-level items can be selected. When False, top-level items cannot be selected and clicking one leaves the current selection unchanged. Default: True |
| allow_children | bool | Whether to allow children in the tree. Default: True |
| min_items | int | Minimum number of items that must remain in the tree. Default: 1 |
| alternating_row_colors | bool | Whether to enable alternating row colors. Default: True |
| top_level_collapsible | bool | Whether top-level items are allowed to be collapsed by the user. When False, top-level items are kept expanded (collapsing one re-expands it). When True, top-level items can be collapsed, allowing them to be used as collapsible category headers. In this mode top-level items are always drawn with a fixed darker-grey background, and their child rows keep alternating row colors. Default: False |
| elide_text | bool | Controls text eliding for item text longer than the column width. When False, long text is elided with '...'. When True, text is not elided. Default: False |
| column_resizable | bool | Whether the user can resize columns by dragging the header dividers. When False, columns are sized to their contents and cannot be dragged. In either case column widths stay put when items are expanded or collapsed - they do not shrink to fit the smaller visible text. Default: False |
| set_column_widths | Dict[str, int] | Dictionary mapping column names to their width in pixels. Only the columns included in the dictionary are given a fixed width; any columns not included keep their default resize-to-contents behavior. If None, no column widths are set. Default: None |
| enabled | bool | Set to True to enable the tree widget. Default: True |
| width | int | PyFlameTreeWidget width. If None, the tree widget expands to fit the maximum width set by the layout. Minimum width is 25. If an integer, the tree widget is given a fixed width. Default: None |
| height | int | PyFlameTreeWidget height. If None, the tree widget expands to fit the maximum height set by the layout. Minimum height is 28. If an integer, the tree widget is given a fixed height. Default: None |
| tooltip | str | PyFlameTreeWidget tooltip text. Default: None |
| tooltip_delay | int | Tooltip delay in seconds. Delay before tooltip is shown. Default: 3 |
| tooltip_duration | int | Tooltip duration in seconds. Duration tooltip is shown. Default: 5 |
| PROPERTY | TYPE | DESCRIPTION |
| column_names | List | A list of all column names in the tree. |
| sort | bool | Whether to enable sorting in the tree widget. |
| tree_dict | Dict[str, Dict] | A nested dictionary representing the tree structure. Useful when dealing with folder trees. |
| tree_list | List[str] | A list of all item names in the tree. Useful when dealing with batch group schematic reels shelf reels and desktop reels. |
| tree_list_no_root | List[str] | A list of all item names in the tree excluding the root item. Useful when dealing with batch group schematic reels shelf reels and desktop reels. |
| connect_callback | Callable | A callback function that is called when an item is clicked. |
| update_connect_callback | Callable | A callback function that is called when an item is updated. |
| top_level_item | str | The top level item of the tree. |
| top_level_editable | bool | Whether the top level item is editable. |
| top_level_selectable | bool | Whether the top level items are selectable. When False, top-level items cannot be selected and clicking one leaves the current selection unchanged. |
| allow_children | bool | Whether children are allowed to be added to the tree. |
| min_items | int | The minimum number of items that must be present in the tree. |
| enabled | bool | Whether the tree widget is currently enabled. |
| width | None | int | Width of tree widget in pixels. |
| height | None | int | Height of tree widget in pixels. |
| tooltip | None | str | Tooltip text shown on hover. |
| tooltip_delay | int | Delay in seconds before the tooltip is shown. |
| tooltip_duration | int | Duration in seconds the tooltip is shown. |
| column_resizable | bool | Whether the user can resize columns by dragging the header dividers. When False (the default) columns are sized to their contents and cannot be dragged. In either case column widths stay put when items are expanded or collapsed - they do not shrink to fit the smaller visible text. |
| set_column_widths | Dict[str, int] | A dictionary mapping column names to their width in pixels. |
| all_item_paths | List[str] | Get the recursive paths of all items in the tree. |
| all_item_paths_no_root | List[str] | Get the recursive paths of all items in the tree excluding the root item. |
| item_path | str | Get the recursive path of the currently selected item. |
| item_paths | List[str] | Get the recursive paths of all selected items. |
| selected_item | str | Get the name of the currently selected item. |
| fill_tree_dict(tree_dict, editable=False) Fill the PyFlameTreeWidget with the provided dictionary. | ||
| fill_tree_list(tree_list) Fill the PyFlameTreeWidget with the provided list. | ||
| add_item(item_name) Add a new item as a child of the currently selected item in the tree, or as a child of the top-level item if no item is selected. | ||
| add_item_with_columns(item, parent=None) Add a new item to a tree with tree column entries. | ||
| delete_item() Delete the selected item in the PyFlameTreeWidget. Does not delete if the item is the top-level item or if the total number of items under the top-level item would drop below the minimum required that is set by the min_items argument. | ||
| sort_items() Sort all items in the tree while maintaining the structure and keeping the tree expanded. | ||
| color_item(item, color) Color item in tree with supplied QColor value. | ||
| set_fixed_column_headers() Set all the column headers of a tree to a fixed length | ||
| clear() Clear all items from the PyFlameTreeWidget. | ||
| update() Update the tree using the update_connect callback. | ||
| selectionCommand(index, event=None) Decide how a click/keypress on index should change the selection. | ||
| drawRow(painter, option, index) Paint a top-level item's fixed background across the full width of its row before the row's contents are drawn. Applies to every top-level item, whether or not the tree is collapsible. | ||
| drawBranches(painter, rect, index) Draw a disclosure triangle in the gutter for any item that has children, so the arrow appears when a child is added and disappears once the last child is removed (the default child-indicator policy reserves the gutter region only while children exist). | ||
| paintEvent(event) Extend the column separator lines into the empty area below the last row. | ||
| enterEvent(event) No description in the library. | ||
| leaveEvent(event) No description in the library. |
| PARAM | TYPE | DESCRIPTION |
| total_tasks | int | Total number of tasks to be processed. Default: 100 |
| processing_task | int | Current task being processed. Default: 0 |
| bar_color | Color | Color of the progress bar. Default: Color.BLUE |
| bar_height | int | Height of the progress bar. Default: 5 |
| parent | QtWidgets.QWidget | Parent widget. Default: None |
| PROPERTY | TYPE | DESCRIPTION |
| total_tasks | int | Total number of tasks to be processed. |
| processing_task | int | Current task being processed. |
| bar_color | Color | Color of the progress bar. |
| bar_height | int | Height of the progress bar. |
| PARAM | TYPE | DESCRIPTION |
| button_group required | list | List of buttons to be part of group. |
| set_exclusive | bool | If True, only one button can be checked at a time. Default: True |
| PROPERTY | TYPE | DESCRIPTION |
| button_group | get / set | Get or set the buttons in the button group. |
| set_exclusive | get / set | Get or set the exclusive state of the button group. |
| PARAM | TYPE | DESCRIPTION |
| color | Color | Color of the line. Uses Color Enum. Color Options: Color.BLACK: Black Color.WHITE: White Color.GRAY: Gray Color.BRIGHT_GRAY: Bright Gray Color.BLUE: Blue Color.RED: Red Default: Color.GRAY |
| width | int | Width of the line in pixels. If None, it expands to fit the layout. Minimum width is 25. Default: None |
| height | int | Height of the line in pixels. If None, defaults to 1. Default: None |
| PROPERTY | TYPE | DESCRIPTION |
| width | int | The width of line. |
| height | int | The height of the line. |
| PARAM | TYPE | DESCRIPTION |
| color | Color | Color of the line. Uses Color Enum. Color Options: Color.BLACK: Black Color.WHITE: White Color.GRAY: Gray Color.BRIGHT_GRAY: Bright Gray Color.BLUE: Blue Color.RED: Red Default: Color.GRAY |
| width | int | Width of the line in pixels. If None, defaults to 1. Default: None |
| height | int | Height of the line in pixels. If None, it expands to fit the layout. Minimum height is 28. Default: None |
| PROPERTY | TYPE | DESCRIPTION |
| width | int | The width of line. |
| height | int | The height of the line. |
| PARAM | TYPE | DESCRIPTION |
| columns | int | Number of columns in the grid. Columns start counting at 0. Default: 0 |
| rows | int | Number of rows in the grid. Rows start counting at 0. Default: 0 |
| column_width | int | Default width of each column in pixels. Default: 150 |
| row_height | int | Default height of each row in pixels. Default: 28 |
| adjust_column_widths | dict[int, int] | A dictionary to adjust the width of specific columns. Keys are column indices (0-based), and values are widths in pixels. Default: {} |
| adjust_row_heights | dict[int, int] | A dictionary to adjust the height of specific rows. Keys are row indices (0-based), and values are heights in pixels. Default: {} |
| PROPERTY | TYPE | DESCRIPTION |
| columns | int | Number of columns in the grid. Columns start counting at 0. |
| rows | int | Number of rows in the grid. Rows start counting at 0. |
| column_width | int | Default width of each column in pixels. |
| row_height | int | Default height of each row in pixels. |
| adjust_column_widths | dict[int, int] | A dictionary to adjust the width of specific columns. Keys are column indices (0-based), and values are widths in pixels. |
| adjust_row_heights | dict[int, int] | A dictionary to adjust the height of specific rows. Keys are row indices (0-based), and values are heights in pixels. |
| setSpacing(spacing) Apply spacing between widgets in PyFlameHBoxLayout adjusted for display scale using pyflame.gui_resize(). | ||
| addSpacing(spacing) Insert fixed amount of non-stretchable space between widgets in the PyFlameHBoxLayout. | ||
| setContentsMargins(left, top, right, bottom) Apply margins to PyFlameHBoxLayout adjusted for display scale using pyflame.gui_resize(). |
| setSpacing(spacing) Apply spacing between widgets in the PyFlameVBoxLayout adjusted for display scale using pyflame.gui_resize(). | ||
| addSpacing(spacing) Insert fixed amount of non-stretchable space between widgets in the PyFlameVBoxLayout. | ||
| setContentsMargins(left, top, right, bottom) Apply margins to the PyFlameVBoxLayout adjusted for display scale using pyflame.gui_resize(). |
| PARAM | TYPE | DESCRIPTION |
| parent required | PyFlameWindow | None | Parent window for the window if any. Set to None if no parent window. Not setting a parent window for any window that should appear over another window will cause window layering problems in linux. |
| title | str | Text displayed in top left corner of window. Default: '' |
| title_style | Style | Style of title text. Use Style Enum to set style. Style Options Style.BACKGROUND: For background style. Style.BACKGROUND_THIN: For background style with thin border. Style.NORMAL: For normal style. Style.UNDERLINE: For underline style. Default: Style.BACKGROUND_THIN |
| title_align | Align | Alignment of title text. Use Align Enum to set alignment. Align Options Align.LEFT: For left alignment. Align.CENTER: For center alignment. Align.RIGHT: For right alignment. Default: Align.LEFT |
| title_underline_color | Color | Color of underline below title text. Only used if title_style is Style.UNDERLINE. Color Options Color.BLUE_TRANS: Blue underline. Color.RED_TRANS: Red underline. Color.GREEN_TRANS: Green underline. Color.YELLOW_TRANS: Yellow underline. Color.TEAL_TRANS: Teal underline. Default: Color.BLUE_TRANS |
| title_height | int | Height of title area. Default: 48 |
| title_font_size | int | Font size of title text. Default: 24 |
| message_bar | bool | Enable message bar at bottom of window. Default: True |
| line_color | Color | Color of bar on left side of window. Color Options Color.GRAY: Gray line. Color.BLUE: Blue line. Color.RED: Red line. Color.GREEN: Green line. Color.YELLOW: Yellow line. Color.TEAL: Teal line. Default: Color.BLUE |
| tab_order | list | List of widgets in the tab order. Must have two or more widgets. Default: None |
| return_pressed | callable | Function to be called when return/enter key is pressed. Default: None |
| escape_pressed | callable | Function to be called when escape key is pressed. Default: None |
| grid_layout_columns | int | Number of columns in grid layout. Only used if grid_layout is True. Default: 4 |
| grid_layout_rows | int | Number of rows in grid layout. Only used if grid_layout is True. Default: 3 |
| grid_layout_column_width | int | Width of columns in grid layout. Only used if grid_layout is True. Default: 150 |
| grid_layout_row_height | int | Height of rows in grid layout. Only used if grid_layout is True. Default: 28 |
| grid_layout_adjust_column_widths | dict | Dictionary of column widths to adjust. Default: {} |
| grid_layout_adjust_row_heights | dict | Dictionary of row heights to adjust. Default: {} |
| window_margins | int | tuple[int, int, int, int] | Margin in pixels around the main content area. Pass a single int to use the same value for left, top, right, and bottom; or pass a tuple of four ints for (left, top, right, bottom). Values are scaled by pyflame.gui_resize(). Default: 15 |
| PROPERTY | TYPE | DESCRIPTION |
| title | str | Get or set the title of the window. |
| title_style | Style | Get or set the style of the title. |
| title_align | Align | Get or set the alignment of the title. |
| title_underline_color | Color | Get or set the color of the underline below the title. |
| title_height | int | Get or set the height of the title. |
| title_font_size | int | Get or set the font size of the title. |
| message_bar_text | str | Get or set text in message bar. |
| line_color | Color | Get or set the color of the line on the left side of the window. |
| tab_order | list | Get or set the list of widgets in the tab order. |
| return_pressed | callable | Get or set the function to be called when the return/enter key is pressed. |
| escape_pressed | callable | Get or set the function to be called when the escape key is pressed. |
| grid_layout_columns | int | Get or set the number of columns in the grid layout. |
| grid_layout_rows | int | Get or set the number of rows in the grid layout. |
| grid_layout_column_width | int | Get or set the width of the columns in the grid layout. |
| grid_layout_row_height | int | Get or set the height of the rows in the grid layout. |
| grid_layout_adjust_column_widths | dict | Get or set the dictionary of column widths to adjust. |
| grid_layout_adjust_row_heights | dict | Get or set the dictionary of row heights to adjust. |
| window_margins | int | tuple[int, int, int, int] | Get or set the margin in pixels around the main content area. Accepts a single int or a tuple of four ints (left, top, right, bottom). Getter always returns a tuple of four ints. |
| center_window() Center the window on the screen. | ||
| print(message) Print message to message bar. | ||
| mousePressEvent(event) Handle mouse press event. | ||
| mouseMoveEvent(event) Handle mouse move event. | ||
| keyPressEvent(event) Handle Return/Enter and Escape key events. | ||
| paintEvent(event) Adds colored line to the left edge of the window. |
| PARAM | TYPE | DESCRIPTION |
| parent required | PyFlameWindow | None | This window's parent window. Set to None if no parent window. |
| message | str | Text displayed in the body of the window. Default: '' |
| buttons | dict[int, dict] | Dictionary defining the window's buttons. Required; at least one button must be provided. Keys are button positions (1-4) and values are dictionaries describing each button. Up to four buttons are supported. Omitting a position leaves that slot empty. Each button dictionary supports: text (str): Text displayed on the button. Required. color (Color, optional): Button color. Must be Color.GRAY, Color.BLUE, or Color.RED. Example buttons={
1: {'text': 'Overwrite', 'color': Color.RED},
3: {'text': 'Skip', 'color': Color.GRAY},
4: {'text': 'Cancel', 'color': Color.GRAY},
} (Default: {1: {'text': 'Ok', 'color': Color.BLUE}}) Default: {1: {'text': 'Ok', 'color': Color.BLUE}} |
| cancel_button | int | Position (1-4) of the button that should be treated as a cancel button. Pressing this button causes the window to evaluate as False. Set to 0 for no cancel button. Default: 0 |
| title | str | Window title. If empty, SCRIPT_NAME is used. Default: '' |
| title_style | Style | Style of title text. Default: Style.BACKGROUND_THIN |
| title_align | Align | None | Alignment of title text. Default: None |
| line_color | Color | None | Color of bar on left side of window. If None, Color.BLUE is used. Default: None |
| message_bar | bool | Enable message bar at bottom of window. Default: False |
| duration | int | Time in seconds to display message in flame message area. Default: 5 |
| PROPERTY | TYPE | DESCRIPTION |
| message | str | Get or set the message text in the window. |
| title | str | Get or set the title of the window. |
| title_style | Style | Get or set the title style of the window. |
| title_align | Align | None | Get or set the title alignment of the window. |
| line_color | Color | None | Get or set the line color of the window. |
| duration | int | Get or set the amount of time to display the message in the Flame message area. |
| selected | str | Get the text of the pressed button. Empty string if the window was closed without a button press. Read-only. |
| confirmed | bool | Get or set the confirmed status of the window. |
| close() Close the option window. |
| PARAM | TYPE | DESCRIPTION |
| parent required | PyFlameWindow | None | This windows parent window. Set to None if no parent window. |
| text | str | Input entry text. Default: '' |
| label_text | str | Text displayed above input entry field. Default: 'Enter New Value' |
| title | str | Custom title for the dialog window. Default: 'User Input' |
| title_style | Style | The style of the title text using the Style Enum. Default: Style.BACKGROUND_THIN |
| title_align | Align | The alignment of the title text using the Align Enum. Default: None |
| line_color | Color | The color of the line using the Color Enum. Default: Color.BLUE |
| message_bar | bool | Enable message bar at bottom of window. Default: False |
| PROPERTY | TYPE | DESCRIPTION |
| text | str | Get or set input entry text. |
| message_bar_text | str | Get or set text in message bar. 'label_text` (str): Get or set entry label text. Displayed above entry. (Default: "Enter New Value") |
| title | str | Get or set window title. |
| title_style | Style | Get or set style applied to window title. |
| line_color | Color | Get or set window line color. |
| PARAM | TYPE | DESCRIPTION |
| parent required | PyFlameWindow | None | This windows parent window. Set to None if no parent window. |
| message | str | Text displayed in the body of the window. Default: '' |
| message_type | MessageType | Type of message window to be shown. Message types set defaults for title, title_style, title_align, and line_color. All of these can be overridden by providing values for the respective keyword arguments. Message Types MessageType.INFO Title: SCRIPT_NAME Window lines: Blue Buttons: Ok MessageType.OPERATION_COMPLETE Title: SCRIPT_NAME: Operation Complete Window lines: Blue Buttons: Ok MessageType.CONFIRM Title: SCRIPT_NAME: Confirm Operation Window lines: Grey Buttons: Confirm, Cancel Returns bool value. MessageType.ERROR Title: SCRIPT_NAME: Error Window lines: Yellow Buttons: Ok MessageType.WARNING Title: SCRIPT_NAME: Warning Window lines: Red Buttons: Confirm, Cancel Returns bool value. Default: MessageType.INFO |
| title | str | Use to override default title for message_type. Providing a value will override the default title for the message_type. Default: '' |
| title_style | Style | Style of title text. Alignment of text from title_style can be overridden by providing title_align value. Style Options Style.NORMAL: Plain text, left aligned. Style.UNDERLINE: Underlined text, centered. Style.BORDER: Border text, centered. Style.BACKGROUND: Text background is darker, left aligned. Style.BACKGROUND_THIN: Text background is darker, left aligned, thin font. Default: Style.BACKGROUND_THIN |
| title_align | Align | Alignment of title text. Providing a value will override the default alignment for the title_style. Align Options Align.LEFT: Left aligned. Align.CENTER: Centered. Align.RIGHT: Right aligned. Default: None |
| line_color | WindowBarColor | Color of bar on left side of window. Providing a value will override the default color for the message_type. Color Options Color.GRAY: Gray line. Color.BLUE: Blue line. Color.RED: Red line. Color.GREEN: Green line. Color.YELLOW: Yellow line. Color.TEAL: Teal line. Default: None |
| message_bar | bool | Enable message bar at bottom of window. Default: False |
| duration | int | Time in seconds to display message in flame message area. Default: 5 |
| PROPERTY | TYPE | DESCRIPTION |
| message | str | Get or set the message text in the window. |
| message_type | MessageType | Get or set the type of message using the MessageType Enum. |
| title | str | Get or set the title of the progress window. |
| title_style | Style | Get or set the title style of the progress window. |
| title_align | Align | Get or set the title alignment of the progress window. |
| line_color | Color | Get or set the line color of the progress window. |
| message_bar_text | str | Get or set text in message bar. |
| duration | int | Get or set the amount of time to display the message in the Flame message area. |
| confirmed | bool | Get or set the confirmed status of the message. |
| cancel() Cancel the message. | ||
| confirm() Confirm the message. | ||
| close() Close the message window. |
| PARAM | TYPE | DESCRIPTION |
| parent required | PyFlameWindow | None | This windows parent window. Set to None if no parent window. |
| text | str | The text to be displayed in the window. The default text of either 'Enter system password' or 'Enter username and password' will be used based on user_name_prompt argument. Default: 'Enter System Password' |
| user_name_prompt | bool | If set to True, the window will prompt for both username and password. Default: False |
| title | str | The title text shown in the top left of the window. The default title of either 'Enter Password' or 'Enter Username and Password' will be used based on user_name_prompt argument. Default: 'Enter System Password' |
| title_style | Style | The style of the title text. Default: Style.BACKGROUND_THIN |
| title_align | Align | The alignment of the title text. Use to override the default alignment set by title_style. Default: None |
| line_color | Color | The color of the line on the side of the window. Use to override the default line color(Color.BLUE). Default: None |
| message_bar | bool | Enable message bar at bottom of window. Default: False |
| PROPERTY | TYPE | DESCRIPTION |
| text | str | Get or set the text of the password window. |
| title | str | Get or set the title of the password window. |
| user_name_prompt | bool | Get or set the user name prompt of the password window. |
| title_style | Style | Get or set the title style of the password window. |
| title_align | Align | Get or set the title alignment of the password window. |
| line_color | Color | Get or set the line color of the password window. |
| message_bar_text | str | Get or set text in message bar. |
| password | str | Get or set the password of the password window. |
| username | str | Get or set the username of the password window. |
| PARAM | TYPE | DESCRIPTION |
| parent required | PyFlameWindow | None | This windows parent window. Set to None if no parent window. |
| task | str | Name of task to be displayed in progress window. Default: 'Processing' |
| total_tasks | int | Total number of operations to be completed. Default: 100 |
| task_progress_message | str | No description in the library. Default: f'{{task}}: [{{processing_task}} of {{total_tasks}}] ({{progress:.1f}}%)' |
| title | str | text shown in top left of window ie. Rendering... Default: 'Processing...' |
| title_style | Style | Style of title text. Style Options Style.NORMAL: Plain text, left aligned. Style.UNDERLINE: Underlined text, centered. Style.BORDER: Border text, centered. Style.BACKGROUND: Text background is darker, left aligned. Style.BACKGROUND_THIN: Text background is darker, left aligned, thin font. Default: Style.BACKGROUND_THIN |
| title_align | Align | Alignment of title text. If not provided, Align.LEFT will be used. Align Options Align.LEFT: Left aligned. Align.CENTER: Centered. Align.RIGHT: Right aligned. Default: None |
| line_color | WindowBarColor | Color of bar on left side of window. Color Options Color.GRAY: Gray line. Color.BLUE: Blue line. Color.RED: Red line. Color.GREEN: Green line. Color.YELLOW: Yellow line. Color.TEAL: Teal line. Default: Color.BLUE |
| message_bar | bool | Enable message bar at bottom of window. Default: False |
| PROPERTY | TYPE | DESCRIPTION |
| text | str | Get or set the text in the progress window. (Used to print progress to terminal) |
| task | str | Get or set the task of the progress window. |
| total_tasks | int | Get or set the total number of tasks to be completed. |
| current_task | int | Get or set the number of the current task being processed. Updating this value will update the progress bar and the text in the progress window. |
| title | str | Get or set the title of the progress window. |
| title_style | Style | Get or set the title style of the progress window. |
| title_align | Align | Get or set the title alignment of the progress window. |
| line_color | Color | Get or set the line color of the progress window. |
| message_bar_text | str | Get or set text in message bar. |
| enable_done_button() No description in the library. | ||
| close() Close the Progress Window. text_append Append text to the current message in the progress window. Message starts on a new line. tasks_completed Set progress window to completed state. Sets progress bar to 100%, updates progress text with completed values, and optionally updates title, appends text, and enables the Done button. | ||
| text_append(message) Append text to the current text in the progress window. | ||
| tasks_completed(done_button_enabled=True, task_progress_message=None, title=None, text_append=None) Set progress window to a completed state and Enable the Done button |
| PARAM | TYPE | DESCRIPTION |
| parent_widget required | QtWidgets.QWidget | Parent widget to display tooltip. |
| text | str | Text to display in tooltip. Default: '' |
| delay | int | Delay in seconds before tooltip is displayed. Default: 3 |
| duration | int | Duration in seconds tooltip is displayed. Default: 5 |
| PROPERTY | TYPE | DESCRIPTION |
| widget | QtWidgets.QWidget | Get or set parent widget. |
| text | str | Get or set tooltip text. |
| delay | int | Get or set tooltip delay in seconds. |
| duration | int | Get or set tooltip duration in seconds. |
| enter_event() Show tooltip when mouse enters widget. | ||
| leave_event() Hide tooltip when mouse leaves widget. |
| PARAM | TYPE | DESCRIPTION |
| config_values required | Dict[str, Any] | Dictionary of default config key-value pairs. Must contain at least one key. |
| config_path | str | Path to the config json file. Default: os.path.join(SCRIPT_PATH, 'config/config.json') |
| script_name | str | Script name to persist in config. Default: SCRIPT_NAME |
| print_config(action) No description in the library. | ||
| load_config() Load config from disk and hydrate attributes. | ||
| save_config(config_values=None, config_path=None) Save updated config values to disk. get(key: str, default: Any=None) -> Any: Return raw value from config dictionary. get_str(key: str, default: str='') -> str: Return value as string. get_int(key: str, default: int=0) -> int: Return value as integer. get_float(key: str, default: float=0.0) -> float: Return value as float. get_bool(key: str, default: bool=False) -> bool: Return value as boolean. get_config_values(config_path: str) -> Dict[str, Any]: Static helper to load and return config values from a path. | ||
| get(key, default=None) Get raw config value by key. | ||
| get_str(key, default='') Get config value as string. | ||
| get_int(key, default=0) Get config value as int. | ||
| get_float(key, default=0.0) Get config value as float. | ||
| get_bool(key, default=False) Get config value as bool. | ||
| get_config_values(config_path) Load and return config values from a json file path. |
All utility functions are accessed through the pyflame object after importing the library.
Click any function to see its description, arguments, and usage examples.
| ARG | TYPE | DESCRIPTION |
| folder_name | str | Name of the temporary folder to clear. Temp folder is added to <SCRIPT_PATH>/<folder_name>. Default: 'temp' |
| ARG | TYPE | DESCRIPTION |
| export_preset_name required | str | Export preset name to convert to path. Example 'Shared: File Sequence: Jpeg (8-bit)' |
| TypeError | If 'export_preset_name' is not a string. | |
| ARG | TYPE | DESCRIPTION |
| value required | str | int | Text or integer to copy to clipboard. |
| TypeError | If value is not a string or integer. | |
| ARG | TYPE | DESCRIPTION |
| shot_name required | str | Name of shot |
| pyobject required | flame.PyClip | flame.PyBatch | flame.PyDesktop | PyClip, PyBatch, or PyDesktop to copy to shot folder. |
| search_location required | flame.PyLibrary | flame.PyFolder | Media Panel Library or Folder to search through for shot folder. |
| dest_folder_path required | str | Destination folder path in Shot Folder. Example 'Shot_Folder/Plates' |
| expand_dest_folder | bool | Expands the destination folder after copy is complete. Default: True |
| ARG | TYPE | DESCRIPTION |
| folder_name required | str | Name of the main folder to create. |
| folder_structure required | dict | Dictionary representing the folder structure to create. |
| dest_path required | str | Path where folders will be created. |
| skip_existing | bool | Skip creating folders if they already exist. Default: False |
| TypeError | If folder_name is not a string. If folder_structure is not a dictionary. If dest_path is not a string. If skip_existing is not a boolean. | |
| ARG | TYPE | DESCRIPTION |
| folder_list required | list[str] | List of folder names to create. |
| folder_structure required | dict | Dictionary representing the folder structure to create. |
| dest_path required | str | Path where folders will be created. |
| TypeError | If folder_list is not a list. If folder_structure is not a dictionary. If dest_path is not a string. | |
| ARG | TYPE | DESCRIPTION |
| folder_name required | str | Name of the main folder to create in the media panel. |
| folder_structure required | dict | A dictionary representing the folder structure to be created. |
| dest required | Folder | The destination folder/library in the Media Panel where the main folder will be created. |
| shot_name_tag | str | Use to add ShotName tag to folder with matching name. If shot_name_tag is PYT_0010 any folder named PYT_0010 will be tagged with 'ShotName: PYT_0010'. Default: '' |
| TypeError | If folder_name is not a string. If folder_structure is not a dictionary. If dest is not a flame.PyFolder or flame.PyLibrary. If shot_name_tag is not a string. | |
| ARG | TYPE | DESCRIPTION |
| folder_list required | list[str] | List of folder names to create. |
| folder_structure required | dict | Dictionary representing the folder structure to create. |
| dest required | Folder | The destination folder/library in the Media Panel where the folders will be created. |
| TypeError | If folder_list is not a list. If folder_structure is not a dictionary. If dest is not a flame.PyFolder or flame.PyLibrary. | |
| ARG | TYPE | DESCRIPTION |
| library_structure required | dict | A dictionary representing the library/folder structure to be created. 'Workspace' should always be the top level key. |
| TypeError | If library_structure is not a dictionary. | |
| ValueError | If 'Workspace' is not the only top-level key in library_structure. | |
| ARG | TYPE | DESCRIPTION |
| folder_name | str | Name of the temporary folder to create. Default: 'temp' |
| TypeError | If folder_name is not a string. | |
| ARG | TYPE | DESCRIPTION |
| path | str | Open file browser to this path. Default: '/opt/Autodesk' |
| title | str | File browser window title. If None, the title will be set to 'Select Directory' or 'Select File' based on the extension and select_directory arguments. Default: None |
| extension | str | list | File extension filter. None to list directories. Can be a single extension or a list of extensions. Default: None |
| select_directory | bool | Ability to select directories. Default: False |
| multi_selection | bool | Ability to select multiple files/folders. Default: False |
| include_resolution | bool | Enable resolution controls in flame browser. Default: False |
| use_flame_browser | bool | Use Flame's file browser. If False, QT file browser will be used. Default: True |
| window_to_hide | QtWidgets.QWidget | list[QtWidgets.QWidget] | Hide Qt window while Flame file browser window is open. Window is restored when browser is closed. Can be a single window or a list of windows. Default: None |
| ARG | TYPE | DESCRIPTION |
| pyobject required | flame.PyLibrary, flame.PyDesktop, or flame.PyFolder | Flame PyObject (Library, Desktop, or Folder) that will be searched for item with target tag. |
| target_tag required | str | Tag to search for. If contains ':', will match against tag_type:value format. |
| sorted | bool | If True, assumes PyObjects contained within pyobject are sorted by tag. When True, performs a binary search. If False, performs a linear search. Default: True |
| ARG | TYPE | DESCRIPTION |
| value required | int | Value to be scaled. |
| ARG | TYPE | DESCRIPTION |
| value required | str | Value to check for uniqueness. |
| existing_names required | list[str] | List of already existing names against which the new name will be checked for uniqueness. |
| TypeError | If value is not a string. If existing_names is not a list. If any element in existing_names is not a string. | |
| ARG | TYPE | DESCRIPTION |
| node_names required | list[str] | List of node names that need to be checked and possibly modified to ensure uniqueness. |
| existing_node_names required | list[str] | List of already existing node names against which the new node names will be checked for uniqueness. |
| TypeError | If node_names is not a list. If existing_node_names is not a list. | |
| ValueError | If any element in node_names is not a string. If any element in existing_node_names is not a string. | |
| ARG | TYPE | DESCRIPTION |
| preset_path required | str | Path of preset to check/update. |
| ARG | TYPE | DESCRIPTION |
| print_path | bool | Print path to terminal. Default: True |
| FileNotFoundError | If no python3.* folder is found in the python lib path. | |
| ARG | TYPE | DESCRIPTION |
| shot_name required | str | Name of shot |
| pyobject required | flame.PyClip | flame.PyBatch | flame.PyDesktop | PyClip, PyBatch, or PyDesktop to move to shot folder. |
| search_location required | flame.PyLibrary | flame.PyFolder | Media Panel Library or Folder to search through for shot folder. |
| dest_folder_path required | str | Destination folder path in Shot Folder. Example 'Shot_Folder/Plates' |
| ARG | TYPE | DESCRIPTION |
| value required | int | Value to be scaled. |
| ARG | TYPE | DESCRIPTION |
| existing_names required | list of str | A list of existing names. |
| new_name required | str | The base name to be made unique. |
| ARG | TYPE | DESCRIPTION |
| shot_name required | str | Name of shot |
| pyobject required | flame.PyClip | flame.PyBatch | flame.PyDesktop | PyClip, PyBatch, or PyDesktop to move to shot folder. |
| search_location required | flame.PyLibrary | flame.PyFolder | Media Panel Library or Folder to search through for shot folder. |
| dest_folder_path required | str | Destination folder path in Shot Folder. Example 'Shot_Folder/Plates' |
| expand_dest_folder | bool | Expands the destination folder after move is complete. Default: True |
| ARG | TYPE | DESCRIPTION |
| path required | str | Path to open in Finder. |
| ARG | TYPE | DESCRIPTION |
| seconds | int|float | Time in seconds to pause the UI. Default: 0.01 |
| ARG | TYPE | DESCRIPTION |
| text required | str | Text to print. |
| indent | int | Indent text in terminal by the specified amount of spaces. Default: 0 |
| print_type | PrintType | See print types below. Default: PrintType.INFO |
| new_line | bool | Print a new line after text. Default: True |
| arrow | bool | Add an arrow --> to the start of the text. Also sets text color to green. Default: False |
| underline | bool | Add an underline to the text. A line of dashes will be printed below the text. Default: False |
| double_underline | bool | Add a double underline to the text. Equals sign will be printed below the text. Default: False |
| text_color | TextColor | Text color to print text in terminal. Overrides print_type color. See text colors below. Default: None |
| time | int | Amount of time to display text in Flame for in seconds. Default: 3 |
| print_to_flame | bool | Print message to Flame message area. Default: True |
| script_name | str | Name of script. This is displayed in the Flame message area. Default: SCRIPT_NAME |
| TypeError | If text is not a string. If indent is not an integer. If new_line, arrow, underline, or double_underline is not a boolean. If time is not an integer. If script_name is not a string. If text_color is not a TextColor. | |
| ValueError | If type is not a valid PrintType. | |
| ARG | TYPE | DESCRIPTION |
| dict_data required | dict | Dictionary to print. |
| indent | int | Indentation level. Default: 0 |
| TypeError | If dict_data is not a dictionary. If indent is not an integer. | |
| ARG | TYPE | DESCRIPTION |
| json_data required | dict | list | str | int | bool | JSON data to print. |
| indent | int | Indentation level. Default: 0 |
| TypeError | If indent is not an integer. | |
| ARG | TYPE | DESCRIPTION |
| list_name required | str | Name of the list. |
| list_items required | list | List of items to print. |
| indent | int | Indent message in terminal by specified amount of spaces. Default: 0 |
| time | int | Amount of time to display message in Flame for in seconds. Default: 3 |
| script_name | str | Name of script. This is displayed in the Flame message area. Default: SCRIPT_NAME |
| TypeError | If list_name is not a string. If list_items is not a list. If any item in list_items is not a string. If indent is not an integer. If time is not an integer. If script_name is not a string. | |
| ValueError | If list_items is not a list of strings. | |
| ARG | TYPE | DESCRIPTION |
| text required | str | The full banner line, e.g., 'Cool Script v1.0.0' |
| ARG | TYPE | DESCRIPTION |
| package required | str|list[str] | The name(s) of the python package(s) to check/install. Should match the file name prefix of the compressed package. |
| ARG | TYPE | DESCRIPTION |
| source_name | str | Name of the class or function that raised the error. Default: None |
| arg_name | str | Name of the argument that caused the error. Default: None |
| expected_type | str | Expected type of the argument. Default: None |
| actual_value | Any | Actual value of the argument. Default: None |
| error_message | str | Error message to print. Default: None |
| time | int | Time to display the error message. Default: 10 |
| ARG | TYPE | DESCRIPTION |
| source_name | str | Name of the class or function that raised the error. Default: None |
| arg_name | str | Name of the argument that caused the error. Default: None |
| expected_value | Any | Expected value of the argument. Default: None |
| actual_value | Any | Actual value of the argument. Default: None |
| error_message | str | Error message to print. Default: None |
| time | int | Time to display the error message. Default: 10 |
| ARG | TYPE | DESCRIPTION |
| script_name | str | Name of script. This is displayed in the Flame message area. Default: SCRIPT_NAME |
| TypeError | If script_name is not a string. | |
| ARG | TYPE | DESCRIPTION |
| name required | str | The name to be resolved into a shot name. |
| TypeError | If name is not a string. | |
| ARG | TYPE | DESCRIPTION |
| tokenized_string required | str | String with tokens to be translated. |
| flame_pyobject | flame.PyClip | Flame PyClip/PySegment/PyBatch Object. Default: None |
| date | datetime | Date/time to use for token translation. If None is passed datetime value will be gotten each time function is run. Default: None |
| shot_name_tag | str | No description in the library. Default: 'ShotName' |
| TypeError | If tokenized_string is not a string. | |
| ARG | TYPE | DESCRIPTION |
| pyobject required | flame.PyObject | Flame object to set tagging for. Can be PyLibrary, PyFolder, PyDesktop, PyBatch, or PyClip. |
| shot_name required | str | Shot name to set as tag. |
| append | bool | Append shot name tag to existing tags. Default: False |
| shot_name_tag | str | No description in the library. Default: 'ShotName' |
| TypeError | If 'pyobject' is not a PyLibrary, PyFolder, PyDesktop, PyBatch, or PyClip. If 'shot_name' is not a string. If 'append' is not a boolean. | |
| ARG | TYPE | DESCRIPTION |
| batch_group required | flame.PyBatch | Batch group to get shot name from |
| shot_name_tag | str | No description in the library. Default: 'ShotName' |
| ARG | TYPE | DESCRIPTION |
| clip required | flame.PyClip | Clip to get shot name from |
| shot_name_tag | str | No description in the library. Default: 'ShotName' |
| ARG | TYPE | DESCRIPTION |
| tar_file_path required | str | Path to tar file to untar including filename.tgz/tar. |
| untar_path required | str | Untar destination path. |
| sudo_password | bool | Password for sudo. Default: None |
| ARG | TYPE | DESCRIPTION |
| preset_path required | str | Path of preset to check/update. |
| ARG | TYPE | DESCRIPTION |
| additional_files | list | List of additional files to check for in the script folder. These are other files that are required for the script to work. This should only be a list of file names, not full paths. If file is in a subfolder of the script folder, it should include the subfolder name. For example, if the script folder is named 'srt_to_xml' and the file 'xml_template.xml' is in the 'templates' subfolder, the file name should be 'templates/xml_template.xml'. Default: [] |
| TypeError | If additional_files is not a list. | |