swap toml with tomli #354

graingert · 2021-07-02T22:21:55Z

pip is moving from toml to tomli pypa/pip#10035 towncrier should consider following suit

codecov · 2021-07-02T22:23:30Z

Codecov Report

Merging #354 (322d3eb) into master (61681d6) will increase coverage by 0.01%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #354      +/-   ##
==========================================
+ Coverage   96.79%   96.80%   +0.01%     
==========================================
  Files          20       20              
  Lines        1187     1191       +4     
  Branches      106      107       +1     
==========================================
+ Hits         1149     1153       +4     
  Misses         20       20              
  Partials       18       18

Impacted Files	Coverage Δ
src/towncrier/_settings.py	`96.15% <100.00%> (+0.20%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 61681d6...322d3eb. Read the comment docs.

src/towncrier/_settings.py

twm · 2021-07-03T21:10:55Z

It looks like you'll need to drop Python 3.5 support too.

altendky · 2021-07-07T14:34:55Z

What's the benefit of this switch to justify dropping <3.6? FWIW, here's my take on supporting old versions. https://github.com/pytest-dev/pytest-twisted/tree/5dc4efc5d335da0172fec02e48076aacef4bf75d#python-2-support-plans

graingert · 2021-07-07T16:04:33Z

What's the benefit of this switch to justify dropping <3.6? FWIW, here's my take on supporting old versions. https://github.com/pytest-dev/pytest-twisted/tree/5dc4efc5d335da0172fec02e48076aacef4bf75d#python-2-support-plans

toml doesn't support toml v1 syntax

hukkin · 2021-07-07T16:15:26Z

As graingert mentioned, this will avoid issues like this Black issue, i.e. crashing hard if another tool uses TOML v1 syntax in the shared pyproject.toml.

Note that by setting python_requires='>=3.6' metadata in setup.py (currently not set), many legacy Python users will not notice Python 2 being dropped, as pip is smart enough to not install unsupported versions.

setup.py

altendky · 2021-07-07T16:18:58Z

Well, yeah, that'll be a relevant reason... :| Thanks for the explanation. After getting the last release out I've more or less disappeared so I've got no real say in process here at the moment, but is there any chance we could get another release out with whatever bugfixes before dropping 2.7 etc?

Co-authored-by: Taneli Hukkinen <3275109+hukkin@users.noreply.github.com>

graingert · 2021-07-07T16:37:14Z

Well, yeah, that'll be a relevant reason... :| Thanks for the explanation. After getting the last release out I've more or less disappeared so I've got no real say in process here at the moment, but is there any chance we could get another release out with whatever bugfixes before dropping 2.7 etc?

Yeah would be good to get another release

graingert · 2021-07-07T16:37:59Z

Could make this a conditional dep and drag 2.7 support on for a little while longer

This reverts commit b06c863.

This reverts commit 43ccc05.

This reverts commit 71060f3.

setup.py

src/towncrier/_settings.py

graingert · 2021-07-07T20:58:51Z

@altendky the conditional import isn't so bad py2.7 can survive another day

altendky

I appreciate the accommodation.

Same as `towncrier` did until recently: twisted/towncrier#354

towncrier 22.12.0 (2022-12-21) ============================== No changes since the previous release candidate. towncrier 22.12.0rc1 (2022-12-20) ================================= Features -------- - Added ``--keep`` option to the ``build`` command that allows generating a newsfile, but keeps the newsfragments in place. This option can not be used together with ``--yes``. (`#129 <https://github.com/hawkowl/towncrier/issues/129>`_) - Python 3.11 is now officially supported. (`#427 <https://github.com/hawkowl/towncrier/issues/427>`_) - You can now create fragments that are not associated with issues. Start the name of the fragment with ``+`` (e.g. ``+anything.feature``). The content of these orphan news fragments will be included in the release notes, at the end of the category corresponding to the file extension. To help quickly create a unique orphan news fragment, ``towncrier create +.feature`` will append a random string to the base name of the file, to avoid name collisions. (`#428 <https://github.com/hawkowl/towncrier/issues/428>`_) Improved Documentation ---------------------- - Improved contribution documentation. (`#415 <https://github.com/hawkowl/towncrier/issues/415>`_) - Correct a typo in the readme that incorrectly documented custom fragments in a format that does not work. (`#424 <https://github.com/hawkowl/towncrier/issues/424>`_) - The documentation has been restructured and (hopefully) improved. (`#435 <https://github.com/hawkowl/towncrier/issues/435>`_) - Added a Markdown-based how-to guide. (`#436 <https://github.com/hawkowl/towncrier/issues/436>`_) - Defining custom fragments using a TOML array is not deprecated anymore. (`#438 <https://github.com/hawkowl/towncrier/issues/438>`_) Deprecations and Removals ------------------------- - Default branch for `towncrier check` is now "origin/main" instead of "origin/master". If "origin/main" does not exist, fallback to "origin/master" with a deprecation warning. (`#400 <https://github.com/hawkowl/towncrier/issues/400>`_) Misc ---- - `#406 <https://github.com/hawkowl/towncrier/issues/406>`_, `#408 <https://github.com/hawkowl/towncrier/issues/408>`_, `#411 <https://github.com/hawkowl/towncrier/issues/411>`_, `#412 <https://github.com/hawkowl/towncrier/issues/412>`_, `#413 <https://github.com/hawkowl/towncrier/issues/413>`_, `#414 <https://github.com/hawkowl/towncrier/issues/414>`_, `#416 <https://github.com/hawkowl/towncrier/issues/416>`_, `#418 <https://github.com/hawkowl/towncrier/issues/418>`_, `#419 <https://github.com/hawkowl/towncrier/issues/419>`_, `#421 <https://github.com/hawkowl/towncrier/issues/421>`_, `#429 <https://github.com/hawkowl/towncrier/issues/429>`_, `#430 <https://github.com/hawkowl/towncrier/issues/430>`_, `#431 <https://github.com/hawkowl/towncrier/issues/431>`_, `#434 <https://github.com/hawkowl/towncrier/issues/434>`_, `#446 <https://github.com/hawkowl/towncrier/issues/446>`_, `#447 <https://github.com/hawkowl/towncrier/issues/447>`_ towncrier 22.8.0 (2022-08-29) ============================= No significant changes since the previous release candidate. towncrier 22.8.0.rc1 (2022-08-28) ================================= Features -------- - Make the check subcommand succeed for branches that change the news file This should enable the ``check`` subcommand to be used as a CI lint step and not fail when a pull request only modifies the configured news file (i.e. when the news file is being assembled for the next release). (`#337 <https://github.com/hawkowl/towncrier/issues/337>`_) - Added support to tables in toml settings, which provides a more intuitive way to configure custom types. (`#369 <https://github.com/hawkowl/towncrier/issues/369>`_) - The `towncrier create` command line now has a new `-m TEXT` argument that is used to define the content of the newly created fragment. (`#374 <https://github.com/hawkowl/towncrier/issues/374>`_) Bugfixes -------- - The extra newline between the title and rendered content when using ``--draft`` is no longer inserted. (`#105 <https://github.com/hawkowl/towncrier/issues/105>`_) - The detection of duplicate release notes was fixed and recording changes of same version is no longer triggered. Support for having the release notes for each version in a separate file is working again. This is a regression introduced in VERSION 19.9.0rc1. (`#391 <https://github.com/hawkowl/towncrier/issues/391>`_) Improved Documentation ---------------------- - Improve ``CONTRIBUTING.rst`` and add PR template. (`#342 <https://github.com/hawkowl/towncrier/issues/342>`_) - Move docs too the main branch and document custom fragment types. (`#367 <https://github.com/hawkowl/towncrier/issues/367>`_) - The CLI help messages were updated to contain more information. (`#384 <https://github.com/hawkowl/towncrier/issues/384>`_) Deprecations and Removals ------------------------- - Support for all Python versions older than 3.7 has been dropped. (`#378 <https://github.com/hawkowl/towncrier/issues/378>`_) Misc ---- - `#292 <https://github.com/hawkowl/towncrier/issues/292>`_, `#330 <https://github.com/hawkowl/towncrier/issues/330>`_, `#366 <https://github.com/hawkowl/towncrier/issues/366>`_, `#376 <https://github.com/hawkowl/towncrier/issues/376>`_, `#377 <https://github.com/hawkowl/towncrier/issues/377>`_, `#380 <https://github.com/hawkowl/towncrier/issues/380>`_, `#381 <https://github.com/hawkowl/towncrier/issues/381>`_, `#382 <https://github.com/hawkowl/towncrier/issues/382>`_, `#383 <https://github.com/hawkowl/towncrier/issues/383>`_, `#393 <https://github.com/hawkowl/towncrier/issues/393>`_, `#399 <https://github.com/hawkowl/towncrier/issues/399>`_, `#402 <https://github.com/hawkowl/towncrier/issues/402>`_ towncrier 21.9.0 (2022-02-04) ============================= Features -------- - towncrier --version` was added to the command line interface to show the product version. (`#339 <https://github.com/hawkowl/towncrier/issues/339>`_) - Support Toml v1 syntax with tomli on Python 3.6+ (`#354 <https://github.com/hawkowl/towncrier/issues/354>`_) Bugfixes -------- - Stop writing title twice when ``title_format`` is specified. (`#346 <https://github.com/hawkowl/towncrier/issues/346>`_) - Disable universal newlines when reading TOML (`#359 <https://github.com/hawkowl/towncrier/issues/359>`_) Misc ---- - `#332 <https://github.com/hawkowl/towncrier/issues/332>`_, `#333 <https://github.com/hawkowl/towncrier/issues/333>`_, `#334 <https://github.com/hawkowl/towncrier/issues/334>`_, `#338 <https://github.com/hawkowl/towncrier/issues/338>`_ towncrier 21.3.0 (2021-04-02) ============================= No significant changes since the previous release candidate. towncrier 21.3.0.rc1 (2021-03-21) ================================= Features -------- - Ticket number from file names will be stripped down to avoid ticket links such as ``#7``. (`#126 <https://github.com/hawkowl/towncrier/issues/126>`_) - Allow definition of the project ``version`` and ``name`` in the configuration file. This allows use of towncrier seamlessly with non-Python projects. (`#165 <https://github.com/hawkowl/towncrier/issues/165>`_) - Improve news fragment file name parsing to allow using file names like ``123.feature.1.ext`` which are convenient when one wants to use an appropriate extension (e.g. ``rst``, ``md``) to enable syntax highlighting. (`#173 <https://github.com/hawkowl/towncrier/issues/173>`_) - The new ``--edit`` option of the ``create`` subcommand launches an editor for entering the contents of the newsfragment. (`#275 <https://github.com/hawkowl/towncrier/issues/275>`_) - CPython 3.8 and 3.9 are now part of our automated test matrix and are officially supported. (`#291 <https://github.com/hawkowl/towncrier/issues/291>`_) - When searching for the project, first check for an existing importable instance. This helps if the version is only available in the installed version and not the source. (`#297 <https://github.com/hawkowl/towncrier/issues/297>`_) - Support building with PEP 517. (`#314 <https://github.com/hawkowl/towncrier/issues/314>`_) Bugfixes -------- - Configuration errors found during command line execution now trigger a message to stderr and no longer show a traceback. (`#84 <https://github.com/hawkowl/towncrier/issues/84>`_) - A configuration error is triggered when the newsfragment files couldn't be discovered. (`#85 <https://github.com/hawkowl/towncrier/issues/85>`_) - Invoking towncrier as `python -m towncrier` works. (`#163 <https://github.com/hawkowl/towncrier/issues/163>`_) - ``check`` subcommand defaults to UTF-8 encoding when ``sys.stdout.encoding`` is ``None``. This happens, for example, with Python 2 on GitHub Actions or when the output is piped. (`#175 <https://github.com/hawkowl/towncrier/issues/175>`_) - Specifying ``title_format`` disables default top line creation to avoid duplication. (`#180 <https://github.com/hawkowl/towncrier/issues/180>`_) Improved Documentation ---------------------- - The README now mentions the possibility to name the configuration file ``towncrier.toml`` (in addition to ``pyproject.toml``). (`#172 <https://github.com/hawkowl/towncrier/issues/172>`_) - ``start_line`` corrected to ``start_string`` in the readme to match the long standing implementation. (`#277 <https://github.com/hawkowl/towncrier/issues/277>`_) towncrier 19.9.0 (2021-03-20) ============================= No significant changes. towncrier 19.9.0rc1 (2019-09-16) ================================ Features -------- - Add ``create`` subcommand, which can be used to quickly create a news fragment command in the location defined by config. (`#4 <https://github.com/hawkowl/towncrier/issues/4>`_) - Add support for subcommands, meaning the functionality of the ``towncrier`` executable is now replaced by the ``build`` subcommand:: $ towncrier build --draft A new ``check`` subcommand is exposed. This is an alternative to calling the ``towncrier.check`` module manually:: $ towncrier check Calling ``towncrier`` without a subcommand will result in a call to the ``build`` subcommand to ensure backwards compatibility. This may be removed in a future release. (`#144 <https://github.com/hawkowl/towncrier/issues/144>`_) - Towncrier's templating now allows configuration of the version header. *CUSTOM TEMPLATE USERS PLEASE NOTE: You will need to add the version header information to your template!* (`#147 <https://github.com/hawkowl/towncrier/issues/147>`_) - towncrier now accepts the --config argument to specify a custom configuration file (`#157 <https://github.com/hawkowl/towncrier/issues/157>`_) - There is now the option for ``all_bullets = false`` in the configuration. Setting ``all_bullets`` to false means that news fragments have to include the bullet point if they should be rendered as enumerations, otherwise they are rendered directly (this means fragments can include a header.). It is necessary to set this option to avoid (incorrect) automatic indentation of multiline fragments that do not include bullet points. The ``single-file-no-bullets.rst`` template gives an example of using these options. (`#158 <https://github.com/hawkowl/towncrier/issues/158>`_) - The ``single_file`` option can now be added to the configuration file. When set to ``true``, the filename key can now be formattable with the ``name``, ``version``, and ``project_date`` format variables. This allows subsequent versions to be written out to new files instead of appended to an existing one. (`#161 <https://github.com/hawkowl/towncrier/issues/161>`_) - You can now specify Towncrier-bundled templates in your configuration file. Available templates are `default`, `hr-between-versions` (as used in attrs), and `single-file-no-bullets`. (`#162 <https://github.com/hawkowl/towncrier/issues/162>`_) Bugfixes -------- - Accept newsfragment filenames with multiple dots, like `fix-1.2.3.bugfix`. (`#142 <https://github.com/hawkowl/towncrier/issues/142>`_) Deprecations and Removals ------------------------- - The `--pyproject` option for `towncrier check` is now replaced with `--config`, for consistency with other commands. (`#162 <https://github.com/hawkowl/towncrier/issues/162>`_)

