view sat/memory/sqla_config.py @ 4037:524856bd7b19

massive refactoring to switch from camelCase to snake_case: historically, Libervia (SàT before) was using camelCase as allowed by PEP8 when using a pre-PEP8 code, to use the same coding style as in Twisted. However, snake_case is more readable and it's better to follow PEP8 best practices, so it has been decided to move on full snake_case. Because Libervia has a huge codebase, this ended with a ugly mix of camelCase and snake_case. To fix that, this patch does a big refactoring by renaming every function and method (including bridge) that are not coming from Twisted or Wokkel, to use fully snake_case. This is a massive change, and may result in some bugs.
author Goffi <goffi@goffi.org>
date Sat, 08 Apr 2023 13:54:42 +0200
parents 4edfd7521418
children
line wrap: on
line source

#!/usr/bin/env python3

# Libervia: an XMPP client
# Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org)

# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.

# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.

# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

from pathlib import Path
from urllib.parse import quote
from sat.core.constants import Const as C
from sat.tools import config


def get_db_config() -> dict:
    """Get configuration for database

    @return: dict with following keys:
        - type: only "sqlite" for now
        - path: path to the sqlite DB
    """
    main_conf = config.parse_main_conf()
    local_dir = Path(config.config_get(main_conf, "", "local_dir"))
    database_path = (local_dir / C.SAVEFILE_DATABASE).expanduser()
    url = f"sqlite+aiosqlite:///{quote(str(database_path))}?timeout=30"
    return {
        "type": "sqlite",
        "path": database_path,
        "url": url,
    }