refactor(render_params): RenderParams base class for the 5 *RenderParams - #720

Merged
timtreis merged 1 commit into
mainfrom
refactor/issue-700-renderparams-ir
Jun 14, 2026
Merged

refactor(render_params): RenderParams base class for the 5 *RenderParams#720
timtreis merged 1 commit into
mainfrom
refactor/issue-700-renderparams-ir

Conversation

@timtreis

@timtreistimtreis commented Jun 14, 2026

Copy link
Copy Markdown
Member

Step 1 of #700 — the low-risk, internal-only piece of the RenderParams→IR architecture epic. The IR phases (Steps 2+) remain a discussion pending maintainer sign-off and are not in this PR.

What & why

The five *RenderParams dataclasses each redeclared the four fields that are universal with identical type+default: element, zorder, colorbar, colorbar_params. This hoists them into a @dataclass(kw_only=True) class RenderParams; the five become thin (RenderParams) subclasses carrying only their renderer-specific fields.

Only these four are genuinely universal. cmap_params exists on all five but with three different types (CmapParams / list[CmapParams] | CmapParams / CmapParams | None), and the color/groups/table_name/col_for_color/table_layer cluster is not shared by all renderers (Image lacks the color cluster; Graph lacks col_for_color/table_layer) — so those stay on the subclasses rather than being forced into the base with inert/over-wide fields.

