zenutils 0.3.6

Collection of simple utils.

zenutils

Collection of simple utils.

Install

pip install zenutils

Extra packages requires

• For python3.2 and python2.x, requires extra package: inspect2~=0.1.2
• For user who is using xxhash methods with hashutils, requires extra package: xxhash
• For user who is using sm3 methods with hashutils, requires extra package: sm3utils.
• If your python installation's hashlib already support sm3 hash method, you don't have to install sm3utils.
• xxhash and sm3utils are not put into this package's requirements, you need to install them by your self.

Notice

• The hashutils' hash methods are different on different python installations. The list below is based on Python 3.10.6 x86_64 on windows. Mostly md5, sha1, sha224, sha256, sha384, sha512 methods are supported.
• The hashutils' DEFAULT_HASH_METHOD is sm3 and DEFAULT_PASSWORD_HASH_METHOD is ssm3, so if your python installation is not support sm3 hash method, you need to install sm3utils by yourself.

Utils

1. zenutils.base64utils
   1. a85decode
   2. a85encode
   3. b16decode
   4. b16encode
   5. b32decode
   6. b32encode
   7. b32hexdecode
   8. b32hexencode
   9. b64decode
   10. b64encode
   11. b85decode
   12. b85encode
   13. decode
   14. decodebytes
   15. encode
   16. encodebytes
   17. standard_b64decode
   18. standard_b64encode
   19. urlsafe_b64decode
   20. urlsafe_b64encode
2. zenutils.baseutils
   1. Null
3. zenutils.cacheutils
   1. cache
   2. get_cached_value
4. zenutils.cipherutils
   1. Base64Encoder
   2. CipherBase
   3. DecryptFailed
   4. EncoderBase
   5. HexlifyEncoder
   6. IvCipher
   7. IvfCipher
   8. MappingCipher
   9. RawDataEncoder
   10. S12Cipher
   11. S1Cipher
   12. S2Cipher
   13. SafeBase64Encoder
   14. Utf8Encoder
5. zenutils.dictutils
   1. Object
   2. attrgetorset
   3. attrset
   4. change
   5. changes
   6. deep_merge
   7. diff
   8. fix_object
   9. ignore_none_item
   10. prefix_key
   11. select
   12. to_object
   13. touch
   14. update
6. zenutils.fsutils
   1. TemporaryFile
   2. copy
   3. expand
   4. file_content_replace
   5. filecopy
   6. first_exists_file
   7. get_application_config_filepath
   8. get_application_config_paths
   9. get_safe_filename
   10. get_size_deviation
   11. get_size_display
   12. get_swap_filename
   13. get_temp_workspace
   14. get_unit_size
   15. info
   16. mkdir
   17. move
   18. pathjoin
   19. readfile
   20. rename
   21. rm
   22. safe_write
   23. size_unit_names
   24. size_unit_upper_limit
   25. touch
   26. treecopy
   27. write
7. zenutils.funcutils
   1. BunchCallable
   2. call_with_inject
   3. chain
   4. classproperty
   5. get_all_builtin_exceptions
   6. get_builtins_dict
   7. get_class_name
   8. get_default_values
   9. get_inject_params
   10. inspect
   11. is_a_class
   12. isclass
   13. mcall_with_inject
   14. signature
   15. try_again_on_error
