/usr/lib/python2.7/dist-packages/spyne/service.py is in python-spyne 2.12.11-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 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 | #
# spyne - Copyright (C) Spyne contributors.
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
#
"""
This module contains the :class:`ServiceBase` class and its helper objects.
"""
import logging
logger = logging.getLogger(__name__)
import collections
from spyne import EventManager
from spyne.util import six
from spyne.util.oset import oset
class ServiceBaseMeta(type):
"""Creates the :class:`spyne.MethodDescriptor` objects by iterating over
tagged methods.
"""
def __init__(self, cls_name, cls_bases, cls_dict):
super(ServiceBaseMeta, self).__init__(cls_name, cls_bases, cls_dict)
self.__has_aux_methods = self.__aux__ is not None
self.public_methods = {}
self.event_manager = EventManager(self,
self.__get_base_event_handlers(cls_bases))
for k, v in cls_dict.items():
if hasattr(v, '_is_rpc'):
descriptor = v(_default_function_name=k)
# these two lines are needed for staticmethod wrapping to work
setattr(self, k, staticmethod(descriptor.function))
descriptor.reset_function(getattr(self, k))
try:
getattr(self, k).descriptor = descriptor
except AttributeError as e:
pass
# FIXME: this fails with builtins. Temporary hack while we
# investigate whether we really need this or not
descriptor.service_class = self
self.public_methods[k] = descriptor
if descriptor.aux is None:
if self.__has_aux_methods and self.__aux__ is None:
raise Exception("You can't mix primary and "
"auxiliary methods in a single service definition.")
else:
self.__has_aux_methods = True
def __get_base_event_handlers(self, cls_bases):
handlers = {}
for base in cls_bases:
evmgr = getattr(base, 'event_manager', None)
if evmgr is None:
continue
for k, v in evmgr.handlers.items():
handler=handlers.get(k, oset())
for h in v:
handler.add(h)
handlers[k]=handler
return handlers
def is_auxiliary(self):
return self.__has_aux_methods
@six.add_metaclass(ServiceBaseMeta)
class ServiceBase(object):
"""The ``ServiceBase`` class is the base class for all service definitions.
The convention is to have public methods defined under a subclass of this
class along with common properties of public methods like header classes or
auxiliary processors. The :func:`spyne.decorator.srpc` decorator or its
wrappers should be used to flag public methods.
This class is designed to be subclassed just once. You're supposed to
combine ServiceBase subclasses in order to get the public method mix you
want.
It is a natural abstract base class, because it's of no use without any
method definitions, hence the 'Base' suffix in the name.
This class supports the following events:
* ``method_call``
Called right before the service method is executed
* ``method_return_object``
Called right after the service method is executed
* ``method_exception_object``
Called when an exception occurred in a service method, before the
exception is serialized.
* ``method_accept_document``
Called by the transport right after the incoming stream is parsed to
the incoming protocol's document type.
* ``method_return_document``
Called by the transport right after the outgoing object is
serialized to the outgoing protocol's document type.
* ``method_exception_document``
Called by the transport right before the outgoing exception object
is serialized to the outgoing protocol's document type.
* ``method_return_string``
Called by the transport right before passing the return string to
the client.
* ``method_exception_string``
Called by the transport right before passing the exception string to
the client.
"""
__in_header__ = None
"""The incoming header object that the methods under this service definition
accept."""
__out_header__ = None
"""The outgoing header object that the methods under this service definition
accept."""
__service_name__ = None
"""The name of this service definition as exposed in the interface document.
Defaults to the class name."""
__port_types__ = ()
"""WSDL-Specific portType mappings"""
__aux__ = None
"""The auxiliary method type. When set, the ``aux`` property of every method
defined under this service is set to this value. The _aux flag in the @srpc
decorator overrides this."""
@classmethod
def get_service_class_name(cls):
return cls.__name__
@classmethod
def get_service_key(cls, app):
return '{%s}%s' % (app.tns, cls.get_service_name())
@classmethod
def get_service_name(cls):
if cls.__service_name__ is None:
return cls.__name__
else:
return cls.__service_name__
@classmethod
def get_port_types(cls):
return cls.__port_types__
@classmethod
def _has_callbacks(cls):
"""Determines if this service definition has callback methods or not."""
for method in cls.public_methods.values():
if method.is_callback:
return True
return False
@classmethod
def call_wrapper(cls, ctx):
"""Called in place of the original method call. You can override this to
do your own exception handling.
:param ctx: The method context.
The overriding function must call this function by convention.
"""
if ctx.function is not None:
args = ctx.in_object
# python3 wants a proper sequence as *args
assert not isinstance(args, six.string_types)
if not isinstance(args, collections.Sequence):
args = tuple(args)
if ctx.descriptor.no_ctx:
return ctx.function(*args)
else:
return ctx.function(ctx, *args)
@classmethod
def initialize(cls, app):
pass
|