dulwich.client module documentation

Part of dulwich

Client side support for the Git protocol.

The Dulwich client supports the following capabilities:

  • thin-pack
  • multi_ack_detailed
  • multi_ack
  • side-band-64k
  • ofs-delta
  • quiet
  • report-status
  • delete-refs

Known capabilities that are not supported:

  • shallow
  • no-progress
  • include-tag
Class InvalidWants Invalid wants.
Class ReportStatusParser Handle status as reported by servers with 'report-status' capability.
Function read_pkt_refs Undocumented
Class FetchPackResult Result of a fetch-pack operation.
Class GitClient Git smart server client.
Function check_wants Check that a set of wants is valid.
Function remote_error_from_stderr Return an appropriate exception based on stderr output.
Class TraditionalGitClient Traditional Git client.
Class TCPGitClient A Git Client that works over TCP directly (i.e. git://).
Class SubprocessWrapper A socket-like object that talks to a subprocess via pipes.
Function find_git_command Find command to run for system Git (usually C Git).
Class SubprocessGitClient Git client that talks to a server using a subprocess.
Class LocalGitClient Git Client that just uses a local Repo.
Class SSHVendor A client side SSH implementation.
Class StrangeHostname Refusing to connect to strange SSH hostname.
Class SubprocessSSHVendor SSH vendor that shells out to the local 'ssh' command.
Class PLinkSSHVendor SSH vendor that shells out to the local 'plink' command.
Function ParamikoSSHVendor Undocumented
Class SSHGitClient Undocumented
Function default_user_agent_string Undocumented
Function default_urllib3_manager Return urllib3 connection pool manager.
Class HttpGitClient No class docstring; 0/1 class methods, 4/10 methods documented
Function get_transport_and_path_from_url Obtain a git client from a URL.
Function parse_rsync_url Parse a rsync-style URL.
Function get_transport_and_path Obtain a git client from a URL.
Function _fileno_can_read Check if a file descriptor is readable.
Function _win32_peek_avail Wrapper around PeekNamedPipe to check how many bytes are available.
Function _read_shallow_updates Undocumented
def _fileno_can_read(fileno):
Check if a file descriptor is readable.
def _win32_peek_avail(handle):
Wrapper around PeekNamedPipe to check how many bytes are available.
def read_pkt_refs(proto):
Undocumented
def _read_shallow_updates(proto):
Undocumented
def check_wants(wants, refs):
Check that a set of wants is valid.
ParameterswantsSet of object SHAs to fetch
refsRefs dictionary to check against
def remote_error_from_stderr(stderr):
Return an appropriate exception based on stderr output.
def find_git_command():
Find command to run for system Git (usually C Git).
def ParamikoSSHVendor(**kwargs):
Undocumented
def default_user_agent_string():
Undocumented
def default_urllib3_manager(config, **override_kwargs):

Return urllib3 connection pool manager.

Honour detected proxy configurations.

Parametersconfigdulwich.config.ConfigDict instance with Git configuration.
kwargsAdditional arguments for urllib3.ProxyManager
Returnsurllib3.ProxyManager instance for proxy configurations, urllib3.PoolManager otherwise.
def get_transport_and_path_from_url(url, config=None, **kwargs):
Obtain a git client from a URL.
ParametersurlURL to open (a unicode string)
configOptional config object
thin_packsWhether or not thin packs should be retrieved
report_activityOptional callback for reporting transport activity.
ReturnsTuple with client instance and relative path.
def parse_rsync_url(location):
Parse a rsync-style URL.
def get_transport_and_path(location, **kwargs):
Obtain a git client from a URL.
ParameterslocationURL or path (a string)
configOptional config object
thin_packsWhether or not thin packs should be retrieved
report_activityOptional callback for reporting transport activity.
ReturnsTuple with client instance and relative path.
API Documentation for Dulwich, generated by pydoctor at 2018-11-17 19:05:54.