# `gbp.pkg.pristinetar.PristineTar(Command)` class documentation

Part of `gbp.pkg.pristinetar` (View In Hierarchy)

Known subclasses: gbp.deb.pristinetar.DebianPristineTar

The pristine-tar branch in a git repository

Class Variable | branch | Undocumented
Method | __init__ | Undocumented
Instance Variable | repo | Undocumented
Method | has_feature_verify | Does this pristine-tar support tarball verification
Method | has_feature_sig | Does this pristine-tar support detached upstream signatures
Method | has_commit | Do we have a pristine-tar commit for a package matching archive_regexp.
Method | get_commit | Get the pristine-tar commit of a package matching archive_regexp. Checks also whether the commit contains a signature file.
Method | checkout | Checkout an orig archive from pristine-tar branch
Instance Variable | run_error | Undocumented
Method | commit | Commit an archive archive to the pristine tar branch using upstream branch ${upstream}.
Method | verify | Verify an archive's archive checksum using to the pristine tar branch
Method | _has_in_output | Check if pristine_tar has a certain feature enabled.
Method | _commit_contains_file | Does the given commit contain a file with the given regex

Inherited from Command:

Instance Variable | cmd | Undocumented
Instance Variable | args | Undocumented
Instance Variable | shell | Undocumented
Instance Variable | capture_stdout | Undocumented
Instance Variable | capture_stderr | Undocumented
Instance Variable | cwd | Undocumented
Instance Variable | env | Undocumented
Instance Variable | retcode | Undocumented
Instance Variable | stdout | Undocumented
Instance Variable | stderr | Undocumented
Instance Variable | err_reason | Undocumented
Method | __call__ | Run the command and raise exception on errors
Method | call | Like `__call__` but let the caller handle the return status.
Static Method | _f | Build error string template
Method | _reset_state | Undocumented
Method | __call | Wraps subprocess.call so we can be verbose and fix Python's SIGPIPE handling
Method | _log_err | Log an error message
Method | _format_err | Log an error message

branch =
Undocumented
(type: `str`)
def __init__(self, repo):
overrides gbp.command_wrappers.Command.__init__
Undocumented
repo =
Undocumented
def _has_in_output(self, match):

Check if pristine_tar has a certain feature enabled.

Parameters | feature | feature / command option to check (type: `str`)
Returns | True if feature is supported (type: `bool`)

def has_feature_verify(self):

Does this pristine-tar support tarball verification

def has_feature_sig(self):

Does this pristine-tar support detached upstream signatures

def has_commit(self, archive_regexp):
overridden in gbp.deb.pristinetar.DebianPristineTar

Do we have a pristine-tar commit for a package matching archive_regexp.

Parameters | archive_regexp | archive name to look for (regexp wildcards allowed) (type: `str`)

def _commit_contains_file(self, commit, regexp):

Does the given commit contain a file with the given regex

def get_commit(self, archive_regexp):

Get the pristine-tar commit of a package matching archive_regexp. Checks also whether the commit contains a signature file.

Parameters | archive_regexp | archive name to look for (regexp wildcards allowed) (type: `str`)
Returns | Commit, True if commit contains a signature file (type: `tuple` of `str` and `bool`)

def checkout(self, archive, quiet=(False), signaturefile=None):
overridden in gbp.deb.pristinetar.DebianPristineTar

Checkout an orig archive from pristine-tar branch

Parameters | archive | the name of the orig archive (type: `str`)

run_error =
Undocumented
def commit(self, archive, upstream, quiet=(False), signaturefile=None):

Commit an archive archive to the pristine tar branch using upstream branch ${upstream}.

Parameters | archive | the archive to commit (type: `str`)
| upstream | the upstream branch to diff against (type: `str`)

def verify(self, archive, quiet=(False)):

Verify an archive's archive checksum using to the pristine tar branch