Cannot setup `log_format` in `setup.cfg, because of` InterpolationMissingOptionError` #3062

prokher · 2017-12-25T17:29:30Z

I would like to setup log_format in the project-wise configuration file setup.cfg. I do it like this:

[tool:pytest]
log_format = %(filename)s:%(lineno)d %(name)s%(levelname)s%(message)s

Given this, any invocation of some setup.py or simply pip install -r requirements.txt in the directory where setup.cfg resides, gives me a error:

configparser.InterpolationMissingOptionError: Bad value substitution: option 'log_format' in section 'tool:pytest' contains an interpolation key 'filename' which is not a valid option name. Raw value: '%(filename)s:%(lineno)d %(name)s%(levelname)s%(message)s'

As far as I understand, the reason is that %-formatting is used in config files for string interpolation. It is recommended to screen % with another % to avoid interpolation. Well, if I do this then pytest-catchlog stops interpreting this string as format and simply output it as is.

It looks like, pytest-catchlog shall adopt the rules of writing setup.cfg files. If there is another solution or workaround, please let me know.
Bug was originally posted to the pytest-catchlog issue tracker here , but once this plugin was merged into PyTest I have to report the bug is still here.

P.S. Sorry for ignoring all the steps listed in the contributing guidelines, but this bug was reproduced and confirmed successfully in the original bug report.

The text was updated successfully, but these errors were encountered:

pytestbot · 2017-12-25T17:30:13Z

GitMate.io thinks the contributors most likely able to help are @nicoddemus, and @RonnyPfannschmidt.

nicoddemus · 2017-12-25T21:56:41Z

Thanks @prokher for moving the bug report to here (you can close the original issue if you would like).

@Thisch, from that thread you mention that there's no workaround for it in Python 2.X?

Also seems strange that by using double % then pytest-catchlog outputs the format string verbatim.

twmr · 2017-12-28T09:36:12Z

According to https://bugs.python.org/issue20754l#msg299292 the distutils "bug", which causes "pip install ..." to fail, will not be fixed in cpython 2.x.

Also seems strange that by using double % then pytest-catchlog outputs the format string verbatim.

We could add support for both single % (used inside pytest.ini) and double % (used inside setup.cfg) in the logging plugin.

prokher · 2017-12-29T06:44:28Z

We could add support for both single % (used inside pytest.ini) and double % (used inside setup.cfg) in the logging plugin.

I suppose, this will solve the original issue.

nicoddemus · 2018-01-08T20:30:31Z

Thanks. @Thisch should we still consider this a bug or is this an improvement?

twmr · 2018-01-08T20:46:46Z

What would be the difference? If we mark it as a bug we could fix it in 3.3.x, if not we would have to wait till 3.4, right?

nicoddemus · 2018-01-09T20:27:51Z

Correct, but we also should consider if existing suites might break after fixing this; this could warrant releasing it into 3.4 even if it is a bug fix.

RonnyPfannschmidt · 2018-01-10T07:03:07Z

well, this is mainly another example of why it is bad to naively hook into configfiles of other tools that aren't meant to be used that way - i propose documenting setup.cfg support as intentionally incomplete due to python version differences in how the file is supposed to be parsed

prokher · 2018-01-10T15:31:48Z

@nicoddemus

we also should consider if existing suites might break after fixing this

How is that possible?

@RonnyPfannschmidt

well, this is mainly another example of why it is bad to naively hook into configfiles of other tools that aren't meant to be used that way

I must disagree. In our projects we put all the relevant settings into setup.cfg and that is quite convenient. The only exception for now is PyTest. I mean, it looks quite natural to keep all the settings in the setup.cfg.

RonnyPfannschmidt · 2018-01-10T16:01:27Z

@prokher feel free to disagree,however different tools disagree on how to parse what configfile and bam there is a massive mess

while it may feel natural, tecnically its strictly wrong and works mostly by accident, this issue simply shows that there are cases where that "happy it works" breaks down for all the right reasons

prokher · 2018-01-10T16:34:18Z

@RonnyPfannschmidt It is not necessary wrong. For instance it will not be wrong if PyTest would use configparser to parse setup.cfg file. I agree that the solution will not solve problem for Python 2.x, since there is no option for screening % symbols yet, but, come on, now it does not work in both 2.x and 3.x which is clearly worse.

I do not want to induce (or participate in) philosophical discussions about what is good and what is wrong, but currently many tools use sections of setup.cfg files for their own parameters, including PyTest. I simply think that this feature shall work as intended.

RonnyPfannschmidt · 2018-01-10T16:40:37Z

@prokher then py.test would have different config syntaxes with different behaviours for different files - i'm not quite sure how that makes anything better

RonnyPfannschmidt · 2018-01-10T16:41:15Z

from my pov it was a mistake to ever allow the parsing of setup.cfg since it uses a different semantics than pytest.ini

Explanation: pytest-dev/pytest#3062

BeyondEvil · 2018-05-31T11:54:37Z

So is there a workaround for 3.6? I've hit this issue and I'm confused as how to fix it. For the record we use a setup.cfg file where we put all our configs (for pytest and other tools).

RonnyPfannschmidt · 2018-05-31T12:59:55Z

it is impossible to fix as of now - we shoudl start deprecating using setup.cfg

BeyondEvil · 2018-05-31T13:05:02Z

@RonnyPfannschmidt So what I'm hearing is that in order to fix this, I'll need to move out the pytest-specific stuff from our setup.cfg and put them into pytest.ini instead?

RonnyPfannschmidt · 2018-05-31T13:24:57Z

@BeyondEvil correct

I wish it could go in setup.cfg, but that's impossible due to the string interpolation (see pytest-dev/pytest#3062 for a similar problem) I don't like it being in tox.ini because it becomes confusing where things are.

wimglenn · 2018-08-20T05:18:02Z

My related issue over on pip pypa/pip#5182

RonnyPfannschmidt · 2018-08-20T06:23:32Z

im closing this one as "wontfix"

Don't move pytest settings into setup.cfg pytest-dev/pytest#3062

* Add pre-commit * Fix pre-commit check error * Replace pytest.ini with setup.cfg * Remove MANIFEST.in * Fix .travis.yml error * Fix .travis.yml error .travis.yml currently not support merging multi maps * Fix setup.cfg error Don't move pytest settings into setup.cfg pytest-dev/pytest#3062

- Running flake8 via tox, e.g., `tox -e flake8` crashes. Setuptools uses configparser to read the config, which throws configparser.InterpolationMissingOptionError because of the percent (%) symbols in the format string. - Ref: pytest-dev/pytest#3062 pypa/pip#5182

- see pytest-dev/pytest#3062

Turns out Pytest doesn't support log-format specification in setup.cfg declarations. See pytest-dev/pytest#3062.

pytest was using config from `tox.ini` preferentially and ignoring config from `setup.cfg`, as a side-effect doctests were not running on code/docstrings in `rdflib/`. The reason why some pytest config was in `tox.ini` instead of `setup.cfg` was because of these issues: - pypa/pip#5182 - pytest-dev/pytest#3062 As a compromise to fix this I have opted for moving all pytest config to `pyproject.toml`: - https://docs.pytest.org/en/stable/reference/customize.html#pyproject-toml This seems sensible as `pyproject.toml` is standarized by PEPs and eventually most things from `setup.cfg` will end up in there anyway. Also: - remove the pytest ignore on `test/translate_algebra` as tests in there have been running and passing for some time. - fixed path to test data in `rdflib/plugins/parsers/nquads.py`.

…ytest-dev/pytest#3062)

Additional details below: * pytest-dev/pytest#3062 * pypa/pip#5182

nicoddemus added plugin: logging related to the logging builtin plugin type: bug problem that needs to be addressed labels Dec 25, 2017

prokher mentioned this issue Dec 26, 2017

Cannot setup log_format in setup.cfg, because of InterpolationMissingOptionError` eisensheng/pytest-catchlog#67

