run-epydoc.py @@ -14,6 +14,8 @@ Provides a front-end to the Python standard ``optparse`` module. The It also provides a couple extra utility modules. """ +__docformat__ = "restructuredtext en" + # --------------------------------------------------------------------------- # Imports # --------------------------------------------------------------------------- @@ -71,10 +73,10 @@ class CommandLineParser(OptionParser): def die_with_usage(self, msg=None, exit_code=2): """ - Display of the usage message and exit. + Display a usage message and exit. :Parameters: - msg : string + msg : str If not set to ``None`` (the default), this message will be displayed before the usage message grizzled/cmdline.py @@ -6,6 +6,7 @@ """ ``grizzled.collections`` provides some useful Python collection classes. """ +__docformat__ = "restructuredtext en" # --------------------------------------------------------------------------- # Imports grizzled/collections/__init__.py @@ -7,6 +7,7 @@ ``grizzled.collections.dict`` contains some useful dictionary classes that extend the behavior of the built-in Python ``dict`` type. """ +__docformat__ = "restructuredtext en" # --------------------------------------------------------------------------- # Imports grizzled/collections/dict.py @@ -7,6 +7,7 @@ ``grizzled.collections.tuple`` contains some useful tuple-related classes and functions. """ +__docformat__ = "restructuredtext en" # --------------------------------------------------------------------------- # Imports @@ -170,4 +171,4 @@ if _sys.hexversion >= 0x2060000: import collections _namedtuple = collections.namedtuple else: - _namedtuple = _local_namedtuple \ No newline at end of file + _namedtuple = _local_namedtuple grizzled/collections/tuple.py @@ -171,12 +171,14 @@ That will preprocess the enhanced configuration file, producing a file that is suitable for parsing by the standard Python ``config`` module. ''' +from __future__ import absolute_import + +__docformat__ = "restructuredtext en" + # --------------------------------------------------------------------------- # Imports # --------------------------------------------------------------------------- -from __future__ import absolute_import - import ConfigParser import logging import string grizzled/config.py @@ -75,6 +75,8 @@ with this API, you use: blob = db.Binary(some_string) """ +__docformat__ = "restructuredtext en" + # --------------------------------------------------------------------------- # Imports # --------------------------------------------------------------------------- grizzled/db/__init__.py @@ -4,6 +4,8 @@ Base classes for enhanced DB drivers. """ +__docformat__ = "restructuredtext en" + # --------------------------------------------------------------------------- # Imports # --------------------------------------------------------------------------- grizzled/db/base.py @@ -4,6 +4,8 @@ Gadfly extended database driver. """ +__docformat__ = "restructuredtext en" + # --------------------------------------------------------------------------- # Imports # --------------------------------------------------------------------------- grizzled/db/dbgadfly.py @@ -5,6 +5,8 @@ A dummy database driver, useful for testing. """ +__docformat__ = "restructuredtext en" + # --------------------------------------------------------------------------- # Imports # --------------------------------------------------------------------------- grizzled/db/dummydb.py @@ -4,6 +4,8 @@ MySQL extended database driver. """ +__docformat__ = "restructuredtext en" + # --------------------------------------------------------------------------- # Imports # --------------------------------------------------------------------------- grizzled/db/mysql.py @@ -4,6 +4,8 @@ Oracle extended database driver. """ +__docformat__ = "restructuredtext en" + # --------------------------------------------------------------------------- # Imports # --------------------------------------------------------------------------- grizzled/db/oracle.py @@ -4,6 +4,8 @@ PostgreSQL extended database driver. """ +__docformat__ = "restructuredtext en" + # --------------------------------------------------------------------------- # Imports # --------------------------------------------------------------------------- grizzled/db/postgresql.py @@ -4,6 +4,8 @@ SQLite3 extended database driver. """ +__docformat__ = "restructuredtext en" + # --------------------------------------------------------------------------- # Imports # --------------------------------------------------------------------------- grizzled/db/sqlite.py @@ -4,6 +4,8 @@ SQL Server extended database driver. """ +__docformat__ = "restructuredtext en" + # --------------------------------------------------------------------------- # Imports # --------------------------------------------------------------------------- grizzled/db/sqlserver.py @@ -4,6 +4,8 @@ This module contains various Python decorators. """ +__docformat__ = "restructuredtext en" + # --------------------------------------------------------------------------- # Imports # --------------------------------------------------------------------------- grizzled/decorators.py @@ -4,6 +4,8 @@ Provides some base exception classes. """ +__docformat__ = "restructuredtext en" + # --------------------------------------------------------------------------- # Exports # --------------------------------------------------------------------------- grizzled/exception.py @@ -4,12 +4,14 @@ This module contains file- and path-related methods, classes, and modules. """ +from __future__ import with_statement, absolute_import + +__docformat__ = "restructuredtext en" + # --------------------------------------------------------------------------- # Imports # --------------------------------------------------------------------------- -from __future__ import with_statement, absolute_import - import os as _os import sys import shutil grizzled/file/__init__.py @@ -78,6 +78,7 @@ Use an include-enabled file with the standard Python logging module: ''' +__docformat__ = "restructuredtext en" __all__ = ['Includer', 'IncludeError', 'preprocess'] # --------------------------------------------------------------------------- grizzled/file/includer.py @@ -19,16 +19,16 @@ all history operations. To get the appropriate History implementation for the current platform, simply call the ``get_history()`` factory method. - -$Id$ """ +from __future__ import with_statement + +__docformat__ = "restructuredtext en" + # --------------------------------------------------------------------------- # Imports # --------------------------------------------------------------------------- -from __future__ import with_statement - import re import sys import logging grizzled/history.py @@ -3,12 +3,15 @@ """ Input/Output utility methods and classes. """ + +from __future__ import absolute_import + +__docformat__ = "restructuredtext en" + # --------------------------------------------------------------------------- # Imports # --------------------------------------------------------------------------- -from __future__ import absolute_import - import os import zipfile grizzled/io/__init__.py @@ -38,6 +38,8 @@ You can also use the ``locked_file()`` function to simplify your code: ... """ +__docformat__ = "restructuredtext en" + # --------------------------------------------------------------------------- # Imports # --------------------------------------------------------------------------- grizzled/io/filelock.py @@ -8,6 +8,8 @@ Provides some classes and functions for use with the standard Python ``logging`` module. """ +__docformat__ = "restructuredtext en" + # --------------------------------------------------------------------------- # Imports # --------------------------------------------------------------------------- grizzled/log.py @@ -13,6 +13,8 @@ The ``grizzled.misc`` module contains miscellanous functions and classes that don't seem to fit well in other modules. """ +__docformat__ = "restructuredtext en" + # --------------------------------------------------------------------------- # Imports # --------------------------------------------------------------------------- grizzled/misc.py @@ -3,12 +3,14 @@ """ Network-related methods and classes. """ +from __future__ import absolute_import + +__docformat__ = 'restructuredtext en' + # --------------------------------------------------------------------------- # Imports # --------------------------------------------------------------------------- -from __future__ import absolute_import - import urlparse import shutil import tempfile grizzled/net/__init__.py @@ -1,4 +1,6 @@ """ FTP-related modules and classes. This module is a conceptual extension to the standard ``ftplib`` Python module. -""" \ No newline at end of file +""" + +__docformat__ = 'restructuredtext en' grizzled/net/ftp/__init__.py @@ -37,7 +37,7 @@ Definitely not covered: - NCSA Telnet FTP server. Has LIST = NLST (and bad NLST for directories). """ -__docformat__ = 'restructuredtext' +__docformat__ = 'restructuredtext en' # --------------------------------------------------------------------------- # Globals grizzled/net/ftp/parse.py @@ -12,12 +12,15 @@ Overview The ``grizzled.os`` module contains some operating system-related functions and classes. It is a conceptual extension of the standard Python ``os`` module. """ + +from __future__ import absolute_import + +__docformat__ = "restructuredtext en" + # --------------------------------------------------------------------------- # Imports # --------------------------------------------------------------------------- -from __future__ import absolute_import - import logging import os as _os import sys @@ -256,6 +259,7 @@ def daemonize(no_close=False, pidfile=None): terminal. Otherwise, you'll risk having the daemon re-acquire a control terminal, which can cause it to be killed if someone logs off that terminal. + pidfile : str Path to file to which to write daemon's process ID. The string may contain a ``${pid}`` token, which is replaced with the process ID grizzled/os.py @@ -13,12 +13,15 @@ The ``grizzled.system`` module contains some functions and classes that provide information about the Python system (the Python runtime, the language, etc.). Tt is a conceptual extension of the standard Python ``sys`` module. """ + +from __future__ import absolute_import + +__docformat__ = "restructuredtext en" + # --------------------------------------------------------------------------- # Imports # --------------------------------------------------------------------------- -from __future__ import absolute_import - import sys as _sys import logging import re grizzled/system.py @@ -4,6 +4,8 @@ The ``grizzled.text`` package contains text-related classes and modules. """ +__docformat__ = "restructuredtext en" + # --------------------------------------------------------------------------- # Imports # --------------------------------------------------------------------------- grizzled/text/__init__.py 06522b060f1bf5283cee0252fab9a197a87b7409 Brian Clapper bmc@clapper.org http://github.com/bmc/grizzled/commit/1daa54c4fcaa866b27faeae78df4f361cd4cf775 1daa54c4fcaa866b27faeae78df4f361cd4cf775 2009-10-24T08:59:56-07:00 2009-10-24T08:59:56-07:00 Fixed various Epydoc errors. Added top-level script to run epydoc, so I don't have to remember the arguments I use. 80d66394cdf2d1875d6e1c34cbbdb153083d5397 Brian Clapper bmc@clapper.org