python-peps/pep2html.py

#!/usr/bin/env python
"""
convert PEP's to (X)HTML - courtesy of /F

Usage: %(PROGRAM)s [options] [peps]

Options:

    -u/--user
        SF username

    -i/--install
        After generating the HTML, install it and the plain text source file
        (.txt) SourceForge.  In that case the user's name is used in the scp
        and ssh commands, unless sf_username is given (in which case, it is
        used instead).  Without -i, sf_username is ignored.

    -q/--quiet
        Turn off verbose messages.

    -h/--help
        Print this help message and exit.

The optional argument `peps' is a list of either pep numbers or .txt files.
"""

import sys
import os
import re
import cgi
import glob
import getopt
import errno

PROGRAM = sys.argv[0]
RFCURL = 'http://www.faqs.org/rfcs/rfc%d.html'
PEPURL = 'pep-%04d.html'


HOST = "shell.sourceforge.net"                    # host for update
HDIR = "/home/groups/p/py/python/htdocs/peps"     # target host directory
LOCALVARS = "Local Variables:"

# The generated HTML doesn't validate -- you cannot use <hr> and <h3> inside
# <pre> tags.  But if I change that, the result doesn't look very nice...
DTD = ('<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"\n'
       '                      "http://www.w3.org/TR/REC-html40/loose.dtd">')

fixpat = re.compile("((http|ftp):[-_a-zA-Z0-9/.+~:?#$=&,]+)|(pep-\d+(.txt)?)|"
                    "(RFC[- ]?(?P<rfcnum>\d+))|"
                    "(PEP\s+(?P<pepnum>\d+))|"
                    ".")

EMPTYSTRING = ''
SPACE = ' '


def usage(code, msg=''):
    print >> sys.stderr, __doc__ % globals()
    if msg:
        print >> sys.stderr, msg
    sys.exit(code)


def fixanchor(current, match):
    text = match.group(0)
    link = None
    if text.startswith('http:') or text.startswith('ftp:'):
        # Strip off trailing punctuation.  Pattern taken from faqwiz.
        ltext = list(text)
        while ltext:
            c = ltext.pop()
            if c not in '();:,.?\'"<>':
                ltext.append(c)
                break
        link = EMPTYSTRING.join(ltext)
    elif text.startswith('pep-') and text <> current:
        link = os.path.splitext(text)[0] + ".html"
    elif text.startswith('PEP'):
        pepnum = int(match.group('pepnum'))
        link = PEPURL % pepnum
    elif text.startswith('RFC'):
        rfcnum = int(match.group('rfcnum'))
        link = RFCURL % rfcnum
    if link:
        return '<a href="%s">%s</a>' % (link, cgi.escape(text))
    return cgi.escape(match.group(0)) # really slow, but it works...


def fixfile(infile, outfile):
    basename = os.path.basename(infile)
    # convert plain text pep to minimal XHTML markup
    try:
        fi = open(infile)
    except IOError, e:
        if e.errno <> errno.ENOENT: raise
        print >> sys.stderr, 'Error: Skipping missing PEP file:', e.filename
        return
    fo = open(outfile, "w")
    print >> fo, DTD
    print >> fo, '<html>'
    print >> fo, '<head>'
    # head
    header = []
    pep = ""
    title = ""
    while 1:
        line = fi.readline()
        if not line.strip():
            break
        if line[0].strip():
            if ":" not in line:
                break
            key, value = line.split(":", 1)
            value = value.strip()
            header.append((key, value))
        else:
            # continuation line
            key, value = header[-1]
            value = value + line
            header[-1] = key, value
        if key.lower() == "title":
            title = value
        elif key.lower() == "pep":
            pep = value
    if pep:
        title = "PEP " + pep + " -- " + title
    if title:
        print >> fo, '  <title>%s</title>' % cgi.escape(title)
        print >> fo, '  <link rel="STYLESHEET" href="style.css">'
    print >> fo, '</head>'
    # body
    print >> fo, '<body bgcolor="white">'
    print >> fo, '<div class="navigation">'
    print >> fo, '[<b><a href="../">home</a></b>]'
    if basename <> 'pep-0000.txt':
        print >> fo, '[<b><a href=".">index</a></b>]'
    print >> fo, '[<b><a href="pep-%04d.txt">PEP source</a></b>]' % int(pep)
    print >> fo, '</div>'
    print >> fo, '<div class="header">\n<table border="0">'
    for k, v in header:
        if k.lower() in ('author', 'discussions-to'):
            mailtos = []
            for addr in v.split():
                if '@' in addr:
                    mailtos.append(
                        '<a href="mailto:%s?subject=PEP%%20%s">%s</a>' %
                        (addr, pep, addr))
                elif addr.startswith('http:'):
                    mailtos.append(
                        '<a href="%s">%s</a>' % (addr, addr))
                else:
                    mailtos.append(addr)
            v = SPACE.join(mailtos)
        elif k.lower() in ('replaces', 'replaced-by'):
            peps = ''
            for pep in v.split():
                pep = int(pep)
                peps += '<a href="pep-%04d.html">%i</a> ' % (pep, pep)
            v = peps
        else:
            v = cgi.escape(v)
        print >> fo, '  <tr><th align="right">%s:</th><td>%s</td></tr>' % (
            cgi.escape(k), v)
    print >> fo, '</table>'
    print >> fo, '</div>'
    print >> fo, '<hr />'
    print >> fo, '<pre>'
    while 1:
        line = fi.readline()
        if not line:
            break
        if line[0] == '\f':
            continue
        if line.strip() == LOCALVARS:
            break
        if line[0].strip():
            if line.strip() == LOCALVARS:
                break
            print >> fo, '</pre>'
            print >> fo, '<h3>%s</h3>' % line.strip()
            print >> fo, '<pre>',
        else:
            # PEP 0 has some special treatment
            if basename == 'pep-0000.txt':
                parts = line.split()
                if len(parts) > 1 and re.match(r'\s*\d{1,4}', parts[1]):
                    # This is a PEP summary line, which we need to hyperlink
                    url = PEPURL % int(parts[1])
                    print >> fo, re.sub(
                        parts[1],
                        '<a href="%s">%s</a>' % (url, parts[1]),
                        line, 1),
                    continue
                elif parts and '@' in parts[-1]:
                    # This is a pep email address line, so hyperlink it
                    url = '<a href="mailto:%s">%s</a>' % (parts[-1], parts[-1])
                    print >> fo, re.sub(
                        parts[-1], url, line, 1),
                    continue
            line = fixpat.sub(lambda x, c=infile: fixanchor(c, x), line)
            fo.write(line)
    print >> fo, '</pre>'
    print >> fo, '</body>'
    print >> fo, '</html>'
    fo.close()
    os.chmod(outfile, 0664)


def find_pep(pep_str):
    """Find the .txt file indicated by a cmd line argument"""
    if os.path.exists(pep_str):
        return pep_str
    num = int(pep_str)
    return "pep-%04d.txt" % num

def make_html(file, verbose=0):
    newfile = os.path.splitext(file)[0] + ".html"
    if verbose:
        print file, "->", newfile
    fixfile(file, newfile)
    return newfile

def push_pep(htmlfiles, txtfiles, username, verbose):
    if verbose:
        quiet = ""
    else:
        quiet = "-q"
    if username:
        username = username + "@"
    target = username + HOST + ":" + HDIR
    files = htmlfiles[:]
    files.extend(txtfiles)
    files.append("style.css")
    filelist = SPACE.join(files)
    rc = os.system("scp %s %s %s" % (quiet, filelist, target))
    if rc:
        sys.exit(rc)
    rc = os.system("ssh %s%s chmod 664 %s/*" % (username, HOST, HDIR))
    if rc:
        sys.exit(rc)


def main():
    # defaults
    update = 0
    username = ''
    verbose = 1

    try:
        opts, args = getopt.getopt(sys.argv[1:], 'ihqu:',
                                   ['install', 'help', 'quiet', 'user='])
    except getopt.error, msg:
        usage(1, msg)

    for opt, arg in opts:
        if opt in ('-h', '--help'):
            usage(0)
        elif opt in ('-i', '--install'):
            update = 1
        elif opt in ('-u', '--user'):
            username = arg
        elif opt in ('-q', '--quiet'):
            verbose = 0

    if args:
        peptxt = []
        html = []
        for pep in args:
            file = find_pep(pep)
            peptxt.append(file)
            newfile = make_html(file, verbose=verbose)
            html.append(newfile)
    else:
        # do them all
        peptxt = []
        for file in glob.glob("pep-*.txt"):
            peptxt.append(file)
            make_html(file, verbose=verbose)
        html = ["pep-*.html"]
    if update:
        push_pep(html, peptxt, username, verbose)


if __name__ == "__main__":
    main()
-												converts pep-*.txt to pep-*.html and loads them up with the help of scp

it would be nice if you could call it after committing changes on a pep

Syntax: python pep2html [sf_username]

											
										
										
											2000-07-20 18:29:24 -04:00
+								#!/usr/bin/env python
 								"""
 								convert PEP's to (X)HTML - courtesy of /F
-												new usage to support conversion of only specified PEPs

Usage: %(PROGRAM)s [options] [peps]
Notes:
    The optional argument peps can be either pep numbers or .txt files.
Options:
    -u/--user
        SF username
    [rest is the same]

											
										
										
											2000-08-28 12:00:49 -04:00
+								Usage: %(PROGRAM)s [options] [peps]
-												Changed the sense of the default behavior.  No longer installs the
.html files in SF by default; you must explicitly include the
-i/--install option in order to upload.

Also, added -h/--help and migrated to getopt for switch parsing.
Included a usage() function.

Some cosmetic changes.

											
										
										
											2000-08-15 01:53:19 -04:00
+								Options:
-												Revise the generated HTML to be a little nicer, but still pretty simple.
Also add a -n option to suppress installing the generated HTML at
SourceForge to allow local use.

											
										
										
											2000-07-24 23:51:44 -04:00
-												new usage to support conversion of only specified PEPs

Usage: %(PROGRAM)s [options] [peps]
Notes:
    The optional argument peps can be either pep numbers or .txt files.
Options:
    -u/--user
        SF username
    [rest is the same]

											
										
										
											2000-08-28 12:00:49 -04:00
+								    -u/--user
 								        SF username
-												Changed the sense of the default behavior.  No longer installs the
.html files in SF by default; you must explicitly include the
-i/--install option in order to upload.

Also, added -h/--help and migrated to getopt for switch parsing.
Included a usage() function.

Some cosmetic changes.

											
										
										
											2000-08-15 01:53:19 -04:00
+								    -i/--install
-												push_html() -> push_pep()

push_pep(), main(): Arrange for the .txt source file to also be scp
uploaded to SF when the -i/--install flag is given.

											
										
										
											2001-03-20 10:07:21 -05:00
+								        After generating the HTML, install it and the plain text source file
 								        (.txt) SourceForge.  In that case the user's name is used in the scp
 								        and ssh commands, unless sf_username is given (in which case, it is
 								        used instead).  Without -i, sf_username is ignored.
-												Revise the generated HTML to be a little nicer, but still pretty simple.
Also add a -n option to suppress installing the generated HTML at
SourceForge to allow local use.

											
										
										
											2000-07-24 23:51:44 -04:00
-												Document -q/--quiet in the module docstring.

											
										
										
											2000-11-03 10:43:28 -05:00
+								    -q/--quiet
 								        Turn off verbose messages.
-												Changed the sense of the default behavior.  No longer installs the
.html files in SF by default; you must explicitly include the
-i/--install option in order to upload.

Also, added -h/--help and migrated to getopt for switch parsing.
Included a usage() function.

Some cosmetic changes.

											
										
										
											2000-08-15 01:53:19 -04:00
+								    -h/--help
 								        Print this help message and exit.
-												Slight rewording of docstring.

											
										
										
											2001-11-12 09:58:07 -05:00
 								The optional argument `peps' is a list of either pep numbers or .txt files.
-												converts pep-*.txt to pep-*.html and loads them up with the help of scp

it would be nice if you could call it after committing changes on a pep

Syntax: python pep2html [sf_username]

											
										
										
											2000-07-20 18:29:24 -04:00
+								"""
-												Changed the sense of the default behavior.  No longer installs the
.html files in SF by default; you must explicitly include the
-i/--install option in order to upload.

