Implement Zarr V3 protocol - #898

Merged
joshmoore merged 121 commits into
zarr-developers:masterfrom
grlee77:v3-store-part6
Mar 23, 2022
Merged

Implement Zarr V3 protocol#898
joshmoore merged 121 commits into
zarr-developers:masterfrom
grlee77:v3-store-part6

Conversation

@grlee77

@grlee77grlee77 commented Dec 1, 2021

Copy link
Copy Markdown
Contributor

This PR builds on #897, adding zarr v3 support to most of the high-level convenience functions (I haven't looked at the consolidated metadata yet).

EDIT: I closed the prior v3 PRs leading up to this one as their commits are also included here along with additional bug fixes and tests.

TODO:

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/tutorial.rst
  • Changes documented in docs/release.rst
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

Define the StoreV3 class and create v3 versions of most existing stores
Add a test_storage_v3.py with test classes inheriting from their v2
counterparts. Only a subset of methods involving differences in v3
behavior were overridden.
@codecov

codecovBot commented Dec 1, 2021

Copy link
Copy Markdown

Codecov Report

Merging #898 (7aa5dff) into master (b98c799) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@ Coverage Diff @@## master #898 +/- ##
=========================================
Coverage 99.94% 99.95% =========================================
Files 32 33 +1 Lines 11256 13622 +2366 =========================================
+ Hits 11250 13616 +2366 
Misses 6 6 
Impacted FilesCoverage Δ
zarr/_storage/absstore.py100.00% <100.00%> (ø)
zarr/_storage/store.py100.00% <100.00%> (ø)
zarr/attrs.py100.00% <100.00%> (ø)
zarr/convenience.py100.00% <100.00%> (ø)
zarr/core.py100.00% <100.00%> (ø)
zarr/creation.py100.00% <100.00%> (ø)
zarr/hierarchy.py100.00% <100.00%> (ø)
zarr/meta.py100.00% <100.00%> (ø)
zarr/storage.py100.00% <100.00%> (ø)
zarr/tests/test_attrs.py100.00% <100.00%> (ø)
... and 11 more

@pep8speaks

pep8speaks commented Dec 15, 2021

Copy link
Copy Markdown

Hello @grlee77! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2022-03-11 03:47:51 UTC

@grlee77
grlee77force-pushed the v3-store-part6 branch 2 times, most recently from de243b2 to 266ab58CompareDecember 16, 2021 20:43
zarr_version should not be in the array metadata, only the base store metadata
compressor should be absent when there is no compression
No need for this class as DirectoryStoreV3 with / chunk separator can be used instead
@grlee77

Copy link
Copy Markdown
ContributorAuthor

NestedDirectoryStoreV3 has been removed as discussed above: #898 (comment)

@joshmoorejoshmoore left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking nice, @grlee77! A number of mostly aesthetic points below after an initial read. Don't think any of them are MUSTs before merging this into a dev branch. (See zarr-developers/governance#15)

The only other high-level comment, also aesthetic, is whether zarr._storage.v3 (or similar) would be appropriate earlier rather than later.

Comment threadzarr/_storage/absstore.py Outdated
self.rmdir()


def rmdir_abs(store: ABSStore, path=None):

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this not a method on the store?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure why I did it that way. I can make this ABSStore.rmdir and just call it from there in ABSStoreV3.rmdir

Comment threadzarr/_storage/absstore.py Outdated
Comment threadzarr/_storage/store.py Outdated
Comment threadzarr/_storage/store.py Outdated
Comment threadzarr/_storage/store.py Outdated
del store[key]


def _rmdir_from_keys_v3(store: StoreV3, path: str = "") -> None:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Knowing how this module is growing, is there any place relatively convenient that we could "hide" v3-specific methods?

Comment threadzarr/convenience.py
key == 'zarr.json')

# cannot create a group without a path in v3
# so create /meta/root/consolidated group to store the metadata

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use of "/meta/root/consolidated" likely needs review at the zarr-specs level.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I opened zarr-developers/zarr-specs#136 so we don't forget

Comment threadzarr/hierarchy.py Outdated
store = _normalize_store_arg(store)
store = _normalize_store_arg(store, zarr_version=zarr_version)
if zarr_version is None:
zarr_version = getattr(store, '_store_version', 2)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Worth planning now for when the default swaps from 2 to 3? Either by using a constant or by documenting the locations while you have it in mind?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I added DEFAULT_ZARR_VERSION (currently set to 2) in place of 2 in these checks.

It is intended as a constant used by developers, not something a user would set in their code to select the default version.

@joshmoore

Copy link
Copy Markdown
Member

Anything else planned from your side, @grlee77 ?

@grlee77

grlee77 commented Mar 15, 2022

Copy link
Copy Markdown
ContributorAuthor

Anything else planned from your side, @grlee77 ?

Before release we will need to decide on where we want the import path for v3 Stores to be (currently in the same file as the V2 ones). We can think about that and a possible environment variable to enable/disable v3 visibility in a followup, though.

@joshmoore

Copy link
Copy Markdown
Member

👍 for handling the refactoring and v3-switch in follow ups. As discussed during the past two community calls, getting this in to the mainline. 🎉 (And as promised for @grlee77: 🍪)

Clear warning for @zarr-developers/core-devs : the mainline is now in an unreleasable v3 state. If 2.11.x needs to go out, a dedicated v2 branch will need to be forked from a point before this merge.

See zarr-developers/governance#15 for some background.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@grlee77@pep8speaks@joshmoore
, '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

