Support @include directives in QSS templates - #14101
Open
kaamyashinde wants to merge 2 commits into
Open
Conversation
kaamyashinde
marked this pull request as draft
August 5, 2026 11:03
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## implement-basis-for-new-styling #14101 +/- ##
================================================================
Coverage 91.93% 91.93%
================================================================
Files 483 483
Lines 33505 33525 +20
================================================================
+ Hits 30802 30822 +20
Misses 2703 2703
Flags with carried forward coverage won't be shown. Click here to find out more.
|
kaamyashinde
force-pushed
the
qss-include-directive
branch
from
August 5, 2026 11:17
369c272 to
0cbf763
Compare
kaamyashinde
force-pushed
the
qss-include-directive
branch
from
August 5, 2026 11:45
0cbf763 to
c3b669d
Compare
kaamyashinde
force-pushed
the
qss-include-directive
branch
from
August 5, 2026 13:27
c3b669d to
ec20c7f
Compare
kaamyashinde
force-pushed
the
qss-include-directive
branch
from
August 5, 2026 13:29
ec20c7f to
8abd255
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Adds support for @include "…" directives in QSS template processing so GUI styling can be split across multiple .qss.in files while still using design-token substitution.
Changes:
- Introduce
resolve_includes()to expand@include "file.qss.in"directives (including nested includes) and detect circular references. - Update
process_qss()to resolve includes before token substitution. - Move/extend unit tests to cover include resolution behavior and keep resource-reading tests centralized.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
src/ert/gui/theme_manager/qss_processing.py |
Adds include-resolution pre-pass and integrates it into QSS processing. |
tests/ert/unit_tests/gui/theme_manager/test_qss_processing.py |
Adds unit tests for include resolution (multiple, nested, circular, missing). |
tests/ert/unit_tests/gui/theme_manager/test_theme_utils.py |
Relocates and keeps tests for read_qss_stylesheet_file() behavior. |
Comment on lines
8
to
11
| _TOKEN_PATTERN = re.compile(r"\{\{([a-z0-9\-]+)\}\}") | ||
| _INCLUDE_PATTERN = re.compile(r'^@include\s+"(.+?)"', re.MULTILINE) | ||
|
|
||
| _BASE_TEMPLATE = "base" |
kaamyashinde
force-pushed
the
qss-include-directive
branch
from
August 6, 2026 07:09
8abd255 to
75e7ef8
Compare
kaamyashinde
force-pushed
the
qss-include-directive
branch
from
August 6, 2026 07:42
75e7ef8 to
0b4c9f6
Compare
kaamyashinde
force-pushed
the
qss-include-directive
branch
from
August 6, 2026 08:34
0b4c9f6 to
32a599e
Compare
Collaborator
|
Screenshots differ from baselines. A baseline update PR has been prepared: equinor/ert-testdata#80 |
ertomatic
pushed a commit
to equinor/ert-testdata
that referenced
this pull request
Aug 6, 2026
Allow a .qss.in template to pull in another with @include "nav.qss.in", so styling can be split per GUI area instead of living in one file. Includes are resolved before token substitution, so included files use {{token}} placeholders exactly like the base template. Includes may nest; circular references raise QssProcessingError instead of recursing until the stack is exhausted.
read_qss_stylesheet_file only names a resource and delegates to read_theming_resource, so its tests belong with the other resource loader tests rather than among the template processing ones.
kaamyashinde
force-pushed
the
qss-include-directive
branch
from
August 6, 2026 11:11
32a599e to
da0b629
Compare
Collaborator
|
Screenshot tests now pass. The baseline update PR equinor/ert-testdata#80 has been closed. |
kaamyashinde
marked this pull request as ready for review
August 6, 2026 11:44
eilskra
reviewed
Aug 6, 2026
Comment on lines
+30
to
+36
| for match in _INCLUDE_LIKE_PATTERN.finditer(template): | ||
| line = match.group(0) | ||
| if not _INCLUDE_PATTERN.fullmatch(line): | ||
| raise QssProcessingError( | ||
| f"Malformed @include directive: {line.strip()}. " | ||
| 'Expected the form: @include "name.qss.in"' | ||
| ) |
Contributor
There was a problem hiding this comment.
Do we need to separate the two pattern checks? What happens if we just use _INCLUDE_PATTERN from the start?
Contributor
There was a problem hiding this comment.
What are the pros/cons of having multiple .qss.in? Do we have enough components to that we need the added complexity of having between-qss communication?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issue
Resolves #14103
Approach
Stacked on #14100 so that needs to be reviewed first.
base.qss.inholds styling for the whole GUI, which won't scale. Adds@include "nav.qss.in"so stylesheets can be split per GUI area. Includes are resolved before token substitution, so included files use{{token}}like the base template.Includes may nest; circular references raise
QssProcessingErrorinstead of recursing until the stack is exhausted.No visual change,
base.qss.inuses no includes yet, so the rendered stylesheet is unchanged.git rebase -i main --exec 'just rapid-tests')When applicable
merge screenshot-PR in ert-testdata before merging this PR.