swap toml with tomli

83b968d

graingert requested review from altendky and a team July 2, 2021 22:22

graingert commented Jul 2, 2021

View reviewed changes

src/towncrier/_settings.py Outdated Show resolved Hide resolved

drop py2.7

71060f3

hukkin reviewed Jul 7, 2021

View reviewed changes

setup.py Outdated Show resolved Hide resolved

Update setup.py

43ccc05

Co-authored-by: Taneli Hukkinen <3275109+hukkin@users.noreply.github.com>

graingert added 5 commits July 7, 2021 20:19

remove 3.5 ci build

b06c863

Revert "remove 3.5 ci build"

b611ed2

This reverts commit b06c863.

Revert "Update setup.py"

462a20b

This reverts commit 43ccc05.

Revert "drop py2.7"

dbfb33e

This reverts commit 71060f3.

use toml on py3.5- and tomli on py3.6+

2e89866

graingert commented Jul 7, 2021

View reviewed changes

setup.py Outdated Show resolved Hide resolved

Update setup.py

8a661ad

graingert commented Jul 7, 2021

View reviewed changes

setup.py Outdated Show resolved Hide resolved

Update setup.py

f72c7a7

graingert commented Jul 7, 2021

View reviewed changes

src/towncrier/_settings.py Outdated Show resolved Hide resolved

