ezfilelock

A simple cross-platform file lock


License
MIT
Install
pip install ezfilelock==1.0.1

Documentation

EZ File Lock

A simple cross-platform File Lock

Quick start:

pip install ezfilelock

Usage

Use just like builtin method open()

from ezfilelock import open

with open('xxx.txt','r') as f:
    print(f.read())

Use FileLock instance

from ezfilelock import FileLock
from builtin import open

with FileLock('xxx.txt'):
    # do continuous things with lock
    with open('xxx.txt','w') as f:
        f.write('hello')
    with open('xxx.txt','a') as f:
        f.write('world!')
    with open('xxx.txt','r') as f:
        f.read()

Read Write Lock

Cannot Write when Reading.

Cannot Read when Writing.

Can Read by multiple threads at the same time

from ezfilelock import rwopen

with rwopen('xxx.txt',mode='w') as f:
    f.write('hello world')

with rwopen('xxx.txt',mode='r') as f:
    print(f.read())