setuptools._vendor.jaraco.text

package documentation
(source)

Undocumented

From __init__.py:

Class FoldedCase A case insensitive string class; behaves just like str except compares equal when the only variation is case.
Class SeparatedValues A string separated by a separator. Overrides __iter__ for getting the values.
Class Splitter object that will split a string with the given arguments for each call
Class Stripper Given a series of lines, find the common prefix and strip it from them.
Class WordSet Given an identifier, return the words that identifier represents, whether in camel case, underscore-separated, etc.
Function drop_comment Drop comments.
Function indent >>> indent('foo') ' foo'
Function is_binary Return True if the value appears to be binary (that is, it's a byte string and isn't decodable).
Function is_decodable Return True if the supplied value is decodable (using the default encoding).
Function join_continuation Join lines continued by a trailing backslash.
Function multi_substitution Take a sequence of pairs specifying substitutions, and create a function that performs those substitutions.
Function normalize_newlines Replace alternate newlines with the canonical newline.
Function remove_prefix Remove the prefix from the text if it exists.
Function remove_suffix Remove the suffix from the text if it exists.
Function simple_html_strip Remove HTML from the string `s`.
Function substitution Return a function that will perform a substitution on a string
Function trim Trim something like a docstring to remove the whitespace that is common due to indentation and formatting.
Function unwrap Given a multi-line string, return an unwrapped version.
Function wrap Wrap lines of text, retaining existing newlines as paragraph markers.
Function yield_lines Yield valid lines of a string or iterable.
Function _ Undocumented
Function _nonblank Undocumented
Variable _unicode_trap Undocumented
def substitution(old, new): (source)

Return a function that will perform a substitution on a string

def multi_substitution(*substitutions): (source)

Take a sequence of pairs specifying substitutions, and create a function that performs those substitutions. >>> multi_substitution(('foo', 'bar'), ('bar', 'baz'))('foo') 'baz'

_unicode_trap = (source)

Undocumented

@_unicode_trap.passes
def is_decodable(value): (source)

Return True if the supplied value is decodable (using the default encoding). >>> is_decodable(b'\xff') False >>> is_decodable(b'\x32') True

def is_binary(value): (source)

Return True if the value appears to be binary (that is, it's a byte string and isn't decodable). >>> is_binary(b'\xff') True >>> is_binary('\xff') False

def trim(s): (source)

Trim something like a docstring to remove the whitespace that is common due to indentation and formatting. >>> trim("\n\tfoo = bar\n\t\tbar = baz\n") 'foo = bar\n\tbar = baz'

def wrap(s): (source)

Wrap lines of text, retaining existing newlines as paragraph markers. >>> print(wrap(lorem_ipsum)) Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. <BLANKLINE> Curabitur pretium tincidunt lacus. Nulla gravida orci a odio. Nullam varius, turpis et commodo pharetra, est eros bibendum elit, nec luctus magna felis sollicitudin mauris. Integer in mauris eu nibh euismod gravida. Duis ac tellus et risus vulputate vehicula. Donec lobortis risus a elit. Etiam tempor. Ut ullamcorper, ligula eu tempor congue, eros est euismod turpis, id tincidunt sapien risus a quam. Maecenas fermentum consequat mi. Donec fermentum. Pellentesque malesuada nulla a mi. Duis sapien sem, aliquet nec, commodo eget, consequat quis, neque. Aliquam faucibus, elit ut dictum aliquet, felis nisl adipiscing sapien, sed malesuada diam lacus eget erat. Cras mollis scelerisque nunc. Nullam arcu. Aliquam consequat. Curabitur augue lorem, dapibus quis, laoreet et, pretium ac, nisi. Aenean magna nisl, mollis quis, molestie eu, feugiat in, orci. In hac habitasse platea dictumst.

def unwrap(s): (source)

Given a multi-line string, return an unwrapped version. >>> wrapped = wrap(lorem_ipsum) >>> wrapped.count('\n') 20 >>> unwrapped = unwrap(wrapped) >>> unwrapped.count('\n') 1 >>> print(unwrapped) Lorem ipsum dolor sit amet, consectetur adipiscing ... Curabitur pretium tincidunt lacus. Nulla gravida orci ...

def indent(string, prefix=' '*4): (source)

>>> indent('foo') ' foo'

def simple_html_strip(s): (source)

Remove HTML from the string `s`. >>> str(simple_html_strip('')) '' >>> print(simple_html_strip('A <bold>stormy</bold> day in paradise')) A stormy day in paradise >>> print(simple_html_strip('Somebody <!-- do not --> tell the truth.')) Somebody tell the truth. >>> print(simple_html_strip('What about<br/>\nmultiple lines?')) What about multiple lines?

def remove_prefix(text, prefix): (source)

Remove the prefix from the text if it exists. >>> remove_prefix('underwhelming performance', 'underwhelming ') 'performance' >>> remove_prefix('something special', 'sample') 'something special'

def remove_suffix(text, suffix): (source)

Remove the suffix from the text if it exists. >>> remove_suffix('name.git', '.git') 'name' >>> remove_suffix('something special', 'sample') 'something special'

def normalize_newlines(text): (source)

Replace alternate newlines with the canonical newline. >>> normalize_newlines('Lorem Ipsum\u2029') 'Lorem Ipsum\n' >>> normalize_newlines('Lorem Ipsum\r\n') 'Lorem Ipsum\n' >>> normalize_newlines('Lorem Ipsum\x85') 'Lorem Ipsum\n'

def _nonblank(str): (source)

Undocumented

@functools.singledispatch
def yield_lines(iterable): (source)

Yield valid lines of a string or iterable. >>> list(yield_lines('')) [] >>> list(yield_lines(['foo', 'bar'])) ['foo', 'bar'] >>> list(yield_lines('foo\nbar')) ['foo', 'bar'] >>> list(yield_lines('\nfoo\n#bar\nbaz #comment')) ['foo', 'baz #comment'] >>> list(yield_lines(['foo\nbar', 'baz', 'bing\n\n\n'])) ['foo', 'bar', 'baz', 'bing']

@yield_lines.register(str)
def _(text): (source)

Undocumented

def drop_comment(line): (source)

Drop comments. >>> drop_comment('foo # bar') 'foo' A hash without a space may be in a URL. >>> drop_comment('http://example.com/foo#bar') 'http://example.com/foo#bar'

def join_continuation(lines): (source)

Join lines continued by a trailing backslash. >>> list(join_continuation(['foo \\', 'bar', 'baz'])) ['foobar', 'baz'] >>> list(join_continuation(['foo \\', 'bar', 'baz'])) ['foobar', 'baz'] >>> list(join_continuation(['foo \\', 'bar \\', 'baz'])) ['foobarbaz'] Not sure why, but... The character preceeding the backslash is also elided. >>> list(join_continuation(['goo\\', 'dly'])) ['godly'] A terrible idea, but... If no line is available to continue, suppress the lines. >>> list(join_continuation(['foo', 'bar\\', 'baz\\'])) ['foo']