Also, added -h/--help and migrated to getopt for switch parsing.
Included a usage() function.

Some cosmetic changes.

											
										
										
											2000-08-15 01:53:19 -04:00
+								import sys
 								import os
 								import re
 								import cgi
 								import glob
 								import getopt
-												fixpat: Recognize current preferred usage for PEP references in body,
e.g. "PEP 1".

fixanchor(): Turn preferred usage for PEP references into PEP url
using the new PEPURL template (which uses the canonical
www.python.org/peps url instead of the sourceforge.net site).
(Also, get rid of base argument in int() calls; base 10 is default.)

fixfile(): If we can't open the input file, print an error message and
continue on.

											
										
										
											2001-07-05 14:44:20 -04:00
+								import errno
-												converts pep-*.txt to pep-*.html and loads them up with the help of scp

it would be nice if you could call it after committing changes on a pep

Syntax: python pep2html [sf_username]

											
										
										
											2000-07-20 18:29:24 -04:00
-												Changed the sense of the default behavior.  No longer installs the
.html files in SF by default; you must explicitly include the
-i/--install option in order to upload.

Also, added -h/--help and migrated to getopt for switch parsing.
Included a usage() function.

Some cosmetic changes.

											
										
										
											2000-08-15 01:53:19 -04:00
+								PROGRAM = sys.argv[0]
-												fixanchor(): Use a module global RFCURL template for RFC urls.  Change
this template to point at the nice faqs.org html-ified RFCs.

											
										
										
											2001-06-05 13:21:19 -04:00
+								RFCURL = 'http://www.faqs.org/rfcs/rfc%d.html'
-												fixpat: Recognize current preferred usage for PEP references in body,
e.g. "PEP 1".

fixanchor(): Turn preferred usage for PEP references into PEP url
using the new PEPURL template (which uses the canonical
www.python.org/peps url instead of the sourceforge.net site).
(Also, get rid of base argument in int() calls; base 10 is default.)

fixfile(): If we can't open the input file, print an error message and
continue on.

											
										
										
											2001-07-05 14:44:20 -04:00
+								PEPURL = 'pep-%04d.html'
-												incorporating changes from /F

not including pep-0000.txt -> index.html (a symbolic link does just fine)

											
										
										
											2000-07-20 18:44:36 -04:00
-												Changed the sense of the default behavior.  No longer installs the
.html files in SF by default; you must explicitly include the
-i/--install option in order to upload.

Also, added -h/--help and migrated to getopt for switch parsing.
Included a usage() function.

Some cosmetic changes.

											
										
										
											2000-08-15 01:53:19 -04:00
 								HOST = "shell.sourceforge.net"                    # host for update
-												The home directory for the python project has moved (and the symlink removed).

											
										
										
											2001-05-01 13:53:52 -04:00
+								HDIR = "/home/groups/p/py/python/htdocs/peps"     # target host directory
-												Moved "Local Variables:" string farther away from the end of the file,
so Emacs doesn't think this actually indicates the beginning of a
local variable section!

											
										
										
											2000-07-28 02:40:10 -04:00
+								LOCALVARS = "Local Variables:"
-												try to change rights of peps to rw-rw-r--

											
										
										
											2000-07-25 00:12:28 -04:00
-												Changed the sense of the default behavior.  No longer installs the
.html files in SF by default; you must explicitly include the
-i/--install option in order to upload.

Also, added -h/--help and migrated to getopt for switch parsing.
Included a usage() function.

Some cosmetic changes.

											
										
										
											2000-08-15 01:53:19 -04:00
+								# The generated HTML doesn't validate -- you cannot use <hr> and <h3> inside
 								# <pre> tags.  But if I change that, the result doesn't look very nice...
-												Revise the generated HTML to be a little nicer, but still pretty simple.
Also add a -n option to suppress installing the generated HTML at
SourceForge to allow local use.

											
										
										
											2000-07-24 23:51:44 -04:00
+								DTD = ('<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"\n'
 								       '                      "http://www.w3.org/TR/REC-html40/loose.dtd">')
-												incorporating changes from /F

not including pep-0000.txt -> index.html (a symbolic link does just fine)

											
										
										
											2000-07-20 18:44:36 -04:00
-												fixpat: Add , to the list of punctuation allowable in a url.

fixanchor(): Adopt the algorithm for url recognition from faqwiz after
    suggestion by Guido.  Strip any trailing punctuation from the end
    of the url.

    Also, use .startswith() where appropriate.

											
										
										
											2001-08-14 17:42:39 -04:00
+								fixpat = re.compile("((http|ftp):[-_a-zA-Z0-9/.+~:?#$=&,]+)|(pep-\d+(.txt)?)|"
-												fixpat: Recognize current preferred usage for PEP references in body,
e.g. "PEP 1".

fixanchor(): Turn preferred usage for PEP references into PEP url
using the new PEPURL template (which uses the canonical
www.python.org/peps url instead of the sourceforge.net site).
(Also, get rid of base argument in int() calls; base 10 is default.)

fixfile(): If we can't open the input file, print an error message and
continue on.

											
										
										
											2001-07-05 14:44:20 -04:00
+								                    "(RFC[- ]?(?P<rfcnum>\d+))|"
 								                    "(PEP\s+(?P<pepnum>\d+))|"
 								                    ".")
-												converts pep-*.txt to pep-*.html and loads them up with the help of scp

it would be nice if you could call it after committing changes on a pep

Syntax: python pep2html [sf_username]

											
										
										
											2000-07-20 18:29:24 -04:00
-												fixpat: Add , to the list of punctuation allowable in a url.

