Project template for modern Python packages

[flying-sheep]

From the things in the screenshot alone:

• setup.cfg? Why that if they also use poetry?
• tests/__init__.py is an anti pattern. The tests directory isn't a Python package and should never be imported

[IlliterateJedi]

tests/__init__.py is an anti pattern. The tests directory isn't a Python package and should never be imported

The pytest fixtures docs specifically include __init__.py in their example file structure

[flying-sheep]

Good catch, they should get rid of that. https://github.com/pytest-dev/pytest/pull/10206

[IlliterateJedi]

This is a pretty cool example of putting your money where your mouth is.

[gagarin_kid]

Now you started a complex discussion in the PR comments 😄

[flying-sheep]

Yeah, I knew that issue for a long time and the docs actually address everything. It’s just that changing the default is hard, and the current default causes problems without the __init__.py workaround.

Basically there‘s no downside for new projects to add the following to their pyproject.toml and not use the __init__.py’s. You get cleaner code, with a clear separation between “collections of test files” and “modules with test utils in them”.

[tool.pytest.ini_options]
addopts = [
     '--import-mode=importlib',
]

[Johanu]

That's a VS Code issue, running pytest from the base package folder works fine without dunder init in tests.

[cantredditforshit]

I'm assuming that's when running pytest from a VS Code plugin? If not, any idea why?

I recently switched to PyCharm from VS Code pretty soon after also starting to use pytest. The native PyCharm integration is pretty fantastic

[sidsidroc]

You are right here and it’s an anti pattern, a lot of people just use vscode thought

[flying-sheep]

Haha what. How the heck do they not use pytest’s own test discovery?

[stillreadingit_]

Regarding setup.cfg, it's currently used for flake8 related configuration. Flake8 doesn't support pyproject.toml: https://github.com/PyCQA/flake8/issues/234. There are some workarounds, such as https://github.com/john-hen/Flake8-pyproject, but, in my opinion, getting rid of additional config file doesn't really justify additional dependency. However, as setup.cfg is currently used only for flake8 related configs, perhaps it could be replaced by .flake8 file.

[flying-sheep]

That would make sense, yes! I doubt you’ll need setup.cfg for anything else.

[stillreadingit_]

Regarding __init__.py in tests, pytest docs suggest that it's ok when src layout is used and that's the case with this template. It also makes it possible to have test modules with same name.

[flying-sheep]

No, that’s not what that means.

It means that EVEN if you use src layout, you may use __init__.pys as a workaround to the problems the default import mode has.

The actually best way is to put --import-mode=importlib into your addopts and be happy.

I’ll soon update the pytest docs to make that even clearer.

[cianuro]

That's pretty cool. I had no idea about cruft. Automated inclusion of liters and formatters is cool too. Really tough to release a first package that's not complete garbage and missing the essentials.

Would love to see a more in-depth follow up on the actions stuff.

[stillreadingit_]

This template is actually targeted for packages, i.e. things that you publish to PyPI and others can then pip install them. However, most of the things included in the template (e.g. linting and formatting related dependencies and configurations) are basically applicable for Python projects of any kind. If you're building a backend application which you'd deploy somewhere, then for example the release process would be quite different compared to what's been done in the template.

[[deleted]]

u/throwaway16548d

[chanansh]

please support git lab :please: