CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-11-21 18:27:59 -05:00
Code Issues Packages Projects Releases Wiki Activity

Normalize names of attributes with Config instances (#3765)

Browse Source 
* Lets normalize how we name config attributes across the bot.

Signed-off-by: Drapersniper <27962761+drapersniper@users.noreply.github.com>

* ....

Signed-off-by: Drapersniper <27962761+drapersniper@users.noreply.github.com>

* nothing to see here

Signed-off-by: Drapersniper <27962761+drapersniper@users.noreply.github.com>
This commit is contained in:
Draper
2020-04-20 18:12:57 +01:00
committed by GitHub
parent df7ca65108
commit e4018ec677
22 changed files with 328 additions and 325 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
redbot/core/config.py
View File

@@ -197,11 +197,11 @@ class Value:
-------
::
foo = await conf.guild(some_guild).foo()
foo = await config.guild(some_guild).foo()
# Is equivalent to this
group_obj = conf.guild(some_guild)
group_obj = config.guild(some_guild)
value_obj = group_obj.foo
foo = await value_obj()
@@ -241,10 +241,10 @@ class Value:
::
# Sets global value "foo" to False
await conf.foo.set(False)
await config.foo.set(False)
# Sets guild specific value of "bar" to True
await conf.guild(some_guild).bar.set(True)
await config.guild(some_guild).bar.set(True)
Parameters
----------
@@ -367,7 +367,7 @@ class Group(Value):
For example::
await conf.clear_raw("foo", "bar")
await config.clear_raw("foo", "bar")
# is equivalent to
@@ -430,7 +430,7 @@ class Group(Value):
user = ctx.author
# Where the value of item is the name of the data field in Config
await ctx.send(await self.conf.user(user).get_attr(item).foo())
await ctx.send(await self.config.user(user).get_attr(item).foo())
Parameters
----------
@@ -455,7 +455,7 @@ class Group(Value):
For example::
d = await conf.get_raw("foo", "bar")
d = await config.get_raw("foo", "bar")
# is equivalent to
@@ -567,7 +567,7 @@ class Group(Value):
For example::
await conf.set_raw("foo", "bar", value="baz")
await config.set_raw("foo", "bar", value="baz")
# is equivalent to
@@ -602,7 +602,7 @@ class Config(metaclass=ConfigMeta):
:python:`global` method because global data is accessed by
normal attribute access::
await conf.foo()
await config.foo()
Attributes
----------
@@ -821,11 +821,11 @@ class Config(metaclass=ConfigMeta):
--------
You can register a single value or multiple values::
conf.register_global(
config.register_global(
foo=True
)
conf.register_global(
config.register_global(
bar=False,
baz=None
)
@@ -840,7 +840,7 @@ class Config(metaclass=ConfigMeta):
}
# Will register `foo.bar` == True and `foo.baz` == False
conf.register_global(
config.register_global(
**_defaults
)
@@ -848,7 +848,7 @@ class Config(metaclass=ConfigMeta):
using double underscore as a variable name separator::
# This is equivalent to the previous example
conf.register_global(
config.register_global(
foo__bar=True,
foo__baz=False
)