dulwich.client.TraditionalGitClient

class documentation

class TraditionalGitClient(GitClient):

Known subclasses: dulwich.client.SSHGitClient, dulwich.client.SubprocessGitClient, dulwich.client.TCPGitClient, dulwich.tests.test_client.DummyClient

View In Hierarchy

Traditional Git client.

Method	`__init__`	Create a new GitClient instance.
Method	`archive`	Retrieve an archive of the specified tree.
Method	`fetch_pack`	Retrieve a pack from a git smart server.
Method	`get_refs`	Retrieve the current refs from a git smart server.
Method	`send_pack`	Upload a pack to a remote repository.
Constant	`DEFAULT_ENCODING`	Undocumented
Async Method	`_connect`	Create a connection to the server.
Instance Variable	`_remote_path_encoding`	Undocumented
Instance Variable	`_report_status_parser`	Undocumented

Inherited from GitClient:

Class Method	`from_parsedurl`	Create an instance of this client from a urlparse.parsed object.
Method	`clone`	Clone a repository.
Method	`fetch`	Fetch into a target repository.
Method	`get_url`	Retrieves full url to given path.
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	`_send_capabilities`	Undocumented

def __init__(self, path_encoding=DEFAULT_ENCODING, **kwargs): ¶

overrides dulwich.client.GitClient.__init__

overridden in dulwich.client.SSHGitClient, dulwich.client.TCPGitClient, dulwich.tests.test_client.DummyClient

Create a new GitClient instance.

Parameters
path_encoding	Undocumented
**kwargs	Undocumented
thin_packs	Whether or not thin packs should be retrieved
report_activity	Optional callback for reporting transport activity.
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): ¶

overrides dulwich.client.GitClient.archive

Retrieve an archive of the specified tree.

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

overrides dulwich.client.GitClient.fetch_pack

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): ¶

overrides dulwich.client.GitClient.get_refs

Retrieve the current refs from a git smart server.

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

overrides dulwich.client.GitClient.send_pack

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 pack data to upload.
progress	Optional callback called with progress updates
Returns
SendPackResult
Raises
`SendPackError`	if server rejects the pack data

DEFAULT_ENCODING: str = ¶

Undocumented

Value

'utf-8'

async def _connect(self, cmd, path): ¶

overridden in dulwich.client.SSHGitClient, dulwich.client.SubprocessGitClient, dulwich.client.TCPGitClient, dulwich.tests.test_client.DummyClient

Create a connection to the server.

This method is abstract - concrete implementations should implement their own variant which connects to the server and returns an initialized Protocol object with the service ready for use and a can_read function which may be used to see if reads would block.

Parameters
cmd	The git service name to which we should connect.
path	The path we should pass to the service. (as bytestirng)

_remote_path_encoding = ¶

Undocumented

_report_status_parser = ¶

overrides dulwich.client.GitClient._report_status_parser

Undocumented