cgl.core.utils package

Submodules

cgl.core.utils.amc_batch_extract_wav module

cgl.core.utils.amc_batch_extract_wav.amc_batch_extract_wav(root_path)

cgl.core.utils.amc_batch_extract_wav.find_msd(dir_path)

cgl.core.utils.amc_batch_extract_wav.update_msd_json(wav_file_path)

cgl.core.utils.batch_folder_renamer module

cgl.core.utils.build module

cgl.core.utils.folder_renamer module

CLI for renaming folders

cgl.core.utils.folder_renamer.remove_sequence_from_folder(folder_path)

cgl.core.utils.folder_renamer.rename_folder_with_sequence(folder_path, sequence_name)

cgl.core.utils.folder_renamer.rename_folders(folder_path)

cgl.core.utils.general module

exception cgl.core.utils.general.CglExecuteError(message, command=None, returncode=None, stdout=None, stderr=None)

Bases: RuntimeError

Raised when cgl_execute is misused or the child process fails.

class cgl.core.utils.general.DateTimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)

Bases: JSONEncoder

default(obj)

Implement this method in a subclass such that it returns a serializable object for o, or calls the base implementation (to raise a TypeError).

For example, to support arbitrary iterators, you could implement default like this:

def default(self, o):
    try:
        iterable = iter(o)
    except TypeError:
        pass
    else:
        return list(iterable)
    # Let the base class default method raise the TypeError
    return JSONEncoder.default(self, o)

class cgl.core.utils.general.Logger(name=None, log_file=None, log_level=10)

Bases: object

set_log_level(level)

The function sets the log level of a logger object.

Parameters:

level – The “level” parameter is used to set the logging level for the logger object. The

logging level determines the severity of the messages that will be logged. The available logging levels are:

DEBUG, INFO, WARN, ERROR

cgl.core.utils.general.app_name(str_=None, human=False)

return the name of the application used in settings files :param str_: the name to map from defaults sys.argv[0] :param human: a human-readable string

Returns:

name of application

Return type:

str

cgl.core.utils.general.apply_theme(app, theme_name='alchemy_theme.qss', dev_mode=False)

cgl.core.utils.general.atomic_replace(tmp: Path, target: Path, retries=5)

cgl.core.utils.general.cgl_clean_dir(dir_path)

Removes everything in a directory, including recursively removing all the contents of any subdirectories. :param dir_path:

Returns:

cgl.core.utils.general.cgl_copy(source, destination, methodology: str = 'local', verbose: bool = False, dest_is_folder: bool = False, test: bool = False, job_name: str = '', wait_to_finish: bool = False)

Catch-all for copy operations.

Behavior:

• If source is a sequence (get_file_type(source) == “sequence”), use the existing sequence path (robocopy on win / copy_file_list otherwise).

• If source is a list of paths, use copy_file_list.

• Otherwise, defer to cgl_copy_single() which already supports both file and directory sources. We ensure dest_is_folder is set whenever either source is a directory or destination is/should be a directory.

Returns:

run_dict (same shape as before)

cgl.core.utils.general.cgl_copy_single(source, destination, test=False, verbose=False, dest_is_folder=False, command_name='cgl_copy_single')

Lumbermill Copy Function. Built to handle any kind of copy interaction.

cgl.core.utils.general.cgl_execute(command: Sequence[str] | str, *, return_output: bool = True, print_output: bool = True, verbose: bool = True, command_name: str = 'cgl_execute', new_window: bool = False, detach: bool = False, env: Mapping[str, str] | None = None, timeout: float | None = None, working_directory: str | Path | None = None) → dict[str, Any]

Runs a local process with smart shell detection. Replaces the old _run_blocking/_run_nonblocking pattern.

cgl.core.utils.general.cgl_move(source, destination, verbose=False)

Catch All Move Function. handles files and folders on all platforms

cgl.core.utils.general.cgl_sync(source_dir: str, dest_dir: str)

Sync files from source to destination using robocopy. Only updates files if the source version is newer. Skips identical files.

cgl.core.utils.general.cgl_sync_file(source_file: str, dest_dir: str)

Sync a single file from source to destination folder. Only updates the file if the source version is newer or if it does not exist in the destination.

cgl.core.utils.general.clean_file_list(file_list)

removes items we don’t want to display in the GUI based off what’s listed in the globals.

Parameters:

file_list

Returns:

list of files with items removed

Return type:

clean_list

cgl.core.utils.general.clean_file_string(file_name)

Removes characters we don’t want from a file name

cgl.core.utils.general.compare_drives(source: str, destination: str)

cgl.core.utils.general.copy_file_list(source_list, destination, methodology, verbose, dest_is_folder)

cgl.core.utils.general.create_file_dirs(file_path)

given file_path checks to see if directories exist and creates them if they don’t.

Parameters:

file_path – path to file you’re about to create.

cgl.core.utils.general.current_user()

find the currently logged-in user :returns: username :rtype: str

cgl.core.utils.general.display_debug_widget(parent)

cgl.core.utils.general.ext_exists(folder_path, ext, as_posix=True) → list[Path]

Parameters:

• folder_path – directory to search

• ext – extention you’re looking for. expecting a “.ext” but “ext” will likely work too.

Returns:

list of Path objects that match the extension in the folder_path

cgl.core.utils.general.fix_json(filepath)

Function to fix json file if there’s no newlines

Parameters:

filepath – Path to json file

cgl.core.utils.general.get_branch_name()

cgl.core.utils.general.get_end_time(start_time)

cgl.core.utils.general.get_file_type(filepath) → str

Returns the file type of the given filepath

Parameters:

filepath

Returns:

The file type of the given filepath

Raises:

KeyError – If the file type is not found in the config file

