WebserviceBase.__init__() - Code Metrics - Inspection of "Added logging" - trocafone/correios-lib - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/acompanhar_pedido ( b64008 )

by Flávio

created 2016-07-18 16:49 UTC

WebserviceBase.init() A

↳ Parent: WebserviceBase

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	4.25

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
c	3
b	0
f	0
dl	0
loc	56
ccs	6
cts	8
cp	0.75
rs	9.0544
cc	4
crap	4.25

How to fix Long Method

# -*- coding: utf-8 -*-
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
# #############################################################################
#
# The MIT License (MIT)
#
# Copyright (c) 2016 Trocafone
#
# 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 zeep import Client
from zeep.transports import Transport
from voluptuous import Invalid, MultipleInvalid
import certifi
import logging.config


class WebserviceError(Exception):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    pass


class WebserviceBase():
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

    def __init__(self, env, id_correios, password,

                 cert=False, log_config=None):
        ''' Webservice initialization.

        Depending on the env get a different wsdl definition.
        New Correios SIGEP uses HTTPAuth to do requests.

        Args:
            env (str): Environment used to get the wsdl
            id_correios (str): IdCorreios given by correios website
            password (str): password vinculated to the IdCorreios
            log_config (dict): Dictionary configurations of logging
        '''

        ''' Untrusted ssl certificate for homolog envs see more at:

        https://www.ssllabs.com/ssltest/analyze.html?d=apphom.correios.com.br
        '''

        if cert is False:
            verify = False
        else:
            verify = certifi.where()

        if log_config is not None and isinstance(dict):
            """ Example config from zeep documentation:

            {
                'version': 1,
                'formatters': {
                    'verbose': {
                        'format': '%(name)s: %(message)s'
                    }
                },
                'handlers': {
                    'console': {
                        'level': 'DEBUG',
                        'class': 'logging.StreamHandler',
                        'formatter': 'verbose',
                    },
                },
                'loggers': {
                    'zeep.transports': {
                        'level': 'DEBUG',
                        'propagate': True,
                        'handlers': ['console'],
                    },
                }
            }
            """

            logging.config.dictConfig(log_config)

        t = Transport(

            verify=verify,
            http_auth=(id_correios, password)
        )
        self.client = Client(wsdl=self.get_env(env), transport=t)

    def get_env(self, env):
        """ Get WSDL Url.

        Must be implemented in order to return the correct WSDL.

        Args:
            env (str): Environment used to get the wsdl

        Returns:
            str: WSDL Url of the corresponding environment
        """
        raise NotImplementedError()

    def call(self, method, request):
        ''' Call the webservice method with the validated request content

        Args:
            method (str): Name of the method available at the webservice
            request (RequestObject): Object containing all the info needed

        Returns:
            dict: Result of the service call
        '''
        service_method = getattr(self.client.service, method, None)

        req_type = 'Request' + method[0].upper() + method[1:]
        req_instance = request.__class__.__name__

        if req_type != req_instance:
            raise WebserviceError(
                'Request must be an instance of {0}, given {1}'.format(
                    req_type,
                    req_instance
                 )

            )

        try:
            return service_method(**request)

        except ValueError:
            raise WebserviceError('The method you are trying to call does not '
                                  'exists.')


class EntityBase(dict):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

    def __init__(self, **kargs):
        super(EntityBase, self).__init__(kargs)
        self.validate()

        try:
            raise getattr(self, 'error')
        except AttributeError:
            pass
        except Invalid as e:
            raise MultipleInvalid([e])

    def get_schema(self):
        """ Returns validation schema

        Returns:
            voluptous.Schema: Schema with validation rules
        """
        raise NotImplementedError("Every entitiy needs validation against a " +
                                  "Schema.")

    def validate(self):
        """ Validates content against schema

        In case of failure an error is kept inside the entity object,
        to be displayed by the client user if needed.

        Returns:
            bool: Validation result
        """
        schema = self.get_schema()
        try:
            super(EntityBase, self).__init__(schema(self))
            return True
        except Exception as e:

            self.error = e
            return False


1		# -- coding: utf-8 --
		0 ignored issues – show Coding Style introduced 2016-07-13 14:39 UTC by Report Bug Copy Issue Report This module should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
2		# #############################################################################
3		#
4		# The MIT License (MIT)
5		#
6		# Copyright (c) 2016 Trocafone
7		#
8		# Permission is hereby granted, free of charge, to any person obtaining a copy
9		# of this software and associated documentation files (the "Software"), to deal
10		# in the Software without restriction, including without limitation the rights
11		# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12		# copies of the Software, and to permit persons to whom the Software is
13		# furnished to do so, subject to the following conditions:
14		#
15		# The above copyright notice and this permission notice shall be included in
16		# all copies or substantial portions of the Software.
17		#
18		# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19		# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20		# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21		# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22		# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23		# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24		# SOFTWARE.
25		#
26		###############################################################################
27
28	1	from zeep import Client
29	1	from zeep.transports import Transport
30	1	from voluptuous import Invalid, MultipleInvalid
31	1	import certifi
32	1	import logging.config
33
34
35	1	class WebserviceError(Exception):
		0 ignored issues – show Coding Style introduced 2016-07-13 14:39 UTC by Report Bug Copy Issue Report This class should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
36	1	pass
37
38
39	1	class WebserviceBase():
		0 ignored issues – show Coding Style introduced 2016-07-13 14:39 UTC by Report Bug Copy Issue Report This class should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history... introduced 2016-07-13 14:39 UTC by Report Bug Copy Issue Report Old-style class defined. Loading history... Complexity introduced 2016-07-15 19:18 UTC by Report Bug Copy Issue Report This abstract class seems to be used only once. Abstract classes which are used only once can usually be inlined into the class which already uses this abstract class. Loading history...
