New option 'index'

[tirolerstefan]

Towncried currently adds an index if a snippet already exists, e.g. issue-1234.feat.md is available, so issue-1234.feat.1.md is created.

We have a graphical tool for changelog snippet creation and wanted to directly access the indexed snippets - so an overwrite is possible.

With this change, a new option "--index" is added.

e.g.

towncrier create --dir .../changelogs/preliminary --config .../config/changelogs/towncrier.toml --section BLA --content "test3<br/>
    another snippet" --index 8 ISSUE-1000.feat.md
Created news fragment at .../changelogs/preliminary/BLA/ISSUE-1000.feat.8.md

If index == 0, the filename without index is accessed.
If inxed > 0, the index is added to the filename.

If option "index" is not passed, the tool behaves as before - the next index is chosen.

[adiroiban]

Thanks for the report.
As long as backward compatiblity is preserved, we can add extra options.

[tirolerstefan]

Hi @adiroiban , thanks a lot for the feedback. I tested it and added auto tests to the PR.
But it's bloody complicated to get the pre-commit checks done (black / isort).

$ pre-commit run --all-files 
black....................................................................Passed
pyupgrade................................................................Passed
isort....................................................................Passed
flake8...................................................................Passed
trim trailing whitespace.................................................Passed
fix end of files.........................................................Passed
debug statements (python)................................................Passed
check toml...............................................................Passed
check yaml...............................................................Passed
towncrier-check..........................................................Passed

$ pre-commit autoupdate
[https://github.com/psf/black-pre-commit-mirror] updating 25.12.0 -> 26.5.1
[https://github.com/asottile/pyupgrade] already up to date!
[https://github.com/PyCQA/isort] updating 7.0.0 -> 9.0.0a3
[https://github.com/PyCQA/flake8] already up to date!
[https://github.com/pre-commit/pre-commit-hooks] already up to date!
[https://github.com/twisted/towncrier] already up to date!

$ pre-commit run --all-files 
black....................................................................Failed
- hook id: black
- files were modified by this hook

Warning: Python 3.12 cannot parse code formatted for Python 3.15. To fix this: run Black with Python 3.15, set --target-version to py312, or use --fast to skip the safety check. Black's safety check verifies equivalence by parsing the AST, which fails when the running Python is older than the target version.
reformatted src/towncrier/__main__.py
reformatted bin/towncrier
reformatted src/towncrier/_settings/__init__.py
reformatted admin/check_tag_version_match.py
reformatted docs/conf.py
reformatted src/towncrier/_writer.py
reformatted noxfile.py
reformatted src/towncrier/test/test_hg.py
reformatted src/towncrier/click_default_group.py
reformatted src/towncrier/test/test_builder.py
reformatted src/towncrier/test/test_project.py
reformatted src/towncrier/build.py
reformatted src/towncrier/_settings/load.py
reformatted src/towncrier/create.py
reformatted src/towncrier/test/test_settings.py
reformatted src/towncrier/test/test_write.py
reformatted src/towncrier/test/test_create.py
reformatted src/towncrier/test/test_build.py

All done! ✨ 🍰 ✨
18 files reformatted, 17 files left unchanged.

pyupgrade................................................................Passed
isort....................................................................Failed
- hook id: isort
- files were modified by this hook

Fixing /home/stfe/prog/tools/towncrier/admin/check_tag_version_match.py
Fixing /home/stfe/prog/tools/towncrier/bin/towncrier
Fixing /home/stfe/prog/tools/towncrier/docs/conf.py
Fixing /home/stfe/prog/tools/towncrier/noxfile.py
Fixing /home/stfe/prog/tools/towncrier/src/towncrier/__main__.py
Fixing /home/stfe/prog/tools/towncrier/src/towncrier/_settings/__init__.py
Fixing /home/stfe/prog/tools/towncrier/src/towncrier/_settings/load.py
Fixing /home/stfe/prog/tools/towncrier/src/towncrier/_writer.py
Fixing /home/stfe/prog/tools/towncrier/src/towncrier/build.py
Fixing /home/stfe/prog/tools/towncrier/src/towncrier/click_default_group.py
Fixing /home/stfe/prog/tools/towncrier/src/towncrier/create.py
Fixing /home/stfe/prog/tools/towncrier/src/towncrier/test/test_hg.py
Fixing /home/stfe/prog/tools/towncrier/src/towncrier/test/test_project.py

flake8...................................................................Passed
trim trailing whitespace.................................................Passed
fix end of files.........................................................Passed
debug statements (python)................................................Passed
check toml...............................................................Passed
check yaml...............................................................Passed
towncrier-check..........................................................Passed

$ git s
On branch create_using_index_#714
Your branch is up to date with 'origin/create_using_index_#714'.

Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
	modified:   .pre-commit-config.yaml
	modified:   src/towncrier/test/test_build.py
	modified:   src/towncrier/test/test_builder.py
	modified:   src/towncrier/test/test_create.py
	modified:   src/towncrier/test/test_project.py
	modified:   src/towncrier/test/test_settings.py
	modified:   src/towncrier/test/test_write.py

no changes added to commit (use "git add" and/or "git commit -a")

$ git add -u

$ git commit -m "reformatted after running black / isort"
black....................................................................Failed
- hook id: black
- files were modified by this hook

Warning: Python 3.12 cannot parse code formatted for Python 3.15. To fix this: run Black with Python 3.15, set --target-version to py312, or use --fast to skip the safety check. Black's safety check verifies equivalence by parsing the AST, which fails when the running Python is older than the target version.
reformatted src/towncrier/test/test_project.py

All done! ✨ 🍰 ✨
1 file reformatted, 5 files left unchanged.

pyupgrade................................................................Passed
isort....................................................................Failed
- hook id: isort
- files were modified by this hook

Fixing /home/stfe/prog/tools/towncrier/src/towncrier/test/test_project.py

flake8...................................................................Passed
trim trailing whitespace.................................................Passed
fix end of files.........................................................Passed
debug statements (python)................................................Passed
check toml...........................................(no files to check)Skipped
check yaml...............................................................Passed
towncrier-check......................................(no files to check)Skipped

$ git s
On branch create_using_index_#714
Your branch is up to date with 'origin/create_using_index_#714'.

Changes to be committed:
  (use "git restore --staged <file>..." to unstage)
	modified:   .pre-commit-config.yaml
	modified:   src/towncrier/test/test_build.py
	modified:   src/towncrier/test/test_builder.py
	modified:   src/towncrier/test/test_create.py
	modified:   src/towncrier/test/test_project.py
	modified:   src/towncrier/test/test_settings.py
	modified:   src/towncrier/test/test_write.py

How can I commit this? Thanks!