mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-07 03:38:53 -05:00
docs: deprecation of shared libraries has been postponed to 3.4 (#3449)
This commit is contained in:
parent
fc5fc08962
commit
068585379a
@ -238,7 +238,7 @@ Removals
|
|||||||
~~~~~~~~
|
~~~~~~~~
|
||||||
|
|
||||||
- ``[p]set owner`` and ``[p]set token`` have been removed in favor of managing server side. (`#2928 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2928>`_)
|
- ``[p]set owner`` and ``[p]set token`` have been removed in favor of managing server side. (`#2928 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2928>`_)
|
||||||
- Shared libraries are marked for removal in Red 3.3. (`#3106 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3106>`_)
|
- Shared libraries are marked for removal in Red 3.4. (`#3106 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3106>`_)
|
||||||
- Removed ``[p]backup``. Use the cli command ``redbot-setup backup`` instead. (`#3235 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3235>`_)
|
- Removed ``[p]backup``. Use the cli command ``redbot-setup backup`` instead. (`#3235 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3235>`_)
|
||||||
- Removed the functions ``safe_delete``, ``fuzzy_command_search``, ``format_fuzzy_results`` and ``create_backup`` from ``redbot.core.utils``. (`#3240 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3240>`_)
|
- Removed the functions ``safe_delete``, ``fuzzy_command_search``, ``format_fuzzy_results`` and ``create_backup`` from ``redbot.core.utils``. (`#3240 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3240>`_)
|
||||||
- Removed a lot of the launcher's handled behavior. (`#3289 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3289>`_)
|
- Removed a lot of the launcher's handled behavior. (`#3289 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3289>`_)
|
||||||
|
|||||||
@ -81,5 +81,5 @@ Keys specific to the cog info.json (case sensitive)
|
|||||||
``SHARED_LIBRARY``. If ``SHARED_LIBRARY`` then ``hidden`` will be ``True``.
|
``SHARED_LIBRARY``. If ``SHARED_LIBRARY`` then ``hidden`` will be ``True``.
|
||||||
|
|
||||||
.. warning::
|
.. warning::
|
||||||
Shared libraries are deprecated since version 3.2 and are marked for removal in version 3.3.
|
Shared libraries are deprecated since version 3.2 and are marked for removal in version 3.4.
|
||||||
|
|
||||||
|
|||||||
@ -29,7 +29,7 @@ _ = Translator("Downloader", __file__)
|
|||||||
|
|
||||||
DEPRECATION_NOTICE = _(
|
DEPRECATION_NOTICE = _(
|
||||||
"\n**WARNING:** The following repos are using shared libraries"
|
"\n**WARNING:** The following repos are using shared libraries"
|
||||||
" which are marked for removal in Red 3.3: {repo_list}.\n"
|
" which are marked for removal in Red 3.4: {repo_list}.\n"
|
||||||
" You should inform maintainers of these repos about this message."
|
" You should inform maintainers of these repos about this message."
|
||||||
)
|
)
|
||||||
|
|
||||||
@ -237,7 +237,7 @@ class Downloader(commands.Cog):
|
|||||||
await self.conf.installed_libraries.set(installed_libraries)
|
await self.conf.installed_libraries.set(installed_libraries)
|
||||||
|
|
||||||
async def _shared_lib_load_check(self, cog_name: str) -> Optional[Repo]:
|
async def _shared_lib_load_check(self, cog_name: str) -> Optional[Repo]:
|
||||||
# remove in Red 3.3
|
# remove in Red 3.4
|
||||||
is_installed, cog = await self.is_installed(cog_name)
|
is_installed, cog = await self.is_installed(cog_name)
|
||||||
# it's not gonna be None when `is_installed` is True
|
# it's not gonna be None when `is_installed` is True
|
||||||
# if we'll use typing_extensions in future, `Literal` can solve this
|
# if we'll use typing_extensions in future, `Literal` can solve this
|
||||||
|
|||||||
@ -22,7 +22,7 @@ class SharedLibImportWarner(MetaPathFinder):
|
|||||||
return None
|
return None
|
||||||
msg = (
|
msg = (
|
||||||
"One of cogs uses shared libraries which are"
|
"One of cogs uses shared libraries which are"
|
||||||
" deprecated and scheduled for removal in Red 3.3.\n"
|
" deprecated and scheduled for removal in Red 3.4.\n"
|
||||||
"You should inform author of the cog about this message."
|
"You should inform author of the cog about this message."
|
||||||
)
|
)
|
||||||
warnings.warn(msg, SharedLibDeprecationWarning, stacklevel=2)
|
warnings.warn(msg, SharedLibDeprecationWarning, stacklevel=2)
|
||||||
|
|||||||
@ -126,7 +126,7 @@ class CoreLogic:
|
|||||||
else:
|
else:
|
||||||
await bot.add_loaded_package(name)
|
await bot.add_loaded_package(name)
|
||||||
loaded_packages.append(name)
|
loaded_packages.append(name)
|
||||||
# remove in Red 3.3
|
# remove in Red 3.4
|
||||||
downloader = bot.get_cog("Downloader")
|
downloader = bot.get_cog("Downloader")
|
||||||
if downloader is None:
|
if downloader is None:
|
||||||
continue
|
continue
|
||||||
@ -705,13 +705,13 @@ class Core(commands.Cog, CoreLogic):
|
|||||||
if len(repos_with_shared_libs) == 1:
|
if len(repos_with_shared_libs) == 1:
|
||||||
formed = _(
|
formed = _(
|
||||||
"**WARNING**: The following repo is using shared libs"
|
"**WARNING**: The following repo is using shared libs"
|
||||||
" which are marked for removal in Red 3.3: {repo}.\n"
|
" which are marked for removal in Red 3.4: {repo}.\n"
|
||||||
"You should inform maintainer of the repo about this message."
|
"You should inform maintainer of the repo about this message."
|
||||||
).format(repo=inline(repos_with_shared_libs.pop()))
|
).format(repo=inline(repos_with_shared_libs.pop()))
|
||||||
else:
|
else:
|
||||||
formed = _(
|
formed = _(
|
||||||
"**WARNING**: The following repos are using shared libs"
|
"**WARNING**: The following repos are using shared libs"
|
||||||
" which are marked for removal in Red 3.3: {repos}.\n"
|
" which are marked for removal in Red 3.4: {repos}.\n"
|
||||||
"You should inform maintainers of these repos about this message."
|
"You should inform maintainers of these repos about this message."
|
||||||
).format(repos=humanize_list([inline(repo) for repo in repos_with_shared_libs]))
|
).format(repos=humanize_list([inline(repo) for repo in repos_with_shared_libs]))
|
||||||
output.append(formed)
|
output.append(formed)
|
||||||
@ -823,13 +823,13 @@ class Core(commands.Cog, CoreLogic):
|
|||||||
if len(repos_with_shared_libs) == 1:
|
if len(repos_with_shared_libs) == 1:
|
||||||
formed = _(
|
formed = _(
|
||||||
"**WARNING**: The following repo is using shared libs"
|
"**WARNING**: The following repo is using shared libs"
|
||||||
" which are marked for removal in Red 3.3: {repo}.\n"
|
" which are marked for removal in Red 3.4: {repo}.\n"
|
||||||
"You should inform maintainers of these repos about this message."
|
"You should inform maintainers of these repos about this message."
|
||||||
).format(repo=inline(repos_with_shared_libs.pop()))
|
).format(repo=inline(repos_with_shared_libs.pop()))
|
||||||
else:
|
else:
|
||||||
formed = _(
|
formed = _(
|
||||||
"**WARNING**: The following repos are using shared libs"
|
"**WARNING**: The following repos are using shared libs"
|
||||||
" which are marked for removal in Red 3.3: {repos}.\n"
|
" which are marked for removal in Red 3.4: {repos}.\n"
|
||||||
"You should inform maintainers of these repos about this message."
|
"You should inform maintainers of these repos about this message."
|
||||||
).format(repos=humanize_list([inline(repo) for repo in repos_with_shared_libs]))
|
).format(repos=humanize_list([inline(repo) for repo in repos_with_shared_libs]))
|
||||||
output.append(formed)
|
output.append(formed)
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user