Skip to content

A Python utility package. Provides various utility functions for TCR Projects

License

Notifications You must be signed in to change notification settings

anamoyee/TCRUtils

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

483 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TCRUtils - yet another utilities package

TCRUtils is a collection of utility functions, classes, and helpers designed to streamline various tasks in projects. Below is a brief overview of some of the key features.

Featured Features (yipee :3)

  • fmt_iterable(x: LITERALLY_ANY_OBJECT_TYPE): Pretty-formats any python object that i have thought of for easier readability, even some third-party-library ones.
  • console, or just tcr.c: Provides hikari-styled logging combined with the above fmt_iterable to pretty-print your debugging! Yay!
  • timestr2: Convert between seconds and readable timestrs. Now with timezones! for example "1h" -> 3600.
  • ShelveDB & sdb2: Quickly and easily set up a dict-based, python built-in shelve module's shelf - a python dictionary able to contain arbitrary python types that persists on restart.

Iterable Helpers

  • Or: Returns the first element of the tuple (arg, *args) that does not equal the supplied (none) variable, by default None. This is different from just doing x or y or y because it does not fail on falsey values, just the ones that are specified to be equal to the noney value
  • batched: py3.12 itertools.batched() in py3.11 with some extra features!
  • cut_at: Cut a string (or an iterable) with a specified suffix for example i'm running out of space on this markdown line so i will use th...
  • shuffled: Returns a shuffled version of an iterable. So you dont have to do random.shuffle(x) which does not return the shuffled

String and Formatting Utilities

  • commafy: Adds commas to numbers for better readability.
  • apostrophe_s: Handles the correct placement of apostrophes if the word ends with s for example "peoples'" and "mike's" (not "peoples's").

Error Handling

  • extract_error and extract_traceback: Extracts the error object's name and the error message (or the traceback's contents).

Decorators

  • @test: Prints a nice block separator containing formatted name of the function before executing
  • @timeit: Measures the execution time of a function and prints it afterwards.

Miscellaneous

  • insist: Prompts user input with a customizable insistence until a valid answer is provided, for example you can keep input()ing the user if they provided invalid value for an integer field.

This package includes many other useful utilities, go look for yourself if you want...

About

A Python utility package. Provides various utility functions for TCR Projects

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages