artellapipe.core.project module

Module that contains basic implementation for Artella Projects

class artellapipe.core.project.ArtellaProject(settings=None)

Bases: object

ASSETS_VIEWER_CLASS

alias of artellapipe.core.assetsviewer.AssetsViewer

ASSET_CLASS

alias of artellapipe.core.asset.ArtellaAsset

ASSET_NODE_CLASS

alias of artellapipe.core.node.ArtellaAssetNode

class DataExtensions

Bases: object

class DataVersions

Bases: object

SHOT = '0.0.1'

PROJECT_RESOURCE = None

SEQUENCE_CLASS

alias of artellapipe.core.sequence.ArtellaSequence

SHELF_CLASS

SHOT_CLASS

alias of artellapipe.core.shot.ArtellaShot

SYNC_FILES_DIALOG_CLASS

alias of artellapipe.core.syncdialog.ArtellaSyncFileDialog

SYNC_PATHS_DIALOG_CLASS

alias of artellapipe.core.syncdialog.ArtellaSyncPathDialog

TAG_NODE_CLASS

alias of artellapipe.core.asset.ArtellaTagNode

TRAY_CLASS

alias of artellapipe.gui.tray.ArtellaTray

property asset_files

Returns the list of asset files being used by the Artella project :return: list(str)

property asset_must_files

Returns the list of asset files that an asset need to have published to consider the asset ready for production :return: list(str)

property asset_types

Returns the list of asset types being used by the Artella project :return: list(str)

property assets_library_file_types

Returns file types supported by assets library :return: dict

check_lock_status(file_path=None, show_message=False)

Returns the current lock status of the file in Artella :param file_path: stro :param show_message: bool :return: bool

check_template_validity(template_name, path_to_check)

Returns whether given path matches given pattern or not :param template_name: str :param path_to_check: str :return: bool

create_asset(asset_data, category=None)

Returns a new asset with the given data :param asset_data: dict :param category: str

create_asset_in_artella(asset_name, asset_path, folders_to_create=None)

Creates a new asset in Artella :param asset_name: str :param asset_path: str :param folders_to_create: list(str) or None

create_logger()

Creates and initializes Artella project logger

create_menu()

Creates Artella Project menu

create_shelf()

Creates Artella Project shelf

create_tray()

Creates Artella Project tray

property emails

Returns list of emails that will be used when sending an email :return: list(str)

find_all_assets(asset_name=None, asset_path=None)

Returns a list of all assets in the project :param asset_name: str, If given, a list with the given item will be returned instead :param asset_path: str, If given, asset will be found in given path :return: variant, ArtellaAsset or list(ArtellaAsset)

find_asset(asset_name=None, asset_path=None, allow_multiple_instances=True)

Returns asset of the project if found :param asset_name: str, name of the asset to find :param asset_path: str, path where asset is located in disk :param allow_multiple_instances: bool, whether to return None if multiple instances of an asset is found; otherwise first asset in the list will be return :return: Asset or None

fix_path(path_to_fix)

Converts path to a path relative to project environment variable :param path_to_fix: str :return: str

format_template(template_name, template_tokens)

Returns template path filled with tempalte tokens data :param template_name: str :param template_tokens: dict :return: str

property full_id

Returns full ID of the project :return: str

get_alembics(as_asset_nodes=True, only_roots=True)

Returns all alembic nodes in the scene :param as_asset_nodes: bool, Whether to return nodes as ArtellaAssetNodes :param only_roots: bool :return: list

get_artella_assets_url()

Returns URL of the Artella Assets of the project are located :return: str

get_artella_url()

Returns Artella URL of the project :return: str

get_asset_data_file_path(asset_path)

Returns asset data file path of given asset :param asset_path: str :return: str

get_asset_file(file_type, extension=None)

Returns asset file object class linked to given file type for current project :param file_type: str :param extension: str :return: ArtellaAssetType

get_asset_from_path(asset_path)

Returns asset from the given path :param asset_path: str :return: ArtellaAsset

get_assets_path()

Returns path where project assets are located :return: str

get_cameras()

Returns all cameras in the scene :return: list(str)

get_changelog_path()

Returns path where default Artella project changelog is located :return: str

get_clean_name()

Returns a cleaned version of the project name (without spaces and in lowercase) :return: str

get_config_data()

Returns the config data of the project :return: dict

get_config_path()

Returns path where default Artella project config is located :return: str

get_configurations_folder()

Returns folder where project configuration files are loaded :return: str

get_data_path()

Returns path where user data for Artella project should be located This path is mainly located to store tools configuration files and log files :return: str

get_folders_to_register(full_path=True)

Returns folders to register paths :param full_path: bool, Whether to return full path of the folder or not :return: list(str)

get_light_rigs_path()

Returns path where light rigs are located in the project :return: str

get_menu_path()

Returns path where default Artella shelf file is located :return: str

get_naming_path()

Returns path where default Artella naming configuration is located :return: str

get_path(force_update=False)

Returns path where project is located :param force_update: bool, Whether to force the update of project path is environment variables are not setup :return: str

get_playblast_presets_folder()

Returns path where Playblas Presets are loated :return: str

get_production_path()

Returns path where Production data for current project is stored :return: str

get_progress_bar()

Creates and returns a new instance of project Progress bar :return: QProgressBar

get_project_path()

Returns path where default Artella project is located :return: str

get_publisher_plugin_paths()

Function that registers all plugins available for Artella Publisher

get_scene_assets(as_nodes=True, allowed_types=None)

Returns a list with all nodes in the current scene :return: list

get_sequences(force_update=False)

Returns a list of current sequences in Artella :param force_update: bool :return: list(ArtellaSequence)

get_settings_file()

Returns file path of the window settings file :return: str

get_shaders_path()

Returns path where shareds are located in the project :return: str

get_shelf_path()

Returns path where default Artella shelf file is located :return: str

get_shot_name_regex()

Returns regex used to identeify shots :return: str

get_shots(force_update=False)

Returns all shots of the given sequence name :param force_update: bool :return: list(ArtellaShot)

get_shots_from_sequence(sequence_name, force_update=False)

Returns shots of the given sequence name :param sequence_name: str :param force_update: bool :return:

get_tag_info_nodes(as_tag_nodes=False)

Returns all nodes containing tag info data :return: list

get_temp_path(*args)

Returns temporary folder path of the project :return: str

get_templates()

Returns a list with all available templates :return: list(str)

get_version()

Returns the current version of the tools :return: str

get_version_path()

Returns path where version file is located :return: str

property icon

Returns the icon used by the Artella project :return: QIcon

property icon_name

Returns the name of the icon by Artella project :return: str

property id

Returns ID of the project :return: str

property id_number

Returns ID number of the project :return: str

property id_path

Returns ID path of this Artella project :return: str

init(force_skip_hello=False)

This function initializes Artella project :param force_skip_hello: bool, Whether the hello window should be showed or not

init_config()

Function that reads project configuration file and initializes project variables properly This function can be extended in new projects

init_settings()

Function that initializes project settings file

is_valid_asset_file_type(file_type)

Returns whether the current file type is valid or not for current project :param file_type: str :return: bool

is_valid_assets_path()

Returns whether current asset path exists or not :return: bool

lock_file(file_path=None, notify=False)

Locks given file in Artella :param file_path: str :param notify: bool :return: bool

property logger

Returns the logger used by the Artella project :return: Logger

message(msg, title=None)

Shows tray given message in OS tray. If tray is not available, the message will be output in the debug logger :param msg: str, message to show :param title: str, title to show; if None, the project name will be used :return:

property name

Returns the name of the Artella project :return: str

property namemanager

Returns name manager widget used to manage nomenclature in the project :return: NameWidget

