Modernize syntax in chat formatting module and add success() (#5427)

* Downloader's plurial & Fix

* Don't forget pipinstall

* Fix syntax issue

* This f****** fix that took me too much of my time for nothing.

* Black

* Update redbot/cogs/downloader/downloader.py

Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>

* Update redbot/cogs/downloader/downloader.py

Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>

* Update redbot/cogs/downloader/downloader.py

Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>

* Update redbot/cogs/downloader/downloader.py

Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>

* Update redbot/cogs/downloader/downloader.py

Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>

* Update redbot/cogs/downloader/downloader.py

Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>

* Update redbot/cogs/downloader/downloader.py

Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>

* Update redbot/cogs/downloader/downloader.py

Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>

* Update redbot/cogs/downloader/downloader.py

Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>

* Fix Jack's syntax, remove numbers & fix bad calculated cogs

* Black ofc

* Update redbot/cogs/downloader/downloader.py

Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>

* Update redbot/cogs/downloader/downloader.py

Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>

* Update redbot/cogs/downloader/downloader.py

Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>

* Update redbot/cogs/downloader/downloader.py

Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>

* Update redbot/cogs/downloader/downloader.py

Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>

* Update redbot/cogs/downloader/downloader.py

Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>

* Update redbot/cogs/downloader/downloader.py

Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>

* Update redbot/cogs/downloader/downloader.py

Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>

* Update redbot/cogs/downloader/downloader.py

Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>

* Address my review comment

* Simplify

* this is kinda a lot but shh

* Change format to f-string

* Add success function to char_formatting

* Revert "Merge branch 'V3/develop' of github.com:Predeactor/Red-DiscordBot into master/chat-formatting-enhancement"

This reverts commit c338da7b66a79eaff975f4dbaa8269263a388e37, reversing
changes made to f2422ad782258990a56438db8abad61180cea681.

* For once I would have appreciated if style checks were failing...

Co-authored-by: Predeactor <ubuntu@vps-35e65bf5.vps.ovh.net>
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
This commit is contained in:
Predeactor 2021-10-27 14:34:20 +02:00 committed by GitHub
parent 42293afd43
commit 483ef36d1b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -27,7 +27,7 @@ def error(text: str) -> str:
The new message. The new message.
""" """
return "\N{NO ENTRY SIGN} {}".format(text) return f"\N{NO ENTRY SIGN} {text}"
def warning(text: str) -> str: def warning(text: str) -> str:
@ -44,7 +44,7 @@ def warning(text: str) -> str:
The new message. The new message.
""" """
return "\N{WARNING SIGN}\N{VARIATION SELECTOR-16} {}".format(text) return f"\N{WARNING SIGN}\N{VARIATION SELECTOR-16} {text}"
def info(text: str) -> str: def info(text: str) -> str:
@ -61,7 +61,24 @@ def info(text: str) -> str:
The new message. The new message.
""" """
return "\N{INFORMATION SOURCE}\N{VARIATION SELECTOR-16} {}".format(text) return f"\N{INFORMATION SOURCE}\N{VARIATION SELECTOR-16} {text}"
def success(text: str) -> str:
"""Get text prefixed with a success emoji.
Parameters
----------
text : str
The text to be prefixed.
Returns
-------
str
The new message.
"""
return f"\N{WHITE HEAVY CHECK MARK} {text}"
def question(text: str) -> str: def question(text: str) -> str:
@ -78,7 +95,7 @@ def question(text: str) -> str:
The new message. The new message.
""" """
return "\N{BLACK QUESTION MARK ORNAMENT}\N{VARIATION SELECTOR-16} {}".format(text) return f"\N{BLACK QUESTION MARK ORNAMENT}\N{VARIATION SELECTOR-16} {text}"
def bold(text: str, escape_formatting: bool = True) -> str: def bold(text: str, escape_formatting: bool = True) -> str:
@ -99,8 +116,7 @@ def bold(text: str, escape_formatting: bool = True) -> str:
The marked up text. The marked up text.
""" """
text = escape(text, formatting=escape_formatting) return f"**{escape(text, formatting=escape_formatting)}**"
return "**{}**".format(text)
def box(text: str, lang: str = "") -> str: def box(text: str, lang: str = "") -> str:
@ -119,8 +135,7 @@ def box(text: str, lang: str = "") -> str:
The marked up text. The marked up text.
""" """
ret = "```{}\n{}\n```".format(lang, text) return f"```{lang}\n{text}\n```"
return ret
def inline(text: str) -> str: def inline(text: str) -> str:
@ -138,9 +153,9 @@ def inline(text: str) -> str:
""" """
if "`" in text: if "`" in text:
return "``{}``".format(text) return f"``{text}``"
else: else:
return "`{}`".format(text) return f"`{text}`"
def italics(text: str, escape_formatting: bool = True) -> str: def italics(text: str, escape_formatting: bool = True) -> str:
@ -161,8 +176,7 @@ def italics(text: str, escape_formatting: bool = True) -> str:
The marked up text. The marked up text.
""" """
text = escape(text, formatting=escape_formatting) return f"*{escape(text, formatting=escape_formatting)}*"
return "*{}*".format(text)
def spoiler(text: str, escape_formatting: bool = True) -> str: def spoiler(text: str, escape_formatting: bool = True) -> str:
@ -183,8 +197,7 @@ def spoiler(text: str, escape_formatting: bool = True) -> str:
The marked up text. The marked up text.
""" """
text = escape(text, formatting=escape_formatting) return f"||{escape(text, formatting=escape_formatting)}||"
return "||{}||".format(text)
def bordered(*columns: Sequence[str], ascii_border: bool = False) -> str: def bordered(*columns: Sequence[str], ascii_border: bool = False) -> str:
@ -343,8 +356,7 @@ def strikethrough(text: str, escape_formatting: bool = True) -> str:
The marked up text. The marked up text.
""" """
text = escape(text, formatting=escape_formatting) return f"~~{escape(text, formatting=escape_formatting)}~~"
return "~~{}~~".format(text)
def underline(text: str, escape_formatting: bool = True) -> str: def underline(text: str, escape_formatting: bool = True) -> str:
@ -365,8 +377,7 @@ def underline(text: str, escape_formatting: bool = True) -> str:
The marked up text. The marked up text.
""" """
text = escape(text, formatting=escape_formatting) return f"__{escape(text, formatting=escape_formatting)}__"
return "__{}__".format(text)
def quote(text: str) -> str: def quote(text: str) -> str: