dulwich package¶

Python implementation of the Git file formats and protocols.

Subpackages¶

Submodules¶

dulwich.archive module
- ChunkedBytesIO
  - ChunkedBytesIO.read()
- tar_stream()
dulwich.bundle module
- Bundle
- read_bundle()
- write_bundle()
dulwich.cli module
- Command
  - Command.run()
- SuperCommand
  - SuperCommand.default_command
  - SuperCommand.run()
  - SuperCommand.subcommands
- cmd_add
  - cmd_add.run()
- cmd_archive
  - cmd_archive.run()
- cmd_check_ignore
  - cmd_check_ignore.run()
- cmd_check_mailmap
  - cmd_check_mailmap.run()
- cmd_clone
  - cmd_clone.run()
- cmd_commit
  - cmd_commit.run()
- cmd_commit_tree
  - cmd_commit_tree.run()
- cmd_daemon
  - cmd_daemon.run()
- cmd_describe
  - cmd_describe.run()
- cmd_diff
  - cmd_diff.run()
- cmd_diff_tree
  - cmd_diff_tree.run()
- cmd_dump_index
  - cmd_dump_index.run()
- cmd_dump_pack
  - cmd_dump_pack.run()
- cmd_fetch
  - cmd_fetch.run()
- cmd_fetch_pack
  - cmd_fetch_pack.run()
- cmd_fsck
  - cmd_fsck.run()
- cmd_help
  - cmd_help.run()
- cmd_init
  - cmd_init.run()
- cmd_log
  - cmd_log.run()
- cmd_ls_files
  - cmd_ls_files.run()
- cmd_ls_remote
  - cmd_ls_remote.run()
- cmd_ls_tree
  - cmd_ls_tree.run()
- cmd_pack_objects
  - cmd_pack_objects.run()
- cmd_pull
  - cmd_pull.run()
- cmd_push
  - cmd_push.run()
- cmd_receive_pack
  - cmd_receive_pack.run()
- cmd_remote
  - cmd_remote.subcommands
- cmd_remote_add
  - cmd_remote_add.run()
- cmd_repack
  - cmd_repack.run()
- cmd_reset
  - cmd_reset.run()
- cmd_rev_list
  - cmd_rev_list.run()
- cmd_rm
  - cmd_rm.run()
- cmd_show
  - cmd_show.run()
- cmd_stash
  - cmd_stash.subcommands
- cmd_stash_list
  - cmd_stash_list.run()
- cmd_stash_pop
  - cmd_stash_pop.run()
- cmd_stash_push
  - cmd_stash_push.run()
- cmd_status
  - cmd_status.run()
- cmd_submodule
  - cmd_submodule.default_command
  - cmd_submodule.subcommands
- cmd_submodule_init
  - cmd_submodule_init.run()
- cmd_submodule_list
  - cmd_submodule_list.run()
- cmd_symbolic_ref
  - cmd_symbolic_ref.run()
- cmd_tag
  - cmd_tag.run()
- cmd_update_server_info
  - cmd_update_server_info.run()
- cmd_upload_pack
  - cmd_upload_pack.run()
- cmd_web_daemon
  - cmd_web_daemon.run()
- cmd_write_tree
  - cmd_write_tree.run()
- main()
- signal_int()
- signal_quit()
dulwich.client module
- AbstractHttpGitClient
  - AbstractHttpGitClient.fetch_pack()
  - AbstractHttpGitClient.from_parsedurl()
  - AbstractHttpGitClient.get_refs()
  - AbstractHttpGitClient.get_url()
  - AbstractHttpGitClient.send_pack()
- FetchPackResult
  - FetchPackResult.refs
  - FetchPackResult.symrefs
  - FetchPackResult.agent
- GitClient
  - GitClient.archive()
  - GitClient.clone()
  - GitClient.fetch()
  - GitClient.fetch_pack()
  - GitClient.from_parsedurl()
  - GitClient.get_refs()
  - GitClient.get_url()
  - GitClient.send_pack()
