Module `meerschaum.utils`

The utils module contains utility functions. These include tools from primary utilities (get_pipes) to miscellaneous helper functions.

Expand source code

#! /usr/bin/env python
# -*- coding: utf-8 -*-
# vim:fenc=utf-8

"""
The utils module contains utility functions.
These include tools from primary utilities (get_pipes)
to miscellaneous helper functions.
"""

### import_children will be depreciated in a future release.
### Explicit is better than implicit (mostly).

# from meerschaum.utils.packages import import_children
# import_children()

from meerschaum.utils.get_pipes import get_pipes

Sub-modules

meerschaum.utils.daemon: Daemonize processes via daemoniker.
meerschaum.utils.debug: Functions to handle debug statements
meerschaum.utils.formatting: Utilities for formatting output text
meerschaum.utils.get_pipes: Return a dictionary (or list) of pipe objects. See documentation below for more information.
meerschaum.utils.interactive: Interactive "wizards" to guide the user.
meerschaum.utils.misc: Miscellaneous functions go here
meerschaum.utils.networking: Utility functions pertaining to network functionality (e.g. available ports).
meerschaum.utils.packages: Functions for managing packages and virtual environments reside here.
meerschaum.utils.pool: Global pools that are joined on exit.
meerschaum.utils.process: Custom process-handling functions. See meerschaum.utils.pool for multiprocessing and meerschaum.utils.threading for threads.
meerschaum.utils.prompt: Functions for interacting with the user.
meerschaum.utils.schedule: Schedule processes and threads.
meerschaum.utils.sql: Flavor-specific SQL tools.
meerschaum.utils.threading: Define a custom Thread class with a callback method.
meerschaum.utils.typing
meerschaum.utils.venv: Manage virtual environments.
meerschaum.utils.warnings: Handle all things warnings and errors here
meerschaum.utils.yaml: Meerschaum wrapper around YAML libraries …