https://github.com/ravencentric/atomicwriter
Cross-platform atomic file writer for all-or-nothing operations.
https://github.com/ravencentric/atomicwriter
atomic file python writer
Last synced: 3 months ago
JSON representation
Cross-platform atomic file writer for all-or-nothing operations.
- Host: GitHub
- URL: https://github.com/ravencentric/atomicwriter
- Owner: Ravencentric
- License: apache-2.0
- Created: 2025-02-13T13:24:00.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-10-06T18:26:57.000Z (3 months ago)
- Last Synced: 2025-10-06T20:35:11.297Z (3 months ago)
- Topics: atomic, file, python, writer
- Language: Python
- Homepage: https://ravencentric.cc/atomicwriter/
- Size: 255 KB
- Stars: 11
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# atomicwriter
[](https://github.com/Ravencentric/atomicwriter/actions/workflows/tests.yml)
[](https://github.com/Ravencentric/atomicwriter/actions/workflows/release.yml)
[](https://pypi.org/project/atomicwriter)
`atomicwriter` provides the `AtomicWriter` class, which performs cross-platform atomic file writes to ensure "all-or-nothing" operations—if a write fails, the target file is left unchanged.
## Table Of Contents
- [Usage](#usage)
- [Installation](#installation)
- [Building from source](#building-from-source)
- [Acknowledgements](#acknowledgements)
- [License](#license)
- [Contributing](#contributing)
## Usage
```python
from pathlib import Path
from atomicwriter import AtomicWriter
destination = Path("alpha_trion.txt") # or str
with AtomicWriter(destination) as writer:
writer.write_text("What defines a Transformer is not the cog in his chest, ")
writer.write_text("but the Spark that resides in their core.\n")
assert destination.is_file() is False
assert destination.is_file()
```
Checkout the complete documentation [here](https://ravencentric.cc/atomicwriter/api-reference/).
## Installation
`atomicwriter` is available on [PyPI](https://pypi.org/project/atomicwriter/), so you can simply use pip to install it.
```console
pip install atomicwriter
```
## Building from source
Building from source requires the [Rust toolchain](https://rustup.rs/) and [Python 3.9+](https://www.python.org/downloads/).
- With [`uv`](https://docs.astral.sh/uv/):
```console
git clone https://github.com/Ravencentric/atomicwriter
cd atomicwriter
uv build
```
- With [`pypa/build`](https://github.com/pypa/build):
```console
git clone https://github.com/Ravencentric/atomicwriter
cd atomicwriter
python -m build
```
## Acknowledgements
This project is essentially a thin wrapper around the excellent [`tempfile`](https://crates.io/crates/tempfile) crate, which handles all the heavy lifting for atomic file operations.
It is also heavily inspired by the now-archived [`atomicwrites`](https://pypi.org/project/atomicwrites/) project and uses a similar API.
## License
Licensed under either of:
- Apache License, Version 2.0 ([LICENSE-APACHE](https://github.com/Ravencentric/atomicwriter/blob/main/LICENSE-APACHE) or )
- MIT license ([LICENSE-MIT](https://github.com/Ravencentric/atomicwriter/blob/main/LICENSE-MIT) or )
at your option.
## Contributing
Contributions are welcome! Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.