[yum-commits] Branch 'yum-3_2_X' - 5 commits - callback.py docs/sphinxdocs po/pygettext.py yum/callbacks.py yum-updatesd.py
James Antill
james at osuosl.org
Wed Jul 27 13:41:44 UTC 2011
callback.py | 20 ++-
docs/sphinxdocs/Makefile | 130 ++++++++++++++++++++
docs/sphinxdocs/conf.py | 228 +++++++++++++++++++++++++++++++++++
docs/sphinxdocs/rstgenerator.py | 222 ++++++++++++++++++++++++++++++++++
po/pygettext.py | 1
yum-updatesd.py | 259 +++++++++++++++++++++++++++++++++++++---
yum/callbacks.py | 101 +++++++++------
7 files changed, 906 insertions(+), 55 deletions(-)
New commits:
commit a22ea37e9632338051118d61affd432ea52e5f10
Author: Nick Jacek <njacek at redhat.com>
Date: Fri Jul 22 15:18:05 2011 -0400
Adds documentation for the yum.callbacks module.
diff --git a/yum/callbacks.py b/yum/callbacks.py
index 7ad25ce..a9a8e53 100644
--- a/yum/callbacks.py
+++ b/yum/callbacks.py
@@ -13,6 +13,8 @@
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+"""Classes for handling various callbacks."""
+
# imports
import logging
@@ -35,59 +37,79 @@ PT_MESSAGES = { PT_DOWNLOAD : "Downloading Packages",
class ProcessTransBaseCallback:
-
+ """A class to handle callbacks from
+ :func:`YumBase.processTransaction`.
+ """
def __init__(self):
self.logger = logging.getLogger('yum.verbose.ProcessTrasactionBaseCallback')
def event(self,state,data=None):
+ """Handle an event by logging it.
+
+ :param state: a number indicating the type of callback
+ :param data: data associated with the callback
+ """
if state in PT_MESSAGES.keys():
self.logger.info(PT_MESSAGES[state])
class ProcessTransNoOutputCallback:
+ """A class to handle callbacks from
+ :func:`YumBase.processTransaction`, without logging them.
+ """
def __init__(self):
pass
def event(self,state,data=None):
+ """Handle an event.
+
+ :param state: a number indicating the type of callback
+ :param data: data associated with the callback
+ """
pass
class DownloadBaseCallback( BaseMeter ):
- """
- This is class is a base class to use by implement a download progress
- handler to be used with YumBase.repos.setProgressBar.
+ """This is a base class that can be extended to implement a custom
+ download progress handler to be used with
+ :func:`YumBase.repos.setProgressBar`.
- Example:
-
- from yum.callbacks import DownloadBaseCallback
-
- class MyDownloadCallback( DownloadBaseCallback ):
-
- def updateProgress(self,name,frac,fread,ftime):
- '''
- Update the progressbar
- @param name: filename
- @param frac: Progress fracment (0 -> 1)
- @param fread: formated string containing BytesRead
- @param ftime : formated string containing remaining or elapsed time
- '''
- pct = int( frac*100 )
- print " %s : %s " % (name,pct)
-
-
- if __name__ == '__main__':
- my = YumBase()
- my.doConfigSetup()
- dnlcb = MyDownloadCallback()
- my.repos.repos.setProgressBar( dnlcb )
- for pkg in my.pkgSack:
- print pkg.name
-
- """
+ Example::
+ from yum.callbacks import DownloadBaseCallback
+
+ class MyDownloadCallback( DownloadBaseCallback ):
+
+ def updateProgress(self,name,frac,fread,ftime):
+ '''
+ Update the progressbar
+ @param name: filename
+ @param frac: Progress fracment (0 -> 1)
+ @param fread: formated string containing BytesRead
+ @param ftime : formated string containing remaining or elapsed time
+ '''
+ pct = int( frac*100 )
+ print " %s : %s " % (name,pct)
+
+
+ if __name__ == '__main__':
+ my = YumBase()
+ my.doConfigSetup()
+ dnlcb = MyDownloadCallback()
+ my.repos.setProgressBar( dnlcb )
+ for pkg in my.pkgSack:
+ print pkg.name
+ """
def __init__(self):
BaseMeter.__init__( self )
self.totSize = "" # Total size to download in a formatted string (Kb, MB etc)
def update( self, amount_read, now=None ):
+ """Update the status bar.
+
+ :param amount_read: the amount of data, in bytes, that has been read
+ :param now: the current time in seconds since the epoch. If
+ *now* is not given, the output of :func:`time.time()` will
+ be used.
+ """
BaseMeter.update( self, amount_read, now )
def _do_start( self, now=None ):
@@ -130,12 +152,15 @@ class DownloadBaseCallback( BaseMeter ):
return name
def updateProgress(self,name,frac,fread,ftime):
- '''
- Update the progressbar (Overload in child class)
- @param name: filename
- @param frac: Progress fracment (0 -> 1)
- @param fread: formated string containing BytesRead
- @param ftime : formated string containing remaining or elapsed time
- '''
+ """Update the progressbar. This method should be overridden
+ by subclasses to implement the handler.
+
+ :param name: the name of the filed being downloaded
+ :param frac: number between 0 and 1 representing the fraction
+ fraction of the file that has been downloaded
+ :param fread: formatted string containing the number of bytes read
+ :param ftime: formatted string containing remaining or elapsed time
+
+ """
pass
commit e4a3531ae770f3c446389b0d04f859ed781c20c0
Author: Nick Jacek <njacek at redhat.com>
Date: Fri Jul 22 15:13:07 2011 -0400
Adds documentation for the yum-updatesd module.
diff --git a/yum-updatesd.py b/yum-updatesd.py
old mode 100644
new mode 100755
index 1ce4720..25e3022
--- a/yum-updatesd.py
+++ b/yum-updatesd.py
@@ -28,6 +28,11 @@
# $ dbus-send --system --print-reply --type=method_call \
# --dest=edu.duke.linux.yum /Updatesd edu.duke.linux.yum.CheckNow
+"""
+Daemon to periodically check for updates to installed packages, and
+associated classes and methods.
+"""
+
import os
import sys
import time
@@ -60,34 +65,78 @@ config_file = '/etc/yum/yum-updatesd.conf'
initial_directory = os.getcwd()
class UpdateEmitter(object):
- """Abstract object for implementing different types of emitters."""
+ """Abstract class for implementing different types of
+ emitters.
+ """
+
def __init__(self):
pass
def updatesAvailable(self, updateInfo):
"""Emitted when there are updates available to be installed.
If not doing the download here, then called immediately on finding
new updates. If we do the download here, then called after the
- updates have been downloaded."""
+ updates have been downloaded.
+
+ :param updateInfo: a list of tuples of dictionaries. Each
+ dictionary contains information about a package, and each
+ tuple specifies an available upgrade: the second dictionary
+ in the tuple has information about a package that is
+ currently installed, and the first dictionary has
+ information what the package can be upgraded to
+ """
pass
+
def updatesDownloading(self, updateInfo):
- """Emitted to give feedback of update download starting."""
+ """Emitted to give feedback of update download starting.
+
+ :param updateInfo: a list of tuples of dictionaries. Each
+ dictionary contains information about a package, and each
+ tuple specifies an available upgrade: the second dictionary
+ in the tuple has information about a package that is
+ currently installed, and the first dictionary has
+ information what the package can be upgraded to
+ """
pass
+
def updatesApplied(self, updateInfo):
- """Emitted on successful installation of updates."""
+ """Emitted on successful installation of updates.
+
+ :param updateInfo: a list of tuples of dictionaries. Each
+ dictionary contains information about a package, and each
+ tuple specifies an available upgrade: the second dictionary
+ in the tuple has information about a package that is
+ currently installed, and the first dictionary has
+ information what the package can be upgraded to
+ """
pass
+
def updatesFailed(self, errmsgs):
- """Emitted when an update has failed to install."""
+ """Emitted when an update has failed to install.
+
+ :param errmsgs: a list of error messages
+ """
pass
+
def checkFailed(self, error):
- """Emitted when checking for updates failed."""
+ """Emitted when checking for updates failed.
+
+ :param error: an error message
+ """
pass
def setupFailed(self, error, translation_domain):
- """Emitted when plugin initialization failed."""
+ """Emitted when plugin initialization failed.
+
+ :param error: an error message
+ :param translation_domain: the translation domain supplied by
+ the plugin
+ """
pass
class SyslogUpdateEmitter(UpdateEmitter):
+ """Emitter class to send messages to syslog."""
+
def __init__(self, syslog_facility, ident = "yum-updatesd",
level = "WARN"):
UpdateEmitter.__init__(self)
@@ -95,6 +144,15 @@ class SyslogUpdateEmitter(UpdateEmitter):
self.level = level
def updatesAvailable(self, updateInfo):
+ """Emit a message stating that updates are available.
+
+ :param updateInfo: a list of tuples of dictionaries. Each
+ dictionary contains information about a package, and each
+ tuple specifies an available upgrade: the second dictionary
+ in the tuple has information about a package that is
+ currently installed, and the first dictionary has
+ information what the package can be upgraded to
+ """
num = len(updateInfo)
level = self.level
if num > 1:
@@ -144,12 +202,23 @@ class SyslogUpdateEmitter(UpdateEmitter):
class EmailUpdateEmitter(UpdateEmitter):
+ """Emitter class to send messages via email."""
+
def __init__(self, sender, rcpt):
UpdateEmitter.__init__(self)
self.sender = sender
self.rcpt = rcpt
def updatesAvailable(self, updateInfo):
+ """Emit a message stating that updates are available.
+
+ :param updateInfo: a list of tuples of dictionaries. Each
+ dictionary contains information about a package, and each
+ tuple specifies an available upgrade: the second dictionary
+ in the tuple has information about a package that is
+ currently installed, and the first dictionary has
+ information what the package can be upgraded to
+ """
num = len(updateInfo)
if num < 1:
return
@@ -173,6 +242,8 @@ class EmailUpdateEmitter(UpdateEmitter):
s.close()
class DbusUpdateEmitter(UpdateEmitter):
+ """Emitter class to send messages to the dbus message system."""
+
def __init__(self):
UpdateEmitter.__init__(self)
bus = dbus.SystemBus()
@@ -181,6 +252,15 @@ class DbusUpdateEmitter(UpdateEmitter):
self.dbusintf = yum_dbus
def updatesAvailable(self, updateInfo):
+ """Emit a message stating that updates are available.
+
+ :param updateInfo: a list of tuples of dictionaries. Each
+ dictionary contains information about a package, and each
+ tuple specifies an available upgrade: the second dictionary
+ in the tuple has information about a package that is
+ currently installed, and the first dictionary has
+ information what the package can be upgraded to
+ """
num = len(updateInfo)
msg = "%d" %(num,)
if num > 0:
@@ -189,44 +269,102 @@ class DbusUpdateEmitter(UpdateEmitter):
self.dbusintf.NoUpdatesAvailableSignal(msg)
def updatesFailed(self, errmsgs):
+ """Emit a message stating that an update has failed to install.
+
+ :param errmsgs: a list of error messages
+ """
self.dbusintf.UpdatesFailedSignal(errmsgs)
def updatesApplied(self, updinfo):
+ """Emit a message stating that updates were installed
+ successfully.
+
+ :param updinfo: a list of tuples of dictionaries. Each
+ dictionary contains information about a package, and each
+ tuple specifies an available upgrade: the second dictionary
+ in the tuple has information about a package that is
+ currently installed, and the first dictionary has
+ information what the package can be upgraded to
+ """
self.dbusintf.UpdatesAppliedSignal(updinfo)
def checkFailed(self, error):
+ """Emit a message stating that checking for updates failed.
+
+ :param error: an error message
+ """
self.dbusintf.CheckFailedSignal(error)
def setupFailed(self, error, translation_domain):
+ """Emit a message stating that plugin initialization failed.
+
+ :param error: an error message
+ :param translation_domain: the translation domain supplied by
+ the plugin
+ """
self.dbusintf.SetupFailedSignal(error, translation_domain)
class YumDbusInterface(dbus.service.Object):
+ """Interface class for sending signals to the dbus."""
+
def __init__(self, bus_name, object_path='/UpdatesAvail'):
dbus.service.Object.__init__(self, bus_name, object_path)
@dbus.service.signal('edu.duke.linux.yum')
def UpdatesAvailableSignal(self, message):
+ """Send a signal stating that updates are available.
+
+ :param message: the message to send in the signal
+ """
pass
@dbus.service.signal('edu.duke.linux.yum')
def NoUpdatesAvailableSignal(self, message):
+ """Send a signal stating that no updates are available.
+
+ :param message: the message to send in the signal
+ """
pass
@dbus.service.signal('edu.duke.linux.yum')
def UpdatesFailedSignal(self, errmsgs):
+ """Send a signal stating that the update has failed.
+
+ :param errmsgs: a list of error messages
+ """
pass
@dbus.service.signal('edu.duke.linux.yum')
def UpdatesAppliedSignal(self, updinfo):
+ """Send a signal stating that updates were applied
+ successfully.
+
+ :param updinfo: a list of tuples of dictionaries. Each
+ dictionary contains information about a package, and each
+ tuple specifies an available upgrade: the second dictionary
+ in the tuple has information about a package that is
+ currently installed, and the first dictionary has
+ information what the package can be upgraded to
+ """
pass
@dbus.service.signal('edu.duke.linux.yum')
def CheckFailedSignal(self, message):
+ """Send a signal stating that checking for updates failed.
+
+ :param message: the message to send in the signal
+ """
pass
@dbus.service.signal('edu.duke.linux.yum')
def SetupFailedSignal(self, message, translation_domain=""):
+ """Send a signal stating that plugin initialization failed.
+
+ :param message: the message to send in the signal
+ :param translation_domain: the translation domain supplied by
+ the plugin
+ """
pass
@@ -249,11 +387,18 @@ class UDConfig(BaseConfig):
class UpdateBuildTransactionThread(threading.Thread):
+ """Class to build the update transaction in a new thread."""
+
def __init__(self, updd, name):
self.updd = updd
threading.Thread.__init__(self, name=name)
def run(self):
+ """Build the transaction, and download the packages to be
+ updated. Finally, call self.processPkgs. This method must be
+ provided by a subclass, and will determine what, if any,
+ action is taken with the packages after they are downloaded.
+ """
self.updd.tsInfo.makelists()
try:
(result, msgs) = self.updd.buildTransaction()
@@ -270,25 +415,41 @@ class UpdateBuildTransactionThread(threading.Thread):
class UpdateDownloadThread(UpdateBuildTransactionThread):
+ """Class to download the packages in the update in a new thread."""
+
def __init__(self, updd):
UpdateBuildTransactionThread.__init__(self, updd,
name="UpdateDownloadThread")
def processPkgs(self, dlpkgs):
+ """Output that there are updates available via the emitters,
+ and release the yum locks.
+
+ :param dlpkgs: unused
+ """
self.updd.emitAvailable()
self.updd.releaseLocks()
class UpdateInstallThread(UpdateBuildTransactionThread):
+ """Class to install updates in a new thread."""
+
def __init__(self, updd):
UpdateBuildTransactionThread.__init__(self, updd,
name="UpdateInstallThread")
def failed(self, msgs):
+ """Output that the update failed via the emitters.
+
+ :param msgs: a list or error messages to emit
+ """
self.updd.emitUpdateFailed(msgs)
self.updd.releaseLocks()
def success(self):
+ """Output that the update has completed successfully via the
+ emitters, and perform clean up.
+ """
self.updd.emitUpdateApplied()
self.updd.releaseLocks()
@@ -296,6 +457,10 @@ class UpdateInstallThread(UpdateBuildTransactionThread):
self.updd.updateInfoTime = None
def processPkgs(self, dlpkgs):
+ """Apply the available updates.
+
+ :param dlpkgs: a list of package objecs to update
+ """
for po in dlpkgs:
result, err = self.updd.sigCheckPkg(po)
if result == 0:
@@ -323,6 +488,8 @@ class UpdateInstallThread(UpdateBuildTransactionThread):
self.success()
class UpdatesDaemon(yum.YumBase):
+ """Class to implement the update checking daemon."""
+
def __init__(self, opts):
yum.YumBase.__init__(self)
self.opts = opts
@@ -343,6 +510,9 @@ class UpdatesDaemon(yum.YumBase):
self.updateInfoTime = None
def doSetup(self):
+ """Perform set up, including setting up directories and
+ parsing options.
+ """
# if we are not root do the special subdir thing
if os.geteuid() != 0:
if not os.path.exists(self.opts.nonroot_workdir):
@@ -352,6 +522,8 @@ class UpdatesDaemon(yum.YumBase):
self.doConfigSetup(fn=self.opts.yum_config)
def refreshUpdates(self):
+ """Retrieve information about what updates are available."""
+
self.doLock()
try:
self.doRepoSetup()
@@ -366,6 +538,8 @@ class UpdatesDaemon(yum.YumBase):
return True
def populateUpdateMetadata(self):
+ """Populate the metadata for the packages in the update."""
+
self.updateMetadata = UpdateMetadata()
repos = []
@@ -383,6 +557,9 @@ class UpdatesDaemon(yum.YumBase):
md.close()
def populateUpdates(self):
+ """Retrieve and set up information about the updates available
+ for installed packages.
+ """
def getDbusPackageDict(pkg):
"""Returns a dictionary corresponding to the package object
in the form that we can send over the wire for dbus."""
@@ -425,6 +602,8 @@ class UpdatesDaemon(yum.YumBase):
self.updateInfoTime = time.time()
def populateTsInfo(self):
+ """Set up information about the update in the tsInfo object."""
+
# figure out the updates
for (new, old) in self.up.getUpdatesTuples():
updating = self.getPackageObject(new)
@@ -442,6 +621,13 @@ class UpdatesDaemon(yum.YumBase):
self.tsInfo.addObsoleted(installed, obsoleting)
def updatesCheck(self):
+ """Check to see whether updates are available for any
+ installed packages. If updates are available, install them,
+ download them, or just emit a message, depending on what
+ options are selected in the configuration file.
+
+ :return: whether the daemon should continue looping
+ """
if not self.didSetup:
try:
self.doSetup()
@@ -491,6 +677,18 @@ class UpdatesDaemon(yum.YumBase):
return True
def getUpdateInfo(self):
+ """Return information about the update. This may be
+ previously cached information if the configured time interval
+ between update retrievals has not yet elapsed, or there is an
+ error in trying to retrieve the update information.
+
+ :return: a list of tuples of dictionaries. Each
+ dictionary contains information about a package, and each
+ tuple specifies an available upgrade: the second dictionary
+ in the tuple has information about a package that is
+ currently installed, and the first dictionary has
+ information what the package can be upgraded to
+ """
# if we have a cached copy, use it
if self.updateInfoTime and (time.time() - self.updateInfoTime <
self.opts.updaterefresh):
@@ -522,40 +720,47 @@ class UpdatesDaemon(yum.YumBase):
return self.updateInfo
def updateCheckSetup(self):
+ """Set up the transaction set, rpm database, and prepare to
+ get updates.
+ """
self.doTsSetup()
self.doRpmDBSetup()
self.doUpdateSetup()
def releaseLocks(self):
+ """Close the rpm database, and release the yum lock."""
self.closeRpmDB()
self.doUnlock()
def emitAvailable(self):
- """method to emit a notice about updates"""
+ """Emit a notice stating whether updates are available."""
map(lambda x: x.updatesAvailable(self.updateInfo), self.emitters)
def emitDownloading(self):
- """method to emit a notice about updates downloading"""
+ """Emit a notice stating that updates are downloading."""
map(lambda x: x.updatesDownloading(self.updateInfo), self.emitters)
def emitUpdateApplied(self):
- """method to emit a notice when automatic updates applied"""
+ """Emit a notice stating that automatic updates have been applied."""
map(lambda x: x.updatesApplied(self.updateInfo), self.emitters)
def emitUpdateFailed(self, errmsgs):
- """method to emit a notice when automatic updates failed"""
+ """Emit a notice stating that automatic updates failed."""
map(lambda x: x.updatesFailed(errmsgs), self.emitters)
def emitCheckFailed(self, error):
- """method to emit a notice when checking for updates failed"""
+ """Emit a notice stating that checking for updates failed."""
map(lambda x: x.checkFailed(error), self.emitters)
def emitSetupFailed(self, error, translation_domain=""):
- """method to emit a notice when checking for updates failed"""
+ """Emit a notice stating that checking for updates failed."""
map(lambda x: x.setupFailed(error, translation_domain), self.emitters)
class YumDbusListener(dbus.service.Object):
+ """Class to export methods that control the daemon over the
+ dbus.
+ """
def __init__(self, updd, bus_name, object_path='/Updatesd',
allowshutdown = False):
dbus.service.Object.__init__(self, bus_name, object_path)
@@ -563,11 +768,19 @@ class YumDbusListener(dbus.service.Object):
self.allowshutdown = allowshutdown
def doCheck(self):
+ """Check whether updates are available.
+
+ :return: False
+ """
self.updd.updatesCheck()
return False
@dbus.service.method("edu.duke.linux.yum", in_signature="")
def CheckNow(self):
+ """Check whether updates are available.
+
+ :return: a message stating that a check has been queued
+ """
# make updating checking asynchronous since we discover whether
# or not there are updates via a callback signal anyway
gobject.idle_add(self.doCheck)
@@ -575,6 +788,11 @@ class YumDbusListener(dbus.service.Object):
@dbus.service.method("edu.duke.linux.yum", in_signature="")
def ShutDown(self):
+ """Shut down the daemon.
+
+ :return: whether remote callers have permission to shut down
+ the daemon
+ """
if not self.allowshutdown:
return False
@@ -585,19 +803,34 @@ class YumDbusListener(dbus.service.Object):
@dbus.service.method("edu.duke.linux.yum", in_signature="", out_signature="a(a{ss}a{ss})")
def GetUpdateInfo(self):
+ """Return information about the available updates
+
+ :return: a list of tuples of dictionaries. Each
+ dictionary contains information about a package, and each
+ tuple specifies an available upgrade: the second dictionary
+ in the tuple has information about a package that is
+ currently installed, and the first dictionary has
+ information what the package can be upgraded to
+ """
# FIXME: should this be async?
upds = self.updd.getUpdateInfo()
return upds
def shutDown():
+ """Shut down the daemon."""
+
sys.exit(0)
def restart():
+ """Restart the daemon, reloading configuration files."""
+
os.chdir(initial_directory)
os.execve(sys.argv[0], sys.argv, os.environ)
def main(options = None):
+ """Configure and start the daemon."""
+
# we'll be threading for downloads/updates
gobject.threads_init()
dbus.glib.threads_init()
commit b656a6193b21435764f8d40bce7380d445682e25
Author: Nick Jacek <njacek at redhat.com>
Date: Fri Jul 22 15:12:22 2011 -0400
Adds documentation for the callback module.
diff --git a/callback.py b/callback.py
index 2f6154e..2e5a052 100644
--- a/callback.py
+++ b/callback.py
@@ -27,10 +27,7 @@ from yum.constants import *
class RPMInstallCallback:
-
- """
- Yum command line callback class for callbacks from the RPM library.
- """
+ """Yum command line callback class for callbacks from the RPM library."""
def __init__(self, output=1):
self.output = output
@@ -105,6 +102,21 @@ class RPMInstallCallback:
return pkg
def callback(self, what, bytes, total, h, user):
+ """Handle callbacks from the RPM library.
+
+ :param what: number identifying the type of callback
+ :param bytes: the number of bytes associated with the
+ callback; the exact meaning depends on the type of
+ the callback. For example, for a RPMCALLBACK_INST_PROGRESS
+ callback, bytes will represent the current amount of work done
+ :param total: the total amount of work associated with the
+ callback; the exact meaning depends on the type of the
+ callback. For example, *total* may represent the total
+ number of transactions in a transaction set
+ :param h: a package object or string identifying the package
+ involved in the callback
+ :param user: unused
+ """
if what == rpm.RPMCALLBACK_TRANS_START:
if bytes == 6:
self.total_actions = total
commit 6650891a41330618d1f049fb0ba42723f5e8d2bc
Author: Nick Jacek <njacek at redhat.com>
Date: Fri Jul 22 15:08:15 2011 -0400
This adds configuration files so that Sphinx can automatically generate html documentation for yum. So far, the default settings for Sphinx are mostly used. To generate the documentation, make sure Sphinx is installed, then cd to yum/docs/sphinxdocs and run "make html".
diff --git a/docs/sphinxdocs/Makefile b/docs/sphinxdocs/Makefile
new file mode 100644
index 0000000..623c22b
--- /dev/null
+++ b/docs/sphinxdocs/Makefile
@@ -0,0 +1,130 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Yum.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Yum.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/Yum"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Yum"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ make -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
diff --git a/docs/sphinxdocs/conf.py b/docs/sphinxdocs/conf.py
new file mode 100644
index 0000000..b9f2e1d
--- /dev/null
+++ b/docs/sphinxdocs/conf.py
@@ -0,0 +1,228 @@
+# -*- coding: utf-8 -*-
+#
+# Yum documentation build configuration file, created by
+# sphinx-quickstart on Mon Jun 27 14:01:20 2011.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+# sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+#Tell sphinx where to look for all the files
+sys.path.insert(0, os.path.normpath(os.path.join(os.getcwd(), "../../test")))
+sys.path.insert(0, os.path.normpath(os.path.join(os.getcwd(), "../../po")))
+sys.path.insert(0, os.path.normpath(os.path.join(os.getcwd(), "../../bin")))
+sys.path.insert(0, os.path.normpath(os.path.join(os.getcwd(), "../..")))
+
+#Generate all the rst files
+sys.path.insert(1, os.getcwd())
+import rstgenerator
+rstgenerator.generateAll(sys.path[0], os.getcwd())
+
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Yum'
+copyright = None
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '3.4'
+# The full version, including alpha/beta/rc tags.
+release = '3.4.2'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+html_show_copyright = False
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Yumdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+ ('index', 'Yum.tex', u'Yum Documentation',
+ u'', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ ('index', 'yum', u'Yum Documentation',
+ [u''], 1)
+]
diff --git a/docs/sphinxdocs/rstgenerator.py b/docs/sphinxdocs/rstgenerator.py
new file mode 100755
index 0000000..d2a0ed1
--- /dev/null
+++ b/docs/sphinxdocs/rstgenerator.py
@@ -0,0 +1,222 @@
+#! /usr/bin/python
+
+import sys, re, os
+
+def generateFile(input_directory, file_name, output_directory,
+ package_heirarchy=None, module_name=None):
+ """Generate a rst file telling sphinx to just generate documentation
+ for the public interface automatically. Output will be written to
+ *file_name*.rst in the current directory.
+
+ :param input_directory: a string specifying the directory containing the
+ source code file
+ :param file_name: the name of the python source code file to generate
+ a sphinx rst file describing
+ :param ouput_directory: a string specifying the directory where
+ the generated rst file should be placed. If *output_directory* does
+ not already exist, it will be created
+ :param package_heirarchy: a list of strings, where each name is
+ the name of a package, in the order of the hierarchy
+ :param module_name: the name of the module. If not given, the .py is
+ removed from *file_name* to produce the module_name
+ """
+ #Stick all output into a list of strings, then just join it and output
+ #it all in on go.
+ output = []
+
+ # Create the output directory if it doesn't already exist. Note that
+ # if the directory is created between the check and the creation, it
+ # might cause issues, but I don't think this likely at all to happen
+ if not os.path.exists(output_directory):
+ try:
+ os.makedirs(output_directory)
+ except OSError as e:
+ print "Error creating the output directory"
+ print e.args
+
+ try:
+ #Open the file
+ f = open(os.path.join(input_directory, file_name), 'r')
+
+ #Do the module output
+ if not module_name:
+ module_name = re.search('(\w+).py$', file_name).group(1)
+
+ #Append the package names, if there are any
+ full_module_name = module_name
+ if package_heirarchy:
+ full_module_name = '.'.join(package_heirarchy) + '.' + module_name
+
+ output.append(full_module_name)
+ output.append('=' * len(full_module_name))
+ output.append('.. automodule:: %s\n' % full_module_name)
+
+ #Read the file, and do output for classes
+ class_reg = re.compile('^class (\w+)')
+ func_reg = re.compile('^def ((?:[a-zA-Z0-9]+_)*[a-zA-Z0-9]+)')
+
+ #We don't need a blank line between autofunction directives, but we do
+ #need one between autofunctions and headings etc. for classes. This
+ #keeps track if we're switching from autofunctions to classes, so we
+ #can add that blank line.
+ finding_functions = False
+
+ for line in iter(f):
+ #Search for classes
+ match = class_reg.match(line)
+ if match is not None:
+ if finding_functions:
+ output.append('')
+ finding_functions = False
+ class_name = match.group(1)
+ output.append(class_name)
+ output.append('-' * len(class_name))
+ output.append('''.. autoclass:: %s
+ :members:
+ :show-inheritance:
+
+ ''' % class_name)
+
+
+ #Search for top level functions
+ else:
+ match = func_reg.match(line)
+ if match is not None:
+ func_name = match.group(1)
+ output.append('.. autofunction:: ' + func_name)
+ finding_functions = True
+ f.close()
+
+ except IOError as e:
+ print "Error opening the input file : ", os.path.join(input_directory, file_name)
+ print e.args[1]
+
+ else:
+ #Write the output
+ try:
+ output_file_name = os.path.join(output_directory, module_name) + '.rst'
+ f = open(output_file_name, 'w')
+ f.write('\n'.join(output))
+
+
+ except IOError as e:
+ print "Error opening the output file : ", output_file_name
+ print e.args[1]
+
+
+def generateIndex(module_list, output_directory):
+ """Create an index.rst file for sphinx in the given directory.
+
+ :param module_list: a list of the names of the modules to list in
+ the index file
+ :param output_directory: the directory to create the index file in
+ """
+
+ #Sort the module_list
+ module_list.sort()
+
+ try:
+ #open the file
+ f = open(os.path.join(output_directory, 'index.rst'), 'w')
+
+ #Do the output
+ f.write(""".. Yum documentation master file, created by
+ sphinx-quickstart on Mon Jun 27 14:01:20 2011.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to Yum's documentation!
+===============================
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ """)
+ f.write('\n '.join(module_list))
+ f.write("""
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+""")
+
+ except IOError as e:
+ print "Error opening the output file."
+ print e.args[1]
+
+
+def generateAll(source_directory, output_directory):
+ #Verify that both the source and output directories exist
+
+
+ # Keep a set of file names that are packages. This is
+ # useful so that later we will be able to figure out full
+ # module names.
+ packages = set()
+
+ # Keep a list of tuples containing python module names and
+ # relative paths, so that we can build the index file later
+ modules = []
+
+ # Walk the directory tree
+ for dirpath, dirnames, filenames in os.walk(source_directory, topdown=True):
+
+ # print dirpath
+ # print dirnames
+ # print filenames
+ # print
+
+ # Add the curent directory to packages if __init__.py exists
+ if '__init__.py' in filenames:
+ packages.add(dirpath)
+
+ # Find the heirarchy of packages that we are currently in
+ package_heirarchy = []
+ #Recurse up to the root
+ dirpath_i = dirpath
+ while dirpath_i != '/':
+ if dirpath_i in packages:
+ dirpath_i, tail = os.path.split(dirpath_i)
+ package_heirarchy.insert(0, tail)
+ else:
+ break
+
+ # Find the relative output directory, mirroring the input
+ # directory structure
+ relative_output_directory = ''
+ if not os.path.samefile(dirpath, source_directory):
+ relative_output_directory = os.path.relpath(dirpath, source_directory)
+
+ # Don't recurse into directories that are hidden, or for docs
+ for directory in dirnames:
+ if directory == "docs" or directory.startswith("."):
+ dirnames.remove(directory)
+
+ # Generate the rst for a file if it is a python source code file
+ for file_name in filenames:
+ # Skip file names that contain dashes, since they're not
+ # valid module names, so we won't be able to import them
+ # to generate the documentation anyway
+ if '-' in file_name:
+ continue
+
+ if file_name.endswith('.py'):
+ module_name = file_name.partition('.')[0]
+ modules.append(os.path.join(relative_output_directory,
+ module_name))
+ generateFile(dirpath, file_name,
+ os.path.join(output_directory, relative_output_directory),
+ package_heirarchy, module_name)
+
+
+
+ # Create the index.rst file
+ generateIndex(modules, output_directory)
+
+if __name__ == "__main__":
+ generateAll(os.getcwd(), os.getcwd())
commit 5132b23a7ed23dcdd1ab29aab7287d55d463ec26
Author: Nick Jacek <njacek at redhat.com>
Date: Fri Jul 22 15:08:14 2011 -0400
Specifies the encoding of the pygettext.py source file, so the it can be imported without errors.
diff --git a/po/pygettext.py b/po/pygettext.py
index 276a433..7f13138 100644
--- a/po/pygettext.py
+++ b/po/pygettext.py
@@ -1,4 +1,5 @@
#!/usr/bin/python
+# coding=utf-8
# Originally written by Barry Warsaw <bwarsaw at python.org>
#
# minimally patched to make it even more xgettext compatible
More information about the Yum-commits
mailing list