File: indentstring.py

package info (click to toggle)
python-happydoc 2.0-2
  • links: PTS
  • area: main
  • in suites: woody
  • size: 4,176 kB
  • ctags: 3,347
  • sloc: python: 11,321; makefile: 88; sh: 77
file content (146 lines) | stat: -rw-r--r-- 3,856 bytes parent folder | download
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
#
# $Id: indentstring.py,v 1.2 2001/11/25 13:05:37 doughellmann Exp $
#
# Copyright 2000 Doug Hellmann
#
#                         All Rights Reserved
#
# 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.
#
# 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.
#

"""Function to indent the lines of a string using a standard indent spacing.

"""

__rcs_info__ = {
    #
    #  Creation Information
    #
    'module_name'  : '$RCSfile: indentstring.py,v $',
    'rcs_id'       : '$Id: indentstring.py,v 1.2 2001/11/25 13:05:37 doughellmann Exp $',
    'creator'      : 'Doug Hellmann <doug@hellfly.net>',
    'project'      : 'HappyDoc',
    'created'      : 'Sun, 27-Aug-2000 07:49:28 EDT',

    #
    #  Current Information
    #
    'author'       : '$Author: doughellmann $',
    'version'      : '$Revision: 1.2 $',
    'date'         : '$Date: 2001/11/25 13:05:37 $',
}
try:
    __version__ = __rcs_info__['version'].split(' ')[1]
except:
    __version__ = '0.0'

#
# Import system modules
#
import pprint
import string
try:
    from cStringIO import StringIO
except:
    from StringIO import StringIO
import unittest

#
# Import Local modules
#
from StreamFlushTest import StreamFlushTest

#
# Module
#

def indentString(str, tabWidth=1, tabChar=' '):
    output = StringIO()
    lines = string.split(str, '\n')
    indent_lines = map(lambda x, pre=(tabWidth * tabChar): '%s%s\n' % (pre, x),
                       lines)
    output.writelines(indent_lines)
    return output.getvalue()



class IndentStringTest(StreamFlushTest):

    def testIndentString(self):
        stream = StringIO()
        printer = pprint.PrettyPrinter(indent=2, width=10, stream=stream)

        test_tuple = ( ( ( 1, 'two', (3, 'four') ), ( 1, 'two', (3, 'four') ) ),
                       ( ( 1, 'two', (3, 'four') ), ( 1, 'two', (3, 'four') ) ),
                       ( ( 1, 'two', (3, 'four') ), ( 1, 'two', (3, 'four') ) ),
                       ( ( 1, 'two', (3, 'four') ), ( 1, 'two', (3, 'four') ) ),
                       ( ( 1, 'two', (3, 'four') ), ( 1, 'two', (3, 'four') ) ),
                      )
        printer.pprint(test_tuple)
        indented = indentString(stream.getvalue(), tabWidth=2, tabChar='.')

        expected_value = """..( ( ( 1,
..      'two',
..      ( 3,
..        'four')),
..    ( 1,
..      'two',
..      ( 3,
..        'four'))),
..  ( ( 1,
..      'two',
..      ( 3,
..        'four')),
..    ( 1,
..      'two',
..      ( 3,
..        'four'))),
..  ( ( 1,
..      'two',
..      ( 3,
..        'four')),
..    ( 1,
..      'two',
..      ( 3,
..        'four'))),
..  ( ( 1,
..      'two',
..      ( 3,
..        'four')),
..    ( 1,
..      'two',
..      ( 3,
..        'four'))),
..  ( ( 1,
..      'two',
..      ( 3,
..        'four')),
..    ( 1,
..      'two',
..      ( 3,
..        'four'))))
..
"""
        assert indented == expected_value, \
               'Did not get expected indention "%s"' % indented
        return
    

if __name__ == '__main__':
    unittest.main()