/usr/lib/python3/dist-packages/hug/directives.py is in python3-hug 2.3.0-1.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 | """hug/directives.py
Defines the directives built into hug. Directives allow attaching behaviour to an API handler based simply
on an argument it takes and that arguments default value. The directive gets called with the default supplied,
ther request data, and api_version. The result of running the directive method is then set as the argument value.
Directive attributes are always prefixed with 'hug_'
Copyright (C) 2016 Timothy Edmund Crosley
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or
substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
"""
from __future__ import absolute_import
from functools import partial
from timeit import default_timer as python_timer
from hug import introspect
def _built_in_directive(directive):
"""Marks a callable as a built-in directive"""
directive.directive = True
return directive
@_built_in_directive
class Timer(object):
"""Keeps track of time surpased since instantiation, outputed by doing float(instance)"""
__slots__ = ('start', 'round_to')
def __init__(self, round_to=None, **kwargs):
self.start = python_timer()
self.round_to = round_to
def __float__(self):
time_taken = python_timer() - self.start
return round(time_taken, self.round_to) if self.round_to else time_taken
def __int__(self):
return int(round(float(self)))
def __native_types__(self):
return self.__float__()
def __str__(self):
return str(float(self))
def __repr__(self):
return "{}({})".format(self.__class__.__name__, self)
@_built_in_directive
def module(default=None, api=None, **kwargs):
"""Returns the module that is running this hug API function"""
return api.module if api else default
@_built_in_directive
def api(default=None, api=None, **kwargs):
"""Returns the api instance in which this API function is being ran"""
return api if api else default
@_built_in_directive
def api_version(default=None, api_version=None, **kwargs):
"""Returns the current api_version as a directive for use in both request and not request handling code"""
return api_version
@_built_in_directive
def documentation(default=None, api_version=None, api=None, **kwargs):
"""returns documentation for the current api"""
api_version = default or api_version
if api:
return api.http.documentation(base_url="", api_version=api_version)
@_built_in_directive
def session(context_name='session', request=None, **kwargs):
"""Returns the session associated with the current request"""
return request and request.context.get(context_name, None)
@_built_in_directive
def user(default=None, request=None, **kwargs):
"""Returns the current logged in user"""
return request and request.context.get('user', None) or default
@_built_in_directive
class CurrentAPI(object):
"""Returns quick access to all api functions on the current version of the api"""
__slots__ = ('api_version', 'api')
def __init__(self, default=None, api_version=None, **kwargs):
self.api_version = api_version
self.api = api(**kwargs)
def __getattr__(self, name):
function = self.api.http.versioned.get(self.api_version, {}).get(name, None)
if not function:
function = self.api.http.versioned.get(None, {}).get(name, None)
if not function:
raise AttributeError('API Function {0} not found'.format(name))
accepts = function.interface.arguments
if 'hug_api_version' in accepts:
function = partial(function, hug_api_version=self.api_version)
if 'hug_current_api' in accepts:
function = partial(function, hug_current_api=self)
return function
|