feat: migrate from tomlkit to tomlrt

[dimbleby]

I have always found tomlkit a bit disagreeable to work with:

• the type annotations are unusable
• the API is fiddly
• it has been buggy, eg around line endings and out-of-order tables
• the parser is very slow
• possibly more that I have forgotten...

So I got to wondering how hard it could be in the AI age to (have the bots) come up with something that I liked better.

The result is tomlrt, and this pull request shows what it would look like to move poetry to using it.

The good news is:

• the type annotations worked out fine, this pull request cleans out lots of type-checker workarounds
• the API is simpler:
  • tomlrt tries hard to Do The Right Thing rather than exposing explicit nl() and is_super_table and suchlike
  • and I have included a handful of helpers for navigating nested tables that simplify some calling code
• so far as I know the code is bug-free
  • but "so far as I know" is doing all of the lifting there! it is easy to have no bug reports when you have no users
  • using tomlrt fixes poetry version throws error Key "source" already exists. when sources are not in order in toml-file #10144, for what its worth
• the parser is a lot faster

Per the diff, tomlrt prefers to format inline tables with spaces around the curly braces. AFAIK tomlkit is the odd one out among toml tooling in not doing this, but there would be a one-time round of noise in lock files.

For all of the faults of tomlkit: at this point poetry has mostly flushed out most of the bugs that users care about - and that is a pretty good argument for not changing anything. So even I am far from 100% convinced that this pull request is a good idea.

But I figured I should show it to you and let you consider it for yourselves.

[sourcery-ai]

Hey - I've left some high level feedback:

• In tests/helpers.py, the new toml_dumps_dict helper calls tomlrt.Document at runtime but tomlrt is only imported in TYPE_CHECKING, so you should add a real import of tomlrt at the top of the file to avoid NameError.
• Several tests now instantiate tomlrt.Document directly (e.g. tests/utils/env/test_env_manager.py, tests/console/commands/env/test_list.py, tests/console/commands/env/test_use.py), but still import tomlkit; update these modules to import tomlrt instead so the new Document calls resolve correctly.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- In tests/helpers.py, the new toml_dumps_dict helper calls tomlrt.Document at runtime but tomlrt is only imported in TYPE_CHECKING, so you should add a real import of tomlrt at the top of the file to avoid NameError.
- Several tests now instantiate tomlrt.Document directly (e.g. tests/utils/env/test_env_manager.py, tests/console/commands/env/test_list.py, tests/console/commands/env/test_use.py), but still import tomlkit; update these modules to import tomlrt instead so the new Document calls resolve correctly.

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}