sequences.utils package

Submodules

sequences.utils.fileStructure module

class sequences.utils.fileStructure.FilestructurePath(path)

Bases: object

classmethod from_path(path, *args, **kwargs)

classmethod find_type(path, *args, **kwargs)

path

parent()

name()

type

class sequences.utils.fileStructure.PerforcePath(path, *args, **kwargs)

Bases: sequences.utils.fileStructure.FilestructurePath

priority = 40

p4

local_path

depot_path

tracked()

get_stats()

Get Perforces stats (fstat) for this Perforce path This always retrieves the latest information, no caching

stats

Get Perforces stats (fstat) for this Perforce path Uses caching

get_revisions()

Get Perforces revsions (filelog) for this Perforce path This always retrieves the latest information, no caching

revisions

Get Perforces revisions (filelog) for this Perforce path Uses caching

get_client_data()

clientData

get_where()

Get Perforces where (where) for this Perforce path No caching

where

Get Perforces where (where) for this Perforce path Uses caching

get_fileinfo()

Get Perforces fileinfo (file) for this Perforce path No caching

fileinfo

Get Perforces fileinfo (file) for this Perforce path Uses caching

item_cmp(a, b)

Return the comparison for two items. Sort by isfile/isdir and then by name

editable()

deleted()

latest()

checkedOut()

different

revision

next_revision

exists()

refresh()

sync(revision=None, *args, **kwargs)

remove()

checkout()

revert()

revert_unchanged()

Reverts unchanged file

submit(description=None, force=False)

get_children(includeDirs=True, includeFiles=True)

read(forceP4=False)

isfile()

isdir()

validate()

class sequences.utils.fileStructure.DiskPath(path)

Bases: sequences.utils.fileStructure.FilestructurePath

priority = 20

local_path

exists()

editable()

read()

get_children()

isfile()

isdir()

validate()

sequences.utils.perforce module

sequences.utils.perforce.refresh()

Delete all cached p4 connections

sequences.utils.perforce.newInstance(dialog=False)

sequences.utils.perforce.is_valid_user(p4)

class sequences.utils.perforce.TempP4ExceptionLevel(p4, lvl)

Bases: object

Temporarily adjust the P4 exception level

Example

>>> with TempP4ExceptionLevel(p4, 1):
>>>     # do stuff

Parameters:

• p4 (P4.P4) – P4 instance
• lvl (int) – Exception Level

sequences.utils.perforce.get_p4_and_client_from_path(path)

Given a path, return a p4 instance and clientData if possible. Will search within the cached instances, otherwise attempts to find an appropriate client and returns the new data

sequences.utils.perforce.get_p4_from_path(path)

sequences.utils.perforce.get_client_data(p4)

sequences.utils.perforce.get_client_from_path(p4, path, clients=None, includeData=False)

sequences.utils.perforce.check_path_in_client(p4, c, path, filterHost=True)

sequences.utils.perforce.find_client(p4, path, host=None)

Find a client by root path

sequences.utils.perforce.get_depots(p4=None, refresh=False)

Return a list of all depots

sequences.utils.perforce.get_depot_paths(p4=None, refresh=False)

From a p4 instance, get a list of all depot paths available

Parameters:p4 (P4) – perforce instance Returns:

Depot paths in the format of

[‘//{depotName}’, ...]

Return type:list of str

sequences.utils.perforce.get_clients(p4=None, refresh=False)

Return a list of all clients

sequences.utils.perforce.get_clients_with_specs(p4=None, clients=None, ignoreStreams=False, useCache=True)

Get a list of clients with their full specs This contains the view mappings

sequences.utils.perforce.get_child_dirs(p4, path, **kwargs)

Return all child directories of the given path as strings Kwargs are passed to filter_item

sequences.utils.perforce.get_child_files(p4, path, includeDeleted=False, **kwargs)

Return all perforce files inside the given directory as strings

sequences.utils.perforce.build_changelist(p4, files, description)

sequences.utils.perforce.is_path_tracked(path, p4=None)

sequences.utils.perforce.is_file_tracked(path, p4=None)

Return True if the given file is currently tracked in perforce

sequences.utils.perforce.is_dir_tracked(path, p4=None)

Return True if the given directory is currently tracked in perforce

sequences.utils.utils module

sequences.utils.utils.get_os()

Get the os of the current system in a standard format. mac, windows, linux

sequences.utils.utils.path_normalize(filename, allowBackslash=False, normcase=False, removeDoubleSlashes=True)

Normalize filename Make sure all slashes match the platform

sequences.utils.utils.path_contains(root, path, normalize=True, normcase=True)

Return True if root contains path Prevents false positives such as:

/root /root2/project

sequences.utils.utils.join_paths(*paths)

Join paths using forward slashes

sequences.utils.utils.filter_item(item, include=['*'], exclude=[])

Return True if the given item passes the given filters, False if it doesn’t

key - can be given an attrgetter or itemgetter to be used on item

sequences.utils.utils.get_folder_contents(path, includeFiles=True, includeDirs=True, **kwargs)

Module contents