perforce.api

This module implements the Perforce API

copyright:
  1. 2015 by Brett Dixon
license:

MIT, see LICENSE for more details
perforce.api.changelist(description=None, connection=None)[source]

Gets or creates a Changelist object with a description

Parameters:
  • description (str) – Description of changelist to find or create
  • connection (Connection) – Connection object to use
Returns:

Changelist
perforce.api.connect(*args, **kwargs)[source]

Creates or returns a singleton Connection object

perforce.api.edit(filename, connection=None)[source]

Checks out a file into the default changelist

Parameters:
  • filename (str) – File to check out
  • connection (Connection) – Connection object to use
perforce.api.info(connection=None)[source]

Returns information about the current Connection

Parameters:connection (Connection) – Connection object to use
Returns:dict
perforce.api.open(filename, connection=None)[source]

Edits or Adds a filename ensuring the file is in perforce and editable

Parameters:
  • filename (str) – File to check out
  • connection (Connection) – Connection object to use
perforce.api.sync(filename, connection=None)[source]

Syncs a file

Parameters:
  • filename (str) – File to check out
  • connection (Connection) – Connection object to use