PythonActionWrapper - Code Metrics - Inspection of "PIP 8.1.2 compatibility." - Plexxi/st2 - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — pip_8.1.2 ( 36f804 )

unknown

created 2016-08-08 17:28 UTC

PythonActionWrapper A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	98
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	98
rs	10
wmc	15

3 Methods

Rating	Name	Size	Complexity
B	_get_action_instance()	22	4
B	__init__()	37	3
D	run()	36	8

# Licensed to the StackStorm, Inc ('StackStorm') under one or more
# contributor license agreements.  See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License.  You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import sys
import json
import argparse
from oslo_config import cfg

from st2common import log as logging
from st2actions import config
from st2actions.runners.pythonrunner import Action
from st2actions.runners.utils import get_logger_for_python_runner_action
from st2actions.runners.utils import get_action_class_instance
from st2common.util import loader as action_loader
from st2common.util.config_loader import ContentPackConfigLoader
from st2common.constants.action import ACTION_OUTPUT_RESULT_DELIMITER
from st2common.constants.keyvalue import SYSTEM_SCOPE
from st2common.constants.runners import PYTHON_RUNNER_INVALID_ACTION_STATUS_EXIT_CODE
from st2common.service_setup import db_setup
from st2common.services.datastore import DatastoreService

__all__ = [
    'PythonActionWrapper',
    'ActionService'
]

LOG = logging.getLogger(__name__)

INVALID_STATUS_ERROR_MESSAGE = """
If this is an existing action which returns a tuple with two items, it needs to be updated to
either:

1. Return a list instead of a tuple
2. Return a tuple where a first items is a status flag - (True, ('item1', 'item2'))

For more information, please see: https://docs.stackstorm.com/upgrade_notes.html#st2-v1-6
""".strip()


class ActionService(object):
    """
    Instance of this class is passed to the action instance and exposes "public"
    methods which can be called by the action.
    """

    def __init__(self, action_wrapper):
        logger = get_logger_for_python_runner_action(action_name=action_wrapper._class_name)
class MyParent:
    def __init__(self):
        self._x = 1;
        self.y = 2;

class MyChild(MyParent):
    def some_method(self):
        return self._x    # Ok, since accessed from a child class

class AnotherClass:
    def some_method(self, instance_of_my_child):
        return instance_of_my_child._x   # Would be flagged as AnotherClass is not
                                         # a child class of MyParent

        self._action_wrapper = action_wrapper
        self._datastore_service = DatastoreService(logger=logger,
                                                   pack_name=self._action_wrapper._pack,
class MyParent:
    def __init__(self):
        self._x = 1;
        self.y = 2;

class MyChild(MyParent):
    def some_method(self):
        return self._x    # Ok, since accessed from a child class

class AnotherClass:
    def some_method(self, instance_of_my_child):
        return instance_of_my_child._x   # Would be flagged as AnotherClass is not
                                         # a child class of MyParent
                                                   class_name=self._action_wrapper._class_name,
class MyParent:
    def __init__(self):
        self._x = 1;
        self.y = 2;

class MyChild(MyParent):
    def some_method(self):
        return self._x    # Ok, since accessed from a child class

class AnotherClass:
    def some_method(self, instance_of_my_child):
        return instance_of_my_child._x   # Would be flagged as AnotherClass is not
                                         # a child class of MyParent
                                                   api_username='action_service')

    ##################################
    # Methods for datastore management
    ##################################

    def list_values(self, local=True, prefix=None):
        return self._datastore_service.list_values(local, prefix)

    def get_value(self, name, local=True, scope=SYSTEM_SCOPE, decrypt=False):
        return self._datastore_service.get_value(name, local, scope=scope, decrypt=decrypt)

    def set_value(self, name, value, ttl=None, local=True, scope=SYSTEM_SCOPE, encrypt=False):
        return self._datastore_service.set_value(name, value, ttl, local, scope=scope,
                                                 encrypt=encrypt)

    def delete_value(self, name, local=True, scope=SYSTEM_SCOPE):
        return self._datastore_service.delete_value(name, local)


