dulwich.client.GitClient

class documentation

class GitClient(object):

Known subclasses: dulwich.client.AbstractHttpGitClient, dulwich.client.LocalGitClient, dulwich.client.TraditionalGitClient

View In Hierarchy

Git smart server client.

Class Method	`from_parsedurl`	Create an instance of this client from a urlparse.parsed object.
Method	`__init__`	Create a new GitClient instance.
Method	`archive`	Retrieve an archive of the specified tree.
Method	`clone`	Clone a repository.
Method	`fetch`	Fetch into a target repository.
Method	`fetch_pack`	Retrieve a pack from a git smart server.
Method	`get_refs`	Retrieve the current refs from a git smart server.
Method	`get_url`	Retrieves full url to given path.
Method	`send_pack`	Upload a pack to a remote repository.
Static Method	`_should_send_pack`	Undocumented
Method	`_handle_receive_pack_tail`	Handle the tail of a 'git-receive-pack' request.
Method	`_negotiate_receive_pack_capabilities`	Undocumented
Method	`_negotiate_upload_pack_capabilities`	Undocumented
Instance Variable	`_fetch_capabilities`	Undocumented
Instance Variable	`_report_activity`	Undocumented
Instance Variable	`_report_status_parser`	Undocumented
Instance Variable	`_send_capabilities`	Undocumented

@classmethod
def from_parsedurl(cls, parsedurl, **kwargs): ¶

overridden in dulwich.client.AbstractHttpGitClient, dulwich.client.LocalGitClient, dulwich.client.SSHGitClient, dulwich.client.SubprocessGitClient, dulwich.client.TCPGitClient

Create an instance of this client from a urlparse.parsed object.

Parameters
parsedurl	Result of urlparse()
**kwargs	Undocumented
Returns
A `GitClient` object

def __init__(self, thin_packs=True, report_activity=None, quiet=False, include_tags=False): ¶

overridden in dulwich.client.AbstractHttpGitClient, dulwich.client.LocalGitClient, dulwich.client.TraditionalGitClient

Create a new GitClient instance.

Parameters
thin_packs	Whether or not thin packs should be retrieved
report_activity	Optional callback for reporting transport activity.
quiet	Undocumented
include_tags	send annotated tags when sending the objects they point to

def archive(self, path, committish, write_data, progress=None, write_error=None, format=None, subdirs=None, prefix=None): ¶

overridden in dulwich.client.TraditionalGitClient

Retrieve an archive of the specified tree.

def clone(self, path, target_path, mkdir=True, bare=False, origin='origin', checkout=None, branch=None, progress=None, depth=None): ¶

Clone a repository.

Parameters
path	Undocumented
target_path	Undocumented
mkdir:`bool`	Undocumented
bare	Undocumented
origin	Undocumented
checkout	Undocumented
branch	Undocumented
progress	Undocumented
depth	Undocumented

def fetch(self, path, target, determine_wants=None, progress=None, depth=None): ¶

overridden in dulwich.client.LocalGitClient

Fetch into a target repository.

Parameters
path:`str`	Path to fetch from (as bytestring)
target:`Repo`	Target repository to fetch into
determine_wants:`Optional[Callable[[Dict[bytes, bytes], Optional[int]], List[bytes]]]`	Optional function to determine what refs to fetch. Receives dictionary of name->sha, should return list of shas to fetch. Defaults to all shas.
progress:`Optional[Callable[[bytes], None]]`	Optional progress function
depth:`Optional[int]`	Depth to fetch at
Returns
`FetchPackResult`	Dictionary with all remote refs (not just those fetched)

def fetch_pack(self, path, determine_wants, graph_walker, pack_data, progress=None, depth=None): ¶

overridden in dulwich.client.AbstractHttpGitClient, dulwich.client.LocalGitClient, dulwich.client.TraditionalGitClient

Retrieve a pack from a git smart server.

Parameters
path	Remote path to fetch from
determine_wants	Function determine what refs to fetch. Receives dictionary of name->sha, should return list of shas to fetch.
graph_walker	Object with next() and ack().
pack_data	Callback called for each bit of data in the pack
progress	Callback for progress reports (strings)
depth	Shallow fetch depth
Returns
FetchPackResult object

def get_refs(self, path): ¶

overridden in dulwich.client.AbstractHttpGitClient, dulwich.client.LocalGitClient, dulwich.client.TraditionalGitClient

Retrieve the current refs from a git smart server.

Returns:

Parameters
path	Path to the repo to fetch from. (as bytestring)

def get_url(self, path): ¶

overridden in dulwich.client.AbstractHttpGitClient, dulwich.client.LocalGitClient, dulwich.client.SSHGitClient, dulwich.client.TCPGitClient

Retrieves full url to given path.

Parameters
path	Repository path (as string)
Returns
Url to path (as string)

def send_pack(self, path, update_refs, generate_pack_data, progress=None): ¶

overridden in dulwich.client.AbstractHttpGitClient, dulwich.client.LocalGitClient, dulwich.client.TraditionalGitClient

Upload a pack to a remote repository.

Parameters
path	Repository path (as bytestring)
update_refs	Function to determine changes to remote refs. Receive dict with existing remote refs, returns dict with changed refs (name -> sha, where sha=ZERO_SHA for deletions)
generate_pack_data	Function that can return a tuple with number of objects and list of pack data to include
progress	Optional progress function
Returns
SendPackResult object
Raises
`SendPackError`	if server rejects the pack data

@staticmethod
def _should_send_pack(new_refs): ¶

Undocumented

def _handle_receive_pack_tail(self, proto, capabilities, progress=None): ¶

Handle the tail of a 'git-receive-pack' request.

Parameters
proto:`Protocol`	Protocol object to read from
capabilities:`Set[bytes]`	List of negotiated capabilities
progress:`Optional[Callable[[bytes], None]]`	Optional progress reporting function
Returns
dict mapping ref name to	error message if the ref failed to update None if it was updated successfully

def _negotiate_receive_pack_capabilities(self, server_capabilities): ¶

Undocumented

def _negotiate_upload_pack_capabilities(self, server_capabilities): ¶

Undocumented

_fetch_capabilities = ¶

Undocumented

_report_activity = ¶

overridden in dulwich.client.LocalGitClient

Undocumented

_report_status_parser = ¶

overridden in dulwich.client.AbstractHttpGitClient, dulwich.client.TraditionalGitClient

Undocumented

_send_capabilities = ¶

Undocumented