feat: use hatchling, drop setuptools #1323

onerandomusername · 2025-08-25T20:08:31Z

closes #664

read-the-docs-community · 2025-09-20T20:38:48Z

Documentation build overview

📚 disnake | 🛠️ Build #29974033 | 📁 Comparing 3fe0fa6 against latest (dba1a62)

🔍 Preview build

Show files changed (49 files in total): 📝 49 modified | ➕ 0 added | ➖ 0 deleted

File	Status
genindex.html	📝 modified
index.html	📝 modified
whats_new.html	📝 modified
api/abc.html	📝 modified
api/activities.html	📝 modified
api/app_commands.html	📝 modified
api/app_info.html	📝 modified
api/audit_logs.html	📝 modified
api/automod.html	📝 modified
api/channels.html	📝 modified
api/clients.html	📝 modified
api/components.html	📝 modified
api/emoji.html	📝 modified
api/entitlements.html	📝 modified
api/events.html	📝 modified
api/exceptions.html	📝 modified
api/guild_scheduled_events.html	📝 modified
api/guilds.html	📝 modified
api/integrations.html	📝 modified
api/interactions.html	📝 modified
api/invites.html	📝 modified
api/localization.html	📝 modified
api/members.html	📝 modified
api/messages.html	📝 modified
api/misc.html	📝 modified
api/permissions.html	📝 modified
api/roles.html	📝 modified
api/skus.html	📝 modified
api/soundboard.html	📝 modified
api/stage_instances.html	📝 modified
api/stickers.html	📝 modified
api/subscriptions.html	📝 modified
api/ui.html	📝 modified
api/users.html	📝 modified
api/utilities.html	📝 modified
api/voice.html	📝 modified
api/webhooks.html	📝 modified
api/widgets.html	📝 modified
ext/tasks/index.html	📝 modified
ext/commands/api/app_commands.html	📝 modified
ext/commands/api/bots.html	📝 modified
ext/commands/api/checks.html	📝 modified
ext/commands/api/cogs.html	📝 modified
ext/commands/api/context.html	📝 modified
ext/commands/api/converters.html	📝 modified
ext/commands/api/exceptions.html	📝 modified
ext/commands/api/help_commands.html	📝 modified
ext/commands/api/misc.html	📝 modified
ext/commands/api/prefix_commands.html	📝 modified

…chling

shiftinv

Looks pretty good! I spent some time looking into hatchling + versioningit, but haven't fully reviewed everything just yet, so here are some preliminary comments:

disnake/__init__.py

docs/conf.py

noxfile.py

.gitattributes

shiftinv · 2025-10-14T15:50:40Z

pyproject.toml

    "towncrier==23.6.0",
    "sphinx-notfound-page==0.8.3",
    "sphinxext-opengraph==0.9.1",
+    "versioningit>=3.3.0",


Suggested change

"versioningit>=3.3.0",

"versioningit~=3.3",

Versioningit is special. It is a build dependency, so it shouldn't be pinned. this matches what we have in build-requires.

build-requires limits it to <4.0, which is what ~=3.3 also effectively does

oh. I should undo that.

There might be some merit to specifying an upper bound, since this uses a custom template-fields function:

Moreover, the basic pyproject.toml interface to versioningit can be considered very stable [...]. Nearly all breaking changes will be to the library or custom method API; if you’ve written any code that uses this part of the API, you are advised to declare the next major version of versioningit as an upper bound on your versioningit dependency.

https://versioningit.readthedocs.io/en/stable/notes.html#backwards-compatibility-policy

pyproject.toml

shiftinv · 2025-10-17T09:26:08Z

docs/extensions/versionchange.py

            # Get the version from the Sphinx config
-            version = self.env.config.version
-            self.arguments[0] = version
+            self.arguments[0] = versioningit.get_next_version(
+                pathlib.Path(__file__).parent.parent.parent
+            )


This seems a bit like a hack, we could integrate this a little better with

... self.arguments[0] = self.env.config.next_version ... def setup(app): app.add_config_value("next_version", None, "env", types=[str])

shiftinv · 2025-10-17T09:28:56Z

.github/workflows/release.yaml

Now that the version gets inferred and isn't being set manually anymore, I believe all the versiontool.py stuff from this file and create-release-pr.yaml (as well as the script itself) can be removed

Yeah. I plan to update all of the release pr stuff separately because of the vnext change that also needs to be implemented

Changelog generation and vnext fixing needs to be committed, then tagged.

But I'll be doing this in another pull.

shiftinv · 2025-10-17T09:34:13Z

pyproject.toml

 ]
-
-
-[tool.check-manifest]


We obviously don't have a MANIFEST.in anymore, but could it be worth considering finding a replacement for check-manifest somehow, that at least checks the sdist against a preset list of files we expect in there?

shiftinv · 2025-10-17T09:40:43Z

pyproject.toml

+include = [
+    "disnake/",
+]


perhaps worth noting a tiny issue. there doesn't seem to be a single python file in the built wheel besides _version.py:

Seems like the sdist include below is overwriting the global include.

shiftinv · 2025-10-17T09:49:46Z

pyproject.toml

+[tool.versioningit.format]
+distance = "{base_version}+{distance}.{vcs}{rev}"
+dirty = "{base_version}+d{build_date:%Y%m%d}"
+distance-dirty = "{base_version}.a{distance}+{vcs}{rev}.d{build_date:%Y%m%d}"


These don't quite match, making builds of dirty trees use a slightly different format:

clean: disnake-2.11.0+66.g3fe0fa63-py3-none-any.whl dirty: disnake-2.11.0a66+g3fe0fa63.d20251017-py3-none-any.whl

(note the +66 vs a66)