Implement Zarr V3 protocol - #898

Merged
joshmoore merged 121 commits into
zarr-developers:masterfrom
grlee77:v3-store-part6
Mar 23, 2022
Merged

Implement Zarr V3 protocol#898
joshmoore merged 121 commits into
zarr-developers:masterfrom
grlee77:v3-store-part6

Conversation

@grlee77

@grlee77grlee77 commented Dec 1, 2021

Copy link
Copy Markdown
Contributor

This PR builds on #897, adding zarr v3 support to most of the high-level convenience functions (I haven't looked at the consolidated metadata yet).

EDIT: I closed the prior v3 PRs leading up to this one as their commits are also included here along with additional bug fixes and tests.

TODO:

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/tutorial.rst
  • Changes documented in docs/release.rst
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

Define the StoreV3 class and create v3 versions of most existing stores
Add a test_storage_v3.py with test classes inheriting from their v2
counterparts. Only a subset of methods involving differences in v3
behavior were overridden.
@codecov

codecovBot commented Dec 1, 2021

Copy link
Copy Markdown

Codecov Report

Merging #898 (7aa5dff) into master (b98c799) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@ Coverage Diff @@## master #898 +/- ##
=========================================
Coverage 99.94% 99.95% =========================================
Files 32 33 +1 Lines 11256 13622 +2366 =========================================
+ Hits 11250 13616 +2366 
Misses 6 6 
Impacted FilesCoverage Δ
zarr/_storage/absstore.py100.00% <100.00%> (ø)
zarr/_storage/store.py100.00% <100.00%> (ø)
zarr/attrs.py100.00% <100.00%> (ø)
zarr/convenience.py100.00% <100.00%> (ø)
zarr/core.py100.00% <100.00%> (ø)
zarr/creation.py100.00% <100.00%> (ø)
zarr/hierarchy.py100.00% <100.00%> (ø)
zarr/meta.py100.00% <100.00%> (ø)
zarr/storage.py100.00% <100.00%> (ø)
zarr/tests/test_attrs.py100.00% <100.00%> (ø)
... and 11 more

@pep8speaks

pep8speaks commented Dec 15, 2021

Copy link
Copy Markdown

Hello @grlee77! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2022-03-11 03:47:51 UTC

@grlee77
grlee77force-pushed the v3-store-part6 branch 2 times, most recently from de243b2 to 266ab58CompareDecember 16, 2021 20:43
zarr_version should not be in the array metadata, only the base store metadata
compressor should be absent when there is no compression
No need for this class as DirectoryStoreV3 with / chunk separator can be used instead
@grlee77

Copy link
Copy Markdown
ContributorAuthor

NestedDirectoryStoreV3 has been removed as discussed above: #898 (comment)

@joshmoorejoshmoore left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking nice, @grlee77! A number of mostly aesthetic points below after an initial read. Don't think any of them are MUSTs before merging this into a dev branch. (See zarr-developers/governance#15)

The only other high-level comment, also aesthetic, is whether zarr._storage.v3 (or similar) would be appropriate earlier rather than later.

Comment threadzarr/_storage/absstore.py Outdated
self.rmdir()


def rmdir_abs(store: ABSStore, path=None):

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this not a method on the store?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure why I did it that way. I can make this ABSStore.rmdir and just call it from there in ABSStoreV3.rmdir

Comment threadzarr/_storage/absstore.py Outdated
Comment threadzarr/_storage/store.py Outdated
Comment threadzarr/_storage/store.py Outdated
Comment threadzarr/_storage/store.py Outdated
del store[key]


def _rmdir_from_keys_v3(store: StoreV3, path: str = "") -> None:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Knowing how this module is growing, is there any place relatively convenient that we could "hide" v3-specific methods?

Comment threadzarr/convenience.py
key == 'zarr.json')

# cannot create a group without a path in v3
# so create /meta/root/consolidated group to store the metadata

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use of "/meta/root/consolidated" likely needs review at the zarr-specs level.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I opened zarr-developers/zarr-specs#136 so we don't forget

Comment threadzarr/hierarchy.py Outdated
store = _normalize_store_arg(store)
store = _normalize_store_arg(store, zarr_version=zarr_version)
if zarr_version is None:
zarr_version = getattr(store, '_store_version', 2)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Worth planning now for when the default swaps from 2 to 3? Either by using a constant or by documenting the locations while you have it in mind?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I added DEFAULT_ZARR_VERSION (currently set to 2) in place of 2 in these checks.

It is intended as a constant used by developers, not something a user would set in their code to select the default version.

@joshmoore

Copy link
Copy Markdown
Member

Anything else planned from your side, @grlee77 ?

@grlee77

grlee77 commented Mar 15, 2022

Copy link
Copy Markdown
ContributorAuthor

Anything else planned from your side, @grlee77 ?

Before release we will need to decide on where we want the import path for v3 Stores to be (currently in the same file as the V2 ones). We can think about that and a possible environment variable to enable/disable v3 visibility in a followup, though.

@joshmoore

Copy link
Copy Markdown
Member

👍 for handling the refactoring and v3-switch in follow ups. As discussed during the past two community calls, getting this in to the mainline. 🎉 (And as promised for @grlee77: 🍪)

Clear warning for @zarr-developers/core-devs : the mainline is now in an unreleasable v3 state. If 2.11.x needs to go out, a dedicated v2 branch will need to be forked from a point before this merge.

See zarr-developers/governance#15 for some background.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@grlee77@pep8speaks@joshmoore
, '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

