[Spambayes-checkins] spambayes/Outlook2000/docs setup.py,NONE,1.1

Sun Jan 16 23:12:01 CET 2005

Update of /cvsroot/spambayes/spambayes/Outlook2000/docs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv8581/Outlook2000/docs

Added Files:
	setup.py 
Log Message:
A simple script that generates documentation for the configuration options.  This
 means we can just re-run this when we do a release and don't need to worry (much)
 about keeping the documentation sync'd with the code.

--- NEW FILE: setup.py ---
#!/usr/bin/env python

"""setup.py

Generate any dynamic documentation for the Outlook plug-in.
Typically, this involves options that can be set - dynamic generation means
that the information needs only be updated in one central location, and the
documentation can still stay up-to-date.
"""

# This module is part of the spambayes project, which is Copyright 2002-5
# The Python Software Foundation and is covered by the Python Software
# Foundation license.

__author__ = "Tony Meyer <ta-meyer at ihug.co.nz>"
__credits__ = "All the spambayes folk."

import os
import sys

# Fix path so we can import from Outlook2000 directory.
try:
    __file__
except NameError:
    # Create __file__ for Python 2.2
    __file__ = sys.argv[0]
# Fix __file__ for Python 2.2 & 2.3
__file__ = os.path.abspath(__file__)

sys.path.append(os.path.dirname(os.path.dirname(__file__)))

import config
from spambayes.Options import defaults
from spambayes.OptionsClass import OptionsClass
from spambayes.OptionsClass import PATH, INTEGER, REAL, HEADER_NAME

# Replace common regexes with human-readable <wink> names.
# If the value is None, then skip those options, as they are not
# human-editable.
nice_regex_names = {PATH : "Filename",
                    INTEGER : "Whole number",
                    REAL : "Number",
                    HEADER_NAME : "Email Header Name",
                    config.FOLDER_ID : None,
                    config.FIELD_NAME : "Alphanumeric characters",
                    }

table_header = """
    <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    <html>
    <head>
      <meta http-equiv="content-type"
     content="text/html; charset=ISO-8859-1">
      <title>Available options</title>
    <link rel='stylesheet' type="text/css" href="style.css" title="Intended style" />
    </head>
    <body>

    <table width="100%" cellspacing="0" cellpadding="0">
        <tr>
          <td width="380"><img src="images/sblogo.jpg" title=""
     alt="Logo" style="width: 380px; height: 77px;"></td>
    <!-- use background instead of styles to avoid mozilla bug 167262 --> <td
     background="images/span.jpg">&nbsp;</td>
          <td width="78"><img src="images/python.jpg"
     style="width: 78px; height: 77px;"></td>
        </tr>
    </table>

    <h1>Available options</h1>

    <table border='1' cellpadding='2' cellspacing='2' class="options">
      <tr class="options-heading">
        <td>Section</td>
        <td>Option Name</td>
        <td>Valid Values</td>
        <td>Default</td>
        <td>Comments</td>
      </tr>
"""

def main():
    outlook_config = config.CreateConfig()
    spambayes_config = OptionsClass()
    spambayes_config.load_defaults(defaults)

    # Create HTML pages that outline the available options.
    for fn, o, sects in [("outlook-options.html", outlook_config,
                          ("General", "Filter", "Training", "Notification")),
                         ("spambayes-options.html", spambayes_config,
                          ("Tokenizer", "General", "Classifier", "Storage"))]:
        f = open(fn, "w")
        f.write(table_header)

        for sect in sects:
            f.write('<tr style="height:1em">&nbsp;</tr>\n')
            opts = o.options_in_section(sect)
            opts.sort()
            for opt_name in opts:
                opt = o.get_option(sect, opt_name)

                # Skip experimental and deprecated.
                if opt_name.startswith("x-"):
                    continue

                # Replace regex's with readable descriptions.
                if opt.allowed_values in nice_regex_names:
                    replacement = nice_regex_names[opt.allowed_values]
                    if replacement is None:
                        continue
                    opt.allowed_values = (replacement,)

                f.write(opt.as_documentation_string(sect))
                f.write('\n')
        f.write("</table>\n")
        f.close()

    # Create pre-filled configuration files with comments.
    for fn, o in (("outlook-defaults.ini", outlook_config),
                  ("spambayes-defaults.ini", spambayes_config)):
        f = open(fn, "w")
        f.write(o.display(add_comments=True))
        f.close()

if __name__ == "__main__":
    main()