dulwich.objects.Commit

class documentation

class Commit(ShaFile):

Constructors: Commit.from_path(path, sha, object_format), Commit()

A git commit object.

Class Method	`from_path`	Read a commit from a file on disk.
Method	`__init__`	Initialize an empty Commit.
Method	`check`	Check this object for internal consistency.
Method	`extract_signature`	Extract the payload, signature, and signature type from this commit.
Method	`raw_without_sig`	Return raw string serialization without the GPG/SSH signature.
Class Variable	`__slots__`	Undocumented
Class Variable	`author`	Undocumented
Class Variable	`author_time`	Undocumented
Class Variable	`author_timezone`	Undocumented
Class Variable	`commit_time`	Undocumented
Class Variable	`commit_timezone`	Undocumented
Class Variable	`committer`	Undocumented
Class Variable	`encoding`	Undocumented
Class Variable	`gpgsig`	Undocumented
Class Variable	`mergetag`	Undocumented
Class Variable	`message`	Undocumented
Class Variable	`parents`	Undocumented
Class Variable	`tree`	Undocumented
Class Variable	`type_name`	Undocumented
Class Variable	`type_num`	Undocumented
Method	`_deserialize`	Undocumented
Method	`_get_parents`	Return a list of parents of this commit.
Method	`_serialize`	Undocumented
Method	`_set_parents`	Set a list of parents of this commit.
Instance Variable	`_author`	Undocumented
Instance Variable	`_author_time`	Undocumented
Instance Variable	`_author_timezone_neg_utc`	Undocumented
Instance Variable	`_commit_time`	Undocumented
Instance Variable	`_commit_timezone_neg_utc`	Undocumented
Instance Variable	`_committer`	Undocumented
Instance Variable	`_encoding`	Undocumented
Instance Variable	`_extra`	Undocumented
Instance Variable	`_gpgsig`	Undocumented
Instance Variable	`_mergetag`	Undocumented
Instance Variable	`_message`	Undocumented
Instance Variable	`_needs_serialization`	Undocumented
Instance Variable	`_parents`	Undocumented
Instance Variable	`_tree`	Undocumented

Inherited from ShaFile:

Class Method	`from_file`	Get the contents of a SHA file on disk.
Class Method	`from_string`	Create a ShaFile from a string.
Static Method	`from_raw_chunks`	Creates an object of the indicated type from the raw chunks given.
Static Method	`from_raw_string`	Creates an object of the indicated type from the raw string given.
Method	`__bytes__`	Return raw string serialization of this object.
Method	`__eq__`	Return True if the SHAs of the two objects match.
Method	`__hash__`	Return unique hash for this object.
Method	`__le__`	Check whether SHA of this object is less than or equal to the other.
Method	`__lt__`	Return whether SHA of this object is less than the other.
Method	`__ne__`	Check whether this object does not match the other.
Method	`__repr__`	Return string representation of this object.
Method	`as_legacy_object`	Return string representing the object in the experimental format.
Method	`as_legacy_object_chunks`	Return chunks representing the object in the experimental format.
Method	`as_pretty_string`	Return a string representing this object, fit for display.
Method	`as_raw_chunks`	Return chunks with serialization of the object.
Method	`as_raw_string`	Return raw string with serialization of the object.
Method	`copy`	Create a new copy of this SHA1 object from its raw string.
Method	`get_id`	Get the hex SHA of this object using the specified hash algorithm.
Method	`raw_length`	Returns the length of the raw string of this object.
Method	`set_raw_chunks`	Set the contents of this object from a list of chunks.
Method	`set_raw_string`	Set the contents of this object from a serialized string.
Method	`sha`	The SHA object that is the name of this object.
Instance Variable	`object_format`	Undocumented
Property	`id`	The hex SHA1 of this object.
Class Method	`_is_legacy_object`	Undocumented
Class Method	`_parse_file`	Undocumented
Static Method	`_parse_legacy_object_header`	Parse a legacy object, creating it but not reading the file.
Static Method	`_parse_object_header`	Parse a new style object, creating it but not reading the file.
Method	`_check_has_member`	Check that the object has a given member variable.
Method	`_header`	Undocumented
Method	`_parse_legacy_object`	Parse a legacy object, setting the raw string.
Method	`_parse_object`	Parse a new style object, setting self._text.
Instance Variable	`_chunked_text`	Undocumented
Instance Variable	`_sha`	Undocumented

