# `gbp.pkg.upstreamsource.UpstreamSource(object)` class documentation

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

Known subclasses: gbp.deb.upstreamsource.DebianUpstreamSource, gbp.rpm.RpmUpstreamSource

Upstream source. Can be either an unpacked dir, a tarball or another type of archive

Method | __init__ | Undocumented
Instance Variable | unpacked | Undocumented
Method | __repr__ | Undocumented
Method | is_orig |
Method | is_dir |
Method | path | Undocumented
Method | signaturefile | Undocumented
Method | unpack | Unpack packed upstream sources into a given directory (filtering out files specified by filters) and determine the toplevel of the source tree.
Method | pack | Recreate a new archive from the current one
Static Method | known_compressions | Undocumented
Method | guess_version | Undocumented
Instance Variable | _orig | are the upstream sources already suitable as an upstream tarball
Instance Variable | _path | path to the upstream sources
Class Variable | _unpacked | path to the unpacked source tree
Instance Variable | _pkg_policy | Undocumented
Instance Variable | _sig | Undocumented
Method | _check_orig | Check if upstream source format can be used as orig tarball. This doesn't imply that the tarball is correctly named.
Method | _unpack_archive | Unpack packed upstream sources into a given directory allowing to filter out files in case of tar archives.
Method | _unpack_zip | Undocumented
Method | _unpacked_toplevel | unpacked archives can contain a leading directory or not
Method | _unpack_tar | Unpack a tarball to dir applying a list of filters. Leave the cleanup to the caller in case of an error.

_orig =
are the upstream sources already suitable as an upstream tarball
(type: boolean)
_path =
path to the upstream sources
(type: string)
_unpacked =
path to the unpacked source tree
(type: string)
def __init__(self, name, unpacked=None, pkg_policy=PkgPolicy, sig=None):
overridden in gbp.deb.upstreamsource.DebianUpstreamSource, gbp.rpm.RpmUpstreamSource
Undocumented
_pkg_policy =
Undocumented
unpacked =
Undocumented
_sig =
Undocumented
def __repr__(self):
Undocumented
def _check_orig(self):

Check if upstream source format can be used as orig tarball. This doesn't imply that the tarball is correctly named.

Returns | `True` if upstream source format is suitable as upstream tarball, `False` otherwise. (type: `bool`)

def is_orig(self):

Returns | `True` if sources are suitable as orig tarball, `False` otherwise (type: `bool`)

def is_dir(self):

Returns | `True` if if upstream sources are an unpacked directory, `False` otherwise (type: `bool`)

@property
def path(self):
Undocumented
@signaturefile.setter
def signaturefile(self, sig):
Undocumented
def unpack(self, dir, filters=None):
overridden in gbp.deb.upstreamsource.DebianAdditionalTarball

Unpack packed upstream sources into a given directory (filtering out files specified by filters) and determine the toplevel of the source tree.

def _unpack_archive(self, dir, filters):

Unpack packed upstream sources into a given directory allowing to filter out files in case of tar archives.

def _unpack_zip(self, dir):
Undocumented
def _unpacked_toplevel(self, dir):

unpacked archives can contain a leading directory or not

def _unpack_tar(self, dir, filters):

Unpack a tarball to dir applying a list of filters. Leave the cleanup to the caller in case of an error.

def pack(self, newarchive, filters=None):

Recreate a new archive from the current one

Parameters | newarchive | the name of the new archive (type: string)
| filters | tar filters to apply (type: array of strings)
Returns | the new upstream source (type: UpstreamSource)

@staticmethod
def known_compressions():
Undocumented
def guess_version(self, extra_regex=""""""):
Undocumented