Allowed fallback usage of `project.name` for `name` and `package` if pyproject.toml exists #687

zerothi · 2025-02-20T08:59:00Z

Description

Fixes #685

Checklist

Make sure changes are covered by existing or new tests.
For at least one Python version, make sure test pass on your local environment.
Create a file in src/towncrier/newsfragments/. Briefly describe your
changes, with information useful to end users. Your change will be included in the public release notes.
Make sure all GitHub Actions checks are green (they are automatically checking all of the above).
Ensure docs/tutorial.rst is still up-to-date.
If you add new CLI arguments (or change the meaning of existing ones), make sure docs/cli.rst reflects those changes.
If you add new configuration options (or change the meaning of existing ones), make sure docs/configuration.rst reflects those changes.

This fallback will only work if the pyproject.toml file is present. However, it will work for any combination of pyproject.toml or towncrier.toml configuration files. Note, that project.name is a required field in pyproject.toml files. Hence, the minimal requirement for using towncrier in python project is a no-op! Signed-off-by: Nick Papior <nickpapior@gmail.com>

Signed-off-by: Nick Papior <nickpapior@gmail.com>

Due to the lifting of minimal configuration in python projects the entry is not required any more. Signed-off-by: Nick Papior <nickpapior@gmail.com>

zerothi · 2025-02-20T09:10:41Z

So this drastically changes the requirement of having a tool.towncrier section, however, I think this is ok given the circumstances. If you want to use towncrier, then you'll likely put something anyway, in particular if you are not using a python project.

So unless that is a big objection, I think this is a more or less complete PR that catches undefined name|package. Do you want a test for the last thing not covered?

zerothi · 2025-02-20T09:12:56Z

One thing, you said I should use the metadata, but I am inclined not to. That would only work for Python projects, and so the path would be something like:

project_name = pyproject_config["project"]["name"]
project_name = importlib.metadata.metadata(project_name)["Name"]

is this more in line with what you want?

adiroiban

Many thanks for the PR.

I am quite busy these days and I don't have much time for side-projects.

I tried to do a quick review.

Can you update the PR title to provide a summary of what is done here?

Do you want a test for the last thing not covered?

If this is a functionality that is documented, then we need automated tests.

If the functionality is not documented and has no tests, then this is an "accidental" feature and it might break any time in the future.

One thing, you said I should use the metadata, but I am inclined not to. That would only work for Python projects, and so the path would be something like:

I am ok with the current implementation.
No need to extract the package name from importlib.metadata

As long as we don't break backward compatility, anyting should be ok

Do have a test that proves that if we have

[project]
name = "Dull Pants"
[tool.towncrier]
name = "Fancy Pants"
package = fancy_pants

the config will prefer the value from [tool.towncrier] ?

Thanks again

adiroiban · 2025-02-21T16:24:30Z

src/towncrier/test/test_settings.py

@@ -112,22 +112,6 @@ def test_template_extended(self):

        self.assertEqual(config.template, ("towncrier.templates", "default.rst"))

-    def test_missing(self):


why was this test removed?

because now towncrier does not need any tool.towncrier section for Python projects using pyproject.toml files.

A pyproject.toml file requires the name field, and hence everything can be used without problems.

The removed test checked that it broke when tool.towncrier was not present, simply because it is not required.

adiroiban · 2025-02-21T16:27:48Z

src/towncrier/test/test_settings.py

@@ -194,6 +178,42 @@ def test_towncrier_toml_preferred(self):
        config = load_config(project_dir)
        self.assertEqual(config.package, "a")

