Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions cf/docstring/docstring.py
Original file line number Diff line number Diff line change
Expand Up @@ -686,4 +686,19 @@
The subspace is the smallest hyperrectangular
subspace that contains all of the selected
locations.""",
# read filesystem
"{{read filesystem: optional}}": """filesystem: optional
A pre-authenticated filesystem object (for example an
``fsspec`` filesystem instance) to use for opening the
dataset. When provided, *datasets* values are treated as
paths understood by *filesystem*, and local string
pre-processing (tilde/variable expansion, globbing and
directory walking) is bypassed. The file is opened by
calling ``filesystem.open(dataset, "rb")``, which returns
a file-like object that is passed to the netCDF backend.

If `None` (the default) then the existing file-opening
logic is used.

.. versionadded:: NEXTVERSION""",
Comment thread
davidhassell marked this conversation as resolved.
Outdated
}
5 changes: 5 additions & 0 deletions cf/read_write/read.py
Original file line number Diff line number Diff line change
Expand Up @@ -336,6 +336,10 @@ class read(cfdm.read):

.. versionadded:: 3.19.0

{{read filesystem: optional}}

.. versionadded:: NEXTVERSION

umversion: deprecated at version 3.0.0
Use the *um* parameter instead.

Expand Down Expand Up @@ -455,6 +459,7 @@ def __new__(
fmt=None,
file_type=None,
group_dimension_search="closest_ancestor",
filesystem=None,
):
"""Read field or domain constructs from a dataset."""
kwargs = locals()
Expand Down