dulwich.notes.Notes

class documentation

class Notes:

High-level interface for Git notes operations.

Method	`__init__`	Initialize Notes.
Method	`get_note`	Get the note for an object.
Method	`get_notes_ref`	Get the notes reference to use.
Method	`list_notes`	List all notes in a notes ref.
Method	`remove_note`	Remove a note for an object.
Method	`set_note`	Set or update a note for an object.
Instance Variable	`_object_store`	Undocumented
Instance Variable	`_refs`	Undocumented

def __init__(self, object_store: BaseObjectStore, refs_container: RefsContainer): ¶

Initialize Notes.

Parameters
object_store:`BaseObjectStore`	Object store to read/write objects
refs_container:`RefsContainer`	Refs container to read/write refs

def get_note(self, object_sha: bytes, notes_ref: bytes | None = None, config: StackedConfig | None = None) -> bytes | None: ¶

Get the note for an object.

Parameters
object_sha:`bytes`	SHA of the object to get notes for
notes_ref:`bytes \| None`	The notes ref to use, or None to use the default
config:`StackedConfig \| None`	Config to read notes.displayRef from

Returns
`bytes \| None`	The note content as bytes, or None if no note exists

def get_notes_ref(self, notes_ref: bytes | None = None, config: StackedConfig | None = None) -> Ref: ¶

Get the notes reference to use.

Parameters
notes_ref:`bytes \| None`	The notes ref to use, or None to use the default
config:`StackedConfig \| None`	Config to read notes.displayRef from

Returns
`Ref`	The notes reference name

def list_notes(self, notes_ref: bytes | None = None, config: StackedConfig | None = None) -> list[tuple[ObjectID, bytes]]: ¶

List all notes in a notes ref.

Parameters
notes_ref:`bytes \| None`	The notes ref to use, or None to use the default
config:`StackedConfig \| None`	Config to read notes.displayRef from

Returns
`list[tuple[ObjectID, bytes]]`	List of tuples of (object_sha, note_content)

Remove a note for an object.

Parameters
object_sha:`bytes`	SHA of the object to remove notes from
notes_ref:`bytes \| None`	The notes ref to use, or None to use the default
author:`bytes \| None`	Author identity (defaults to committer)
committer:`bytes \| None`	Committer identity (defaults to config)
message:`bytes \| None`	Commit message for the notes removal
config:`StackedConfig \| None`	Config to read user identity and notes.displayRef from

Returns
`bytes \| None`	SHA of the new notes commit, or None if no note existed

Set or update a note for an object.

Parameters
object_sha:`bytes`	SHA of the object to annotate
note_content:`bytes`	Content of the note
notes_ref:`bytes \| None`	The notes ref to use, or None to use the default
author:`bytes \| None`	Author identity (defaults to committer)
committer:`bytes \| None`	Committer identity (defaults to config)
message:`bytes \| None`	Commit message for the notes update
config:`StackedConfig \| None`	Config to read user identity and notes.displayRef from

Returns
`bytes`	SHA of the new notes commit

_object_store = ¶

Undocumented

_refs = ¶

Undocumented