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-1.0.0.tar.gz (14.7 kB view details)

Uploaded Source

Built Distribution

atomicwrites-1.0.0-py2.py3-none-any.whl (6.5 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for atomicwrites-1.0.0.tar.gz
Algorithm Hash digest
SHA256 1b977e9a6cbf8ae36a4e259e6da28d98fda6ab81cbf9634258eee0700e512e05
MD5 9bcb01d6f3affb398a12db4e83a97479
BLAKE2b-256 b655127c32cbe8e2e2aef2fb41e5dc5b72bf5d4b0631a0d5cc0f9b13b4b44bac

See more details on using hashes here.

File details

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

File metadata

  • Download URL: atomicwrites-1.0.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 6.5 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-1.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 65ab13ed810d9b97ab3b5c7b51a865173f431b9e63dbcda7c0d1ed7f82484309
MD5 d624fb96ff8bf88adeb05c0443489cbf
BLAKE2b-256 6f7e9a49e30f5dd941a3e57b76221e007d93a67d67d9d84e3f215303e5541096

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