more docstrings

a few more in dak/

Signed-off-by: Joerg Jaspert <joerg@debian.org>

diff --git a/dak/ls.py b/dak/ls.py
index b9753b483e265303246ac6e533059c550790ec93..69251eb47a6123b9e02bb1eb96d7b9bf87eedf5d 100755 (executable)
--- a/dak/ls.py
+++ b/dak/ls.py
@@ -1,8 +1,13 @@
 #!/usr/bin/env python
 
-""" Display information about package(s) (suite, version, etc.) """
-# Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006  James Troup <james@nocrew.org>
+"""
+Display information about package(s) (suite, version, etc.)
 
+@contact: Debian FTP Master <ftpmaster@debian.org>
+@copyright: 2000, 2001, 2002, 2003, 2004, 2005, 2006  James Troup <james@nocrew.org>
+@license: GNU General Public License version 2 or later
+
+"""
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation; either version 2 of the License, or
@@ -26,15 +31,17 @@
 
 ################################################################################
 
-import os, pg, sys
+import os
+import pg
+import sys
 import apt_pkg
 from daklib import database
 from daklib import utils
 
 ################################################################################
 
-Cnf = None
-projectB = None
+Cnf = None       #: Configuration, apt_pkg.Configuration
+projectB = None  #: database connection, pgobject
 
 ################################################################################
 

diff --git a/dak/make_maintainers.py b/dak/make_maintainers.py
index 913537500c47688e8cbe53275f8c69d45fd63e8b..4e2fe244bb6fd911930641eebef3730fb19f9a66 100755 (executable)
--- a/dak/make_maintainers.py
+++ b/dak/make_maintainers.py
@@ -1,7 +1,12 @@
 #!/usr/bin/env python
 
-""" Generate Maintainers file used by e.g. the Debian Bug Tracking System """
-# Copyright (C) 2000, 2001, 2002, 2003, 2004, 2006  James Troup <james@nocrew.org>
+"""
+Generate Maintainers file used by e.g. the Debian Bug Tracking System
+@contact: Debian FTP Master <ftpmaster@debian.org>
+@copyright: 2000, 2001, 2002, 2003, 2004, 2006  James Troup <james@nocrew.org>
+@license: GNU General Public License version 2 or later
+
+"""
 
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -25,7 +30,8 @@
 
 ################################################################################
 
-import pg, sys
+import pg
+import sys
 import apt_pkg
 from daklib import database
 from daklib import utils
@@ -33,11 +39,11 @@ from daklib.regexes import re_comments
 
 ################################################################################
 
-projectB = None
-Cnf = None
-maintainer_from_source_cache = {}
-packages = {}
-fixed_maintainer_cache = {}
+Cnf = None                          #: Configuration, apt_pkg.Configuration
+projectB = None                     #: database connection, pgobject
+maintainer_from_source_cache = {}   #: caches the maintainer name <email> per source_id
+packages = {}                       #: packages data to write out
+fixed_maintainer_cache = {}         #: caches fixed ( L{daklib.utils.fix_maintainer} ) maintainer data
 
 ################################################################################
 
@@ -52,6 +58,15 @@ Generate an index of packages <=> Maintainers.
 ################################################################################
 
 def fix_maintainer (maintainer):
+    """
+    Fixup maintainer entry, cache the result.
+
+    @type maintainer: string
+    @param maintainer: A maintainer entry as passed to L{daklib.utils.fix_maintainer}
+
+    @rtype: tuple
+    @returns: fixed maintainer tuple
+    """
     global fixed_maintainer_cache
 
     if not fixed_maintainer_cache.has_key(maintainer):
@@ -60,9 +75,25 @@ def fix_maintainer (maintainer):
     return fixed_maintainer_cache[maintainer]
 
 def get_maintainer (maintainer):
+    """
+    Retrieves maintainer name from database, passes it through fix_maintainer and
+    passes on whatever that returns.
+
+    @type maintainer: int
+    @param maintainer: maintainer_id
+    """
     return fix_maintainer(database.get_maintainer(maintainer))
 
 def get_maintainer_from_source (source_id):
+    """
+    Returns maintainer name for given source_id.
+
+    @type source_id: int
+    @param source_id: source package id
+
+    @rtype: string
+    @return: maintainer name/email
+    """
     global maintainer_from_source_cache
 
     if not maintainer_from_source_cache.has_key(source_id):

diff --git a/dak/make_overrides.py b/dak/make_overrides.py
index 176e563f6358ff45a7b4f0923903831e3165b45a..bff25dd96d539bc4287e26f3607d3b5c0ce630dd 100755 (executable)
--- a/dak/make_overrides.py
+++ b/dak/make_overrides.py
@@ -1,7 +1,11 @@
 #!/usr/bin/env python
 
-""" Output override files for apt-ftparchive and indices/ """
-# Copyright (C) 2000, 2001, 2002, 2004, 2006  James Troup <james@nocrew.org>
+"""
+Output override files for apt-ftparchive and indices/
+@contact: Debian FTP Master <ftpmaster@debian.org>
+@copyright: 2000, 2001, 2002, 2004, 2006  James Troup <james@nocrew.org>
+@license: GNU General Public License version 2 or later
+"""
 
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -25,16 +29,17 @@
 
 ################################################################################
 
-import pg, sys
+import pg
+import sys
 import apt_pkg
 from daklib import database
 from daklib import utils
 
 ################################################################################
 
-Cnf = None
-projectB = None
-override = {}
+Cnf = None       #: Configuration, apt_pkg.Configuration
+projectB = None  #: database connection, pgobject
+override = {}    #: override data to write out
 
 ################################################################################
 
@@ -48,6 +53,22 @@ Outputs the override tables to text files.
 ################################################################################
 
 def do_list(output_file, suite, component, otype):
+    """
+    Fetch override data for suite from the database and dump it.
+
+    @type output_file: fileobject
+    @param output_file: where to write the overrides to
+
+    @type suite: string
+    @param suite: The name of the suite
+
+    @type component: string
+    @param component: The name of the component
+
+    @type otype: string
+    @param otype: type of override. deb/udeb/dsc
+
+    """
     global override
 
     suite_id = database.get_suite_id(suite)