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

@cvar _orig: are the upstream sources already suitable as an upstream
             tarball
@type _orig: boolean
@cvar _path: path to the upstream sources
@type _path: string
@cvar _unpacked: path to the unpacked source tree
@type _unpacked: string
Method __init__ Undocumented
Method is_orig @return: C{True} if sources are suitable as orig tarball, C{False} otherwise @rtype: C{bool}
Method is_dir @return: C{True} if if upstream sources are an unpacked directory, C{False} otherwise @rtype: C{bool}
Method path 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
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 I{dir} applying a list of I{filters}. Leave the cleanup to the caller in case of an error.
def __init__(self, name, unpacked=None, pkg_policy=PkgPolicy):
overridden in gbp.deb.upstreamsource.DebianUpstreamSource, gbp.rpm.RpmUpstreamSource
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.

@return: C{True} if upstream source format is suitable
    as upstream tarball, C{False} otherwise.
@rtype: C{bool}
def is_orig(self): 
@return: C{True} if sources are suitable as orig tarball,
    C{False} otherwise
@rtype: C{bool}
def is_dir(self): 
@return: C{True} if if upstream sources are an unpacked directory,
    C{False} otherwise
@rtype: C{bool}
@property
def path(self):
Undocumented
def unpack(self, dir, filters=None): 
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 I{dir} applying a list of I{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

@param newarchive: the name of the new archive
@type newarchive: string
@param filters: tar filters to apply
@type filters: array of strings
@return: the new upstream source
@rtype: UpstreamSource
@staticmethod
def known_compressions():
Undocumented
def guess_version(self, extra_regex=''):
Undocumented
API Documentation for git-buildpackage, generated by pydoctor at 2019-09-07 17:58:51.