Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make the environment section of the config mandatory #1083

Open
doug-walker opened this issue Aug 1, 2020 · 0 comments
Open

Make the environment section of the config mandatory #1083

doug-walker opened this issue Aug 1, 2020 · 0 comments
Labels
Feature Request New addition to OCIO functionality. Needs Discussion Needs discussion before implmentation, which could result in changes, or a decision not to proceed.

Comments

@doug-walker
Copy link
Collaborator

doug-walker commented Aug 1, 2020

In PR #322 (and discussed in Issue #149), Malcolm Humphreys implemented a nice feature that adds an optional environment section at the top of a config file to declare the context variables used in the config. This serves several purposes:

  1. It allows the config author to specify default values
  2. It makes the config easier to understand since one may see at a glance which context vars are used
  3. It makes it easy for OCIO to only load the necessary environment variables into the Context object
  4. It allows additional validation options.

Point 3 has performance implications. In sophisticated studio setups, there may be 100 or more variables in the environment (with the vast majority not being used by the config). Nevertheless, if the environment section is not present, OCIO currently loads all of these into the Context object and this slows down the generation of the cacheIDs. The slowdown may be significant for timeline-based applications that need to update the context rapidly.

Given the many benefits, we propose making the environment section mandatory for OCIO v2.

When this was proposed at a recent OCIO v2 working group meeting, there were people both for and against the proposal, so I'm creating this issue to get feedback from a wider audience.

@carolalynn carolalynn removed the v2.0 label Feb 7, 2024
@carolalynn carolalynn added Feature Request New addition to OCIO functionality. Needs Discussion Needs discussion before implmentation, which could result in changes, or a decision not to proceed. labels Apr 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature Request New addition to OCIO functionality. Needs Discussion Needs discussion before implmentation, which could result in changes, or a decision not to proceed.
Projects
None yet
Development

No branches or pull requests

2 participants