@@ -7,17 +7,17 @@ User Functions
77--------------
88
99.. autosummary ::
10- fsspec. available_compressions
11- fsspec. available_protocols
12- fsspec. filesystem
13- fsspec. fuse.run
14- fsspec. generic.rsync
15- fsspec. get_filesystem_class
16- fsspec. get_mapper
17- fsspec. gui.FileSelector
18- fsspec. open
19- fsspec. open_files
20- fsspec. open_local
10+ available_compressions
11+ available_protocols
12+ filesystem
13+ fuse.run
14+ generic.rsync
15+ get_filesystem_class
16+ get_mapper
17+ gui.FileSelector
18+ open
19+ open_files
20+ open_local
2121
2222.. autofunction :: fsspec.available_compressions
2323.. autofunction :: fsspec.available_protocols
@@ -36,24 +36,24 @@ Base Classes
3636------------
3737
3838.. autosummary ::
39- fsspec. archive.AbstractArchiveFileSystem
40- fsspec. asyn.AsyncFileSystem
41- fsspec. callbacks.Callback
42- fsspec. callbacks.DotPrinterCallback
43- fsspec. callbacks.NoOpCallback
44- fsspec. callbacks.TqdmCallback
45- fsspec. core.BaseCache
46- fsspec. core.OpenFile
47- fsspec. core.OpenFiles
48- fsspec. core.get_fs_token_paths
49- fsspec. core.url_to_fs
50- fsspec. dircache.DirCache
51- fsspec. FSMap
52- fsspec. generic.GenericFileSystem
53- fsspec. registry.register_implementation
54- fsspec. spec.AbstractBufferedFile
55- fsspec. spec.AbstractFileSystem
56- fsspec. spec.Transaction
39+ archive.AbstractArchiveFileSystem
40+ asyn.AsyncFileSystem
41+ callbacks.Callback
42+ callbacks.DotPrinterCallback
43+ callbacks.NoOpCallback
44+ callbacks.TqdmCallback
45+ core.BaseCache
46+ core.OpenFile
47+ core.OpenFiles
48+ core.get_fs_token_paths
49+ core.url_to_fs
50+ dircache.DirCache
51+ FSMap
52+ generic.GenericFileSystem
53+ registry.register_implementation
54+ spec.AbstractBufferedFile
55+ spec.AbstractFileSystem
56+ spec.Transaction
5757
5858.. autoclass :: fsspec.archive.AbstractArchiveFileSystem
5959 :members:
@@ -107,30 +107,31 @@ Built-in Implementations
107107------------------------
108108
109109.. autosummary ::
110- fsspec.implementations.arrow.ArrowFSWrapper
111- fsspec.implementations.arrow.HadoopFileSystem
112- fsspec.implementations.cached.CachingFileSystem
113- fsspec.implementations.cached.SimpleCacheFileSystem
114- fsspec.implementations.cached.WholeFileCacheFileSystem
115- fsspec.implementations.dask.DaskWorkerFileSystem
116- fsspec.implementations.data.DataFileSystem
117- fsspec.implementations.dbfs.DatabricksFileSystem
118- fsspec.implementations.dirfs.DirFileSystem
119- fsspec.implementations.ftp.FTPFileSystem
120- fsspec.implementations.git.GitFileSystem
121- fsspec.implementations.github.GithubFileSystem
122- fsspec.implementations.http.HTTPFileSystem
123- fsspec.implementations.jupyter.JupyterFileSystem
124- fsspec.implementations.libarchive.LibArchiveFileSystem
125- fsspec.implementations.local.LocalFileSystem
126- fsspec.implementations.memory.MemoryFileSystem
127- fsspec.implementations.reference.ReferenceFileSystem
128- fsspec.implementations.reference.LazyReferenceMapper
129- fsspec.implementations.sftp.SFTPFileSystem
130- fsspec.implementations.smb.SMBFileSystem
131- fsspec.implementations.tar.TarFileSystem
132- fsspec.implementations.webhdfs.WebHDFS
133- fsspec.implementations.zip.ZipFileSystem
110+ implementations.arrow.ArrowFSWrapper
111+ implementations.arrow.HadoopFileSystem
112+ implementations.cached.CachingFileSystem
113+ implementations.cached.SimpleCacheFileSystem
114+ implementations.cached.WholeFileCacheFileSystem
115+ implementations.dask.DaskWorkerFileSystem
116+ implementations.data.DataFileSystem
117+ implementations.dbfs.DatabricksFileSystem
118+ implementations.dirfs.DirFileSystem
119+ implementations.ftp.FTPFileSystem
120+ implementations.gist.GistFileSystem
121+ implementations.git.GitFileSystem
122+ implementations.github.GithubFileSystem
123+ implementations.http.HTTPFileSystem
124+ implementations.jupyter.JupyterFileSystem
125+ implementations.libarchive.LibArchiveFileSystem
126+ implementations.local.LocalFileSystem
127+ implementations.memory.MemoryFileSystem
128+ implementations.reference.ReferenceFileSystem
129+ implementations.reference.LazyReferenceMapper
130+ implementations.sftp.SFTPFileSystem
131+ implementations.smb.SMBFileSystem
132+ implementations.tar.TarFileSystem
133+ implementations.webhdfs.WebHDFS
134+ implementations.zip.ZipFileSystem
134135
135136.. autoclass :: fsspec.implementations.arrow.ArrowFSWrapper
136137 :members: __init__
@@ -162,6 +163,9 @@ Built-in Implementations
162163.. autoclass :: fsspec.implementations.ftp.FTPFileSystem
163164 :members: __init__
164165
166+ .. autoclass :: fsspec.implementations.gist.GistFileSystem
167+ :members: __init__
168+
165169.. autoclass :: fsspec.implementations.git.GitFileSystem
166170 :members: __init__
167171
@@ -231,6 +235,7 @@ documentation carefully before using any particular package.
231235- `irods `_ for access to iRODS servers, with protocol "irods://"
232236- `lakefs `_ for lakeFS data lakes, with protocol "lakefs://"
233237- `morefs `_ for `OverlayFileSystem `, `DictFileSystem `, and others
238+ - `obstore `_: zero-dependency access to Amazon S3, Google Cloud Storage, and Azure Blob Storage using the underlying Rust `object_store `_ library, with protocols "s3://", "gs://", and "abfs://".
234239- `ocifs `_ for access to Oracle Cloud Object Storage, with protocol "oci://"
235240- `ocilake `_ for OCI Data Lake storage
236241- `ossfs `_ for Alibaba Cloud (Aliyun) Object Storage System (OSS)
@@ -246,6 +251,7 @@ documentation carefully before using any particular package.
246251- `wandbfsspec `_ to access Weights & Biases (experimental)
247252- `webdav4 `_ for WebDAV, with protocol "webdav://" or "dav://"
248253- `xrootd `_ for xrootd, with protocol "root://"
254+ - `msgraphfs `_ for Microsoft storage (ie Sharepoint) using the drive API through Microsoft Graph, with protocol "msgd://"
249255
250256.. _abfs : https://github.com/dask/adlfs
251257.. _adl : https://github.com/dask/adlfs
@@ -266,6 +272,8 @@ documentation carefully before using any particular package.
266272.. _irods : https://github.com/xwcl/irods_fsspec
267273.. _lakefs : https://github.com/aai-institute/lakefs-spec
268274.. _morefs : https://github.com/iterative/morefs
275+ .. _object_store : https://docs.rs/object_store/latest/object_store/
276+ .. _obstore : https://developmentseed.org/obstore/latest/
269277.. _ocifs : https://ocifs.readthedocs.io/en/latest/
270278.. _ocilake : https://github.com/oracle/ocifs
271279.. _ossfs : https://github.com/fsspec/ossfs
@@ -280,19 +288,20 @@ documentation carefully before using any particular package.
280288.. _wandbfsspec : https://github.com/alvarobartt/wandbfsspec
281289.. _webdav4 : https://github.com/skshetry/webdav4
282290.. _xrootd : https://github.com/CoffeaTeam/fsspec-xrootd
291+ .. _msgraphfs : https://github.com/acsone/msgraphfs
283292
284293.. _readbuffering :
285294
286295Read Buffering
287296--------------
288297
289298.. autosummary ::
290- fsspec. caching.BlockCache
291- fsspec. caching.BytesCache
292- fsspec. caching.MMapCache
293- fsspec. caching.ReadAheadCache
294- fsspec. caching.FirstChunkCache
295- fsspec. caching.BackgroundBlockCache
299+ caching.BlockCache
300+ caching.BytesCache
301+ caching.MMapCache
302+ caching.ReadAheadCache
303+ caching.FirstChunkCache
304+ caching.BackgroundBlockCache
296305
297306.. autoclass :: fsspec.caching.BlockCache
298307 :members:
@@ -317,7 +326,7 @@ Utilities
317326
318327.. autosummary ::
319328
320- fsspec. utils.read_block
329+ utils.read_block
321330
322331.. autofunction :: fsspec.utils.read_block
323332
0 commit comments