feat: expose classmethod to build tortoise config by waketzheng · Pull Request #2162 · tortoise/tortoise-orm

waketzheng · 2026-03-31T11:54:18Z

Description

The init function of tortoise.context.Context is too long
Add a new classmethod to TortoiseConfig which is used for sharing config between contexts

Motivation and Context

Base on #2159

This function has too many lines; shorten it.

How Has This Been Tested?

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have added the changelog accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests passed.

codspeed-hq · 2026-03-31T11:57:05Z

Merging this PR will not alter performance

✅ 24 untouched benchmarks

_{Comparing waketzheng:feat-typed-config (5f71748) with develop (b35f0f2)}

seladb · 2026-04-05T06:51:58Z

@waketzheng this PR has many changes that are not related to the PR title and description. Maybe you should break them into multiple PRs?

seladb · 2026-04-05T20:15:19Z

@waketzheng this PR still seems to have unrelated changes. We have this PR to add pre-commit, and this PR for Starlette v1 support. These changes can probably be removed from this PR

waketzheng · 2026-04-06T06:51:32Z

@waketzheng this PR still seems to have unrelated changes. We have this PR to add pre-commit, and this PR for Starlette v1 support. These changes can probably be removed from this PR

@seladb No need to do that. I expected this PR to be reviewed after the previous one merged, so I explicitly mentioned that it’s based on #2159. Actually, I refactored the code once when fixing mypy complaints after Starlette upgraded, and then separated it into three PRs.

seladb · 2026-04-06T07:07:16Z

@waketzheng this PR still seems to have unrelated changes. We have this PR to add pre-commit, and this PR for Starlette v1 support. These changes can probably be removed from this PR

@seladb No need to do that. I expected this PR to be reviewed after the previous one merged, so I explicitly mentioned that it’s based on #2159. Actually, I refactored the code once when fixing mypy complaints after Starlette upgraded, and then separated it into three PRs.

@waketzheng is there a reason to open these changes as stacked PRs? It looks like these are separate changes that can each have their own PR based on develop 🤔

waketzheng · 2026-04-06T07:27:50Z

Using stacked PRs avoids merge conflicts
I can prek run --all-files to check this PR (prek is a reimagined version of pre-commit, built in Rust.)
You can select the latest commit (instead of all commits) to compare the code between this PR and the previous one.

seladb · 2026-04-06T07:36:55Z

Using stacked PRs avoids merge conflicts

Yes, if the changes in the stacked PRs depend on each other, otherwise there shouldn't be merge conflicts. Here it looks like the actual commit related to this PR doesn't depend on the changes in the other PR. What am I missing here? 🤔

…typed-config

waketzheng · 2026-04-06T13:34:16Z

Yes, if the changes in the stacked PRs depend on each other, otherwise there shouldn't be merge conflicts. Here it looks like the actual commit related to this PR doesn't depend on the changes in the other PR. What am I missing here? 🤔

You forgot that I need the pre-commit config to enforce code style.

seladb · 2026-04-07T05:21:20Z

You forgot that I need the pre-commit config to enforce code style.

I'm not sure why pre-commit is needed for this PR, but anyway - the pre-commit PR was merged so this PR is simpler now 🙂

…typed-config

seladb

Please see one comment, otherwise LGTM

seladb · 2026-04-12T07:17:01Z

+            return cls.from_dict(config_dict)
+
+    @classmethod
+    def _get_config_from_config_file(cls, config_file: str) -> TortoiseConfig:


Maybe we can make it a public method instead of private/protected?

Maybe we can make it a public method instead of private/protected?

If it to be a public method, should generating config from db_url/modules also be public? For example:

230 else: 231 return cls.generate_config(db_url, modules) 232 233 @classmethod 234 def generate_config( 235 cls, db_url: str, modules: dict[str, Iterable[str | ModuleType]] 236 ) -> TortoiseConfig: 237 from tortoise.backends.base.config_generator import generate_config 238 239 config_dict = generate_config(db_url, app_modules=modules) 240 return cls.from_dict(config_dict) 241 242 @classmethod 243 def get_config_from_config_file(cls, config_file: str) -> TortoiseConfig:

I guess we can add it...

…typed-config

seladb · 2026-04-15T06:44:40Z

+
+    @classmethod
+    def generate_config(cls, db_url: str, modules: dict[str, Iterable[str | ModuleType]]) -> Self:
+        from tortoise.backends.base.config_generator import generate_config


