posixfs 1.0.1

posixfs

posixfs提供了在POSIX文件系统上以原子性和持久性操作文件的上下文管理器和函数。该模块旨在简单易用。

该模块使用Python 3编写，具有类型注解并使用pathlib.Path。

相关项目

已经有许多模块和项目提供了此功能。以下是一个非详尽的列表

• https://github.com/abarnert/fatomic

• https://github.com/untitaker/python-atomicwrites

• https://github.com/mitsuhiko/python-atomicfile

• https://github.com/sashka/atomicfile

• https://boltons.readthedocs.io/en/latest/fileutils.html#boltons.fileutils.atomic_save

不幸的是，它们都没有提供持久写入（只有原子写入），缺乏类型注解，并且它们都使用str而不是pathlib.Path来处理文件路径。

我们特别认为，对于像文件读写这样在大型需要静态检查和良好可读性的代码库中广泛使用的模块，类型注解至关重要。此外，我们不想放弃对pathlib的操作能力，也不想在代码中到处使用.as_posix()。

有关POSIX文件系统上的原子和持久写入的更多信息，请参阅http://blog.httrack.com/blog/2013/11/15/everything-you-always-wanted-to-know-about-fsync

用法

import pathlib

import posixfs

# write bytes to a file atomically and durably
pth = pathlib.Path("/some/file.txt")
posixfs.atomic_write_bytes(path=pth, data=b"hello", durable=True)

# write text to a file atomically and durably
posixfs.atomic_write_bytes(path=pth, text="hello", durable=True)

# use context manager
with posixfs.AtomicWritingText(path=pth, durable=True) as file:
    file.write('hello\n')
    file.write('how do you do?\n')

安装

• 创建虚拟环境

python3 -m venv venv3

• 激活它

source venv3/bin/activate

• 使用pip安装posixfs

pip3 install posixfs

开发

• 查看仓库。

• 在仓库根目录下，创建虚拟环境

python3 -m venv venv3

• 激活虚拟环境

source venv3/bin/activate

• 安装开发依赖

pip3 install -e .[dev]

• 我们使用tox进行测试和打包分发。假设已经激活了虚拟环境并且安装了开发依赖，请运行

tox

• 我们还提供了一套预提交检查，用于检查代码格式。在激活的虚拟环境中带有开发依赖的情况下本地运行

./precommit.py

• 预提交脚本还可以自动格式化代码

./precommit.py  --overwrite

版本控制

我们遵循语义版本控制。版本号X.Y.Z表示

• X为主版本（不向后兼容），

• Y为次版本（向后兼容），

• Z为补丁版本（向后兼容的bug修复）。