8. zenutils.hashutils
   1. Base64ResultEncoder
   2. Blake2BHexlifyPasswordHash
   3. Blake2BPbkdf2PasswordHash
   4. Blake2BPbkdf2PasswordHashColon
   5. Blake2BSimplePasswordHash
   6. Blake2BSimpleSaltPasswordHash
   7. Blake2SHexlifyPasswordHash
   8. Blake2SPbkdf2PasswordHash
   9. Blake2SPbkdf2PasswordHashColon
   10. Blake2SSimplePasswordHash
   11. Blake2SSimpleSaltPasswordHash
   12. DigestResultEncoder
   13. HexlifyPasswordHashBase
   14. HexlifyResultEncoder
   15. Md4HexlifyPasswordHash
   16. Md4Pbkdf2PasswordHash
   17. Md4Pbkdf2PasswordHashColon
   18. Md4SimplePasswordHash
   19. Md4SimpleSaltPasswordHash
   20. Md5HexlifyPasswordHash
   21. Md5Pbkdf2PasswordHash
   22. Md5Pbkdf2PasswordHashColon
   23. Md5SimplePasswordHash
   24. Md5SimpleSaltPasswordHash
   25. Md5_Sha1HexlifyPasswordHash
   26. Md5_Sha1Pbkdf2PasswordHash
   27. Md5_Sha1Pbkdf2PasswordHashColon
   28. Md5_Sha1SimplePasswordHash
   29. Md5_Sha1SimpleSaltPasswordHash
   30. Mdc2HexlifyPasswordHash
   31. Mdc2Pbkdf2PasswordHash
   32. Mdc2Pbkdf2PasswordHashColon
   33. Mdc2SimplePasswordHash
   34. Mdc2SimpleSaltPasswordHash
   35. PasswordHashMethodBase
   36. PasswordHashMethodNotSupportError
   37. Pbkdf2PasswordHashBase
   38. ResultEncoderBase
   39. Ripemd160HexlifyPasswordHash
   40. Ripemd160Pbkdf2PasswordHash
   41. Ripemd160Pbkdf2PasswordHashColon
   42. Ripemd160SimplePasswordHash
   43. Ripemd160SimpleSaltPasswordHash
   44. Sha1HexlifyPasswordHash
   45. Sha1Pbkdf2PasswordHash
   46. Sha1Pbkdf2PasswordHashColon
   47. Sha1SimplePasswordHash
   48. Sha1SimpleSaltPasswordHash
   49. Sha224HexlifyPasswordHash
   50. Sha224Pbkdf2PasswordHash
   51. Sha224Pbkdf2PasswordHashColon
   52. Sha224SimplePasswordHash
   53. Sha224SimpleSaltPasswordHash
   54. Sha256HexlifyPasswordHash
   55. Sha256Pbkdf2PasswordHash
   56. Sha256Pbkdf2PasswordHashColon
   57. Sha256SimplePasswordHash
   58. Sha256SimpleSaltPasswordHash
   59. Sha384HexlifyPasswordHash
   60. Sha384Pbkdf2PasswordHash
   61. Sha384Pbkdf2PasswordHashColon
   62. Sha384SimplePasswordHash
   63. Sha384SimpleSaltPasswordHash
   64. Sha3_224HexlifyPasswordHash
   65. Sha3_224Pbkdf2PasswordHash
   66. Sha3_224Pbkdf2PasswordHashColon
   67. Sha3_224SimplePasswordHash
   68. Sha3_224SimpleSaltPasswordHash
   69. Sha3_256HexlifyPasswordHash
   70. Sha3_256Pbkdf2PasswordHash
   71. Sha3_256Pbkdf2PasswordHashColon
   72. Sha3_256SimplePasswordHash
   73. Sha3_256SimpleSaltPasswordHash
   74. Sha3_384HexlifyPasswordHash
   75. Sha3_384Pbkdf2PasswordHash
   76. Sha3_384Pbkdf2PasswordHashColon
   77. Sha3_384SimplePasswordHash
   78. Sha3_384SimpleSaltPasswordHash
   79. Sha3_512HexlifyPasswordHash
   80. Sha3_512Pbkdf2PasswordHash
   81. Sha3_512Pbkdf2PasswordHashColon
   82. Sha3_512SimplePasswordHash
   83. Sha3_512SimpleSaltPasswordHash
   84. Sha512HexlifyPasswordHash
   85. Sha512Pbkdf2PasswordHash
   86. Sha512Pbkdf2PasswordHashColon
   87. Sha512SimplePasswordHash
   88. Sha512SimpleSaltPasswordHash
   89. Sha512_224HexlifyPasswordHash
   90. Sha512_224Pbkdf2PasswordHash
   91. Sha512_224Pbkdf2PasswordHashColon
   92. Sha512_224SimplePasswordHash
   93. Sha512_224SimpleSaltPasswordHash
   94. Sha512_256HexlifyPasswordHash
   95. Sha512_256Pbkdf2PasswordHash
   96. Sha512_256Pbkdf2PasswordHashColon
   97. Sha512_256SimplePasswordHash
   98. Sha512_256SimpleSaltPasswordHash
   99. ShaHexlifyPasswordHash
   100. ShaPbkdf2PasswordHash
   101. ShaPbkdf2PasswordHashColon
   102. ShaSimplePasswordHash
   103. ShaSimpleSaltPasswordHash
   104. SimplePasswordHashBase
   105. SimpleSaltPasswordHashBase
   106. Sm3HexlifyPasswordHash
   107. Sm3Pbkdf2PasswordHash
   108. Sm3Pbkdf2PasswordHashColon
   109. Sm3SimplePasswordHash
   110. Sm3SimpleSaltPasswordHash
   111. WhirlpoolHexlifyPasswordHash
   112. WhirlpoolPbkdf2PasswordHash
   113. WhirlpoolPbkdf2PasswordHashColon
   114. WhirlpoolSimplePasswordHash
   115. WhirlpoolSimpleSaltPasswordHash
   116. Xxh128HexlifyPasswordHash
   117. Xxh128Pbkdf2PasswordHash
   118. Xxh128Pbkdf2PasswordHashColon
   119. Xxh128SimplePasswordHash
   120. Xxh128SimpleSaltPasswordHash
   121. Xxh32HexlifyPasswordHash
   122. Xxh32Pbkdf2PasswordHash
   123. Xxh32Pbkdf2PasswordHashColon
   124. Xxh32SimplePasswordHash
   125. Xxh32SimpleSaltPasswordHash
   126. Xxh64HexlifyPasswordHash
   127. Xxh64Pbkdf2PasswordHash
   128. Xxh64Pbkdf2PasswordHashColon
   129. Xxh64SimplePasswordHash
   130. Xxh64SimpleSaltPasswordHash
   131. algorithms_available
   132. get_blake2b
   133. get_blake2b_base64
   134. get_blake2b_digest
   135. get_blake2b_hexdigest
   136. get_blake2s
   137. get_blake2s_base64
   138. get_blake2s_digest
   139. get_blake2s_hexdigest
   140. get_file_blake2b
   141. get_file_blake2b_base64
   142. get_file_blake2b_digest
   143. get_file_blake2b_hexdigest
   144. get_file_blake2s
   145. get_file_blake2s_base64
   146. get_file_blake2s_digest
   147. get_file_blake2s_hexdigest
   148. get_file_hash
   149. get_file_hash_base64
   150. get_file_hash_hexdigest
   151. get_file_hash_result
   152. get_file_md4
   153. get_file_md4_base64
   154. get_file_md4_digest
   155. get_file_md4_hexdigest
   156. get_file_md5
   157. get_file_md5_base64
   158. get_file_md5_digest
   159. get_file_md5_hexdigest
   160. get_file_md5_sha1
   161. get_file_md5_sha1_base64
   162. get_file_md5_sha1_digest
   163. get_file_md5_sha1_hexdigest
   164. get_file_mdc2
   165. get_file_mdc2_base64
   166. get_file_mdc2_digest
   167. get_file_mdc2_hexdigest
   168. get_file_ripemd160
   169. get_file_ripemd160_base64
   170. get_file_ripemd160_digest
   171. get_file_ripemd160_hexdigest
   172. get_file_sha
   173. get_file_sha1
   174. get_file_sha1_base64
   175. get_file_sha1_digest
   176. get_file_sha1_hexdigest
   177. get_file_sha224
   178. get_file_sha224_base64
   179. get_file_sha224_digest
   180. get_file_sha224_hexdigest
   181. get_file_sha256
   182. get_file_sha256_base64
   183. get_file_sha256_digest
   184. get_file_sha256_hexdigest
   185. get_file_sha384
   186. get_file_sha384_base64
   187. get_file_sha384_digest
   188. get_file_sha384_hexdigest
   189. get_file_sha3_224
   190. get_file_sha3_224_base64
   191. get_file_sha3_224_digest
   192. get_file_sha3_224_hexdigest
   193. get_file_sha3_256
   194. get_file_sha3_256_base64
   195. get_file_sha3_256_digest
   196. get_file_sha3_256_hexdigest
   197. get_file_sha3_384
   198. get_file_sha3_384_base64
   199. get_file_sha3_384_digest
   200. get_file_sha3_384_hexdigest
   201. get_file_sha3_512
   202. get_file_sha3_512_base64
   203. get_file_sha3_512_digest
   204. get_file_sha3_512_hexdigest
   205. get_file_sha512
   206. get_file_sha512_224
   207. get_file_sha512_224_base64
   208. get_file_sha512_224_digest
   209. get_file_sha512_224_hexdigest
   210. get_file_sha512_256
   211. get_file_sha512_256_base64
   212. get_file_sha512_256_digest
   213. get_file_sha512_256_hexdigest
   214. get_file_sha512_base64
   215. get_file_sha512_digest
   216. get_file_sha512_hexdigest
   217. get_file_sha_base64
   218. get_file_sha_digest
   219. get_file_sha_hexdigest
   220. get_file_sm3
   221. get_file_sm3_base64
   222. get_file_sm3_digest
   223. get_file_sm3_hexdigest
   224. get_file_whirlpool
   225. get_file_whirlpool_base64
   226. get_file_whirlpool_digest
   227. get_file_whirlpool_hexdigest
   228. get_file_xxh128
   229. get_file_xxh128_base64
   230. get_file_xxh128_digest
   231. get_file_xxh128_hexdigest
   232. get_file_xxh32
   233. get_file_xxh32_base64
   234. get_file_xxh32_digest
   235. get_file_xxh32_hexdigest
   236. get_file_xxh64
   237. get_file_xxh64_base64
   238. get_file_xxh64_digest
   239. get_file_xxh64_hexdigest
   240. get_hash
   241. get_hash_base64
   242. get_hash_hexdigest
   243. get_hash_result
   244. get_md4
   245. get_md4_base64
   246. get_md4_digest
   247. get_md4_hexdigest
   248. get_md5
   249. get_md5_base64
   250. get_md5_digest
   251. get_md5_hexdigest
   252. get_md5_sha1
   253. get_md5_sha1_base64
   254. get_md5_sha1_digest
   255. get_md5_sha1_hexdigest
   256. get_mdc2
   257. get_mdc2_base64
   258. get_mdc2_digest
   259. get_mdc2_hexdigest
   260. get_password_hash
   261. get_password_hash_methods
   262. get_pbkdf2_blake2b
   263. get_pbkdf2_blake2s
   264. get_pbkdf2_hmac
   265. get_pbkdf2_md4
   266. get_pbkdf2_md5
   267. get_pbkdf2_md5_sha1
   268. get_pbkdf2_mdc2
   269. get_pbkdf2_ripemd160
   270. get_pbkdf2_sha
   271. get_pbkdf2_sha1
   272. get_pbkdf2_sha224
   273. get_pbkdf2_sha256
   274. get_pbkdf2_sha384
   275. get_pbkdf2_sha3_224
   276. get_pbkdf2_sha3_256
   277. get_pbkdf2_sha3_384
   278. get_pbkdf2_sha3_512
   279. get_pbkdf2_sha512
   280. get_pbkdf2_sha512_224
   281. get_pbkdf2_sha512_256
   282. get_pbkdf2_sm3
   283. get_pbkdf2_whirlpool
   284. get_pbkdf2_xxh128
   285. get_pbkdf2_xxh32
   286. get_pbkdf2_xxh64
   287. get_ripemd160
   288. get_ripemd160_base64
   289. get_ripemd160_digest
   290. get_ripemd160_hexdigest
   291. get_salted_hash_base64
   292. get_sha
   293. get_sha1
   294. get_sha1_base64
   295. get_sha1_digest
   296. get_sha1_hexdigest
   297. get_sha224
   298. get_sha224_base64
   299. get_sha224_digest
   300. get_sha224_hexdigest
   301. get_sha256
   302. get_sha256_base64
   303. get_sha256_digest
   304. get_sha256_hexdigest
   305. get_sha384
   306. get_sha384_base64
   307. get_sha384_digest
   308. get_sha384_hexdigest
   309. get_sha3_224
   310. get_sha3_224_base64
   311. get_sha3_224_digest
   312. get_sha3_224_hexdigest
   313. get_sha3_256
   314. get_sha3_256_base64
   315. get_sha3_256_digest
   316. get_sha3_256_hexdigest
   317. get_sha3_384
   318. get_sha3_384_base64
   319. get_sha3_384_digest
   320. get_sha3_384_hexdigest
   321. get_sha3_512
   322. get_sha3_512_base64
   323. get_sha3_512_digest
   324. get_sha3_512_hexdigest
   325. get_sha512
   326. get_sha512_224
   327. get_sha512_224_base64
   328. get_sha512_224_digest
   329. get_sha512_224_hexdigest
   330. get_sha512_256
   331. get_sha512_256_base64
   332. get_sha512_256_digest
   333. get_sha512_256_hexdigest
   334. get_sha512_base64
   335. get_sha512_digest
   336. get_sha512_hexdigest
   337. get_sha_base64
   338. get_sha_digest
   339. get_sha_hexdigest
   340. get_sm3
   341. get_sm3_base64
   342. get_sm3_digest
   343. get_sm3_hexdigest
   344. get_whirlpool
   345. get_whirlpool_base64
   346. get_whirlpool_digest
   347. get_whirlpool_hexdigest
   348. get_xxh128
   349. get_xxh128_base64
   350. get_xxh128_digest
   351. get_xxh128_hexdigest
   352. get_xxh32
   353. get_xxh32_base64
   354. get_xxh32_digest
   355. get_xxh32_hexdigest
   356. get_xxh64
   357. get_xxh64_base64
   358. get_xxh64_digest
   359. get_xxh64_hexdigest
   360. is_the_same_hash_method
   361. method_load
   362. new
   363. pbkdf2_hmac
   364. register_hexlify_password_hash
   365. register_password_hash_method
   366. register_pbkdf2_password_hash
   367. register_simple_password_hash
   368. register_simple_salt_password_hash
   369. setup_hash_method_loader
   370. validate_password_hash
   371. validate_pbkdf2_blake2b
   372. validate_pbkdf2_blake2s
   373. validate_pbkdf2_hmac
   374. validate_pbkdf2_md4
   375. validate_pbkdf2_md5
   376. validate_pbkdf2_md5_sha1
   377. validate_pbkdf2_mdc2
   378. validate_pbkdf2_ripemd160
   379. validate_pbkdf2_sha
   380. validate_pbkdf2_sha1
   381. validate_pbkdf2_sha224
   382. validate_pbkdf2_sha256
   383. validate_pbkdf2_sha384
   384. validate_pbkdf2_sha3_224
   385. validate_pbkdf2_sha3_256
   386. validate_pbkdf2_sha3_384
   387. validate_pbkdf2_sha3_512
   388. validate_pbkdf2_sha512
   389. validate_pbkdf2_sha512_224
   390. validate_pbkdf2_sha512_256
   391. validate_pbkdf2_sm3
   392. validate_pbkdf2_whirlpool
   393. validate_pbkdf2_xxh128
   394. validate_pbkdf2_xxh32
   395. validate_pbkdf2_xxh64
