docs: Update tutorials for DataJoint 2.0 and add deferred schema how-to guide #1327
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Remove unused RowList and PrimaryKeyList type aliases - Change list to list[Any] in Restriction type - Use TYPE_CHECKING instead of 'if False:' for conditional import - Remove redundant isinstance check in is_remote_url (type annotation guarantees str) Co-Authored-By: Claude Opus 4.5 <[email protected]>
The from_json method can pass None for timestamp when it's missing from the data, so the type annotation should be datetime | None. Co-Authored-By: Claude Opus 4.5 <[email protected]>
Implements unified URL handling for all storage backends including local files: - Add URL_PROTOCOLS tuple including file:// - Add is_url() to check if path is a URL - Add normalize_to_url() to convert local paths to file:// URLs - Add parse_url() to parse any URL into protocol and path - Add StorageBackend.get_url() to return full URLs for any backend - Add comprehensive unit tests for URL functions This enables consistent internal representation across all storage types, aligning with fsspec's unified approach to filesystems. Closes #1326 Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Update dj-top.ipynb and json.ipynb for 2.0 API changes:
- Replace fetch("KEY") with keys()
- Replace fetch(as_dict=True) with to_dicts()
- Replace fetch(column) with to_arrays(column)
- Add schema cleanup at start of tutorials for re-runnability
- Add datajoint.json and .secrets/ to .gitignore for local config
- Add deferred schema activation how-to guide
- Update mkdocs.yaml with How-To Guides section
Co-Authored-By: Claude Opus 4.5 <[email protected]>
github-actions
bot
added
enhancement
- dj-top.ipynb → datajoint-docs 04-queries.ipynb (dj.Top section) - json.ipynb → datajoint-docs advanced/json-type.ipynb Co-Authored-By: Claude Opus 4.5 <[email protected]>
Member
Author
|
Closing without merge. This PR had several mistakes and the important functionality was re-implemented in #1328. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds documentation for deferred schema activation and removes migrated tutorials from the archive.
New Documentation
Added How-To Guide: Deferred Schema Activation (
docs/src/how-to/deferred-schema-activation.md):is_activated()check andactivate()method usageArchive Cleanup
Removed
docs/src/archive/tutorials/directory:dj-top.ipynb- migrated to datajoint-docsjson.ipynb- migrated to datajoint-docsConfiguration Updates
datajoint.jsonand.secrets/to.gitignorefor local database credentialsdocs/mkdocs.yamlwith How-To Guides navigation sectionTest Plan
src/datajoint/schemas.pyimplementation🤖 Generated with Claude Code