fixanchor(): Adopt the algorithm for url recognition from faqwiz after
    suggestion by Guido.  Strip any trailing punctuation from the end
    of the url.

    Also, use .startswith() where appropriate.

											
										
										
											2001-08-14 17:42:39 -04:00
+								EMPTYSTRING = ''
 								SPACE = ' '
-												Changed the sense of the default behavior.  No longer installs the
.html files in SF by default; you must explicitly include the
-i/--install option in order to upload.

Also, added -h/--help and migrated to getopt for switch parsing.
Included a usage() function.

Some cosmetic changes.

											
										
										
											2000-08-15 01:53:19 -04:00
 								def usage(code, msg=''):
-												Fixed a typo which caused help (-h) to fail.

											
										
										
											2002-02-04 17:38:27 -05:00
+								    print >> sys.stderr, __doc__ % globals()
-												Changed the sense of the default behavior.  No longer installs the
.html files in SF by default; you must explicitly include the
-i/--install option in order to upload.

Also, added -h/--help and migrated to getopt for switch parsing.
Included a usage() function.

Some cosmetic changes.

											
										
										
											2000-08-15 01:53:19 -04:00
+								    if msg:
-												fixfile(): Added special casing to handle the new PEP 0 format, which
    eliminates the "filename" field in favor of just the unadorned PEP
    number.

											
										
										
											2001-08-14 12:45:19 -04:00
+								        print >> sys.stderr, msg
-												Changed the sense of the default behavior.  No longer installs the
.html files in SF by default; you must explicitly include the
-i/--install option in order to upload.

Also, added -h/--help and migrated to getopt for switch parsing.
Included a usage() function.

Some cosmetic changes.

											
										
										
											2000-08-15 01:53:19 -04:00
+								    sys.exit(code)
-												Revise the generated HTML to be a little nicer, but still pretty simple.
Also add a -n option to suppress installing the generated HTML at
SourceForge to allow local use.

											
										
										
											2000-07-24 23:51:44 -04:00
+								def fixanchor(current, match):
-												converts pep-*.txt to pep-*.html and loads them up with the help of scp

it would be nice if you could call it after committing changes on a pep

Syntax: python pep2html [sf_username]

											
										
										
											2000-07-20 18:29:24 -04:00
+								    text = match.group(0)
 								    link = None
-												fixpat: Add , to the list of punctuation allowable in a url.

fixanchor(): Adopt the algorithm for url recognition from faqwiz after
    suggestion by Guido.  Strip any trailing punctuation from the end
    of the url.

    Also, use .startswith() where appropriate.

											
										
										
											2001-08-14 17:42:39 -04:00
+								    if text.startswith('http:') or text.startswith('ftp:'):
 								        # Strip off trailing punctuation.  Pattern taken from faqwiz.
 								        ltext = list(text)
 								        while ltext:
 								            c = ltext.pop()
 								            if c not in '();:,.?\'"<>':
 								                ltext.append(c)
 								                break
 								        link = EMPTYSTRING.join(ltext)
 								    elif text.startswith('pep-') and text <> current:
-												converts pep-*.txt to pep-*.html and loads them up with the help of scp

it would be nice if you could call it after committing changes on a pep

Syntax: python pep2html [sf_username]

											
										
										
											2000-07-20 18:29:24 -04:00
+								        link = os.path.splitext(text)[0] + ".html"
-												fixpat: Add , to the list of punctuation allowable in a url.

fixanchor(): Adopt the algorithm for url recognition from faqwiz after
    suggestion by Guido.  Strip any trailing punctuation from the end
    of the url.

    Also, use .startswith() where appropriate.

											
										
										
											2001-08-14 17:42:39 -04:00
+								    elif text.startswith('PEP'):
-												fixpat: Recognize current preferred usage for PEP references in body,
e.g. "PEP 1".

fixanchor(): Turn preferred usage for PEP references into PEP url
using the new PEPURL template (which uses the canonical
www.python.org/peps url instead of the sourceforge.net site).
(Also, get rid of base argument in int() calls; base 10 is default.)

fixfile(): If we can't open the input file, print an error message and
continue on.

											
										
										
											2001-07-05 14:44:20 -04:00
+								        pepnum = int(match.group('pepnum'))
 								        link = PEPURL % pepnum
-												fixpat: Add , to the list of punctuation allowable in a url.

fixanchor(): Adopt the algorithm for url recognition from faqwiz after
    suggestion by Guido.  Strip any trailing punctuation from the end
    of the url.

    Also, use .startswith() where appropriate.

											
										
										
											2001-08-14 17:42:39 -04:00
+								    elif text.startswith('RFC'):
-												fixpat: Recognize current preferred usage for PEP references in body,
e.g. "PEP 1".

fixanchor(): Turn preferred usage for PEP references into PEP url
using the new PEPURL template (which uses the canonical
www.python.org/peps url instead of the sourceforge.net site).
(Also, get rid of base argument in int() calls; base 10 is default.)

fixfile(): If we can't open the input file, print an error message and
continue on.

											
										
										
											2001-07-05 14:44:20 -04:00
+								        rfcnum = int(match.group('rfcnum'))
-												fixanchor(): Use a module global RFCURL template for RFC urls.  Change
this template to point at the nice faqs.org html-ified RFCs.

											
										
										
											2001-06-05 13:21:19 -04:00
+								        link = RFCURL % rfcnum
-												converts pep-*.txt to pep-*.html and loads them up with the help of scp

it would be nice if you could call it after committing changes on a pep

Syntax: python pep2html [sf_username]

											
										
										
											2000-07-20 18:29:24 -04:00
+								    if link:
-												fixfile(): Added special casing to handle the new PEP 0 format, which
    eliminates the "filename" field in favor of just the unadorned PEP
    number.

											
										
										
											2001-08-14 12:45:19 -04:00
+								        return '<a href="%s">%s</a>' % (link, cgi.escape(text))
-												incorporating changes from /F

not including pep-0000.txt -> index.html (a symbolic link does just fine)

											
										
										
											2000-07-20 18:44:36 -04:00
+								    return cgi.escape(match.group(0)) # really slow, but it works...
-												converts pep-*.txt to pep-*.html and loads them up with the help of scp