class PythonActionWrapper(object):
    def __init__(self, pack, file_path, parameters=None, user=None, parent_args=None):
param = 5

class Foo:
    def __init__(self, param):   # "param" would be flagged here
        self.param = param
        """
        :param pack: Name of the pack this action belongs to.
        :type pack: ``str``

        :param file_path: Path to the action module.
        :type file_path: ``str``

        :param parameters: action parameters.
        :type parameters: ``dict`` or ``None``

        :param user: Name of the user who triggered this action execution.
        :type user: ``str``

        :param parent_args: Command line arguments passed to the parent process.
        :type parse_args: ``list``
        """

        self._pack = pack
        self._file_path = file_path
        self._parameters = parameters or {}
        self._user = user
        self._parent_args = parent_args or []
        self._class_name = None
        self._logger = logging.getLogger('PythonActionWrapper')

        try:
            config.parse_args(args=self._parent_args)
        except Exception:
            pass

        db_setup()

        # Note: We can only set a default user value if one is not provided after parsing the
        # config
        if not self._user:
            self._user = cfg.CONF.system_user.user

    def run(self):
        action = self._get_action_instance()
        output = action.run(**self._parameters)

        if isinstance(output, tuple) and len(output) == 2:
            # run() method returned status and data - (status, data)
            action_status = output[0]
            action_result = output[1]
        else:
            # run() method returned only data, no status (pre StackStorm v1.6)
            action_status = None
            action_result = output

        action_output = {
            'result': action_result,
            'status': None
        }

        if action_status is not None and not isinstance(action_status, bool):
            sys.stderr.write('Status returned from the action run() method must either be '
                             'True or False, got: %s\n' % (action_status))
            sys.stderr.write(INVALID_STATUS_ERROR_MESSAGE)
            sys.exit(PYTHON_RUNNER_INVALID_ACTION_STATUS_EXIT_CODE)

        if action_status is not None and isinstance(action_status, bool):
            action_output['status'] = action_status

        try:
            print_output = json.dumps(action_output)
        except Exception:
            print_output = str(action_output)

        # Print output to stdout so the parent can capture it
        sys.stdout.write(ACTION_OUTPUT_RESULT_DELIMITER)
        sys.stdout.write(print_output + '\n')
        sys.stdout.write(ACTION_OUTPUT_RESULT_DELIMITER)

    def _get_action_instance(self):
        actions_cls = action_loader.register_plugin(Action, self._file_path)
        action_cls = actions_cls[0] if actions_cls and len(actions_cls) > 0 else None

        if not action_cls:
            raise Exception('File "%s" has no action or the file doesn\'t exist.' %
                            (self._file_path))

        config_loader = ContentPackConfigLoader(pack_name=self._pack, user=self._user)
        config = config_loader.get_config()
param = 5

class Foo:
    def __init__(self, param):   # "param" would be flagged here
        self.param = param

        if config:
            LOG.info('Found config for action "%s"' % (self._file_path))
        else:
            LOG.info('No config found for action "%s"' % (self._file_path))
            config = None

        action_service = ActionService(action_wrapper=self)
        action_instance = get_action_class_instance(action_cls=action_cls,
                                                    config=config,
                                                    action_service=action_service)
        return action_instance


if __name__ == '__main__':
    parser = argparse.ArgumentParser(description='Python action runner process wrapper')
    parser.add_argument('--pack', required=True,
                        help='Name of the pack this action belongs to')
    parser.add_argument('--file-path', required=True,
                        help='Path to the action module')
    parser.add_argument('--parameters', required=False,
                        help='Serialized action parameters')
    parser.add_argument('--user', required=False,
                        help='User who triggered the action execution')
    parser.add_argument('--parent-args', required=False,
                        help='Command line arguments passed to the parent process')
    args = parser.parse_args()

    parameters = args.parameters
    parameters = json.loads(parameters) if parameters else {}
    user = args.user
    parent_args = json.loads(args.parent_args) if args.parent_args else []

    assert isinstance(parent_args, list)
    obj = PythonActionWrapper(pack=args.pack,
                              file_path=args.file_path,
                              parameters=parameters,
                              user=user,
                              parent_args=parent_args)

    obj.run()


