* apt/*.py:

  - Almost complete cleanup of the code
  - Remove inconsistent use of tabs and spaces (Closes: #505443)
  - Improved documentation
* apt/debfile.py:
  - Drop get*() methods, as they are deprecated and were
    never in a stable release
  - Make DscSrcPackage working
* apt/gtk/widgets.py:
  - Fix the code and document the signals
* Introduce new documentation build with Sphinx
  - Contains style Guide (Closes: #481562)
  - debian/rules: Build the documentation here
  - setup.py: Remove pydoc building and add new docs.
  - debian/examples: Include examples from documentation
  - debian/python-apt.docs:
    + Change html/ to build/doc/html.
    + Add build/doc/text for the text-only documentation
* setup.py:
  - Only create build/data when building, not all the time
  - Remove build/mo and build/data on clean -a
* debian/control:
  - Remove the Conflicts on python2.3-apt, python2.4-apt, as
    they are only needed for oldstable (sarge)
  - Build-Depend on python-sphinx (>= 0.5)
* aptsources/distinfo.py:
  - Allow @ in mirror urls (Closes: #478171) (LP: #223097)
* Merge Ben Finney's whitespace changes (Closes: #481563)
* Merge Ben Finney's do not use has_key() (Closes: #481878)
* Do not use deprecated form of raise statement (Closes: #494259)
* Add support for PkgRecords.SHA256Hash (Closes: #456113)

7 files changed, 232 insertions, 0 deletions

diff --git a/doc/source/examples/apt-gtk.py b/doc/source/examples/apt-gtk.py
new file mode 100644
index 00000000..c3bb09d5
--- /dev/null
+++ b/doc/source/examples/apt-gtk.py
@@ -0,0 +1,29 @@
+#!/usr/bin/python
+"""Example for gtk widgets"""
+import pygtk
+pygtk.require("2.0")
+import gtk
+
+import apt.gtk.widgets
+
+
+def main():
+    """Main function."""
+    win = gtk.Window()
+    win.connect("destroy", gtk.main_quit)
+    progress = apt.gtk.widgets.GtkAptProgress()
+    win.set_title("GtkAptProgress Demo")
+    win.add(progress)
+    progress.show()
+    win.show()
+    cache = apt.cache.Cache(progress.open)
+    if cache["xterm"].isInstalled:
+        cache["xterm"].markDelete()
+    else:
+        cache["xterm"].markInstall()
+    progress.show_terminal(expanded=True)
+    cache.commit(progress.fetch, progress.install)
+    gtk.main()
+
+if __name__ == "__main__":
+    main()
diff --git a/doc/source/examples/cache-packages.py b/doc/source/examples/cache-packages.py
new file mode 100644
index 00000000..1abe7cf2
--- /dev/null
+++ b/doc/source/examples/cache-packages.py
@@ -0,0 +1,22 @@
+#!/usr/bin/python
+"""Example for packages. Print all essential and important packages"""
+
+import apt_pkg
+
+
+def main():
+    """Main."""
+    apt_pkg.InitConfig()
+    apt_pkg.InitSystem()
+    cache = apt_pkg.GetCache()
+    print "Essential packages:"
+    for pkg in cache.Packages:
+        if pkg.Essential:
+            print " ", pkg.Name
+    print "Important packages:"
+    for pkg in cache.Packages:
+        if pkg.Important:
+            print " ", pkg.Name
+
+if __name__ == "__main__":
+    main()
diff --git a/doc/source/examples/cache-pkgfile.py b/doc/source/examples/cache-pkgfile.py
new file mode 100644
index 00000000..f25975d3
--- /dev/null
+++ b/doc/source/examples/cache-pkgfile.py
@@ -0,0 +1,29 @@
+#!/usr/bin/python
+import apt_pkg
+
+
+def main():
+    """Example for PackageFile()"""
+    apt_pkg.init()
+    cache = apt_pkg.GetCache()
+    for pkgfile in cache.FileList:
+        print 'Package-File:', pkgfile.FileName
+        print 'Index-Type:', pkgfile.IndexType # 'Debian Package Index'
+        if pkgfile.NotSource:
+            print 'Source: None'
+        else:
+            if pkgfile.Site:
+                # There is a source, and a site, print the site
+                print 'Source:', pkgfile.Site
+            else:
+                # It seems to be a local repository
+                print 'Source: Local package file'
+        if pkgfile.NotAutomatic:
+            # The system won't be updated automatically (eg. experimental)
+            print 'Automatic: No'
+        else:
+            print 'Automatic: Yes'
+        print
+
+if __name__ == '__main__':
+    main()
diff --git a/doc/source/examples/dpkg-contents.py b/doc/source/examples/dpkg-contents.py
new file mode 100644
index 00000000..99d1596f
--- /dev/null
+++ b/doc/source/examples/dpkg-contents.py
@@ -0,0 +1,55 @@
+#!/usr/bin/python
+"""Emulate dpkg --contents"""
+
+import grp
+import pwd
+import stat
+import sys
+import time
+
+import apt_inst
+
+
+def format_mode(what, mode):
+    """Return the symbolic mode"""
+    s_mode = dict(DIR="d", HARDLINK="h", FILE="-").get(what)
+    s_mode += ((mode & stat.S_IRUSR) and "r" or "-")
+    s_mode += ((mode & stat.S_IWUSR) and "w" or "-")
+    s_mode += ((mode & stat.S_IXUSR) and (mode & stat.S_ISUID and "s" or "x")
+                                      or (mode & stat.S_ISUID and "S" or "-"))
+    s_mode += ((mode & stat.S_IRGRP) and "r" or "-")
+    s_mode += ((mode & stat.S_IWGRP) and "w" or "-")
+    s_mode += ((mode & stat.S_IXGRP) and (mode & stat.S_ISGID and "s" or "x")
+                                      or (mode & stat.S_ISGID and "S" or "-"))
+    s_mode += ((mode & stat.S_IROTH) and "r" or "-")
+    s_mode += ((mode & stat.S_IWOTH) and "w" or "-")
+    s_mode += ((mode & stat.S_IXOTH) and "x" or "-")
+    return s_mode
+
+
+def callback(what, name, link, mode, uid, gid, size, mtime, major, minor):
+    """callback for debExtract"""
+    s_mode = format_mode(what, mode)
+    s_owner = "%s/%s" % (pwd.getpwuid(uid)[0], grp.getgrgid(gid)[0])
+    s_size = "%9d" % size
+    s_time = time.strftime("%Y-%m-%d %H:%M", time.localtime(mtime))
+    s_name = name.startswith(".") and name or ("./" + name)
+    if link:
+        s_name += " link to %s" % link
+    print s_mode, s_owner, s_size, s_time, s_name
+
+
+def main():
+    """Main function"""
+    if len(sys.argv) < 2:
+        print >> sys.stderr, "need filename argumnet"
+        sys.exit(1)
+
+    fobj = open(sys.argv[1])
+    try:
+        apt_inst.debExtract(fobj, callback, "data.tar.gz")
+    finally:
+        fobj.close()
+
+if __name__ == "__main__":
+    main()
diff --git a/doc/source/examples/dpkg-extract.py b/doc/source/examples/dpkg-extract.py
new file mode 100644
index 00000000..ced8652f
--- /dev/null
+++ b/doc/source/examples/dpkg-extract.py
@@ -0,0 +1,25 @@
+#!/usr/bin/python
+"""Emulate dpkg --extract package.deb outdir"""
+import os
+import sys
+
+import apt_inst
+
+
+def main():
+    """Main function."""
+    if len(sys.argv) < 3:
+        print >> sys.stderr, "Usage:", __file__, "package.deb outdir"
+        sys.exit(1)
+    if not os.path.exists(sys.argv[2]):
+        print >> sys.stderr, "The directory %s does not exist" % sys.argv[2]
+        sys.exit(1)
+
+    fobj = open(sys.argv[1])
+    try:
+        apt_inst.debExtractArchive(fobj, sys.argv[2])
+    finally:
+        fobj.close()
+
+if __name__ == "__main__":
+    main()
diff --git a/doc/source/examples/dpkg-info.py b/doc/source/examples/dpkg-info.py
new file mode 100644
index 00000000..ff98d8b1
--- /dev/null
+++ b/doc/source/examples/dpkg-info.py
@@ -0,0 +1,20 @@
+#!/usr/bin/python
+"""Emulate dpkg --info package.deb control-file"""
+import sys
+
+from apt_inst import debExtractControl
+
+
+def main():
+    """Main function."""
+    if len(sys.argv) < 3:
+        print >> sys.stderr, 'Usage: tool file.deb control-file'
+        sys.exit(0)
+    fobj = open(sys.argv[1])
+    try:
+        print debExtractControl(fobj, sys.argv[2])
+    finally:
+        fobj.close()
+
+if __name__ == '__main__':
+    main()
diff --git a/doc/source/examples/missing-deps.py b/doc/source/examples/missing-deps.py
new file mode 100644
index 00000000..3ca16e45
--- /dev/null
+++ b/doc/source/examples/missing-deps.py
@@ -0,0 +1,52 @@
+#!/usr/bin/python
+"""Check the archive for missing dependencies"""
+import apt_pkg
+
+
+def fmt_dep(dep):
+    """Format a Dependency object [of apt_pkg] as a string."""
+    ret = dep.TargetPkg.Name
+    if dep.TargetVer:
+        ret += " (%s %s)" % (dep.CompType, dep.TargetVer)
+    return ret
+
+
+def check_version(pkgver):
+    """Check the version of the package"""
+    missing = []
+
+    for or_group in pkgver.DependsList.get("Pre-Depends", []) + \
+                    pkgver.DependsList.get("Depends", []):
+        if not any(dep.AllTargets() for dep in or_group):
+            # If none of the or-choices can be satisfied, add it to missing
+            missing.append(or_group)
+
+    if missing:
+        print "Package:", pkgver.ParentPkg.Name
+        print "Version:", pkgver.VerStr
+        print "Missing:",
+        print ", ".join(" | ".join(fmt_dep(dep) for dep in or_group)
+                        for or_group in missing)
+        print
+
+
+def main():
+    """The main function."""
+    apt_pkg.InitConfig()
+    apt_pkg.InitSystem()
+
+    cache = apt_pkg.GetCache()
+
+    for pkg in sorted(cache.Packages, key=lambda pkg: pkg.Name):
+        # pkg is from a list of packages, sorted by name.
+        for version in pkg.VersionList:
+            # Check every version
+            for pfile, _ in version.FileList:
+                if (pfile.Origin == "Debian" and pfile.Component == "main" and
+                    pfile.Archive == "unstable"):
+                    # We only want packages from Debian unstable main.
+                    check_version(version)
+                    break
+
+if __name__ == "__main__":
+    main()