it would be nice if you could call it after committing changes on a pep

Syntax: python pep2html [sf_username]

											
										
										
											2000-07-20 18:29:24 -04:00
-												Changed the sense of the default behavior.  No longer installs the
.html files in SF by default; you must explicitly include the
-i/--install option in order to upload.

Also, added -h/--help and migrated to getopt for switch parsing.
Included a usage() function.

Some cosmetic changes.

											
										
										
											2000-08-15 01:53:19 -04:00
-												converts pep-*.txt to pep-*.html and loads them up with the help of scp

it would be nice if you could call it after committing changes on a pep

Syntax: python pep2html [sf_username]

											
										
										
											2000-07-20 18:29:24 -04:00
+								def fixfile(infile, outfile):
-												fixfile(): Added special casing to handle the new PEP 0 format, which
    eliminates the "filename" field in favor of just the unadorned PEP
    number.

											
										
										
											2001-08-14 12:45:19 -04:00
+								    basename = os.path.basename(infile)
-												converts pep-*.txt to pep-*.html and loads them up with the help of scp

it would be nice if you could call it after committing changes on a pep

Syntax: python pep2html [sf_username]

											
										
										
											2000-07-20 18:29:24 -04:00
+								    # convert plain text pep to minimal XHTML markup
-												fixpat: Recognize current preferred usage for PEP references in body,
e.g. "PEP 1".

fixanchor(): Turn preferred usage for PEP references into PEP url
using the new PEPURL template (which uses the canonical
www.python.org/peps url instead of the sourceforge.net site).
(Also, get rid of base argument in int() calls; base 10 is default.)

fixfile(): If we can't open the input file, print an error message and
continue on.

											
										
										
											2001-07-05 14:44:20 -04:00
+								    try:
 								        fi = open(infile)
 								    except IOError, e:
 								        if e.errno <> errno.ENOENT: raise
 								        print >> sys.stderr, 'Error: Skipping missing PEP file:', e.filename
 								        return
-												converts pep-*.txt to pep-*.html and loads them up with the help of scp

it would be nice if you could call it after committing changes on a pep

Syntax: python pep2html [sf_username]

											
										
										
											2000-07-20 18:29:24 -04:00
+								    fo = open(outfile, "w")
-												fixfile(): Added special casing to handle the new PEP 0 format, which
    eliminates the "filename" field in favor of just the unadorned PEP
    number.

											
										
										
											2001-08-14 12:45:19 -04:00
+								    print >> fo, DTD
 								    print >> fo, '<html>'
 								    print >> fo, '<head>'
-												converts pep-*.txt to pep-*.html and loads them up with the help of scp

it would be nice if you could call it after committing changes on a pep

Syntax: python pep2html [sf_username]

											
										
										
											2000-07-20 18:29:24 -04:00
+								    # head
 								    header = []
-												incorporating changes from /F

not including pep-0000.txt -> index.html (a symbolic link does just fine)

											
										
										
											2000-07-20 18:44:36 -04:00
+								    pep = ""
 								    title = ""
-												converts pep-*.txt to pep-*.html and loads them up with the help of scp

it would be nice if you could call it after committing changes on a pep

Syntax: python pep2html [sf_username]

											
										
										
											2000-07-20 18:29:24 -04:00
+								    while 1:
 								        line = fi.readline()
-												Handle RFC822-style continuation lines.  One of these appeared in PEP-0001.

											
										
										
											2000-07-27 15:18:59 -04:00
+								        if not line.strip():
-												converts pep-*.txt to pep-*.html and loads them up with the help of scp

it would be nice if you could call it after committing changes on a pep

Syntax: python pep2html [sf_username]

											
										
										
											2000-07-20 18:29:24 -04:00
+								            break
-												Handle RFC822-style continuation lines.  One of these appeared in PEP-0001.

											
										
										
											2000-07-27 15:18:59 -04:00
+								        if line[0].strip():
 								            if ":" not in line:
 								                break
 								            key, value = line.split(":", 1)
 								            value = value.strip()
 								            header.append((key, value))
 								        else:
 								            # continuation line
 								            key, value = header[-1]
 								            value = value + line
 								            header[-1] = key, value
-												converts pep-*.txt to pep-*.html and loads them up with the help of scp

it would be nice if you could call it after committing changes on a pep

Syntax: python pep2html [sf_username]

											
										
										
											2000-07-20 18:29:24 -04:00
+								        if key.lower() == "title":
-												incorporating changes from /F

not including pep-0000.txt -> index.html (a symbolic link does just fine)

											
										
										
											2000-07-20 18:44:36 -04:00
+								            title = value
-												Handle RFC822-style continuation lines.  One of these appeared in PEP-0001.

											
										
										
											2000-07-27 15:18:59 -04:00
+								        elif key.lower() == "pep":
-												incorporating changes from /F

not including pep-0000.txt -> index.html (a symbolic link does just fine)

											
										
										
											2000-07-20 18:44:36 -04:00
+								            pep = value
 								    if pep:
 								        title = "PEP " + pep + " -- " + title
 								    if title:
-												fixfile(): Added special casing to handle the new PEP 0 format, which
    eliminates the "filename" field in favor of just the unadorned PEP
    number.

											
										
										
											2001-08-14 12:45:19 -04:00
+								        print >> fo, '  <title>%s</title>' % cgi.escape(title)
 								        print >> fo, '  <link rel="STYLESHEET" href="style.css">'
 								    print >> fo, '</head>'
-												converts pep-*.txt to pep-*.html and loads them up with the help of scp

it would be nice if you could call it after committing changes on a pep

Syntax: python pep2html [sf_username]

											
										
										
											2000-07-20 18:29:24 -04:00
+								    # body
-												fixfile(): Added special casing to handle the new PEP 0 format, which
    eliminates the "filename" field in favor of just the unadorned PEP
    number.

											
										
										
											2001-08-14 12:45:19 -04:00
