Анализатор Python Config читает комментарий вместе со значением

Question

У меня есть файл конфигурации,

[local]
    variable1 : val1 ;#comment1
    variable2 : val2 ;#comment2

код, подобный этому, читает только значение ключа:

class Config(object):
    def __init__(self):
        self.config = ConfigParser.ConfigParser()
        self.config.read('config.py')

    def get_path(self):
        return self.config.get('local', 'variable1')

if __name__ == '__main__':
    c = Config()
    print c.get_path()

но я также хочу прочитать присутствующий комментарий вместе со значением, любые предложения в этом отношении будут очень полезны.

Answer 1

Увы, это не так просто сделать в общем случае.Комментарии должны игнорироваться парсером.

В вашем конкретном случае это легко, потому что # служит только символом комментария, если он начинает строку.Таким образом, значение variable1 будет "val1 #comment1".Я полагаю, вы используете что-то вроде этого, только менее хрупкое:

val1_line = c.get('local', 'var1')
val1, comment = val1_line.split(' #') 

Если необходимо значение «комментария», возможно, это неправильный комментарий?Попробуйте добавить явные ключи для комментариев, например:

[local]
  var1: 108.5j
  var1_comment: remember, the flux capacitor capacitance is imaginary! 

Answer 2

Ваше единственное решение - написать еще один ConfigParser, переопределяющий метод _read().В вашем ConfigParser вы должны удалить все проверки на удаление комментариев.Это опасное решение , но оно должно работать.

class ValuesWithCommentsConfigParser(ConfigParser.ConfigParser):

    def _read(self, fp, fpname):
        from ConfigParser import DEFAULTSECT, MissingSectionHeaderError, ParsingError

        cursect = None                        # None, or a dictionary
        optname = None
        lineno = 0
        e = None                              # None, or an exception
        while True:
            line = fp.readline()
            if not line:
                break
            lineno = lineno + 1
            # comment or blank line?
            if line.strip() == '' or line[0] in '#;':
                continue
            if line.split(None, 1)[0].lower() == 'rem' and line[0] in "rR":
                # no leading whitespace
                continue
                # continuation line?
            if line[0].isspace() and cursect is not None and optname:
                value = line.strip()
                if value:
                    cursect[optname].append(value)
            # a section header or option header?
            else:
                # is it a section header?
                mo = self.SECTCRE.match(line)
                if mo:
                    sectname = mo.group('header')
                    if sectname in self._sections:
                        cursect = self._sections[sectname]
                    elif sectname == DEFAULTSECT:
                        cursect = self._defaults
                    else:
                        cursect = self._dict()
                        cursect['__name__'] = sectname
                        self._sections[sectname] = cursect
                        # So sections can't start with a continuation line
                    optname = None
                # no section header in the file?
                elif cursect is None:
                    raise MissingSectionHeaderError(fpname, lineno, line)
                # an option line?
                else:
                    mo = self._optcre.match(line)
                    if mo:
                        optname, vi, optval = mo.group('option', 'vi', 'value')
                        optname = self.optionxform(optname.rstrip())
                        # This check is fine because the OPTCRE cannot
                        # match if it would set optval to None
                        if optval is not None:
                            optval = optval.strip()
                            # allow empty values
                            if optval == '""':
                                optval = ''
                            cursect[optname] = [optval]
                        else:
                            # valueless option handling
                            cursect[optname] = optval
                    else:
                        # a non-fatal parsing error occurred.  set up the
                        # exception but keep going. the exception will be
                        # raised at the end of the file and will contain a
                        # list of all bogus lines
                        if not e:
                            e = ParsingError(fpname)
                        e.append(lineno, repr(line))
            # if any parsing errors occurred, raise an exception
        if e:
            raise e

        # join the multi-line values collected while reading
        all_sections = [self._defaults]
        all_sections.extend(self._sections.values())
        for options in all_sections:
            for name, val in options.items():
                if isinstance(val, list):
                    options[name] = '\n'.join(val)

В ValuesWithCommentsConfigParser я исправил некоторые операции импорта и удалил соответствующие разделы кода.

Использованиеconfig.ini из моего предыдущего ответа , я могу доказать, что предыдущий код верен.

config = ValuesWithCommentsConfigParser()
config.read('config.ini')
assert config.get('local', 'variable1') == 'value1 ; comment1'
assert config.get('local', 'variable2') == 'value2 # comment2'

Answer 3

В соответствии с модулем ConfigParser документация,

Файлы конфигурации могут содержать комментарии с префиксом определенных символы (# и;). Комментарии могут появляться самостоятельно в противном случае пустая строка или может быть введена в строки, содержащие значения или раздел имена. В последнем случае им должен предшествовать пробел символ должен быть признан в качестве комментария. (Для обратной совместимости, только ; запускает встроенный комментарий, а # - нет.)

Если вы хотите прочитать «комментарий» со значением, вы можете опустить пробел перед символом ; или использовать #. Но в этом случае строки comment1 и comment2 становятся частью значения и больше не считаются комментариями.

Лучшим подходом было бы использовать другое имя свойства, такое как variable1_comment, или определить другой раздел в конфигурации, предназначенный для комментариев:

[local]
    variable1 = value1
[comments]
    variable1 = comment1

Первое решение требует, чтобы вы сгенерировали новый ключ, используя другой (то есть вычислите variable1_comment из variable1), другое позволяет вам использовать тот же ключ для разных разделов в файле конфигурации.

Начиная с Python 2.7.2, всегда можно прочитать комментарий вдоль строки , если вы используете символ #. Как говорят в документах, это для обратной совместимости. Следующий код должен работать без сбоев:

config = ConfigParser.ConfigParser()
config.read('config.ini')
assert config.get('local', 'variable1') == 'value1'
assert config.get('local', 'variable2') == 'value2 # comment2'

для следующего config.ini файла:

[local]
variable1 = value1 ; comment1
variable2 = value2 # comment2

Если вы принимаете это решение, не забудьте вручную проанализировать результат get() для значений и комментариев.

Answer 4

в соответствии с инструкциями: Строки, начинающиеся с «#» или «;» игнорируются и могут использоваться для предоставления комментариев.

, поэтому значение переменной1 равно "val1 # comment1". Комментарий является частью значения

Вы можете проверить свой конфиг, введя ли вы Enter перед вашим комментарием