m3-mutex 2.1.0__py3-none-any.whl

m3_mutex/__init__.py

@@ -0,0 +1,8 @@
+# coding:utf-8
+# from __future__ import absolute_import
+# from .exceptions import MutexBusy
+# from .domain import (
+#     MutexID, MutexOwner, SystemOwner, MutexState,
+#     TimeoutAutoRelease)
+#
+# from .api import (capture_mutex, request_mutex, release_mutex)

m3_mutex/actions.py

@@ -0,0 +1,6 @@
+#coding: utf-8
+u"""
+Created on 14.07.2011
+
+@author: akvarats
+"""

m3_mutex/api.py

@@ -0,0 +1,85 @@
+#coding: utf-8
+u"""
+Created on 14.07.2011
+
+@author: akvarats
+"""
+from __future__ import absolute_import
+# данные импорты для использования вовне системы
+from .domain import TimeoutAutoRelease, MutexQuery
+from .backends import ModelMutexBackend
+#from helpers import get_backend
+
+
+def get_backend(mutex_id):
+    u"""Получает бекэнд
+
+    :param mutex_id: семафор
+    :type mutex_id: объект класса domain.Mutex или domain.MutexID
+
+    :return: объект класса ModelMutexBackend
+    """
+    return ModelMutexBackend()
+
+
+def capture_mutex(mutex_id, owner=None, auto_release=TimeoutAutoRelease(timeout=300), status_data=None):
+    u"""Устанавливает семафор с таймаутом в 300 секунд (5 минут) по умолчанию
+
+    :param mutex_id: семафор
+    :type mutex_id: объект класса domain.Mutex или domain.MutexID
+    :param owner: владелец семафора. Если передать значение None, то будет
+        использовано значение из thread-locals
+    :type owner: объект класса domain.MutexOwner
+    :param auto_release: правило автоосвобождения данного семаформа. По
+        умолчанию используется автоматическое освобождение по таймауту
+        в 5 минут.
+    :param str status_data: статусная информация
+
+    :return: объект класса domain.Mutex
+
+    """
+    return get_backend(mutex_id).capture_mutex(mutex_id, owner, auto_release, status_data)
+
+
+def release_mutex(mutex_id, owner=None):
+    u"""Освобождает семафор
+
+    :param mutex_id: семафор
+    :type mutex_id: объект класса domain.Mutex или domain.MutexID
+    :param owner: владелец семафора. Если передать значение None, то будет
+        использовано значение из thread-locals
+    :type owner: объект класса domain.MutexOwner
+
+    :return:
+
+    """
+    return get_backend(mutex_id).release_mutex(mutex_id, owner)
+
+
+def request_mutex(mutex_id, owner=None):
+    u"""Проверяет, свободен ли семафор.
+
+    :param mutex_id: семафор
+    :type mutex_id: объект класса domain.Mutex или domain.MutexID
+    :param owner: владелец семафора. Если передать значение None, то будет
+        использовано значение из thread-locals
+    :type owner: объект класса domain.MutexOwner
+
+    :return: кортеж из состояния семафора MutexState и семафора или None
+
+    """
+    return get_backend(mutex_id).request_mutex(mutex_id, owner)
+
+
+def get_mutex_list(mutex_query=MutexQuery()):
+    u"""Возвращает список семафоров.
+
+    :param mutex_query: условия отбора семафоров
+    :type mutex_query: объект класса MutexQuery
+
+    :return: список семафоров
+
+    """
+    return []
+
+

m3_mutex/app_meta.py

@@ -0,0 +1,6 @@
+#coding: utf-8
+u"""
+Created on 14.07.2011
+
+@author: akvarats
+"""

m3_mutex/backends.py

@@ -0,0 +1,329 @@
+"""
+Created on 15.07.2011
+
+@author: akvarats
+"""
+import datetime
+
+from django.db.models import (
+    F,
+)
+from django.utils.translation import (
+    gettext as _,
+)
+
+from m3_mutex.domain import (
+    Mutex,
+    MutexAutoReleaseRule,
+    MutexState,
+    TimeoutAutoRelease,
+)
+from m3_mutex.exceptions import (
+    MutexBusy,
+)
+from m3_mutex.helpers import (
+    compare_owners,
+    get_default_owner,
+)
+from m3_mutex.models import (
+    MutexModel,
+)
+
+
+class BaseMutexBackend(object):
+    """Базовый класс (интерфейс) бекэнда для управления семафорами.
+    """
+    def capture_mutex(self, mutex_id, owner=None,
+                      auto_release=TimeoutAutoRelease(), status_data=None):
+        """Метод захвата семафора.
+
+        :param mutex_id: семафор
+        :type mutex_id: объект класса domain.Mutex или domain.MutexID
+        :param owner: владелец семафора. Если передать значение None, то будет
+            использовано значение из thread-locals
+        :type owner: объект класса domain.MutexOwner
+        :param auto_release: правило автоосвобождения данного семаформа. По
+            умолчанию используется автоматическое освобождение по таймауту
+            в 5 минут.
+        :param str status_data: статусная информация
+
+        :return: объект класса domain.Mutex
+        :raise: MutexBusy
+
+        """
+        # если владелец не определен
+        if not owner:
+            # получим владельца из текущей сессии
+            owner = get_default_owner()
+
+        cleaned_status_data = ''
+        # если нам передали какую - либо статусную информацию
+        if status_data != None:
+            if hasattr(status_data, 'dump') and callable(status_data.dump):
+                cleaned_status_data = status_data.dump()
+            else:
+                cleaned_status_data = str(status_data)
+        # получим информацию о семафоре из хранилища
+        mutex = self._read_mutex(mutex_id)
+
+        # признак того, что необходимо создать новый семафор
+        create_mutex = False
+        if mutex:
+            # проверяем условие автоосвобождения семафора
+            if mutex.auto_release and mutex.auto_release.check(mutex):
+                # удаляем семафор из хранилища
+                self._remove_mutex(mutex_id)
+                create_mutex = True
+            else:
+                # сравним владельца, переданного нам, с владельцем семафора
+                if not compare_owners(mutex.owner, owner):
+                    raise MutexBusy()
+                # семафор уже был захвачен нами, обновим информацию
+                self._refresh_mutex(mutex_id, cleaned_status_data)
+        else:
+            create_mutex = True
+        # если необходимо создать новый семафор
+        if create_mutex:
+            mutex = Mutex()
+            mutex.id = mutex_id
+            mutex.owner = owner
+            mutex.captured_since = datetime.datetime.now()
+            mutex.auto_release = auto_release
+            mutex.status_data = cleaned_status_data
+            # добавим семафор в хранилище
+            self._add_mutex(mutex)
+
+        return mutex
+
+    def release_mutex(self, mutex_id, owner=None):
+        """Метод освобождения семафора. В случае, если семафор был ранее
+        захвачен не нами.
+
+        :param mutex_id: семафор
+        :type mutex_id: объект класса domain.Mutex или domain.MutexID
+        :param owner: владелец семафора. Если передать значение None, то будет
+            использовано значение из thread-locals
+        :type owner: объект класса domain.MutexOwner
+
+        :return:
+        :raise: MutexBusy
+
+        """
+        # получим информацию о семафоре из хранилища
+        mutex = self._read_mutex(mutex_id)
+        if not mutex:
+            return
+
+         # если владелец не определен
+        if not owner:
+            # получим владельца из текущей сессии
+            owner = get_default_owner()
+
+        # сравним владельца, которого нам передали с владельцем семафора
+        if not compare_owners(mutex.owner, owner):
+            raise MutexBusy()
+
+        # удаляем семафор из хранилища
+        self._remove_mutex(mutex_id)
+
+    def request_mutex(self, mutex_id, owner=None):
+        """Метод проверки состояния семафора.
+
+        :param mutex_id: семафор
+        :type mutex_id: объект класса domain.Mutex или domain.MutexID
+        :param owner: владелец семафора. Если передать значение None, то будет
+            использовано значение из thread-locals
+        :type owner: объект класса domain.MutexOwner
+
+        :return: кортеж из состояния семафора MutexState и семафора или None
+
+        """
+        # получим информацию о семафоре из хранилища
+        mutex = self._read_mutex(mutex_id)
+
+        # если нет семафора
+        if not mutex:
+            return MutexState.FREE, None
+
+        # есил существует правило автоосвобождения семафора
+        if mutex.auto_release and mutex.auto_release.check(mutex):
+            # удаляем семафор из хранилища
+            self._remove_mutex(mutex_id)
+            return MutexState.FREE, None
+
+        # если владелец не определен
+        if not owner:
+            # получим владельца из текущей сессии
+            owner = get_default_owner()
+
+        # возвращает в качестве состояния MutexState.CAPTURED_BY_ME, если
+        # семафор захвачен нами, иначе MutexState.CAPTURED_BY_OTHER
+        return (MutexState.CAPTURED_BY_ME if compare_owners(mutex.owner, owner)
+                else MutexState.CAPTURED_BY_OTHER, mutex)
+
+    #==========================================================================
+    # Методы, которые должны быть переопределены в классах конкретных
+    # backend'ов
+    #==========================================================================
+    def _read_mutex(self, mutex_id):
+        """Внутренний метод чтения информации о семафоре из хранилища
+
+        :param mutex_id: семафор
+        :type mutex_id: объект класса domain.Mutex или domain.MutexID
+
+        """
+        raise NotImplementedError(
+            _('Данный метод должен быть переопределен в классах-потомках'))
+
+    def _add_mutex(self, mutex):
+        """Внутренний метод добавления семафора в хранилище
+
+        :param mutex: семафор
+        :type mutex: объект класса domain.Mutex
+
+        """
+        raise NotImplementedError(
+            _('Данный метод должен быть переопределен в классах-потомках'))
+
+    def _refresh_mutex(self, mutex_id, status_data):
+        """Внутренний метод обновления информации о семафоре в хранилище
+
+        :param mutex_id: семафор
+        :type mutex_id: объект класса domain.Mutex или domain.MutexID
+        :param str status_data: статусная информация
+
+        """
+        raise NotImplementedError(
+            _('Данный метод должен быть переопределен в классах-потомках'))
+
+    def _remove_mutex(self, mutex_id):
+        """Внутренний метод удаления семафора из хранилища
+
+        :param mutex_id: семафор
+        :type mutex_id: объект класса domain.Mutex или domain.MutexID
+
+        """
+        raise NotImplementedError(
+            _('Данный метод должен быть переопределен в классах-потомках'))
+
+
+class ModelMutexBackend(BaseMutexBackend):
+    """Бекэнд, который реализует хранение семафоров в базе данных
+    """
+
+    def _read_mutex(self, mutex_id):
+        """Читаем параметры семафора из базы данных
+
+        :param mutex_id: семафор
+        :type mutex_id: объект класса domain.Mutex или domain.MutexID
+
+        :return: объект класса domain.Mutex или None
+        """
+        try:
+            stored_mutex = MutexModel.objects.get(mutex_group=mutex_id.group,
+                                                  mutex_mode=mutex_id.mode,
+                                                  mutex_id=mutex_id.id)
+            mutex = Mutex()
+            # информация о семафоре
+            mutex.id.group = stored_mutex.mutex_group
+            mutex.id.mode = stored_mutex.mutex_mode
+            mutex.id.id = stored_mutex.mutex_id
+
+            # информация о владельце семафора
+            mutex.owner.session_id = stored_mutex.owner_session
+            mutex.owner.host = stored_mutex.owner_session
+            mutex.owner.user_id = stored_mutex.owner_id
+            mutex.owner.login = stored_mutex.owner_login
+            mutex.owner.name = stored_mutex.owner_name
+
+            # служебная информация
+            mutex.captured_since = stored_mutex.captured_since
+
+            # статусная информация
+            mutex.status_data = stored_mutex.status_data
+
+            # восстановление правила автоосвобождения семафора
+            auto_release_class = MutexAutoReleaseRule.get_rule_class(
+                stored_mutex.auto_release_rule)
+            if auto_release_class:
+                mutex.auto_release = auto_release_class()
+                mutex.auto_release.restore(stored_mutex.auto_release_config)
+
+        except MutexModel.DoesNotExist:
+            mutex = None
+
+        return mutex
+
+    def _add_mutex(self, mutex):
+        """Записывает информацию о захвате семафора в базу данных.
+
+        :param mutex: семафор
+        :type mutex: объект класса domain.Mutex
+
+        :return:
+        """
+        mutex_model = MutexModel()
+
+        # информация о семафоре
+        mutex_model.mutex_group = mutex.id.group
+        mutex_model.mutex_mode = mutex.id.mode
+        mutex_model.mutex_id = mutex.id.id
+
+        # информация о владельце семафора
+        mutex_model.owner_session = mutex.owner.session_id
+        mutex_model.owner_host = mutex.owner.host
+        mutex_model.owner_id = mutex.owner.user_id
+        mutex_model.owner_login = mutex.owner.login
+        mutex_model.owner_name = mutex.owner.name
+
+        # служебная информация
+        mutex_model.captured_since = mutex.captured_since
+
+        # статусная информация
+        mutex_model.status_data = mutex.status_data
+
+        # условие автоосвобождения
+        if mutex.auto_release:
+            auto_release_tuple = mutex.auto_release.dump()
+            mutex_model.auto_release_rule = auto_release_tuple[0]
+            mutex_model.auto_release_config = auto_release_tuple[1]
+
+        mutex_model.save()
+
+    def _refresh_mutex(self, mutex_id, status_data=''):
+        """Производит обновление информации об установке семафора. Выставляет
+        текущую дату в качестве метки момента захвата семафора.
+
+        :param mutex_id: семафор
+        :type mutex_id: объект класса domain.Mutex или domain.MutexID
+
+        :param str status_data: статусная информация
+
+        """
+        MutexModel.objects.filter(
+            mutex_group=mutex_id.group,
+            mutex_mode=mutex_id.mode,
+            mutex_id=mutex_id.id
+        ).update(
+            captured_since=datetime.datetime.now(),
+            status_data=status_data or F('status_data'))
+
+    def _remove_mutex(self, mutex_id):
+        """Удаляет информацию о захвате семафора из базы данных
+
+        :param mutex_id: семафор
+        :type mutex_id: объект класса domain.Mutex или domain.MutexID
+
+        """
+        MutexModel.objects.filter(mutex_group=mutex_id.group,
+                                  mutex_mode=mutex_id.mode,
+                                  mutex_id=mutex_id.id).delete()
+
+
+class SessionMutexBackend(BaseMutexBackend):
+    """ Бекэнд, который реализует хранение семафоров в
+    сессии текущей обработки запросов.
+    Данный бекэнд необходимо использовать для выставления семафоров
+    только в рамках обработки текущего запроса.
+    """
+    pass

m3_mutex/doc/Makefile

@@ -0,0 +1,177 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/m3-mutex.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/m3-mutex.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/m3-mutex"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/m3-mutex"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

m3_mutex/doc/build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 6023ff33efdf7e4c168ccd583aa410f4
+tags: 645f666f9bcd5a90fca523b33c5a78b7