posixfs 1.0.1

posixfs

posixfs提供了上下文管理器和函数来操作具有原子性和 耐用性。该模块的目的是简单易用。

该模块是用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

用法

importpathlibimportposixfs# write bytes to a file atomically and durablypth=pathlib.Path("/some/file.txt")posixfs.atomic_write_bytes(path=pth,data=b"hello",durable=True)# write text to a file atomically and durablyposixfs.atomic_write_bytes(path=pth,text="hello",durable=True)# use context managerwithposixfs.AtomicWritingText(path=pth,durable=True)asfile: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

• 我们还提供了一组预提交检查，lint和检查代码的格式。从激活的 具有开发依赖关系的虚拟环境：

./precommit.py

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

./precommit.py  --overwrite

版本控制

我们跟着Semantic Versioning。版本x.y.z表示：

• X是主要版本（向后不兼容），
• y是次要版本（向后兼容），并且
• z是修补程序版本（向后兼容的错误修复）。