- HTTPProxyUnauthorized
- HTTPUnauthorized
- HttpGitClient
- InvalidWants
- LocalGitClient
  - LocalGitClient.fetch()
  - LocalGitClient.fetch_pack()
  - LocalGitClient.from_parsedurl()
  - LocalGitClient.get_refs()
  - LocalGitClient.get_url()
  - LocalGitClient.send_pack()
- PLinkSSHVendor
  - PLinkSSHVendor.run_command()
- ParamikoSSHVendor()
- ReportStatusParser
  - ReportStatusParser.check()
  - ReportStatusParser.handle_packet()
- SSHGitClient
  - SSHGitClient.from_parsedurl()
  - SSHGitClient.get_url()
- SSHVendor
  - SSHVendor.run_command()
- SendPackResult
  - SendPackResult.refs
  - SendPackResult.agent
  - SendPackResult.ref_status
- StrangeHostname
- SubprocessGitClient
  - SubprocessGitClient.from_parsedurl()
  - SubprocessGitClient.git_command
- SubprocessSSHVendor
  - SubprocessSSHVendor.run_command()
- SubprocessWrapper
  - SubprocessWrapper.can_read()
  - SubprocessWrapper.close()
  - SubprocessWrapper.stderr
- TCPGitClient
  - TCPGitClient.from_parsedurl()
  - TCPGitClient.get_url()
- TraditionalGitClient
  - TraditionalGitClient.DEFAULT_ENCODING
  - TraditionalGitClient.archive()
  - TraditionalGitClient.fetch_pack()
  - TraditionalGitClient.get_refs()
  - TraditionalGitClient.send_pack()
- Urllib3HttpGitClient
- check_for_proxy_bypass()
- check_wants()
- default_local_git_client_cls
- default_urllib3_manager()
- default_user_agent_string()
- find_git_command()
- get_credentials_from_store()
- get_ssh_vendor
- get_transport_and_path()
- get_transport_and_path_from_url()
- parse_rsync_url()
- read_pkt_refs()
dulwich.config module
- CaseInsensitiveOrderedMultiDict
- Config
- ConfigDict
- ConfigFile
- StackedConfig
- apply_instead_of()
- get_win_system_paths()
- get_xdg_config_home_path()
- iter_instead_of()
- lower_key()
- parse_submodules()
- read_submodules()
dulwich.credentials module
- match_partial_url()
- match_urls()
- urlmatch_credential_sections()
dulwich.diff_tree module
- RenameDetector
  - RenameDetector.changes_with_renames()
- TreeChange
  - TreeChange.add()
  - TreeChange.delete()
- tree_changes()
- tree_changes_for_merge()
- walk_trees()
dulwich.errors module
- ApplyDeltaError
- ChecksumMismatch
- CommitError
- FileFormatException
- GitProtocolError
- HangupException
- HookError
- MissingCommitError
- NoIndexPresent
- NotBlobError
  - NotBlobError.type_name
- NotCommitError
  - NotCommitError.type_name
- NotGitRepository
- NotTagError
  - NotTagError.type_name
- NotTreeError
  - NotTreeError.type_name
- ObjectFormatException
- ObjectMissing
- PackedRefsException
- RefFormatError
- SendPackError
- UnexpectedCommandError
- UpdateRefsError
- WrongObjectException
dulwich.fastexport module
- GitFastExporter
- GitImportProcessor
- split_email()
dulwich.file module
- FileLocked
- GitFile()
- ensure_dir_exists()
dulwich.graph module
- can_fast_forward()
- find_merge_base()
- find_octopus_base()
dulwich.greenthreads module
dulwich.hooks module
- CommitMsgShellHook
- Hook
  - Hook.execute()
- PostCommitShellHook
- PostReceiveShellHook
  - PostReceiveShellHook.execute()
- PreCommitShellHook
- ShellHook
  - ShellHook.execute()
dulwich.ignore module
- IgnoreFilter
- IgnoreFilterManager
- IgnoreFilterStack
  - IgnoreFilterStack.is_ignored()
- Pattern
  - Pattern.match()
