summaryrefslogtreecommitdiffstats
path: root/testing/web-platform/tests/tools/third_party/atomicwrites/docs/index.rst
blob: 0391c04477126f9a7272ca24da05241a7f56f486 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
.. include:: ../README.rst

.. module:: atomicwrites

API
===

.. autofunction:: atomic_write


Errorhandling
-------------

All filesystem errors are subclasses of :py:exc:`OSError`.

- On UNIX systems, errors from the Python stdlib calls are thrown.
- On Windows systems, errors from Python's ``ctypes`` are thrown.

In either case, the ``errno`` attribute on the thrown exception maps to an
errorcode in the ``errno`` module.

Low-level API
-------------

.. autofunction:: replace_atomic

.. autofunction:: move_atomic

.. autoclass:: AtomicWriter
   :members:

License
=======

.. include:: ../LICENSE