@@ -192,19 +192,19 @@ methods:
192
192
ContentsManager.is_hidden
193
193
194
194
You may be required to specify a Checkpoints object, as the default one,
195
- ``FileCheckpoints ``, could be incompatible with your custom
195
+ ``FileCheckpoints ``, could be incompatible with your custom
196
196
ContentsManager.
197
197
198
198
Customizing Checkpoints
199
199
-----------------------
200
200
.. currentmodule :: jupyter_server.services.contents.checkpoints
201
201
202
- Customized Checkpoint definitions allows behavior to be
202
+ Customized Checkpoint definitions allows behavior to be
203
203
altered and extended.
204
204
205
205
The ``Checkpoints `` and ``GenericCheckpointsMixin `` classes
206
206
(from :mod: `jupyter_server.services.contents.checkpoints `)
207
- have reusable code and are intended to be used together,
207
+ have reusable code and are intended to be used together,
208
208
but require the following methods to be implemented.
209
209
210
210
.. autosummary ::
@@ -220,7 +220,7 @@ No-op example
220
220
~~~~~~~~~~~~~
221
221
222
222
Here is an example of a no-op checkpoints object - note the mixin
223
- comes first. The docstrings indicate what each method should do or
223
+ comes first. The docstrings indicate what each method should do or
224
224
return for a more complete implementation.
225
225
226
226
.. code-block :: python
@@ -238,7 +238,7 @@ return for a more complete implementation.
238
238
def delete_checkpoint (self , checkpoint_id , path ):
239
239
""" deletes a checkpoint for a file"""
240
240
def list_checkpoints (self , path ):
241
- """ returns a list of checkpoint models for a given file,
241
+ """ returns a list of checkpoint models for a given file,
242
242
default just does one per file
243
243
"""
244
244
return []
@@ -267,3 +267,13 @@ ContentsManager.
267
267
.. _NBFormat : https://nbformat.readthedocs.io/en/latest/index.html
268
268
.. _PGContents : https://github.com/quantopian/pgcontents
269
269
.. _PostgreSQL : https://www.postgresql.org/
270
+
271
+ Asynchronous Support
272
+ ~~~~~~~~~~~~~~~~~~~~
273
+
274
+ To execute file operations asynchronously in a virtual filesystem, the following classes are available.
275
+
276
+ - :class: `~manager.AsyncContentsManager `
277
+ - :class: `~filemanager.AsyncFileContentsManager `
278
+ - :class: `~checkpoints.AsyncCheckpoints `
279
+
0 commit comments