open_artella_project_url()

Opens Artella Project web page in browser

open_folder()

Opens folder where Artella project is located in user computer

open_in_artella()

Opens project Artella web page in user web browser

property outliner_categories

Returns a dictionary that maps tag types with outliner categories :return: dict

parse_template(template_name, path_to_parse)

Parses given path in the given template :param template_name: str :param path_to_parse: str :return: list(str)

property playblast_presets_url

Returns the URL where playblast presets are located :return: str

property progress_bar_color_0

Returns color 0 used in progress bar color gradient :return: str

property progress_bar_color_1

Returns color 1 used in progress bar color gradient :return: str

property project_environment_variable

Returns name used to store path to the current project :return: str

property project_url

Returns URL to official Plot Twist web page :return: str

property publish_status

Returns the name of the publish status :return: str

register_asset_class(asset_class)

Registers a new asset class into the project :param asset_class: cls

register_asset_file_type(asset_file_type_class)

Registers a new asset file type class into the project :param asset_file_type_class: cls

relative_path(full_path)

Returns relative path of the given path relative to Project path :param full_path: str :return: str

resolve_path(path_to_resolve)

Converts path to a valid full path :param path_to_resolve: str :return: str

property resource

Returns the class used by the project to load resources (icons, images, fonts, etc) :return: Resource

save_scene(notify=False)

Saves current scene and cleans invalid data :param notify: bool

send_email(title=None)

Opens email application with proper info

set_environment_variables()

Initializes environment variables needed by the Artella Project This function is called during project initialization and can be extended in new projects :return:

property settings

Returns the settings of the project :return: ArtellaProjectSettings

property shaders_extension

Returns extension usded by shaders files :return: str

property shot_extension

Returns extesnsion used to stored shot files :return: str

property shot_file_types

Returns of shot files supported by the project :return: list(str)

solve_name(rule_name, *args, **kwargs)

Resolves name with given rule and attributes :param rule_name: str :param args: list :param kwargs: dict

sync_files(files)

Creates an return a new instance of the Artella files sync dialog :param files: list(str)

sync_paths(paths)

Creates an return a new instance of the Artella paths sync dialog :param paths: list(str)

property tag_type_id

Returns tag name used to identify assets for the current project :return: str

property tag_types

Returns the list of types that can be used to categorize all the elements of the project :return: list(str)

property tray

Returns the tray used by the Artella project :return: Tray

property tray_icon

Retrusn the tray icon used by Artella project tray :return: QIcon

property tray_icon_name

Returns the name of the icon used by Artella project tray :return: str

unlock_file(file_path=None, notify=False, warn_user=True)

Unlocks current file in Artella :param file_path: str :param notify: bool :param warn_user: bool :return: bool

update_paths()

Updates system path with custom paths needed by Artella project This function is called during project initialization and can be extended in new projects

update_project()

Sets the current Maya project to the path where Artella project is located inside Artella folder

update_shaders()

Updates shaders from Artella

upload_working_version(file_path=None, skip_saving=False, notify=False, comment=None, force=False)

Uploads a new working version of the given file :param file_path: str :param skip_saving: bool :param notify: bool :param comment: str :param force: bool :return: bool

property working_status

Returns the name of the working status :return: str

class artellapipe.core.project.ArtellaProjectSettings(project, filename, max_files=10)

Bases: PySide2.QtCore.QSettings, object

get(setting_name, default_value=None)

Returns the setting stored with the given name :param setting_name: str :param default_value: variant :return:

has_setting(setting_name)

Returns whether given settings name is currently stored in the settings or not :param setting_name: str :return: bool

set(setting_name, setting_value)

Stores a new settings with the given name and the given value If the given setting already exists, it will be overwrite :param setting_name: str, setting name we want store :param setting_value: variant, setting value we want to store

staticMetaObject = <PySide2.QtCore.QMetaObject object>