1			# Licensed to the StackStorm, Inc ('StackStorm') under one or more
2			# contributor license agreements. See the NOTICE file distributed with
3			# this work for additional information regarding copyright ownership.
4			# The ASF licenses this file to You under the Apache License, Version 2.0
5			# (the "License"); you may not use this file except in compliance with
6			# the License. You may obtain a copy of the License at
7			#
8			# http://www.apache.org/licenses/LICENSE-2.0
9			#
10			# Unless required by applicable law or agreed to in writing, software
11			# distributed under the License is distributed on an "AS IS" BASIS,
12			# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13			# See the License for the specific language governing permissions and
14			# limitations under the License.
15
16			import sys
17			import json
18			import argparse
19			from oslo_config import cfg
20
21			from st2common import log as logging
22			from st2actions import config
23			from st2actions.runners.pythonrunner import Action
24			from st2actions.runners.utils import get_logger_for_python_runner_action
25			from st2actions.runners.utils import get_action_class_instance
26			from st2common.util import loader as action_loader
27			from st2common.util.config_loader import ContentPackConfigLoader
28			from st2common.constants.action import ACTION_OUTPUT_RESULT_DELIMITER
29			from st2common.constants.keyvalue import SYSTEM_SCOPE
30			from st2common.constants.runners import PYTHON_RUNNER_INVALID_ACTION_STATUS_EXIT_CODE
31			from st2common.service_setup import db_setup
32			from st2common.services.datastore import DatastoreService
33
34			__all__ = [
35			'PythonActionWrapper',
36			'ActionService'
37			]
38
39			LOG = logging.getLogger(__name__)
40
41			INVALID_STATUS_ERROR_MESSAGE = """
42			If this is an existing action which returns a tuple with two items, it needs to be updated to
43			either:
44
45			1. Return a list instead of a tuple
46			2. Return a tuple where a first items is a status flag - (True, ('item1', 'item2'))
47
48			For more information, please see: https://docs.stackstorm.com/upgrade_notes.html#st2-v1-6
49			""".strip()
50
51
52			class ActionService(object):
53			"""
54			Instance of this class is passed to the action instance and exposes "public"
55			methods which can be called by the action.
56			"""
57
58			def __init__(self, action_wrapper):
59			logger = get_logger_for_python_runner_action(action_name=action_wrapper._class_name)
			0 ignored issues – show Coding Style Best Practice introduced 2016-02-22 18:43 UTC by Report Bug Copy Issue Report It seems like `_class_name` was declared protected and should not be accessed from this context. Prefixing a member variable `_` is usually regarded as the equivalent of declaring it with protected visibility that exists in other languages. Consequentially, such a member should only be accessed from the same class or a child class: class MyParent: def __init__(self): self._x = 1; self.y = 2; class MyChild(MyParent): def some_method(self): return self._x # Ok, since accessed from a child class class AnotherClass: def some_method(self, instance_of_my_child): return instance_of_my_child._x # Would be flagged as AnotherClass is not # a child class of MyParent Loading history...
60
61			self._action_wrapper = action_wrapper
62			self._datastore_service = DatastoreService(logger=logger,
63			pack_name=self._action_wrapper._pack,
			0 ignored issues – show Coding Style Best Practice introduced 2016-02-22 18:43 UTC by Report Bug Copy Issue Report It seems like `_pack` was declared protected and should not be accessed from this context. Prefixing a member variable `_` is usually regarded as the equivalent of declaring it with protected visibility that exists in other languages. Consequentially, such a member should only be accessed from the same class or a child class: class MyParent: def __init__(self): self._x = 1; self.y = 2; class MyChild(MyParent): def some_method(self): return self._x # Ok, since accessed from a child class class AnotherClass: def some_method(self, instance_of_my_child): return instance_of_my_child._x # Would be flagged as AnotherClass is not # a child class of MyParent Loading history...
64			class_name=self._action_wrapper._class_name,
			0 ignored issues – show Coding Style Best Practice introduced 2016-02-22 18:43 UTC by Report Bug Copy Issue Report It seems like `_class_name` was declared protected and should not be accessed from this context. Prefixing a member variable `_` is usually regarded as the equivalent of declaring it with protected visibility that exists in other languages. Consequentially, such a member should only be accessed from the same class or a child class: class MyParent: def __init__(self): self._x = 1; self.y = 2; class MyChild(MyParent): def some_method(self): return self._x # Ok, since accessed from a child class class AnotherClass: def some_method(self, instance_of_my_child): return instance_of_my_child._x # Would be flagged as AnotherClass is not # a child class of MyParent Loading history...
65			api_username='action_service')
66
67			##################################
68			# Methods for datastore management
69			##################################
70
71			def list_values(self, local=True, prefix=None):
72			return self._datastore_service.list_values(local, prefix)
73
74			def get_value(self, name, local=True, scope=SYSTEM_SCOPE, decrypt=False):
75			return self._datastore_service.get_value(name, local, scope=scope, decrypt=decrypt)
76
77			def set_value(self, name, value, ttl=None, local=True, scope=SYSTEM_SCOPE, encrypt=False):
78			return self._datastore_service.set_value(name, value, ttl, local, scope=scope,
79			encrypt=encrypt)
80
81			def delete_value(self, name, local=True, scope=SYSTEM_SCOPE):
82			return self._datastore_service.delete_value(name, local)
83
84
85			class PythonActionWrapper(object):
86			def __init__(self, pack, file_path, parameters=None, user=None, parent_args=None):
			0 ignored issues – show Comprehensibility Bug introduced 2016-02-04 18:21 UTC by Report Bug Copy Issue Report `parent_args` is re-defining a name which is already available in the outer-scope (previously defined on line `202`). It is generally a bad practice to shadow variables from the outer-scope. In most cases, this is done unintentionally and might lead to unexpected behavior: param = 5 class Foo: def __init__(self, param): # "param" would be flagged here self.param = param Loading history... Comprehensibility Bug introduced 2016-05-28 06:48 UTC by Report Bug Copy Issue Report `user` is re-defining a name which is already available in the outer-scope (previously defined on line `201`). It is generally a bad practice to shadow variables from the outer-scope. In most cases, this is done unintentionally and might lead to unexpected behavior: param = 5 class Foo: def __init__(self, param): # "param" would be flagged here self.param = param Loading history... Comprehensibility Bug introduced 2016-02-04 18:21 UTC by Report Bug Copy Issue Report `parameters` is re-defining a name which is already available in the outer-scope (previously defined on line `199`). It is generally a bad practice to shadow variables from the outer-scope. In most cases, this is done unintentionally and might lead to unexpected behavior: param = 5 class Foo: def __init__(self, param): # "param" would be flagged here self.param = param Loading history...
