@@ -7,17 +7,17 @@ User Functions
7
7
--------------
8
8
9
9
.. 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
21
21
22
22
.. autofunction :: fsspec.available_compressions
23
23
.. autofunction :: fsspec.available_protocols
@@ -36,24 +36,24 @@ Base Classes
36
36
------------
37
37
38
38
.. 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
57
57
58
58
.. autoclass :: fsspec.archive.AbstractArchiveFileSystem
59
59
:members:
@@ -107,30 +107,31 @@ Built-in Implementations
107
107
------------------------
108
108
109
109
.. 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
134
135
135
136
.. autoclass :: fsspec.implementations.arrow.ArrowFSWrapper
136
137
:members: __init__
@@ -162,6 +163,9 @@ Built-in Implementations
162
163
.. autoclass :: fsspec.implementations.ftp.FTPFileSystem
163
164
:members: __init__
164
165
166
+ .. autoclass :: fsspec.implementations.gist.GistFileSystem
167
+ :members: __init__
168
+
165
169
.. autoclass :: fsspec.implementations.git.GitFileSystem
166
170
:members: __init__
167
171
@@ -231,6 +235,7 @@ documentation carefully before using any particular package.
231
235
- `irods `_ for access to iRODS servers, with protocol "irods://"
232
236
- `lakefs `_ for lakeFS data lakes, with protocol "lakefs://"
233
237
- `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://".
234
239
- `ocifs `_ for access to Oracle Cloud Object Storage, with protocol "oci://"
235
240
- `ocilake `_ for OCI Data Lake storage
236
241
- `ossfs `_ for Alibaba Cloud (Aliyun) Object Storage System (OSS)
@@ -246,6 +251,7 @@ documentation carefully before using any particular package.
246
251
- `wandbfsspec `_ to access Weights & Biases (experimental)
247
252
- `webdav4 `_ for WebDAV, with protocol "webdav://" or "dav://"
248
253
- `xrootd `_ for xrootd, with protocol "root://"
254
+ - `msgraphfs `_ for Microsoft storage (ie Sharepoint) using the drive API through Microsoft Graph, with protocol "msgd://"
249
255
250
256
.. _abfs : https://github.com/dask/adlfs
251
257
.. _adl : https://github.com/dask/adlfs
@@ -266,6 +272,8 @@ documentation carefully before using any particular package.
266
272
.. _irods : https://github.com/xwcl/irods_fsspec
267
273
.. _lakefs : https://github.com/aai-institute/lakefs-spec
268
274
.. _morefs : https://github.com/iterative/morefs
275
+ .. _object_store : https://docs.rs/object_store/latest/object_store/
276
+ .. _obstore : https://developmentseed.org/obstore/latest/
269
277
.. _ocifs : https://ocifs.readthedocs.io/en/latest/
270
278
.. _ocilake : https://github.com/oracle/ocifs
271
279
.. _ossfs : https://github.com/fsspec/ossfs
@@ -280,19 +288,20 @@ documentation carefully before using any particular package.
280
288
.. _wandbfsspec : https://github.com/alvarobartt/wandbfsspec
281
289
.. _webdav4 : https://github.com/skshetry/webdav4
282
290
.. _xrootd : https://github.com/CoffeaTeam/fsspec-xrootd
291
+ .. _msgraphfs : https://github.com/acsone/msgraphfs
283
292
284
293
.. _readbuffering :
285
294
286
295
Read Buffering
287
296
--------------
288
297
289
298
.. 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
296
305
297
306
.. autoclass :: fsspec.caching.BlockCache
298
307
:members:
@@ -317,7 +326,7 @@ Utilities
317
326
318
327
.. autosummary ::
319
328
320
- fsspec. utils.read_block
329
+ utils.read_block
321
330
322
331
.. autofunction :: fsspec.utils.read_block
323
332
0 commit comments