mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-06 03:08:55 -05:00
5d48e6f3b1
* Basic Mongo Driver * Update docstrings * WIP motor support * Use motor * Update docs, add selective importer * Make use of selective importer * Fix docs * Fix config storage location for JSON * Add delimiters in the drivers doc section * Make async things async * Add basic config information for mongo driver * get info from basic setup into config * IT WORKS * Add dependency for RJM's PR.
108 lines
2.8 KiB
Python
108 lines
2.8 KiB
Python
import sys
|
|
from pathlib import Path
|
|
|
|
import appdirs
|
|
|
|
from .json_io import JsonIO
|
|
|
|
__all__ = ['load_basic_configuration', 'cog_data_path', 'core_data_path',
|
|
'storage_details', 'storage_type']
|
|
|
|
jsonio = None
|
|
basic_config = None
|
|
|
|
instance_name = None
|
|
|
|
basic_config_default = {
|
|
"DATA_PATH": None,
|
|
"COG_PATH_APPEND": "cogs",
|
|
"CORE_PATH_APPEND": "core"
|
|
}
|
|
|
|
config_dir = Path(appdirs.AppDirs("Red-DiscordBot").user_config_dir)
|
|
config_file = config_dir / 'config.json'
|
|
|
|
|
|
def load_basic_configuration(instance_name_: str):
|
|
global jsonio
|
|
global basic_config
|
|
global instance_name
|
|
|
|
jsonio = JsonIO(config_file)
|
|
|
|
instance_name = instance_name_
|
|
|
|
try:
|
|
config = jsonio._load_json()
|
|
basic_config = config[instance_name]
|
|
except (FileNotFoundError, KeyError):
|
|
print("You need to configure the bot instance using `redbot-setup`"
|
|
" prior to running the bot.")
|
|
sys.exit(1)
|
|
|
|
|
|
def _base_data_path() -> Path:
|
|
if basic_config is None:
|
|
raise RuntimeError("You must load the basic config before you"
|
|
" can get the base data path.")
|
|
path = basic_config['DATA_PATH']
|
|
return Path(path).resolve()
|
|
|
|
|
|
def cog_data_path(cog_instance=None) -> Path:
|
|
"""
|
|
Gets the base cog data path. If you want to get the folder with
|
|
which to store your own cog's data please pass in an instance
|
|
of your cog class.
|
|
:param cog_instance:
|
|
:return:
|
|
"""
|
|
try:
|
|
base_data_path = Path(_base_data_path())
|
|
except RuntimeError as e:
|
|
raise RuntimeError("You must load the basic config before you"
|
|
" can get the cog data path.") from e
|
|
cog_path = base_data_path / basic_config['COG_PATH_APPEND']
|
|
if cog_instance:
|
|
cog_path = cog_path / cog_instance.__class__.__name__
|
|
cog_path.mkdir(exist_ok=True, parents=True)
|
|
|
|
return cog_path.resolve()
|
|
|
|
|
|
def core_data_path() -> Path:
|
|
try:
|
|
base_data_path = Path(_base_data_path())
|
|
except RuntimeError as e:
|
|
raise RuntimeError("You must load the basic config before you"
|
|
" can get the core data path.") from e
|
|
core_path = base_data_path / basic_config['CORE_PATH_APPEND']
|
|
core_path.mkdir(exist_ok=True, parents=True)
|
|
|
|
return core_path.resolve()
|
|
|
|
|
|
def storage_type() -> str:
|
|
"""
|
|
Gets the storage type as a string.
|
|
|
|
:return:
|
|
"""
|
|
try:
|
|
return basic_config['STORAGE_TYPE']
|
|
except KeyError as e:
|
|
raise RuntimeError('Bot basic config has not been loaded yet.') from e
|
|
|
|
|
|
def storage_details() -> dict:
|
|
"""
|
|
Gets any details necessary for config drivers to load.
|
|
|
|
These are set on setup.
|
|
:return:
|
|
"""
|
|
try:
|
|
return basic_config['STORAGE_DETAILS']
|
|
except KeyError as e:
|
|
raise RuntimeError('Bot basic config has not been loaded yet.') from e
|