Блокировка файла в Python

Мне нужно заблокировать файл для записи в Python. Он будет доступен из нескольких процессов Python сразу. Я нашел некоторые решения в Интернете, но большинство из них не подходят для моих целей, поскольку они часто основаны только на Unix или Windows.

Ответ 1

Хорошо, поэтому я закончил с кодом, который я написал ~~здесь, на моем сайте~~ ^{ссылка мертва, посмотрите на archive.org} (также доступно на GitHub). Я могу использовать его следующим образом:

from filelock import FileLock

with FileLock("myfile.txt"):
    # work with the file as it is now locked
    print("Lock acquired.")

Ответ 2

Здесь есть модуль межплатформенной блокировки файлов: Portalocker

Хотя, как говорит Кевин, запись в файл из нескольких процессов сразу - это то, чего вы хотите избежать, если это вообще возможно.

Если вы можете переустановить свою проблему в базу данных, вы можете использовать SQLite. Он поддерживает одновременный доступ и обрабатывает собственную блокировку.

Ответ 3

Я предпочитаю lockfile - независимая от платформы блокировка файлов

Ответ 4

Блокировка - это платформа и устройство, но обычно у вас есть несколько вариантов:

Используйте flock() или эквивалент (если ваш os поддерживает его). Это консультативная блокировка, если вы не проверяете блокировку, ее игнорируют.
Используйте методологию lock-copy-move-unlock, в которой вы копируете файл, записываете новые данные, а затем перемещаете его (перемещение, а не копирование - перемещение - это атомная операция в Linux - проверьте вашу ОС), и вы проверяете наличие файла блокировки.
Используйте каталог как "блокировку". Это необходимо, если вы пишете NFS, поскольку NFS не поддерживает flock().
Также существует возможность использования разделяемой памяти между процессами, но я никогда не пробовал это; это очень специфично для ОС.

Для всех этих методов вам понадобится использовать метод spin-lock (retry-after-failure) для приобретения и тестирования блокировки. Это оставляет небольшое окно для неправильной синхронизации, но его в целом достаточно мало, чтобы не быть серьезной проблемой.

Если вы ищете решение, которое является кросс-платформой, то вам лучше сходить в другую систему через какой-то другой механизм (следующая лучшая вещь - это метод NFS выше).

Обратите внимание, что sqlite подвержен тем же ограничениям над NFS, что и обычные файлы, поэтому вы не можете писать в базу данных sqlite на сетевом ресурсе и бесплатно получать синхронизацию.

Ответ 5

Другие решения ссылаются на множество внешних кодовых баз. Если вы предпочитаете сделать это самостоятельно, вот код для кроссплатформенного решения, использующего соответствующие инструменты блокировки файлов в системах Linux/DOS.

try:
    # Posix based file locking (Linux, Ubuntu, MacOS, etc.)
    import fcntl, os
    def lock_file(f):
        fcntl.lockf(f, fcntl.LOCK_EX)
    def unlock_file(f):
        fcntl.lockf(f, fcntl.LOCK_UN)
except ModuleNotFoundError:
    # Windows file locking
    import msvcrt, os
    def file_size(f):
        return os.path.getsize( os.path.realpath(f.name) )
    def lock_file(f):
        msvcrt.locking(f.fileno(), msvcrt.LK_RLCK, file_size(f))
    def unlock_file(f):
        msvcrt.locking(f.fileno(), msvcrt.LK_UNLCK, file_size(f))


# Class for ensuring that all file operations are atomic, treat
# initialization like a standard call to 'open' that happens to be atomic.
# This file opener *must* be used in a "with" block.
class AtomicOpen:
    # Open the file with arguments provided by user. Then acquire
    # a lock on that file object (WARNING: Advisory locking).
    def __init__(self, path, *args, **kwargs):
        # Open the file and acquire a lock on the file before operating
        self.file = open(path,*args, **kwargs)
        # Lock the opened file
        lock_file(self.file)

    # Return the opened file object (knowing a lock has been obtained).
    def __enter__(self, *args, **kwargs): return self.file

    # Unlock the file and close the file object.
    def __exit__(self, exc_type=None, exc_value=None, traceback=None):        
        # Flush to make sure all buffered contents are written to file.
        self.file.flush()
        os.fsync(self.file.fileno())
        # Release the lock on the file.
        unlock_file(self.file)
        self.file.close()
        # Handle exceptions that may have come up during execution, by
        # default any exceptions are raised to the user.
        if (exc_type != None): return False
        else:                  return True

Теперь AtomicOpen можно использовать в блоке with где обычно используется оператор open.

