Class ArchSourceTree

Find a pristine copy of a file for a given revision.

Will create the requested revision in the library or in the
current tree pristines if needed.

:param name: name of the file.
:type name: str
:param revision: revision to look for the file into.
:type revision: `Revision`
:return: absolute path name of a pristine copy of the file.
:rtype: `pathname.PathName`
:raise errors.MissingFileError: file is not source or is not
    present in the specified revision.

Read a file id set by an explicit id tag or tagline.

FIXME: update docstring when support for pybaz<1.3 is dropped, as this
release fixed "baz id" to report name-based ids correctly.

:param name: name of a source file relative to the tree-root.
:type name: str
:return: file id if the file has an explicit id or a tagline.
:rtype: str

Default version of the tree, also called tree-version.

:raise errors.TreeVersionError: no valid default version set.
:raise IOError: unable to read the ++default-version file.

Deprecated.

Inventory of the source tree as a list.

:see: `iter_inventory`

Tree inventory.

The kind of files looked for is specified by setting to
``True`` exactly one of the following keyword arguments:

    ``source``, ``precious``, ``backups``, ``junk``,
    ``unrecognized``, ``trees``.

If the ``trees`` argument is not set, whether files, directory
or both should be listed is specified by setting to ``True``
exactly one of the following keyword arguments:

    ``directories``, ``files``, ``both``.

:keyword source: list source files only.
:keyword precious: list precious files only.
:keyword backups: list backup files only.
:keyword junk: list junk files only.
:keyword unrecognized: list unrecognized files only.
:keyword trees: list nested trees only. If this is true, the
    iterator wil only yield `ArchSourceTree` objects.

:keyword directories: list directories only,
    yield only `FileName` objects.
:keyword files: list files only, yield only `DirName` objects.
:keyword both: list both files and directories,
    yield both FileName and `DirName` objects.

:keyword name: do inventory as if the id-tagging-method was
    set to ``names``. That is useful to ignore
    ``untagged-source`` classification.

:keyword limit: restrict the inventory to this directory. Must
    be the name of a directory relative to the tree root.

:rtype: iterable of `FileName`, `DirName`, `ArchSourceTree`
    according to the arguments.

Tree inventory with file ids.

:see: `ArchSourceTree.iter_inventory`

:rtype: iterable of tuples ``(id, item)``, where ``item`` is
    `FileName`, `DirName`, `ArchSourceTree` according to the
    arguments and ``id`` is the associated inventory id.

Iterate over versions this tree has a log-version for.

:param limit: only iterate log-versions in this namespace.
:type limit: `Archive`, `Category`, `Branch`, `Version`
:param reverse: yield log-versions in reverse order.
:type reverse: bool

Iterate over patchlogs present in this tree.

:param version: list patchlogs from this version. Defaults to
    the tree-version.
:type version: `Version`
:param reverse: iterate more recent logs first.
:type reverse: bool
:return: patchlogs from ``version``.
:rtype: iterator of `Patchlog`.
:raise errors.TreeVersionError: no valid default version set.
:raise IOError: unable to read the ++default-version file.

tagging_method

Get Method:

pybaz.ArchSourceTree.get_tagging_method(self)

tree_revision

Revision of the last patchlog for the tree-version.

:raise errors.TreeVersionError: no valid default version set.
:raise IOError: unable to read the ++default-version file.

Get Method:

pybaz.ArchSourceTree._get_tree_revision(self) - Revision of the last patchlog for the tree-version.

tree_version

Default version of the tree, also called tree-version.

:raise errors.TreeVersionError: no valid default version set.
:raise IOError: unable to read the ++default-version file.

Get Method:

pybaz.ArchSourceTree.get_tree_version(self) - Default version of the tree, also called tree-version.