refactor config file finding #8358

RonnyPfannschmidt · 2021-02-20T21:24:16Z

addresses #3523

setup.cfg

also a structural refactor and cleanup of the config file finding/loading

changelog
writeup in deprecated docs/links

nicoddemus · 2021-02-22T20:45:01Z

The discussion in #3523 is interesting, seems this will bring a lot of pain to our users that still keep their configuration in setup.cfg, because those that have working suites today are not being affected by the issues in #3523, so I wonder if there's other path than dropping setup.cfg support completely?

What would be the downsides of keeping the existing support, even if for some options it doesn't work so well (filterwarnings seems to be an example of that)?

RonnyPfannschmidt · 2021-02-27T07:14:41Z

@nicoddemus in that case lets turn setup.cfg support into something undocumented, and keep support based on the basic testing

in future we might want to try using config-parser to load setup.cfg data

based on recent developments of config-parser it may even be possible o drop inconfig and use different config-parser configurations for different config-file setups as part of a breaking release

nicoddemus · 2021-02-27T13:55:24Z

@nicoddemus in that case lets turn setup.cfg support into something undocumented, and keep support based on the basic testing

I would be fine with that. 👍

We can remove examples of setup.cfg usage, and just leave a note stating that while it "works", there are situations where it doesn't and is not really recommended. This way if any bug reports come along because of setup.cfg support, we can just point that to users and suggest they change the configuration format.

in future we might want to try using config-parser to load setup.cfg data

based on recent developments of config-parser it may even be possible o drop inconfig and use different config-parser configurations for different config-file setups as part of a breaking release

I'm not keen on the details, but the overall idea seems good. 😁

RonnyPfannschmidt · 2021-06-06T20:48:03Z

reviewed the docs and decided the warnings @nicoddemus did put in way earlier are good enough

its already taken care of earlier

nicoddemus

Overall the changes look good, please take a look at my comments. 👍

nicoddemus · 2022-07-31T13:04:36Z

doc/en/reference/customize.rst

@@ -79,7 +79,7 @@ and can also be used to hold pytest configuration if they have a ``[pytest]`` se
 .. code-block:: ini

    # tox.ini
-    [pytest]
+    [tool:pytest]


This doesn't seem right, AFAIK for tox.ini files we use the [pytest] section.

nicoddemus · 2022-07-31T13:05:47Z

doc/en/reference/customize.rst

-    down problems.
-    When possible, it is recommended to use the latter files, or ``pyproject.toml``, to hold your
-    pytest configuration.
+``setup.cfg`` file usage for pytest has been deprecated, its recommended to use ``tox.ini`` or ``pyproject.toml``


Suggested change

``setup.cfg`` file usage for pytest has been deprecated, its recommended to use ``tox.ini`` or ``pyproject.toml``

``setup.cfg`` file usage for pytest is supported but is not recommended for new projects. Instead, use ``tox.ini`` or ``pyproject.toml`` files.

It is not really deprecated in the sense that we will remove it in the future.

nicoddemus · 2022-07-31T13:12:44Z

src/_pytest/config/findpaths.py

-) -> Optional[Dict[str, Union[str, List[str]]]]:
-    """Load pytest configuration from the given file path, if supported.
+def _parse_pytest_ini(path: Path) -> PARSE_RESULT:
+    """Parse the legacy pytest.ini and return the contents of the pytest section


Suggested change

"""Parse the legacy pytest.ini and return the contents of the pytest section

"""Parse the pytest.ini file and return the contents of the pytest section

I don't think we should consider pytest.ini files "legacy" in any way. 😁

nicoddemus · 2022-07-31T13:15:38Z

src/_pytest/config/findpaths.py

    return None


 def locate_config(
-    args: Iterable[Path],
+    args: List[Path],


Minor, but for non-mutable parameters I think Sequence is more adequate.

nicoddemus · 2022-07-31T13:16:02Z

testing/test_config.py

@@ -113,7 +113,7 @@ def test_tox_ini_wrong_version(self, pytester: Pytester) -> None:
    @pytest.mark.parametrize(
        "section, name",
        [
-            ("tool:pytest", "setup.cfg"),
+            pytest.param("tool:pytest", "setup.cfg"),


Seems unnecessary?

nicoddemus · 2022-07-31T13:16:40Z

src/_pytest/config/findpaths.py


-    Return None if the file does not contain valid pytest configuration.
+    if the file exists and lacks a pytest section, consider it empty"""


Suggested change

if the file exists and lacks a pytest section, consider it empty"""

if the file exists and lacks a pytest section, consider it empty."""

nicoddemus · 2022-07-31T13:16:51Z

src/_pytest/config/findpaths.py

+
+
+def _parse_ini_file(path: Path) -> PARSE_RESULT:
+    """Parses .ini files with expected pytest.ini sections


Suggested change

"""Parses .ini files with expected pytest.ini sections

"""Parses .ini files with expected pytest.ini sections.

nicoddemus · 2022-07-31T13:17:40Z

src/_pytest/config/findpaths.py

+def _parse_ini_file(path: Path) -> PARSE_RESULT:
+    """Parses .ini files with expected pytest.ini sections
+
+    todo: investigate if tool:pytest should be added


Suggested change

todo: investigate if tool:pytest should be added

TODO: Investigate if tool:pytest should be added.

However I think it would be best to either create a new issue, or write more details about what you mean with this "TODO" (or is this something you still plan to work on this PR?).

RonnyPfannschmidt force-pushed the ronny/fix-3523-deprecate-setup-cfg branch from fe3b062 to cbee643 Compare February 20, 2021 21:25

RonnyPfannschmidt requested review from bluetech and nicoddemus February 20, 2021 23:19

Base automatically changed from master to main March 9, 2021 20:40

RonnyPfannschmidt force-pushed the ronny/fix-3523-deprecate-setup-cfg branch from cbee643 to 015fcf4 Compare June 6, 2021 20:39

RonnyPfannschmidt changed the title ~~refactor config file finding and deprecate setup.cfg~~ refactor config file finding Jun 6, 2021

RonnyPfannschmidt marked this pull request as ready for review June 6, 2021 20:51

RonnyPfannschmidt marked this pull request as draft October 3, 2021 18:44

RonnyPfannschmidt force-pushed the ronny/fix-3523-deprecate-setup-cfg branch 2 times, most recently from ed2ac09 to 7129605 Compare July 12, 2022 08:08

RonnyPfannschmidt marked this pull request as ready for review July 12, 2022 08:08

RonnyPfannschmidt force-pushed the ronny/fix-3523-deprecate-setup-cfg branch from 8ebc068 to c6f6e59 Compare July 12, 2022 08:44

RonnyPfannschmidt added 8 commits July 29, 2022 21:51

Refactor: turn iniconfig import optional

8db673c

Refactor: split up config loading logic to dispatch by filename/suffix

4c3d797

fix issue pytest-dev#3523 - deprecate using setup.cfg

17514c1

code drop in config: remove cli argument dropping from locate_config

5c3fea0

its already taken care of earlier

Revert pytest-dev#3523 - instead of deprecating we will drop the docs

dd7f52b

add changelog

7012fe3

remove setup.cfg usage from docs

3e01de5

fix rebase artefacts

4ac06da

RonnyPfannschmidt force-pushed the ronny/fix-3523-deprecate-setup-cfg branch from c6f6e59 to 4ac06da Compare July 29, 2022 19:51

nicoddemus requested changes Jul 31, 2022

View reviewed changes

RonnyPfannschmidt marked this pull request as draft July 31, 2022 17:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor config file finding #8358

refactor config file finding #8358

RonnyPfannschmidt commented Feb 20, 2021 •

edited

Loading

nicoddemus commented Feb 22, 2021

RonnyPfannschmidt commented Feb 27, 2021

nicoddemus commented Feb 27, 2021

RonnyPfannschmidt commented Jun 6, 2021

nicoddemus left a comment

nicoddemus Jul 31, 2022

nicoddemus Jul 31, 2022

nicoddemus Jul 31, 2022

nicoddemus Jul 31, 2022

nicoddemus Jul 31, 2022

nicoddemus Jul 31, 2022

nicoddemus Jul 31, 2022

nicoddemus Jul 31, 2022

	``setup.cfg`` file usage for pytest has been deprecated, its recommended to use ``tox.ini`` or ``pyproject.toml``
	``setup.cfg`` file usage for pytest is supported but is not recommended for new projects. Instead, use ``tox.ini`` or ``pyproject.toml`` files.

	"""Parse the legacy pytest.ini and return the contents of the pytest section
	"""Parse the pytest.ini file and return the contents of the pytest section


		Return None if the file does not contain valid pytest configuration.
		if the file exists and lacks a pytest section, consider it empty"""



		def _parse_ini_file(path: Path) -> PARSE_RESULT:
		"""Parses .ini files with expected pytest.ini sections

	todo: investigate if tool:pytest should be added
	TODO: Investigate if tool:pytest should be added.

refactor config file finding #8358

Are you sure you want to change the base?

refactor config file finding #8358

Conversation

RonnyPfannschmidt commented Feb 20, 2021 • edited Loading

nicoddemus commented Feb 22, 2021

RonnyPfannschmidt commented Feb 27, 2021

nicoddemus commented Feb 27, 2021

RonnyPfannschmidt commented Jun 6, 2021

nicoddemus left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RonnyPfannschmidt commented Feb 20, 2021 •

edited

Loading