graingert added 3 commits July 7, 2021 20:28

Update src/towncrier/_settings.py

4e2a76d

Update src/towncrier/_settings.py

2517818

Create 354.feature.rst

322d3eb

altendky approved these changes Jul 7, 2021

View reviewed changes

graingert merged commit 5dce0fa into master Jul 7, 2021

graingert deleted the swap-toml-with-tomli branch July 7, 2021 21:00

graingert mentioned this pull request Jul 9, 2021

consider switching from toml to tomli nedbat/coveragepy#1180

Closed

mauritsvanrees added a commit to collective/zestreleaser.towncrier that referenced this pull request Apr 19, 2022

Use tomli when on Python 3, toml on Python 2.

2eb3f75

Same as `towncrier` did until recently: twisted/towncrier#354

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

swap toml with tomli #354

swap toml with tomli #354

graingert commented Jul 2, 2021 •

edited

codecov bot commented Jul 2, 2021 •

edited

twm commented Jul 3, 2021

altendky commented Jul 7, 2021

graingert commented Jul 7, 2021

hukkin commented Jul 7, 2021

altendky commented Jul 7, 2021

graingert commented Jul 7, 2021

graingert commented Jul 7, 2021

graingert commented Jul 7, 2021

altendky left a comment

swap toml with tomli #354

swap toml with tomli #354

Conversation

graingert commented Jul 2, 2021 • edited

codecov bot commented Jul 2, 2021 • edited

Codecov Report

twm commented Jul 3, 2021

altendky commented Jul 7, 2021

graingert commented Jul 7, 2021

hukkin commented Jul 7, 2021

altendky commented Jul 7, 2021

graingert commented Jul 7, 2021

graingert commented Jul 7, 2021

graingert commented Jul 7, 2021

altendky left a comment

Choose a reason for hiding this comment

graingert commented Jul 2, 2021 •

edited

codecov bot commented Jul 2, 2021 •

edited