Implement Zarr V3 protocol - #898

Merged
joshmoore merged 121 commits into
zarr-developers:masterfrom
grlee77:v3-store-part6
Mar 23, 2022
Merged

Implement Zarr V3 protocol#898
joshmoore merged 121 commits into
zarr-developers:masterfrom
grlee77:v3-store-part6

Conversation

@grlee77

@grlee77grlee77 commented Dec 1, 2021

Copy link
Copy Markdown
Contributor

This PR builds on #897, adding zarr v3 support to most of the high-level convenience functions (I haven't looked at the consolidated metadata yet).

EDIT: I closed the prior v3 PRs leading up to this one as their commits are also included here along with additional bug fixes and tests.

TODO:

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/tutorial.rst
  • Changes documented in docs/release.rst
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

Define the StoreV3 class and create v3 versions of most existing stores
Add a test_storage_v3.py with test classes inheriting from their v2
counterparts. Only a subset of methods involving differences in v3
behavior were overridden.
@codecov

codecovBot commented Dec 1, 2021

Copy link
Copy Markdown

Codecov Report

Merging #898 (7aa5dff) into master (b98c799) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@ Coverage Diff @@## master #898 +/- ##
=========================================
Coverage 99.94% 99.95% =========================================
Files 32 33 +1 Lines 11256 13622 +2366 =========================================
+ Hits 11250 13616 +2366 
Misses 6 6 
Impacted FilesCoverage Δ
zarr/_storage/absstore.py100.00% <100.00%> (ø)
zarr/_storage/store.py100.00% <100.00%> (ø)
zarr/attrs.py100.00% <100.00%> (ø)
zarr/convenience.py100.00% <100.00%> (ø)
zarr/core.py100.00% <100.00%> (ø)
zarr/creation.py100.00% <100.00%> (ø)
zarr/hierarchy.py100.00% <100.00%> (ø)
zarr/meta.py100.00% <100.00%> (ø)
zarr/storage.py100.00% <100.00%> (ø)
zarr/tests/test_attrs.py100.00% <100.00%> (ø)
... and 11 more

@pep8speaks

pep8speaks commented Dec 15, 2021

Copy link
Copy Markdown

Hello @grlee77! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2022-03-11 03:47:51 UTC

@grlee77
grlee77force-pushed the v3-store-part6 branch 2 times, most recently from de243b2 to 266ab58CompareDecember 16, 2021 20:43
zarr_version should not be in the array metadata, only the base store metadata
compressor should be absent when there is no compression
No need for this class as DirectoryStoreV3 with / chunk separator can be used instead
@grlee77

Copy link
Copy Markdown
ContributorAuthor

NestedDirectoryStoreV3 has been removed as discussed above: #898 (comment)

@joshmoorejoshmoore left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking nice, @grlee77! A number of mostly aesthetic points below after an initial read. Don't think any of them are MUSTs before merging this into a dev branch. (See zarr-developers/governance#15)

The only other high-level comment, also aesthetic, is whether zarr._storage.v3 (or similar) would be appropriate earlier rather than later.

Comment threadzarr/_storage/absstore.py Outdated
self.rmdir()


def rmdir_abs(store: ABSStore, path=None):

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this not a method on the store?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure why I did it that way. I can make this ABSStore.rmdir and just call it from there in ABSStoreV3.rmdir

Comment threadzarr/_storage/absstore.py Outdated
Comment threadzarr/_storage/store.py Outdated
Comment threadzarr/_storage/store.py Outdated
Comment threadzarr/_storage/store.py Outdated
del store[key]


def _rmdir_from_keys_v3(store: StoreV3, path: str = "") -> None:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Knowing how this module is growing, is there any place relatively convenient that we could "hide" v3-specific methods?

Comment threadzarr/convenience.py
key == 'zarr.json')

# cannot create a group without a path in v3
# so create /meta/root/consolidated group to store the metadata

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use of "/meta/root/consolidated" likely needs review at the zarr-specs level.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I opened zarr-developers/zarr-specs#136 so we don't forget

Comment threadzarr/hierarchy.py Outdated
store = _normalize_store_arg(store)
store = _normalize_store_arg(store, zarr_version=zarr_version)
if zarr_version is None:
zarr_version = getattr(store, '_store_version', 2)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Worth planning now for when the default swaps from 2 to 3? Either by using a constant or by documenting the locations while you have it in mind?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I added DEFAULT_ZARR_VERSION (currently set to 2) in place of 2 in these checks.

It is intended as a constant used by developers, not something a user would set in their code to select the default version.

@joshmoore

Copy link
Copy Markdown
Member

Anything else planned from your side, @grlee77 ?

@grlee77

grlee77 commented Mar 15, 2022

Copy link
Copy Markdown
ContributorAuthor

Anything else planned from your side, @grlee77 ?

Before release we will need to decide on where we want the import path for v3 Stores to be (currently in the same file as the V2 ones). We can think about that and a possible environment variable to enable/disable v3 visibility in a followup, though.

@joshmoore

Copy link
Copy Markdown
Member

👍 for handling the refactoring and v3-switch in follow ups. As discussed during the past two community calls, getting this in to the mainline. 🎉 (And as promised for @grlee77: 🍪)

Clear warning for @zarr-developers/core-devs : the mainline is now in an unreleasable v3 state. If 2.11.x needs to go out, a dedicated v2 branch will need to be forked from a point before this merge.

See zarr-developers/governance#15 for some background.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@grlee77@pep8speaks@joshmoore
, '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

