dulwich.objects.Tag

class documentation

class Tag(ShaFile):

A Git Tag object.

Class Method	`from_path`	Open a SHA file from disk.
Method	`__init__`	Don't call this directly
Method	`check`	Check this object for internal consistency.
Method	`sign`	Undocumented
Method	`verify`	Verify GPG signature for this tag (if it is signed).
Class Variable	`__slots__`	Undocumented
Class Variable	`message`	Undocumented
Class Variable	`name`	Undocumented
Class Variable	`object`	Undocumented
Class Variable	`tag_time`	Undocumented
Class Variable	`tag_timezone`	Undocumented
Class Variable	`tagger`	Undocumented
Class Variable	`type_name`	Undocumented
Class Variable	`type_num`	Undocumented
Instance Variable	`signature`	Undocumented
Method	`_deserialize`	Grab the metadata attached to the tag
Method	`_get_object`	Get the object pointed to by this tag.
Method	`_serialize`	Undocumented
Method	`_set_object`	Undocumented
Instance Variable	`_needs_serialization`	Undocumented
Instance Variable	`_object_class`	Undocumented
Instance Variable	`_object_sha`	Undocumented
Instance Variable	`_signature`	Undocumented
Instance Variable	`_tag_time`	Undocumented
Instance Variable	`_tag_timezone`	Undocumented
Instance Variable	`_tag_timezone_neg_utc`	Undocumented
Instance Variable	`_tagger`	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__`	Undocumented
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	`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 SHA1 object that is the name of this object.
Property	`id`	The hex SHA 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, filename): ¶

overrides dulwich.objects.ShaFile.from_path

Open a SHA file from disk.

def __init__(self): ¶

overrides dulwich.objects.ShaFile.__init__

Don't call this directly

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 sign(self, keyid=None): ¶

Undocumented

Parameters
keyid:`Optional[str]`	Undocumented

def verify(self, keyids=None): ¶

Verify GPG signature for this tag (if it is signed).

Parameters
keyids:`Optional[Iterable[str]]`	Optional iterable of trusted keyids for this tag. If this tag is not signed by any key in keyids verification will fail. If not specified, this function only verifies that the tag has a valid signature.
Raises
`gpg.errors.BadSignatures`	if GPG signature verification fails
`gpg.errors.MissingSignatures`	if tag was not signed by a key specified in keyids

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

overrides dulwich.objects.ShaFile.__slots__

Undocumented

message = ¶

Undocumented

name = ¶

Undocumented

object = ¶

Undocumented

tag_time = ¶

Undocumented

tag_timezone = ¶

Undocumented

tagger = ¶

Undocumented

type_name: bytes = ¶

overrides dulwich.objects.ShaFile.type_name

Undocumented

type_num: int = ¶

overrides dulwich.objects.ShaFile.type_num

Undocumented

signature = ¶

Undocumented

def _deserialize(self, chunks): ¶

overrides dulwich.objects.ShaFile._deserialize

Grab the metadata attached to the tag

def _get_object(self): ¶

Get the object pointed to by this tag.

Returns: tuple of (object class, sha).

def _serialize(self): ¶

overrides dulwich.objects.ShaFile._serialize

Undocumented

def _set_object(self, value): ¶

Undocumented

_needs_serialization: bool = ¶

overrides dulwich.objects.ShaFile._needs_serialization

Undocumented

_object_class = ¶

Undocumented

_object_sha = ¶

Undocumented

_signature = ¶

Undocumented

_tag_time = ¶

Undocumented

_tag_timezone = ¶

Undocumented

_tag_timezone_neg_utc: bool = ¶

Undocumented

_tagger = ¶

Undocumented