+    def test_pyproject_name_fallback_both(self):
+        """
+        Towncrier will fallback to the [project.name] value in pyproject.toml.


Just a small suggestion to help understand the scope of this test.

Suggested change

Towncrier will fallback to the [project.name] value in pyproject.toml.

To obtain the name of the project, when there is no dedicated [tool.towncrier] section in pyproject.toml, it will fallback to the `name` option from the [project] section.

Just asking. Is towncrier usable without a configuration section ?

Yes. When it is a Python project with a pyproject.toml file, then a configuration file / setting is not required.

src/towncrier/test/test_settings.py

src/towncrier/newsfragments/687.feature.rst

Signed-off-by: Nick Papior <nickpapior@gmail.com>

zerothi · 2025-02-24T20:15:54Z

As long as we don't break backward compatility, anyting should be ok

Do have a test that proves that if we have

done!

I think everything is done, let me know if there is something that needs clarification.

adiroiban

Looks good. Great work! Thanks again for the PR.

zerothi added 2 commits February 20, 2025 09:56

added the news-fragment

8f8c9f5

Signed-off-by: Nick Papior <nickpapior@gmail.com>

zerothi requested a review from a team as a code owner February 20, 2025 08:59

zerothi added 2 commits February 20, 2025 10:02

a minimal configuration now does not require tool.towncrier

7eda8b3

Signed-off-by: Nick Papior <nickpapior@gmail.com>

removed test that asserts tool.towncrier section

45cc1bf

Due to the lifting of minimal configuration in python projects the entry is not required any more. Signed-off-by: Nick Papior <nickpapior@gmail.com>

adiroiban reviewed Feb 21, 2025

View reviewed changes

zerothi changed the title ~~685 name~~ Allowed fallback usage of project.name for name and package if pyproject.toml exists Feb 22, 2025

zerothi added 2 commits February 24, 2025 20:25

amended tests according to feedback in PR

afe1f42

Signed-off-by: Nick Papior <nickpapior@gmail.com>

fixed order of field grabbing

cfdb1f0

Signed-off-by: Nick Papior <nickpapior@gmail.com>

adiroiban approved these changes Feb 25, 2025

View reviewed changes

adiroiban merged commit cd14c9c into twisted:trunk Feb 25, 2025
16 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allowed fallback usage of `project.name` for `name` and `package` if pyproject.toml exists #687

Allowed fallback usage of `project.name` for `name` and `package` if pyproject.toml exists #687

zerothi commented Feb 20, 2025 •

edited

Loading

zerothi commented Feb 20, 2025

zerothi commented Feb 20, 2025

adiroiban left a comment •

edited

Loading

adiroiban Feb 21, 2025

zerothi Feb 24, 2025

adiroiban Feb 21, 2025

zerothi Feb 24, 2025

zerothi commented Feb 24, 2025 •

edited

Loading

adiroiban left a comment

		@@ -112,22 +112,6 @@ def test_template_extended(self):

		self.assertEqual(config.template, ("towncrier.templates", "default.rst"))

		def test_missing(self):

	Towncrier will fallback to the [project.name] value in pyproject.toml.
	To obtain the name of the project, when there is no dedicated [tool.towncrier] section in pyproject.toml, it will fallback to the `name` option from the [project] section.

Allowed fallback usage of project.name for name and package if pyproject.toml exists #687

Allowed fallback usage of project.name for name and package if pyproject.toml exists #687

Conversation

zerothi commented Feb 20, 2025 • edited Loading

Description

Checklist

zerothi commented Feb 20, 2025

zerothi commented Feb 20, 2025

adiroiban left a comment • edited Loading

Choose a reason for hiding this comment

adiroiban Feb 21, 2025

Choose a reason for hiding this comment

zerothi Feb 24, 2025

Choose a reason for hiding this comment

adiroiban Feb 21, 2025

Choose a reason for hiding this comment

zerothi Feb 24, 2025

Choose a reason for hiding this comment

zerothi commented Feb 24, 2025 • edited Loading

adiroiban left a comment

Choose a reason for hiding this comment

Allowed fallback usage of `project.name` for `name` and `package` if pyproject.toml exists #687

Allowed fallback usage of `project.name` for `name` and `package` if pyproject.toml exists #687

zerothi commented Feb 20, 2025 •

edited

Loading

adiroiban left a comment •

edited

Loading

zerothi commented Feb 24, 2025 •

edited

Loading