dulwich.client.BundleClient

class documentation

class BundleClient(GitClient):

Constructors: BundleClient.from_parsedurl(parsedurl, thin_packs, report_activity, quiet, ...), BundleClient(thin_packs, report_activity, config, quiet, ...)

View In Hierarchy

Git Client that reads from a bundle file.

Class Method	`from_parsedurl`	Create an instance of BundleClient from a parsed URL.
Method	`__init__`	Create a new BundleClient instance.
Method	`fetch`	Fetch into a target repository from a bundle file.
Method	`fetch_pack`	Retrieve a pack from a bundle file.
Method	`get_refs`	Retrieve the current refs from a bundle file.
Method	`get_url`	Get the URL for a bundle file path.
Method	`send_pack`	Upload is not supported for bundle files.
Class Method	`_is_bundle_file`	Check if a file is a git bundle by reading the first line.
Class Method	`_open_bundle`	Open and parse a bundle file.
Static Method	`_skip_to_pack_data`	Skip to the pack data section in a bundle file.
Instance Variable	`_include_tags`	Undocumented
Instance Variable	`_quiet`	Undocumented
Instance Variable	`_report_activity`	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_with_bundle_uri`	Fetch into a target repository, using bundle URIs for bootstrap.
Instance Variable	`protocol_version`	Undocumented
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_status_parser`	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) -> BundleClient: ¶

overrides dulwich.client.GitClient.from_parsedurl

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

Returns
`BundleClient`	A BundleClient instance

def __init__(self, thin_packs: bool = True, report_activity: Callable[[int, str], None] | None = None, config: Config | None = None, quiet: bool = False, include_tags: bool = False): ¶

overrides dulwich.client.GitClient.__init__

Create a new BundleClient instance.

Parameters
thin_packs:`bool`	Whether or not thin packs should be retrieved
report_activity:`Callable[[int, str], None] \| None`	Optional callback for reporting transport activity.
config:`Config \| None`	Optional configuration object
quiet:`bool`	Whether to suppress progress output
include_tags:`bool`	Whether to include tags

overrides dulwich.client.GitClient.fetch

Fetch into a target repository from a bundle file.

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 bundle file.

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 bundle file.

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

overrides dulwich.client.GitClient.get_url

Get the URL for a bundle file path.

Parameters
path:`str`	Bundle file path

Returns
`str`	The path unchanged (bundle files use local paths)

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 is not supported for bundle files.

@classmethod

def _is_bundle_file(cls, path: str) -> bool: ¶

Check if a file is a git bundle by reading the first line.

@classmethod

def _open_bundle(cls, path: str | bytes) -> Bundle: ¶

Open and parse a bundle file.

Parameters
path:`str \| bytes`	Path to the bundle file (bytes or str)

Returns
`Bundle`	Bundle object with parsed metadata

Raises
`AssertionError`	If bundle format is unsupported

@staticmethod

def _skip_to_pack_data(f: IO[bytes], version: int): ¶

Skip to the pack data section in a bundle file.

Parameters
f:`IO[bytes]`	File object positioned at the beginning of the bundle
version:`int`	Bundle format version (2 or 3)

Raises
`AssertionError`	If bundle header is invalid

_include_tags = ¶

Undocumented

_quiet = ¶

Undocumented

_report_activity = ¶

overrides dulwich.client.GitClient._report_activity

Undocumented