@classmethod

def from_path(cls, path: str | bytes, sha: ObjectID | None = None, *, object_format: ObjectFormat | None = None) -> Commit: ¶

overrides dulwich.objects.ShaFile.from_path

Read a commit from a file on disk.

Parameters
path:`str \| bytes`	Path to the commit file
sha:`ObjectID \| None`	Optional known SHA for the object
object_format:`ObjectFormat \| None`	Optional object format to use

Returns
`Commit`	A Commit object

Raises
`NotCommitError`	If the file is not a commit

def __init__(self): ¶

overrides dulwich.objects.ShaFile.__init__

Initialize an empty Commit.

def check(self): ¶

overrides dulwich.objects.ShaFile.check

Check this object for internal consistency.

Raises
`ObjectFormatException`	if the object is malformed in some way

def extract_signature(self) -> tuple[bytes, bytes | None, bytes | None]: ¶

Extract the payload, signature, and signature type from this commit.

Returns
`tuple of (payload, signature, signature_type) where`	`payload`: The raw commit data without the signature `signature`: The signature bytes if present, None otherwise `signature_type`: SIGNATURE_PGP for PGP, SIGNATURE_SSH for SSH, None if no signature

Raises
`ObjectFormatException`	If signature has unknown format

def raw_without_sig(self) -> bytes: ¶

Return raw string serialization without the GPG/SSH signature.

self.gpgsig is a signature for the returned raw byte string serialization.

__slots__: tuple[str, ...] = ¶

overrides dulwich.objects.ShaFile.__slots__

Undocumented

author = ¶

Undocumented

author_time = ¶

Undocumented

author_timezone = ¶

Undocumented

commit_time = ¶

Undocumented

commit_timezone = ¶

Undocumented

committer = ¶

Undocumented

encoding = ¶

Undocumented

gpgsig = ¶

Undocumented

mergetag = ¶

Undocumented

message = ¶

Undocumented

parents = ¶

Undocumented

tree = ¶

Undocumented

type_name: bytes = ¶

overrides dulwich.objects.ShaFile.type_name

Undocumented

type_num: int = ¶

overrides dulwich.objects.ShaFile.type_num

Undocumented

def _deserialize(self, chunks: list[bytes]): ¶

overrides dulwich.objects.ShaFile._deserialize

Undocumented

def _get_parents(self) -> list[ObjectID]: ¶

Return a list of parents of this commit.

def _serialize(self) -> list[bytes]: ¶

overrides dulwich.objects.ShaFile._serialize

Undocumented

def _set_parents(self, value: list[ObjectID]): ¶

Set a list of parents of this commit.

_author = ¶

Undocumented

_author_time = ¶

Undocumented

_author_timezone_neg_utc: bool | None = ¶

Undocumented

_commit_time = ¶

Undocumented

_commit_timezone_neg_utc: bool | None = ¶

Undocumented

_committer = ¶

Undocumented

_encoding: bytes | None = ¶

Undocumented

_extra: list[tuple[bytes, bytes]] = ¶

Undocumented

_gpgsig: bytes | None = ¶

Undocumented

_mergetag: list[Tag] = ¶

Undocumented

_message = ¶

Undocumented

_needs_serialization: bool = ¶

overrides dulwich.objects.ShaFile._needs_serialization

Undocumented

_parents: list[ObjectID] = ¶

Undocumented

_tree = ¶

Undocumented