diff options
| author | Michael Vogt <michael.vogt@ubuntu.com> | 2010-03-23 14:18:44 +0100 |
|---|---|---|
| committer | Michael Vogt <michael.vogt@ubuntu.com> | 2010-03-23 14:18:44 +0100 |
| commit | 37650a078f5504dfbc6622d2c06f4435a3302dd4 (patch) | |
| tree | 35d7df75535420cbe0712a5f7b7b66d61f5e44d1 /doc/source/apt | |
| parent | 2aa709e41d8896ef897863ea9181c409c4c87a8c (diff) | |
| parent | 3a08cfb10590d5cf5df1f45d94a424ef6a0f674b (diff) | |
| download | python-apt-37650a078f5504dfbc6622d2c06f4435a3302dd4.tar.gz | |
merged from lp:~mvo/python-apt/mvo
Diffstat (limited to 'doc/source/apt')
| -rw-r--r-- | doc/source/apt/cache.rst | 83 | ||||
| -rw-r--r-- | doc/source/apt/cdrom.rst | 7 | ||||
| -rw-r--r-- | doc/source/apt/debfile.rst | 39 | ||||
| -rw-r--r-- | doc/source/apt/index.rst | 61 | ||||
| -rw-r--r-- | doc/source/apt/package.rst | 111 | ||||
| -rw-r--r-- | doc/source/apt/progress.gtk2.rst | 29 | ||||
| -rw-r--r-- | doc/source/apt/progress.rst | 37 |
7 files changed, 0 insertions, 367 deletions
diff --git a/doc/source/apt/cache.rst b/doc/source/apt/cache.rst deleted file mode 100644 index beae74a2..00000000 --- a/doc/source/apt/cache.rst +++ /dev/null @@ -1,83 +0,0 @@ -:mod:`apt.cache` --- The Cache class -===================================== -.. automodule:: apt.cache - -The Cache class ---------------- - -.. autoclass:: Cache - :members: - :undoc-members: - - .. describe:: cache[pkgname] - - Return a :class:`Package()` for the package with the name *pkgname*. - -Example -^^^^^^^ - -The following example shows how to load the cache, update it, and upgrade -all the packages on the system:: - - import apt - import apt.progress - - # First of all, open the cache - cache = apt.Cache() - # Now, lets update the package list - cache.update() - # We need to re-open the cache because it needs to read the package list - cache.open(None) - # Now we can do the same as 'apt-get upgrade' does - cache.upgrade() - # or we can play 'apt-get dist-upgrade' - cache.upgrade(True) - # Q: Why does nothing happen? - # A: You forgot to call commit()! - cache.commit(apt.progress.TextFetchProgress(), - apt.progress.InstallProgress()) - - - -Working with Filters --------------------- -.. autoclass:: Filter - :members: - :inherited-members: - :undoc-members: - -.. autoclass:: MarkedChangesFilter - :members: - :inherited-members: - :undoc-members: - -.. autoclass:: FilteredCache - :members: - :inherited-members: - :undoc-members: - - -Example -^^^^^^^ - -This is an example for a filtered cache, which only allows access to the -packages whose state has been changed, eg. packages marked for installation:: - - >>> from apt.cache import FilteredCache, Cache, MarkedChangesFilter - >>> cache = apt.Cache() - >>> changed = apt.FilteredCache(cache) - >>> changed.setFilter(MarkedChangesFilter()) - >>> print len(changed) == len(cache.GetChanges()) # Both need to have same length - True - -The ProblemResolver class --------------------------- - -.. autoclass:: ProblemResolver - :members: - -Exceptions ----------- -.. autoexception:: FetchCancelledException -.. autoexception:: FetchFailedException -.. autoexception:: LockFailedException diff --git a/doc/source/apt/cdrom.rst b/doc/source/apt/cdrom.rst deleted file mode 100644 index 56381f14..00000000 --- a/doc/source/apt/cdrom.rst +++ /dev/null @@ -1,7 +0,0 @@ -:mod:`apt.cdrom` - Functionality like in apt-cdrom -==================================================== -.. automodule:: apt.cdrom - :members: - - - diff --git a/doc/source/apt/debfile.rst b/doc/source/apt/debfile.rst deleted file mode 100644 index 7133b5a8..00000000 --- a/doc/source/apt/debfile.rst +++ /dev/null @@ -1,39 +0,0 @@ -:mod:`apt.debfile` --- Classes related to debian package files -============================================================== -The :mod:`apt.debfile` provides classes to work with locally available -debian packages, or source packages. - -.. module:: apt.debfile - -Binary packages ----------------- -.. autoclass:: DebPackage - :members: - :inherited-members: - :undoc-members: - - The :class:`DebPackage` class is a class for working with '.deb' files, - also known as Debian packages. - - It provides methods and attributes to get a list of the files in the - package, to install the package and much more. - - If you specify *cache* it has to point to an :class:`apt.cache.Cache()` - object. - - .. versionchanged:: 0.7.9 - Introduce all new methods (everything except for :meth:`open()` and - :attr:`filelist`) - - -Source packages ----------------- -.. autoclass:: DscSrcPackage - :members: - :inherited-members: - :undoc-members: - - Provide functionality to work with locally available source packages, - especially with their '.dsc' file. - - .. versionadded:: 0.7.9 diff --git a/doc/source/apt/index.rst b/doc/source/apt/index.rst deleted file mode 100644 index bf39354f..00000000 --- a/doc/source/apt/index.rst +++ /dev/null @@ -1,61 +0,0 @@ -:mod:`apt` --- Highlevel apt package -===================================== -The highlevel apt package provides a lot of functionality, all -with an easy-to-use interface. - -.. warning:: - The API of this package is not considered stable. Evenmore, it is considered - to change the naming conventions in future to lowercase_with_underscores. - - In case this happens, the API will still be kept compatible, with the old - functions provided as deprecated ones. - -.. automodule:: apt - :members: - - - - -.. toctree:: - :maxdepth: 2 - :glob: - - * - - -Classes exported in apt ------------------------- -These classes are defined in the submodules, but are also exported directly -in the package. - -.. class:: Cache - - Please see :class:`apt.cache.Cache` for documentation. - -.. class:: Cdrom - - Please see :class:`apt.cdrom.Cdrom` for documentation. - -.. class:: CdromProgress - - Please see :class:`apt.progress.CdromProgress` for documentation. - -.. class:: FetchProgress - - Please see :class:`apt.progress.FetchProgress` for documentation. - -.. class:: InstallProgress - - Please see :class:`apt.progress.InstallProgress` for documentation. - -.. class:: OpProgress - - Please see :class:`apt.progress.OpProgress` for documentation. - -.. class:: Package - - Please see :class:`apt.package.Package` for documentation. - -.. class:: ProblemResolver - - Please see :class:`apt.cache.ProblemResolver` for documentation. diff --git a/doc/source/apt/package.rst b/doc/source/apt/package.rst deleted file mode 100644 index bb74915e..00000000 --- a/doc/source/apt/package.rst +++ /dev/null @@ -1,111 +0,0 @@ -:mod:`apt.package` --- Classes for package handling -==================================================== - - -.. automodule:: apt.package - - -The Package class ------------------ -.. autoclass:: Package - :members: - - .. note:: - - Several methods have been deprecated in version 0.7.9 of python-apt, - please see the :class:`Version` class for the new alternatives. - -The Version class ------------------ -.. autoclass:: Version - :members: - - -Dependency Information ----------------------- -.. class:: BaseDependency - - The :class:`BaseDependency` class defines various attributes for accessing - the parts of a dependency. The attributes are as follows: - - .. attribute:: name - - The name of the dependency - - .. attribute:: relation - - The relation (>>,>=,==,<<,<=,) - - .. attribute:: version - - The version or None. - - .. attribute:: preDepend - - Boolean value whether this is a pre-dependency. - -.. class:: Dependency - - The dependency class represents a Or-Group of dependencies. It provides - an attribute to access the :class:`BaseDependency` object for the available - choices. - - .. attribute:: or_dependencies - - A list of :class:`BaseDependency` objects which could satisfy the - requirement of the Or-Group. - - -Origin Information -------------------- -.. class:: Origin - - The :class:`Origin` class provides access to the origin of the package. - It allows you to check the component, archive, the hostname, and even if - this package can be trusted. - - .. attribute:: archive - - The archive (eg. unstable) - - .. attribute:: component - - The component (eg. main) - - .. attribute:: label - - The Label, as set in the Release file - - .. attribute:: origin - - The Origin, as set in the Release file - - .. attribute:: site - - The hostname of the site. - - .. attribute:: trusted - - Boolean value whether this is trustworthy. An origin can be trusted, if - it provides a GPG-signed Release file and the GPG-key used is in the - keyring used by apt (see apt-key). - -Examples ---------- -.. code-block:: python - - import apt - - cache = apt.Cache() - pkg = cache['python-apt'] # Access the Package object for python-apt - print 'python-apt is trusted:', pkg.candidate.origins[0].trusted - - # Mark python-apt for install - pkg.markInstall() - - print 'python-apt is marked for install:', pkg.markedInstall - - print 'python-apt is (summary):', pkg.candidate.summary - - # Now, really install it - cache.commit() diff --git a/doc/source/apt/progress.gtk2.rst b/doc/source/apt/progress.gtk2.rst deleted file mode 100644 index a83ab111..00000000 --- a/doc/source/apt/progress.gtk2.rst +++ /dev/null @@ -1,29 +0,0 @@ -:mod:`apt.progress.gtk2` --- GTK widgets -======================================== -.. automodule:: apt.progress.gtk2 - - -GObject progress classes -------------------------- - -.. autoclass:: GDpkgInstallProgress - :members: - -.. autoclass:: GFetchProgress - :members: - -.. autoclass:: GInstallProgress - :members: - -.. autoclass:: GOpProgress - :members: - -GTK+ Class ----------- -.. autoclass:: GtkAptProgress - :members: - - -Example -------- -.. literalinclude:: ../examples/apt-gtk.py diff --git a/doc/source/apt/progress.rst b/doc/source/apt/progress.rst deleted file mode 100644 index 8989aa27..00000000 --- a/doc/source/apt/progress.rst +++ /dev/null @@ -1,37 +0,0 @@ -:mod:`apt.progress` --- Classes for progress reporting -====================================================== -.. automodule:: apt.progress - -.. warning:: - - This class is currently under re-organisation. Therefore, the API may - change soon. The old names will still be kept until it is safe to remove - them. - - - -Classes without output ----------------------- -.. autoclass:: FetchProgress - :members: -.. autoclass:: OpProgress - :members: -.. autoclass:: CdromProgress - :members: -.. autoclass:: DumbInstallProgress - :members: - -Implementing classes for text output ------------------------------------- -.. autoclass:: TextFetchProgress - :members: -.. autoclass:: OpTextProgress - :members: -.. autoclass:: InstallProgress - :members: -.. autoclass:: DpkgInstallProgress - :members: - - - - |
