Merge pull request ceph#66219 from guits/cv-migrate-to-dataclass

ceph-volume: migrate namedtuple based config and sysInfo to dataclasses

Author: guits

src/ceph-volume/ceph_volume/__init__.py

@@ -1,10 +1,15 @@
 import os
 import logging
-from collections import namedtuple
+from dataclasses import dataclass
+from typing import Any, Optional
 
+@dataclass
+class SysInfo:
+    devices: dict[str, list]
 
-sys_info = namedtuple('sys_info', ['devices'])
+sys_info = SysInfo(devices={})
 sys_info.devices = dict()
+
 logger = logging.getLogger(__name__)
 BEING_REPLACED_HEADER: str = 'CEPH_DEVICE_BEING_REPLACED'
 
@@ -42,9 +47,17 @@ def __getattr__(self, *a):
 
 
 allow_loop_devices = AllowLoopDevices()
-conf = namedtuple('config', ['ceph', 'cluster', 'verbosity', 'path', 'log_path', 'dmcrypt_no_workqueue'])
-conf.ceph = UnloadedConfig()
-conf.dmcrypt_no_workqueue = None
+
+@dataclass
+class Config:
+    ceph: Any = UnloadedConfig()
+    cluster: Optional[str] = None
+    verbosity: Optional[int] = None
+    path: str = ''
+    log_path: str = ''
+    dmcrypt_no_workqueue: bool = False
+
+conf = Config()
 
 __version__ = "1.0.0"
 

src/ceph-volume/ceph_volume/configuration.py

@@ -5,16 +5,8 @@
 from ceph_volume import terminal, conf
 from ceph_volume import exceptions
 from sys import version_info as sys_version_info
-
-if sys_version_info.major >= 3:
-    import configparser
-    conf_parentclass = configparser.ConfigParser
-elif sys_version_info.major < 3:
-    import ConfigParser as configparser
-    conf_parentclass = configparser.SafeConfigParser
-else:
-    raise RuntimeError('Not expecting python version > 3 yet.')
-
+import configparser
+from typing import Optional
 
 logger = logging.getLogger(__name__)
 
@@ -43,7 +35,7 @@ def load_ceph_conf_path(cluster_name='ceph'):
     conf.cluster = cluster_name
 
 
-def load(abspath=None):
+def load(abspath: Optional[str] = None):
     if abspath is None:
         abspath = conf.path
 
@@ -65,7 +57,7 @@ def load(abspath=None):
         raise RuntimeError('Unable to read configuration file: %s' % abspath)
 
 
-class Conf(conf_parentclass):
+class Conf(configparser.ConfigParser):
     """
     Subclasses from ConfigParser to give a few helpers for Ceph
     configuration.
@@ -81,10 +73,10 @@ def is_valid(self):
         except (configparser.NoSectionError, configparser.NoOptionError):
             raise exceptions.ConfigurationKeyError('global', 'fsid')
 
-    def optionxform(self, s):
-        s = s.replace('_', ' ')
-        s = '_'.join(s.split())
-        return s
+    def optionxform(self, optionstr):
+        optionstr = optionstr.replace('_', ' ')
+        optionstr = '_'.join(optionstr.split())
+        return optionstr
 
     def get_safe(self, section, key, default=None, check_valid=True):
         """

src/ceph-volume/ceph_volume/main.py

@@ -168,7 +168,7 @@ def main(self, argv):
             # we warn only here, because it is possible that the configuration
             # file is not needed, or that it will be loaded by some other means
             # (like reading from lvm tags)
-            logger.warning('ignoring inability to load ceph.conf', exc_info=1)
+            logger.warning('ignoring inability to load ceph.conf')
             terminal.yellow(error)
         # dispatch to sub-commands
         terminal.dispatch(self.mapper, subcommand_args)