- default_user_ignore_filter_path()
- match_pattern()
- read_ignore_patterns()
- translate()
dulwich.index module
- Index
  - Index.changes_from_tree()
  - Index.clear()
  - Index.commit()
  - Index.get_mode()
  - Index.get_sha1()
  - Index.items()
  - Index.iteritems()
  - Index.iterobjects()
  - Index.path
  - Index.read()
  - Index.update()
  - Index.write()
- IndexEntry
  - IndexEntry.ctime
  - IndexEntry.dev
  - IndexEntry.extended_flags
  - IndexEntry.flags
  - IndexEntry.gid
  - IndexEntry.ino
  - IndexEntry.mode
  - IndexEntry.mtime
  - IndexEntry.sha
  - IndexEntry.size
  - IndexEntry.uid
- UnsupportedIndexFormat
- blob_from_path_and_mode()
- blob_from_path_and_stat()
- build_file_from_blob()
- build_index_from_tree()
- changes_from_tree()
- cleanup_mode()
- commit_index()
- commit_tree()
- get_unstaged_changes()
- index_entry_from_directory()
- index_entry_from_path()
- index_entry_from_stat()
- iter_fresh_entries()
- iter_fresh_objects()
- locked_index
- pathjoin()
- pathsplit()
- read_cache_entry()
- read_cache_time()
- read_index()
- read_index_dict()
- read_submodule_head()
- refresh_index()
- validate_path()
- validate_path_element_default()
- validate_path_element_ntfs()
- write_cache_entry()
- write_cache_time()
- write_index()
- write_index_dict()
dulwich.lfs module
- LFSStore
dulwich.line_ending module
- BlobNormalizer
  - BlobNormalizer.checkin_normalize()
  - BlobNormalizer.checkout_normalize()
- TreeBlobNormalizer
  - TreeBlobNormalizer.checkin_normalize()
- convert_crlf_to_lf()
- convert_lf_to_crlf()
- get_checkin_filter()
- get_checkin_filter_autocrlf()
- get_checkout_filter()
- get_checkout_filter_autocrlf()
- normalize_blob()
dulwich.log_utils module
- default_logging_config()
- remove_null_handler()
dulwich.lru_cache module
- LRUCache
- LRUSizeCache
dulwich.mailmap module
- Mailmap
- parse_identity()
- read_mailmap()
dulwich.object_store module
- BaseObjectStore
- BucketBasedObjectStore
  - BucketBasedObjectStore.add_pack()
- DiskObjectStore
- MemoryObjectStore
- MissingObjectFinder
  - MissingObjectFinder.add_todo()
  - MissingObjectFinder.next()
- ObjectIterator
  - ObjectIterator.iterobjects()
- ObjectStoreGraphWalker
- ObjectStoreIterator
  - ObjectStoreIterator.iterobjects()
  - ObjectStoreIterator.itershas()
- OverlayObjectStore
- PackBasedObjectStore
- commit_tree_changes()
- read_packs_file()
- tree_lookup_path()
dulwich.objects module
- Blob
  - Blob.check()
  - Blob.chunked
  - Blob.data
  - Blob.from_path()
  - Blob.splitlines()
  - Blob.type_name
  - Blob.type_num
- Commit
  - Commit.author
  - Commit.author_time
  - Commit.author_timezone
  - Commit.check()
  - Commit.commit_time
  - Commit.commit_timezone
  - Commit.committer
  - Commit.encoding
  - Commit.extra
  - Commit.from_path()
  - Commit.gpgsig
  - Commit.mergetag
  - Commit.message
  - Commit.parents
  - Commit.sign()
  - Commit.tree
  - Commit.type_name
  - Commit.type_num
  - Commit.verify()
- EmptyFileException
- FixedSha
  - FixedSha.digest()
  - FixedSha.hexdigest()
