GoldyBot.ext.extensions

  1from __future__ import annotations
  2import GoldyBot
  3
  4MODULE_NAME = "EXTENSION"
  5
  6class Extension(object):
  7    """
  8    The base class for a Goldy Bot extension.
  9
 10    ---------------
 11    ### ***``Example:``***
 12
 13    This is how you set up an extension in a GoldyBot module. 😍
 14
 15    ```python
 16    class YourExtension(GoldyBot.Extension):
 17        def __init__(self, package_module=None):
 18            super().__init__(self, package_module_name=package_module)
 19
 20        def loader(self):
 21
 22            @GoldyBot.command()
 23            async def uwu(self:YourExtension, ctx):
 24                await ctx.send(f'Hi, {ctx.author.mention}! UwU!')
 25
 26    def load():
 27        YourExtension(package_module_name=__name__)
 28        pass
 29    ```
 30    """
 31
 32    def __init__(self, class_object, package_module_name:str=None):
 33        """Tells Goldy Bot to Load this class as an extension."""
 34        self.class_object:object = class_object
 35        self.module_name_ = package_module_name
 36        self.ignored_extensions_list = GoldyBot.config.Config(GoldyBot.files.File(GoldyBot.paths.GOLDY_CONFIG_JSON)).read("ignored_extensions")
 37        
 38        try:
 39            if not self.code_name in self.ignored_extensions_list:
 40                # Cache it.
 41                #------------
 42                try:
 43                    if self.module.is_internal_module:
 44                        GoldyBot.cache.main_cache_dict["internal_modules"][f"{self.module_name}"]["extensions"][f"{self.code_name}"] = {}
 45                        GoldyBot.cache.main_cache_dict["internal_modules"][f"{self.module_name}"]["extensions"][f"{self.code_name}"]["commands"] = []
 46                        GoldyBot.cache.main_cache_dict["internal_modules"][f"{self.module_name}"]["extensions"][f"{self.code_name}"]["object"] = self
 47                    else:
 48                        GoldyBot.cache.main_cache_dict["modules"][f"{self.module_name}"]["extensions"][f"{self.code_name}"] = {}
 49                        GoldyBot.cache.main_cache_dict["modules"][f"{self.module_name}"]["extensions"][f"{self.code_name}"]["commands"] = []
 50                        GoldyBot.cache.main_cache_dict["modules"][f"{self.module_name}"]["extensions"][f"{self.code_name}"]["object"] = self
 51                except AttributeError:
 52                    GoldyBot.logging.log("error", f"""[{MODULE_NAME}] Did you specify the module name when loading this extension. Looks like the module '{self.module_name}' did not get loaded by Goldy Bot. 
 53                    Perhaps this is a package module and you forgot to specify the module name when loading this extension.\n""")
 54                    
 55                    GoldyBot.Goldy().stop(f"I think you forgot to specify the module name when loading the '{self.code_name}' extension.")
 56
 57                GoldyBot.logging.log(f"[{self.code_name}] Loading my commands...")
 58                self.loader() # Load commands.
 59
 60            else:
 61                GoldyBot.logging.log("info", f"[{class_object.__class__.__name__}] Not loading commands as this extension is ignored.")
 62
 63        except TypeError as e:
 64            what_is_incorrect = None
 65
 66            if self.ignored_extensions_list == None: what_is_incorrect = "ignored_extensions"
 67
 68            raise GoldyBot.errors.ConfigIsIncorrect(e, what_is_incorrect)
 69
 70        # Setting all variable shortcuts.
 71        #-----------------------------------
 72        self.client:GoldyBot.nextcord.Client = GoldyBot.cache.main_cache_dict["client"]
 73        self.database:GoldyBot.database.Database = GoldyBot.cache.main_cache_dict["database"]
 74
 75        self.FindGuilds = GoldyBot.cache.FindGuilds()
 76
 77        self.msg = GoldyBot.utility.msgs
 78
 79    @property
 80    def code_name(self):
 81        return self.class_object.__class__.__name__
 82
 83    @property
 84    def module_name(self):
 85        """Returns the name of the module this extension is being called from. This is much faster than grabbing the name with ``module().name``."""
 86        if self.module_name_ == None:
 87            return self.class_object.__module__
 88        else:
 89            return self.module_name_
 90
 91    @property
 92    def module(self) -> GoldyBot.modules.Module:
 93        return GoldyBot.cache.FindModules().find_object_by_module_name(self.module_name)
 94
 95    def loader(self):
 96        """The extension's command loader. This is what Goldy Bot uses to load your commands in an extension."""
 97        pass
 98
 99    def get_object(self):
100        """Returns the actual class object of the extension."""
101        return self.class_object