Create common.py

sonarqube/utils/common.py

@@ -0,0 +1,165 @@
+#!/usr/bin/env python
+# -*- coding:utf-8 -*-
+# @Author: Jialiang Shi
+import inspect
+from functools import wraps
+
+
+def strip_trailing_slash(url):
+ """
+ remove url's trailing slash
+
+ :param url:
+ :return:
+ """
+ if url.endswith("/"):
+ url = url[:-1]
+ return url
+
+
+def get_args(func):
+ """
+ Returns a sequence of list (args) for func
+ :param func:
+ :return:
+ """
+ try:
+ argspec = inspect.getfullargspec(func)
+ except AttributeError:
+ argspec = inspect.getargspec(func)
+
+ if not argspec.defaults:
+ args = argspec.args[1:]
+ else:
+ args = argspec.args[1 : -len(argspec.defaults)]
+
+ return args
+
+
+def get_default_kwargs(func):
+ """
+ Returns a sequence of tuples (kwarg_name, default_value) for func
+
+ :param func:
+ :return:
+ """
+ try:
+ argspec = inspect.getfullargspec(func)
+ except AttributeError:
+ argspec = inspect.getargspec(func)
+
+ if not argspec.defaults:
+ return []
+
+ return zip(argspec.args[-len(argspec.defaults) :], argspec.defaults)
+
+
+def translate_params(f, *args, **kwargs):
+ """
+
+ :param f:
+ :param args:
+ :param kwargs:
+ :return:
+ """
+ all_params = dict(get_default_kwargs(f))
+
+ if len(get_args(f)) < len(args):
+ additional_values = args[len(get_args(f)) :]
+ try:
+ argspec = inspect.getfullargspec(f)
+ except AttributeError:
+ argspec = inspect.getargspec(f)
+
+ func_parameters = argspec.args[1:]
+ additional_args = func_parameters[
+ len(get_args(f)) : len(get_args(f)) + len(additional_values)
+ ]
+ all_params.update(dict(zip(additional_args, additional_values)))
+
+ all_params.update(dict(zip(get_args(f), args)))
+ all_params.update(kwargs)
+
+ for key in list(all_params.keys()):
+ if not all_params[key]:
+ del all_params[key]
+
+ return all_params
+
+
+def translate_special_params(func_params, attributes_map):
+ """
+
+ :param func_params:
+ :param attributes_map:
+ :return:
+ """
+ params = {}
+
+ for key, value in func_params.items():
+ if key in attributes_map:
+ params[attributes_map[key]] = value
+ else:
+ params[key] = value
+
+ return params
+
+
+def endpoint(url_pattern, method="GET"):
+ """
+
+ :param url_pattern:
+ :param method:
+ :param item:
+ :return:
+ """
+
+ def wrapped_func(f):
+ @wraps(f)
+ def inner_func(self, *args, **kwargs):
+ """
+
+ :param self:
+ :param args:
+ :param kwargs:
+ :return:
+ """
+ func_params = translate_params(f, *args, **kwargs)
+ params = translate_special_params(func_params, self.special_attributes_map)
+
+ response = None
+ if method == "GET":
+ response = self._get(url_pattern, params=params)
+ elif method == "POST":
+ response = self._post(url_pattern, data=params)
+
+ if response:
+ try:
+ if response.headers["Content-Type"] == "application/json":
+ return response.json()
+ else:
+ return response.text
+ except Exception as e:
+ return response.content
+
+ return inner_func
+
+ return wrapped_func
+
+
+def GET(url_pattern):
+ """
+
+ :param url_pattern:
+ :return:
+ """
+ return endpoint(url_pattern, method="GET")
+
+
+def POST(url_pattern):
+ """
+
+ :param url_pattern:
+ :return:
+ """
+ return endpoint(url_pattern, method="POST")