Implement Zarr V3 protocol - #898

Merged
joshmoore merged 121 commits into
zarr-developers:masterfrom
grlee77:v3-store-part6
Mar 23, 2022
Merged

Implement Zarr V3 protocol#898
joshmoore merged 121 commits into
zarr-developers:masterfrom
grlee77:v3-store-part6

Conversation

@grlee77

@grlee77grlee77 commented Dec 1, 2021

Copy link
Copy Markdown
Contributor

This PR builds on #897, adding zarr v3 support to most of the high-level convenience functions (I haven't looked at the consolidated metadata yet).

EDIT: I closed the prior v3 PRs leading up to this one as their commits are also included here along with additional bug fixes and tests.

TODO:

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/tutorial.rst
  • Changes documented in docs/release.rst
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

Define the StoreV3 class and create v3 versions of most existing stores
Add a test_storage_v3.py with test classes inheriting from their v2
counterparts. Only a subset of methods involving differences in v3
behavior were overridden.
@codecov

codecovBot commented Dec 1, 2021

Copy link
Copy Markdown

Codecov Report

Merging #898 (7aa5dff) into master (b98c799) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@ Coverage Diff @@## master #898 +/- ##
=========================================
Coverage 99.94% 99.95% =========================================
Files 32 33 +1 Lines 11256 13622 +2366 =========================================
+ Hits 11250 13616 +2366 
Misses 6 6 
Impacted FilesCoverage Δ
zarr/_storage/absstore.py100.00% <100.00%> (ø)
zarr/_storage/store.py100.00% <100.00%> (ø)
zarr/attrs.py100.00% <100.00%> (ø)
zarr/convenience.py100.00% <100.00%> (ø)
zarr/core.py100.00% <100.00%> (ø)
zarr/creation.py100.00% <100.00%> (ø)
zarr/hierarchy.py100.00% <100.00%> (ø)
zarr/meta.py100.00% <100.00%> (ø)
zarr/storage.py100.00% <100.00%> (ø)
zarr/tests/test_attrs.py100.00% <100.00%> (ø)
... and 11 more

@pep8speaks

pep8speaks commented Dec 15, 2021

Copy link
Copy Markdown

Hello @grlee77! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2022-03-11 03:47:51 UTC

@grlee77
grlee77force-pushed the v3-store-part6 branch 2 times, most recently from de243b2 to 266ab58CompareDecember 16, 2021 20:43
zarr_version should not be in the array metadata, only the base store metadata
compressor should be absent when there is no compression
No need for this class as DirectoryStoreV3 with / chunk separator can be used instead
@grlee77

Copy link
Copy Markdown
ContributorAuthor

NestedDirectoryStoreV3 has been removed as discussed above: #898 (comment)

@joshmoorejoshmoore left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking nice, @grlee77! A number of mostly aesthetic points below after an initial read. Don't think any of them are MUSTs before merging this into a dev branch. (See zarr-developers/governance#15)

The only other high-level comment, also aesthetic, is whether zarr._storage.v3 (or similar) would be appropriate earlier rather than later.

Comment threadzarr/_storage/absstore.py Outdated
self.rmdir()


def rmdir_abs(store: ABSStore, path=None):

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this not a method on the store?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure why I did it that way. I can make this ABSStore.rmdir and just call it from there in ABSStoreV3.rmdir

Comment threadzarr/_storage/absstore.py Outdated
Comment threadzarr/_storage/store.py Outdated
Comment threadzarr/_storage/store.py Outdated
Comment threadzarr/_storage/store.py Outdated
del store[key]


def _rmdir_from_keys_v3(store: StoreV3, path: str = "") -> None:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Knowing how this module is growing, is there any place relatively convenient that we could "hide" v3-specific methods?

Comment threadzarr/convenience.py
key == 'zarr.json')

# cannot create a group without a path in v3
# so create /meta/root/consolidated group to store the metadata

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use of "/meta/root/consolidated" likely needs review at the zarr-specs level.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I opened zarr-developers/zarr-specs#136 so we don't forget

Comment threadzarr/hierarchy.py Outdated
store = _normalize_store_arg(store)
store = _normalize_store_arg(store, zarr_version=zarr_version)
if zarr_version is None:
zarr_version = getattr(store, '_store_version', 2)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Worth planning now for when the default swaps from 2 to 3? Either by using a constant or by documenting the locations while you have it in mind?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I added DEFAULT_ZARR_VERSION (currently set to 2) in place of 2 in these checks.

It is intended as a constant used by developers, not something a user would set in their code to select the default version.

@joshmoore

Copy link
Copy Markdown
Member

Anything else planned from your side, @grlee77 ?

@grlee77

grlee77 commented Mar 15, 2022

Copy link
Copy Markdown
ContributorAuthor

Anything else planned from your side, @grlee77 ?

Before release we will need to decide on where we want the import path for v3 Stores to be (currently in the same file as the V2 ones). We can think about that and a possible environment variable to enable/disable v3 visibility in a followup, though.

@joshmoore

Copy link
Copy Markdown
Member

👍 for handling the refactoring and v3-switch in follow ups. As discussed during the past two community calls, getting this in to the mainline. 🎉 (And as promised for @grlee77: 🍪)

Clear warning for @zarr-developers/core-devs : the mainline is now in an unreleasable v3 state. If 2.11.x needs to go out, a dedicated v2 branch will need to be forked from a point before this merge.

See zarr-developers/governance#15 for some background.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@grlee77@pep8speaks@joshmoore
, '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

