src.cm.utils.decorators Namespace Reference

Here are placed decorators for: More...

Functions
def	admin_cm_log
	Decorator for functions requiring admin_cm's privilidges.
def	ci_log
	Decorator for functions requiring only guest's privilidges.
def	ctx_log
	Decorator for functions requiring only guest's privilidges.
def	ec2ctx_log
	Decorator for functions requiring only guest's privilidges.
def	genericlog
	Generic log is called by actor decorators defined in src.clm.utils.decorators :
def	guest_log
	Decorator for functions requiring only guest's privilidges.
def	user_log
	Decorator for functions requiring logged in user's privilidges.

Variables
tuple	ci_decorated_functions = set([])
tuple	ctx_decorated_functions = set([])
tuple	decorated_functions = set([])
dictionary	locks

Detailed Description

Here are placed decorators for:

• actor functions (and the src.cm.utils.decorators.genericlog() function called by all those),
• ctx functions,
• rm functions.

Actor decorators

• src.cm.utils.decorators.guest_log
• src.cm.utils.decorators.user_log
• src.cm.utils.decorators.admin_cm_log

Those actor decorators call src.cm.utils.decorators.genericlog(). By default those decorators call src.cm.utils.decorators.genericlog with logging disabled. You can enable it by giving kwarg log=True , when decorating, eg.:

@admin_clm_log(log=False)
def get_by_id(cm_id, caller_id, id):
    pass

Author

Tomasz Sośnicki tom.s.nosp@m.osni.nosp@m.cki@g.nosp@m.mail.nosp@m..com

Maciej Nabożny mn@mn.nosp@m.aboz.nosp@m.ny.pl

Function Documentation

def src.cm.utils.decorators.admin_cm_log	(		arg,
			kw
	)

Decorator for functions requiring admin_cm's privilidges.

src.cm.utils.decorators.genericlog is called with parameters:

• is_user=True
• is_superuser=True

Decorated function's declaration

@admin_clm_log[(log=<False|True>)]
function (cm_id, caller_id, *args, **kw)

Decorated function's call

function (caller_id, admin_password, *arg, **kw)

admin_password argument is removed by src.cm.utils.decorators.genericlog(), so it doesn't appear in formal parameters of the function.

Definition at line 165 of file decorators.py.

def src.cm.utils.decorators.ci_log	(		arg,
			kw
	)

Decorator for functions requiring only guest's privilidges.

src.cm.utils.decorators.genericlog() is called with parameters:

• is_user=False
• is_superuser=False

Decorated function's declaration

@guest_log[(log=<False|True>)]
function (*arg, **kw)

Decorated function's call

function (*arg, **kw)

Definition at line 196 of file decorators.py.

def src.cm.utils.decorators.ctx_log	(		arg,
			kw
	)

Decorator for functions requiring only guest's privilidges.

src.cm.utils.decorators.genericlog() is called with parameters:

• is_user=False
• is_superuser=False

Decorated function's declaration

@guest_log[(log=<False|True>)]
function (*arg, **kw)

Decorated function's call

function (*arg, **kw)

Definition at line 227 of file decorators.py.

def src.cm.utils.decorators.ec2ctx_log	(		arg,
			kw
	)

Decorator for functions requiring only guest's privilidges.

src.cm.utils.decorators.genericlog() is called with parameters:

• is_user=False
• is_superuser=False

Decorated function's declaration

@guest_log[(log=<False|True>)]
function (*arg, **kw)

Decorated function's call

function (*arg, **kw)

Definition at line 292 of file decorators.py.

def src.cm.utils.decorators.genericlog	(		log_enabled,
			is_user,
			is_admin_cm,
			need_ip,
			fun,
			args
	)

Generic log is called by actor decorators defined in src.clm.utils.decorators :

• src.cm.utils.decorators.guest_log
• src.cm.utils.decorators.user_log
• src.cm.utils.decorators.admin_cm_log

It calls decorated functions, additionally performing several tasks.

Genericlog performes:

1. if decorated function requires user or admin privilidges: authorization;
2. execution of the decorated function;
3. if log_enabled=TRUE or if return status isn't 'ok': debug log of the user_id, function name and arguments;
4. if exception is thrown: general exception log;
5. if return status isn't 'ok' or log_enabled: debug log of the response.

Returns

(dict) HttpResponse response with content of JSON-ed tuple (status, data), where status should be "ok" if everything went fine.

Definition at line 336 of file decorators.py.

def src.cm.utils.decorators.guest_log	(		arg,
			kw
	)

Decorator for functions requiring only guest's privilidges.

src.cm.utils.decorators.genericlog() is called with parameters:

• is_user=False
• is_superuser=False

Decorated function's declaration

@guest_log[(log=<False|True>)]
function (*arg, **kw)

Decorated function's call

function (*arg, **kw)

Definition at line 99 of file decorators.py.

def src.cm.utils.decorators.user_log	(		arg,
			kw
	)

Decorator for functions requiring logged in user's privilidges.

src.cm.utils.decorators.genericlog() is called with parameters:

• is_user=True
• is_superuser=False

Decorated function's declaration

@user_log[(log=<False|True>)]
function (cm_id, caller_id, *args, **kw)

Decorated function's call

function (caller_id, *arg, **kw)

Definition at line 130 of file decorators.py.

Variable Documentation

tuple src.cm.utils.decorators.ci_decorated_functions = set([])

Definition at line 68 of file decorators.py.

tuple src.cm.utils.decorators.ctx_decorated_functions = set([])

Definition at line 69 of file decorators.py.

tuple src.cm.utils.decorators.decorated_functions = set([])

Definition at line 67 of file decorators.py.

dictionary src.cm.utils.decorators.locks

Initial value:

{
    'vmcreate': Lock()
}

Definition at line 72 of file decorators.py.