cgl.core.utils.general.get_job_id()

cgl.core.utils.general.get_print_list(list_array)

Returns a string of a list with commas and an “and” before the last item. :param list_array:

Returns:

cgl.core.utils.general.get_resource_path(relative_path)

Get absolute path to resource, works for PyInstaller and development.

cgl.core.utils.general.ignore_name(name, ignore_matches, ignore_contains, ignore_endswith, ignore_startswith)

Check if a file should be ignored based on the ignore rules

cgl.core.utils.general.load_fonts_from_directory(directory=None)

cgl.core.utils.general.load_json(filepath)

cgl.core.utils.general.load_style_sheet(style_file='stylesheet.css', app=None, dev_mode=0)

cgl.core.utils.general.load_xml(filepath)

cgl.core.utils.general.normpath(filepath)

returns path with all ‘’ replaced with ‘/’

Parameters:

filepath

Returns:

cgl.core.utils.general.pretty(obj)

return a pretty printed representation of an object :param obj: the object to pretty print

Return type:

str

cgl.core.utils.general.pretty_print_error(e: CglExecuteError)

Nicely format a CglExecuteError for logging or console output.

cgl.core.utils.general.print_call_stack()

cgl.core.utils.general.remove_read_only_attribute(file_path)

Removes read only attribute from file

Parameters:

file_path – Absolute file path to file

cgl.core.utils.general.save_json(path: Path, data: dict)

cgl.core.utils.general.save_xml(filepath, data)

cgl.core.utils.general.screen_grab(path_object)

1. takes a screen grab and saves it to the “preview_path” variable on PathObject()

2. creates a “thumbnail” at the “thumb_path” from PathObject()

3. updates ftrack or shotgrid with the new thumbnail.

cgl.core.utils.general.split_all(path)

It splits a path into all of its parts, and returns a list of those parts

Parameters:

path – The path to split

Returns:

A list of all the parts of the path.

cgl.core.utils.msd_tools module

cgl.core.utils.network module

cgl.core.utils.network.check_for_network_drive_connection(address, drive)

Check if network drive is currently mapped to computer :param address: Network location :param drive: Drive that network is mapped to

Returns:

True if network is found. False is network address is not found

cgl.core.utils.network.get_all_connected_network_drives(simple=False)

Get all network drives mapped on current computer :returns: List of dictionaries for each connected network drive

Example

{ “Y:” : {“local” : “Y:”, “remote” : “10.0.0.100VPShare”}}

cgl.core.utils.network.get_all_drives()

Returns all drives computer is connected to. :returns: List of drives

cgl.core.utils.network.get_ip_address(external=False)

returns the computer’s external ip address.

Returns:

ip address

cgl.core.utils.network.get_local_drives()

returns all the local drives. (Probably a more elegant way to do this.)

Returns:

List of local drives

cgl.core.utils.network.get_machine_name()

Returns the local machine’s hostname. Cross-platform, no dependencies.

cgl.core.utils.network.map_network_drive(drive, address, user, password)

Parameters:

• drive – drive letter - should be in the following: “Y”

• address

• user

• password

Returns:

True if network is found. False is network address is not found

cgl.core.utils.pycharm_setup module

cgl.core.utils.read_write module

class cgl.core.utils.read_write.NoAliasDumper(stream, default_style=None, default_flow_style=False, canonical=None, indent=None, width=None, allow_unicode=None, line_break=None, encoding=None, explicit_start=None, explicit_end=None, version=None, tags=None, sort_keys=True)

Bases: Dumper

ignore_aliases(data)

cgl.core.utils.read_write.load_json(filepath)

Loads a .json file in as a dictionary

Parameters:

filepath

Returns:

dictionary

Return type:

data

cgl.core.utils.read_write.load_text_file(file_path)

cgl.core.utils.read_write.load_xml(filepath)

loads an xml as a dictionary

Parameters:

filepath

Returns:

dictionary

Return type:

docs

cgl.core.utils.read_write.load_yaml(filepath)

Loads a .yaml file in as a dictionary

Parameters:

filepath

Returns:

dictionary

Return type:

data

cgl.core.utils.read_write.save_json(filepath, data)

Saves a Dictionary as a .json file.

Parameters:

• filepath

• data – dictionary

cgl.core.utils.read_write.save_text_lines(text_array, file_path)

this expects to get typical text that would print normally.

Parameters:

• text_array

• file_path

cgl.core.utils.read_write.save_xml(filepath, data)

saves a dictionary as an xml file

Parameters:

• filepath

• data

cgl.core.utils.read_write.save_yaml(filepath, data)

Saves a Dictionary as a .json file.

Parameters:

• filepath

• data – dictionary

cgl.core.utils.read_write.unzip(zipped_file, destination, password=None)

Parameters:

• zipped_file

• destination

• password

Returns:

destination path

cgl.core.utils.read_write.zip_dir(folder_path, zip_file)

zipes a file or folder

Parameters:

• folder_path

• zip_file

Return:

cgl.core.utils.read_write.zip_path(source_path, zip_file)

built to handle both files and folders as “source_path”

Parameters:

• source_path

• zip_file

Returns:

cgl.core.utils.setup_codacy_coverage module

cgl.core.utils.web module

cgl.core.utils.web.download_url(url, destination_file)

Downloads the given file from url to destination file path.

Parameters:

• url – url location of a file on the web

• destination_file – file to be created

cgl.core.utils.web.download_youtube_video(url, destination_file)

Downloads the given youtube video from url to destination file path.

Parameters:

• url – url location of a youtube video

• destination_file – file to be created

cgl.core.utils.web.url_exists(url)

Checks to see if the given url exists

Parameters:

url – url address

Module contents