Replace setup.py with pyproject.toml #848

moi15moi · 2025-06-12T16:30:11Z

Fix #480 (comment)
Note that when building the dist (with python -m build --sdist), it won't create a zip file anymore. It will be a tar.gz file.
There is an issue about this, see pypa/setuptools#3916, but honestly, I don't think it really matters.

codecov · 2025-06-12T16:35:34Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.72%. Comparing base (f2bd605) to head (1a1d9ad).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #848   +/-   ##
=======================================
  Coverage   84.72%   84.72%           
=======================================
  Files         125      125           
  Lines       11552    11552           
=======================================
  Hits         9787     9787           
  Misses       1765     1765

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

moi15moi · 2025-06-12T16:39:05Z

pyproject.toml

+description = "Pure Python COM package"
+readme = "README.md"
+requires-python = ">=3.8"
+license = "MIT"


I'm not really sure what is the license of the project.
setup.cfg specify MIT, but the license file seems to says OSI.

The clauses in LICENSE.txt are the same as those of the MIT License.

Although starting the file with the line MIT License is the practice generally accepted today, the wording might be consistent, as the MIT License is officially listed as an OSI-approved open source license.

comtypes/LICENSE.txt

Lines 1 to 2 in 8d40715

This software is OSI Certified Open Source Software.

OSI Certified is a certification mark of the Open Source Initiative.

@cfarrow
If you remember, I would like to confirm the intent behind this license wording with you, who committed LICENSE.txt in 8d40715.
Was this common practice when this commit was made?

moi15moi · 2025-06-12T16:50:58Z

I'm currently trying to investigate why the install-tests CI fails only for Python 3.8

moi15moi · 2025-06-12T21:31:44Z

Oh, the problem is simple.
The license in the pryproject.toml have been added in setuptools 77.0.0.
The last version to support Python 3.8 is 75.3.2, so it cannot simply work.

I guess I will need to wait that you drop 3.8 support.

junkmd · 2025-06-16T14:08:54Z

I am planning to drop support for Python 3.8 soon. 1.4.12 will likely be the last release to support it.
This means this PR might be merged after the next release.

junkmd · 2025-06-16T14:15:50Z

The migration of setup.cfg to pyproject.toml, as per this PR's title, is clear and understandable.

However, I believe the legacy setup.py code should be addressed in a separate scope.
I'm not deeply familiar with packaging, so please inform me if these two tasks are interdependent.

moi15moi · 2025-06-19T23:39:44Z

However, I believe the legacy setup.py code should be addressed in a separate scope.

It is indeed possible to keep setup.py.
But, if you want to keep setup.py, this PR isn't usefull because the pyproject.toml would basically be the same thing has setup.cfg.

But, do you have any reason to keep setup.py? The only difference between this setup (with pyproject.toml) and setup.py is that I removed the cmdclass.

There are 2 cmdclass:

post_install was just a workaround for a old setuptools bug. It's clearly not needed anymore, so it is safe to remove it.
test. I'm not sure what it does. It's seems to do the same stuff has simply running the test with my pytest, but i'm not sure. Could you confirm it?

junkmd · 2025-06-30T13:45:24Z

@moi15moi

I apologize for the delay in my response; I've been quite busy.

My initial thought to keep setup.py was mainly because I wasn't entirely clear on what those two cmdclasses were doing.
I appreciate the clarification on post_install. I now understand that it's no longer necessary in modern packaging, and I'm fine with its removal.

However, I still have some uncertainties about the test class.
My understanding is that options like tests= and use-resources= seem to have very little meaning given the current use of test resources and the unittest suite.
On the other hand, I don't fully understand the refcounts part.

The refcounts option appears to be doing something with sys.gettotalrefcount(), which is a function only available in Python's debug builds. However, the specific purpose of this test remains unclear to me.
If you have any insights or conjectures about the behavior or intent of this test class, I would greatly appreciate it if you could share them.

moi15moi · 2025-07-06T17:32:43Z

I tried to run python setup.py test in the CI. You can see the result here: https://github.com/moi15moi/comtypes/pull/10/checks
As you can see, it currently simply fails. I guess it is was a way to detect if there is memory leak when executing test?

junkmd · 2025-07-07T14:15:41Z

@moi15moi

Thank you for your investigation.

I guess it was a way to detect if there is memory leak when executing tests?

I agree.
I also suspect the code invoked when running test through setup.py relies heavily on a very old internal implementation of unittest.

I believe it's fine to remove cmdclasses and other specific functionalities from setup.py.

My main concern is whether we can safely delete setup.py entirely, even without requiring setuptools>=77.0.0.

If you have the resources to open a separate PR that solely focuses on removing setup.py (and making any necessary adjustments to other related files), I think that PR could be merged even before we drop Python 3.8 support.

moi15moi · 2025-07-14T23:40:08Z

license-files has been introduced with 77.0.0, so I cannot directly use a older version.
It is now recommand to use license-files, so, in my opinion, we should just wait to drop support for python 3.8 before merging this PR.