Implement Zarr V3 protocol - #898

Merged
joshmoore merged 121 commits into
zarr-developers:masterfrom
grlee77:v3-store-part6
Mar 23, 2022
Merged

Implement Zarr V3 protocol#898
joshmoore merged 121 commits into
zarr-developers:masterfrom
grlee77:v3-store-part6

Conversation

@grlee77

@grlee77grlee77 commented Dec 1, 2021

Copy link
Copy Markdown
Contributor

This PR builds on #897, adding zarr v3 support to most of the high-level convenience functions (I haven't looked at the consolidated metadata yet).

EDIT: I closed the prior v3 PRs leading up to this one as their commits are also included here along with additional bug fixes and tests.

TODO:

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/tutorial.rst
  • Changes documented in docs/release.rst
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

Define the StoreV3 class and create v3 versions of most existing stores
Add a test_storage_v3.py with test classes inheriting from their v2
counterparts. Only a subset of methods involving differences in v3
behavior were overridden.
@codecov

codecovBot commented Dec 1, 2021

Copy link
Copy Markdown

Codecov Report

Merging #898 (7aa5dff) into master (b98c799) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@ Coverage Diff @@## master #898 +/- ##
=========================================
Coverage 99.94% 99.95% =========================================
Files 32 33 +1 Lines 11256 13622 +2366 =========================================
+ Hits 11250 13616 +2366 
Misses 6 6 
Impacted FilesCoverage Δ
zarr/_storage/absstore.py100.00% <100.00%> (ø)
zarr/_storage/store.py100.00% <100.00%> (ø)
zarr/attrs.py100.00% <100.00%> (ø)
zarr/convenience.py100.00% <100.00%> (ø)
zarr/core.py100.00% <100.00%> (ø)
zarr/creation.py100.00% <100.00%> (ø)
zarr/hierarchy.py100.00% <100.00%> (ø)
zarr/meta.py100.00% <100.00%> (ø)
zarr/storage.py100.00% <100.00%> (ø)
zarr/tests/test_attrs.py100.00% <100.00%> (ø)
... and 11 more

@pep8speaks

pep8speaks commented Dec 15, 2021

Copy link
Copy Markdown

Hello @grlee77! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2022-03-11 03:47:51 UTC

@grlee77
grlee77force-pushed the v3-store-part6 branch 2 times, most recently from de243b2 to 266ab58CompareDecember 16, 2021 20:43
zarr_version should not be in the array metadata, only the base store metadata
compressor should be absent when there is no compression
No need for this class as DirectoryStoreV3 with / chunk separator can be used instead
@grlee77

Copy link
Copy Markdown
ContributorAuthor

NestedDirectoryStoreV3 has been removed as discussed above: #898 (comment)

@joshmoorejoshmoore left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking nice, @grlee77! A number of mostly aesthetic points below after an initial read. Don't think any of them are MUSTs before merging this into a dev branch. (See zarr-developers/governance#15)

The only other high-level comment, also aesthetic, is whether zarr._storage.v3 (or similar) would be appropriate earlier rather than later.

Comment threadzarr/_storage/absstore.py Outdated
self.rmdir()


def rmdir_abs(store: ABSStore, path=None):

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this not a method on the store?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure why I did it that way. I can make this ABSStore.rmdir and just call it from there in ABSStoreV3.rmdir

Comment threadzarr/_storage/absstore.py Outdated
Comment threadzarr/_storage/store.py Outdated
Comment threadzarr/_storage/store.py Outdated
Comment threadzarr/_storage/store.py Outdated
del store[key]


def _rmdir_from_keys_v3(store: StoreV3, path: str = "") -> None:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Knowing how this module is growing, is there any place relatively convenient that we could "hide" v3-specific methods?

Comment threadzarr/convenience.py
key == 'zarr.json')

# cannot create a group without a path in v3
# so create /meta/root/consolidated group to store the metadata

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use of "/meta/root/consolidated" likely needs review at the zarr-specs level.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I opened zarr-developers/zarr-specs#136 so we don't forget

Comment threadzarr/hierarchy.py Outdated
store = _normalize_store_arg(store)
store = _normalize_store_arg(store, zarr_version=zarr_version)
if zarr_version is None:
zarr_version = getattr(store, '_store_version', 2)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Worth planning now for when the default swaps from 2 to 3? Either by using a constant or by documenting the locations while you have it in mind?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I added DEFAULT_ZARR_VERSION (currently set to 2) in place of 2 in these checks.

It is intended as a constant used by developers, not something a user would set in their code to select the default version.

@joshmoore

Copy link
Copy Markdown
Member

Anything else planned from your side, @grlee77 ?

@grlee77

grlee77 commented Mar 15, 2022

Copy link
Copy Markdown
ContributorAuthor

Anything else planned from your side, @grlee77 ?

Before release we will need to decide on where we want the import path for v3 Stores to be (currently in the same file as the V2 ones). We can think about that and a possible environment variable to enable/disable v3 visibility in a followup, though.

@joshmoore

Copy link
Copy Markdown
Member

👍 for handling the refactoring and v3-switch in follow ups. As discussed during the past two community calls, getting this in to the mainline. 🎉 (And as promised for @grlee77: 🍪)

Clear warning for @zarr-developers/core-devs : the mainline is now in an unreleasable v3 state. If 2.11.x needs to go out, a dedicated v2 branch will need to be forked from a point before this merge.

See zarr-developers/governance#15 for some background.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@grlee77@pep8speaks@joshmoore
, '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