9. zenutils.httputils
   1. download
   2. get_sitename
   3. get_url_filename
   4. get_url_save_path
   5. get_urlinfo
   6. urlparse
10. zenutils.jsonutils
    1. SimpleJsonEncoder
    2. make_simple_json_encoder
    3. register_global_encoder
    4. simple_json_dumps
11. zenutils.listutils
    1. append_new
    2. chunk
    3. clean_none
    4. compare
    5. compare_execute
    6. first
    7. group
    8. ignore_none_element
    9. int_list_to_bytes
    10. is_ordered
    11. list2dict
    12. pad
    13. replace
    14. topological_sort
    15. topological_test
    16. unique
12. zenutils.logutils
    1. get_console_handler
    2. get_file_handler
    3. get_simple_config
    4. setup
13. zenutils.nameutils
    1. get_last_names
    2. get_random_name
    3. get_suggest_first_names
    4. guess_lastname
    5. guess_surname
14. zenutils.numericutils
    1. _infinity
    2. binary_decompose
    3. bytes2ints
    4. decimal_change_base
    5. float_split
    6. from_bytes
    7. get_float_part
    8. infinity
    9. int2bytes
    10. ints2bytes
    11. is_infinity
    12. ninfinity
    13. pinfinity
15. zenutils.randomutils
    1. Random
    2. UuidGenerator
    3. choices
    4. uuid1
    5. uuid3
    6. uuid4
    7. uuid5
