CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-11-06 03:08:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

Prefer force_registration=true in Config documentation (#6259)

Browse Source 
Co-authored-by: Michael Oliveira <34169552+Flame442@users.noreply.github.com>
This commit is contained in:
Jakub Kuczys 2023-11-06 23:06:36 +01:00 committed by GitHub
parent eb3267e332
commit 8997bf6002
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 17 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/framework_config.rst
View File

@ -25,7 +25,7 @@ Basic Usage
class MyCog(commands.Cog): class MyCog(commands.Cog):
def __init__(self): def __init__(self):
self.config = Config.get_conf(self, identifier=1234567890) self.config = Config.get_conf(self, identifier=1234567890, force_registration=True)
self.config.register_global( self.config.register_global(
foo=True foo=True
@ -55,15 +55,19 @@ Then, in the class's :code:`__init__` function, you need to get a config instanc
class MyCog(commands.Cog): class MyCog(commands.Cog):
def __init__(self): def __init__(self):
self.config = Config.get_conf(self, identifier=1234567890) self.config = Config.get_conf(self, identifier=1234567890, force_registration=True)
The ``identifier`` in :py:meth:`Config.get_conf` is used to keep your cog's data separate The ``identifier`` in :py:meth:`Config.get_conf` is used to keep your cog's data separate
from that of another cog, and thus should be unique to your cog. For example: if we from that of another cog, and thus should be unique to your cog. For example: if we
have two cogs named :code:`MyCog` and their identifier is different, each will have have two cogs named :code:`MyCog` and their identifier is different, each will have
its own data without overwriting the other's data. Note that it is also possible its own data without overwriting the other's data.
to force registration of a data key before allowing you to get and set data for
that key by adding :code:`force_registration=True` after identifier (that defaults Note that, as shown by most of the examples in this document, it is also possible to
to :code:`False` though) force registration of a data key before allowing you to get and set data for that key
by adding :code:`force_registration=True` after identifier.
When this is set to :code:`False` (the default), the default value for any key that isn't registered
will be :code:`None`. When this is set to :code:`True` (as shown in this document), attempting
to read from or write to any key that isn't registered will raise an :exc:`AttributeError`.
After we've gotten that, we need to register default values: After we've gotten that, we need to register default values:
@ -71,7 +75,7 @@ After we've gotten that, we need to register default values:
class MyCog(commands.Cog): class MyCog(commands.Cog):
def __init__(self): def __init__(self):
self.config = Config.get_conf(self, identifier=1234567890) self.config = Config.get_conf(self, identifier=1234567890, force_registration=True)
default_global = { default_global = {
"foobar": True, "foobar": True,
"foo": { "foo": {
@ -213,7 +217,7 @@ Tutorial example.
class MyCog(commands.Cog): class MyCog(commands.Cog):
def __init__(self): def __init__(self):
self.config = Config.get_conf(self, identifier=1234567890) self.config = Config.get_conf(self, identifier=1234567890, force_registration=True)
default_guild = { default_guild = {
"blah": [], "blah": [],
"baz": 1234567890 "baz": 1234567890
@ -264,7 +268,7 @@ Now let's see an example that uses multiple identifiers:
class ChannelAccess(commands.Cog): class ChannelAccess(commands.Cog):
def __init__(self): def __init__(self):
self.config = Config.get_conf(self, identifier=1234567890) self.config = Config.get_conf(self, identifier=1234567890, force_registration=True)
default_access = { default_access = {
"allowed": False "allowed": False
} }
@ -304,7 +308,7 @@ the built-in Economy credits::
class Pets(commands.Cog): class Pets(commands.Cog):
def __init__(self): def __init__(self):
self.config = Config.get_conf(self, 1234567890) self.config = Config.get_conf(self, 1234567890, force_registration=True)
# Here we'll assign some default costs for the pets # Here we'll assign some default costs for the pets
self.config.register_global( self.config.register_global(
@ -509,7 +513,7 @@ API Reference
includes keys within a `dict` when one is being set, as well as keys in nested dictionaries includes keys within a `dict` when one is being set, as well as keys in nested dictionaries
within that `dict`. For example:: within that `dict`. For example::
>>> config = Config.get_conf(self, identifier=999) >>> config = Config.get_conf(self, identifier=999, force_registration=True)
>>> config.register_global(foo={}) >>> config.register_global(foo={})
>>> await config.foo.set_raw(123, value=True) >>> await config.foo.set_raw(123, value=True)
>>> await config.foo() >>> await config.foo()

4
redbot/core/config.py
View File

@ -622,8 +622,8 @@ class Config(metaclass=ConfigMeta):
Unique identifier provided to differentiate cog data when name Unique identifier provided to differentiate cog data when name
conflicts occur. conflicts occur.
force_registration : `bool` force_registration : `bool`
Determines if Config should throw an error if a cog attempts to access Determines whether `Config` should throw an error (`AttributeError`)
an attribute which has not been previously registered. when attempting to access an attribute which has not been previously registered.
Note Note
---- ----