Implement Zarr V3 protocol - #898

Merged
joshmoore merged 121 commits into
zarr-developers:masterfrom
grlee77:v3-store-part6
Mar 23, 2022
Merged

Implement Zarr V3 protocol#898
joshmoore merged 121 commits into
zarr-developers:masterfrom
grlee77:v3-store-part6

Conversation

@grlee77

@grlee77grlee77 commented Dec 1, 2021

Copy link
Copy Markdown
Contributor

This PR builds on #897, adding zarr v3 support to most of the high-level convenience functions (I haven't looked at the consolidated metadata yet).

EDIT: I closed the prior v3 PRs leading up to this one as their commits are also included here along with additional bug fixes and tests.

TODO:

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/tutorial.rst
  • Changes documented in docs/release.rst
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

Define the StoreV3 class and create v3 versions of most existing stores
Add a test_storage_v3.py with test classes inheriting from their v2
counterparts. Only a subset of methods involving differences in v3
behavior were overridden.
@codecov

codecovBot commented Dec 1, 2021

Copy link
Copy Markdown

Codecov Report

Merging #898 (7aa5dff) into master (b98c799) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@ Coverage Diff @@## master #898 +/- ##
=========================================
Coverage 99.94% 99.95% =========================================
Files 32 33 +1 Lines 11256 13622 +2366 =========================================
+ Hits 11250 13616 +2366 
Misses 6 6 
Impacted FilesCoverage Δ
zarr/_storage/absstore.py100.00% <100.00%> (ø)
zarr/_storage/store.py100.00% <100.00%> (ø)
zarr/attrs.py100.00% <100.00%> (ø)
zarr/convenience.py100.00% <100.00%> (ø)
zarr/core.py100.00% <100.00%> (ø)
zarr/creation.py100.00% <100.00%> (ø)
zarr/hierarchy.py100.00% <100.00%> (ø)
zarr/meta.py100.00% <100.00%> (ø)
zarr/storage.py100.00% <100.00%> (ø)
zarr/tests/test_attrs.py100.00% <100.00%> (ø)
... and 11 more

@pep8speaks

pep8speaks commented Dec 15, 2021

Copy link
Copy Markdown

Hello @grlee77! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2022-03-11 03:47:51 UTC

@grlee77
grlee77force-pushed the v3-store-part6 branch 2 times, most recently from de243b2 to 266ab58CompareDecember 16, 2021 20:43
zarr_version should not be in the array metadata, only the base store metadata
compressor should be absent when there is no compression
No need for this class as DirectoryStoreV3 with / chunk separator can be used instead
@grlee77

Copy link
Copy Markdown
ContributorAuthor

NestedDirectoryStoreV3 has been removed as discussed above: #898 (comment)

@joshmoorejoshmoore left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking nice, @grlee77! A number of mostly aesthetic points below after an initial read. Don't think any of them are MUSTs before merging this into a dev branch. (See zarr-developers/governance#15)

The only other high-level comment, also aesthetic, is whether zarr._storage.v3 (or similar) would be appropriate earlier rather than later.

Comment threadzarr/_storage/absstore.py Outdated
self.rmdir()


def rmdir_abs(store: ABSStore, path=None):

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this not a method on the store?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure why I did it that way. I can make this ABSStore.rmdir and just call it from there in ABSStoreV3.rmdir

Comment threadzarr/_storage/absstore.py Outdated
Comment threadzarr/_storage/store.py Outdated
Comment threadzarr/_storage/store.py Outdated
Comment threadzarr/_storage/store.py Outdated
del store[key]


def _rmdir_from_keys_v3(store: StoreV3, path: str = "") -> None:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Knowing how this module is growing, is there any place relatively convenient that we could "hide" v3-specific methods?

Comment threadzarr/convenience.py
key == 'zarr.json')

# cannot create a group without a path in v3
# so create /meta/root/consolidated group to store the metadata

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use of "/meta/root/consolidated" likely needs review at the zarr-specs level.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I opened zarr-developers/zarr-specs#136 so we don't forget

Comment threadzarr/hierarchy.py Outdated
store = _normalize_store_arg(store)
store = _normalize_store_arg(store, zarr_version=zarr_version)
if zarr_version is None:
zarr_version = getattr(store, '_store_version', 2)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Worth planning now for when the default swaps from 2 to 3? Either by using a constant or by documenting the locations while you have it in mind?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I added DEFAULT_ZARR_VERSION (currently set to 2) in place of 2 in these checks.

It is intended as a constant used by developers, not something a user would set in their code to select the default version.

@joshmoore

Copy link
Copy Markdown
Member

Anything else planned from your side, @grlee77 ?

@grlee77

grlee77 commented Mar 15, 2022

Copy link
Copy Markdown
ContributorAuthor

Anything else planned from your side, @grlee77 ?

Before release we will need to decide on where we want the import path for v3 Stores to be (currently in the same file as the V2 ones). We can think about that and a possible environment variable to enable/disable v3 visibility in a followup, though.

@joshmoore

Copy link
Copy Markdown
Member

👍 for handling the refactoring and v3-switch in follow ups. As discussed during the past two community calls, getting this in to the mainline. 🎉 (And as promised for @grlee77: 🍪)

Clear warning for @zarr-developers/core-devs : the mainline is now in an unreleasable v3 state. If 2.11.x needs to go out, a dedicated v2 branch will need to be forked from a point before this merge.

See zarr-developers/governance#15 for some background.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@grlee77@pep8speaks@joshmoore
, '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

Implement Zarr V3 protocol - #898

Merged
joshmoore merged 121 commits into
zarr-developers:masterfrom
grlee77:v3-store-part6
Mar 23, 2022
Merged

Implement Zarr V3 protocol#898
joshmoore merged 121 commits into
zarr-developers:masterfrom
grlee77:v3-store-part6

Conversation

@grlee77

@grlee77grlee77 commented Dec 1, 2021

Copy link
Copy Markdown
Contributor

This PR builds on #897, adding zarr v3 support to most of the high-level convenience functions (I haven't looked at the consolidated metadata yet).

EDIT: I closed the prior v3 PRs leading up to this one as their commits are also included here along with additional bug fixes and tests.

TODO:

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/tutorial.rst
  • Changes documented in docs/release.rst
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

Define the StoreV3 class and create v3 versions of most existing stores
Add a test_storage_v3.py with test classes inheriting from their v2
counterparts. Only a subset of methods involving differences in v3
behavior were overridden.
@codecov

codecovBot commented Dec 1, 2021

Copy link
Copy Markdown

Codecov Report

Merging #898 (7aa5dff) into master (b98c799) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@ Coverage Diff @@## master #898 +/- ##
=========================================
Coverage 99.94% 99.95% =========================================
Files 32 33 +1 Lines 11256 13622 +2366 =========================================
+ Hits 11250 13616 +2366 
Misses 6 6 
Impacted FilesCoverage Δ
zarr/_storage/absstore.py100.00% <100.00%> (ø)
zarr/_storage/store.py100.00% <100.00%> (ø)
zarr/attrs.py100.00% <100.00%> (ø)
zarr/convenience.py100.00% <100.00%> (ø)
zarr/core.py100.00% <100.00%> (ø)
zarr/creation.py100.00% <100.00%> (ø)
zarr/hierarchy.py100.00% <100.00%> (ø)
zarr/meta.py100.00% <100.00%> (ø)
zarr/storage.py100.00% <100.00%> (ø)
zarr/tests/test_attrs.py100.00% <100.00%> (ø)
... and 11 more

@pep8speaks

pep8speaks commented Dec 15, 2021

Copy link
Copy Markdown

Hello @grlee77! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2022-03-11 03:47:51 UTC

@grlee77
grlee77force-pushed the v3-store-part6 branch 2 times, most recently from de243b2 to 266ab58CompareDecember 16, 2021 20:43
zarr_version should not be in the array metadata, only the base store metadata
compressor should be absent when there is no compression
No need for this class as DirectoryStoreV3 with / chunk separator can be used instead
@grlee77

Copy link
Copy Markdown
ContributorAuthor

NestedDirectoryStoreV3 has been removed as discussed above: #898 (comment)

@joshmoorejoshmoore left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking nice, @grlee77! A number of mostly aesthetic points below after an initial read. Don't think any of them are MUSTs before merging this into a dev branch. (See zarr-developers/governance#15)

The only other high-level comment, also aesthetic, is whether zarr._storage.v3 (or similar) would be appropriate earlier rather than later.

Comment threadzarr/_storage/absstore.py Outdated
self.rmdir()


def rmdir_abs(store: ABSStore, path=None):

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this not a method on the store?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure why I did it that way. I can make this ABSStore.rmdir and just call it from there in ABSStoreV3.rmdir

Comment threadzarr/_storage/absstore.py Outdated
Comment threadzarr/_storage/store.py Outdated
Comment threadzarr/_storage/store.py Outdated
Comment threadzarr/_storage/store.py Outdated
del store[key]


def _rmdir_from_keys_v3(store: StoreV3, path: str = "") -> None:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Knowing how this module is growing, is there any place relatively convenient that we could "hide" v3-specific methods?

Comment threadzarr/convenience.py
key == 'zarr.json')

# cannot create a group without a path in v3
# so create /meta/root/consolidated group to store the metadata

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use of "/meta/root/consolidated" likely needs review at the zarr-specs level.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I opened zarr-developers/zarr-specs#136 so we don't forget

Comment threadzarr/hierarchy.py Outdated
store = _normalize_store_arg(store)
store = _normalize_store_arg(store, zarr_version=zarr_version)
if zarr_version is None:
zarr_version = getattr(store, '_store_version', 2)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Worth planning now for when the default swaps from 2 to 3? Either by using a constant or by documenting the locations while you have it in mind?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I added DEFAULT_ZARR_VERSION (currently set to 2) in place of 2 in these checks.

It is intended as a constant used by developers, not something a user would set in their code to select the default version.

@joshmoore

Copy link
Copy Markdown
Member

Anything else planned from your side, @grlee77 ?

@grlee77

grlee77 commented Mar 15, 2022

Copy link
Copy Markdown
ContributorAuthor

Anything else planned from your side, @grlee77 ?

Before release we will need to decide on where we want the import path for v3 Stores to be (currently in the same file as the V2 ones). We can think about that and a possible environment variable to enable/disable v3 visibility in a followup, though.

@joshmoore

Copy link
Copy Markdown
Member

👍 for handling the refactoring and v3-switch in follow ups. As discussed during the past two community calls, getting this in to the mainline. 🎉 (And as promised for @grlee77: 🍪)

Clear warning for @zarr-developers/core-devs : the mainline is now in an unreleasable v3 state. If 2.11.x needs to go out, a dedicated v2 branch will need to be forked from a point before this merge.

See zarr-developers/governance#15 for some background.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@grlee77@pep8speaks@joshmoore
, '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

Implement Zarr V3 protocol - #898

Merged
joshmoore merged 121 commits into
zarr-developers:masterfrom
grlee77:v3-store-part6
Mar 23, 2022
Merged

Implement Zarr V3 protocol#898
joshmoore merged 121 commits into
zarr-developers:masterfrom
grlee77:v3-store-part6

Conversation

@grlee77

@grlee77grlee77 commented Dec 1, 2021

Copy link
Copy Markdown
Contributor

This PR builds on #897, adding zarr v3 support to most of the high-level convenience functions (I haven't looked at the consolidated metadata yet).

EDIT: I closed the prior v3 PRs leading up to this one as their commits are also included here along with additional bug fixes and tests.

TODO:

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/tutorial.rst
  • Changes documented in docs/release.rst
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

Define the StoreV3 class and create v3 versions of most existing stores
Add a test_storage_v3.py with test classes inheriting from their v2
counterparts. Only a subset of methods involving differences in v3
behavior were overridden.
@codecov

codecovBot commented Dec 1, 2021

Copy link
Copy Markdown

Codecov Report

Merging #898 (7aa5dff) into master (b98c799) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@ Coverage Diff @@## master #898 +/- ##
=========================================
Coverage 99.94% 99.95% =========================================
Files 32 33 +1 Lines 11256 13622 +2366 =========================================
+ Hits 11250 13616 +2366 
Misses 6 6 
Impacted FilesCoverage Δ
zarr/_storage/absstore.py100.00% <100.00%> (ø)
zarr/_storage/store.py100.00% <100.00%> (ø)
zarr/attrs.py100.00% <100.00%> (ø)
zarr/convenience.py100.00% <100.00%> (ø)
zarr/core.py100.00% <100.00%> (ø)
zarr/creation.py100.00% <100.00%> (ø)
zarr/hierarchy.py100.00% <100.00%> (ø)
zarr/meta.py100.00% <100.00%> (ø)
zarr/storage.py100.00% <100.00%> (ø)
zarr/tests/test_attrs.py100.00% <100.00%> (ø)
... and 11 more

@pep8speaks

pep8speaks commented Dec 15, 2021

Copy link
Copy Markdown

Hello @grlee77! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2022-03-11 03:47:51 UTC

@grlee77
grlee77force-pushed the v3-store-part6 branch 2 times, most recently from de243b2 to 266ab58CompareDecember 16, 2021 20:43
zarr_version should not be in the array metadata, only the base store metadata
compressor should be absent when there is no compression
No need for this class as DirectoryStoreV3 with / chunk separator can be used instead
@grlee77

Copy link
Copy Markdown
ContributorAuthor

NestedDirectoryStoreV3 has been removed as discussed above: #898 (comment)

@joshmoorejoshmoore left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking nice, @grlee77! A number of mostly aesthetic points below after an initial read. Don't think any of them are MUSTs before merging this into a dev branch. (See zarr-developers/governance#15)

The only other high-level comment, also aesthetic, is whether zarr._storage.v3 (or similar) would be appropriate earlier rather than later.

Comment threadzarr/_storage/absstore.py Outdated
self.rmdir()


def rmdir_abs(store: ABSStore, path=None):

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this not a method on the store?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure why I did it that way. I can make this ABSStore.rmdir and just call it from there in ABSStoreV3.rmdir

Comment threadzarr/_storage/absstore.py Outdated
Comment threadzarr/_storage/store.py Outdated
Comment threadzarr/_storage/store.py Outdated
Comment threadzarr/_storage/store.py Outdated
del store[key]


def _rmdir_from_keys_v3(store: StoreV3, path: str = "") -> None:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Knowing how this module is growing, is there any place relatively convenient that we could "hide" v3-specific methods?

Comment threadzarr/convenience.py
key == 'zarr.json')

# cannot create a group without a path in v3
# so create /meta/root/consolidated group to store the metadata

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use of "/meta/root/consolidated" likely needs review at the zarr-specs level.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I opened zarr-developers/zarr-specs#136 so we don't forget

Comment threadzarr/hierarchy.py Outdated
store = _normalize_store_arg(store)
store = _normalize_store_arg(store, zarr_version=zarr_version)
if zarr_version is None:
zarr_version = getattr(store, '_store_version', 2)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Worth planning now for when the default swaps from 2 to 3? Either by using a constant or by documenting the locations while you have it in mind?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I added DEFAULT_ZARR_VERSION (currently set to 2) in place of 2 in these checks.

It is intended as a constant used by developers, not something a user would set in their code to select the default version.

@joshmoore

Copy link
Copy Markdown
Member

Anything else planned from your side, @grlee77 ?

@grlee77

grlee77 commented Mar 15, 2022

Copy link
Copy Markdown
ContributorAuthor

Anything else planned from your side, @grlee77 ?

Before release we will need to decide on where we want the import path for v3 Stores to be (currently in the same file as the V2 ones). We can think about that and a possible environment variable to enable/disable v3 visibility in a followup, though.

@joshmoore

Copy link
Copy Markdown
Member

👍 for handling the refactoring and v3-switch in follow ups. As discussed during the past two community calls, getting this in to the mainline. 🎉 (And as promised for @grlee77: 🍪)

Clear warning for @zarr-developers/core-devs : the mainline is now in an unreleasable v3 state. If 2.11.x needs to go out, a dedicated v2 branch will need to be forked from a point before this merge.

See zarr-developers/governance#15 for some background.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@grlee77@pep8speaks@joshmoore