Module lib.tools.strings
Strings utilities
Expand source code
# Distributed under Pycameresp License
# Copyright (c) 2023 Remi BERTHOLET
# pylint:disable=consider-using-f-string
""" Strings utilities """
import binascii
import time
import io
def key_to_string(value):
""" Convert key to string """
if value <= 0x1A:
return "CTRL-%s"%chr(64+value)
elif value == 0x1B:
return "ESC"
elif value == 0x20:
return "SPACE"
else:
return "%s"%chr(value)
def size_to_string(size, largeur=6):
""" Convert a size in a string with k, m, g, t..."""
return size_to_bytes(size, largeur).decode("utf8")
def size_to_bytes(size, largeur=7):
""" Convert a size in a bytes with k, m, g, t..."""
if size > 1073741824*1024:
return b"%*.2fT"%(largeur, size / (1073741824.*1024.))
elif size > 1073741824:
return b"%*.2fG"%(largeur, size / 1073741824.)
elif size > 1048576:
return b"%*.2fM"%(largeur, size / 1048576.)
elif size > 1024:
return b"%*.2fK"%(largeur, size / 1024.)
else:
return b"%*dB"%(largeur, size)
def tobytes(datas, encoding="utf8"):
""" Convert data to bytes """
result = datas
if type(datas) == type(""):
result = datas.encode(encoding)
elif type(datas) == type([]):
result = []
for item in datas:
result.append(tobytes(item, encoding))
elif type(datas) == type((0,0)):
result = []
for item in datas:
result.append(tobytes(item, encoding))
result = tuple(result)
elif type(datas) == type({}):
result = {}
for key, value in datas.items():
result[tobytes(key,encoding)] = tobytes(value, encoding)
return result
def tostrings(datas, encoding="utf8"):
""" Convert data to strings """
result = datas
if type(datas) == type(b""):
result = datas.decode(encoding)
elif type(datas) == type([]):
result = []
for item in datas:
result.append(tostrings(item, encoding))
elif type(datas) == type((0,0)):
result = []
for item in datas:
result.append(tostrings(item, encoding))
result = tuple(result)
elif type(datas) == type({}):
result = {}
for key, value in datas.items():
result[tostrings(key,encoding)] = tostrings(value, encoding)
return result
def tofilename(filename):
""" Replace forbid characters in filename """
filename = tostrings(filename)
if len(filename) > 0:
for char in "<>:/\\|?*":
filename = filename.replace(char,"_%d_"%ord(char))
return filename
def isascii(char):
""" Indicates if the char is ascii """
if len(char) == 1:
if ord(char) >= 0x20 and ord(char) != 0x7F or char == "\t":
return True
return False
def isupper(char):
""" Indicates if the char is upper """
if len(char) == 1:
if ord(char) >= 0x41 and ord(char) <= 0x5A:
return True
return False
def islower(char):
""" Indicates if the char is lower """
if len(char) == 1:
if ord(char) >= 0x61 and ord(char) < 0x7A:
return True
return False
def isdigit(char):
""" Indicates if the char is a digit """
if len(char) == 1:
if ord(char) >= 0x31 and ord(char) <= 0x39:
return True
return False
def isalpha(char):
""" Indicates if the char is alpha """
return isupper(char) or islower(char) or isdigit(char)
def isspace(char):
""" Indicates if the char is a space, tabulation or new line """
if char == " " or char == "\t" or char == "\n" or char == "\r":
return True
return False
def ispunctuation(char):
""" Indicates if the char is a punctuation """
if (ord(char) >= 0x21 and ord(char) <= 0x2F) or \
(ord(char) >= 0x3A and ord(char) <= 0x40) or \
(ord(char) >= 0x5B and ord(char) <= 0x60) or \
(ord(char) >= 0x7B and ord(char) <= 0x7E):
return True
else:
return False
def get_length_utf8(key):
""" Get the length utf8 string """
if len(key) > 0:
char = key[0]
if char <= 0x7F:
return 1
elif char >= 0xC2 and char <= 0xDF:
return 2
elif char >= 0xE0 and char <= 0xEF:
return 3
elif char >= 0xF0 and char <= 0xF4:
return 4
return 1
else:
return 0
def is_key_ended(key):
""" Indicates if the key completly entered """
if len(key) == 0:
return False
else:
char = key[-1]
if len(key) == 1:
if char == 0x1B:
return False
elif get_length_utf8(key) == len(key):
return True
elif len(key) == 2:
if key[0] == b"\x1B" and key[1] == b"\x1B":
return False
elif key[0] == b"\x1B":
if key[1] == b"[" or key[1] == b"(" or \
key[1] == b")" or key[1] == b"#" or \
key[1] == b"?" or key[1] == b"O":
return False
else:
return True
elif get_length_utf8(key) == len(key):
return True
else:
if key[-1] >= ord("A") and key[-1] <= ord("Z"):
return True
elif key[-1] >= ord("a") and key[-1] <= ord("z"):
return True
elif key[-1] == b"~":
return True
elif key[0] != b"\x1B" and get_length_utf8(key) == len(key):
return True
return False
def dump(buff, withColor=True):
""" dump buffer """
if withColor:
string = "\x1B[7m"
else:
string = ""
if type(buff) == type(b"") or type(buff) == type(bytearray()):
for i in buff:
if isascii(chr(i)):
string += chr(i)
else:
string += "\\x%02x"%i
else:
for i in buff:
if isascii(i):
string += i
else:
string += "\\x%02x"%ord(i)
if withColor:
string += "\x1B[m"
return string
def dump_line(data, line=None, width=0, spacer=b" "):
""" dump a data data in hexadecimal on one line """
size = len(data)
fill = 0
if line is None:
output = io.BytesIO()
else:
output = line
# Calculation of the filling length
if width > size:
fill = width-size
# Displaying values in hex
output.write(binascii.hexlify(data, " ").upper())
# Filling of vacuum according to the size of the dump
output.write(spacer*fill*3)
# Display of ASCII codes
output.write(b' |')
for i in data:
if i >= 0x20 and i < 0x7F and i != 0x3C and i != 0x3E:
output.write(i.to_bytes(1,"big"))
else:
output.write(b'.')
# Filling of vacuum according to the size of the dump
output.write(spacer*fill)
# End of data ascii
output.write(b'|')
if line is None:
return output.getvalue()
def compute_hash(string):
""" Compute hash
>>> print(compute_hash("1234"))
49307
>>> print(compute_hash(b"1234"))
49307
"""
string = tostrings(string)
hash_ = 63689
for char in string:
hash_ = hash_ * 378551 + ord(char)
return hash_ % 65536
try:
# pylint: disable=no-name-in-module
from time import ticks_ms
def ticks():
""" Count tick elapsed from start """
return ticks_ms()
except:
_ticks_init = time.monotonic()
def ticks():
""" Count tick elapsed from start """
result = (int)((time.monotonic() - _ticks_init)*1000)
return result
def ticks_to_string():
""" Create a string with tick in seconds """
tick = ticks()
return "%d.%03d s"%(tick/1000, tick%1000)
def get_utf8_length(data):
""" Get the length of utf8 character """
# 0XXX XXXX one byte
if data <= 0x7F:
length = 1
# 110X XXXX two length
else:
# first byte
if ((data & 0xE0) == 0xC0):
length = 2
# 1110 XXXX three bytes length
elif ((data & 0xF0) == 0xE0):
length = 3
# 1111 0XXX four bytes length
elif ((data & 0xF8) == 0xF0):
length = 4
# 1111 10XX five bytes length
elif ((data & 0xFC) == 0xF8):
length = 5
# 1111 110X six bytes length
elif ((data & 0xFE) == 0xFC):
length = 6
else:
# not a valid first byte of a UTF-8 sequence
length = -1
return lengthFunctions
def compute_hash(string)-
Compute hash
>>> print(compute_hash("1234")) 49307 >>> print(compute_hash(b"1234")) 49307Expand source code
def compute_hash(string): """ Compute hash >>> print(compute_hash("1234")) 49307 >>> print(compute_hash(b"1234")) 49307 """ string = tostrings(string) hash_ = 63689 for char in string: hash_ = hash_ * 378551 + ord(char) return hash_ % 65536 def dump(buff, withColor=True)-
dump buffer
Expand source code
def dump(buff, withColor=True): """ dump buffer """ if withColor: string = "\x1B[7m" else: string = "" if type(buff) == type(b"") or type(buff) == type(bytearray()): for i in buff: if isascii(chr(i)): string += chr(i) else: string += "\\x%02x"%i else: for i in buff: if isascii(i): string += i else: string += "\\x%02x"%ord(i) if withColor: string += "\x1B[m" return string def dump_line(data, line=None, width=0, spacer=b' ')-
dump a data data in hexadecimal on one line
Expand source code
def dump_line(data, line=None, width=0, spacer=b" "): """ dump a data data in hexadecimal on one line """ size = len(data) fill = 0 if line is None: output = io.BytesIO() else: output = line # Calculation of the filling length if width > size: fill = width-size # Displaying values in hex output.write(binascii.hexlify(data, " ").upper()) # Filling of vacuum according to the size of the dump output.write(spacer*fill*3) # Display of ASCII codes output.write(b' |') for i in data: if i >= 0x20 and i < 0x7F and i != 0x3C and i != 0x3E: output.write(i.to_bytes(1,"big")) else: output.write(b'.') # Filling of vacuum according to the size of the dump output.write(spacer*fill) # End of data ascii output.write(b'|') if line is None: return output.getvalue() def get_length_utf8(key)-
Get the length utf8 string
Expand source code
def get_length_utf8(key): """ Get the length utf8 string """ if len(key) > 0: char = key[0] if char <= 0x7F: return 1 elif char >= 0xC2 and char <= 0xDF: return 2 elif char >= 0xE0 and char <= 0xEF: return 3 elif char >= 0xF0 and char <= 0xF4: return 4 return 1 else: return 0 def get_utf8_length(data)-
Get the length of utf8 character
Expand source code
def get_utf8_length(data): """ Get the length of utf8 character """ # 0XXX XXXX one byte if data <= 0x7F: length = 1 # 110X XXXX two length else: # first byte if ((data & 0xE0) == 0xC0): length = 2 # 1110 XXXX three bytes length elif ((data & 0xF0) == 0xE0): length = 3 # 1111 0XXX four bytes length elif ((data & 0xF8) == 0xF0): length = 4 # 1111 10XX five bytes length elif ((data & 0xFC) == 0xF8): length = 5 # 1111 110X six bytes length elif ((data & 0xFE) == 0xFC): length = 6 else: # not a valid first byte of a UTF-8 sequence length = -1 return length def is_key_ended(key)-
Indicates if the key completly entered
Expand source code
def is_key_ended(key): """ Indicates if the key completly entered """ if len(key) == 0: return False else: char = key[-1] if len(key) == 1: if char == 0x1B: return False elif get_length_utf8(key) == len(key): return True elif len(key) == 2: if key[0] == b"\x1B" and key[1] == b"\x1B": return False elif key[0] == b"\x1B": if key[1] == b"[" or key[1] == b"(" or \ key[1] == b")" or key[1] == b"#" or \ key[1] == b"?" or key[1] == b"O": return False else: return True elif get_length_utf8(key) == len(key): return True else: if key[-1] >= ord("A") and key[-1] <= ord("Z"): return True elif key[-1] >= ord("a") and key[-1] <= ord("z"): return True elif key[-1] == b"~": return True elif key[0] != b"\x1B" and get_length_utf8(key) == len(key): return True return False def isalpha(char)-
Indicates if the char is alpha
Expand source code
def isalpha(char): """ Indicates if the char is alpha """ return isupper(char) or islower(char) or isdigit(char) def isascii(char)-
Indicates if the char is ascii
Expand source code
def isascii(char): """ Indicates if the char is ascii """ if len(char) == 1: if ord(char) >= 0x20 and ord(char) != 0x7F or char == "\t": return True return False def isdigit(char)-
Indicates if the char is a digit
Expand source code
def isdigit(char): """ Indicates if the char is a digit """ if len(char) == 1: if ord(char) >= 0x31 and ord(char) <= 0x39: return True return False def islower(char)-
Indicates if the char is lower
Expand source code
def islower(char): """ Indicates if the char is lower """ if len(char) == 1: if ord(char) >= 0x61 and ord(char) < 0x7A: return True return False def ispunctuation(char)-
Indicates if the char is a punctuation
Expand source code
def ispunctuation(char): """ Indicates if the char is a punctuation """ if (ord(char) >= 0x21 and ord(char) <= 0x2F) or \ (ord(char) >= 0x3A and ord(char) <= 0x40) or \ (ord(char) >= 0x5B and ord(char) <= 0x60) or \ (ord(char) >= 0x7B and ord(char) <= 0x7E): return True else: return False def isspace(char)-
Indicates if the char is a space, tabulation or new line
Expand source code
def isspace(char): """ Indicates if the char is a space, tabulation or new line """ if char == " " or char == "\t" or char == "\n" or char == "\r": return True return False def isupper(char)-
Indicates if the char is upper
Expand source code
def isupper(char): """ Indicates if the char is upper """ if len(char) == 1: if ord(char) >= 0x41 and ord(char) <= 0x5A: return True return False def key_to_string(value)-
Convert key to string
Expand source code
def key_to_string(value): """ Convert key to string """ if value <= 0x1A: return "CTRL-%s"%chr(64+value) elif value == 0x1B: return "ESC" elif value == 0x20: return "SPACE" else: return "%s"%chr(value) def size_to_bytes(size, largeur=7)-
Convert a size in a bytes with k, m, g, t…
Expand source code
def size_to_bytes(size, largeur=7): """ Convert a size in a bytes with k, m, g, t...""" if size > 1073741824*1024: return b"%*.2fT"%(largeur, size / (1073741824.*1024.)) elif size > 1073741824: return b"%*.2fG"%(largeur, size / 1073741824.) elif size > 1048576: return b"%*.2fM"%(largeur, size / 1048576.) elif size > 1024: return b"%*.2fK"%(largeur, size / 1024.) else: return b"%*dB"%(largeur, size) def size_to_string(size, largeur=6)-
Convert a size in a string with k, m, g, t…
Expand source code
def size_to_string(size, largeur=6): """ Convert a size in a string with k, m, g, t...""" return size_to_bytes(size, largeur).decode("utf8") def ticks()-
Count tick elapsed from start
Expand source code
def ticks(): """ Count tick elapsed from start """ result = (int)((time.monotonic() - _ticks_init)*1000) return result def ticks_to_string()-
Create a string with tick in seconds
Expand source code
def ticks_to_string(): """ Create a string with tick in seconds """ tick = ticks() return "%d.%03d s"%(tick/1000, tick%1000) def tobytes(datas, encoding='utf8')-
Convert data to bytes
Expand source code
def tobytes(datas, encoding="utf8"): """ Convert data to bytes """ result = datas if type(datas) == type(""): result = datas.encode(encoding) elif type(datas) == type([]): result = [] for item in datas: result.append(tobytes(item, encoding)) elif type(datas) == type((0,0)): result = [] for item in datas: result.append(tobytes(item, encoding)) result = tuple(result) elif type(datas) == type({}): result = {} for key, value in datas.items(): result[tobytes(key,encoding)] = tobytes(value, encoding) return result def tofilename(filename)-
Replace forbid characters in filename
Expand source code
def tofilename(filename): """ Replace forbid characters in filename """ filename = tostrings(filename) if len(filename) > 0: for char in "<>:/\\|?*": filename = filename.replace(char,"_%d_"%ord(char)) return filename def tostrings(datas, encoding='utf8')-
Convert data to strings
Expand source code
def tostrings(datas, encoding="utf8"): """ Convert data to strings """ result = datas if type(datas) == type(b""): result = datas.decode(encoding) elif type(datas) == type([]): result = [] for item in datas: result.append(tostrings(item, encoding)) elif type(datas) == type((0,0)): result = [] for item in datas: result.append(tostrings(item, encoding)) result = tuple(result) elif type(datas) == type({}): result = {} for key, value in datas.items(): result[tostrings(key,encoding)] = tostrings(value, encoding) return result