Python String Utils

Latest version:1.0.0 (March 2020)

What's inside...

Library structure

Api overview

String validation functions:

is_string('hello') # returns trueis_string(b'hello') # returns false

is_full_string(None) # returns falseis_full_string('') # returns falseis_full_string(' ') # returns falseis_full_string('foo') # returns true

is_number('42') # returns trueis_number('-25.99') # returns trueis_number('1e3') # returns trueis_number(' 1 2 3 ') # returns false

is_integer('42') # returns trueis_integer('42.0') # returns false

is_decimal('42.0') # returns trueis_decimal('42') # returns false

is_url('foo.com') # returns falseis_url('http://www.foo.com') # returns trueis_url('https://foo.com') # returns true

is_email('my.email@some.provider.com') # returns trueis_eamil('@gmail.com') # retruns false

is_credit_card(value)# returns true if `value` represents a valid card number for one of these:# VISA, MASTERCARD, AMERICAN EXPRESS, DINERS CLUB, DISCOVER or JCB

is_camel_case('MyCamelCase') # returns trueis_camel_case('hello') # returns false

is_snake_case('snake_bites') # returns trueis_snake_case('nope') # returns false

is_json('{"first_name": "Peter", "last_name": "Parker"}') # returns trueis_json('[1, 2, 3]') # returns trueis_json('{nope}') # returns false

is_uuid('ce2cd4ee-83de-46f6-a054-5ee4ddae1582') # returns true

is_ip_v4('255.200.100.75') # returns trueis_ip_v4('255.200.100.999') # returns false (999 is out of range)

is_ip_v6('2001:db8:85a3:0000:0000:8a2e:370:7334') # returns trueis_ip_v6('123:db8:85a3:0000:0000:8a2e:370,1') # returns false

is_ip('255.200.100.75') # returns trueis_ip('2001:db8:85a3:0000:0000:8a2e:370:7334') # returns trueis_ip('255.200.100.999') # returns falseis_ip('123:db8:85a3:0000:0000:8a2e:370,1') # returns false

is_isbn_13('9780312498580') # returns trueis_isbn_13('978-0312498580') # returns trueis_isbn_13('978-0312498580', normalize=False) # returns false

is_isbn_10('1506715214') # returns trueis_isbn_10('150-6715214') # returns trueis_isbn_10('150-6715214', normalize=False) # returns false

is_isbn('9780312498580') # returns trueis_isbn('1506715214') # returns true

is_slug('my-blog-post-title') # returns trueis_slug('My blog post title') # returns false

contains_html('my string is <strong>bold</strong>') # returns truecontains_html('my string is not bold') # returns false

words_count('hello world') # returns 2words_count('one,two,three') # returns 3 (no need for spaces, punctuation is recognized!)

is_palindrome('LOL') # returns trueis_palindrome('ROTFL') # returns false

is_pangram('The quick brown fox jumps over the lazy dog') # returns trueis_pangram('hello world') # returns false

is_isogram('dermatoglyphics') # returns trueis_isogram('hello') # returns false

String manipulation:

camel_case_to_snake('ThisIsACamelStringTest') # returns 'this_is_a_camel_case_string_test'

snake_case_to_camel('the_snake_is_green') # returns 'TheSnakeIsGreen'

reverse('hello') # returns 'olleh'

shuffle('hello world') # possible output: 'l wodheorll'

strip_html('test: <a href="foo/bar">click here</a>') # returns 'test: 'strip_html('test: <a href="foo/bar">click here</a>', keep_tag_content=True) # returns 'test: click here'

prettify(' unprettified string ,, like this one,will be"prettified" .it\' s awesome! ')# the ouput will be: 'Unprettified string, like this one, will be "prettified". It\'s awesome!'

asciify('èéùúòóäåëýñÅÀÁÇÌÍÑÓË') # returns 'eeuuooaaeynAAACIINOE' (string is deliberately dumb in order to show char conversion)

slugify('Top 10 Reasons To Love Dogs!!!') # returns: 'top-10-reasons-to-love-dogs'

booleanize('true') # returns truebooleanize('YES') # returns truebooleanize('y') # returns truebooleanize('1') # returns truebooelanize('something else') # returns false

strip_margin('''        line 1        line 2        line 3''')#returns:'''line 1line 2line 3'''

compressed = compress(my_long_string) # shorter string (URL safe base64 encoded)decompressed = decompress(compressed) # string restoredassert(my_long_string == decompressed) # yep

roman_encode(37) # returns 'XXXVII'

roman_decode('XXXVII') # returns 37

for n in roman_range(10): print(n) # prints: I, II, III, IV, V, VI, VII, VIII, IX, Xfor n in roman_range(start=7, stop=1, step=-1): print(n) # prints: VII, VI, V, IV, III, II, I

String generations:

uuid() # possible output: 'ce2cd4ee-83de-46f6-a054-5ee4ddae1582'uuid(as_hex=True) # possible output: 'ce2cd4ee83de46f6a0545ee4ddae1582'

random_string(9) # possible output: 'K1URtlTu5'

secure_random_hex(12) # possible ouput: 'd1eedff4033a2e9867c37ded' # (len is 24, because 12 represents the number of random bytes generated, which are then converted to hexadecimal value)

Installation

pip install python-string-utils

Checking installed version

import string_utilsstring_utils.__version__'1.0.0' # (if '1.0.0' is the installed version)

Documentation

Support the project!