Skip to main content

Stop letting heavy packages block down your scripts!

Project description

Release status PyPI package Supported Python versions Test Coverage Status Pypi downloads Pypi downloads Code style: black

comberload

I have recently built some little command line utility. It simply receives a command, parses the command and evaluates it with syntax coloring and autocompletion from prompt_toolkit. But there was an issue, prompt_toolkit loaded extremely, I was wasting alot time to load a package which was not indispensable to my app.

Comberloads, since comberload 1.0.2, were added two more methods to comberloader, failback and fail

comberload permits you to register modules for queued loading and callbacks if they are not loaded yet, howaworks?

a simple example for a function which uses prompt_toolkit.prompt but can fallback to simple input

fallback

import comberload

@comberload("prompt_toolkit")
def get_input():
    import prompt_toolkit

    return prompt_toolkit.prompt()

@get_input.fallback
def fallback_get_input():
    return input()

get_input()  # immediately uses fallback

get_input()  # abit later, uses prompt_toolkit

comberload uses a worker function running on a seperate thread to load the modules as listed in the queue. Each time you call on comberload("module1", "module2") the modules are queued and loaded.

multiple fallbacks

You can easily queue fallbacks as:

import comberload


comberload("mod1", "mod2")
def first():
    pass

@first.fallback
@comberload("mod3")
def second():
    pass

@second.fallback
def third():
    pass

fail

Use this handler in case the module fails to import

import comberload


comberload("mod1", "mod2")
def first():
    pass

@first.fail
def second():
    print(first.error)

failback

This is what I advice to use, it uses the default handler in case the module is not loaded due to error or any else.

import comberload


comberload("mod1", "mod2")
def first():
    pass

@first.failback
def second():
    pass

callbacks

comberload also permits you to register callbacks when some modules finish loading as

import comberload

@comberload("mod", "mod2").fallback
def mod_and_mod2_loaded():
    pass

best practice

Only what necessary

I will advice to load only what is necessary taking such an approach

Loading in beginning

What I will advice is to queue all the required import at the begining of each of your modules to permit all of them load without having to fallback.

... # imports
import comberload

comberload("all", "my", "modules")

... # rest of code

Well, you're all set. Listening for issues at https://github.com/ken-morel/comberload , till then, good coding!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

comberload-1.1.3.tar.gz (5.8 kB view hashes)

Uploaded Source

Built Distribution

comberload-1.1.3-py3-none-any.whl (5.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page