40
41	1	def __init__(self, env, id_correios, password,
		0 ignored issues – show best-practice introduced 2016-07-18 16:54 UTC by Report Bug Copy Issue Report Too many arguments (6/5) Loading history...
42		cert=False, log_config=None):
43		''' Webservice initialization.
44
45		Depending on the env get a different wsdl definition.
46		New Correios SIGEP uses HTTPAuth to do requests.
47
48		Args:
49		env (str): Environment used to get the wsdl
50		id_correios (str): IdCorreios given by correios website
51		password (str): password vinculated to the IdCorreios
52		log_config (dict): Dictionary configurations of logging
53		'''
54
55		''' Untrusted ssl certificate for homolog envs see more at:
56
57		https://www.ssllabs.com/ssltest/analyze.html?d=apphom.correios.com.br
58		'''
		0 ignored issues – show Unused Code introduced 2016-07-13 14:39 UTC by Report Bug Copy Issue Report This string statement has no effect and could be removed. Loading history...
59	1	if cert is False:
60	1	verify = False
61		else:
62		verify = certifi.where()
63
64	1	if log_config is not None and isinstance(dict):
65		""" Example config from zeep documentation:
66
67		{
68		'version': 1,
69		'formatters': {
70		'verbose': {
71		'format': '%(name)s: %(message)s'
72		}
73		},
74		'handlers': {
75		'console': {
76		'level': 'DEBUG',
77		'class': 'logging.StreamHandler',
78		'formatter': 'verbose',
79		},
80		},
81		'loggers': {
82		'zeep.transports': {
83		'level': 'DEBUG',
84		'propagate': True,
85		'handlers': ['console'],
86		},
87		}
88		}
89		"""
		0 ignored issues – show Unused Code introduced 2016-07-18 16:54 UTC by Report Bug Copy Issue Report This string statement has no effect and could be removed. Loading history...
90		logging.config.dictConfig(log_config)
91
92	1	t = Transport(
		0 ignored issues – show Coding Style Naming introduced 2016-07-13 14:39 UTC by Report Bug Copy Issue Report The name `t` does not conform to the variable naming conventions (`[a-z_][a-z0-9_]{2,30}$`). This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history...
93		verify=verify,
94		http_auth=(id_correios, password)
95		)
96	1	self.client = Client(wsdl=self.get_env(env), transport=t)
97
98	1	def get_env(self, env):
99		""" Get WSDL Url.
100
101		Must be implemented in order to return the correct WSDL.
102
103		Args:
104		env (str): Environment used to get the wsdl
105
106		Returns:
107		str: WSDL Url of the corresponding environment
108		"""
109	1	raise NotImplementedError()
110
111	1	def call(self, method, request):
112		''' Call the webservice method with the validated request content
113
114		Args:
115		method (str): Name of the method available at the webservice
116		request (RequestObject): Object containing all the info needed
117
118		Returns:
119		dict: Result of the service call
120		'''
121	1	service_method = getattr(self.client.service, method, None)
122
123	1	req_type = 'Request' + method[0].upper() + method[1:]
124	1	req_instance = request.__class__.__name__
125
126	1	if req_type != req_instance:
127	1	raise WebserviceError(
128		'Request must be an instance of {0}, given {1}'.format(
129		req_type,
130		req_instance
131		)
		0 ignored issues – show Coding Style introduced 2016-07-18 16:54 UTC by Report Bug Copy Issue Report Wrong hanging indentation. ) \|^ \| Loading history...
132		)
133
134	1	try:
135	1	return service_method(**request)
		0 ignored issues – show Coding Style introduced 2016-07-18 16:54 UTC by Report Bug Copy Issue Report Usage of `` or `` arguments should usually be done with care. Generally, there is nothing wrong with usage of `` or `**` arguments. For readability of the code base, we suggest to not over-use these language constructs though. For more information, we can recommend this blog post from Ned Batchelder including its comments which also touches this aspect. Loading history...
136		except ValueError:
137		raise WebserviceError('The method you are trying to call does not '
138		'exists.')
139
140
141	1	class EntityBase(dict):
		0 ignored issues – show Coding Style introduced 2016-07-13 14:39 UTC by Report Bug Copy Issue Report This class should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
142
143	1	def __init__(self, **kargs):
144	1	super(EntityBase, self).__init__(kargs)
145	1	self.validate()
146
147	1	try:
148	1	raise getattr(self, 'error')
149	1	except AttributeError:
150	1	pass
151	1	except Invalid as e:
152	1	raise MultipleInvalid([e])
153
154	1	def get_schema(self):
155		""" Returns validation schema
156
157		Returns:
158		voluptous.Schema: Schema with validation rules
159		"""
160		raise NotImplementedError("Every entitiy needs validation against a " +
161		"Schema.")
162
163	1	def validate(self):
164		""" Validates content against schema
165
166		In case of failure an error is kept inside the entity object,
167		to be displayed by the client user if needed.
168
169		Returns:
170		bool: Validation result
171		"""
172	1	schema = self.get_schema()
173	1	try:
174	1	super(EntityBase, self).__init__(schema(self))
175	1	return True
176	1	except Exception as e:
		0 ignored issues – show Best Practice introduced 2016-07-13 14:39 UTC by Report Bug Copy Issue Report Catching very general exceptions such as `Exception` is usually not recommended. Generally, you would want to handle very specific errors in the exception handler. This ensure that you do not hide other types of errors which should be fixed. So, unless you specifically plan to handle any error, consider adding a more specific exception. Loading history...
177	1	self.error = e
178		return False
179

trocafone / correios-lib

GitHub Access Token became invalid

Push — feature/acompanhar_pedido ( b64008 )

WebserviceBase.__init__() A

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

WebserviceBase.init() A