…rParams (#700)
Step 1 of the #700 architecture epic (the low-risk, internal-only piece).
The five *RenderParams dataclasses each redeclared the four fields that are
universal with identical type+default: element, zorder, colorbar,
colorbar_params. Hoist them into a `@dataclass(kw_only=True) class
RenderParams`; the five become thin `(RenderParams)` subclasses keeping only
their renderer-specific fields.
- kw_only=True is required on the base (a required `element` precedes the
defaulted fields) and applied uniformly for a consistent convention; all
construction sites in basic.py already pass every field by keyword.
- Behaviour/pixel preserving: each subclass exposes the exact same field set
(name/type/default) as before — only the declaration moved. cmap_params
stays on the subclasses (its type varies: CmapParams / list|CmapParams /
CmapParams|None), as do color/groups/table_name etc. (Image/Graph differ).
- Internal only; not part of the public API.
Adds tests/pl/test_render_params.py locking the hierarchy and a frozen
per-subclass field-name snapshot (a dropped field or flipped default is
invisible to the CI-only image baselines, so it is asserted directly).
Steps 2+ (resolve -> IR -> backend) remain a discussion pending maintainer
sign-off; sequence after #696 and #699 land.
@timtreistimtreis changed the title refactor(render_params): RenderParams base class for the 5 *RenderParams (#700, Step 1)refactor(render_params): RenderParams base class for the 5 *RenderParamsJun 14, 2026
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.11%. Comparing base (7a1b3a3) to head (7d91a2a).

Additional details and impacted files
@@ Coverage Diff @@## main #720 +/- ##
==========================================
- Coverage 77.18% 77.11% -0.08% 
==========================================
Files 14 14 Lines 4440 4426 -14 Branches 1014 1014 ==========================================
- Hits 3427 3413 -14 
Misses 658 658 Partials 355 355 
Files with missing linesCoverage Δ
src/spatialdata_plot/pl/render_params.py88.36% <100.00%> (-0.67%)⬇️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@timtreis
timtreis merged commit 78f02f8 into mainJun 14, 2026
7 of 8 checks passed
timtreis added a commit that referenced this pull request Jun 14, 2026
… + single continuous-norm (#699)
PRs 1+2 of #699, rebased onto the post-#715 (utils split) / post-#720 main.
PR3 (image-composite helper) deferred.
CmapParams gains behavior:
- fresh_norm(): a safe per-element copy (applying a Normalize autoscales vmin/vmax
in place, leaking one element's range into the next). Converts the 3 copy(norm)
sites in render.py.
- cmap_with_alpha() / colormap_with_alpha(): public-API replacement for the private
cmap._lut[:, -1] = alpha poke in the 1-channel image path; byte-identical body
colors, no shared-cmap mutation.
Single continuous-norm feeds pixels and colorbar:
- _resolve_continuous_norm(values, cmap_params) in _color.py: one resolver called by
each pixel-baking site and its matching colorbar site with the same vector, so they
cannot diverge. Folds the duplicated inline norm blocks in _color_vector_to_rgba and
_get_collection_shape (now in _geometry.py; its dead `norm` param dropped) and routes
_map_color_seg + the labels imshow + _append_outline_colorbar + the shapes set_clim
through it.
- Datashader / image / points / graph paths unchanged (already share their norm).
Behavior-preserving for normal renders; the only unified edge is an all-identical-value
outline column. Adds unit tests for the new CmapParams methods and _resolve_continuous_norm
plus a non-visual colorbar-clim integration test.
timtreis added a commit that referenced this pull request Jun 14, 2026
… + single continuous-norm (#699)
PRs 1+2 of #699, rebased onto the post-#715 (utils split) / post-#720 main.
PR3 (image-composite helper) deferred.
CmapParams gains behavior:
- fresh_norm(): a safe per-element copy (applying a Normalize autoscales vmin/vmax
in place, leaking one element's range into the next). Converts the 3 copy(norm)
sites in render.py.
- cmap_with_alpha() / colormap_with_alpha(): public-API replacement for the private
cmap._lut[:, -1] = alpha poke in the 1-channel image path; byte-identical body
colors, no shared-cmap mutation.
Single continuous-norm feeds pixels and colorbar:
- _resolve_continuous_norm(values, cmap_params) in _color.py: one resolver called by
each pixel-baking site and its matching colorbar site with the same vector, so they
cannot diverge. Folds the duplicated inline norm blocks in _color_vector_to_rgba and
_get_collection_shape (now in _geometry.py; its dead `norm` param dropped) and routes
_map_color_seg + the labels imshow + _append_outline_colorbar + the shapes set_clim
through it.
- Datashader / image / points / graph paths unchanged (already share their norm).
Behavior-preserving for normal renders; the only unified edge is an all-identical-value
outline column. Adds unit tests for the new CmapParams methods and _resolve_continuous_norm
plus a non-visual colorbar-clim integration test.
@timtreis
timtreis deleted the refactor/issue-700-renderparams-ir branch July 10, 2026 11:11
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@timtreis@codecov-commenter
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

refactor(render_params): RenderParams base class for the 5 *RenderParams - #720

Merged
timtreis merged 1 commit into
mainfrom
refactor/issue-700-renderparams-ir
Jun 14, 2026
Merged

refactor(render_params): RenderParams base class for the 5 *RenderParams#720
timtreis merged 1 commit into
mainfrom
refactor/issue-700-renderparams-ir

Conversation

@timtreis

@timtreistimtreis commented Jun 14, 2026

Copy link
Copy Markdown
Member

Step 1 of #700 — the low-risk, internal-only piece of the RenderParams→IR architecture epic. The IR phases (Steps 2+) remain a discussion pending maintainer sign-off and are not in this PR.

What & why

The five *RenderParams dataclasses each redeclared the four fields that are universal with identical type+default: element, zorder, colorbar, colorbar_params. This hoists them into a @dataclass(kw_only=True) class RenderParams; the five become thin (RenderParams) subclasses carrying only their renderer-specific fields.

Only these four are genuinely universal. cmap_params exists on all five but with three different types (CmapParams / list[CmapParams] | CmapParams / CmapParams | None), and the color/groups/table_name/col_for_color/table_layer cluster is not shared by all renderers (Image lacks the color cluster; Graph lacks col_for_color/table_layer) — so those stay on the subclasses rather than being forced into the base with inert/over-wide fields.

…rParams (#700)
Step 1 of the #700 architecture epic (the low-risk, internal-only piece).
The five *RenderParams dataclasses each redeclared the four fields that are
universal with identical type+default: element, zorder, colorbar,
colorbar_params. Hoist them into a `@dataclass(kw_only=True) class
RenderParams`; the five become thin `(RenderParams)` subclasses keeping only
their renderer-specific fields.
- kw_only=True is required on the base (a required `element` precedes the
defaulted fields) and applied uniformly for a consistent convention; all
construction sites in basic.py already pass every field by keyword.
- Behaviour/pixel preserving: each subclass exposes the exact same field set
(name/type/default) as before — only the declaration moved. cmap_params
stays on the subclasses (its type varies: CmapParams / list|CmapParams /
CmapParams|None), as do color/groups/table_name etc. (Image/Graph differ).
- Internal only; not part of the public API.
Adds tests/pl/test_render_params.py locking the hierarchy and a frozen
per-subclass field-name snapshot (a dropped field or flipped default is
invisible to the CI-only image baselines, so it is asserted directly).
Steps 2+ (resolve -> IR -> backend) remain a discussion pending maintainer
sign-off; sequence after #696 and #699 land.
@timtreistimtreis changed the title refactor(render_params): RenderParams base class for the 5 *RenderParams (#700, Step 1)refactor(render_params): RenderParams base class for the 5 *RenderParamsJun 14, 2026
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.11%. Comparing base (7a1b3a3) to head (7d91a2a).

Additional details and impacted files
@@ Coverage Diff @@## main #720 +/- ##
==========================================
- Coverage 77.18% 77.11% -0.08% 
==========================================
Files 14 14 Lines 4440 4426 -14 Branches 1014 1014 ==========================================
- Hits 3427 3413 -14 
Misses 658 658 Partials 355 355 
Files with missing linesCoverage Δ
src/spatialdata_plot/pl/render_params.py88.36% <100.00%> (-0.67%)⬇️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@timtreis
timtreis merged commit 78f02f8 into mainJun 14, 2026
7 of 8 checks passed
timtreis added a commit that referenced this pull request Jun 14, 2026
… + single continuous-norm (#699)
PRs 1+2 of #699, rebased onto the post-#715 (utils split) / post-#720 main.
PR3 (image-composite helper) deferred.
CmapParams gains behavior:
- fresh_norm(): a safe per-element copy (applying a Normalize autoscales vmin/vmax
in place, leaking one element's range into the next). Converts the 3 copy(norm)
sites in render.py.
- cmap_with_alpha() / colormap_with_alpha(): public-API replacement for the private
cmap._lut[:, -1] = alpha poke in the 1-channel image path; byte-identical body
colors, no shared-cmap mutation.
Single continuous-norm feeds pixels and colorbar:
- _resolve_continuous_norm(values, cmap_params) in _color.py: one resolver called by
each pixel-baking site and its matching colorbar site with the same vector, so they
cannot diverge. Folds the duplicated inline norm blocks in _color_vector_to_rgba and
_get_collection_shape (now in _geometry.py; its dead `norm` param dropped) and routes
_map_color_seg + the labels imshow + _append_outline_colorbar + the shapes set_clim
through it.
- Datashader / image / points / graph paths unchanged (already share their norm).
Behavior-preserving for normal renders; the only unified edge is an all-identical-value
outline column. Adds unit tests for the new CmapParams methods and _resolve_continuous_norm
plus a non-visual colorbar-clim integration test.
timtreis added a commit that referenced this pull request Jun 14, 2026
… + single continuous-norm (#699)
PRs 1+2 of #699, rebased onto the post-#715 (utils split) / post-#720 main.
PR3 (image-composite helper) deferred.
CmapParams gains behavior:
- fresh_norm(): a safe per-element copy (applying a Normalize autoscales vmin/vmax
in place, leaking one element's range into the next). Converts the 3 copy(norm)
sites in render.py.
- cmap_with_alpha() / colormap_with_alpha(): public-API replacement for the private
cmap._lut[:, -1] = alpha poke in the 1-channel image path; byte-identical body
colors, no shared-cmap mutation.
Single continuous-norm feeds pixels and colorbar:
- _resolve_continuous_norm(values, cmap_params) in _color.py: one resolver called by
each pixel-baking site and its matching colorbar site with the same vector, so they
cannot diverge. Folds the duplicated inline norm blocks in _color_vector_to_rgba and
_get_collection_shape (now in _geometry.py; its dead `norm` param dropped) and routes
_map_color_seg + the labels imshow + _append_outline_colorbar + the shapes set_clim
through it.
- Datashader / image / points / graph paths unchanged (already share their norm).
Behavior-preserving for normal renders; the only unified edge is an all-identical-value
outline column. Adds unit tests for the new CmapParams methods and _resolve_continuous_norm
plus a non-visual colorbar-clim integration test.
@timtreis
timtreis deleted the refactor/issue-700-renderparams-ir branch July 10, 2026 11:11
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@timtreis@codecov-commenter
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

refactor(render_params): RenderParams base class for the 5 *RenderParams - #720

Merged
timtreis merged 1 commit into
mainfrom
refactor/issue-700-renderparams-ir
Jun 14, 2026
Merged

refactor(render_params): RenderParams base class for the 5 *RenderParams#720
timtreis merged 1 commit into
mainfrom
refactor/issue-700-renderparams-ir

Conversation

@timtreis

@timtreistimtreis commented Jun 14, 2026

Copy link
Copy Markdown
Member

Step 1 of #700 — the low-risk, internal-only piece of the RenderParams→IR architecture epic. The IR phases (Steps 2+) remain a discussion pending maintainer sign-off and are not in this PR.

What & why

The five *RenderParams dataclasses each redeclared the four fields that are universal with identical type+default: element, zorder, colorbar, colorbar_params. This hoists them into a @dataclass(kw_only=True) class RenderParams; the five become thin (RenderParams) subclasses carrying only their renderer-specific fields.

Only these four are genuinely universal. cmap_params exists on all five but with three different types (CmapParams / list[CmapParams] | CmapParams / CmapParams | None), and the color/groups/table_name/col_for_color/table_layer cluster is not shared by all renderers (Image lacks the color cluster; Graph lacks col_for_color/table_layer) — so those stay on the subclasses rather than being forced into the base with inert/over-wide fields.

…rParams (#700)
Step 1 of the #700 architecture epic (the low-risk, internal-only piece).
The five *RenderParams dataclasses each redeclared the four fields that are
universal with identical type+default: element, zorder, colorbar,
colorbar_params. Hoist them into a `@dataclass(kw_only=True) class
RenderParams`; the five become thin `(RenderParams)` subclasses keeping only
their renderer-specific fields.
- kw_only=True is required on the base (a required `element` precedes the
defaulted fields) and applied uniformly for a consistent convention; all
construction sites in basic.py already pass every field by keyword.
- Behaviour/pixel preserving: each subclass exposes the exact same field set
(name/type/default) as before — only the declaration moved. cmap_params
stays on the subclasses (its type varies: CmapParams / list|CmapParams /
CmapParams|None), as do color/groups/table_name etc. (Image/Graph differ).
- Internal only; not part of the public API.
Adds tests/pl/test_render_params.py locking the hierarchy and a frozen
per-subclass field-name snapshot (a dropped field or flipped default is
invisible to the CI-only image baselines, so it is asserted directly).
Steps 2+ (resolve -> IR -> backend) remain a discussion pending maintainer
sign-off; sequence after #696 and #699 land.
@timtreistimtreis changed the title refactor(render_params): RenderParams base class for the 5 *RenderParams (#700, Step 1)refactor(render_params): RenderParams base class for the 5 *RenderParamsJun 14, 2026
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.11%. Comparing base (7a1b3a3) to head (7d91a2a).

Additional details and impacted files
@@ Coverage Diff @@## main #720 +/- ##
==========================================
- Coverage 77.18% 77.11% -0.08% 
==========================================
Files 14 14 Lines 4440 4426 -14 Branches 1014 1014 ==========================================
- Hits 3427 3413 -14 
Misses 658 658 Partials 355 355 
Files with missing linesCoverage Δ
src/spatialdata_plot/pl/render_params.py88.36% <100.00%> (-0.67%)⬇️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@timtreis
timtreis merged commit 78f02f8 into mainJun 14, 2026
7 of 8 checks passed
timtreis added a commit that referenced this pull request Jun 14, 2026
… + single continuous-norm (#699)
PRs 1+2 of #699, rebased onto the post-#715 (utils split) / post-#720 main.
PR3 (image-composite helper) deferred.
CmapParams gains behavior:
- fresh_norm(): a safe per-element copy (applying a Normalize autoscales vmin/vmax
in place, leaking one element's range into the next). Converts the 3 copy(norm)
sites in render.py.
- cmap_with_alpha() / colormap_with_alpha(): public-API replacement for the private
cmap._lut[:, -1] = alpha poke in the 1-channel image path; byte-identical body
colors, no shared-cmap mutation.
Single continuous-norm feeds pixels and colorbar:
- _resolve_continuous_norm(values, cmap_params) in _color.py: one resolver called by
each pixel-baking site and its matching colorbar site with the same vector, so they
cannot diverge. Folds the duplicated inline norm blocks in _color_vector_to_rgba and
_get_collection_shape (now in _geometry.py; its dead `norm` param dropped) and routes
_map_color_seg + the labels imshow + _append_outline_colorbar + the shapes set_clim
through it.
- Datashader / image / points / graph paths unchanged (already share their norm).
Behavior-preserving for normal renders; the only unified edge is an all-identical-value
outline column. Adds unit tests for the new CmapParams methods and _resolve_continuous_norm
plus a non-visual colorbar-clim integration test.
timtreis added a commit that referenced this pull request Jun 14, 2026
… + single continuous-norm (#699)
PRs 1+2 of #699, rebased onto the post-#715 (utils split) / post-#720 main.
PR3 (image-composite helper) deferred.
CmapParams gains behavior:
- fresh_norm(): a safe per-element copy (applying a Normalize autoscales vmin/vmax
in place, leaking one element's range into the next). Converts the 3 copy(norm)
sites in render.py.
- cmap_with_alpha() / colormap_with_alpha(): public-API replacement for the private
cmap._lut[:, -1] = alpha poke in the 1-channel image path; byte-identical body
colors, no shared-cmap mutation.
Single continuous-norm feeds pixels and colorbar:
- _resolve_continuous_norm(values, cmap_params) in _color.py: one resolver called by
each pixel-baking site and its matching colorbar site with the same vector, so they
cannot diverge. Folds the duplicated inline norm blocks in _color_vector_to_rgba and
_get_collection_shape (now in _geometry.py; its dead `norm` param dropped) and routes
_map_color_seg + the labels imshow + _append_outline_colorbar + the shapes set_clim
through it.
- Datashader / image / points / graph paths unchanged (already share their norm).
Behavior-preserving for normal renders; the only unified edge is an all-identical-value
outline column. Adds unit tests for the new CmapParams methods and _resolve_continuous_norm
plus a non-visual colorbar-clim integration test.
@timtreis
timtreis deleted the refactor/issue-700-renderparams-ir branch July 10, 2026 11:11
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@timtreis@codecov-commenter
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

refactor(render_params): RenderParams base class for the 5 *RenderParams - #720

Merged
timtreis merged 1 commit into
mainfrom
refactor/issue-700-renderparams-ir
Jun 14, 2026
Merged

refactor(render_params): RenderParams base class for the 5 *RenderParams#720
timtreis merged 1 commit into
mainfrom
refactor/issue-700-renderparams-ir

Conversation

@timtreis

@timtreistimtreis commented Jun 14, 2026

Copy link
Copy Markdown
Member

Step 1 of #700 — the low-risk, internal-only piece of the RenderParams→IR architecture epic. The IR phases (Steps 2+) remain a discussion pending maintainer sign-off and are not in this PR.

What & why

The five *RenderParams dataclasses each redeclared the four fields that are universal with identical type+default: element, zorder, colorbar, colorbar_params. This hoists them into a @dataclass(kw_only=True) class RenderParams; the five become thin (RenderParams) subclasses carrying only their renderer-specific fields.

Only these four are genuinely universal. cmap_params exists on all five but with three different types (CmapParams / list[CmapParams] | CmapParams / CmapParams | None), and the color/groups/table_name/col_for_color/table_layer cluster is not shared by all renderers (Image lacks the color cluster; Graph lacks col_for_color/table_layer) — so those stay on the subclasses rather than being forced into the base with inert/over-wide fields.

…rParams (#700)
Step 1 of the #700 architecture epic (the low-risk, internal-only piece).
The five *RenderParams dataclasses each redeclared the four fields that are
universal with identical type+default: element, zorder, colorbar,
colorbar_params. Hoist them into a `@dataclass(kw_only=True) class
RenderParams`; the five become thin `(RenderParams)` subclasses keeping only
their renderer-specific fields.
- kw_only=True is required on the base (a required `element` precedes the
defaulted fields) and applied uniformly for a consistent convention; all
construction sites in basic.py already pass every field by keyword.
- Behaviour/pixel preserving: each subclass exposes the exact same field set
(name/type/default) as before — only the declaration moved. cmap_params
stays on the subclasses (its type varies: CmapParams / list|CmapParams /
CmapParams|None), as do color/groups/table_name etc. (Image/Graph differ).
- Internal only; not part of the public API.
Adds tests/pl/test_render_params.py locking the hierarchy and a frozen
per-subclass field-name snapshot (a dropped field or flipped default is
invisible to the CI-only image baselines, so it is asserted directly).
Steps 2+ (resolve -> IR -> backend) remain a discussion pending maintainer
sign-off; sequence after #696 and #699 land.
@timtreistimtreis changed the title refactor(render_params): RenderParams base class for the 5 *RenderParams (#700, Step 1)refactor(render_params): RenderParams base class for the 5 *RenderParamsJun 14, 2026
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.11%. Comparing base (7a1b3a3) to head (7d91a2a).

Additional details and impacted files
@@ Coverage Diff @@## main #720 +/- ##
==========================================
- Coverage 77.18% 77.11% -0.08% 
==========================================
Files 14 14 Lines 4440 4426 -14 Branches 1014 1014 ==========================================
- Hits 3427 3413 -14 
Misses 658 658 Partials 355 355 
Files with missing linesCoverage Δ
src/spatialdata_plot/pl/render_params.py88.36% <100.00%> (-0.67%)⬇️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@timtreis
timtreis merged commit 78f02f8 into mainJun 14, 2026
7 of 8 checks passed
timtreis added a commit that referenced this pull request Jun 14, 2026
… + single continuous-norm (#699)
PRs 1+2 of #699, rebased onto the post-#715 (utils split) / post-#720 main.
PR3 (image-composite helper) deferred.
CmapParams gains behavior:
- fresh_norm(): a safe per-element copy (applying a Normalize autoscales vmin/vmax
in place, leaking one element's range into the next). Converts the 3 copy(norm)
sites in render.py.
- cmap_with_alpha() / colormap_with_alpha(): public-API replacement for the private
cmap._lut[:, -1] = alpha poke in the 1-channel image path; byte-identical body
colors, no shared-cmap mutation.
Single continuous-norm feeds pixels and colorbar:
- _resolve_continuous_norm(values, cmap_params) in _color.py: one resolver called by
each pixel-baking site and its matching colorbar site with the same vector, so they
cannot diverge. Folds the duplicated inline norm blocks in _color_vector_to_rgba and
_get_collection_shape (now in _geometry.py; its dead `norm` param dropped) and routes
_map_color_seg + the labels imshow + _append_outline_colorbar + the shapes set_clim
through it.
- Datashader / image / points / graph paths unchanged (already share their norm).
Behavior-preserving for normal renders; the only unified edge is an all-identical-value
outline column. Adds unit tests for the new CmapParams methods and _resolve_continuous_norm
plus a non-visual colorbar-clim integration test.
timtreis added a commit that referenced this pull request Jun 14, 2026
… + single continuous-norm (#699)
PRs 1+2 of #699, rebased onto the post-#715 (utils split) / post-#720 main.
PR3 (image-composite helper) deferred.
CmapParams gains behavior:
- fresh_norm(): a safe per-element copy (applying a Normalize autoscales vmin/vmax
in place, leaking one element's range into the next). Converts the 3 copy(norm)
sites in render.py.
- cmap_with_alpha() / colormap_with_alpha(): public-API replacement for the private
cmap._lut[:, -1] = alpha poke in the 1-channel image path; byte-identical body
colors, no shared-cmap mutation.
Single continuous-norm feeds pixels and colorbar:
- _resolve_continuous_norm(values, cmap_params) in _color.py: one resolver called by
each pixel-baking site and its matching colorbar site with the same vector, so they
cannot diverge. Folds the duplicated inline norm blocks in _color_vector_to_rgba and
_get_collection_shape (now in _geometry.py; its dead `norm` param dropped) and routes
_map_color_seg + the labels imshow + _append_outline_colorbar + the shapes set_clim
through it.
- Datashader / image / points / graph paths unchanged (already share their norm).
Behavior-preserving for normal renders; the only unified edge is an all-identical-value
outline column. Adds unit tests for the new CmapParams methods and _resolve_continuous_norm
plus a non-visual colorbar-clim integration test.
@timtreis
timtreis deleted the refactor/issue-700-renderparams-ir branch July 10, 2026 11:11
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@timtreis@codecov-commenter
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

refactor(render_params): RenderParams base class for the 5 *RenderParams - #720

Merged
timtreis merged 1 commit into
mainfrom
refactor/issue-700-renderparams-ir
Jun 14, 2026
Merged

refactor(render_params): RenderParams base class for the 5 *RenderParams#720
timtreis merged 1 commit into
mainfrom
refactor/issue-700-renderparams-ir

Conversation

@timtreis

@timtreistimtreis commented Jun 14, 2026

Copy link
Copy Markdown
Member

Step 1 of #700 — the low-risk, internal-only piece of the RenderParams→IR architecture epic. The IR phases (Steps 2+) remain a discussion pending maintainer sign-off and are not in this PR.

What & why

The five *RenderParams dataclasses each redeclared the four fields that are universal with identical type+default: element, zorder, colorbar, colorbar_params. This hoists them into a @dataclass(kw_only=True) class RenderParams; the five become thin (RenderParams) subclasses carrying only their renderer-specific fields.

Only these four are genuinely universal. cmap_params exists on all five but with three different types (CmapParams / list[CmapParams] | CmapParams / CmapParams | None), and the color/groups/table_name/col_for_color/table_layer cluster is not shared by all renderers (Image lacks the color cluster; Graph lacks col_for_color/table_layer) — so those stay on the subclasses rather than being forced into the base with inert/over-wide fields.

…rParams (#700)
Step 1 of the #700 architecture epic (the low-risk, internal-only piece).
The five *RenderParams dataclasses each redeclared the four fields that are
universal with identical type+default: element, zorder, colorbar,
colorbar_params. Hoist them into a `@dataclass(kw_only=True) class
RenderParams`; the five become thin `(RenderParams)` subclasses keeping only
their renderer-specific fields.
- kw_only=True is required on the base (a required `element` precedes the
defaulted fields) and applied uniformly for a consistent convention; all
construction sites in basic.py already pass every field by keyword.
- Behaviour/pixel preserving: each subclass exposes the exact same field set
(name/type/default) as before — only the declaration moved. cmap_params
stays on the subclasses (its type varies: CmapParams / list|CmapParams /
CmapParams|None), as do color/groups/table_name etc. (Image/Graph differ).
- Internal only; not part of the public API.
Adds tests/pl/test_render_params.py locking the hierarchy and a frozen
per-subclass field-name snapshot (a dropped field or flipped default is
invisible to the CI-only image baselines, so it is asserted directly).
Steps 2+ (resolve -> IR -> backend) remain a discussion pending maintainer
sign-off; sequence after #696 and #699 land.
@timtreistimtreis changed the title refactor(render_params): RenderParams base class for the 5 *RenderParams (#700, Step 1)refactor(render_params): RenderParams base class for the 5 *RenderParamsJun 14, 2026
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.11%. Comparing base (7a1b3a3) to head (7d91a2a).

Additional details and impacted files
@@ Coverage Diff @@## main #720 +/- ##
==========================================
- Coverage 77.18% 77.11% -0.08% 
==========================================
Files 14 14 Lines 4440 4426 -14 Branches 1014 1014 ==========================================
- Hits 3427 3413 -14 
Misses 658 658 Partials 355 355 
Files with missing linesCoverage Δ
src/spatialdata_plot/pl/render_params.py88.36% <100.00%> (-0.67%)⬇️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@timtreis
timtreis merged commit 78f02f8 into mainJun 14, 2026
7 of 8 checks passed
timtreis added a commit that referenced this pull request Jun 14, 2026
… + single continuous-norm (#699)
PRs 1+2 of #699, rebased onto the post-#715 (utils split) / post-#720 main.
PR3 (image-composite helper) deferred.
CmapParams gains behavior:
- fresh_norm(): a safe per-element copy (applying a Normalize autoscales vmin/vmax
in place, leaking one element's range into the next). Converts the 3 copy(norm)
sites in render.py.
- cmap_with_alpha() / colormap_with_alpha(): public-API replacement for the private
cmap._lut[:, -1] = alpha poke in the 1-channel image path; byte-identical body
colors, no shared-cmap mutation.
Single continuous-norm feeds pixels and colorbar:
- _resolve_continuous_norm(values, cmap_params) in _color.py: one resolver called by
each pixel-baking site and its matching colorbar site with the same vector, so they
cannot diverge. Folds the duplicated inline norm blocks in _color_vector_to_rgba and
_get_collection_shape (now in _geometry.py; its dead `norm` param dropped) and routes
_map_color_seg + the labels imshow + _append_outline_colorbar + the shapes set_clim
through it.
- Datashader / image / points / graph paths unchanged (already share their norm).
Behavior-preserving for normal renders; the only unified edge is an all-identical-value
outline column. Adds unit tests for the new CmapParams methods and _resolve_continuous_norm
plus a non-visual colorbar-clim integration test.
timtreis added a commit that referenced this pull request Jun 14, 2026
… + single continuous-norm (#699)
PRs 1+2 of #699, rebased onto the post-#715 (utils split) / post-#720 main.
PR3 (image-composite helper) deferred.
CmapParams gains behavior:
- fresh_norm(): a safe per-element copy (applying a Normalize autoscales vmin/vmax
in place, leaking one element's range into the next). Converts the 3 copy(norm)
sites in render.py.
- cmap_with_alpha() / colormap_with_alpha(): public-API replacement for the private
cmap._lut[:, -1] = alpha poke in the 1-channel image path; byte-identical body
colors, no shared-cmap mutation.
Single continuous-norm feeds pixels and colorbar:
- _resolve_continuous_norm(values, cmap_params) in _color.py: one resolver called by
each pixel-baking site and its matching colorbar site with the same vector, so they
cannot diverge. Folds the duplicated inline norm blocks in _color_vector_to_rgba and
_get_collection_shape (now in _geometry.py; its dead `norm` param dropped) and routes
_map_color_seg + the labels imshow + _append_outline_colorbar + the shapes set_clim
through it.
- Datashader / image / points / graph paths unchanged (already share their norm).
Behavior-preserving for normal renders; the only unified edge is an all-identical-value
outline column. Adds unit tests for the new CmapParams methods and _resolve_continuous_norm
plus a non-visual colorbar-clim integration test.
@timtreis
timtreis deleted the refactor/issue-700-renderparams-ir branch July 10, 2026 11:11
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@timtreis@codecov-commenter
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

refactor(render_params): RenderParams base class for the 5 *RenderParams - #720

Merged
timtreis merged 1 commit into
mainfrom
refactor/issue-700-renderparams-ir
Jun 14, 2026
Merged

refactor(render_params): RenderParams base class for the 5 *RenderParams#720
timtreis merged 1 commit into
mainfrom
refactor/issue-700-renderparams-ir

Conversation

@timtreis

@timtreistimtreis commented Jun 14, 2026

Copy link
Copy Markdown
Member

Step 1 of #700 — the low-risk, internal-only piece of the RenderParams→IR architecture epic. The IR phases (Steps 2+) remain a discussion pending maintainer sign-off and are not in this PR.

What & why

The five *RenderParams dataclasses each redeclared the four fields that are universal with identical type+default: element, zorder, colorbar, colorbar_params. This hoists them into a @dataclass(kw_only=True) class RenderParams; the five become thin (RenderParams) subclasses carrying only their renderer-specific fields.

Only these four are genuinely universal. cmap_params exists on all five but with three different types (CmapParams / list[CmapParams] | CmapParams / CmapParams | None), and the color/groups/table_name/col_for_color/table_layer cluster is not shared by all renderers (Image lacks the color cluster; Graph lacks col_for_color/table_layer) — so those stay on the subclasses rather than being forced into the base with inert/over-wide fields.

…rParams (#700)
Step 1 of the #700 architecture epic (the low-risk, internal-only piece).
The five *RenderParams dataclasses each redeclared the four fields that are
universal with identical type+default: element, zorder, colorbar,
colorbar_params. Hoist them into a `@dataclass(kw_only=True) class
RenderParams`; the five become thin `(RenderParams)` subclasses keeping only
their renderer-specific fields.
- kw_only=True is required on the base (a required `element` precedes the
defaulted fields) and applied uniformly for a consistent convention; all
construction sites in basic.py already pass every field by keyword.
- Behaviour/pixel preserving: each subclass exposes the exact same field set
(name/type/default) as before — only the declaration moved. cmap_params
stays on the subclasses (its type varies: CmapParams / list|CmapParams /
CmapParams|None), as do color/groups/table_name etc. (Image/Graph differ).
- Internal only; not part of the public API.
Adds tests/pl/test_render_params.py locking the hierarchy and a frozen
per-subclass field-name snapshot (a dropped field or flipped default is
invisible to the CI-only image baselines, so it is asserted directly).
Steps 2+ (resolve -> IR -> backend) remain a discussion pending maintainer
sign-off; sequence after #696 and #699 land.
@timtreistimtreis changed the title refactor(render_params): RenderParams base class for the 5 *RenderParams (#700, Step 1)refactor(render_params): RenderParams base class for the 5 *RenderParamsJun 14, 2026
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.11%. Comparing base (7a1b3a3) to head (7d91a2a).

Additional details and impacted files
@@ Coverage Diff @@## main #720 +/- ##
==========================================
- Coverage 77.18% 77.11% -0.08% 
==========================================
Files 14 14 Lines 4440 4426 -14 Branches 1014 1014 ==========================================
- Hits 3427 3413 -14 
Misses 658 658 Partials 355 355 
Files with missing linesCoverage Δ
src/spatialdata_plot/pl/render_params.py88.36% <100.00%> (-0.67%)⬇️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@timtreis
timtreis merged commit 78f02f8 into mainJun 14, 2026
7 of 8 checks passed
timtreis added a commit that referenced this pull request Jun 14, 2026
… + single continuous-norm (#699)
PRs 1+2 of #699, rebased onto the post-#715 (utils split) / post-#720 main.
PR3 (image-composite helper) deferred.
CmapParams gains behavior:
- fresh_norm(): a safe per-element copy (applying a Normalize autoscales vmin/vmax
in place, leaking one element's range into the next). Converts the 3 copy(norm)
sites in render.py.
- cmap_with_alpha() / colormap_with_alpha(): public-API replacement for the private
cmap._lut[:, -1] = alpha poke in the 1-channel image path; byte-identical body
colors, no shared-cmap mutation.
Single continuous-norm feeds pixels and colorbar:
- _resolve_continuous_norm(values, cmap_params) in _color.py: one resolver called by
each pixel-baking site and its matching colorbar site with the same vector, so they
cannot diverge. Folds the duplicated inline norm blocks in _color_vector_to_rgba and
_get_collection_shape (now in _geometry.py; its dead `norm` param dropped) and routes
_map_color_seg + the labels imshow + _append_outline_colorbar + the shapes set_clim
through it.
- Datashader / image / points / graph paths unchanged (already share their norm).
Behavior-preserving for normal renders; the only unified edge is an all-identical-value
outline column. Adds unit tests for the new CmapParams methods and _resolve_continuous_norm
plus a non-visual colorbar-clim integration test.
timtreis added a commit that referenced this pull request Jun 14, 2026
… + single continuous-norm (#699)
PRs 1+2 of #699, rebased onto the post-#715 (utils split) / post-#720 main.
PR3 (image-composite helper) deferred.
CmapParams gains behavior:
- fresh_norm(): a safe per-element copy (applying a Normalize autoscales vmin/vmax
in place, leaking one element's range into the next). Converts the 3 copy(norm)
sites in render.py.
- cmap_with_alpha() / colormap_with_alpha(): public-API replacement for the private
cmap._lut[:, -1] = alpha poke in the 1-channel image path; byte-identical body
colors, no shared-cmap mutation.
Single continuous-norm feeds pixels and colorbar:
- _resolve_continuous_norm(values, cmap_params) in _color.py: one resolver called by
each pixel-baking site and its matching colorbar site with the same vector, so they
cannot diverge. Folds the duplicated inline norm blocks in _color_vector_to_rgba and
_get_collection_shape (now in _geometry.py; its dead `norm` param dropped) and routes
_map_color_seg + the labels imshow + _append_outline_colorbar + the shapes set_clim
through it.
- Datashader / image / points / graph paths unchanged (already share their norm).
Behavior-preserving for normal renders; the only unified edge is an all-identical-value
outline column. Adds unit tests for the new CmapParams methods and _resolve_continuous_norm
plus a non-visual colorbar-clim integration test.
@timtreis
timtreis deleted the refactor/issue-700-renderparams-ir branch July 10, 2026 11:11
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@timtreis@codecov-commenter
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

refactor(render_params): RenderParams base class for the 5 *RenderParams - #720

Merged
timtreis merged 1 commit into
mainfrom
refactor/issue-700-renderparams-ir
Jun 14, 2026
Merged

refactor(render_params): RenderParams base class for the 5 *RenderParams#720
timtreis merged 1 commit into
mainfrom
refactor/issue-700-renderparams-ir

Conversation

@timtreis

@timtreistimtreis commented Jun 14, 2026

Copy link
Copy Markdown
Member

Step 1 of #700 — the low-risk, internal-only piece of the RenderParams→IR architecture epic. The IR phases (Steps 2+) remain a discussion pending maintainer sign-off and are not in this PR.

What & why

The five *RenderParams dataclasses each redeclared the four fields that are universal with identical type+default: element, zorder, colorbar, colorbar_params. This hoists them into a @dataclass(kw_only=True) class RenderParams; the five become thin (RenderParams) subclasses carrying only their renderer-specific fields.

Only these four are genuinely universal. cmap_params exists on all five but with three different types (CmapParams / list[CmapParams] | CmapParams / CmapParams | None), and the color/groups/table_name/col_for_color/table_layer cluster is not shared by all renderers (Image lacks the color cluster; Graph lacks col_for_color/table_layer) — so those stay on the subclasses rather than being forced into the base with inert/over-wide fields.

…rParams (#700)
Step 1 of the #700 architecture epic (the low-risk, internal-only piece).
The five *RenderParams dataclasses each redeclared the four fields that are
universal with identical type+default: element, zorder, colorbar,
colorbar_params. Hoist them into a `@dataclass(kw_only=True) class
RenderParams`; the five become thin `(RenderParams)` subclasses keeping only
their renderer-specific fields.
- kw_only=True is required on the base (a required `element` precedes the
defaulted fields) and applied uniformly for a consistent convention; all
construction sites in basic.py already pass every field by keyword.
- Behaviour/pixel preserving: each subclass exposes the exact same field set
(name/type/default) as before — only the declaration moved. cmap_params
stays on the subclasses (its type varies: CmapParams / list|CmapParams /
CmapParams|None), as do color/groups/table_name etc. (Image/Graph differ).
- Internal only; not part of the public API.
Adds tests/pl/test_render_params.py locking the hierarchy and a frozen
per-subclass field-name snapshot (a dropped field or flipped default is
invisible to the CI-only image baselines, so it is asserted directly).
Steps 2+ (resolve -> IR -> backend) remain a discussion pending maintainer
sign-off; sequence after #696 and #699 land.
@timtreistimtreis changed the title refactor(render_params): RenderParams base class for the 5 *RenderParams (#700, Step 1)refactor(render_params): RenderParams base class for the 5 *RenderParamsJun 14, 2026
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.11%. Comparing base (7a1b3a3) to head (7d91a2a).

Additional details and impacted files
@@ Coverage Diff @@## main #720 +/- ##
==========================================
- Coverage 77.18% 77.11% -0.08% 
==========================================
Files 14 14 Lines 4440 4426 -14 Branches 1014 1014 ==========================================
- Hits 3427 3413 -14 
Misses 658 658 Partials 355 355 
Files with missing linesCoverage Δ
src/spatialdata_plot/pl/render_params.py88.36% <100.00%> (-0.67%)⬇️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@timtreis
timtreis merged commit 78f02f8 into mainJun 14, 2026
7 of 8 checks passed
timtreis added a commit that referenced this pull request Jun 14, 2026
… + single continuous-norm (#699)
PRs 1+2 of #699, rebased onto the post-#715 (utils split) / post-#720 main.
PR3 (image-composite helper) deferred.
CmapParams gains behavior:
- fresh_norm(): a safe per-element copy (applying a Normalize autoscales vmin/vmax
in place, leaking one element's range into the next). Converts the 3 copy(norm)
sites in render.py.
- cmap_with_alpha() / colormap_with_alpha(): public-API replacement for the private
cmap._lut[:, -1] = alpha poke in the 1-channel image path; byte-identical body
colors, no shared-cmap mutation.
Single continuous-norm feeds pixels and colorbar:
- _resolve_continuous_norm(values, cmap_params) in _color.py: one resolver called by
each pixel-baking site and its matching colorbar site with the same vector, so they
cannot diverge. Folds the duplicated inline norm blocks in _color_vector_to_rgba and
_get_collection_shape (now in _geometry.py; its dead `norm` param dropped) and routes
_map_color_seg + the labels imshow + _append_outline_colorbar + the shapes set_clim
through it.
- Datashader / image / points / graph paths unchanged (already share their norm).
Behavior-preserving for normal renders; the only unified edge is an all-identical-value
outline column. Adds unit tests for the new CmapParams methods and _resolve_continuous_norm
plus a non-visual colorbar-clim integration test.
timtreis added a commit that referenced this pull request Jun 14, 2026
… + single continuous-norm (#699)
PRs 1+2 of #699, rebased onto the post-#715 (utils split) / post-#720 main.
PR3 (image-composite helper) deferred.
CmapParams gains behavior:
- fresh_norm(): a safe per-element copy (applying a Normalize autoscales vmin/vmax
in place, leaking one element's range into the next). Converts the 3 copy(norm)
sites in render.py.
- cmap_with_alpha() / colormap_with_alpha(): public-API replacement for the private
cmap._lut[:, -1] = alpha poke in the 1-channel image path; byte-identical body
colors, no shared-cmap mutation.
Single continuous-norm feeds pixels and colorbar:
- _resolve_continuous_norm(values, cmap_params) in _color.py: one resolver called by
each pixel-baking site and its matching colorbar site with the same vector, so they
cannot diverge. Folds the duplicated inline norm blocks in _color_vector_to_rgba and
_get_collection_shape (now in _geometry.py; its dead `norm` param dropped) and routes
_map_color_seg + the labels imshow + _append_outline_colorbar + the shapes set_clim
through it.
- Datashader / image / points / graph paths unchanged (already share their norm).
Behavior-preserving for normal renders; the only unified edge is an all-identical-value
outline column. Adds unit tests for the new CmapParams methods and _resolve_continuous_norm
plus a non-visual colorbar-clim integration test.
@timtreis
timtreis deleted the refactor/issue-700-renderparams-ir branch July 10, 2026 11:11
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@timtreis@codecov-commenter
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

refactor(render_params): RenderParams base class for the 5 *RenderParams - #720

Merged
timtreis merged 1 commit into
mainfrom
refactor/issue-700-renderparams-ir
Jun 14, 2026
Merged

refactor(render_params): RenderParams base class for the 5 *RenderParams#720
timtreis merged 1 commit into
mainfrom
refactor/issue-700-renderparams-ir

Conversation

@timtreis

@timtreistimtreis commented Jun 14, 2026

Copy link
Copy Markdown
Member

Step 1 of #700 — the low-risk, internal-only piece of the RenderParams→IR architecture epic. The IR phases (Steps 2+) remain a discussion pending maintainer sign-off and are not in this PR.

What & why

The five *RenderParams dataclasses each redeclared the four fields that are universal with identical type+default: element, zorder, colorbar, colorbar_params. This hoists them into a @dataclass(kw_only=True) class RenderParams; the five become thin (RenderParams) subclasses carrying only their renderer-specific fields.

Only these four are genuinely universal. cmap_params exists on all five but with three different types (CmapParams / list[CmapParams] | CmapParams / CmapParams | None), and the color/groups/table_name/col_for_color/table_layer cluster is not shared by all renderers (Image lacks the color cluster; Graph lacks col_for_color/table_layer) — so those stay on the subclasses rather than being forced into the base with inert/over-wide fields.

…rParams (#700)
Step 1 of the #700 architecture epic (the low-risk, internal-only piece).
The five *RenderParams dataclasses each redeclared the four fields that are
universal with identical type+default: element, zorder, colorbar,
colorbar_params. Hoist them into a `@dataclass(kw_only=True) class
RenderParams`; the five become thin `(RenderParams)` subclasses keeping only
their renderer-specific fields.
- kw_only=True is required on the base (a required `element` precedes the
defaulted fields) and applied uniformly for a consistent convention; all
construction sites in basic.py already pass every field by keyword.
- Behaviour/pixel preserving: each subclass exposes the exact same field set
(name/type/default) as before — only the declaration moved. cmap_params
stays on the subclasses (its type varies: CmapParams / list|CmapParams /
CmapParams|None), as do color/groups/table_name etc. (Image/Graph differ).
- Internal only; not part of the public API.
Adds tests/pl/test_render_params.py locking the hierarchy and a frozen
per-subclass field-name snapshot (a dropped field or flipped default is
invisible to the CI-only image baselines, so it is asserted directly).
Steps 2+ (resolve -> IR -> backend) remain a discussion pending maintainer
sign-off; sequence after #696 and #699 land.
@timtreistimtreis changed the title refactor(render_params): RenderParams base class for the 5 *RenderParams (#700, Step 1)refactor(render_params): RenderParams base class for the 5 *RenderParamsJun 14, 2026
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.11%. Comparing base (7a1b3a3) to head (7d91a2a).

Additional details and impacted files
@@ Coverage Diff @@## main #720 +/- ##
==========================================
- Coverage 77.18% 77.11% -0.08% 
==========================================
Files 14 14 Lines 4440 4426 -14 Branches 1014 1014 ==========================================
- Hits 3427 3413 -14 
Misses 658 658 Partials 355 355 
Files with missing linesCoverage Δ
src/spatialdata_plot/pl/render_params.py88.36% <100.00%> (-0.67%)⬇️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@timtreis
timtreis merged commit 78f02f8 into mainJun 14, 2026
7 of 8 checks passed
timtreis added a commit that referenced this pull request Jun 14, 2026
… + single continuous-norm (#699)
PRs 1+2 of #699, rebased onto the post-#715 (utils split) / post-#720 main.
PR3 (image-composite helper) deferred.
CmapParams gains behavior:
- fresh_norm(): a safe per-element copy (applying a Normalize autoscales vmin/vmax
in place, leaking one element's range into the next). Converts the 3 copy(norm)
sites in render.py.
- cmap_with_alpha() / colormap_with_alpha(): public-API replacement for the private
cmap._lut[:, -1] = alpha poke in the 1-channel image path; byte-identical body
colors, no shared-cmap mutation.
Single continuous-norm feeds pixels and colorbar:
- _resolve_continuous_norm(values, cmap_params) in _color.py: one resolver called by
each pixel-baking site and its matching colorbar site with the same vector, so they
cannot diverge. Folds the duplicated inline norm blocks in _color_vector_to_rgba and
_get_collection_shape (now in _geometry.py; its dead `norm` param dropped) and routes
_map_color_seg + the labels imshow + _append_outline_colorbar + the shapes set_clim
through it.
- Datashader / image / points / graph paths unchanged (already share their norm).
Behavior-preserving for normal renders; the only unified edge is an all-identical-value
outline column. Adds unit tests for the new CmapParams methods and _resolve_continuous_norm
plus a non-visual colorbar-clim integration test.
timtreis added a commit that referenced this pull request Jun 14, 2026
… + single continuous-norm (#699)
PRs 1+2 of #699, rebased onto the post-#715 (utils split) / post-#720 main.
PR3 (image-composite helper) deferred.
CmapParams gains behavior:
- fresh_norm(): a safe per-element copy (applying a Normalize autoscales vmin/vmax
in place, leaking one element's range into the next). Converts the 3 copy(norm)
sites in render.py.
- cmap_with_alpha() / colormap_with_alpha(): public-API replacement for the private
cmap._lut[:, -1] = alpha poke in the 1-channel image path; byte-identical body
colors, no shared-cmap mutation.
Single continuous-norm feeds pixels and colorbar:
- _resolve_continuous_norm(values, cmap_params) in _color.py: one resolver called by
each pixel-baking site and its matching colorbar site with the same vector, so they
cannot diverge. Folds the duplicated inline norm blocks in _color_vector_to_rgba and
_get_collection_shape (now in _geometry.py; its dead `norm` param dropped) and routes
_map_color_seg + the labels imshow + _append_outline_colorbar + the shapes set_clim
through it.
- Datashader / image / points / graph paths unchanged (already share their norm).
Behavior-preserving for normal renders; the only unified edge is an all-identical-value
outline column. Adds unit tests for the new CmapParams methods and _resolve_continuous_norm
plus a non-visual colorbar-clim integration test.
@timtreis
timtreis deleted the refactor/issue-700-renderparams-ir branch July 10, 2026 11:11
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@timtreis@codecov-commenter