File: docset_Stdout.py

package info (click to toggle)
python-happydoc 2.1-3
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 4,392 kB
  • ctags: 3,480
  • sloc: python: 12,382; makefile: 102; sh: 77
file content (98 lines) | stat: -rw-r--r-- 2,493 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
#!/usr/bin/env python
#
# Time-stamp: <01/10/23 10:28:49 dhellmann>
#
# COPYRIGHT
#
#   Permission to use, copy, modify, and distribute this software and
#   its documentation for any purpose and without fee is hereby
#   granted, provided that the above copyright notice appear in all
#   copies and that both that copyright notice and this permission
#   notice appear in supporting documentation, and that the name of Doug
#   Hellmann not be used in advertising or publicity pertaining to
#   distribution of the software without specific, written prior
#   permission.
# 
# DISCLAIMER
#
#   DOUG HELLMANN DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
#   INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
#   NO EVENT SHALL DOUG HELLMANN BE LIABLE FOR ANY SPECIAL, INDIRECT OR
#   CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
#   OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
#   NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
#   CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
# 


"""Documentation set which writes output to standard output.

"""

__rcs_info__ = {
    #
    #  Creation Information
    #
    'module_name':'$RCSfile: docset_Stdout.py,v $',
    'creator':'Doug Hellmann <doug@hellfly.net>',
    'project':'HappyDoc',
    'created':'Sat, 03-Jun-2000 18:27:39 EDT',
    #
    #  Current Information
    #
    'author':'$Author: doughellmann $',
    'version':'$Revision: 1.1 $',
    'date':'$Date: 2001/10/24 21:27:35 $',
    }
try:
    __version__ = __rcs_info__['version'].split(' ')[1]
except:
    __version__ = '0.0'

#
# Import system modules
#
import sys

#
# Import Local modules
#
import docset_SingleFile

#
# Module
#

def entryPoint():
    "Return info about this module to the dynamic loader."
    return { 'name':'StdOut',
             'factory':StdOutDocSet,
             }



class StdOutDocSet(docset_SingleFile.SingleFileDocSet):
    """Documentation set which writes output to standard output.

      Parameters

        *See DocSet.*

    """

    def openOutput(self, name, title, subtitle=''):
        "Returns sys.stdout as the output destination, always."
        stdout = sys.stdout
        stdout.write('%s\n' % title)
        if subtitle:
            stdout.write('  %s\n' % subtitle)
        stdout.write('\n')
        return stdout

    def closeOutput(self, output):
        """No-op"""
        return

    def close(self):
        """No-op"""
        return