Closed

Mulugruntz pushed a commit to Mulugruntz/jam that referenced this issue Mar 15, 2018

Moved pytest out of setup.cfg into pytest.ini.

4bff8d8

Explanation: pytest-dev/pytest#3062

Mulugruntz pushed a commit to Mulugruntz/jam that referenced this issue Mar 16, 2018

Moved pytest out of setup.cfg into pytest.ini.

78f0987

Explanation: pytest-dev/pytest#3062

SethMMorton mentioned this issue May 18, 2018

bumpversion and setuptools have differing interpolation behavior peritus/bumpversion#181

Open

RonnyPfannschmidt mentioned this issue May 31, 2018

deprecate setup.cfg support #3523

Open

asottile mentioned this issue Jun 18, 2018

Start warning on non compliant pyproject.toml files and rejecting incorrect ones pypa/pip#5512

Merged

SethMMorton mentioned this issue Jun 20, 2018

bumpversion and setuptools have differing interpolation behavior c4urself/bump2version#21

Closed

RonnyPfannschmidt closed this as completed Aug 20, 2018

tbekolay mentioned this issue Mar 13, 2019

Make default plot directory customizable nengo/pytest-plt#5

Closed

linw1995 added a commit to linw1995/data_extractor that referenced this issue Oct 12, 2019

