Transform internal id's to obfuscated integers using Knuth's integer hash
This is based fully on pjebs/optimus-go for Go which is based on jenssegers/optimus for PHP which is based on Knuth's Integer Hashing (Multiplicative Hashing) from his book The Art Of Computer Programming, Vol. 3, 2nd Edition, Section 6.4, Page 516.
With this library, you can transform your internal id's to obfuscated integers based on Knuth's integer hash. It is similar to Hashids, but will generate integers instead of random strings. It is also super fast.
This library supports both 32 and 64 bits integers, although in Python you don't have that differentiation between int32 and int64, even bigint or bignum is the same since PEP 237. The reason you need a bitlength is that the algorithm itself works on a fixed bitlength. By default this library uses 64 bits.
So far it's only tested on Python 3.8 and Python 3.9
pip install python-optimus
from optimus_ids import Optimus my_optimus = Optimus( prime=<your prime number> ) my_int_id = <some id you have> my_int_id_hashed = my_optimus.encode(my_int_id) assert my_int_id == my_optimus.decode(my_int_id_hashed)
The caveat with the usage above is that every time you create your
Optimus instance it will have a random component, even with using the same prime, so a proper usage should be like this:
from optimus_ids import Optimus my_optimus = Optimus( prime=<your prime number>, random=<some random number> ) my_int_id = <some id you have> my_int_id_hashed = my_optimus.encode(my_int_id) assert my_int_id == my_optimus.decode(my_int_id_hashed)
To generate a suitable random number you could do this:
from optimus_ids import rand_n, MAX_64_INT # use 32 instead of 64 if you want to my_random_number = rand_n(MAX_64_INT - 1)
You can also generate an
Optimus intance and then keep its
random properties stored, so you can always configure a new instance with the same components, or even pickle it:
from optimus_ids import generate, Optimus my_optimus = generate() # store the following variables or pickle the my_optimus variable prime = my_optimus.prime inverse = my_optimus.inverse random = my_optimus.random bitlength = my_optimus.bitlength # create a new instance with the same parameters or unpickle an instance my_other_optimus = Optimus( prime=prime, inverse=inverse, random=random, bitlength=bitlength, ) assert my_optimus.encode(42) == my_other_optimus.encode(42) assert my_optimus.decode(my_other_optimus.encode(42)) == my_other_optimus.decode(my_optimus.encode(42))
NOTE for the generate function to work, it needs data, the data is large, and not available with the package, the data should be downloaded from here and the path to it is passed to the
generate function. By default it expects the data to be in a folder called
optimus-primes in the current working directory.
├── your-app.py ├── ... └── optimus-primes ├── p1.txt ├── p2.txt ├── ... └── p50.txt
Check the tests folder for test cases and other usage examples.
This work is licensed under MIT License.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size python_optimus-1.0.1-py3-none-any.whl (4.4 kB)||File type Wheel||Python version py3||Upload date||Hashes View|
|Filename, size python-optimus-1.0.1.tar.gz (3.8 kB)||File type Source||Python version None||Upload date||Hashes View|
Hashes for python_optimus-1.0.1-py3-none-any.whl