dulwich.client.SubprocessGitClient

class documentation

class SubprocessGitClient(TraditionalGitClient):

Constructors: SubprocessGitClient.from_parsedurl(parsedurl, thin_packs, report_activity, quiet, ...), SubprocessGitClient(path_encoding, thin_packs, report_activity, quiet, ...)

View In Hierarchy

Git client that talks to a server using a subprocess.

Class Method	`from_parsedurl`	Create an instance of SubprocessGitClient from a parsed URL.
Class Variable	`git_command`	Undocumented
Method	`_connect`	Create a connection to the server.

Inherited from TraditionalGitClient:

Method	`__init__`	Initialize a TraditionalGitClient.
Method	`archive`	Request an archive of a specific commit.
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
Instance Variable	`protocol_version`	Undocumented
Instance Variable	`_remote_path_encoding`	Undocumented
Instance Variable	`_report_status_parser`	Undocumented

Inherited from GitClient (via TraditionalGitClient):

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.
Method	`get_url`	Retrieves full url to given path.
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) -> SubprocessGitClient: ¶

overrides dulwich.client.GitClient.from_parsedurl

Create an instance of SubprocessGitClient 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 protocol (not used for SubprocessGitClient)
username:`str \| None`	Username for authentication (not used for SubprocessGitClient)
password:`str \| None`	Password for authentication (not used for SubprocessGitClient)
config:`Config \| None`	Configuration object (not used for SubprocessGitClient)

Returns
`SubprocessGitClient`	A SubprocessGitClient instance

git_command: list[str] | None = ¶

Undocumented

def _connect(self, service: bytes, path: bytes | str, protocol_version: int | None = None) -> tuple[Protocol, Callable[[], bool], IO[bytes] | None]: ¶

overrides dulwich.client.TraditionalGitClient._connect

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
service:`bytes`	Undocumented
path:`bytes \| str`	The path we should pass to the service. (as bytestirng)
protocol_version:`int \| None`	Desired Git protocol version. By default the highest mutually supported protocol version will be used.
cmd	The git service name to which we should connect.

Returns
`tuple[Protocol, Callable[[], bool], IO[bytes] \| None]`	Undocumented