shiftinv · 2025-10-17T10:11:21Z

scripts/versioning.py

+    params: Dict[str, Any],
+) -> Dict[str, Any]:
+    """Implements the ``"basic"`` ``template-fields`` method"""
+    params = copy.deepcopy(params)


Suggested change

params = copy.deepcopy(params)

appears to be unused

shiftinv · 2025-10-17T10:16:39Z

pyproject.toml

+[tool.versioningit]
+default-version = "0.0.0"
+


Suggested change

[tool.versioningit]

default-version = "0.0.0"

If anything goes catastrophically wrong I'd rather know about it, having a default version set will essentially ignore any errors

shiftinv · 2025-10-17T10:19:01Z

scripts/versioning.py

+    }
+
+    if parsed_version.pre:
+        releaselevel = releaselevels.get(parsed_version.pre[0], "final")


pre[0] won't work for rc versions

shiftinv · 2025-10-17T10:20:21Z

scripts/versioning.py

+    if description is not None:
+        fields.update(description.fields)
+        fields["branch"] = description.branch
+    if base_version is not None:
+        fields["base_version"] = base_version
+    if next_version is not None:
+        fields["next_version"] = next_version


The template only uses {version} and {version_template}, are these actually needed here?

shiftinv · 2025-10-17T10:20:44Z

scripts/versioning.py

+    try:
+        fields["normalized_version"] = str(packaging.version.Version(version))
+    except ValueError:
+        fields["normalized_version"] = version


+1, see previous comment

onerandomusername force-pushed the feat/build-with-hatchling branch 3 times, most recently from f7a43c1 to 27cb9ad Compare August 25, 2025 21:44

shiftinv added t: dependencies Addition/update/removal of dependencies t: meta Changes to the project itself (CI, configs, etc.) labels Aug 26, 2025

onerandomusername force-pushed the feat/build-with-hatchling branch 2 times, most recently from 0d9175a to e7d0b60 Compare August 27, 2025 02:22

onerandomusername marked this pull request as ready for review August 27, 2025 07:53

onerandomusername requested a review from a team as a code owner August 27, 2025 07:53

onerandomusername force-pushed the feat/build-with-hatchling branch 3 times, most recently from 4eed882 to 2063c20 Compare September 3, 2025 05:03

onerandomusername force-pushed the feat/build-with-hatchling branch 2 times, most recently from 3785324 to 8a314c4 Compare September 4, 2025 22:52

shiftinv mentioned this pull request Sep 5, 2025

feat(packaging): migrate packages out of setup.py #1356

Merged

8 tasks

onerandomusername force-pushed the feat/build-with-hatchling branch from 8a314c4 to 0294825 Compare September 5, 2025 10:09

onerandomusername force-pushed the feat/build-with-hatchling branch from 0294825 to 332e4c8 Compare September 12, 2025 19:51

onerandomusername added 10 commits September 15, 2025 02:49

feat: migrate build backend to hatchling

090dbf0

fix: use the version from disnake/__init__.py

7cbf902

feat: add partial dynamic versioning support (not yet backwards compat)

22a63ae

fix: version back compat

1384522

fix: provide a fallback version when the version cannot be determined

294e2f3

fix: use importlib.metadata for docs building

a3e98d7

fix: show the next version on the docs changelog

cc0b230

fix: build on rtd

d2eb4b7

chore: add changelog

781cc75

fix: drop check-manifest

28ab5b2

onerandomusername force-pushed the feat/build-with-hatchling branch from 7a2f2b1 to 28ab5b2 Compare September 15, 2025 06:49

Merge branch 'master' into feat/build-with-hatchling

a85fb10

onerandomusername added 2 commits September 26, 2025 09:33

Merge branch 'master' into feat/build-with-hatchling

650ab6d

no more check-manifest

b4b12ce

onerandomusername force-pushed the feat/build-with-hatchling branch from a5a9aca to b4b12ce Compare September 26, 2025 13:46

onerandomusername added 3 commits September 26, 2025 12:52

fix: typing

53f6902

Merge remote-tracking branch 'origin/master' into feat/build-with-hat…

32c4e53

…chling

Merge branch 'master' into feat/build-with-hatchling

ca72997

shiftinv reviewed Oct 13, 2025

View reviewed changes

disnake/__init__.py Show resolved Hide resolved

docs/conf.py Show resolved Hide resolved

noxfile.py Outdated Show resolved Hide resolved

.gitattributes Outdated Show resolved Hide resolved

onerandomusername added 4 commits October 15, 2025 03:17

apply suggestions

8b51017

docs: update |vnext| to use next version

2c334b1

Merge branch 'master' into feat/build-with-hatchling

0de1b84

fix:

2db92a2

onerandomusername force-pushed the feat/build-with-hatchling branch from dd74f06 to 2db92a2 Compare October 15, 2025 08:39

onerandomusername requested a review from shiftinv October 15, 2025 08:40

shiftinv reviewed Oct 16, 2025

View reviewed changes

fix: update build dependency versions

3fe0fa6

onerandomusername requested a review from shiftinv October 16, 2025 20:02

shiftinv reviewed Oct 17, 2025

View reviewed changes

		]


		[tool.check-manifest]

feat: use hatchling, drop setuptools #1323

Are you sure you want to change the base?

feat: use hatchling, drop setuptools #1323

Uh oh!

Conversation

onerandomusername commented Aug 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

read-the-docs-community bot commented Sep 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Documentation build overview

Uh oh!

shiftinv left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

onerandomusername Oct 17, 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

onerandomusername commented Aug 25, 2025 •

edited

Loading

read-the-docs-community bot commented Sep 20, 2025 •

edited

Loading

onerandomusername Oct 17, 2025 •

edited

Loading