16. zenutils.sixutils
    1. BASESTRING_TYPES
    2. BYTES
    3. BYTES_TYPE
    4. INT_TO_BYTES
    5. NUMERIC_TYPES
    6. PY2
    7. PY3
    8. STR_TYPE
    9. TEXT
    10. bchar
    11. bstr_to_array
    12. bytes_to_array
    13. create_new_class
    14. default_encoding
    15. default_encodings
    16. force_bytes
    17. force_text
17. zenutils.strutils
    1. BAI
    2. BASE64_CHARS
    3. HEXLIFY_CHARS
    4. QIAN
    5. SHI
    6. URLSAFEB64_CHARS
    7. WAN
    8. YI
    9. binarify
    10. bytes2ints
    11. camel
    12. captital_number
    13. char_force_to_int
    14. chunk
    15. clean
    16. combinations
    17. combinations2
    18. decodable
    19. default_cn_digits
    20. default_cn_float_places
    21. default_cn_negative
    22. default_cn_places
    23. default_cn_yuan
    24. default_encoding
    25. default_encodings
    26. default_quotes
    27. default_random_string_choices
    28. do_clean
    29. encodable
    30. force_float
    31. force_int
    32. force_numberic
    33. force_type_to
    34. format_with_mapping
    35. get_all_substrings
    36. get_base64image
    37. get_image_bytes
    38. html_element_css_append
    39. int2bytes
    40. ints2bytes
    41. is_base64_decodable
    42. is_chinese_character
    43. is_hex_digits
    44. is_str_composed_by_the_choices
    45. is_unhexlifiable
    46. is_urlsafeb64_decodable
    47. is_uuid
    48. join_lines
    49. no_mapping
    50. none_to_empty_string
    51. parse_base64image
    52. random_string
    53. remove_prefix
    54. remove_suffix
    55. reverse
    56. simplesplit
    57. smart_get_binary_data
    58. split
    59. split2
    60. str_composed_by
    61. stringlist_append
    62. strip_string
    63. substrings
    64. text_display_length
    65. text_display_shorten
    66. unbinarify
    67. unquote
    68. wholestrip