Fix setup.cfg error

3bf1197

Don't move pytest settings into setup.cfg pytest-dev/pytest#3062

linw1995 mentioned this issue Oct 12, 2019

Add pre-commit support and fix pre-commit check error linw1995/data_extractor#32

Merged

oyvindeide mentioned this issue Apr 8, 2020

Add pylint to test suite equinor/semeio#76

Merged

xflr6 added a commit to glottolog/treedb that referenced this issue Jul 31, 2021

fix Bad value substitution on pip invocation

e509a89

- see pytest-dev/pytest#3062

sondrelg added a commit to snok/django-guid that referenced this issue Dec 13, 2021

docs: Reinstate pytest.ini

c5eac46

Turns out Pytest doesn't support log-format specification in setup.cfg declarations. See pytest-dev/pytest#3062.

sondrelg added a commit to snok/django-guid that referenced this issue Dec 13, 2021

docs: Reinstate pytest.ini

b0523ba

Turns out Pytest doesn't support log-format specification in setup.cfg declarations. See pytest-dev/pytest#3062.

sondrelg added a commit to snok/django-guid that referenced this issue Dec 13, 2021

docs: Reinstate pytest.ini

15fe363

Turns out Pytest doesn't support log-format specification in setup.cfg declarations. See pytest-dev/pytest#3062.

sondrelg added a commit to snok/django-guid that referenced this issue Dec 13, 2021

docs: Reinstate pytest.ini

67b3748

Turns out Pytest doesn't support log-format specification in setup.cfg declarations. See pytest-dev/pytest#3062.

sondrelg added a commit to snok/django-guid that referenced this issue Dec 13, 2021

docs: Reinstate pytest.ini

ad47f4a

Turns out Pytest doesn't support log-format specification in setup.cfg declarations. See pytest-dev/pytest#3062.

sondrelg added a commit to snok/django-guid that referenced this issue Dec 13, 2021

fix: Reinstate pytest.ini

d1b8b0b

Turns out Pytest doesn't support log-format specification in setup.cfg declarations. See pytest-dev/pytest#3062.

sondrelg added a commit to snok/django-guid that referenced this issue Dec 13, 2021

fix: Add back pytest.ini

d95ee04

Turns out Pytest doesn't support log-format specification in setup.cfg declarations. See pytest-dev/pytest#3062.

sondrelg added a commit to snok/django-guid that referenced this issue Dec 13, 2021

fix: Add back pytest.ini

4643849

Turns out Pytest doesn't support log-format specification in setup.cfg declarations. See pytest-dev/pytest#3062.

aucampia mentioned this issue Apr 18, 2022