- S_ISGITLINK()
- ShaFile
  - ShaFile.as_legacy_object()
  - ShaFile.as_legacy_object_chunks()
  - ShaFile.as_pretty_string()
  - ShaFile.as_raw_chunks()
  - ShaFile.as_raw_string()
  - ShaFile.check()
  - ShaFile.copy()
  - ShaFile.from_file()
  - ShaFile.from_path()
  - ShaFile.from_raw_chunks()
  - ShaFile.from_raw_string()
  - ShaFile.from_string()
  - ShaFile.id
  - ShaFile.raw_length()
  - ShaFile.set_raw_chunks()
  - ShaFile.set_raw_string()
  - ShaFile.sha()
  - ShaFile.type_name
  - ShaFile.type_num
- SubmoduleEncountered
- Tag
  - Tag.check()
  - Tag.from_path()
  - Tag.message
  - Tag.name
  - Tag.object
  - Tag.sign()
  - Tag.signature
  - Tag.tag_time
  - Tag.tag_timezone
  - Tag.tagger
  - Tag.type_name
  - Tag.type_num
  - Tag.verify()
- Tree
  - Tree.add()
  - Tree.as_pretty_string()
  - Tree.check()
  - Tree.from_path()
  - Tree.items()
  - Tree.iteritems()
  - Tree.lookup_path()
  - Tree.type_name
  - Tree.type_num
- TreeEntry
  - TreeEntry.in_path()
- check_hexsha()
- check_identity()
- check_time()
- cls
- filename_to_hex()
- format_timezone()
- git_line()
- hex_to_filename()
- hex_to_sha()
- key_entry()
- key_entry_name_order()
- object_class()
- object_header()
- parse_commit()
- parse_time_entry()
- parse_timezone()
- parse_tree()
- pretty_format_tree_entry()
- serializable_property()
- serialize_tree()
- sha_to_hex()
- sorted_tree_items()
- valid_hexsha()
dulwich.objectspec module
- AmbiguousShortId
- parse_commit()
- parse_commit_range()
- parse_object()
- parse_ref()
- parse_refs()
- parse_reftuple()
- parse_reftuples()
- parse_tree()
- scan_for_short_id()
- to_bytes()
dulwich.pack module
- DeltaChainIterator
  - DeltaChainIterator.ext_refs()
  - DeltaChainIterator.for_pack_data()
  - DeltaChainIterator.record()
  - DeltaChainIterator.set_pack_data()
- FilePackIndex
  - FilePackIndex.calculate_checksum()
  - FilePackIndex.check()
  - FilePackIndex.close()
  - FilePackIndex.get_pack_checksum()
  - FilePackIndex.get_stored_checksum()
  - FilePackIndex.iterentries()
  - FilePackIndex.object_index()
  - FilePackIndex.path
- MemoryPackIndex
  - MemoryPackIndex.get_pack_checksum()
  - MemoryPackIndex.iterentries()
  - MemoryPackIndex.object_index()
  - MemoryPackIndex.object_sha1()
- Pack
  - Pack.check()
  - Pack.check_length_and_checksum()
  - Pack.close()
  - Pack.data
  - Pack.entries()
  - Pack.from_lazy_objects()
  - Pack.from_objects()
  - Pack.get_raw()
  - Pack.get_raw_unresolved()
  - Pack.get_ref()
  - Pack.get_stored_checksum()
  - Pack.index
  - Pack.iterobjects()
  - Pack.keep()
  - Pack.name()
  - Pack.pack_tuples()
  - Pack.resolve_object()
  - Pack.sorted_entries()
- PackChunkGenerator
  - PackChunkGenerator.sha1digest()
- PackData
  - PackData.calculate_checksum()
  - PackData.check()
  - PackData.close()
  - PackData.create_index()
  - PackData.create_index_v1()
  - PackData.create_index_v2()
  - PackData.filename
  - PackData.from_file()
  - PackData.from_path()
  - PackData.get_compressed_data_at()
  - PackData.get_object_at()
  - PackData.get_stored_checksum()
  - PackData.iterentries()
  - PackData.iterobjects()
  - PackData.path
  - PackData.sorted_entries()
- PackFileDisappeared
- PackIndex
  - PackIndex.get_pack_checksum()
  - PackIndex.iterentries()
  - PackIndex.object_index()
  - PackIndex.object_sha1()
  - PackIndex.objects_sha1()
- PackIndex1
- PackIndex2
- PackIndexer
- PackInflater
- PackStreamCopier
  - PackStreamCopier.verify()
- PackStreamReader
  - PackStreamReader.offset
  - PackStreamReader.read()
  - PackStreamReader.read_objects()
  - PackStreamReader.recv()
- SHA1Reader
  - SHA1Reader.check_sha()
  - SHA1Reader.close()
  - SHA1Reader.read()
  - SHA1Reader.tell()
- SHA1Writer
  - SHA1Writer.close()
  - SHA1Writer.offset()
  - SHA1Writer.tell()
  - SHA1Writer.write()
  - SHA1Writer.write_sha()
- UnpackedObject
  - UnpackedObject.comp_chunks
  - UnpackedObject.crc32
  - UnpackedObject.decomp_chunks
  - UnpackedObject.decomp_len
  - UnpackedObject.delta_base
  - UnpackedObject.obj_chunks
  - UnpackedObject.obj_type_num
  - UnpackedObject.offset
  - UnpackedObject.pack_type_num
  - UnpackedObject.sha()
  - UnpackedObject.sha_file()
- apply_delta()
- bisect_find_sha()
- chunks_length()
- compute_file_sha()
- create_delta()
- deltify_pack_objects()
- iter_sha1()
- load_pack_index()
- load_pack_index_file()
- obj_sha()
- pack_header_chunks()
- pack_object_chunks()
- pack_object_header()
- pack_objects_to_data()
- read_pack_header()
- read_zlib_chunks()
- take_msb_bytes()
- unpack_object()
- write_pack()
- write_pack_data()
- write_pack_header()
- write_pack_index()
- write_pack_index_v1()
- write_pack_index_v2()
- write_pack_object()
- write_pack_objects()
dulwich.patch module
- gen_diff_header()
- get_summary()
- git_am_patch_split()
- is_binary()
- parse_patch_message()
- patch_filename()
- shortid()
- unified_diff()
- write_blob_diff()
- write_commit_patch()
- write_object_diff()
- write_tree_diff()
dulwich.porcelain module
- DivergedBranches
- Error
- GitStatus
  - GitStatus.staged
  - GitStatus.unstaged
  - GitStatus.untracked
- NoneStream
  - NoneStream.read()
  - NoneStream.readall()
  - NoneStream.readinto()
  - NoneStream.write()
- RemoteExists
- TimezoneFormatError
- active_branch()
- add()
- archive()
- branch_create()
- branch_delete()
- branch_list()
- check_diverged()
- check_ignore()
- check_mailmap()
- clean()
- clone()
- commit()
- commit_decode()
- commit_encode()
- commit_tree()
- daemon()
- describe()
- diff_tree()
- fetch()
- find_unique_abbrev()
- fsck()
- get_branch_remote()
- get_object_by_path()
- get_remote_repo()
- get_tree_changes()
- get_untracked_paths()
- get_user_timezones()
- init()
- log()
- ls_files()
- ls_remote()
- ls_tree()
- open_repo()
- open_repo_closing()
- pack_objects()
- parse_timezone_format()
- path_to_tree_path()
- print_commit()
- print_name_status()
- print_tag()
- pull()
- push()
- receive_pack()
- remote_add()
- remote_remove()
- remove()
- repack()
- reset()
- reset_file()
- rev_list()
- rm()
- show()
- show_blob()
- show_commit()
- show_object()
- show_tag()
- show_tree()
- stash_drop()
- stash_list()
- stash_pop()
- stash_push()
- status()
- submodule_add()
- submodule_init()
- submodule_list()
- symbolic_ref()
- tag_create()
- tag_delete()
- tag_list()
- update_head()
- update_server_info()
- upload_pack()
- web_daemon()
- write_tree()
dulwich.protocol module
- BufferedPktLineWriter
  - BufferedPktLineWriter.flush()
  - BufferedPktLineWriter.write()
- PktLineParser
  - PktLineParser.get_tail()
  - PktLineParser.parse()
- Protocol
  - Protocol.close()
  - Protocol.eof()
  - Protocol.read_cmd()
  - Protocol.read_pkt_line()
  - Protocol.read_pkt_seq()
  - Protocol.send_cmd()
  - Protocol.unread_pkt_line()
  - Protocol.write_pkt_line()
  - Protocol.write_sideband()
- ReceivableProtocol
  - ReceivableProtocol.read()
  - ReceivableProtocol.recv()
- ack_type()
- agent_string()
- capability_agent()
- capability_symref()
- extract_capabilities()
- extract_capability_names()
- extract_want_line_capabilities()
- format_ack_line()
- format_capability_line()
- format_cmd_pkt()
- format_ref_line()
- format_shallow_line()
- format_unshallow_line()
- parse_capability()
- parse_cmd_pkt()
- pkt_line()
- symref_capabilities()
dulwich.reflog module
- Entry
- drop_reflog_entry()
- format_reflog_line()
- parse_reflog_line()
- read_reflog()
dulwich.refs module
- DictRefsContainer
- DiskRefsContainer
- InfoRefsContainer
- RefsContainer
- SymrefLoop
- check_ref_format()
- is_local_branch()
- parse_symref_value()
- read_info_refs()
- read_packed_refs()
- read_packed_refs_with_peeled()
- strip_peeled_refs()
- write_info_refs()
- write_packed_refs()
dulwich.repo module
- BaseRepo
- InvalidUserIdentity
- MemoryRepo
- ParentsProvider
  - ParentsProvider.get_parents()
- Repo
- UnsupportedExtension
- UnsupportedVersion
- check_user_identity()
- get_user_identity()
- parse_graftpoints()
- read_gitfile()
- serialize_graftpoints()
dulwich.server module
- Backend
  - Backend.open_repository()
- BackendRepo
- DictBackend
  - DictBackend.open_repository()
- FileSystemBackend
  - FileSystemBackend.open_repository()
- Handler
  - Handler.handle()
- MultiAckDetailedGraphWalkerImpl
- MultiAckGraphWalkerImpl
- PackHandler
- ReceivePackHandler
  - ReceivePackHandler.capabilities()
  - ReceivePackHandler.handle()
- SingleAckGraphWalkerImpl
- TCPGitRequestHandler
  - TCPGitRequestHandler.handle()
- TCPGitServer
- UploadArchiveHandler
  - UploadArchiveHandler.handle()
- UploadPackHandler
- generate_info_refs()
- generate_objects_info_packs()
- main()
- serve_command()
- update_server_info()
dulwich.stash module
- Stash
dulwich.submodule module
- iter_cached_submodules()
dulwich.walk module
- WalkEntry
  - WalkEntry.changes()
- Walker
dulwich.web module
- ChunkReader
  - ChunkReader.read()
- GunzipFilter
- HTTPGitApplication
  - HTTPGitApplication.backend
  - HTTPGitApplication.services
- HTTPGitRequest
  - HTTPGitRequest.environ
  - HTTPGitRequest.add_header()
  - HTTPGitRequest.cache_forever()
  - HTTPGitRequest.error()
  - HTTPGitRequest.forbidden()
  - HTTPGitRequest.nocache()
  - HTTPGitRequest.not_found()
  - HTTPGitRequest.respond()
- LimitedInputFilter
- ServerHandlerLogger
  - ServerHandlerLogger.log_error()
  - ServerHandlerLogger.log_exception()
  - ServerHandlerLogger.log_message()
- WSGIRequestHandlerLogger
  - WSGIRequestHandlerLogger.handle()
  - WSGIRequestHandlerLogger.log_error()
  - WSGIRequestHandlerLogger.log_exception()
  - WSGIRequestHandlerLogger.log_message()
- WSGIServerLogger
  - WSGIServerLogger.handle_error()
- cache_forever_headers()
- date_time_string()
- get_idx_file()
- get_info_packs()
- get_info_refs()
- get_loose_object()
- get_pack_file()
- get_repo()
- get_text_file()
- handle_service_request()
- main()
- make_wsgi_chain()
- send_file()
- url_prefix()