util: basic config manager

[hsirkar]

Usage:

import pipit as pp

pp.set_option("notebook_url", "https://localhost:8080")
pp.reset_option("notebook_url")

pp.get_option("log_level")

[ocnkr]

This looks good for a basic config manager. Here is a draft implementation in Hatchet: https://github.com/hatchet/hatchet/pull/511/files. It's similar to Pandas set_options. registered_options stores the default settings and global_config stores the current settings. The get_option, set_option, and reset_option functions are straightforward. There are also some validators to check if the given inputs are correct but I think the validator implementation has not finished yet.

[hsirkar]

Done

[ocnkr]

We should add reset_option

[ocnkr]

Is there a function in which we might want to use global config? For example, in Hatchet we have the tree function that prints the CCT. One of the parameters it takes is colormap. We want to change colormap globally using set_option. Do we have a function like this in Pipit? If yes, can we add a test that it works?

[hsirkar]

There is a set_option function that is exposed to users. I'm not sure if this is what you mean.

[hsirkar]

In Hatchet, if we specify a colormap parameter for the tree function, does it set the colormap globally? Or just once, for that specific tree?

[ocnkr]

No, it just changes the colormap for that call. If we want to change it globally, we have to use set_option.

[hsirkar]

That makes sense, we should be able to do the same in Pipit for timeline, etc.

[ocnkr]

Yes, I was asking if we could add a test for something like that.

[hsirkar]

If I understand what you're getting at, the timeline function would say something like:

def timeline( ..., colormap = None):
    ...
    if colormap = None:
        colormap = pp.get_config("colormap")
    ...

We currently have tests for pp.get_config. I think a specific test for the code above would be in the timeline test? Please correct me if I'm misunderstanding anything.

[ocnkr]

Hmm, I think that makes sense. Let's discuss this with @bhatele later.