Source code for edeposit.amqp.settings

#! /usr/bin/env python
# -*- coding: utf-8 -*-
"""
Module is containing all necessary global variables for package.

Module also has ability to read user-defined data from two paths:
$HOME/:attr:`SETTINGS_PATH` and /etc/:attr:`SETTINGS_PATH`.

Note:
    If the first path is found, other is ignored.

Example of the configuration file (``$HOME/edeposit/amqp.json``)::

    {
        "RABBITMQ_HOST": "localhost",
        "RABBITMQ_PORT": "2222"
    }

Attributes
----------
"""
import json
import os
import os.path


#= module configuration =======================================================
RABBITMQ_HOST = '127.0.0.1'  #:
RABBITMQ_PORT = '5672'  #:
RABBITMQ_USER_NAME = 'guest'  #:
RABBITMQ_USER_PASSWORD = 'guest'  #:

RABBITMQ_ALEPH_VIRTUALHOST = "aleph"  #:
RABBITMQ_ALEPH_DAEMON_QUEUE = "daemon"  #:
RABBITMQ_ALEPH_PLONE_QUEUE = "plone"  #:
RABBITMQ_ALEPH_EXCHANGE = "search"  #:
RABBITMQ_ALEPH_DAEMON_KEY = "request"  #:
RABBITMQ_ALEPH_PLONE_KEY = "result"  #:
RABBITMQ_ALEPH_EXCEPTION_KEY = "exception"  #:


#= user configuration reader ==================================================
_ALLOWED = [str, int, float]

SETTINGS_PATH = "/edeposit/amqp.json"
"""
Path which is appended to default search paths (``$HOME`` and ``/etc``).

Note:
    It has to start with ``/``. Variable is **appended** to the default search
    paths, so this doesn't mean, that the path is absolute!
"""


[docs]def get_all_constants(): """ Get list of all uppercase, non-private globals (doesn't start with ``_``). Returns: list: Uppercase names defined in `globals()` (variables from this \ module). """ return filter( lambda key: key.upper() == key and type(globals()[key]) in _ALLOWED, filter( # filter _PRIVATE variables lambda x: not x.startswith("_"), globals().keys() ) )
[docs]def substitute_globals(config_dict): """ Set global variables to values defined in `config_dict`. Args: config_dict (dict): dictionary with data, which are used to set \ `globals`. Note: `config_dict` have to be dictionary, or it is ignored. Also all variables, that are not already in globals, or are not types defined in :attr:`_ALLOWED` (str, int, float) or starts with ``_`` are silently ignored. """ constants = get_all_constants() if type(config_dict) != dict: return for key in config_dict.keys(): if key in constants and type(config_dict[key]) in _ALLOWED: globals()[key] = config_dict[key] # try to read data from configuration paths ($HOME/SETTINGS_PATH, # /etc/SETTINGS_PATH)
if "HOME" in os.environ and os.path.exists(os.environ["HOME"] + SETTINGS_PATH): with open(os.environ["HOME"] + SETTINGS_PATH) as f: substitute_globals(json.loads(f.read())) elif os.path.exists("/etc" + SETTINGS_PATH): with open("/etc" + SETTINGS_PATH) as f: substitute_globals(json.loads(f.read()))