even more comments

diff --git a/plugins.d/python.d.plugin b/plugins.d/python.d.plugin
index 02ae652b07f2754b093b2fcf6b3533c025579a0c..0f0997422e249a7abc10c6553deae944fe12b798 100755 (executable)
--- a/plugins.d/python.d.plugin
+++ b/plugins.d/python.d.plugin
@@ -152,7 +152,6 @@ class PythonCharts(object):
         :param modules: list
         :return: list
         """
-
         for mod in modules:
             configfile = self.configs + mod.__name__ + ".conf"
             if os.path.isfile(configfile):
@@ -192,7 +191,6 @@ class PythonCharts(object):
         :param config: dict
         :return: dict
         """
-
         # get default values
         defaults = {}
         for key in BASE_CONFIG:

diff --git a/python.d/mysql.chart.py b/python.d/mysql.chart.py
index 6814f95dfd9840ce7420f469a7a6677a8b2f1261..7466533c27b815da9bd6edc03b81ff39f6fad654 100644 (file)
--- a/python.d/mysql.chart.py
+++ b/python.d/mysql.chart.py
@@ -343,7 +343,11 @@ class Service(BaseService):
         self.defs = {}
 
     def _parse_config(self, configuration):
-        # parse configuration to collect data from mysql server
+        """
+        Parse configuration to collect data from MySQL server
+        :param configuration: dict
+        :return: dict
+        """
         if self.name is None:
             self.name = 'local'
         if 'user' not in configuration:
@@ -369,6 +373,9 @@ class Service(BaseService):
         return configuration
 
     def _connect(self):
+        """
+        Try to connect to MySQL server
+        """
         try:
             self.connection = MySQLdb.connect(user=self.configuration['user'],
                                               passwd=self.configuration['password'],
@@ -382,6 +389,10 @@ class Service(BaseService):
             raise RuntimeError
 
     def _get_data(self):
+        """
+        Get raw data from MySQL server
+        :return: dict
+        """
         if self.connection is None:
             try:
                 self._connect()
@@ -400,6 +411,10 @@ class Service(BaseService):
         return dict(raw_data)
 
     def check(self):
+        """
+        Check if service is able to connect to server
+        :return: boolean
+        """
         try:
             self.connection = self._connect()
             return True
@@ -408,6 +423,10 @@ class Service(BaseService):
             return False
 
     def create(self):
+        """
+        Create graphs
+        :return: boolean
+        """
         for name in ORDER:
             self.defs[name] = []
             for line in CHARTS[name][1]:
@@ -437,6 +456,11 @@ class Service(BaseService):
         return True
 
     def update(self, interval):
+        """
+        Update data on graphs
+        :param interval: int
+        :return: boolean
+        """
         data = self._get_data()
         if data is None:
             return False

diff --git a/python.d/python_modules/base.py b/python.d/python_modules/base.py
index f5d7018d4c8b322efa0080b184b1cef85f9d85fd..a168a560910ad8973f89de15d66778a8701a4d4e 100644 (file)
--- a/python.d/python_modules/base.py
+++ b/python.d/python_modules/base.py
@@ -6,7 +6,16 @@ import sys
 
 
 class BaseService(object):
+    """
+    Prototype of Service class.
+    Implemented basic functionality to run jobs by `python.d.plugin`
+    """
     def __init__(self, configuration=None, name=None):
+        """
+        This needs to be initialized in child classes
+        :param configuration: dict
+        :param name: str
+        """
         if configuration is None:
             self.error("BaseService: no configuration parameters supplied. Cannot create Service.")
             raise RuntimeError
@@ -17,12 +26,29 @@ class BaseService(object):
             self.execution_name = ""
 
     def _extract_base_config(self, config):
+        """
+        Get basic parameters to run service
+        Minimum config:
+            config = {'update_every':1,
+                      'priority':100000,
+                      'retries':0}
+        :param config: dict
+        """
         self.update_every = int(config['update_every'])
         self.priority = int(config['priority'])
         self.retries = int(config['retries'])
         self.retries_left = self.retries
 
     def create_timetable(self, freq=None):
+        """
+        Create service timetable.
+        `freq` is optional
+        Example:
+            timetable = {'last': 1466370091.3767564,
+                         'next': 1466370092,
+                         'freq': 1}
+        :param freq: int
+        """
         if freq is None:
             freq = self.update_every
         now = time()
@@ -38,13 +64,25 @@ class BaseService(object):
         sys.stderr.flush()
 
     def check(self):
+        """
+        check() prototype
+        :return: boolean
+        """
         self.error("Service " + str(self.__name__) + "doesn't implement check() function")
         return False
 
     def create(self):
+        """
+        create() prototype
+        :return: boolean
+        """
         self.error("Service " + str(self.__name__) + "doesn't implement create() function?")
         return False
 
     def update(self):
+        """
+        update() prototype
+        :return: boolean
+        """
         self.error("Service " + str(self.__name__) + "doesn't implement update() function")
         return False