+								    print >> fo, '<body bgcolor="white">'
 								    print >> fo, '<div class="navigation">'
 								    print >> fo, '[<b><a href="../">home</a></b>]'
 								    if basename <> 'pep-0000.txt':
 								        print >> fo, '[<b><a href=".">index</a></b>]'
 								    print >> fo, '[<b><a href="pep-%04d.txt">PEP source</a></b>]' % int(pep)
 								    print >> fo, '</div>'
 								    print >> fo, '<div class="header">\n<table border="0">'
-												converts pep-*.txt to pep-*.html and loads them up with the help of scp

it would be nice if you could call it after committing changes on a pep

Syntax: python pep2html [sf_username]

											
										
										
											2000-07-20 18:29:24 -04:00
+								    for k, v in header:
-												fixfile(): Do the mailto: hacking on both the Author: and
Discussions-To: headers.  Also, apply SF patch #410223 by Andrew
Kuchling, which does the PEP# href wrapping for Replaces: and
Replaced-By: headers.

											
										
										
											2001-03-21 12:26:05 -05:00
+								        if k.lower() in ('author', 'discussions-to'):
-												Linkify the Author: fields with mailto urls.

											
										
										
											2000-08-17 00:27:04 -04:00
+								            mailtos = []
 								            for addr in v.split():
 								                if '@' in addr:
 								                    mailtos.append(
 								                        '<a href="mailto:%s?subject=PEP%%20%s">%s</a>' %
 								                        (addr, pep, addr))
-												fixfile(): Discussions-To: can contain an address or a url.  Adjust
the text accordingly.

											
										
										
											2001-03-21 13:59:03 -05:00
+								                elif addr.startswith('http:'):
 								                    mailtos.append(
 								                        '<a href="%s">%s</a>' % (addr, addr))
-												Linkify the Author: fields with mailto urls.

											
										
										
											2000-08-17 00:27:04 -04:00
+								                else:
 								                    mailtos.append(addr)
-												fixpat: Add , to the list of punctuation allowable in a url.

fixanchor(): Adopt the algorithm for url recognition from faqwiz after
    suggestion by Guido.  Strip any trailing punctuation from the end
    of the url.

    Also, use .startswith() where appropriate.

											
										
										
											2001-08-14 17:42:39 -04:00
+								            v = SPACE.join(mailtos)
-												fixfile(): Do the mailto: hacking on both the Author: and
Discussions-To: headers.  Also, apply SF patch #410223 by Andrew
Kuchling, which does the PEP# href wrapping for Replaces: and
Replaced-By: headers.

											
										
										
											2001-03-21 12:26:05 -05:00
+								        elif k.lower() in ('replaces', 'replaced-by'):
 								            peps = ''
 								            for pep in v.split():
 								                pep = int(pep)
 								                peps += '<a href="pep-%04d.html">%i</a> ' % (pep, pep)
 								            v = peps
-												Linkify the Author: fields with mailto urls.

											
										
										
											2000-08-17 00:27:04 -04:00
+								        else:
 								            v = cgi.escape(v)
-												fixfile(): Added special casing to handle the new PEP 0 format, which
    eliminates the "filename" field in favor of just the unadorned PEP
    number.

											
										
										
											2001-08-14 12:45:19 -04:00
+								        print >> fo, '  <tr><th align="right">%s:</th><td>%s</td></tr>' % (
 								            cgi.escape(k), v)
 								    print >> fo, '</table>'
 								    print >> fo, '</div>'
 								    print >> fo, '<hr />'
 								    print >> fo, '<pre>'
-												converts pep-*.txt to pep-*.html and loads them up with the help of scp

it would be nice if you could call it after committing changes on a pep

Syntax: python pep2html [sf_username]

											
										
										
											2000-07-20 18:29:24 -04:00
+								    while 1:
 								        line = fi.readline()
 								        if not line:
 								            break
-												fixfile(): Added special casing to handle the new PEP 0 format, which
    eliminates the "filename" field in favor of just the unadorned PEP
    number.

											
										
										
											2001-08-14 12:45:19 -04:00
+								        if line[0] == '\f':
 								            continue
 								        if line.strip() == LOCALVARS:
 								            break
 								        if line[0].strip():
 								            if line.strip() == LOCALVARS:
 								                break
 								            print >> fo, '</pre>'
 								            print >> fo, '<h3>%s</h3>' % line.strip()
 								            print >> fo, '<pre>',
 								        else:
 								            # PEP 0 has some special treatment
 								            if basename == 'pep-0000.txt':
 								                parts = line.split()
 								                if len(parts) > 1 and re.match(r'\s*\d{1,4}', parts[1]):
 								                    # This is a PEP summary line, which we need to hyperlink
 								                    url = PEPURL % int(parts[1])
 								                    print >> fo, re.sub(
 								                        parts[1],
 								                        '<a href="%s">%s</a>' % (url, parts[1]),
 								                        line, 1),
 								                    continue
 								                elif parts and '@' in parts[-1]:
 								                    # This is a pep email address line, so hyperlink it
 								                    url = '<a href="mailto:%s">%s</a>' % (parts[-1], parts[-1])
 								                    print >> fo, re.sub(
 								                        parts[-1], url, line, 1),
 								                    continue
 								            line = fixpat.sub(lambda x, c=infile: fixanchor(c, x), line)
 								            fo.write(line)
 								    print >> fo, '</pre>'
 								    print >> fo, '</body>'
 								    print >> fo, '</html>'
-												try to change rights of peps to rw-rw-r--

											
										
										
											2000-07-25 00:12:28 -04:00
+								    fo.close()
 								    os.chmod(outfile, 0664)
-												converts pep-*.txt to pep-*.html and loads them up with the help of scp

it would be nice if you could call it after committing changes on a pep

Syntax: python pep2html [sf_username]

											
										
										
											2000-07-20 18:29:24 -04:00
-												fixfile(): Added special casing to handle the new PEP 0 format, which
    eliminates the "filename" field in favor of just the unadorned PEP
    number.

											
										
										
											2001-08-14 12:45:19 -04:00
-												new usage to support conversion of only specified PEPs

Usage: %(PROGRAM)s [options] [peps]
Notes:
    The optional argument peps can be either pep numbers or .txt files.
