Migrate tool settings from setup.cfg to pyproject.toml #363

pepoluan · 2023-01-13T09:50:46Z

What do these changes do?

Practically all still-maintained projects are migrating to have a Single Source of Truth for their builds: pyproject.toml

This is in accordance with the guidelines in PEP518 and PEP621.

I have ascertained that all tools aiosmtpd uses -- both as dependency or for development -- now have support for putting their configuration in pyproject.toml (some needs a bit of workaround but works well). This left us with an empty setup.cfg file, which I removed because it's no longer useful (all setup information is now in pyproject.toml as well).

Are there changes in behavior for the user?

None if user has the latest pip and setuptools.

Related issue number

None.

Checklist

I think the code is well written
Unit tests for the changes exist
tox testenvs have been executed in the following environments:
- GitHub CI
Documentation reflects the changes
Add a news fragment into the NEWS.rst file

This also requires additional exclusions or pytype will get confused

... and delete setup.cfg

Because we no longer have `setup.py` Also add one line to ensure the latest version of pip and setuptools

setup.cfg

pepoluan · 2023-01-13T09:53:50Z

.github/workflows/unit-testing-and-coverage.yml

+          echo "Running flake8 ... there will be no output if no errors:"
+          python -m flake8 aiosmtpd housekeep.py release.py
+          echo "flake8 done."


Added just to ensure that flake8 actually runs. flake8's silence on no error sometimes make me wonder if it ran or not 😅

FWIW it's quite common to wrap linters with the pre-commit.com too.

pepoluan · 2023-01-13T09:57:41Z

release.py

@@ -28,8 +28,12 @@
    f"dist/aiosmtpd-{ver_str}-py3-none-any.whl",
 ]

+RELEASE_TOOLKIT = ["setuptools", "wheel", "twine", "build"]


build is the new build system created by PyPA that supports PEP 517.

Yes. You need build for making dists and twine for linting them.

Also, PyPI no longer supports GPG. It's possible to use Sigstore, though.

My PyPUG article has an example of that: https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/.

Suggested change

RELEASE_TOOLKIT = ["setuptools", "wheel", "twine", "build"]

RELEASE_TOOLKIT = ["build", "twine"]

pepoluan

A few comments

codecov · 2023-01-13T09:59:34Z

Codecov Report

Merging #363 (75cc9d5) into master (79c8671) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##            master      #363   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            7         7           
  Lines         1706      1706           
  Branches       310       310           
=========================================
  Hits          1706      1706

Impacted Files	Coverage Δ
aiosmtpd/__init__.py	`100.00% <100.00%> (ø)`

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

waynew

Aaaawesome! A few bits of feedback - not sure if anything really needs to change...

waynew · 2023-01-13T14:37:14Z

.github/workflows/unit-testing-and-coverage.yml

@@ -38,7 +36,7 @@ jobs:
        # language=bash
        run: |
          python -m pip install --upgrade pip setuptools wheel
-          python setup.py develop
+          python -m pip install .


Should that be install -e .?

that's more equivalent to develop

Maybe? Ahaha this "install using pyproject.toml" is so new to me 😅

Yes, -e would be the direct equivalent.

waynew · 2023-01-13T14:38:21Z

.github/workflows/unit-testing-and-coverage.yml

@@ -110,7 +112,7 @@ jobs:
        # Test deps
        pip install colorama "coverage>=7.0.1" coverage[toml] "coverage-conditional-plugin>=0.5.0" packaging pytest pytest-cov pytest-mock
        # Package deps
-        python setup.py develop
+        python -m pip install .


Same question here, -e?

waynew · 2023-01-13T14:40:59Z

README.rst


    $ python3 -m venv /path/to/venv
    $ source /path/to/venv/bin/activate
-    $ python setup.py install
+    $ python -m pip install -U pip setuptools
+    $ python -m pip install .


I think here we should definitely recommend editable mode, if we're suggesting folks clone flr dev. Otherwise they can just install from pypi

Same as before. Let me do some study / experiments.

@pepoluan feel free to ask me if you have questions about Python packaging. I maintain PyPUG.

waynew · 2023-01-13T14:42:50Z

pyproject.toml

