Skip to main content

Atomic file writes.

Project description

https://travis-ci.org/untitaker/python-atomicwrites.svg?branch=master https://ci.appveyor.com/api/projects/status/vadc4le3c27to59x/branch/master?svg=true

Atomic file writes.

from atomicwrites import atomic_write

with atomic_write('foo.txt', overwrite=True) as f:
    f.write('Hello world.')
    # "foo.txt" doesn't exist yet.

# Now it does.

Features that distinguish it from other similar libraries (see Alternatives and Credit):

  • Race-free assertion that the target file doesn’t yet exist. This can be controlled with the overwrite parameter.

  • Windows support, although not well-tested. The MSDN resources are not very explicit about which operations are atomic.

  • Simple high-level API that wraps a very flexible class-based API.

  • Consistent error handling across platforms.

How it works

It uses a temporary file in the same directory as the given path. This ensures that the temporary file resides on the same filesystem.

The temporary file will then be atomically moved to the target location: On POSIX, it will use rename if files should be overwritten, otherwise a combination of link and unlink. On Windows, it uses MoveFileEx (see MSDN) through stdlib’s ctypes with the appropriate flags.

Note that with link and unlink, there’s a timewindow where the file might be available under two entries in the filesystem: The name of the temporary file, and the name of the target file.

Alternatives and Credit

Atomicwrites is directly inspired by the following libraries (and shares a minimal amount of code):

Other alternatives to atomicwrites include:

  • sashka/atomicfile. Originally I considered using that, but at the time it was lacking a lot of features I needed (Windows support, overwrite-parameter, overriding behavior through subclassing).

  • The Boltons library collection features a class for atomic file writes, which seems to have a very similar overwrite parameter. It is lacking Windows support though.

License

Licensed under the MIT, see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

atomicwrites-0.1.7.tar.gz (14.4 kB view details)

Uploaded Source

Built Distribution

atomicwrites-0.1.7-py2.py3-none-any.whl (6.4 kB view details)

Uploaded Python 2Python 3

File details

Details for the file atomicwrites-0.1.7.tar.gz.

File metadata

  • Download URL: atomicwrites-0.1.7.tar.gz
  • Upload date:
  • Size: 14.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for atomicwrites-0.1.7.tar.gz
Algorithm Hash digest
SHA256 02486f9f270ceea79f160218f03f691688a5c73049e807d475137125d43023e5
MD5 cbc13f0c5948f98145fa1b108fe3f436
BLAKE2b-256 7a2ead3859d7c5a3dae166e07353bf3ec3879bd760ceacc3ddc6c1fa6de5d672

See more details on using hashes here.

File details

Details for the file atomicwrites-0.1.7-py2.py3-none-any.whl.

File metadata

  • Download URL: atomicwrites-0.1.7-py2.py3-none-any.whl
  • Upload date:
  • Size: 6.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for atomicwrites-0.1.7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d7e3037067c045e8cb224100ab6e6b08b60cd2c8c9a8ca27b8182bd9c1283ec5
MD5 042efd3eea9f577ed2f32051e95347a3
BLAKE2b-256 209ac23dfd01f3020dc310a9f753a000910d3d43cae059432edb2337b29e5ebf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page