springsuite: planemo/lib/python3.7/site-packages/boltons/strutils.py annotate

annotate planemo/lib/python3.7/site-packages/boltons/strutils.py @ 1:56ad4e20f292 draft

"planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1"

author	guerler
date	Fri, 31 Jul 2020 00:32:28 -0400
parents	d30785e31577
children

rev	line source
0 d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1 # -- coding: utf-8 --
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	2 """So much practical programming involves string manipulation, which
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	3 Python readily accommodates. Still, there are dozens of basic and
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	4 common capabilities missing from the standard library, several of them
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	5 provided by ``strutils``.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	6 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	7
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	8 from __future__ import print_function
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	9
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	10 import re
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	11 import sys
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	12 import uuid
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	13 import zlib
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	14 import string
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	15 import unicodedata
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	16 import collections
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	17 from gzip import GzipFile
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	18
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	19 try:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	20 from cStringIO import cStringIO as StringIO
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	21 except ImportError:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	22 from io import BytesIO as StringIO
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	23
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	24 try:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	25 from collections.abc import Mapping
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	26 except ImportError:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	27 from collections import Mapping
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	28
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	29 try:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	30 unicode, str, bytes, basestring = unicode, str, str, basestring
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	31 from HTMLParser import HTMLParser
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	32 import htmlentitydefs
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	33 except NameError: # basestring not defined in Python 3
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	34 unicode, str, bytes, basestring = str, bytes, bytes, (str, bytes)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	35 unichr = chr
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	36 from html.parser import HTMLParser
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	37 from html import entities as htmlentitydefs
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	38
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	39 try:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	40 import __builtin__ as builtins
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	41 except ImportError:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	42 import builtins
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	43
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	44 __all__ = ['camel2under', 'under2camel', 'slugify', 'split_punct_ws',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	45 'unit_len', 'ordinalize', 'cardinalize', 'pluralize', 'singularize',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	46 'asciify', 'is_ascii', 'is_uuid', 'html2text', 'strip_ansi',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	47 'bytes2human', 'find_hashtags', 'a10n', 'gzip_bytes', 'gunzip_bytes',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	48 'iter_splitlines', 'indent', 'escape_shell_args',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	49 'args2cmd', 'args2sh', 'parse_int_list', 'format_int_list',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	50 'int_list_complement', 'int_list_to_int_tuples', 'unwrap_text']
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	51
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	52
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	53 _punct_ws_str = string.punctuation + string.whitespace
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	54 _punct_re = re.compile('[' + _punct_ws_str + ']+')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	55 _camel2under_re = re.compile('((?<=[a-z0-9])[A-Z]\|(?!^)[A-Z](?=[a-z]))')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	56
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	57
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	58 def camel2under(camel_string):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	59 """Converts a camelcased string to underscores. Useful for turning a
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	60 class name into a function name.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	61
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	62 >>> camel2under('BasicParseTest')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	63 'basic_parse_test'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	64 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	65 return _camel2under_re.sub(r'_\1', camel_string).lower()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	66
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	67
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	68 def under2camel(under_string):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	69 """Converts an underscored string to camelcased. Useful for turning a
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	70 function name into a class name.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	71
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	72 >>> under2camel('complex_tokenizer')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	73 'ComplexTokenizer'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	74 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	75 return ''.join(w.capitalize() or '_' for w in under_string.split('_'))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	76
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	77
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	78 def slugify(text, delim='_', lower=True, ascii=False):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	79 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	80 A basic function that turns text full of scary characters
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	81 (i.e., punctuation and whitespace), into a relatively safe
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	82 lowercased string separated only by the delimiter specified
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	83 by delim, which defaults to ``_``.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	84
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	85 The ascii convenience flag will :func:`asciify` the slug if
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	86 you require ascii-only slugs.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	87
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	88 >>> slugify('First post! Hi!!!!~1 ')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	89 'first_post_hi_1'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	90
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	91 >>> slugify("Kurt Gödel's pretty cool.", ascii=True) == \
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	92 b'kurt_goedel_s_pretty_cool'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	93 True
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	94
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	95 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	96 ret = delim.join(split_punct_ws(text)) or delim if text else ''
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	97 if ascii:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	98 ret = asciify(ret)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	99 if lower:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	100 ret = ret.lower()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	101 return ret
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	102
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	103
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	104 def split_punct_ws(text):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	105 """While :meth:`str.split` will split on whitespace,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	106 :func:`split_punct_ws` will split on punctuation and
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	107 whitespace. This used internally by :func:`slugify`, above.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	108
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	109 >>> split_punct_ws('First post! Hi!!!!~1 ')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	110 ['First', 'post', 'Hi', '1']
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	111 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	112 return [w for w in _punct_re.split(text) if w]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	113
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	114
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	115 def unit_len(sized_iterable, unit_noun='item'): # TODO: len_units()/unitize()?
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	116 """Returns a plain-English description of an iterable's
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	117 :func:`len()`, conditionally pluralized with :func:`cardinalize`,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	118 detailed below.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	119
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	120 >>> print(unit_len(range(10), 'number'))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	121 10 numbers
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	122 >>> print(unit_len('aeiou', 'vowel'))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	123 5 vowels
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	124 >>> print(unit_len([], 'worry'))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	125 No worries
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	126 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	127 count = len(sized_iterable)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	128 units = cardinalize(unit_noun, count)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	129 if count:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	130 return u'%s %s' % (count, units)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	131 return u'No %s' % (units,)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	132
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	133
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	134 _ORDINAL_MAP = {'1': 'st',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	135 '2': 'nd',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	136 '3': 'rd'} # 'th' is the default
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	137
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	138
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	139 def ordinalize(number, ext_only=False):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	140 """Turns number into its cardinal form, i.e., 1st, 2nd,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	141 3rd, 4th, etc. If the last character isn't a digit, it returns the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	142 string value unchanged.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	143
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	144 Args:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	145 number (int or str): Number to be cardinalized.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	146 ext_only (bool): Whether to return only the suffix. Default ``False``.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	147
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	148 >>> print(ordinalize(1))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	149 1st
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	150 >>> print(ordinalize(3694839230))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	151 3694839230th
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	152 >>> print(ordinalize('hi'))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	153 hi
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	154 >>> print(ordinalize(1515))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	155 1515th
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	156 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	157 numstr, ext = unicode(number), ''
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	158 if numstr and numstr[-1] in string.digits:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	159 try:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	160 # first check for teens
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	161 if numstr[-2] == '1':
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	162 ext = 'th'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	163 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	164 # all other cases
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	165 ext = _ORDINAL_MAP.get(numstr[-1], 'th')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	166 except IndexError:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	167 # single digit numbers (will reach here based on [-2] above)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	168 ext = _ORDINAL_MAP.get(numstr[-1], 'th')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	169 if ext_only:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	170 return ext
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	171 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	172 return numstr + ext
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	173
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	174
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	175 def cardinalize(unit_noun, count):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	176 """Conditionally pluralizes a singular word unit_noun if
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	177 count is not one, preserving case when possible.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	178
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	179 >>> vowels = 'aeiou'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	180 >>> print(len(vowels), cardinalize('vowel', len(vowels)))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	181 5 vowels
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	182 >>> print(3, cardinalize('Wish', 3))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	183 3 Wishes
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	184 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	185 if count == 1:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	186 return unit_noun
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	187 return pluralize(unit_noun)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	188
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	189
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	190 def singularize(word):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	191 """Semi-intelligently converts an English plural word to its
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	192 singular form, preserving case pattern.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	193
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	194 >>> singularize('chances')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	195 'chance'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	196 >>> singularize('Activities')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	197 'Activity'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	198 >>> singularize('Glasses')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	199 'Glass'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	200 >>> singularize('FEET')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	201 'FOOT'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	202
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	203 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	204 orig_word, word = word, word.strip().lower()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	205 if not word or word in _IRR_S2P:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	206 return orig_word
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	207
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	208 irr_singular = _IRR_P2S.get(word)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	209 if irr_singular:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	210 singular = irr_singular
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	211 elif not word.endswith('s'):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	212 return orig_word
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	213 elif len(word) == 2:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	214 singular = word[:-1] # or just return word?
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	215 elif word.endswith('ies') and word[-4:-3] not in 'aeiou':
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	216 singular = word[:-3] + 'y'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	217 elif word.endswith('es') and word[-3] == 's':
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	218 singular = word[:-2]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	219 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	220 singular = word[:-1]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	221 return _match_case(orig_word, singular)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	222
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	223
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	224 def pluralize(word):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	225 """Semi-intelligently converts an English word from singular form to
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	226 plural, preserving case pattern.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	227
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	228 >>> pluralize('friend')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	229 'friends'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	230 >>> pluralize('enemy')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	231 'enemies'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	232 >>> pluralize('Sheep')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	233 'Sheep'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	234 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	235 orig_word, word = word, word.strip().lower()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	236 if not word or word in _IRR_P2S:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	237 return orig_word
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	238 irr_plural = _IRR_S2P.get(word)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	239 if irr_plural:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	240 plural = irr_plural
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	241 elif word.endswith('y') and word[-2:-1] not in 'aeiou':
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	242 plural = word[:-1] + 'ies'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	243 elif word[-1] == 's' or word.endswith('ch') or word.endswith('sh'):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	244 plural = word if word.endswith('es') else word + 'es'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	245 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	246 plural = word + 's'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	247 return _match_case(orig_word, plural)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	248
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	249
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	250 def _match_case(master, disciple):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	251 if not master.strip():
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	252 return disciple
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	253 if master.lower() == master:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	254 return disciple.lower()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	255 elif master.upper() == master:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	256 return disciple.upper()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	257 elif master.title() == master:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	258 return disciple.title()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	259 return disciple
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	260
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	261
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	262 # Singular to plural map of irregular pluralizations
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	263 _IRR_S2P = {'addendum': 'addenda', 'alga': 'algae', 'alumna': 'alumnae',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	264 'alumnus': 'alumni', 'analysis': 'analyses', 'antenna': 'antennae',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	265 'appendix': 'appendices', 'axis': 'axes', 'bacillus': 'bacilli',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	266 'bacterium': 'bacteria', 'basis': 'bases', 'beau': 'beaux',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	267 'bison': 'bison', 'bureau': 'bureaus', 'cactus': 'cacti',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	268 'calf': 'calves', 'child': 'children', 'corps': 'corps',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	269 'corpus': 'corpora', 'crisis': 'crises', 'criterion': 'criteria',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	270 'curriculum': 'curricula', 'datum': 'data', 'deer': 'deer',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	271 'diagnosis': 'diagnoses', 'die': 'dice', 'dwarf': 'dwarves',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	272 'echo': 'echoes', 'elf': 'elves', 'ellipsis': 'ellipses',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	273 'embargo': 'embargoes', 'emphasis': 'emphases', 'erratum': 'errata',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	274 'fireman': 'firemen', 'fish': 'fish', 'focus': 'foci',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	275 'foot': 'feet', 'formula': 'formulae', 'formula': 'formulas',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	276 'fungus': 'fungi', 'genus': 'genera', 'goose': 'geese',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	277 'half': 'halves', 'hero': 'heroes', 'hippopotamus': 'hippopotami',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	278 'hoof': 'hooves', 'hypothesis': 'hypotheses', 'index': 'indices',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	279 'knife': 'knives', 'leaf': 'leaves', 'life': 'lives',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	280 'loaf': 'loaves', 'louse': 'lice', 'man': 'men',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	281 'matrix': 'matrices', 'means': 'means', 'medium': 'media',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	282 'memorandum': 'memoranda', 'millennium': 'milennia', 'moose': 'moose',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	283 'mosquito': 'mosquitoes', 'mouse': 'mice', 'nebula': 'nebulae',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	284 'neurosis': 'neuroses', 'nucleus': 'nuclei', 'oasis': 'oases',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	285 'octopus': 'octopi', 'offspring': 'offspring', 'ovum': 'ova',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	286 'ox': 'oxen', 'paralysis': 'paralyses', 'parenthesis': 'parentheses',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	287 'person': 'people', 'phenomenon': 'phenomena', 'potato': 'potatoes',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	288 'radius': 'radii', 'scarf': 'scarves', 'scissors': 'scissors',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	289 'self': 'selves', 'sense': 'senses', 'series': 'series', 'sheep':
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	290 'sheep', 'shelf': 'shelves', 'species': 'species', 'stimulus':
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	291 'stimuli', 'stratum': 'strata', 'syllabus': 'syllabi', 'symposium':
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	292 'symposia', 'synopsis': 'synopses', 'synthesis': 'syntheses',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	293 'tableau': 'tableaux', 'that': 'those', 'thesis': 'theses',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	294 'thief': 'thieves', 'this': 'these', 'tomato': 'tomatoes', 'tooth':
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	295 'teeth', 'torpedo': 'torpedoes', 'vertebra': 'vertebrae', 'veto':
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	296 'vetoes', 'vita': 'vitae', 'watch': 'watches', 'wife': 'wives',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	297 'wolf': 'wolves', 'woman': 'women'}
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	298
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	299
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	300 # Reverse index of the above
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	301 _IRR_P2S = dict([(v, k) for k, v in _IRR_S2P.items()])
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	302
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	303 HASHTAG_RE = re.compile(r"(?:^\|\s)[＃#]{1}(\w+)", re.UNICODE)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	304
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	305
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	306 def find_hashtags(string):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	307 """Finds and returns all hashtags in a string, with the hashmark
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	308 removed. Supports full-width hashmarks for Asian languages and
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	309 does not false-positive on URL anchors.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	310
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	311 >>> find_hashtags('#atag http://asite/#ananchor')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	312 ['atag']
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	313
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	314 ``find_hashtags`` also works with unicode hashtags.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	315 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	316
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	317 # the following works, doctest just struggles with it
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	318 # >>> find_hashtags(u"can't get enough of that dignity chicken #肯德基 woo")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	319 # [u'\u80af\u5fb7\u57fa']
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	320 return HASHTAG_RE.findall(string)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	321
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	322
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	323 def a10n(string):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	324 """That thing where "internationalization" becomes "i18n", what's it
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	325 called? Abbreviation? Oh wait, no: ``a10n``. (It's actually a form
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	326 of `numeronym`_.)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	327
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	328 >>> a10n('abbreviation')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	329 'a10n'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	330 >>> a10n('internationalization')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	331 'i18n'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	332 >>> a10n('')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	333 ''
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	334
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	335 .. _numeronym: http://en.wikipedia.org/wiki/Numeronym
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	336 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	337 if len(string) < 3:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	338 return string
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	339 return '%s%s%s' % (string[0], len(string[1:-1]), string[-1])
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	340
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	341
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	342 # Based on https://en.wikipedia.org/wiki/ANSI_escape_code#Escape_sequences
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	343 ANSI_SEQUENCES = re.compile(r'''
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	344 \x1B # Sequence starts with ESC, i.e. hex 0x1B
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	345 (?:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	346 [@-Z\\-_] # Second byte:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	347 # all 0x40–0x5F range but CSI char, i.e ASCII @A–Z\]^_
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	348 \| # Or
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	349 \[ # CSI sequences, starting with [
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	350 [0-?]* # Parameter bytes:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	351 # range 0x30–0x3F, ASCII 0–9:;<=>?
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	352 [ -/]* # Intermediate bytes:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	353 # range 0x20–0x2F, ASCII space and !"#$%&'()*+,-./
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	354 [@-~] # Final byte
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	355 # range 0x40–0x7E, ASCII @A–Z[\]^_`a–z{\|}~
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	356 )
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	357 ''', re.VERBOSE)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	358
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	359
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	360 def strip_ansi(text):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	361 """Strips ANSI escape codes from text. Useful for the occasional
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	362 time when a log or redirected output accidentally captures console
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	363 color codes and the like.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	364
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	365 >>> strip_ansi('\x1b[0m\x1b[1;36mart\x1b[46;34m')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	366 'art'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	367
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	368 Supports unicode, str, bytes and bytearray content as input. Returns the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	369 same type as the input.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	370
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	371 There's a lot of ANSI art available for testing on `sixteencolors.net`_.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	372 This function does not interpret or render ANSI art, but you can do so with
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	373 `ansi2img`_ or `escapes.js`_.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	374
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	375 .. _sixteencolors.net: http://sixteencolors.net
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	376 .. _ansi2img: http://www.bedroomlan.org/projects/ansi2img
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	377 .. _escapes.js: https://github.com/atdt/escapes.js
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	378 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	379 # TODO: move to cliutils.py
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	380
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	381 # Transform any ASCII-like content to unicode to allow regex to match, and
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	382 # save input type for later.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	383 target_type = None
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	384 # Unicode type aliased to str is code-smell for Boltons in Python 3 env.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	385 is_py3 = (unicode == builtins.str)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	386 if is_py3 and isinstance(text, (bytes, bytearray)):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	387 target_type = type(text)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	388 text = text.decode('utf-8')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	389
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	390 cleaned = ANSI_SEQUENCES.sub('', text)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	391
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	392 # Transform back the result to the same bytearray type provided by the user.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	393 if target_type and target_type != type(cleaned):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	394 cleaned = target_type(cleaned, 'utf-8')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	395
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	396 return cleaned
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	397
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	398
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	399 def asciify(text, ignore=False):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	400 """Converts a unicode or bytestring, text, into a bytestring with
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	401 just ascii characters. Performs basic deaccenting for all you
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	402 Europhiles out there.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	403
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	404 Also, a gentle reminder that this is a utility, primarily meant
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	405 for slugification. Whenever possible, make your application work
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	406 with unicode, not against it.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	407
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	408 Args:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	409 text (str or unicode): The string to be asciified.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	410 ignore (bool): Configures final encoding to ignore remaining
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	411 unasciified unicode instead of replacing it.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	412
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	413 >>> asciify('Beyoncé') == b'Beyonce'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	414 True
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	415 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	416 try:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	417 try:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	418 return text.encode('ascii')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	419 except UnicodeDecodeError:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	420 # this usually means you passed in a non-unicode string
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	421 text = text.decode('utf-8')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	422 return text.encode('ascii')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	423 except UnicodeEncodeError:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	424 mode = 'replace'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	425 if ignore:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	426 mode = 'ignore'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	427 transd = unicodedata.normalize('NFKD', text.translate(DEACCENT_MAP))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	428 ret = transd.encode('ascii', mode)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	429 return ret
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	430
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	431
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	432 def is_ascii(text):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	433 """Check if a unicode or bytestring, text, is composed of ascii
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	434 characters only. Raises :exc:`ValueError` if argument is not text.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	435
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	436 Args:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	437 text (str or unicode): The string to be checked.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	438
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	439 >>> is_ascii('Beyoncé')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	440 False
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	441 >>> is_ascii('Beyonce')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	442 True
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	443 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	444 if isinstance(text, unicode):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	445 try:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	446 text.encode('ascii')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	447 except UnicodeEncodeError:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	448 return False
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	449 elif isinstance(text, bytes):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	450 try:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	451 text.decode('ascii')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	452 except UnicodeDecodeError:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	453 return False
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	454 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	455 raise ValueError('expected text or bytes, not %r' % type(text))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	456 return True
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	457
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	458
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	459 class DeaccenterDict(dict):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	460 "A small caching dictionary for deaccenting."
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	461 def __missing__(self, key):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	462 ch = self.get(key)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	463 if ch is not None:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	464 return ch
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	465 try:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	466 de = unicodedata.decomposition(unichr(key))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	467 p1, _, p2 = de.rpartition(' ')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	468 if int(p2, 16) == 0x308:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	469 ch = self.get(key)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	470 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	471 ch = int(p1, 16)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	472 except (IndexError, ValueError):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	473 ch = self.get(key, key)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	474 self[key] = ch
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	475 return ch
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	476
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	477 try:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	478 from collections import defaultdict
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	479 except ImportError:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	480 # no defaultdict means that __missing__ isn't supported in
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	481 # this version of python, so we define __getitem__
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	482 def __getitem__(self, key):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	483 try:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	484 return super(DeaccenterDict, self).__getitem__(key)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	485 except KeyError:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	486 return self.__missing__(key)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	487 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	488 del defaultdict
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	489
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	490
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	491 # http://chmullig.com/2009/12/python-unicode-ascii-ifier/
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	492 # For something more complete, investigate the unidecode
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	493 # or isounidecode packages, which are capable of performing
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	494 # crude transliteration.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	495 _BASE_DEACCENT_MAP = {
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	496 0xc6: u"AE", # Æ LATIN CAPITAL LETTER AE
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	497 0xd0: u"D", # Ð LATIN CAPITAL LETTER ETH
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	498 0xd8: u"OE", # Ø LATIN CAPITAL LETTER O WITH STROKE
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	499 0xde: u"Th", # Þ LATIN CAPITAL LETTER THORN
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	500 0xc4: u'Ae', # Ä LATIN CAPITAL LETTER A WITH DIAERESIS
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	501 0xd6: u'Oe', # Ö LATIN CAPITAL LETTER O WITH DIAERESIS
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	502 0xdc: u'Ue', # Ü LATIN CAPITAL LETTER U WITH DIAERESIS
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	503 0xc0: u"A", # À LATIN CAPITAL LETTER A WITH GRAVE
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	504 0xc1: u"A", # Á LATIN CAPITAL LETTER A WITH ACUTE
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	505 0xc3: u"A", # Ã LATIN CAPITAL LETTER A WITH TILDE
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	506 0xc7: u"C", # Ç LATIN CAPITAL LETTER C WITH CEDILLA
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	507 0xc8: u"E", # È LATIN CAPITAL LETTER E WITH GRAVE
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	508 0xc9: u"E", # É LATIN CAPITAL LETTER E WITH ACUTE
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	509 0xca: u"E", # Ê LATIN CAPITAL LETTER E WITH CIRCUMFLEX
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	510 0xcc: u"I", # Ì LATIN CAPITAL LETTER I WITH GRAVE
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	511 0xcd: u"I", # Í LATIN CAPITAL LETTER I WITH ACUTE
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	512 0xd2: u"O", # Ò LATIN CAPITAL LETTER O WITH GRAVE
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	513 0xd3: u"O", # Ó LATIN CAPITAL LETTER O WITH ACUTE
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	514 0xd5: u"O", # Õ LATIN CAPITAL LETTER O WITH TILDE
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	515 0xd9: u"U", # Ù LATIN CAPITAL LETTER U WITH GRAVE
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	516 0xda: u"U", # Ú LATIN CAPITAL LETTER U WITH ACUTE
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	517 0xdf: u"ss", # ß LATIN SMALL LETTER SHARP S
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	518 0xe6: u"ae", # æ LATIN SMALL LETTER AE
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	519 0xf0: u"d", # ð LATIN SMALL LETTER ETH
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	520 0xf8: u"oe", # ø LATIN SMALL LETTER O WITH STROKE
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	521 0xfe: u"th", # þ LATIN SMALL LETTER THORN,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	522 0xe4: u'ae', # ä LATIN SMALL LETTER A WITH DIAERESIS
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	523 0xf6: u'oe', # ö LATIN SMALL LETTER O WITH DIAERESIS
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	524 0xfc: u'ue', # ü LATIN SMALL LETTER U WITH DIAERESIS
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	525 0xe0: u"a", # à LATIN SMALL LETTER A WITH GRAVE
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	526 0xe1: u"a", # á LATIN SMALL LETTER A WITH ACUTE
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	527 0xe3: u"a", # ã LATIN SMALL LETTER A WITH TILDE
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	528 0xe7: u"c", # ç LATIN SMALL LETTER C WITH CEDILLA
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	529 0xe8: u"e", # è LATIN SMALL LETTER E WITH GRAVE
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	530 0xe9: u"e", # é LATIN SMALL LETTER E WITH ACUTE
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	531 0xea: u"e", # ê LATIN SMALL LETTER E WITH CIRCUMFLEX
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	532 0xec: u"i", # ì LATIN SMALL LETTER I WITH GRAVE
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	533 0xed: u"i", # í LATIN SMALL LETTER I WITH ACUTE
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	534 0xf2: u"o", # ò LATIN SMALL LETTER O WITH GRAVE
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	535 0xf3: u"o", # ó LATIN SMALL LETTER O WITH ACUTE
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	536 0xf5: u"o", # õ LATIN SMALL LETTER O WITH TILDE
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	537 0xf9: u"u", # ù LATIN SMALL LETTER U WITH GRAVE
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	538 0xfa: u"u", # ú LATIN SMALL LETTER U WITH ACUTE
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	539 0x2018: u"'", # ‘ LEFT SINGLE QUOTATION MARK
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	540 0x2019: u"'", # ’ RIGHT SINGLE QUOTATION MARK
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	541 0x201c: u'"', # “ LEFT DOUBLE QUOTATION MARK
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	542 0x201d: u'"', # ” RIGHT DOUBLE QUOTATION MARK
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	543 }
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	544
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	545
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	546 DEACCENT_MAP = DeaccenterDict(_BASE_DEACCENT_MAP)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	547
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	548
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	549 _SIZE_SYMBOLS = ('B', 'K', 'M', 'G', 'T', 'P', 'E', 'Z', 'Y')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	550 _SIZE_BOUNDS = [(1024 ** i, sym) for i, sym in enumerate(_SIZE_SYMBOLS)]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	551 _SIZE_RANGES = list(zip(_SIZE_BOUNDS, _SIZE_BOUNDS[1:]))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	552
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	553
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	554 def bytes2human(nbytes, ndigits=0):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	555 """Turns an integer value of nbytes into a human readable format. Set
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	556 ndigits to control how many digits after the decimal point
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	557 should be shown (default ``0``).
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	558
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	559 >>> bytes2human(128991)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	560 '126K'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	561 >>> bytes2human(100001221)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	562 '95M'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	563 >>> bytes2human(0, 2)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	564 '0.00B'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	565 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	566 abs_bytes = abs(nbytes)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	567 for (size, symbol), (next_size, next_symbol) in _SIZE_RANGES:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	568 if abs_bytes <= next_size:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	569 break
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	570 hnbytes = float(nbytes) / size
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	571 return '{hnbytes:.{ndigits}f}{symbol}'.format(hnbytes=hnbytes,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	572 ndigits=ndigits,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	573 symbol=symbol)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	574
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	575
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	576 class HTMLTextExtractor(HTMLParser):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	577 def __init__(self):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	578 self.reset()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	579 self.strict = False
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	580 self.convert_charrefs = True
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	581 self.result = []
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	582
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	583 def handle_data(self, d):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	584 self.result.append(d)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	585
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	586 def handle_charref(self, number):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	587 if number[0] == u'x' or number[0] == u'X':
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	588 codepoint = int(number[1:], 16)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	589 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	590 codepoint = int(number)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	591 self.result.append(unichr(codepoint))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	592
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	593 def handle_entityref(self, name):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	594 try:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	595 codepoint = htmlentitydefs.name2codepoint[name]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	596 except KeyError:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	597 self.result.append(u'&' + name + u';')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	598 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	599 self.result.append(unichr(codepoint))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	600
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	601 def get_text(self):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	602 return u''.join(self.result)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	603
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	604
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	605 def html2text(html):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	606 """Strips tags from HTML text, returning markup-free text. Also, does
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	607 a best effort replacement of entities like " "
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	608
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	609 >>> r = html2text(u'<a href="#">Test &<em>(\u0394ημώ)</em></a>')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	610 >>> r == u'Test &(\u0394\u03b7\u03bc\u03ce)'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	611 True
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	612 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	613 # based on answers to http://stackoverflow.com/questions/753052/
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	614 s = HTMLTextExtractor()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	615 s.feed(html)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	616 return s.get_text()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	617
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	618
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	619 _EMPTY_GZIP_BYTES = b'\x1f\x8b\x08\x089\xf3\xb9U\x00\x03empty\x00\x03\x00\x00\x00\x00\x00\x00\x00\x00\x00'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	620 _NON_EMPTY_GZIP_BYTES = b'\x1f\x8b\x08\x08\xbc\xf7\xb9U\x00\x03not_empty\x00K\xaa,I-N\xcc\xc8\xafT\xe4\x02\x00\xf3nb\xbf\x0b\x00\x00\x00'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	621
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	622
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	623 def gunzip_bytes(bytestring):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	624 """The :mod:`gzip` module is great if you have a file or file-like
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	625 object, but what if you just have bytes. StringIO is one
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	626 possibility, but it's often faster, easier, and simpler to just
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	627 use this one-liner. Use this tried-and-true utility function to
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	628 decompress gzip from bytes.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	629
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	630 >>> gunzip_bytes(_EMPTY_GZIP_BYTES) == b''
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	631 True
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	632 >>> gunzip_bytes(_NON_EMPTY_GZIP_BYTES).rstrip() == b'bytesahoy!'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	633 True
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	634 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	635 return zlib.decompress(bytestring, 16 + zlib.MAX_WBITS)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	636
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	637
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	638 def gzip_bytes(bytestring, level=6):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	639 """Turn some bytes into some compressed bytes.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	640
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	641 >>> len(gzip_bytes(b'a' * 10000))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	642 46
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	643
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	644 Args:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	645 bytestring (bytes): Bytes to be compressed
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	646 level (int): An integer, 1-9, controlling the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	647 speed/compression. 1 is fastest, least compressed, 9 is
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	648 slowest, but most compressed.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	649
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	650 Note that all levels of gzip are pretty fast these days, though
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	651 it's not really a competitor in compression, at any level.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	652 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	653 out = StringIO()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	654 f = GzipFile(fileobj=out, mode='wb', compresslevel=level)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	655 f.write(bytestring)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	656 f.close()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	657 return out.getvalue()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	658
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	659
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	660
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	661 _line_ending_re = re.compile(r'(\r\n\|\n\|\x0b\|\f\|\r\|\x85\|\x2028\|\x2029)',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	662 re.UNICODE)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	663
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	664
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	665 def iter_splitlines(text):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	666 r"""Like :meth:`str.splitlines`, but returns an iterator of lines
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	667 instead of a list. Also similar to :meth:`file.next`, as that also
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	668 lazily reads and yields lines from a file.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	669
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	670 This function works with a variety of line endings, but as always,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	671 be careful when mixing line endings within a file.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	672
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	673 >>> list(iter_splitlines('\nhi\nbye\n'))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	674 ['', 'hi', 'bye', '']
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	675 >>> list(iter_splitlines('\r\nhi\rbye\r\n'))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	676 ['', 'hi', 'bye', '']
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	677 >>> list(iter_splitlines(''))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	678 []
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	679 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	680 prev_end, len_text = 0, len(text)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	681 # print('last: %r' % last_idx)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	682 # start, end = None, None
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	683 for match in _line_ending_re.finditer(text):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	684 start, end = match.start(1), match.end(1)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	685 # print(start, end)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	686 if prev_end <= start:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	687 yield text[prev_end:start]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	688 if end == len_text:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	689 yield ''
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	690 prev_end = end
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	691 tail = text[prev_end:]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	692 if tail:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	693 yield tail
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	694 return
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	695
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	696
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	697 def indent(text, margin, newline='\n', key=bool):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	698 """The missing counterpart to the built-in :func:`textwrap.dedent`.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	699
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	700 Args:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	701 text (str): The text to indent.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	702 margin (str): The string to prepend to each line.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	703 newline (str): The newline used to rejoin the lines (default: ``\\n``)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	704 key (callable): Called on each line to determine whether to
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	705 indent it. Default: :class:`bool`, to ensure that empty lines do
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	706 not get whitespace added.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	707 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	708 indented_lines = [(margin + line if key(line) else line)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	709 for line in iter_splitlines(text)]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	710 return newline.join(indented_lines)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	711
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	712
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	713 def is_uuid(obj, version=4):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	714 """Check the argument is either a valid UUID object or string.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	715
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	716 Args:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	717 obj (object): The test target. Strings and UUID objects supported.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	718 version (int): The target UUID version, set to 0 to skip version check.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	719
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	720 >>> is_uuid('e682ccca-5a4c-4ef2-9711-73f9ad1e15ea')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	721 True
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	722 >>> is_uuid('0221f0d9-d4b9-11e5-a478-10ddb1c2feb9')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	723 False
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	724 >>> is_uuid('0221f0d9-d4b9-11e5-a478-10ddb1c2feb9', version=1)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	725 True
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	726 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	727 if not isinstance(obj, uuid.UUID):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	728 try:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	729 obj = uuid.UUID(obj)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	730 except (TypeError, ValueError, AttributeError):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	731 return False
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	732 if version and obj.version != int(version):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	733 return False
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	734 return True
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	735
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	736
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	737 def escape_shell_args(args, sep=' ', style=None):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	738 """Returns an escaped version of each string in args, according to
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	739 style.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	740
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	741 Args:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	742 args (list): A list of arguments to escape and join together
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	743 sep (str): The separator used to join the escaped arguments.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	744 style (str): The style of escaping to use. Can be one of
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	745 ``cmd`` or ``sh``, geared toward Windows and Linux/BSD/etc.,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	746 respectively. If style is ``None``, then it is picked
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	747 according to the system platform.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	748
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	749 See :func:`args2cmd` and :func:`args2sh` for details and example
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	750 output for each style.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	751 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	752 if not style:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	753 style = 'cmd' if sys.platform == 'win32' else 'sh'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	754
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	755 if style == 'sh':
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	756 return args2sh(args, sep=sep)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	757 elif style == 'cmd':
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	758 return args2cmd(args, sep=sep)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	759
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	760 raise ValueError("style expected one of 'cmd' or 'sh', not %r" % style)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	761
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	762
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	763 _find_sh_unsafe = re.compile(r'[^a-zA-Z0-9_@%+=:,./-]').search
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	764
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	765
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	766 def args2sh(args, sep=' '):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	767 """Return a shell-escaped string version of args, separated by
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	768 sep, based on the rules of sh, bash, and other shells in the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	769 Linux/BSD/MacOS ecosystem.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	770
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	771 >>> print(args2sh(['aa', '[bb]', "cc'cc", 'dd"dd']))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	772 aa '[bb]' 'cc'"'"'cc' 'dd"dd'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	773
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	774 As you can see, arguments with no special characters are not
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	775 escaped, arguments with special characters are quoted with single
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	776 quotes, and single quotes themselves are quoted with double
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	777 quotes. Double quotes are handled like any other special
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	778 character.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	779
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	780 Based on code from the :mod:`pipes`/:mod:`shlex` modules. Also
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	781 note that :mod:`shlex` and :mod:`argparse` have functions to split
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	782 and parse strings escaped in this manner.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	783 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	784 ret_list = []
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	785
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	786 for arg in args:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	787 if not arg:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	788 ret_list.append("''")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	789 continue
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	790 if _find_sh_unsafe(arg) is None:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	791 ret_list.append(arg)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	792 continue
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	793 # use single quotes, and put single quotes into double quotes
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	794 # the string $'b is then quoted as '$'"'"'b'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	795 ret_list.append("'" + arg.replace("'", "'\"'\"'") + "'")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	796
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	797 return ' '.join(ret_list)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	798
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	799
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	800 def args2cmd(args, sep=' '):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	801 r"""Return a shell-escaped string version of args, separated by
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	802 sep, using the same rules as the Microsoft C runtime.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	803
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	804 >>> print(args2cmd(['aa', '[bb]', "cc'cc", 'dd"dd']))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	805 aa [bb] cc'cc dd\"dd
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	806
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	807 As you can see, escaping is through backslashing and not quoting,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	808 and double quotes are the only special character. See the comment
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	809 in the code for more details. Based on internal code from the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	810 :mod:`subprocess` module.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	811
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	812 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	813 # technique description from subprocess below
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	814 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	815 1) Arguments are delimited by white space, which is either a
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	816 space or a tab.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	817
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	818 2) A string surrounded by double quotation marks is
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	819 interpreted as a single argument, regardless of white space
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	820 contained within. A quoted string can be embedded in an
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	821 argument.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	822
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	823 3) A double quotation mark preceded by a backslash is
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	824 interpreted as a literal double quotation mark.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	825
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	826 4) Backslashes are interpreted literally, unless they
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	827 immediately precede a double quotation mark.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	828
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	829 5) If backslashes immediately precede a double quotation mark,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	830 every pair of backslashes is interpreted as a literal
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	831 backslash. If the number of backslashes is odd, the last
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	832 backslash escapes the next double quotation mark as
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	833 described in rule 3.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	834
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	835 See http://msdn.microsoft.com/en-us/library/17w5ykft.aspx
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	836 or search http://msdn.microsoft.com for
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	837 "Parsing C++ Command-Line Arguments"
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	838 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	839 result = []
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	840 needquote = False
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	841 for arg in args:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	842 bs_buf = []
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	843
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	844 # Add a space to separate this argument from the others
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	845 if result:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	846 result.append(' ')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	847
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	848 needquote = (" " in arg) or ("\t" in arg) or not arg
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	849 if needquote:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	850 result.append('"')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	851
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	852 for c in arg:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	853 if c == '\\':
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	854 # Don't know if we need to double yet.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	855 bs_buf.append(c)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	856 elif c == '"':
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	857 # Double backslashes.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	858 result.append('\\' * len(bs_buf)*2)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	859 bs_buf = []
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	860 result.append('\\"')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	861 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	862 # Normal char
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	863 if bs_buf:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	864 result.extend(bs_buf)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	865 bs_buf = []
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	866 result.append(c)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	867
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	868 # Add remaining backslashes, if any.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	869 if bs_buf:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	870 result.extend(bs_buf)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	871
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	872 if needquote:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	873 result.extend(bs_buf)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	874 result.append('"')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	875
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	876 return ''.join(result)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	877
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	878
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	879 def parse_int_list(range_string, delim=',', range_delim='-'):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	880 """Returns a sorted list of positive integers based on
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	881 range_string. Reverse of :func:`format_int_list`.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	882
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	883 Args:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	884 range_string (str): String of comma separated positive
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	885 integers or ranges (e.g. '1,2,4-6,8'). Typical of a custom
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	886 page range string used in printer dialogs.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	887 delim (char): Defaults to ','. Separates integers and
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	888 contiguous ranges of integers.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	889 range_delim (char): Defaults to '-'. Indicates a contiguous
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	890 range of integers.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	891
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	892 >>> parse_int_list('1,3,5-8,10-11,15')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	893 [1, 3, 5, 6, 7, 8, 10, 11, 15]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	894
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	895 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	896 output = []
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	897
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	898 for x in range_string.strip().split(delim):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	899
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	900 # Range
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	901 if range_delim in x:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	902 range_limits = list(map(int, x.split(range_delim)))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	903 output += list(range(min(range_limits), max(range_limits)+1))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	904
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	905 # Empty String
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	906 elif not x:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	907 continue
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	908
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	909 # Integer
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	910 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	911 output.append(int(x))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	912
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	913 return sorted(output)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	914
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	915
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	916 def format_int_list(int_list, delim=',', range_delim='-', delim_space=False):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	917 """Returns a sorted range string from a list of positive integers
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	918 (int_list). Contiguous ranges of integers are collapsed to min
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	919 and max values. Reverse of :func:`parse_int_list`.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	920
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	921 Args:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	922 int_list (list): List of positive integers to be converted
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	923 into a range string (e.g. [1,2,4,5,6,8]).
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	924 delim (char): Defaults to ','. Separates integers and
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	925 contiguous ranges of integers.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	926 range_delim (char): Defaults to '-'. Indicates a contiguous
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	927 range of integers.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	928 delim_space (bool): Defaults to ``False``. If ``True``, adds a
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	929 space after all delim characters.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	930
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	931 >>> format_int_list([1,3,5,6,7,8,10,11,15])
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	932 '1,3,5-8,10-11,15'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	933
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	934 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	935 output = []
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	936 contig_range = collections.deque()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	937
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	938 for x in sorted(int_list):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	939
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	940 # Handle current (and first) value.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	941 if len(contig_range) < 1:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	942 contig_range.append(x)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	943
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	944 # Handle current value, given multiple previous values are contiguous.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	945 elif len(contig_range) > 1:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	946 delta = x - contig_range[-1]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	947
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	948 # Current value is contiguous.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	949 if delta == 1:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	950 contig_range.append(x)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	951
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	952 # Current value is non-contiguous.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	953 elif delta > 1:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	954 range_substr = '{0:d}{1}{2:d}'.format(min(contig_range),
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	955 range_delim,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	956 max(contig_range))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	957 output.append(range_substr)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	958 contig_range.clear()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	959 contig_range.append(x)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	960
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	961 # Current value repeated.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	962 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	963 continue
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	964
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	965 # Handle current value, given no previous contiguous integers
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	966 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	967 delta = x - contig_range[0]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	968
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	969 # Current value is contiguous.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	970 if delta == 1:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	971 contig_range.append(x)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	972
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	973 # Current value is non-contiguous.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	974 elif delta > 1:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	975 output.append('{0:d}'.format(contig_range.popleft()))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	976 contig_range.append(x)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	977
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	978 # Current value repeated.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	979 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	980 continue
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	981
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	982 # Handle the last value.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	983 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	984
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	985 # Last value is non-contiguous.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	986 if len(contig_range) == 1:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	987 output.append('{0:d}'.format(contig_range.popleft()))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	988 contig_range.clear()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	989
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	990 # Last value is part of contiguous range.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	991 elif len(contig_range) > 1:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	992 range_substr = '{0:d}{1}{2:d}'.format(min(contig_range),
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	993 range_delim,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	994 max(contig_range))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	995 output.append(range_substr)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	996 contig_range.clear()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	997
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	998 if delim_space:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	999 output_str = (delim+' ').join(output)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1000 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1001 output_str = delim.join(output)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1002
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1003 return output_str
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1004
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1005
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1006 def complement_int_list(
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1007 range_string, range_start=0, range_end=None,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1008 delim=',', range_delim='-'):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1009 """ Returns range string that is the complement of the one provided as
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1010 range_string parameter.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1011
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1012 These range strings are of the kind produce by :func:`format_int_list`, and
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1013 parseable by :func:`parse_int_list`.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1014
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1015 Args:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1016 range_string (str): String of comma separated positive integers or
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1017 ranges (e.g. '1,2,4-6,8'). Typical of a custom page range string
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1018 used in printer dialogs.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1019 range_start (int): A positive integer from which to start the resulting
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1020 range. Value is inclusive. Defaults to ``0``.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1021 range_end (int): A positive integer from which the produced range is
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1022 stopped. Value is exclusive. Defaults to the maximum value found in
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1023 the provided ``range_string``.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1024 delim (char): Defaults to ','. Separates integers and contiguous ranges
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1025 of integers.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1026 range_delim (char): Defaults to '-'. Indicates a contiguous range of
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1027 integers.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1028
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1029 >>> complement_int_list('1,3,5-8,10-11,15')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1030 '0,2,4,9,12-14'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1031
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1032 >>> complement_int_list('1,3,5-8,10-11,15', range_start=0)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1033 '0,2,4,9,12-14'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1034
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1035 >>> complement_int_list('1,3,5-8,10-11,15', range_start=1)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1036 '2,4,9,12-14'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1037
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1038 >>> complement_int_list('1,3,5-8,10-11,15', range_start=2)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1039 '2,4,9,12-14'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1040
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1041 >>> complement_int_list('1,3,5-8,10-11,15', range_start=3)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1042 '4,9,12-14'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1043
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1044 >>> complement_int_list('1,3,5-8,10-11,15', range_end=15)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1045 '0,2,4,9,12-14'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1046
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1047 >>> complement_int_list('1,3,5-8,10-11,15', range_end=14)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1048 '0,2,4,9,12-13'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1049
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1050 >>> complement_int_list('1,3,5-8,10-11,15', range_end=13)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1051 '0,2,4,9,12'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1052
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1053 >>> complement_int_list('1,3,5-8,10-11,15', range_end=20)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1054 '0,2,4,9,12-14,16-19'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1055
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1056 >>> complement_int_list('1,3,5-8,10-11,15', range_end=0)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1057 ''
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1058
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1059 >>> complement_int_list('1,3,5-8,10-11,15', range_start=-1)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1060 '0,2,4,9,12-14'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1061
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1062 >>> complement_int_list('1,3,5-8,10-11,15', range_end=-1)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1063 ''
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1064
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1065 >>> complement_int_list('1,3,5-8', range_start=1, range_end=1)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1066 ''
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1067
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1068 >>> complement_int_list('1,3,5-8', range_start=2, range_end=2)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1069 ''
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1070
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1071 >>> complement_int_list('1,3,5-8', range_start=2, range_end=3)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1072 '2'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1073
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1074 >>> complement_int_list('1,3,5-8', range_start=-10, range_end=-5)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1075 ''
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1076
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1077 >>> complement_int_list('1,3,5-8', range_start=20, range_end=10)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1078 ''
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1079
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1080 >>> complement_int_list('')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1081 ''
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1082 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1083 int_list = set(parse_int_list(range_string, delim, range_delim))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1084 if range_end is None:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1085 if int_list:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1086 range_end = max(int_list) + 1
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1087 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1088 range_end = range_start
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1089 complement_values = set(
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1090 range(range_end)) - int_list - set(range(range_start))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1091 return format_int_list(complement_values, delim, range_delim)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1092
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1093
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1094 def int_ranges_from_int_list(range_string, delim=',', range_delim='-'):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1095 """ Transform a string of ranges (range_string) into a tuple of tuples.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1096
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1097 Args:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1098 range_string (str): String of comma separated positive integers or
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1099 ranges (e.g. '1,2,4-6,8'). Typical of a custom page range string
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1100 used in printer dialogs.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1101 delim (char): Defaults to ','. Separates integers and contiguous ranges
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1102 of integers.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1103 range_delim (char): Defaults to '-'. Indicates a contiguous range of
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1104 integers.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1105
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1106 >>> int_ranges_from_int_list('1,3,5-8,10-11,15')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1107 ((1, 1), (3, 3), (5, 8), (10, 11), (15, 15))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1108
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1109 >>> int_ranges_from_int_list('1')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1110 ((1, 1),)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1111
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1112 >>> int_ranges_from_int_list('')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1113 ()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1114 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1115 int_tuples = []
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1116 # Normalize the range string to our internal format for processing.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1117 range_string = format_int_list(
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1118 parse_int_list(range_string, delim, range_delim))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1119 if range_string:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1120 for bounds in range_string.split(','):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1121 if '-' in bounds:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1122 start, end = bounds.split('-')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1123 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1124 start, end = bounds, bounds
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1125 int_tuples.append((int(start), int(end)))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1126 return tuple(int_tuples)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1127
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1128
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1129 class MultiReplace(object):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1130 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1131 MultiReplace is a tool for doing multiple find/replace actions in one pass.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1132
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1133 Given a mapping of values to be replaced it allows for all of the matching
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1134 values to be replaced in a single pass which can save a lot of performance
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1135 on very large strings. In addition to simple replace, it also allows for
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1136 replacing based on regular expressions.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1137
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1138 Keyword Arguments:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1139
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1140 :type regex: bool
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1141 :param regex: Treat search keys as regular expressions [Default: False]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1142 :type flags: int
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1143 :param flags: flags to pass to the regex engine during compile
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1144
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1145 Dictionary Usage::
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1146
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1147 from lrmslib import stringutils
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1148 s = stringutils.MultiReplace({
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1149 'foo': 'zoo',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1150 'cat': 'hat',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1151 'bat': 'kraken'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1152 })
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1153 new = s.sub('The foo bar cat ate a bat')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1154 new == 'The zoo bar hat ate a kraken'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1155
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1156 Iterable Usage::
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1157
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1158 from lrmslib import stringutils
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1159 s = stringutils.MultiReplace([
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1160 ('foo', 'zoo'),
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1161 ('cat', 'hat'),
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1162 ('bat', 'kraken)'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1163 ])
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1164 new = s.sub('The foo bar cat ate a bat')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1165 new == 'The zoo bar hat ate a kraken'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1166
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1167
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1168 The constructor can be passed a dictionary or other mapping as well as
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1169 an iterable of tuples. If given an iterable, the substitution will be run
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1170 in the order the replacement values are specified in the iterable. This is
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1171 also true if it is given an OrderedDict. If given a dictionary then the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1172 order will be non-deterministic::
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1173
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1174 >>> 'foo bar baz'.replace('foo', 'baz').replace('baz', 'bar')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1175 'bar bar bar'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1176 >>> m = MultiReplace({'foo': 'baz', 'baz': 'bar'})
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1177 >>> m.sub('foo bar baz')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1178 'baz bar bar'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1179
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1180 This is because the order of replacement can matter if you're inserting
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1181 something that might be replaced by a later substitution. Pay attention and
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1182 if you need to rely on order then consider using a list of tuples instead
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1183 of a dictionary.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1184 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1185
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1186 def __init__(self, sub_map, **kwargs):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1187 """Compile any regular expressions that have been passed."""
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1188 options = {
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1189 'regex': False,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1190 'flags': 0,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1191 }
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1192 options.update(kwargs)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1193 self.group_map = {}
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1194 regex_values = []
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1195
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1196 if isinstance(sub_map, Mapping):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1197 sub_map = sub_map.items()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1198
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1199 for idx, vals in enumerate(sub_map):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1200 group_name = 'group{0}'.format(idx)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1201 if isinstance(vals[0], basestring):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1202 # If we're not treating input strings like a regex, escape it
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1203 if not options['regex']:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1204 exp = re.escape(vals[0])
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1205 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1206 exp = vals[0]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1207 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1208 exp = vals[0].pattern
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1209
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1210 regex_values.append('(?P<{0}>{1})'.format(
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1211 group_name,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1212 exp
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1213 ))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1214 self.group_map[group_name] = vals[1]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1215
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1216 self.combined_pattern = re.compile(
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1217 '\|'.join(regex_values),
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1218 flags=options['flags']
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1219 )
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1220
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1221 def _get_value(self, match):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1222 """Given a match object find replacement value."""
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1223 group_dict = match.groupdict()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1224 key = [x for x in group_dict if group_dict[x]][0]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1225 return self.group_map[key]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1226
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1227 def sub(self, text):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1228 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1229 Run substitutions on the input text.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1230
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1231 Given an input string, run all substitutions given in the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1232 constructor.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1233 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1234 return self.combined_pattern.sub(self._get_value, text)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1235
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1236
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1237 def multi_replace(text, sub_map, **kwargs):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1238 """Shortcut function to invoke multi-replace in a single command."""
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1239 m = MultiReplace(sub_map, **kwargs)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1240 return m.sub(text)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1241
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1242
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1243 def unwrap_text(text, ending='\n\n'):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1244 r"""
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1245 Unwrap text, the natural complement to :func:`textwrap.wrap`.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1246
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1247 >>> text = "Short \n lines \nwrapped\nsmall.\n\nAnother\nparagraph."
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1248 >>> unwrap_text(text)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1249 'Short lines wrapped small.\n\nAnother paragraph.'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1250
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1251 Args:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1252 text: A string to unwrap.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1253 ending (str): The string to join all unwrapped paragraphs
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1254 by. Pass ``None`` to get the list. Defaults to '\n\n' for
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1255 compatibility with Markdown and RST.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1256
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1257 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1258 all_grafs = []
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1259 cur_graf = []
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1260 for line in text.splitlines():
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1261 line = line.strip()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1262 if line:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1263 cur_graf.append(line)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1264 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1265 all_grafs.append(' '.join(cur_graf))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1266 cur_graf = []
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1267 if cur_graf:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1268 all_grafs.append(' '.join(cur_graf))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1269 if ending is None:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1270 return all_grafs
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1271 return ending.join(all_grafs)

Mercurial > repos > guerler > springsuite

annotate planemo/lib/python3.7/site-packages/boltons/strutils.py @ 1:56ad4e20f292 draft