mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-06 03:08:55 -05:00
29ce2401ca
* Add the identifier as an initialization parameter * Remove config object singleton and opt for a shared JSON datastore * Fix bot unloading to deal with memory leaks * Fix tests * Fix clear all bug
120 lines
3.2 KiB
Python
120 lines
3.2 KiB
Python
from pathlib import Path
|
|
from typing import Tuple
|
|
import weakref
|
|
import logging
|
|
|
|
from ..json_io import JsonIO
|
|
|
|
from .red_base import BaseDriver
|
|
|
|
__all__ = ["JSON"]
|
|
|
|
|
|
_shared_datastore = {}
|
|
_driver_counts = {}
|
|
_finalizers = []
|
|
|
|
log = logging.getLogger("redbot.json_driver")
|
|
|
|
|
|
def finalize_driver(cog_name):
|
|
if cog_name not in _driver_counts:
|
|
return
|
|
|
|
_driver_counts[cog_name] -= 1
|
|
|
|
if _driver_counts[cog_name] == 0:
|
|
if cog_name in _shared_datastore:
|
|
del _shared_datastore[cog_name]
|
|
|
|
for f in _finalizers:
|
|
if not f.alive:
|
|
_finalizers.remove(f)
|
|
|
|
|
|
class JSON(BaseDriver):
|
|
"""
|
|
Subclass of :py:class:`.red_base.BaseDriver`.
|
|
|
|
.. py:attribute:: file_name
|
|
|
|
The name of the file in which to store JSON data.
|
|
|
|
.. py:attribute:: data_path
|
|
|
|
The path in which to store the file indicated by :py:attr:`file_name`.
|
|
"""
|
|
def __init__(self, cog_name, identifier, *, data_path_override: Path=None,
|
|
file_name_override: str="settings.json"):
|
|
super().__init__(cog_name, identifier)
|
|
self.file_name = file_name_override
|
|
if data_path_override:
|
|
self.data_path = data_path_override
|
|
else:
|
|
self.data_path = Path.cwd() / 'cogs' / '.data' / self.cog_name
|
|
|
|
self.data_path.mkdir(parents=True, exist_ok=True)
|
|
|
|
self.data_path = self.data_path / self.file_name
|
|
|
|
self.jsonIO = JsonIO(self.data_path)
|
|
|
|
self._load_data()
|
|
|
|
@property
|
|
def data(self):
|
|
return _shared_datastore.get(self.cog_name)
|
|
|
|
@data.setter
|
|
def data(self, value):
|
|
_shared_datastore[self.cog_name] = value
|
|
|
|
def _load_data(self):
|
|
if self.cog_name not in _driver_counts:
|
|
_driver_counts[self.cog_name] = 0
|
|
_driver_counts[self.cog_name] += 1
|
|
|
|
_finalizers.append(weakref.finalize(self, finalize_driver, self.cog_name))
|
|
|
|
if self.data is not None:
|
|
return
|
|
|
|
try:
|
|
self.data = self.jsonIO._load_json()
|
|
except FileNotFoundError:
|
|
self.data = {}
|
|
self.jsonIO._save_json(self.data)
|
|
|
|
async def get(self, *identifiers: Tuple[str]):
|
|
partial = self.data
|
|
full_identifiers = (self.unique_cog_identifier, *identifiers)
|
|
for i in full_identifiers:
|
|
partial = partial[i]
|
|
return partial
|
|
|
|
async def set(self, *identifiers: str, value=None):
|
|
partial = self.data
|
|
full_identifiers = (self.unique_cog_identifier, *identifiers)
|
|
for i in full_identifiers[:-1]:
|
|
if i not in partial:
|
|
partial[i] = {}
|
|
partial = partial[i]
|
|
|
|
partial[full_identifiers[-1]] = value
|
|
await self.jsonIO._threadsafe_save_json(self.data)
|
|
|
|
async def clear(self, *identifiers: str):
|
|
partial = self.data
|
|
full_identifiers = (self.unique_cog_identifier, *identifiers)
|
|
try:
|
|
for i in full_identifiers[:-1]:
|
|
partial = partial[i]
|
|
del partial[full_identifiers[-1]]
|
|
except KeyError:
|
|
pass
|
|
else:
|
|
await self.jsonIO._threadsafe_save_json(self.data)
|
|
|
|
def get_config_details(self):
|
|
return
|