Skip to content

Modules🔗

Overview🔗

These are the modules used in this package:

Module Description
Classes The classes module is designed for functions to be executed on classes; not within classes.
For any methods/functions that should be added to classes, you should consider re-designing the original class, or sub-classing it to make further alterations.
Bools The bools module is used how to manipulate and enhance Python booleans.
Primarily, this module is used to store the strtobool() function, which used to be found in the distutils.util module, until it was deprecated. As mentioned in PEP632, we should re-implement this function in our own code. And that's what we've done here.
Lists The lists module is used how to manipulate and enhance Python lists.
Note that functions in this module will only take-in and manipulate existing list objects, and also output list objects. It will not sub-class the base list object, or create new 'list-like' objects. It will always remain pure python types at it's core.
Strings The strings module is for manipulating and checking certain string objects.
Dictionaries The dictionaries module is used how to manipulate and enhance Python dictionaries.
Note that functions in this module will only take-in and manipulate existing dict objects, and also output dict objects. It will not sub-class the base dict object, or create new 'dict-like' objects. It will always remain pure python types at it's core.
Checkers Check certain values against other objects.
Output The output module is for streamlining how data is outputted.
This includes print()'ing to the terminal and log()'ing to files.
Retry The retry module is for enabling automatic retrying of a given function when a specific Exception is thrown.
Defaults The defaults module is used how to set and control default values for our various Python processes.

Testing🔗

This package is fully tested against:

  1. Unit tests
  2. Lint tests
  3. MyPy tests
  4. Build tests

Tests are run in matrix against:

  1. Python Versions:
    1. 3.8
    2. 3.9
    3. 3.10
    4. 3.11
    5. 3.12
    6. 3.13
  2. Operatign Systems:
    1. ubuntu-latest
    2. windows-latest
    3. macos-latest

Coverage🔗