Options:
    -u/--user
        SF username
    [rest is the same]

											
										
										
											2000-08-28 12:00:49 -04:00
 								def find_pep(pep_str):
 								    """Find the .txt file indicated by a cmd line argument"""
 								    if os.path.exists(pep_str):
 								        return pep_str
 								    num = int(pep_str)
 								    return "pep-%04d.txt" % num
-												Added a -q/--quiet option to suppress the per-file progress message.
Fixed the branch for files specified from the command line to only update
the Web server if the -u/--update option was used.

											
										
										
											2000-09-06 21:26:46 -04:00
+								def make_html(file, verbose=0):
-												new usage to support conversion of only specified PEPs

Usage: %(PROGRAM)s [options] [peps]
Notes:
    The optional argument peps can be either pep numbers or .txt files.
Options:
    -u/--user
        SF username
    [rest is the same]

											
										
										
											2000-08-28 12:00:49 -04:00
+								    newfile = os.path.splitext(file)[0] + ".html"
-												Added a -q/--quiet option to suppress the per-file progress message.
Fixed the branch for files specified from the command line to only update
the Web server if the -u/--update option was used.

											
										
										
											2000-09-06 21:26:46 -04:00
+								    if verbose:
 								        print file, "->", newfile
-												new usage to support conversion of only specified PEPs

Usage: %(PROGRAM)s [options] [peps]
Notes:
    The optional argument peps can be either pep numbers or .txt files.
Options:
    -u/--user
        SF username
    [rest is the same]

											
										
										
											2000-08-28 12:00:49 -04:00
+								    fixfile(file, newfile)
 								    return newfile
-												Revise the generated HTML to be a little nicer, but still pretty simple.
Also add a -n option to suppress installing the generated HTML at
SourceForge to allow local use.

											
										
										
											2000-07-24 23:51:44 -04:00
-												push_html() -> push_pep()

push_pep(), main(): Arrange for the .txt source file to also be scp
uploaded to SF when the -i/--install flag is given.

											
										
										
											2001-03-20 10:07:21 -05:00
+								def push_pep(htmlfiles, txtfiles, username, verbose):
-												push_html():  New function; handles the mechanics of actually pushing the
              generated HTML to SourceForge.

main():  Adjust to use push_html(), and simplify the logic so it only
         gets called from one place.

											
										
										
											2000-09-08 11:31:36 -04:00
+								    if verbose:
 								        quiet = ""
 								    else:
 								        quiet = "-q"
 								    if username:
 								        username = username + "@"
 								    target = username + HOST + ":" + HDIR
-												push_html() -> push_pep()

push_pep(), main(): Arrange for the .txt source file to also be scp
uploaded to SF when the -i/--install flag is given.

											
										
										
											2001-03-20 10:07:21 -05:00
+								    files = htmlfiles[:]
 								    files.extend(txtfiles)
-												push_html():  New function; handles the mechanics of actually pushing the
              generated HTML to SourceForge.

main():  Adjust to use push_html(), and simplify the logic so it only
         gets called from one place.

											
										
										
											2000-09-08 11:31:36 -04:00
+								    files.append("style.css")
-												push_html() -> push_pep()

push_pep(), main(): Arrange for the .txt source file to also be scp
uploaded to SF when the -i/--install flag is given.

											
										
										
											2001-03-20 10:07:21 -05:00
+								    filelist = SPACE.join(files)
-												push_html():  New function; handles the mechanics of actually pushing the
              generated HTML to SourceForge.

main():  Adjust to use push_html(), and simplify the logic so it only
         gets called from one place.

											
										
										
											2000-09-08 11:31:36 -04:00
+								    rc = os.system("scp %s %s %s" % (quiet, filelist, target))
 								    if rc:
 								        sys.exit(rc)
 								    rc = os.system("ssh %s%s chmod 664 %s/*" % (username, HOST, HDIR))
 								    if rc:
 								        sys.exit(rc)
-												Changed the sense of the default behavior.  No longer installs the
.html files in SF by default; you must explicitly include the
-i/--install option in order to upload.

Also, added -h/--help and migrated to getopt for switch parsing.
Included a usage() function.

Some cosmetic changes.

											
										
										
											2000-08-15 01:53:19 -04:00
-												Revise the generated HTML to be a little nicer, but still pretty simple.
Also add a -n option to suppress installing the generated HTML at
SourceForge to allow local use.

											
										
										
											2000-07-24 23:51:44 -04:00
+								def main():
-												Changed the sense of the default behavior.  No longer installs the
.html files in SF by default; you must explicitly include the
-i/--install option in order to upload.

Also, added -h/--help and migrated to getopt for switch parsing.
Included a usage() function.

Some cosmetic changes.

											
										
										
											2000-08-15 01:53:19 -04:00
+								    # defaults
 								    update = 0
 								    username = ''
-												Added a -q/--quiet option to suppress the per-file progress message.
Fixed the branch for files specified from the command line to only update
the Web server if the -u/--update option was used.

											
										
										
											2000-09-06 21:26:46 -04:00
+								    verbose = 1
-												Changed the sense of the default behavior.  No longer installs the
.html files in SF by default; you must explicitly include the
-i/--install option in order to upload.

Also, added -h/--help and migrated to getopt for switch parsing.
Included a usage() function.

Some cosmetic changes.

											
										
										
											2000-08-15 01:53:19 -04:00
 								    try:
-												Add -u and --user options to the call to getopt, to make them actually work.

											
										
										
											2000-11-01 18:45:47 -05:00
+								        opts, args = getopt.getopt(sys.argv[1:], 'ihqu:',
 								                                   ['install', 'help', 'quiet', 'user='])
-												Changed the sense of the default behavior.  No longer installs the
.html files in SF by default; you must explicitly include the
-i/--install option in order to upload.

Also, added -h/--help and migrated to getopt for switch parsing.
Included a usage() function.

Some cosmetic changes.

											
										
										
											2000-08-15 01:53:19 -04:00
+								    except getopt.error, msg:
 								        usage(1, msg)
 								    for opt, arg in opts:
 								        if opt in ('-h', '--help'):
 								            usage(0)
 								        elif opt in ('-i', '--install'):
 								            update = 1
-												new usage to support conversion of only specified PEPs

Usage: %(PROGRAM)s [options] [peps]
Notes:
    The optional argument peps can be either pep numbers or .txt files.
Options:
    -u/--user
        SF username
    [rest is the same]

											
										
										
											2000-08-28 12:00:49 -04:00
+								        elif opt in ('-u', '--user'):
-												push_html():  New function; handles the mechanics of actually pushing the
              generated HTML to SourceForge.

main():  Adjust to use push_html(), and simplify the logic so it only
         gets called from one place.

											
										
										
											2000-09-08 11:31:36 -04:00
+								            username = arg
-												Added a -q/--quiet option to suppress the per-file progress message.
Fixed the branch for files specified from the command line to only update
the Web server if the -u/--update option was used.

											
										
										
											2000-09-06 21:26:46 -04:00
+								        elif opt in ('-q', '--quiet'):
 								            verbose = 0
-												Changed the sense of the default behavior.  No longer installs the
.html files in SF by default; you must explicitly include the
-i/--install option in order to upload.

Also, added -h/--help and migrated to getopt for switch parsing.
Included a usage() function.

Some cosmetic changes.

											
										
										
											2000-08-15 01:53:19 -04:00
-												new usage to support conversion of only specified PEPs

Usage: %(PROGRAM)s [options] [peps]
Notes:
    The optional argument peps can be either pep numbers or .txt files.
Options:
    -u/--user
        SF username
    [rest is the same]

											
										
										
											2000-08-28 12:00:49 -04:00
+								    if args:
-												push_html() -> push_pep()

push_pep(), main(): Arrange for the .txt source file to also be scp
uploaded to SF when the -i/--install flag is given.

											
										
										
											2001-03-20 10:07:21 -05:00
+								        peptxt = []
-												new usage to support conversion of only specified PEPs

Usage: %(PROGRAM)s [options] [peps]
Notes:
    The optional argument peps can be either pep numbers or .txt files.
Options:
    -u/--user
        SF username
    [rest is the same]

											
										
										
											2000-08-28 12:00:49 -04:00
+								        html = []
 								        for pep in args:
 								            file = find_pep(pep)
-												push_html() -> push_pep()

push_pep(), main(): Arrange for the .txt source file to also be scp
uploaded to SF when the -i/--install flag is given.

											
										
										
											2001-03-20 10:07:21 -05:00
+								            peptxt.append(file)
-												Added a -q/--quiet option to suppress the per-file progress message.
Fixed the branch for files specified from the command line to only update
the Web server if the -u/--update option was used.

											
										
										
											2000-09-06 21:26:46 -04:00
+								            newfile = make_html(file, verbose=verbose)
-												new usage to support conversion of only specified PEPs

Usage: %(PROGRAM)s [options] [peps]
Notes:
    The optional argument peps can be either pep numbers or .txt files.
Options:
    -u/--user
        SF username
    [rest is the same]

											
										
										
											2000-08-28 12:00:49 -04:00
+								            html.append(newfile)
 								    else:
 								        # do them all
-												push_html() -> push_pep()

push_pep(), main(): Arrange for the .txt source file to also be scp
uploaded to SF when the -i/--install flag is given.

											
										
										
											2001-03-20 10:07:21 -05:00
+								        peptxt = []
-												new usage to support conversion of only specified PEPs

Usage: %(PROGRAM)s [options] [peps]
Notes:
    The optional argument peps can be either pep numbers or .txt files.
Options:
    -u/--user
        SF username
    [rest is the same]

											
										
										
											2000-08-28 12:00:49 -04:00
+								        for file in glob.glob("pep-*.txt"):
-												push_html() -> push_pep()

push_pep(), main(): Arrange for the .txt source file to also be scp
uploaded to SF when the -i/--install flag is given.

											
										
										
											2001-03-20 10:07:21 -05:00
+								            peptxt.append(file)
-												Added a -q/--quiet option to suppress the per-file progress message.
Fixed the branch for files specified from the command line to only update
the Web server if the -u/--update option was used.

											
										
										
											2000-09-06 21:26:46 -04:00
+								            make_html(file, verbose=verbose)
-												push_html():  New function; handles the mechanics of actually pushing the
              generated HTML to SourceForge.

main():  Adjust to use push_html(), and simplify the logic so it only
         gets called from one place.

											
										
										
											2000-09-08 11:31:36 -04:00
+								        html = ["pep-*.html"]
-												Revise the generated HTML to be a little nicer, but still pretty simple.
Also add a -n option to suppress installing the generated HTML at
SourceForge to allow local use.

											
										
										
											2000-07-24 23:51:44 -04:00
+								    if update:
-												push_html() -> push_pep()

push_pep(), main(): Arrange for the .txt source file to also be scp
uploaded to SF when the -i/--install flag is given.

											
										
										
											2001-03-20 10:07:21 -05:00
+								        push_pep(html, peptxt, username, verbose)
-												Revise the generated HTML to be a little nicer, but still pretty simple.
Also add a -n option to suppress installing the generated HTML at
SourceForge to allow local use.

											
										
										
											2000-07-24 23:51:44 -04:00
-												fixfile(): Added special casing to handle the new PEP 0 format, which
    eliminates the "filename" field in favor of just the unadorned PEP
    number.

											
										
										
											2001-08-14 12:45:19 -04:00
-												Changed the sense of the default behavior.  No longer installs the
.html files in SF by default; you must explicitly include the
-i/--install option in order to upload.

Also, added -h/--help and migrated to getopt for switch parsing.
Included a usage() function.

Some cosmetic changes.

											
										
										
											2000-08-15 01:53:19 -04:00
-												Revise the generated HTML to be a little nicer, but still pretty simple.
Also add a -n option to suppress installing the generated HTML at
SourceForge to allow local use.

											
										
										
											2000-07-24 23:51:44 -04:00
+								if __name__ == "__main__":
 								    main()