Skip to content

feat: expose classmethod to build tortoise config #2162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
waketzheng merged 13 commits into from
May 1, 2026
Merged

feat: expose classmethod to build tortoise config #2162

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
23467a9
feat: add pre commit config and fix issues
waketzheng Apr 6, 2026
e656ce9
Fix mypy complaint
waketzheng Apr 6, 2026
b1e1093
feat: expose classmethod to build tortoise config
waketzheng Apr 6, 2026
1de8dfc
Merge branch 'develop' of github.com:tortoise/tortoise-orm into feat-…
waketzheng Apr 6, 2026
d7d62d5
refactor: move config file parse logic to TortoiseConfig
waketzheng Apr 9, 2026
0cf3b41
Merge branch 'develop' of github.com:tortoise/tortoise-orm into feat-…
waketzheng Apr 9, 2026
c9e905a
Merge branch 'develop' of github.com:tortoise/tortoise-orm into feat-…
waketzheng Apr 13, 2026
260de75
Use Self
waketzheng Apr 13, 2026
5f71748
refactor: reduce duplicated
waketzheng Apr 13, 2026
3b78e1e
refactor: change function names and add docs
waketzheng Apr 17, 2026
5167053
refactor: remove else
waketzheng Apr 17, 2026
cb9f3f4
refactor: reduce lines and indent
waketzheng Apr 24, 2026
9ea070b
Move import to top and use Self instead of class name for type hints
waketzheng Apr 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 38 additions & 1 deletion tortoise/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,14 @@

from collections.abc import Mapping
from dataclasses import dataclass, field
from typing import Any
from typing import TYPE_CHECKING, Any

from tortoise.exceptions import ConfigurationError

if TYPE_CHECKING:
from collections.abc import Iterable
from types import ModuleType


@dataclass(frozen=True)
class DBUrlConfig:
Expand Down Expand Up @@ -202,3 +206,36 @@ def from_dict(cls, data: Mapping[str, Any]) -> TortoiseConfig:
use_tz=data.get("use_tz"),
timezone=data.get("timezone"),
)

@classmethod
def merge_args(
Comment thread
waketzheng marked this conversation as resolved.
Outdated

@seladb seladb Apr 15, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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:
    ...

@waketzheng waketzheng Apr 17, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the suggestions. I’ve updated the naming:

  1. To keep consistent with from_dict, I’ll use from_db_url_and_modules / from_config_file.

  2. Since there’s already a parameter called config, I used resolve_args instead of generate_config to avoid confusion.

@seladb seladb Apr 23, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I like the from_* convention and it's consistent with the existing code. Maybe we can rename resolve_args to from_args? 🤔

@waketzheng waketzheng Apr 24, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Maybe we can rename resolve_args to from_args?

That is one solution. However, I strongly recommend using resolve_* instead of from_* for this function, because:

  1. resolve_* checks whether arguments conflict, whereas from_* does not.
  2. resolve indicates that this function will parse the arguments, not just load configuration from them.

@seladb seladb Apr 25, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think from_* is clearer, but we can let @abondar decide...

@waketzheng waketzheng May 5, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@seladb Cloud you review #2170

Comment thread
waketzheng marked this conversation as resolved.
Outdated
cls,
config: dict[str, Any] | TortoiseConfig | None = None,
config_file: str | None = None,
db_url: str | None = None,
modules: dict[str, Iterable[str | ModuleType]] | None = None,
) -> TortoiseConfig:
# Handle config_file: load it as config dict
if config_file is not None:
from tortoise import Tortoise
Comment thread
waketzheng marked this conversation as resolved.
Outdated

if config is not None:
raise ConfigurationError("Cannot specify both 'config' and 'config_file'")
config = Tortoise._get_config_from_config_file(config_file)

# Convert input to TortoiseConfig for typed access
typed_config: TortoiseConfig
if config is None:
from tortoise.backends.base.config_generator import generate_config

if db_url is None or modules is None:
raise ConfigurationError(
"Must provide either 'config', 'config_file', or both 'db_url' and 'modules'"
)
config_dict = generate_config(db_url, app_modules=modules)
typed_config = cls.from_dict(config_dict)
elif isinstance(config, dict):
typed_config = cls.from_dict(config)
else:
typed_config = config
return typed_config
21 changes: 1 addition & 20 deletions tortoise/context.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,26 +303,7 @@ async def init(
"""
from tortoise.apps import Apps

# Handle config_file: load it as config dict
if config_file is not None:
if config is not None:
raise ConfigurationError("Cannot specify both 'config' and 'config_file'")
config = self._get_config_from_config_file(config_file)

# Convert input to TortoiseConfig for typed access
typed_config: TortoiseConfig
if config is None:
if db_url is None or modules is None:
raise ConfigurationError(
"Must provide either 'config', 'config_file', or both 'db_url' and 'modules'"
)
config_dict = generate_config(db_url, app_modules=modules)
typed_config = TortoiseConfig.from_dict(config_dict)
elif isinstance(config, TortoiseConfig):
typed_config = config
else:
typed_config = TortoiseConfig.from_dict(config)

typed_config = TortoiseConfig.merge_args(config, config_file, db_url, modules)
config_dict = typed_config.to_dict()
connections_config = config_dict["connections"]
apps_config = config_dict["apps"]
Expand Down
Loading