py-utility

Utility functions for managing and monitoring python resources.

installation

pip install py-utility

Documentation

memoryit

memoryit returns the total memory used by the function at runtime in bytes.
Example Code:

from pyutility import memoryit

def prime_check(x):
  for i in range(2, x):
    if x % i == 0:
      return False
  return True
  
if __name__ == "__main__":
  ...
  memoryit(prime_check, args=(89,))
  ...
  
  

limit_memory

limit_memory limits the memory consumption of function at runtime. It takes the limit in MB. You will find unexpected behaviour if too low value is set. The default value is 25 MB. It throws MemoryError if it exceeds the limit.
Example Code:

from pyutility import limit_memory

if __name__ == "__main__":
  ...
  limit_memory(prime_check, memory=30, args=(89,))
  ...
  

timeit

timeit returns the total time take to execute the function in seconds.
Example Code:

from pyutility import timeit

if __name__ == "__main__":
   ...
   timeit(prime_check, args=(89,))
   ...

limit_time

limit_time limits the time used to execute the function. It takes limit as seconds. The default value is 10 seconds. It throws TimeoutError if it exceeds the limit.
Example Code:

from pyutility import limit_time

if __name__ == "__main__":
  ...
  limit_time(prime_check, time=2, args=(89,))
  ...

Contribution

All contributions are welcomed. If it is a bug fix or new feature, creating new issue is highly recommend before any pull request. If you want any new feature to be included create new issue asking for the feature with a use case and example code if possible.