Add filesystem parameter to cf.read as pass-through to cfdm.read (Part 1)#932
Merged
davidhassell merged 4 commits intomainfrom Mar 19, 2026
Merged
Conversation
Co-authored-by: bnlawrence <1792815+bnlawrence@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] [931] Add filesystem parameter to cf.read for forwarding
Add Mar 16, 2026
filesystem parameter to cf.read as pass-through to cfdm.read
davidhassell
requested changes
Mar 17, 2026
Collaborator
davidhassell
left a comment
There was a problem hiding this comment.
All good, once the docstring bit is removed.
Also, could we add to the Changelog, after the **2026-??-??** line:
* New keyword to `cf.read`: ``filesystem``
(https://github.com/NCAS-CMS/cf-python/issues/931)
Thanks!
davidhassell
approved these changes
Mar 18, 2026
Collaborator
davidhassell
left a comment
There was a problem hiding this comment.
Good to go, once NCAS-CMS/cfdm#393 is merged.
filesystem parameter to cf.read as pass-through to cfdm.readfilesystem parameter to cf.read as pass-through to cfdm.read (Part 1)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Exposes the new
filesystemkeyword from cfdm PR #393 at thecf.readlevel. All logic lives in cfdm; this is purely a wrapper update.Changes
cf/read_write/read.py— addsfilesystem=Nonetocf.read.__new__signature and documents it via template reference in the docstring. Forwarding is handled by the existingkwargs = locals()/super().__new__(**kwargs)mechanism — no new logic required.cf/docstring/docstring.py— adds the{{read filesystem: optional}}substitution definition (mirrors the cfdm PR definition; can be dropped once a cfdm release includes it, as cfdm templates take precedence).Usage
NEXTVERSIONplaceholders in the docstrings follow the same convention used in the prerequisite cfdm PR and will be resolved at release time.💬 Send tasks to Copilot coding agent from Slack and Teams to turn conversations into code. Copilot posts an update in your thread when it's finished.