Is there a reason not to move this import to the top of the file? 🤔

seladb · 2026-04-15T06:50:38Z

        )
+
+    @classmethod
+    def merge_args(


I'm not sure the method name is clear, merge_args seems to create a merged configuration from config, config_file, db_url and modules, but this is actually not the case.

Maybe generate_config could be a better name.

Moreover, maybe we need to normalize the classmethods in this class:

@classmethod def generate_config( cls, config: dict[str, Any] | Self | None = None, config_file: str | None = None, db_url: str | None = None, modules: dict[str, Iterable[str | ModuleType]] | None = None, ) -> Self: ... @classmethod def generate_config_from_db_url_and_modules(cls, db_url: str, modules: dict[str, Iterable[str | ModuleType]]) -> Self: ... @classmethod def generate_config_from_config_file(cls, config_file: str) -> Self: ...

seladb · 2026-04-15T06:51:11Z

        )
+
+    @classmethod
+    def merge_args(


Also - since there are public methods, can we add docstrings to each one?

seladb · 2026-04-15T06:54:58Z

+        if not config_value:
+            raise utils.CLIUsageError(
+                "You must specify TORTOISE_ORM in option or env, or pyproject.toml [tool.tortoise]",
+            )


We can do something like this:

config_value = config_value or utils.tortoise_orm_config() if not config_value: raise utils.CLIUsageError( "You must specify TORTOISE_ORM in option or env, or pyproject.toml [tool.tortoise]", ) return utils.get_tortoise_config(config_value)

abondar previously approved these changes Apr 5, 2026

View reviewed changes

waketzheng dismissed abondar’s stale review via 41be834 April 5, 2026 18:48

waketzheng requested a review from abondar April 5, 2026 19:13

waketzheng added 2 commits April 6, 2026 14:55

feat: add pre commit config and fix issues

23467a9

Fix mypy complaint

e656ce9

feat: expose classmethod to build tortoise config

b1e1093

waketzheng force-pushed the feat-typed-config branch from 7e95e57 to b1e1093 Compare April 6, 2026 07:16

Merge branch 'develop' of github.com:tortoise/tortoise-orm into feat-…

1de8dfc

…typed-config

seladb reviewed Apr 7, 2026

View reviewed changes

Comment thread tortoise/config.py

Comment thread tortoise/config.py Outdated

waketzheng added 2 commits April 10, 2026 00:46

refactor: move config file parse logic to TortoiseConfig

d7d62d5

Merge branch 'develop' of github.com:tortoise/tortoise-orm into feat-…

0cf3b41

…typed-config

waketzheng requested a review from seladb April 9, 2026 17:09

seladb approved these changes Apr 12, 2026

View reviewed changes

waketzheng added 3 commits April 13, 2026 21:12

Merge branch 'develop' of github.com:tortoise/tortoise-orm into feat-…

c9e905a

…typed-config

Use Self

260de75

refactor: reduce duplicated

5f71748

waketzheng requested a review from seladb April 14, 2026 17:18

seladb reviewed Apr 15, 2026

View reviewed changes

Conversation

waketzheng commented Mar 31, 2026

Description

Motivation and Context

How Has This Been Tested?

Checklist:

Uh oh!

codspeed-hq bot commented Mar 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merging this PR will not alter performance

Uh oh!

seladb commented Apr 5, 2026

Uh oh!

seladb commented Apr 5, 2026

Uh oh!

waketzheng commented Apr 6, 2026

Uh oh!

seladb commented Apr 6, 2026

Uh oh!

waketzheng commented Apr 6, 2026

Uh oh!

seladb commented Apr 6, 2026

Uh oh!

waketzheng commented Apr 6, 2026

Uh oh!

seladb commented Apr 7, 2026

Uh oh!

Uh oh!

Uh oh!

seladb left a comment

Choose a reason for hiding this comment

Uh oh!

seladb Apr 12, 2026

Choose a reason for hiding this comment

Uh oh!

waketzheng Apr 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

seladb Apr 14, 2026

Choose a reason for hiding this comment

Uh oh!

seladb Apr 15, 2026

Choose a reason for hiding this comment

Uh oh!

seladb Apr 15, 2026

Choose a reason for hiding this comment

Uh oh!

seladb Apr 15, 2026

Choose a reason for hiding this comment

Uh oh!

seladb Apr 15, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codspeed-hq bot commented Mar 31, 2026 •

edited

Loading

waketzheng Apr 13, 2026 •

edited

Loading