text: fix pytest config RDFLib/rdflib#1846

Merged

3 tasks

brenard-irap pushed a commit to brenard-irap/speasy that referenced this issue Dec 2, 2022

Double % to define log_format and log_date_format in setup.cfg (cf. p…

80c8ab5

…ytest-dev/pytest#3062)

tombayo added a commit to tombayo/python-wikijs that referenced this issue Sep 13, 2024

Fixed an 'InterpolationMissingOptionError' issue in pytest

62fd1b2

Additional details below: * pytest-dev/pytest#3062 * pypa/pip#5182

tombayo added a commit to tombayo/python-wikijs that referenced this issue Sep 13, 2024

Fixed an 'InterpolationMissingOptionError' issue in pytest

a504852

Additional details below: * pytest-dev/pytest#3062 * pypa/pip#5182

This was referenced Sep 13, 2024

Fixed pip failing to install due to a 'InterpolationMissingOptionError' issue in pytest nuno-andre/python-wikijs#2

Open

Fixed an 'InterpolationMissingOptionError' issue in pytest tombayo/python-wikijs#1

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Cannot setup `log_format` in `setup.cfg, because of` InterpolationMissingOptionError` #3062

Cannot setup `log_format` in `setup.cfg, because of` InterpolationMissingOptionError` #3062

prokher commented Dec 25, 2017 •

edited

Loading

pytestbot commented Dec 25, 2017

nicoddemus commented Dec 25, 2017

twmr commented Dec 28, 2017

prokher commented Dec 29, 2017 •

edited

Loading

nicoddemus commented Jan 8, 2018

twmr commented Jan 8, 2018

nicoddemus commented Jan 9, 2018

RonnyPfannschmidt commented Jan 10, 2018

prokher commented Jan 10, 2018 •

edited

Loading

RonnyPfannschmidt commented Jan 10, 2018

prokher commented Jan 10, 2018 •

edited

Loading

RonnyPfannschmidt commented Jan 10, 2018

RonnyPfannschmidt commented Jan 10, 2018

BeyondEvil commented May 31, 2018

RonnyPfannschmidt commented May 31, 2018

BeyondEvil commented May 31, 2018

RonnyPfannschmidt commented May 31, 2018

wimglenn commented Aug 20, 2018

RonnyPfannschmidt commented Aug 20, 2018

Cannot setup log_format in setup.cfg, because of InterpolationMissingOptionError` #3062

Cannot setup log_format in setup.cfg, because of InterpolationMissingOptionError` #3062

Comments

prokher commented Dec 25, 2017 • edited Loading

pytestbot commented Dec 25, 2017

nicoddemus commented Dec 25, 2017

twmr commented Dec 28, 2017

prokher commented Dec 29, 2017 • edited Loading

nicoddemus commented Jan 8, 2018

twmr commented Jan 8, 2018

nicoddemus commented Jan 9, 2018

RonnyPfannschmidt commented Jan 10, 2018

prokher commented Jan 10, 2018 • edited Loading

RonnyPfannschmidt commented Jan 10, 2018

prokher commented Jan 10, 2018 • edited Loading

RonnyPfannschmidt commented Jan 10, 2018

RonnyPfannschmidt commented Jan 10, 2018

BeyondEvil commented May 31, 2018

RonnyPfannschmidt commented May 31, 2018

BeyondEvil commented May 31, 2018

RonnyPfannschmidt commented May 31, 2018

wimglenn commented Aug 20, 2018

RonnyPfannschmidt commented Aug 20, 2018

Cannot setup `log_format` in `setup.cfg, because of` InterpolationMissingOptionError` #3062

Cannot setup `log_format` in `setup.cfg, because of` InterpolationMissingOptionError` #3062

prokher commented Dec 25, 2017 •

edited

Loading

prokher commented Dec 29, 2017 •

edited

Loading

prokher commented Jan 10, 2018 •

edited

Loading

prokher commented Jan 10, 2018 •

edited

Loading