18. zenutils.sysutils
    1. default_timeout_kill
    2. execute_script
    3. get_current_thread_id
    4. get_node_ip
    5. get_random_script_name
    6. get_worker_id
    7. psutil_timeout_kill
19. zenutils.threadutils
    1. Counter
    2. LoopIdle
    3. Service
    4. ServiceStop
    5. ServiceTerminate
    6. SimpleConsumer
    7. SimpleProducer
    8. SimpleProducerConsumerServer
    9. SimpleServer
    10. StartOnTerminatedService
20. zenutils.treeutils
    1. SimpleRouterTree
    2. build_tree
    3. print_tree
    4. print_tree_callback
    5. tree_walk
21. zenutils.typingutils
    1. Number
    2. STRING_ENCODINGS
    3. register_global_caster
    4. smart_cast

Compatibility

Test passed with python versions:

1. Python 2.7 passed
2. Python 3.2 passed
3. Python 3.3 passed
4. Python 3.4 passed
5. Python 3.5 passed
6. Python 3.7 passed
7. Python 3.8 passed
8. Python 3.9 passed
9. Python 3.10 passed

Release

v0.1.0

• First release.

v0.2.0

• Add treeutils.SimpleRouterTree.
• Add randomutils.HashPrng.
• Add hashutils.get_password_hash and hashutils.validate_password_hash.
• Add dictutils.HttpHeadersDict.
• Add sysutils.get_node_ip.

v0.3.1

• Add funcutils.retry.
• Fix hashutils.validate_password_hash problem.

v0.3.2

• Add sm3 hash support in hashutils.
• Add xxhash hash support in hashutils.
• Export hashutils.pbkdf2_hmac to work with your self defined hash methods.
• Fix problem in sysutils.get_random_script_name on windows.
• Fix path string problem in tests.test_httputils on windows.

v0.3.3

• Fix funcutils.isclass can not detect classes with metaclass. Use inspect.isclass instead.
• Add cacheutils.cache.

v0.3.5

• Change default log file path from pwd/app.log to pwd/logs/app.log.
• Add fsutils.get_swap_filename.
• Add fsutils.safe_write.
• Add fsutils.get_safe_filename.

v0.3.6

• Add sixutils.create_new_class.
• Fix hashutils problem in python3.3 and below.
• Extend numericutils.int2bytes as int.to_bytes.