ВНИМАНИЕ: Если в Windows и Python происходит сбой перед вызовом exit, я не уверен, каково будет поведение блокировки.

ВНИМАНИЕ: Блокировка, представленная здесь, носит рекомендательный, а не абсолютный характер. Все потенциально конкурирующие процессы должны использовать класс "AtomicOpen".

Ответ 6

Согласование доступа к одному файлу на уровне ОС сопряжено со всеми проблемами, которые вы, вероятно, не хотите решать.

Лучше всего иметь отдельный процесс, который координирует доступ для чтения/записи к этому файлу.

Ответ 7

Я смотрел несколько решений, чтобы сделать это, и мой выбор был oslo.concurrency

Это мощный и относительно хорошо документированный. Он основан на крепежных деталях.

Другие решения:

Portalocker: требует pywin32, который является exe-установкой, поэтому невозможно с помощью pip
fasteners: плохо документировано
lockfile: устарело
flufl.lock: блокировка файлов NFS для систем POSIX.
simpleflock: Последнее обновление 2013-07
zc.lockfile: Последнее обновление 2016-06 (по состоянию на 2017-03)
lock_file: Последнее обновление в 2007-10 гг.

Ответ 8

Блокировка файла обычно зависит от платформы, поэтому вам может потребоваться возможность запуска в разных операционных системах. Например:

import os

def my_lock(f):
    if os.name == "posix":
        # Unix or OS X specific locking here
    elif os.name == "nt":
        # Windows specific locking here
    else:
        print "Unknown operating system, lock unavailable"

Ответ 9

Я работал над такой ситуацией, когда я запускаю несколько копий одной и той же программы из одного и того же каталога/папки и ошибок регистрации. Мой подход заключался в том, чтобы записать "файл блокировки" на диск перед открытием файла журнала. Программа проверяет наличие "файла блокировки" перед продолжением и ждет своей очереди, если существует "файл блокировки".

Вот код:

def errlogger(error):

    while True:
        if not exists('errloglock'):
            lock = open('errloglock', 'w')
            if exists('errorlog'): log = open('errorlog', 'a')
            else: log = open('errorlog', 'w')
            log.write(str(datetime.utcnow())[0:-7] + ' ' + error + '\n')
            log.close()
            remove('errloglock')
            return
        else:
            check = stat('errloglock')
            if time() - check.st_ctime > 0.01: remove('errloglock')
            print('waiting my turn')

EDIT--- Подумав над некоторыми комментариями о старых замках выше, я отредактировал код, чтобы добавить проверку на постоянство "файла блокировки". Сроки нескольких тысяч итераций этой функции на моей системе дали и в среднем 0.002066... секунд от раньше:

lock = open('errloglock', 'w')

сразу:

remove('errloglock')

поэтому я решил, что я начну с 5-кратной суммы, чтобы указать на тотальность и контролировать ситуацию для проблем.

Кроме того, когда я работал со временем, я понял, что у меня есть немного кода, который действительно не нужен:

lock.close()

который я сразу же после открытого заявления, поэтому я удалил его в этом редактировании.

Ответ 10

сценарий выглядит следующим образом: Пользователь запрашивает файл, чтобы что-то сделать. Затем, если пользователь снова отправляет один и тот же запрос, он информирует пользователя о том, что второй запрос не выполняется до завершения первого запроса. Поэтому я использую блокирующий механизм для решения этой проблемы.

Вот мой рабочий код:

from lockfile import LockFile
lock = LockFile(lock_file_path)
status = ""
if not lock.is_locked():
    lock.acquire()
    status = lock.path + ' is locked.'
    print status
else:
    status = lock.path + " is already locked."
    print status

return status

Ответ 11

Я нашел простую и обработанную (!) реализацию из grizzled-python.

Простое использование os.open(..., O_EXCL) + os.close() не работает в Windows.

Ответ 12

Вы можете найти pylocker очень полезным. Он может использоваться для блокировки файла или для механизмов блокировки в целом и может быть доступен сразу из нескольких процессов Python.

Если вы просто хотите заблокировать файл здесь, как он работает:

import uuid
from pylocker import Locker

#  create a unique lock pass. This can be any string.
lpass = str(uuid.uuid1())

# create locker instance.
FL = Locker(filePath='myfile.txt', lockPass=lpass, mode='w')

# aquire the lock
with FL as r:
    # get the result
    acquired, code, fd  = r

    # check if aquired.
    if fd is not None:
        print fd
        fd.write("I have succesfuly aquired the lock !")

# no need to release anything or to close the file descriptor, 
# with statement takes care of that. let print fd and verify that.
print fd