mirror of
https://github.com/creyD/entro.py.git
synced 2026-04-12 20:00:29 +02:00
91 lines
3.3 KiB
Python
91 lines
3.3 KiB
Python
'''
|
|
calc_entro.py calculates the entropy of a given string or file
|
|
|
|
This uses the negative sum of the log (to the base of 2) of the probability
|
|
times the probability of a char to occur in a certain string as the entropy.
|
|
'''
|
|
|
|
import math
|
|
import argparse
|
|
|
|
|
|
# Calculates the entropy of a given string (as described in the docstring)
|
|
def calculateEntropy(input_string):
|
|
alphabet, alphabet_size, entropy = {}, len(input_string), 0
|
|
|
|
for char in input_string:
|
|
if char in alphabet:
|
|
alphabet[char] += 1
|
|
else:
|
|
alphabet[char] = 1
|
|
|
|
for char in alphabet:
|
|
alphabet[char] = alphabet[char] / alphabet_size
|
|
entropy -= alphabet[char] * math.log(alphabet[char], 2)
|
|
|
|
max_entropy = - len(alphabet) * (1/len(alphabet) * math.log(1/len(alphabet), 2))
|
|
return entropy, alphabet, max_entropy
|
|
|
|
|
|
# Outputs a given entropy including the original text and the alphabet with probabilities
|
|
def printEntropy(original_string, entropy_value, alphabet_dict, simple_bool, max_value):
|
|
print('---')
|
|
if simple_bool == False:
|
|
print('Content: ' + original_string)
|
|
print('Probabilities: ' + str(alphabet_dict))
|
|
print('Entropy: ' + str(entropy_value) + ' bits')
|
|
if max_value:
|
|
print('Maximum Entropy: ' + str(max_value) + ' bits')
|
|
print('---')
|
|
|
|
|
|
# Reads a file by a given path
|
|
def readEntropyFile(path_string):
|
|
f = open(path_string, 'r')
|
|
content = f.read().replace('\n', ' ')
|
|
f.close()
|
|
return content.strip()
|
|
|
|
|
|
# List of the arguments one can use to influence the behavior of the program
|
|
parser = argparse.ArgumentParser(description='Calculate the information entropy of alphabets.')
|
|
|
|
# INPUT ARGUMENTS
|
|
parser.add_argument('strings', nargs='*', default='', type=str, help='Strings to calculate the entropy of.')
|
|
parser.add_argument('--files', nargs='*', type=str, default='', help='Provide file path(s) to calculate the entropy of.')
|
|
|
|
# OUTPUT OPTIONS
|
|
parser.add_argument('--simple', nargs='?', type=bool, default=False, help='Determines the explicitness of the output. (True = only entropy shown)')
|
|
parser.add_argument('--max', nargs='?', type=bool, default=False, help='Includes the maximum entropy.')
|
|
|
|
# CONVERT OPTIONS
|
|
parser.add_argument('--lower', nargs='?', type=bool, default=False, help='Converts given strings or textfiles to lowercase before calculating.')
|
|
parser.add_argument('--upper', nargs='?', type=bool, default=False, help='Converts given strings or textfiles to uppercase before calculating.')
|
|
parser.add_argument('--squash', nargs='?', type=bool, default=False, help='Removes all whitespaces before calculating.')
|
|
args = parser.parse_args()
|
|
|
|
# Prepares the queue of different strings
|
|
queue = []
|
|
|
|
# Add all the provided strings to the list
|
|
for string in args.strings:
|
|
queue.append(string)
|
|
|
|
# Add all the provided files to the list
|
|
for file in args.files:
|
|
string = readEntropyFile(file)
|
|
queue.append(string)
|
|
|
|
# Interates over the collected strings and prints the entropies
|
|
for string in queue:
|
|
if args.lower != False:
|
|
string = string.lower()
|
|
elif args.upper != False:
|
|
string = string.upper()
|
|
|
|
if args.squash != False:
|
|
string = string.replace(" ", "")
|
|
|
|
a, b, c = calculateEntropy(string)
|
|
printEntropy(string, a, b, args.simple, (False if args.max == False else c))
|