code cleanup

Author: rp-

linstor/config.py

@@ -38,10 +38,10 @@ def get_section(section, config_file_name=None):
     @staticmethod
     def get_controllers(section='global', config_file_name=None, fallback='linstor://localhost'):
         """
-        :param str section Section to parse, defaults to 'global'
-        :param str config_file_name Config file to parse, if not set, the default files in /etc and $HOME are
+        :param str section: Section to parse, defaults to 'global'
+        :param str config_file_name: Config file to parse, if not set, the default files in /etc and $HOME are
          parsed
-        :param str fallback Fallback controller if none was found in the environment or the config. Defaults
+        :param str fallback: Fallback controller if none was found in the environment or the config. Defaults
          to 'linstor://localhost'.
         :return: List of linstor uris. This list is intended to be used via the MultiLinstor class.
         :rtype: list[str]

linstor/size_calc.py

@@ -67,7 +67,7 @@ def parse_unit(cls, value):
         :return: a tuple of the size value as int and the SizeCalc.UNIT
         :rtype: (int, int)
         """
-        m = re.match('(\d+)\s*(\D*)', value)
+        m = re.match(r'(\d+)\s*(\D*)', value)
 
         size = None
         if m:
@@ -108,15 +108,16 @@ def convert(cls, size, unit_in, unit_out):
         a size value given in the scale unit of unit_out
         (e.g. convert from decimal megabytes to binary gigabytes, ...)
 
-        @param   size: numeric size value
-        @param   unit_in: scale unit selector of the size parameter
-        @param   unit_out: scale unit selector of the return value
-        @return: size value converted to the scale unit of unit_out
+        :param   size: numeric size value
+        :param   unit_in: scale unit selector of the size parameter
+        :param   unit_out: scale unit selector of the return value
+        :return: size value converted to the scale unit of unit_out
                  truncated to an integer value
+        :rtype: int
         """
         fac_in = ((unit_in & 0xffffff00) >> 8) ** (unit_in & 0xff)
         div_out = ((unit_out & 0xffffff00) >> 8) ** (unit_out & 0xff)
-        return (size * fac_in // div_out)
+        return size * fac_in // div_out
 
     @classmethod
     def convert_round_up(cls, size, unit_in, unit_out):
@@ -133,10 +134,11 @@ def convert_round_up(cls, size, unit_in, unit_out):
          returns 97,657 binary kilobytes (kiB), which equals 100 million
          plus 768 bytes and therefore is large enough to contain 100 megabytes)
 
-        @param   size: numeric size value
-        @param   unit_in: scale unit selector of the size parameter
-        @param   unit_out: scale unit selector of the return value
-        @return: size value converted to the scale unit of unit_out
+        :param   size: numeric size value
+        :param   unit_in: scale unit selector of the size parameter
+        :param   unit_out: scale unit selector of the return value
+        :return: size value converted to the scale unit of unit_out
+        :rtype: int
         """
         fac_in = ((unit_in & 0xffffff00) >> 8) ** (unit_in & 0xff)
         div_out = ((unit_out & 0xffffff00) >> 8) ** (unit_out & 0xff)
@@ -151,6 +153,10 @@ def convert_round_up(cls, size, unit_in, unit_out):
     def approximate_size_string(cls, size_kib):
         """
         Produce human readable size information as a string
+
+        :param int size_kib: size in kibi byte
+        :return: human readable size string
+        :rtype: str
         """
         units = [
             "KiB",
@@ -176,7 +182,7 @@ def approximate_size_string(cls, size_kib):
         size_str = None
         if size_kib % magnitude != 0:
             size_unit = float(size_kib) / magnitude
-            size_loc = locale.format('%3.2f', size_unit, grouping=True)
+            size_loc = locale.format_string('%3.2f', size_unit, grouping=True)
             size_str = "%s %s" % (size_loc, units[index])
         else:
             size_unit = size_kib / magnitude