dulwich.client.AbstractHttpGitClient

class documentation

class AbstractHttpGitClient(GitClient):

Known subclasses: dulwich.client.Urllib3HttpGitClient

Constructors: AbstractHttpGitClient.from_parsedurl(parsedurl, thin_packs, report_activity, quiet, ...), AbstractHttpGitClient(base_url, dumb, thin_packs, report_activity, ...)

View In Hierarchy

Abstract base class for HTTP Git Clients.

This is agonistic of the actual HTTP implementation.

Subclasses should provide an implementation of the _http_request method.

Class Method	`from_parsedurl`	Create an AbstractHttpGitClient from a parsed URL.
Method	`__init__`	Initialize AbstractHttpGitClient.
Method	`__repr__`	Return string representation of this client.
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`	Get the HTTP URL for a path.
Method	`send_pack`	Upload a pack to a remote repository.
Instance Variable	`dumb`	Undocumented
Instance Variable	`protocol_version`	Undocumented
Method	`_discover_references`	Undocumented
Method	`_get_url`	Undocumented
Method	`_http_request`	Perform HTTP request.
Method	`_smart_request`	Send a 'smart' HTTP request.
Instance Variable	`_base_url`	Undocumented
Instance Variable	`_password`	Undocumented
Instance Variable	`_report_status_parser`	Undocumented
Instance Variable	`_url_with_auth`	Undocumented
Instance Variable	`_username`	Undocumented

Inherited from GitClient:

Method	`archive`	Retrieve an archive of the specified tree.
Method	`clone`	Clone a repository.
Method	`close`	Close the client and release any resources.
Method	`fetch`	Fetch into a target repository.
Method	`fetch_with_bundle_uri`	Fetch into a target repository, using bundle URIs for bootstrap.
Static Method	`_should_send_pack`	Undocumented
Static Method	`_warn_filter_objects`	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

@classmethod

def from_parsedurl(cls, parsedurl: ParseResult, thin_packs: bool = True, report_activity: Callable[[int, str], None] | None = None, quiet: bool = False, include_tags: bool = False, dumb: bool = False, username: str | None = None, password: str | None = None, config: Config | None = None, pool_manager: urllib3.PoolManager | None = None) -> AbstractHttpGitClient: ¶

overrides dulwich.client.GitClient.from_parsedurl

Create an AbstractHttpGitClient from a parsed URL.

Parameters
parsedurl:`ParseResult`	Result of urlparse()
thin_packs:`bool`	Whether or not thin packs should be retrieved
report_activity:`Callable[[int, str], None] \| None`	Optional callback for reporting transport activity
quiet:`bool`	Whether to suppress progress output
include_tags:`bool`	Whether to include tags
dumb:`bool`	Whether to use dumb HTTP transport
username:`str \| None`	Optional username for authentication
password:`str \| None`	Optional password for authentication
config:`Config \| None`	Configuration object
pool_manager:`urllib3.PoolManager \| None`	Optional urllib3 PoolManager for HTTP(S) connections

Returns
`AbstractHttpGitClient`	An AbstractHttpGitClient instance

def __init__(self, base_url: str, dumb: bool = False, thin_packs: bool = True, report_activity: Callable[[int, str], None] | None = None, quiet: bool = False, include_tags: bool = False, username: str | None = None, password: str | None = None): ¶

overrides dulwich.client.GitClient.__init__

overridden in dulwich.client.Urllib3HttpGitClient

Initialize AbstractHttpGitClient.

def __repr__(self) -> str: ¶

Return string representation of this client.

def fetch_pack(self, path: str | bytes, determine_wants: DetermineWantsFunc, graph_walker: GraphWalker, pack_data: Callable[[bytes], int], progress: Callable[[bytes], None] | None = None, depth: int | None = None, ref_prefix: Sequence[bytes] | None = None, filter_spec: bytes | None = None, protocol_version: int | None = None, shallow_since: str | None = None, shallow_exclude: list[str] | None = None) -> FetchPackResult: ¶

overrides dulwich.client.GitClient.fetch_pack

Retrieve a pack from a git smart server.

Parameters
path:`str \| bytes`	Path to fetch from
determine_wants:`DetermineWantsFunc`	Callback that returns list of commits to fetch
graph_walker:`GraphWalker`	Object with next() and ack().
pack_data:`Callable[[bytes], int]`	Callback called for each bit of data in the pack
progress:`Callable[[bytes], None] \| None`	Callback for progress reports (strings)
depth:`int \| None`	Depth for request
ref_prefix:`Sequence[bytes] \| None`	List of prefixes of desired references, as a list of bytestrings. Filtering is done by the server if supported, and client side otherwise.
filter_spec:`bytes \| None`	A git-rev-list-style object filter spec, as bytestring. Only used if the server supports the Git protocol-v2 'filter' feature, and ignored otherwise.
protocol_version:`int \| None`	Desired Git protocol version. By default the highest mutually supported protocol version will be used.
shallow_since:`str \| None`	Deepen the history to include commits after this date
shallow_exclude:`list[str] \| None`	Deepen the history to exclude commits reachable from these refs

Returns
`FetchPackResult`	FetchPackResult object

def get_refs(self, path: str | bytes, protocol_version: int | None = None, ref_prefix: Sequence[bytes] | None = None) -> LsRemoteResult: ¶

overrides dulwich.client.GitClient.get_refs

Retrieve the current refs from a git smart server.

def get_url(self, path: str) -> str: ¶

overrides dulwich.client.GitClient.get_url

Get the HTTP URL for a path.

def send_pack(self, path: str | bytes, update_refs: Callable[[dict[Ref, ObjectID]], dict[Ref, ObjectID]], generate_pack_data: GeneratePackDataFunc, progress: Callable[[bytes], None] | None = None, push_options: Sequence[bytes] | None = None, atomic: bool = False) -> SendPackResult: ¶

overrides dulwich.client.GitClient.send_pack

Upload a pack to a remote repository.

Parameters
path:`str \| bytes`	Repository path (as bytestring or string)
update_refs:`Callable[[dict[Ref, ObjectID]], dict[Ref, ObjectID]]`	Function to determine changes to remote refs. Receives dict with existing remote refs, returns dict with changed refs (name -> sha, where sha=ZERO_SHA for deletions)
generate_pack_data:`GeneratePackDataFunc`	Function that can return a tuple with number of elements and pack data to upload.
progress:`Callable[[bytes], None] \| None`	Optional progress function
push_options:`Sequence[bytes] \| None`	Optional list of push options to send to the server
atomic:`bool`	If True, request atomic push (all refs update or none do)

Returns
`SendPackResult`	SendPackResult

Raises
`SendPackError`	if server rejects the pack data
`GitProtocolError`	if atomic push is requested but server doesn't support it

dumb = ¶

Undocumented

protocol_version = ¶

overrides dulwich.client.GitClient.protocol_version

Undocumented

def _discover_references(self, service: bytes, base_url: str, protocol_version: int | None = None, ref_prefix: Sequence[bytes] | None = None) -> tuple[dict[Ref, ObjectID | None], set[bytes], str, dict[Ref, Ref], dict[Ref, ObjectID]]: ¶

Undocumented

def _get_url(self, path: str | bytes) -> str: ¶

overridden in dulwich.client.Urllib3HttpGitClient

Undocumented

def _http_request(self, url: str, headers: dict[str, str] | None = None, data: bytes | Iterator[bytes] | None = None, raise_for_status: bool = True) -> tuple[HTTPResponse, Callable[[int], bytes]]: ¶

overridden in dulwich.client.Urllib3HttpGitClient

Perform HTTP request.

Parameters
url:`str`	Request URL.
headers:`dict[str, str] \| None`	Optional custom headers to override defaults.
data:`bytes \| Iterator[bytes] \| None`	Request data.
raise_for_status:`bool`	Whether to raise an exception for HTTP errors.

Returns
`tuple[HTTPResponse, Callable[[int], bytes]]`	Tuple (response, read), where response is an urllib3 response object with additional content_type and redirect_location properties, and read is a consumable read method for the response data.

Raises
`GitProtocolError`

def _smart_request(self, service: str, url: str, data: bytes | Iterator[bytes]) -> tuple[HTTPResponse, Callable[[int], bytes]]: ¶

Send a 'smart' HTTP request.

This is a simple wrapper around _http_request that sets a couple of extra headers.

_base_url = ¶

Undocumented

_password = ¶

Undocumented

_report_status_parser = ¶

overrides dulwich.client.GitClient._report_status_parser

Undocumented

_url_with_auth: str | None = ¶

Undocumented

_username = ¶

Undocumented