Skip to content

chore(tox): migrate configuration from INI to TOML - #2754

Open
naqiyaa wants to merge 2 commits into
falconry:masterfrom
naqiyaa:migrate-tox-toml
Open

naqiyaa wants to merge 2 commits into
falconry:masterfrom
naqiyaa:migrate-tox-toml

Conversation

@naqiyaa

@naqiyaa naqiyaa commented Oct 2, 2026

Copy link
Copy Markdown

Summary of Changes

  • Migrated tox configuration from INI format to native TOML format.

Related Issues

Closes #2750

Pull Request Checklist

  • Applied changes to both WSGI and ASGI code paths and interfaces (where applicable).
  • Added tests for changed code.
  • Performed automated tests and code quality checks by running tox.
  • [ x] Prefixed code comments with GitHub nick and an appropriate prefix.
  • Coding style is consistent with the rest of the framework.
  • Updated documentation for changed code.
    • Added docstrings for any new classes, functions, or modules.
    • Updated docstrings for any modifications to existing code.
    • Updated both WSGI and ASGI docs (where applicable).
    • Added references to new classes, functions, or modules to the relevant RST file under docs/.
    • Updated all relevant supporting documentation files under docs/.
    • A copyright notice is included at the top of any new modules (using your own name or the name of your organization).
    • Changed/added classes/methods/functions have appropriate version directives.
  • Changes have towncrier news fragments under docs/_newsfragments/.
  • LLM output, if any, has been carefully reviewed and tested by a human developer.

@codecov

codecov Bot commented Oct 2, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (0fd2cbe) to head (196e7a7).

Additional details and impacted files
@@            Coverage Diff            @@
##            master     #2754   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           64        64           
  Lines         8099      8099           
  Branches      1131      1131           
=========================================
  Hits          8099      8099           

☔ View full report in Codecov by Harness.
📢 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.

@vytas7 vytas7 left a comment •

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this PR @naqiyaa!
Everything passes, as evidenced by CI, so great job from that perspective! 👍

However, before merging, I would like the tox.toml file to become more legible for the reader as well:

  • Please restore all the comments from tox.ini (unless they where specific to the INI format). TOML supports comments just fine in the same way as INI.
  • Please indent the file so that it is easier to read both the text itself, and future diffs. If in doubt, just use a similar structure of line breaks as it was before, i.e., if commands were listed on separate lines, keep that distinction.

@naqiyaa

naqiyaa commented Oct 2, 2026

Copy link
Copy Markdown
Author

Thanks for this PR @naqiyaa! Everything passes, as evidenced by CI, so great job from that perspective! 👍

However, before merging, I would like the tox.toml file to become more legible for the reader as well:

  • Please restore all the comments from tox.ini (unless they where specific to the INI format). TOML supports comments just fine in the same way as INI.
  • Please indent the file so that it is easier to read both the text itself, and future diffs. If in doubt, just use a similar structure of line breaks as it was before, i.e., if commands were listed on separate lines, keep that distinction.

@naqiyaa

naqiyaa commented Oct 2, 2026

Copy link
Copy Markdown
Author

Thanks for the review! I've updated tox.toml to restore the comments from the original configuration and improve the formatting and readability of commands while preserving the TOML structure. I've pushed the changes to the PR. Please take another look when you get a chance!

@vytas7

vytas7 commented Oct 2, 2026

Copy link
Copy Markdown
Member

Thanks for the prompt update @naqiyaa!
It seems though, that you have actually forgot to push the change, I see no new commits.

@vytas7 vytas7 changed the title Migrate tox configuration from INI to TOML chore(tox): migrate configuration from INI to TOML Oct 2, 2026
@naqiyaa

naqiyaa commented Oct 2, 2026

Copy link
Copy Markdown
Author

Thanks for pointing that out! I've now committed and pushed the changes to the existing PR. The latest commit should be visible on GitHub. Please take another look when you get a chance!

@vytas7 vytas7 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems consistency with tox.ini can still be improved.

Comment thread tox.toml
]

[env_run_base]
set_env = { PIP_CONFIG_FILE = "pip.conf", PYTHONASYNCIODEBUG = "1", FALCON_DISABLE_CYTHON = "Y" }

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All these set_envs are still single lines, however multiple in tox.ini. Let's make them consistent.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Migrate tox config from INI format to TOML format

2 participants