add optionvars

[davidlatwe]

Feature propose

Add rezconfig.optionvars to store arbitrary key-value data and retrieve them in package.

# rezconfig.py
optionvars = {
    "hello": "world"
}

# package.py
name = "foo"
def commands():
    print(optionvars("hello"))

> rez-env foo
world

Use case

I currently would use this feature to setup local payload path for package development across developer machines.

# package.py
name = "foo"
def commands():
    if intersects(ephemerals.get("dev.foo", "dev.foo-0"), "1"):
        env.PYTHONPATH.append(optionvars("foo_dev_src"))
    else:
        env.PYTHONPATH.append("{root}/payload")

I know my use case could have many alternatives, but I thought this would be the most convenient approach with ephemeral packages and rezconfig involved.

What do you think ?

[davidlatwe]

Just to be more clearer.

The main idea of this feature, is like adding user preferences on package or the value of corresponding ephemeral, which may not easy to define in package's definition file due to the differences between machines/users/pipeline-roles.

Although we can define those as environment variables in a shell launching script, but I think it would be better if those can be managed by rezconfig, and traced with rez-config command. In result, the startup environment can be simplified.

[nerdvegas]

What if we were just to expose the config object instead? I like this idea as it may be helpful to expose other exisitng config settings; but also a studio isn't forced to use a specific optionvars key and could instead choose their own.

[davidlatwe]

Thanks !!

isn't forced to use a specific optionvars key and could instead choose their own.

Not sure I understand this, do you mean that one could pick their own name instead of "optionvars" ?
If so, I think we cannot do this actually, rezconfig only accept key that is in it's schema.

[nerdvegas]

Ah yes - I was thinking about package definitions, not the config. Ok, I think this is fine. A

…

On Tue, Mar 9, 2021 at 11:59 AM David Lai ***@***.***> wrote: Thanks !! isn't forced to use a specific optionvars key and could instead choose their own. Not sure I understand this, do you mean that one could pick their own name instead of "optionvars" ? If so, I think we cannot do this actually, rezconfig only accept key that is in it's schema. — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#1036 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAMOUSTNZECFQ4YAEDS73MLTCVXGZANCNFSM4YVSMVKA> .

[davidlatwe]

Great, thanks !
Will start updating Wiki doc for this.

[nerdvegas]

Note that when updating the wiki, you need a section in https://github.com/nerdvegas/rez/wiki/Package-Commands#objects. In this case I think it'd be fine for that to be very brief and link to the optionvars section in Configuring-Rez. Something like

### optionvars
*Function*

Arbitrary data from the rez config, that can be accessed by packages. See the [config setting](...) for more details.

[davidlatwe]

Thanks for the hints @nerdvegas.
Wiki updated. :)

[davidlatwe]

Just checking, is this able to be merged ?

[nerdvegas]

It's on my list yes. I can probably get to it next week. A

…

On Wed, Mar 24, 2021 at 8:35 PM David Lai ***@***.***> wrote: Just checking, is this able to be merged ? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#1036 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAMOUSRVXP45GA2VJXLS73TTFGW5LANCNFSM4YVSMVKA> .