-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* add pylint to pre-commit config * update CHANGELOG.md * remove rstr dependency
- Loading branch information
Showing
8 changed files
with
415 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| """rstr - Generate random strings from regular expressions.""" | ||
|
|
||
| # 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. | ||
|
|
||
| # source: https://github.com/leapfrogonline/rstr | ||
|
|
||
| from logprep.util.rstr.xeger import Xeger | ||
|
|
||
| Rstr = Xeger | ||
| _default_instance = Rstr() | ||
|
|
||
| rstr = _default_instance.rstr | ||
| xeger = _default_instance.xeger | ||
|
|
||
|
|
||
| # This allows convenience methods from rstr to be accessed at the package | ||
| # level, without requiring the user to instantiate an Rstr() object. | ||
| printable = _default_instance.printable | ||
| letters = _default_instance.letters | ||
| uppercase = _default_instance.uppercase | ||
| lowercase = _default_instance.lowercase | ||
| digits = _default_instance.digits | ||
| punctuation = _default_instance.punctuation | ||
| nondigits = _default_instance.nondigits | ||
| nonletters = _default_instance.nonletters | ||
| whitespace = _default_instance.whitespace | ||
| nonwhitespace = _default_instance.nonwhitespace | ||
| normal = _default_instance.normal | ||
| word = _default_instance.word | ||
| nonword = _default_instance.nonword | ||
| unambiguous = _default_instance.unambiguous | ||
| postalsafe = _default_instance.postalsafe | ||
| urlsafe = _default_instance.urlsafe | ||
| domainsafe = _default_instance.domainsafe |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,193 @@ | ||
| """This module provides the RstrBase class for generating random strings | ||
| from various alphabets. | ||
| """ | ||
|
|
||
| # 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. | ||
|
|
||
| # source: https://github.com/leapfrogonline/rstr | ||
|
|
||
| import itertools | ||
| import string | ||
| import typing | ||
| from functools import partial | ||
| from typing import Iterable, List, Mapping, Optional, Sequence, TypeVar | ||
|
|
||
| _T = TypeVar("_T") | ||
|
|
||
|
|
||
| if typing.TYPE_CHECKING: | ||
| from random import Random | ||
| from typing import Protocol | ||
|
|
||
| class _PartialRstrFunc(Protocol): | ||
|
|
||
| def __call__( | ||
| self, | ||
| start_range: Optional[int] = ..., | ||
| end_range: Optional[int] = ..., | ||
| include: str = ..., | ||
| exclude: str = ..., | ||
| ) -> str: ... | ||
|
|
||
|
|
||
| ALPHABETS: Mapping[str, str] = { | ||
| "printable": string.printable, | ||
| "letters": string.ascii_letters, | ||
| "uppercase": string.ascii_uppercase, | ||
| "lowercase": string.ascii_lowercase, | ||
| "digits": string.digits, | ||
| "punctuation": string.punctuation, | ||
| "nondigits": string.ascii_letters + string.punctuation, | ||
| "nonletters": string.digits + string.punctuation, | ||
| "whitespace": string.whitespace, | ||
| "nonwhitespace": string.printable.strip(), | ||
| "normal": string.ascii_letters + string.digits + " ", | ||
| "word": string.ascii_letters + string.digits + "_", | ||
| "nonword": "".join( | ||
| set(string.printable).difference(string.ascii_letters + string.digits + "_") | ||
| ), | ||
| "unambiguous": "".join(set(string.ascii_letters + string.digits).difference("0O1lI")), | ||
| "postalsafe": string.ascii_letters + string.digits + " .-#/", | ||
| "urlsafe": string.ascii_letters + string.digits + "-._~", | ||
| "domainsafe": string.ascii_letters + string.digits + "-", | ||
| } | ||
|
|
||
|
|
||
| class RstrBase: | ||
| """Create random strings from a variety of alphabets. | ||
| The alphabets for printable(), uppercase(), lowercase(), digits(), and | ||
| punctuation() are equivalent to the constants by those same names in the | ||
| standard library string module. | ||
| nondigits() uses an alphabet of string.letters + string.punctuation | ||
| nonletters() uses an alphabet of string.digits + string.punctuation | ||
| nonwhitespace() uses an alphabet of string.printable.strip() | ||
| normal() uses an alphabet of string.letters + string.digits + ' ' (the | ||
| space character) | ||
| postalsafe() is based on USPS Publication 28 - Postal Addressing Standards: | ||
| http://pe.usps.com/text/pub28/pub28c2.html | ||
| The characters allowed in postal addresses are letters and digits, periods, | ||
| slashes, the pound sign, and the hyphen. | ||
| urlsafe() uses an alphabet of unreserved characters safe for use in URLs. | ||
| From section 2.3 of RFC 3986: "Characters that are allowed in a URI but | ||
| do not have a reserved purpose are called unreserved. These include | ||
| uppercase and lowercase letters, decimal digits, hyphen, period, | ||
| underscore, and tilde. | ||
| domainsafe() uses an alphabet of characters allowed in hostnames, and | ||
| consequently, in internet domains: letters, digits, and the hyphen. | ||
| """ | ||
|
|
||
| def __init__(self, _random: "Random", **custom_alphabets: str) -> None: | ||
| super().__init__() | ||
| self._random = _random | ||
| self._alphabets = dict(ALPHABETS) | ||
| for alpha_name, alphabet in custom_alphabets.items(): | ||
| self.add_alphabet(alpha_name, alphabet) | ||
|
|
||
| def add_alphabet(self, alpha_name: str, characters: str) -> None: | ||
| """Add an additional alphabet to an Rstr instance and make it available | ||
| via method calls. | ||
| """ | ||
| self._alphabets[alpha_name] = characters | ||
|
|
||
| def __getattr__(self, attr: str) -> "_PartialRstrFunc": | ||
| if attr in self._alphabets: | ||
| return partial(self.rstr, self._alphabets[attr]) | ||
| message = f"Rstr instance has no attribute: {attr}" | ||
| raise AttributeError(message) | ||
|
|
||
| def sample_wr(self, population: Sequence[str], k: int) -> List[str]: | ||
| """Samples k random elements (with replacement) from a population""" | ||
| return [self._random.choice(population) for i in itertools.repeat(None, k)] | ||
|
|
||
| def rstr( | ||
| self, | ||
| alphabet: Iterable[str], | ||
| start_range: Optional[int] = None, | ||
| end_range: Optional[int] = None, | ||
| include: Sequence[str] = "", | ||
| exclude: Sequence[str] = "", | ||
| ) -> str: | ||
| """Generate a random string containing elements from 'alphabet' | ||
| By default, rstr() will return a string between 1 and 10 characters. | ||
| You can specify a second argument to get an exact length of string. | ||
| If you want a string in a range of lengths, specify the start and end | ||
| of that range as the second and third arguments. | ||
| If you want to make certain that particular characters appear in the | ||
| generated string, specify them as "include". | ||
| If you want to *prevent* certain characters from appearing, pass them | ||
| as 'exclude'. | ||
| """ | ||
| k = None | ||
| same_characters = set(include).intersection(exclude) | ||
| if same_characters: | ||
| message = ( | ||
| "include and exclude parameters contain " | ||
| f"same character{'s' if len(same_characters) > 1 else ''} " | ||
| f"({', '.join(same_characters)})" | ||
| ) | ||
| raise SameCharacterError(message) | ||
|
|
||
| popul = [char for char in list(alphabet) if char not in list(exclude)] | ||
|
|
||
| if end_range is None: | ||
| if start_range is None: | ||
| start_range, end_range = (1, 10) | ||
| else: | ||
| k = start_range | ||
| elif start_range is None: | ||
| start_range = 1 | ||
|
|
||
| if end_range: | ||
| k = self._random.randint(start_range, end_range) | ||
| # Make sure we don't generate too long a string | ||
| # when adding 'include' to it: | ||
| k = k - len(include) | ||
|
|
||
| result = self.sample_wr(popul, k) + list(include) | ||
| self._random.shuffle(result) | ||
| return "".join(result) | ||
|
|
||
|
|
||
| class SameCharacterError(ValueError): | ||
| """Raised when include and exclude parameters contain the same character""" |
Oops, something went wrong.