+dependencies = [
+    "atpublic",
+    "attrs",
+    "typing-extensions ; python_version < '3.8'",


Are typing extensions require to run aiosmtpd?

iirc it's to implement Protocol, I think that's in the Tproxy code.

Not really sure if that's actually needed to just run ...

Assuming that it's not needed for running we can put it in an extras_require (yeah, not extra_requires) section. I'm not sure what the precise form is for that, tho.

If that were true, it should be here, not in extras. FWIW it's only used in tests:

aiosmtpd/aiosmtpd/tests/test_handlers.py

Line 30 in abadbd4

from typing_extensions import Protocol

. Judging by the lack of it in runtime code, it might be fine to drop it from the tests and deps.

waynew · 2023-03-02T01:39:24Z

@pepoluan FYI I'm still super interested in this getting in. There is a merge conflict in __init__.py. I've (re)reviewed PRs newer and up to this one, and will probably review more tomorrow afternoon.

webknjaz · 2024-08-31T09:57:51Z

pyproject.toml

+# region #### setuptools settings ##########
+
+[tool.setuptools]
+zip-safe = false


Why is it unsafe?

pepoluan added 8 commits January 13, 2023 15:42

Migrate from setup.{py,cfg} to pyproject.toml

2a5d3d8

This also requires additional exclusions or pytype will get confused

Force flake8 to use pyproject.toml using flake8-pyproject plugin

dbb3275

Additional comment w.r.t limiter spacing in tox.ini

3a756a7

Minor improvement of release.py

21700dc

Move project metadata to front, outside of setuptools part

26f736f

Move pytype config to pyproject.toml

c9e1570

... and delete setup.cfg

Update NEWS.rst + bump version

80c7bf5

Update README.rst

75cc9d5

Because we no longer have `setup.py` Also add one line to ensure the latest version of pip and setuptools

pepoluan added tech-debt Things that needs to be tidied up to avoid being bitten in the future... integration labels Jan 13, 2023

pepoluan added this to the 1.5 milestone Jan 13, 2023

pepoluan commented Jan 13, 2023

View reviewed changes

setup.cfg Show resolved Hide resolved

pepoluan commented Jan 13, 2023

View reviewed changes

pepoluan mentioned this pull request Jan 13, 2023

Docs and tests are installed #356

Open

waynew requested changes Jan 13, 2023

View reviewed changes

pepoluan mentioned this pull request Jan 18, 2023

1.4.4: issues on building module and documentation #364

Closed

webknjaz reviewed Aug 31, 2024

View reviewed changes

pyproject.toml

# region #### setuptools settings ##########

[tool.setuptools]

zip-safe = false

Copy link

Member

webknjaz Aug 31, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is it unsafe?

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate tool settings from setup.cfg to pyproject.toml #363

Migrate tool settings from setup.cfg to pyproject.toml #363

pepoluan commented Jan 13, 2023

pepoluan Jan 13, 2023

webknjaz Jan 10, 2024

pepoluan Jan 13, 2023

webknjaz Jan 10, 2024

webknjaz Jan 10, 2024

webknjaz Aug 31, 2024

pepoluan left a comment

codecov bot commented Jan 13, 2023

waynew left a comment

waynew Jan 13, 2023

pepoluan Jan 14, 2023

webknjaz Jan 10, 2024

waynew Jan 13, 2023

waynew Jan 13, 2023

pepoluan Jan 14, 2023

webknjaz Jan 10, 2024

waynew Jan 13, 2023

pepoluan Jan 14, 2023

waynew Mar 2, 2023

webknjaz Aug 31, 2024

waynew commented Mar 2, 2023

webknjaz Aug 31, 2024

	RELEASE_TOOLKIT = ["setuptools", "wheel", "twine", "build"]
	RELEASE_TOOLKIT = ["build", "twine"]

Migrate tool settings from setup.cfg to pyproject.toml #363

Are you sure you want to change the base?

Migrate tool settings from setup.cfg to pyproject.toml #363

Conversation

pepoluan commented Jan 13, 2023

What do these changes do?

Are there changes in behavior for the user?

Related issue number

Checklist

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

pepoluan left a comment

Choose a reason for hiding this comment

codecov bot commented Jan 13, 2023

Codecov Report

waynew 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

waynew commented Mar 2, 2023

Choose a reason for hiding this comment