moi15moi · 2025-10-12T15:30:56Z

I just rebased because you dropped python 3.8 support in #839
Except for this point, I think this PR is ready to be reviewed/merged.

pyproject.toml

.github/workflows/autotest.yml

junkmd · 2025-11-29T14:39:53Z

Assuming that this patch is applied, I checked that I could upload the package to TestPyPI after building it with python -m build --sdist --wheel.
I also confirmed that the license information remained in the metadata.

…ll.py

It is needed for test_pip_install.py

This is necessary because setuptools added support for ``license`` and ``license-files`` in that version (and we use those in pyproject.toml) Changelog: https://setuptools.pypa.io/en/latest/history.html#v77-0-0

junkmd · 2025-11-30T05:13:26Z

setup.py

-    def run(self):
-        install.run(self)
-        # Custom script we run at the end of installing
-        if not self.dry_run and not self.root:
-            print("Executing post install script...")
-            print(f'"{sys.executable}" -m comtypes.clear_cache -y')
-            try:
-                subprocess.check_call([
-                    sys.executable,
-                    "-m",
-                    "comtypes.clear_cache",
-                    '-y',
-                ])
-            except subprocess.CalledProcessError:
-                print("Failed to run post install script!")


Memo:

This post-install script hook is dead code and no longer runs during pip install comtypes.
And these types of hooks are deprecated in modern packaging, we can safely remove it.

We can achieve the same result as the old setup.py installation by executing the cache clear command after installing via pip.

junkmd

Thanks!

moi15moi commented Jun 12, 2025

View reviewed changes

moi15moi force-pushed the Add-pyproject.toml branch from cae9b83 to c5c50fe Compare June 12, 2025 17:16

junkmd mentioned this pull request Aug 27, 2025

Bump version and update change log for 1.4.12 #872

Merged

junkmd mentioned this pull request Oct 11, 2025

Support Python 3.14 and drop Python 3.8. #839

Merged

moi15moi force-pushed the Add-pyproject.toml branch from 8e97a45 to 161a602 Compare October 12, 2025 15:26

junkmd reviewed Oct 18, 2025

View reviewed changes

pyproject.toml Show resolved Hide resolved

Avasam reviewed Oct 19, 2025

View reviewed changes

.github/workflows/autotest.yml Outdated Show resolved Hide resolved

moi15moi force-pushed the Add-pyproject.toml branch from 161a602 to a0d6cd6 Compare October 19, 2025 22:49

moi15moi added 4 commits November 29, 2025 15:54

Replace setup.py with pyproject.toml + update test_pip_install.py

ac2d2a7

[.gitignore] Add "custom location" folder generated by test_pip_insta…

3dae1f9

…ll.py

Install build in CI

d225ea1

It is needed for test_pip_install.py

Require setuptools 77.0.0 or more to build the project

1a1d9ad

This is necessary because setuptools added support for ``license`` and ``license-files`` in that version (and we use those in pyproject.toml) Changelog: https://setuptools.pypa.io/en/latest/history.html#v77-0-0

moi15moi force-pushed the Add-pyproject.toml branch from a9773fc to 1a1d9ad Compare November 29, 2025 20:55

junkmd reviewed Nov 30, 2025

View reviewed changes

junkmd approved these changes Dec 13, 2025

View reviewed changes

junkmd merged commit 4c95d11 into enthought:main Dec 13, 2025
170 of 199 checks passed

junkmd added this to the 1.4.14 milestone Dec 13, 2025

	This software is OSI Certified Open Source Software.
	OSI Certified is a certification mark of the Open Source Initiative.

Uh oh!

Replace setup.py with pyproject.toml #848

Replace setup.py with pyproject.toml #848

Uh oh!

Conversation

moi15moi commented Jun 12, 2025

Uh oh!

codecov bot commented Jun 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

moi15moi Jun 12, 2025

Choose a reason for hiding this comment

Uh oh!

junkmd Oct 18, 2025

Choose a reason for hiding this comment

Uh oh!

moi15moi commented Jun 12, 2025

Uh oh!

moi15moi commented Jun 12, 2025

Uh oh!

junkmd commented Jun 16, 2025

Uh oh!

junkmd commented Jun 16, 2025

Uh oh!

moi15moi commented Jun 19, 2025

Uh oh!

junkmd commented Jun 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

moi15moi commented Jul 6, 2025

Uh oh!

junkmd commented Jul 7, 2025

Uh oh!

moi15moi commented Jul 14, 2025

Uh oh!

moi15moi commented Oct 12, 2025

Uh oh!

Uh oh!

Uh oh!

junkmd commented Nov 29, 2025

Uh oh!

junkmd Nov 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

junkmd left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented Jun 12, 2025 •

edited

Loading

junkmd commented Jun 30, 2025 •

edited

Loading

junkmd Nov 30, 2025 •

edited

Loading