File: pkg-info

package info (click to toggle)
python-rstr 2.2.6-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 148 kB
  • ctags: 101
  • sloc: python: 345; makefile: 3
file content (260 lines) | stat: -rw-r--r-- 10,432 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
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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
Metadata-Version: 1.1
Name: rstr
Version: 2.2.6
Author: Leapfrog Direct Response LLC
Author-email: oss at leapfrogdevelopment com
Maintainer: Brendan.McCollam
Maintainer-email: brendan at mccoll am
Home-page: http://bitbucket.org/leapfrogdevelopment/rstr/overview
Download-url: https://bitbucket.org/leapfrogdevelopment/rstr/downloads
Summary: Generate random strings in Python
License: Copyright (c) 2011, Leapfrog Direct Response, LLC
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
            * Redistributions of source code must retain the above copyright
              notice, this list of conditions and the following disclaimer.
            * Redistributions in binary form must reproduce the above copyright
              notice, this list of conditions and the following disclaimer in the
              documentation and/or other materials provided with the distribution.
            * Neither the name of the Leapfrog Direct Response, LLC, including
              its subsidiaries and affiliates nor the names of its
              contributors, may be used to endorse or promote products derived
              from this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
        "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
        LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
        A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL LEAPFROG DIRECT
        RESPONSE, LLC, INCLUDING ITS SUBSIDIARIES AND AFFILIATES, BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
        CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
        SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
        BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
        WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
        OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
        IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Description: ===============================
        rstr = Random Strings in Python
        ===============================
        
        rstr is a helper module for easily generating random strings of various types.
        It could be useful for fuzz testing, generating dummy data, or other
        applications.
        
        It has no dependencies outside the standard library, and is compatible
        with Python 3.
        
        A Word of Caution
        -----------------
        
        By default, rstr uses the Python ``random`` module to generate psuedorandom text. This module is based on the Mersenne Twister and is *not* cryptographically secure.
        
        **If you wish to use rstr for password-generation or other cryptographic
        applications, you must create an instance that uses** SystemRandom_.
        
        For example:
        
        ::
        
            >> from rstr import Rstr
            >> from random import SystemRandom
            >> rs = Rstr(SystemRandom())
        
        
        Use
        ---
        
        The basic method of rstr is ``rstr()``. At a minimum, it requires one argument,
        an alphabet of characters from which to create a string.
        
        ::
        
            >>> import rstr
            >>> rstr.rstr('ABC')
            'AACAACCB'
        
        By default, it will return a string between 1 and 10 characters in length. You
        may specify an exact length by including it as a second argument:
        
        ::
        
            >>> rstr.rstr('ABC', 4)
            'ACBC'
        
        You can also generate a range of lengths by adding two arguments. In the following
        case, rstr will return a string with a randomly selected length between 5 and 10
        characters.
        
        ::
        
            >>> rstr.rstr('ABC', 5, 10)
            'CBCCCABAA'
        
        It's also possible to include particular characters in your string. This is useful
        when testing a validator to make sure that certain characters are rejected.
        Characters listed in the 'include' argument will *always* be present somewhere
        in the resulting string.
        
        ::
        
            >>> rstr.rstr('ABC', include='&')
            'CA&A'
        
        Conversely, you can exclude particular characters from the generated string. This is
        helpful when starting with a pre-defined population of characters.
        
        ::
        
            >>> import string
            >>> rstr.rstr(string.digits, exclude='5')
            '8661442'
        
        Note that any of the arguments that accept strings can also
        accept lists or tuples of strings:
        
        ::
        
            >>> rstr.rstr(['A', 'B', 'C'], include = ['@'], exclude=('C',))
            'BAAABBA@BAA'
        
        Other methods
        -------------
        
        The other methods provided by rstr, besides ``rstr()`` and ``xeger()``, are convenience
        methods that can be called without arguments, and provide a pre-defined alphabet.
        They accept the same arguments as ``rstr()`` for purposes of
        specifying lengths and including or excluding particular characters.
        
        letters()
            The characters provided by string.letters in the standard library.
        
        uppercase()
            The characters provided by string.uppercase in the standard library.
        
        lowercase()
            The characters provided by string.lowercase in the standard library.
        
        printable()
            The characters provided by string.printable in the standard library.
        
        punctuation()
            The characters provided by string.punctuation in the standard library.
        
        nonwhitespace()
            The characters provided by string.printable in the standard library, except
            for those representing whitespace: tab, space, etc.
        
        digits()
            The characters provided by string.digits in the standard library.
        
        nondigits()
            The characters provided by the concatenation of string.letters and
            string.punctuation in the standard library.
        
        nonletters()
            The characters provided by the concatenation of string.digits and
            string.punctuation in the standard library.
        
        normal()
            Characters commonly accepted in text input, equivalent to string.digits +
            string.letters + ' ' (the space character).
        
        postalsafe()
            Characters that are safe for use in postal addresses in the United States:
            upper- and lower-case letters, digits, spaces, and the punctuation marks period,
            hash (#), hyphen, and forward-slash.
        
        urlsafe()
            Characters safe (unreserved) for use in URLs: letters, digits, hyphen, period, underscore,
            and tilde.
        
        domainsafe()
            Characters that are allowed for use in hostnames, and consequently, in internet domains: letters,
            digits, and the hyphen.
        
        Xeger
        -----
        
        Inspired by the Java library of the same name, the ``xeger()`` method allows users to
        create a random string from a regular expression.
        
        For example to generate a postal code that fits the Canadian format:
        
            >>> import rstr
            >>> rstr.xeger(r'[A-Z]\d[A-Z] \d[A-Z]\d')
            u'R6M 1W5'
        
        xeger works fine with most simple regular expressions, but it doesn't support all
        Python regular expression features.
        
        Custom Alphabets
        ----------------
        
        If you have custom alphabets of characters that you would like to use with a method
        shortcut, you can specify them by keyword when instantiating an Rstr object:
        
            >>> from rstr import Rstr
            >>> rs = Rstr(vowels='AEIOU')
            >>> rs.vowels()
            'AEEUU'
        
        You can also add an alphabet to an existing instance with the add_alphabet() method:
        
            >>> rs.add_alphabet('odds', '13579')
            >>> rs.odds()
            '339599519'
        
        Examples
        --------
        
        You can combine rstr with Python's built-in string formatting to produce strings
        that fit a variety of templates.
        
        An email address:
        
        ::
        
            '{0}@{1}.{2}'.format(rstr.nonwhitespace(exclude='@'),
                                 rstr.domainsafe()
                                 rstr.letters(3))
        
        A URL:
        
        ::
        
            'http://{0}.{1}/{2}/?{3}'.format(rstr.domainsafe(),
                                            rstr.letters(3),
                                            rstr.urlsafe(),
                                            rstr.urlsafe())
        
        A postal address:
        
        ::
        
            """{0} {1}
            {2} {3}
            {4}, {5} {6}
            """.format(rstr.letters(4, 8).title(),
                       rstr.letters(4, 8).title(),
                       rstr.digits(3, 5),
                       rstr.letters(4, 10).title(),
                       rstr.letters(4, 15).title(),
                       rstr.uppercase(2),
                       rstr.digits(5),
                       )
        
        .. _SystemRandom: https://docs.python.org/2/library/random.html#random.SystemRandom
Keywords: Random strings, reverse regex, reverse regular expression, testing, fuzz testing
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Software Development :: Testing