Source code for sqlalchemy_media.stores

import functools
from typing import Iterable

from sqlalchemy import event
from sqlalchemy.util.langhelpers import symbol

from sqlalchemy_media.context import get_id as get_context_id
from sqlalchemy_media.exceptions import ContextError, DefaultStoreError

from .base import Store
from .filesystem import FileSystemStore
from .os2 import OS2Store
from .s3 import S3Store
from .ssh import SSHStore


# Global variable to store contexts
_context_stacks = {}

# Global variable to store store factories
_factories = {}

# Global variable to store observing attributes
_observing_attributes = set()


[docs]class StoreManager(object): """ This is an context manager. Before using you must register at least one store factory function as default with-in store registry with :meth:`register` by passing `default=true` during registration. This object will call the registered factory functions to instantiate one per :func:`sqlalchemy_media.context.get_id`. .. testcode:: import functools from sqlalchemy.orm.session import Session from sqlalchemy_media import StoreManager, FileSystemStore StoreManager.register('fs', functools.partial(FileSystemStore, '/tmp/sa_temp_fs', 'http'), default=True) StoreManager.register('fs2', functools.partial(FileSystemStore, '/tmp/sa_temp_fs2', 'http')) with StoreManager(Session) as store_manager: assert StoreManager.get_current_store_manager() == store_manager print(store_manager.get().root_path) # fs1 default store print(store_manager.get('fs2').root_path) # fs2 store This would output: .. testoutput:: /tmp/sa_temp_fs /tmp/sa_temp_fs2 """ _stores = None _default = None _files_to_delete_after_commit = None _files_to_delete_after_rollback = None _files_orphaned = None #: If :data:`.True` the orphaned attachments will be gathered and deleted after session commit. delete_orphan = False def __init__(self, session, delete_orphan=False): self.session = session self.delete_orphan = delete_orphan self.reset_files_state()
[docs] def __enter__(self): """ Enters the context: bind events and push itself into context stack. :return: self """ self.bind_events() _context_stacks.setdefault(get_context_id(), []).append(self) return self
[docs] def __exit__(self, exc_type, exc_val, exc_tb): """ Destroy the context, pop itself from context stack and unbind all events. """ _context_stacks.setdefault(get_context_id(), []).pop() self.unbind_events() self.cleanup()
@property def stores(self) -> dict: """ The mapping `str -> store factory`. :type: dict[str] -> callable """ if self._stores is None: self._stores = {} # noinspection PyTypeChecker return self._stores
[docs] @classmethod def get_current_store_manager(cls) -> 'StoreManager': """ Find the current :class:`StoreManager` in context stack if any. else :exc:`.ContextError` will be raised. """ try: return _context_stacks.setdefault(get_context_id(), [])[-1] except IndexError: raise ContextError('Not in store manager context.')
[docs] def cleanup(self): """ Calls the :meth:`.Store.cleanup` for each store is :attr:`.stores` and clears the :attr:`.stores` also. """ for store in self.stores.values(): store.cleanup() self.stores.clear()
[docs] @classmethod def make_default(cls, key) -> None: """ Makes a pre-registered store as default. :param key: the store id. """ cls._default = key
[docs] @classmethod def register(cls, key: str, store_factory, default: bool=False): """ Registers the store factory into stores registry, use :meth:`unregister` to remove it. :param key: The unique key for store. :param store_factory: A callable that returns an instance of :class:`.Store`. :param default: If :data:`True` the given store will be marked as default also. in addition you can use :meth:`.make_default` to mark a store as default. """ _factories[key] = store_factory if default: cls._default = key
[docs] @classmethod def unregister(cls, key) -> Store: """ Opposite of :meth:`.register`. :exc:`.KeyError` may raised if key not found in registry. :param key: The store key to remove from stores registry. """ if key == cls._default: cls._default = None if key in _factories: return _factories.pop(key) else: raise KeyError('Cannot find store: %s' % key)
[docs] def get(self, key=None) -> Store: """ Lookup the store in available instance cache, and instantiate a new one using registered factory function, if not found. If the key is :data:`.None`, the default store will be instantiated(if required) and returned. :param key: the store unique id to lookup. """ if key is None: if self._default is None: raise DefaultStoreError() key = self._default if key not in self.stores: factory = _factories[key] self.stores[key] = factory() return self.stores[key]
@property def default_store(self) -> Store: """ The same as the :meth:`.get` without parameter. """ return self.get()
[docs] def bind_events(self) -> None: """ Binds the required event on sqlalchemy session. to handle commit & rollback. """ event.listen(self.session, 'after_commit', self.on_commit) event.listen(self.session, 'after_soft_rollback', self.on_rollback) event.listen(self.session, 'persistent_to_deleted', self.on_delete)
[docs] def unbind_events(self) -> None: """ Opposite of :meth:`bind_events`. """ event.remove(self.session, 'after_commit', self.on_commit) event.remove(self.session, 'after_soft_rollback', self.on_rollback) event.remove(self.session, 'persistent_to_deleted', self.on_delete)
[docs] def orphaned(self, *attachments) -> None: """ Mark one or more attachment(s) orphaned, So if :attr:`delete_orphan` is :data:`.True`, the attachment(s) will be deleted from store after session commit. """ if not self.delete_orphan: return for attachment in attachments: if attachment in self._files_orphaned: continue self._files_orphaned.append(attachment) for child in attachment.get_orphaned_objects(): if child in self._files_orphaned: continue self._files_orphaned.append(child)
[docs] def adopted(self, *attachments) -> None: """ Opposite of :meth:`.orphaned` """ if not self.delete_orphan: return for f in attachments: if f in self._files_orphaned: self._files_orphaned.remove(f)
# noinspection PyUnresolvedReferences
[docs] def register_to_delete_after_commit(self, *attachments: Iterable['Attachment']) -> None: """ Schedules one or more attachment(s) to be deleted from store just after sqlalchemy session commit. """ for attachment in attachments: self._files_to_delete_after_commit.extend(attachment.get_objects_to_delete())
# noinspection PyUnresolvedReferences
[docs] def register_to_delete_after_rollback(self, *files: Iterable['Attachment']) -> None: """ Schedules one or more attachment(s) to be deleted from store just after sqlalchemy session rollback. """ self._files_to_delete_after_rollback.extend(files)
[docs] def reset_files_state(self) -> None: """ Reset the object's state and forget all scheduled tasks for commit and or rollback. .. warning:: Calling this method without knowing what you are doing, will be caused bad result ! """ self._files_to_delete_after_commit = [] self._files_to_delete_after_rollback = [] self._files_orphaned = []
# noinspection PyUnusedLocal
[docs] def on_commit(self, session) -> None: """ Will be called when session commit occurred. """ for f in self._files_to_delete_after_commit: f.delete() if self.delete_orphan: for f in self._files_orphaned: f.delete() self.reset_files_state()
# noinspection PyUnusedLocal
[docs] def on_rollback(self, session, transaction): """ Will be called when session rollback occurred. """ for f in self._files_to_delete_after_rollback: f.delete() self.reset_files_state()
# noinspection PyUnusedLocal
[docs] def on_delete(self, session, instance): """ Will be called when an model instance deleted. """ for attribute in _observing_attributes: if isinstance(instance, attribute.class_): value = getattr(instance, attribute.key) if value: self.register_to_delete_after_commit(value.copy())
[docs] @classmethod def observe_attribute(cls, attr, collection=False): """ Attach some event handlers on sqlalchemy attribute to handle delete_orphan option. """ if attr not in _observing_attributes: _observing_attributes.add(attr) # noinspection PyUnusedLocal def on_set_attr(target, value, old_value, initiator): if old_value is None or old_value in (symbol('NEVER_SET'), symbol('NO_VALUE')): return store_manager = StoreManager.get_current_store_manager() if store_manager.delete_orphan: if value is not old_value: if collection: if isinstance(old_value, dict): store_manager.orphaned(*(set(old_value.values()) - set(value.values()))) else: store_manager.orphaned(*(set(old_value) - set(value))) else: store_manager.orphaned(old_value) event.listen(attr, 'set', on_set_attr, propagate=True)
def store_manager(session, delete_orphan=True): def decorator(func): @functools.wraps(func) def wrapper(*args, **kwargs): with StoreManager(session, delete_orphan=delete_orphan): return func(*args, **kwargs) return wrapper return decorator