@@ -7,235 +7,234 @@ User Functions
77--------------
88
99.. autosummary::
10- fsspec.open_files
11- fsspec.open
12- fsspec.open_local
1310 fsspec.available_compressions
1411 fsspec.available_protocols
1512 fsspec.filesystem
13+ fsspec.fuse.run
14+ fsspec.generic.rsync
1615 fsspec.get_filesystem_class
1716 fsspec.get_mapper
18- fsspec.fuse.run
1917 fsspec.gui.FileSelector
20- fsspec.generic.rsync
18+ fsspec.open
19+ fsspec.open_files
20+ fsspec.open_local
2121
22- .. autofunction:: fsspec.open_files
23- .. autofunction:: fsspec.open
24- .. autofunction:: fsspec.open_local
2522.. autofunction:: fsspec.available_compressions
2623.. autofunction:: fsspec.available_protocols
2724.. autofunction:: fsspec.filesystem
25+ .. autofunction:: fsspec.fuse.run
26+ .. autofunction:: fsspec.generic.rsync
2827.. autofunction:: fsspec.get_filesystem_class
2928.. autofunction:: fsspec.get_mapper
30- .. autofunction:: fsspec.fuse.run
3129.. autoclass:: fsspec.gui.FileSelector
3230 :members:
33- .. autofunction:: fsspec.generic.rsync
31+ .. autofunction:: fsspec.open
32+ .. autofunction:: fsspec.open_files
33+ .. autofunction:: fsspec.open_local
3434
3535Base Classes
3636------------
3737
3838.. autosummary::
39- fsspec.spec.AbstractFileSystem
40- fsspec.spec.Transaction
41- fsspec.spec.AbstractBufferedFile
4239 fsspec.archive.AbstractArchiveFileSystem
43- fsspec.FSMap
4440 fsspec.asyn.AsyncFileSystem
41+ fsspec.callbacks.Callback
42+ fsspec.callbacks.DotPrinterCallback
43+ fsspec.callbacks.NoOpCallback
44+ fsspec.callbacks.TqdmCallback
45+ fsspec.core.BaseCache
4546 fsspec.core.OpenFile
4647 fsspec.core.OpenFiles
47- fsspec.core.BaseCache
4848 fsspec.core.get_fs_token_paths
4949 fsspec.core.url_to_fs
5050 fsspec.dircache.DirCache
51- fsspec.registry.register_implementation
52- fsspec.callbacks.Callback
53- fsspec.callbacks.NoOpCallback
54- fsspec.callbacks.DotPrinterCallback
55- fsspec.callbacks.TqdmCallback
51+ fsspec.FSMap
5652 fsspec.generic.GenericFileSystem
53+ fsspec.registry.register_implementation
54+ fsspec.spec.AbstractBufferedFile
55+ fsspec.spec.AbstractFileSystem
56+ fsspec.spec.Transaction
5757
58- .. autoclass:: fsspec.spec.AbstractFileSystem
58+ .. autoclass:: fsspec.archive.AbstractArchiveFileSystem
5959 :members:
6060
61- .. autoclass:: fsspec.spec.Transaction
61+ .. autoclass:: fsspec.callbacks.Callback
6262 :members:
6363
64- .. autoclass:: fsspec.spec.AbstractBufferedFile
64+ .. autoclass:: fsspec.callbacks.DotPrinterCallback
6565 :members:
6666
67- .. autoclass:: fsspec.archive.AbstractArchiveFileSystem
67+ .. autoclass:: fsspec.callbacks.NoOpCallback
6868 :members:
6969
70- .. autoclass:: fsspec.FSMap
70+ .. autoclass:: fsspec.callbacks.TqdmCallback
71+ :members:
72+
73+ .. autoclass:: fsspec.core.BaseCache
7174 :members:
7275
7376.. autoclass:: fsspec.core.OpenFile
7477 :members:
7578
7679.. autoclass:: fsspec.core.OpenFiles
7780
78- .. autoclass:: fsspec.core.BaseCache
79- :members:
80-
8181.. autofunction:: fsspec.core.get_fs_token_paths
8282
8383.. autofunction:: fsspec.core.url_to_fs
8484
8585.. autoclass:: fsspec.dircache.DirCache
8686 :members: __init__
8787
88- .. autofunction:: fsspec.registry.register_implementation
89-
90- .. autoclass:: fsspec.callbacks.Callback
88+ .. autoclass:: fsspec.FSMap
9189 :members:
9290
93- .. autoclass:: fsspec.callbacks.NoOpCallback
94- :members:
91+ .. autoclass:: fsspec.generic.GenericFileSystem
9592
96- .. autoclass:: fsspec.callbacks.DotPrinterCallback
93+ .. autofunction:: fsspec.registry.register_implementation
94+
95+ .. autoclass:: fsspec.spec.AbstractBufferedFile
9796 :members:
9897
99- .. autoclass:: fsspec.callbacks.TqdmCallback
98+ .. autoclass:: fsspec.spec.AbstractFileSystem
10099 :members:
101100
102- .. autoclass:: fsspec.generic.GenericFileSystem
101+ .. autoclass:: fsspec.spec.Transaction
102+ :members:
103103
104104.. _implementations:
105105
106106Built-in Implementations
107107------------------------
108108
109109.. autosummary::
110- fsspec.implementations.ftp.FTPFileSystem
111110 fsspec.implementations.arrow.ArrowFSWrapper
112111 fsspec.implementations.arrow.HadoopFileSystem
113- fsspec.implementations.dask.DaskWorkerFileSystem
114- fsspec.implementations.http.HTTPFileSystem
115- fsspec.implementations.local.LocalFileSystem
116- fsspec.implementations.memory.MemoryFileSystem
117- fsspec.implementations.github.GithubFileSystem
118- fsspec.implementations.sftp.SFTPFileSystem
119- fsspec.implementations.webhdfs.WebHDFS
120- fsspec.implementations.zip.ZipFileSystem
121112 fsspec.implementations.cached.CachingFileSystem
122- fsspec.implementations.cached.WholeFileCacheFileSystem
123113 fsspec.implementations.cached.SimpleCacheFileSystem
114+ fsspec.implementations.cached.WholeFileCacheFileSystem
115+ fsspec.implementations.dask.DaskWorkerFileSystem
116+ fsspec.implementations.dbfs.DatabricksFileSystem
117+ fsspec.implementations.dirfs.DirFileSystem
118+ fsspec.implementations.ftp.FTPFileSystem
124119 fsspec.implementations.git.GitFileSystem
125- fsspec.implementations.smb.SMBFileSystem
120+ fsspec.implementations.github.GithubFileSystem
121+ fsspec.implementations.http.HTTPFileSystem
126122 fsspec.implementations.jupyter.JupyterFileSystem
127123 fsspec.implementations.libarchive.LibArchiveFileSystem
128- fsspec.implementations.dbfs.DatabricksFileSystem
124+ fsspec.implementations.local.LocalFileSystem
125+ fsspec.implementations.memory.MemoryFileSystem
129126 fsspec.implementations.reference.ReferenceFileSystem
130- fsspec.implementations.dirfs.DirFileSystem
127+ fsspec.implementations.sftp.SFTPFileSystem
128+ fsspec.implementations.smb.SMBFileSystem
131129 fsspec.implementations.tar.TarFileSystem
132-
133- .. autoclass:: fsspec.implementations.ftp.FTPFileSystem
134- :members: __init__
130+ fsspec.implementations.webhdfs.WebHDFS
131+ fsspec.implementations.zip.ZipFileSystem
135132
136133.. autoclass:: fsspec.implementations.arrow.ArrowFSWrapper
137134 :members: __init__
138135
139136.. autoclass:: fsspec.implementations.arrow.HadoopFileSystem
140137 :members: __init__
141138
142- .. autoclass:: fsspec.implementations.dask.DaskWorkerFileSystem
139+ .. autoclass:: fsspec.implementations.cached.CachingFileSystem
143140 :members: __init__
144141
145- .. autoclass:: fsspec.implementations.http.HTTPFileSystem
142+ .. autoclass:: fsspec.implementations.cached.SimpleCacheFileSystem
146143 :members: __init__
147144
148- .. autoclass:: fsspec.implementations.local.LocalFileSystem
145+ .. autoclass:: fsspec.implementations.cached.WholeFileCacheFileSystem
149146 :members: __init__
150147
151- .. autoclass:: fsspec.implementations.memory.MemoryFileSystem
148+ .. autoclass:: fsspec.implementations.dask.DaskWorkerFileSystem
152149 :members: __init__
153150
154- .. autoclass:: fsspec.implementations.sftp.SFTPFileSystem
151+ .. autoclass:: fsspec.implementations.dbfs.DatabricksFileSystem
155152 :members: __init__
156153
157- .. autoclass:: fsspec.implementations.webhdfs.WebHDFS
154+ .. autoclass:: fsspec.implementations.dirfs.DirFileSystem
158155 :members: __init__
159156
160- .. autoclass:: fsspec.implementations.zip.ZipFileSystem
157+ .. autoclass:: fsspec.implementations.ftp.FTPFileSystem
161158 :members: __init__
162159
163- .. autoclass:: fsspec.implementations.cached.CachingFileSystem
160+ .. autoclass:: fsspec.implementations.git.GitFileSystem
164161 :members: __init__
165162
166- .. autoclass:: fsspec.implementations.cached.WholeFileCacheFileSystem
163+ .. autoclass:: fsspec.implementations.github.GithubFileSystem
167164 :members: __init__
168165
169- .. autoclass:: fsspec.implementations.cached.SimpleCacheFileSystem
166+ .. autoclass:: fsspec.implementations.http.HTTPFileSystem
170167 :members: __init__
171168
172- .. autoclass:: fsspec.implementations.github.GithubFileSystem
169+ .. autoclass:: fsspec.implementations.jupyter.JupyterFileSystem
173170 :members: __init__
174171
175- .. autoclass:: fsspec.implementations.git.GitFileSystem
172+ .. autoclass:: fsspec.implementations.libarchive.LibArchiveFileSystem
176173 :members: __init__
177174
178- .. autoclass:: fsspec.implementations.smb.SMBFileSystem
175+ .. autoclass:: fsspec.implementations.local.LocalFileSystem
179176 :members: __init__
180177
181- .. autoclass:: fsspec.implementations.jupyter.JupyterFileSystem
178+ .. autoclass:: fsspec.implementations.memory.MemoryFileSystem
182179 :members: __init__
183180
184- .. autoclass:: fsspec.implementations.libarchive.LibArchiveFileSystem
181+ .. autoclass:: fsspec.implementations.reference.ReferenceFileSystem
185182 :members: __init__
186183
187- .. autoclass:: fsspec.implementations.dbfs.DatabricksFileSystem
184+ .. autoclass:: fsspec.implementations.sftp.SFTPFileSystem
188185 :members: __init__
189186
190- .. autoclass:: fsspec.implementations.reference.ReferenceFileSystem
187+ .. autoclass:: fsspec.implementations.smb.SMBFileSystem
191188 :members: __init__
192189
193- .. autoclass:: fsspec.implementations.dirfs.DirFileSystem
190+ .. autoclass:: fsspec.implementations.tar.TarFileSystem
194191 :members: __init__
195192
196- .. autoclass:: fsspec.implementations.tar.TarFileSystem
193+ .. autoclass:: fsspec.implementations.webhdfs.WebHDFS
194+ :members: __init__
195+
196+ .. autoclass:: fsspec.implementations.zip.ZipFileSystem
197197 :members: __init__
198198
199199Other Known Implementations
200200---------------------------
201201
202- - `s3fs`_ for Amazon S3 and other compatible stores
203- - `gcsfs`_ for Google Cloud Storage
204- - `adl`_ for Azure DataLake storage
205202- `abfs`_ for Azure Blob service
203+ - `adl`_ for Azure DataLake storage
206204- `dropbox`_ for access to dropbox shares
207- - `ocifs`_ for access to Oracle Cloud Object Storage
205+ - `dvc`_ to access DVC/Git repository as a filesystem
206+ - `gcsfs`_ for Google Cloud Storage
208207- `gdrive`_ to access Google Drive and shares (experimental)
209- - `wandbfs `_ to access Wandb run data (experimental)
208+ - `ocifs `_ for access to Oracle Cloud Object Storage
210209- `ossfs`_ for Alibaba Cloud (Aliyun) Object Storage System (OSS)
210+ - `s3fs`_ for Amazon S3 and other compatible stores
211+ - `wandbfs`_ to access Wandb run data (experimental)
211212- `webdav4`_ for WebDAV
212- - `dvc`_ to access DVC/Git repository as a filesystem
213213
214- .. _s3fs: https://s3fs.readthedocs.io/en/latest/
215- .. _gcsfs: https://gcsfs.readthedocs.io/en/latest/
216- .. _adl: https://github.com/dask/adlfs
217214.. _abfs: https://github.com/dask/adlfs
215+ .. _adl: https://github.com/dask/adlfs
218216.. _dropbox: https://github.com/MarineChap/intake_dropbox
219- .. _ocifs: https://pypi.org/project/ocifs
217+ .. _dvc: https://github.com/iterative/dvc
218+ .. _gcsfs: https://gcsfs.readthedocs.io/en/latest/
220219.. _gdrive: https://github.com/fsspec/gdrivefs
221- .. _wandbfs : https://github.com/jkulhanek/wandbfs
220+ .. _ocifs : https://pypi.org/project/ocifs
222221.. _ossfs: https://github.com/fsspec/ossfs
222+ .. _s3fs: https://s3fs.readthedocs.io/en/latest/
223+ .. _wandbfs: https://github.com/jkulhanek/wandbfs
223224.. _webdav4: https://github.com/skshetry/webdav4
224- .. _dvc: https://github.com/iterative/dvc
225225
226226.. _readbuffering:
227227
228228Read Buffering
229229--------------
230230
231231.. autosummary::
232+ fsspec.caching.BlockCache
233+ fsspec.caching.BytesCache
234+ fsspec.caching.MMapCache
235+ fsspec.caching.ReadAheadCache
232236
233- fsspec.caching.ReadAheadCache
234- fsspec.caching.BytesCache
235- fsspec.caching.MMapCache
236- fsspec.caching.BlockCache
237-
238- .. autoclass:: fsspec.caching.ReadAheadCache
237+ .. autoclass:: fsspec.caching.BlockCache
239238 :members:
240239
241240.. autoclass:: fsspec.caching.BytesCache
@@ -244,7 +243,7 @@ Read Buffering
244243.. autoclass:: fsspec.caching.MMapCache
245244 :members:
246245
247- .. autoclass:: fsspec.caching.BlockCache
246+ .. autoclass:: fsspec.caching.ReadAheadCache
248247 :members:
249248
250249Utilities
0 commit comments