87			"""
88			:param pack: Name of the pack this action belongs to.
89			:type pack: ``str``
90
91			:param file_path: Path to the action module.
92			:type file_path: ``str``
93
94			:param parameters: action parameters.
95			:type parameters: ``dict`` or ``None``
96
97			:param user: Name of the user who triggered this action execution.
98			:type user: ``str``
99
100			:param parent_args: Command line arguments passed to the parent process.
101			:type parse_args: ``list``
102			"""
103
104			self._pack = pack
105			self._file_path = file_path
106			self._parameters = parameters or {}
107			self._user = user
108			self._parent_args = parent_args or []
109			self._class_name = None
110			self._logger = logging.getLogger('PythonActionWrapper')
111
112			try:
113			config.parse_args(args=self._parent_args)
114			except Exception:
115			pass
116
117			db_setup()
118
119			# Note: We can only set a default user value if one is not provided after parsing the
120			# config
121			if not self._user:
122			self._user = cfg.CONF.system_user.user
123
124			def run(self):
125			action = self._get_action_instance()
126			output = action.run(**self._parameters)
127
128			if isinstance(output, tuple) and len(output) == 2:
129			# run() method returned status and data - (status, data)
130			action_status = output[0]
131			action_result = output[1]
132			else:
133			# run() method returned only data, no status (pre StackStorm v1.6)
134			action_status = None
135			action_result = output
136
137			action_output = {
138			'result': action_result,
139			'status': None
140			}
141
142			if action_status is not None and not isinstance(action_status, bool):
143			sys.stderr.write('Status returned from the action run() method must either be '
144			'True or False, got: %s\n' % (action_status))
145			sys.stderr.write(INVALID_STATUS_ERROR_MESSAGE)
146			sys.exit(PYTHON_RUNNER_INVALID_ACTION_STATUS_EXIT_CODE)
147
148			if action_status is not None and isinstance(action_status, bool):
149			action_output['status'] = action_status
150
151			try:
152			print_output = json.dumps(action_output)
153			except Exception:
154			print_output = str(action_output)
155
156			# Print output to stdout so the parent can capture it
157			sys.stdout.write(ACTION_OUTPUT_RESULT_DELIMITER)
158			sys.stdout.write(print_output + '\n')
159			sys.stdout.write(ACTION_OUTPUT_RESULT_DELIMITER)
160
161			def _get_action_instance(self):
162			actions_cls = action_loader.register_plugin(Action, self._file_path)
163			action_cls = actions_cls[0] if actions_cls and len(actions_cls) > 0 else None
164
165			if not action_cls:
166			raise Exception('File "%s" has no action or the file doesn\'t exist.' %
167			(self._file_path))
168
169			config_loader = ContentPackConfigLoader(pack_name=self._pack, user=self._user)
170			config = config_loader.get_config()
			0 ignored issues – show Comprehensibility Bug introduced 2016-05-28 06:48 UTC by Report Bug Copy Issue Report `config` is re-defining a name which is already available in the outer-scope (previously defined on line `22`). It is generally a bad practice to shadow variables from the outer-scope. In most cases, this is done unintentionally and might lead to unexpected behavior: param = 5 class Foo: def __init__(self, param): # "param" would be flagged here self.param = param Loading history...
171
172			if config:
173			LOG.info('Found config for action "%s"' % (self._file_path))
174			else:
175			LOG.info('No config found for action "%s"' % (self._file_path))
176			config = None
177
178			action_service = ActionService(action_wrapper=self)
179			action_instance = get_action_class_instance(action_cls=action_cls,
180			config=config,
181			action_service=action_service)
182			return action_instance
183
184
185			if __name__ == '__main__':
186			parser = argparse.ArgumentParser(description='Python action runner process wrapper')
187			parser.add_argument('--pack', required=True,
188			help='Name of the pack this action belongs to')
189			parser.add_argument('--file-path', required=True,
190			help='Path to the action module')
191			parser.add_argument('--parameters', required=False,
192			help='Serialized action parameters')
193			parser.add_argument('--user', required=False,
194			help='User who triggered the action execution')
195			parser.add_argument('--parent-args', required=False,
196			help='Command line arguments passed to the parent process')
197			args = parser.parse_args()
198
199			parameters = args.parameters
200			parameters = json.loads(parameters) if parameters else {}
201			user = args.user
202			parent_args = json.loads(args.parent_args) if args.parent_args else []
203
204			assert isinstance(parent_args, list)
205			obj = PythonActionWrapper(pack=args.pack,
206			file_path=args.file_path,
207			parameters=parameters,
208			user=user,
209			parent_args=parent_args)
210
211			obj.run()
212

Plexxi / st2

GitHub Access Token became invalid

Push — pip_8.1.2 ( 36f804 )

PythonActionWrapper A

Complexity

Size/Duplication

Importance

3 Methods

Duplication Side-by-Side

Filter issues like