Skip to content

Commit

Permalink
Document contents chunks
Browse files Browse the repository at this point in the history
Add a documentation entry for the contents API regarding use of "chunk" in save.

Adds an `extra_requires` value in setup.py for installing documentation dependencies.
  • Loading branch information
vidartf committed Jun 4, 2020
1 parent ed5e9d6 commit dca4fc5
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/source/extending/contents.rst
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,25 @@ You may be required to specify a Checkpoints object, as the default one,
``FileCheckpoints``, could be incompatible with your custom
ContentsManager.


Chunked Saving
~~~~~~~~~~~~~~

The contents API allows for "chunked" saving of files, i.e.
saving/transmitting in partial pieces:

* This can only be used when the ``type`` of the model is ``file``.
* The model should be as otherwise expected for
:meth:`~manager.ContentsManager.save`, with an added field ``chunk``.
* The value of ``chunk`` should be an integer starting at ``1``, and incrementing
for each subsequent chunk, except for the final chunk, which should be
indicated with a value of ``-1``.
* The model returned from using :meth:`~manager.ContentsManager.save` with
``chunk`` should be treated as unreliable for all chunks except the final one.
* Any interaction with a file being saved in a chunked manner is unreliable
until the final chunk has been saved. This includes directory listings.


Customizing Checkpoints
-----------------------
.. currentmodule:: notebook.services.contents.checkpoints
Expand Down
1 change: 1 addition & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,7 @@
'test': ['nose', 'coverage', 'requests', 'nose_warnings_filters',
'nbval', 'nose-exclude', 'selenium', 'pytest', 'pytest-cov',
'requests-unixsocket'],
'docs': ['sphinx', 'nbsphinx', 'sphinxcontrib_github_alt'],
'test:sys_platform == "win32"': ['nose-exclude'],
},
python_requires = '>=3.5',
Expand Down

0 comments on commit dca4fc5

Please sign in to comment.