Skip to content

✨ Add Settings __repr__ #2874

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.

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
merged 15 commits into from
Jul 4, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
32 changes: 31 additions & 1 deletion lamindb/core/_settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
from typing import TYPE_CHECKING

import lamindb_setup as ln_setup
from lamin_utils import logger
from lamin_utils import colors, logger
from lamindb_setup._set_managed_storage import set_managed_storage
from lamindb_setup.core._settings import settings as setup_settings
from lamindb_setup.core._settings_instance import sanitize_git_repo_url
Expand Down Expand Up @@ -43,6 +43,36 @@ def __init__(self):
logger.set_verbosity(self._verbosity_int)
self._sync_git_repo: str | None = None

def __repr__(self) -> str: # pragma: no cover
cls_name = colors.green(self.__class__.__name__)
verbosity_color = colors.yellow if self.verbosity == "warning" else colors.green
verbosity_str = verbosity_color(self.verbosity)

storage_root = self._storage_settings.root_as_str
storage_str = colors.italic(storage_root)

instance_str = colors.italic(self.instance_uid)
track_color = colors.green if self.track_run_inputs else colors.yellow
track_str = track_color(str(self.track_run_inputs))

lines = [
f"{cls_name}",
f" instance: {instance_str}",
f" storage: {storage_str}",
f" verbosity: {verbosity_str}",
f" track_run_inputs: {track_str}",
]

if self.sync_git_repo:
repo_name = (
self.sync_git_repo.split("/")[-1]
if "/" in self.sync_git_repo
else self.sync_git_repo
)
lines.append(f" sync_git_repo: {colors.italic(repo_name)}")

return "\n".join(lines)

@property
def creation(self) -> CreationSettings:
"""SQLRecord creation settings.
Expand Down
14 changes: 14 additions & 0 deletions tests/core/test_settings.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import lamindb as ln


def test_settings_repr():
repr_str = repr(ln.settings)

lines = repr_str.split("\n")
assert "Settings" in lines[0]
assert all(line.startswith(" ") for line in lines[1:])

content = "\n".join(lines[1:])
assert content.find("instance:") < content.find("storage:")
assert content.find("storage:") < content.find("verbosity:")
assert content.find("verbosity:") < content.find("track_run_inputs:")
Loading