cswimr/SeaCogs
cswimr/SeaCogs
1
1
Fork 1
Code Issues 11 Pull requests 9 Projects 1 Wiki Activity Actions

fix(backup): update for red 3.5.14 & reformat
Some checks failed
Actions / Build Documentation (MkDocs) (push) Successful in 44s
Details
Actions / Lint Code (Ruff & Pylint) (push) Failing after 51s
Details

Browse source
This commit is contained in:
cswimr 2025-01-26 13:21:28 +00:00
parent 0f47a15291
commit 0c43e3d2c9
Signed by: cswimr
GPG key ID: 0EC431A8DA8F8087
2 changed files with 41 additions and 89 deletions
Download patch file Download diff file Expand all files Collapse all files

108
backup/backup.py
View file

@ -23,7 +23,7 @@ class Backup(commands.Cog):
__author__ = ["[cswimr](https://www.coastalcommits.com/cswimr)"] __author__ = ["[cswimr](https://www.coastalcommits.com/cswimr)"]
__git__ = "https://www.coastalcommits.com/cswimr/SeaCogs" __git__ = "https://www.coastalcommits.com/cswimr/SeaCogs"
__version__ = "1.1.1" __version__ = "1.1.2"
__documentation__ = "https://seacogs.coastalcommits.com/backup/" __documentation__ = "https://seacogs.coastalcommits.com/backup/"
def __init__(self, bot: Red): def __init__(self, bot: Red):
@ -53,11 +53,7 @@ class Backup(commands.Cog):
"""Export your installed repositories and cogs to a file.""" """Export your installed repositories and cogs to a file."""
downloader = ctx.bot.get_cog("Downloader") downloader = ctx.bot.get_cog("Downloader")
if downloader is None: if downloader is None:
await ctx.send( await ctx.send(error(f"You do not have the `Downloader` cog loaded. Please run `{ctx.prefix}load downloader` and try again."))
error(
f"You do not have the `Downloader` cog loaded. Please run `{ctx.prefix}load downloader` and try again."
)
)
return return
all_repos = list(downloader._repo_manager.repos) all_repos = list(downloader._repo_manager.repos)
@ -88,9 +84,7 @@ class Backup(commands.Cog):
export_data.append(repo_dict) export_data.append(repo_dict)
await ctx.send( await ctx.send(file=text_to_file(json.dumps(export_data, indent=4), "backup.json"))
file=text_to_file(json.dumps(export_data, indent=4), "backup.json")
)
@backup.command(name="import") @backup.command(name="import")
@commands.is_owner() @commands.is_owner()
@ -107,11 +101,7 @@ class Backup(commands.Cog):
downloader = ctx.bot.get_cog("Downloader") downloader = ctx.bot.get_cog("Downloader")
if downloader is None: if downloader is None:
await ctx.send( await ctx.send(error(f"You do not have the `Downloader` cog loaded. Please run `{ctx.prefix}load downloader` and try again."))
error(
f"You do not have the `Downloader` cog loaded. Please run `{ctx.prefix}load downloader` and try again."
)
)
return return
repo_s = [] repo_s = []
@ -133,32 +123,20 @@ class Backup(commands.Cog):
repo_e.append("PyLav cogs are not supported.") repo_e.append("PyLav cogs are not supported.")
continue continue
if name.startswith(".") or name.endswith("."): if name.startswith(".") or name.endswith("."):
repo_e.append( repo_e.append(f"Invalid repository name: {name}\nRepository names cannot start or end with a dot.")
f"Invalid repository name: {name}\nRepository names cannot start or end with a dot."
)
continue continue
if re.match(r"^[a-zA-Z0-9_\-\.]+$", name) is None: if re.match(r"^[a-zA-Z0-9_\-\.]+$", name) is None:
repo_e.append( repo_e.append(f"Invalid repository name: {name}\nRepository names may only contain letters, numbers, underscores, hyphens, and dots.")
f"Invalid repository name: {name}\nRepository names may only contain letters, numbers, underscores, hyphens, and dots."
)
continue continue
try: try:
repository = await downloader._repo_manager.add_repo( repository = await downloader._repo_manager.add_repo(url, name, branch)
url, name, branch repo_s.append(f"Added repository {name} from {url} on branch {branch}.")
) self.logger.debug("Added repository %s from %s on branch %s", name, url, branch)
repo_s.append(
f"Added repository {name} from {url} on branch {branch}."
)
self.logger.debug(
"Added repository %s from %s on branch %s", name, url, branch
)
except errors.ExistingGitRepo: except errors.ExistingGitRepo:
repo_e.append(f"Repository {name} already exists.") repo_e.append(f"Repository {name} already exists.")
repository = downloader._repo_manager.get_repo( repository = downloader._repo_manager.get_repo(name)
name
)
self.logger.debug("Repository %s already exists", name) self.logger.debug("Repository %s already exists", name)
except errors.AuthenticationError as err: except errors.AuthenticationError as err:
@ -172,9 +150,7 @@ class Backup(commands.Cog):
continue continue
except errors.CloningError as err: except errors.CloningError as err:
repo_e.append( repo_e.append(f"Cloning error while adding repository {name}. See logs for more information.")
f"Cloning error while adding repository {name}. See logs for more information."
)
self.logger.exception( self.logger.exception(
"Something went wrong whilst cloning %s (to revision %s)", "Something went wrong whilst cloning %s (to revision %s)",
url, url,
@ -184,9 +160,7 @@ class Backup(commands.Cog):
continue continue
except OSError: except OSError:
repo_e.append( repo_e.append(f"OS error while adding repository {name}. See logs for more information.")
f"OS error while adding repository {name}. See logs for more information."
)
self.logger.exception( self.logger.exception(
"Something went wrong trying to add repo %s under name %s", "Something went wrong trying to add repo %s under name %s",
url, url,
@ -212,17 +186,13 @@ class Backup(commands.Cog):
with contextlib.suppress(commands.ExtensionNotLoaded): with contextlib.suppress(commands.ExtensionNotLoaded):
await ctx.bot.unload_extension(cog) await ctx.bot.unload_extension(cog)
await ctx.bot.remove_loaded_package(cog) await ctx.bot.remove_loaded_package(cog)
await downloader._delete_cog( await downloader._delete_cog(poss_installed_path)
poss_installed_path
)
uninstall_s.append(f"Uninstalled {cog}") uninstall_s.append(f"Uninstalled {cog}")
self.logger.debug("Uninstalled %s", cog) self.logger.debug("Uninstalled %s", cog)
else: else:
uninstall_e.append(f"Failed to uninstall {cog}") uninstall_e.append(f"Failed to uninstall {cog}")
self.logger.warning("Failed to uninstall %s", cog) self.logger.warning("Failed to uninstall %s", cog)
await downloader._remove_from_installed( await downloader._remove_from_installed(cog_modules)
cog_modules
)
for cog in cogs: for cog in cogs:
cog_name = cog["name"] cog_name = cog["name"]
@ -236,25 +206,15 @@ class Backup(commands.Cog):
if cog_name == "backup" and "cswimr/SeaCogs" in url: if cog_name == "backup" and "cswimr/SeaCogs" in url:
continue continue
async with repository.checkout( async with repository.checkout(commit, exit_to_rev=repository.branch):
commit, exit_to_rev=repository.branch cogs_c, message = await downloader._filter_incorrect_cogs_by_names(repository, [cog_name])
):
cogs_c, message = (
await downloader._filter_incorrect_cogs_by_names(
repository, [cog_name]
)
)
if not cogs_c: if not cogs_c:
install_e.append(message) install_e.append(message)
self.logger.error(message) self.logger.error(message)
continue continue
failed_reqs = await downloader._install_requirements( failed_reqs = await downloader._install_requirements(cogs_c)
cogs_c
)
if failed_reqs: if failed_reqs:
install_e.append( install_e.append(f"Failed to install {cog_name} due to missing requirements: {failed_reqs}")
f"Failed to install {cog_name} due to missing requirements: {failed_reqs}"
)
self.logger.error( self.logger.error(
"Failed to install %s due to missing requirements: %s", "Failed to install %s due to missing requirements: %s",
cog_name, cog_name,
@ -262,51 +222,37 @@ class Backup(commands.Cog):
) )
continue continue
installed_cogs, failed_cogs = await downloader._install_cogs( installed_cogs, failed_cogs = await downloader._install_cogs(cogs_c)
cogs_c
)
if repository.available_libraries: if repository.available_libraries:
installed_libs, failed_libs = ( installed_libs, failed_libs = await repository.install_libraries(
await repository.install_libraries( target_dir=downloader.SHAREDLIB_PATH,
target_dir=downloader.SHAREDLIB_PATH, req_target_dir=downloader.LIB_PATH,
req_target_dir=downloader.LIB_PATH,
)
) )
else: else:
installed_libs = None installed_libs = None
failed_libs = None failed_libs = None
if cog_pinned: if cog_pinned:
for cog in installed_cogs: for cog in installed_cogs: # noqa: PLW2901
cog.pinned = True cog.pinned = True
await downloader._save_to_installed( await downloader._save_to_installed(installed_cogs + installed_libs if installed_libs else installed_cogs)
installed_cogs + installed_libs
if installed_libs
else installed_cogs
)
if installed_cogs: if installed_cogs:
installed_cog_name = installed_cogs[0].name installed_cog_name = installed_cogs[0].name
install_s.append(f"Installed {installed_cog_name}") install_s.append(f"Installed {installed_cog_name}")
self.logger.debug("Installed %s", installed_cog_name) self.logger.debug("Installed %s", installed_cog_name)
if installed_libs: if installed_libs:
for lib in installed_libs: for lib in installed_libs:
install_s.append( install_s.append(f"Installed {lib.name} required for {cog_name}")
f"Installed {lib.name} required for {cog_name}" self.logger.debug("Installed %s required for %s", lib.name, cog_name)
)
self.logger.debug(
"Installed %s required for %s", lib.name, cog_name
)
if failed_cogs: if failed_cogs:
failed_cog_name = failed_cogs[0].name failed_cog_name = failed_cogs[0].name
install_e.append(f"Failed to install {failed_cog_name}") install_e.append(f"Failed to install {failed_cog_name}")
self.logger.error("Failed to install %s", failed_cog_name) self.logger.error("Failed to install %s", failed_cog_name)
if failed_libs: if failed_libs:
for lib in failed_libs: for lib in failed_libs:
install_e.append( install_e.append(f"Failed to install {lib.name} required for {cog_name}")
f"Failed to install {lib.name} required for {cog_name}"
)
self.logger.error( self.logger.error(
"Failed to install %s required for %s", "Failed to install %s required for %s",
lib.name, lib.name,

22
backup/info.json
View file

@ -1,15 +1,21 @@
{ {
"author" : ["cswimr"], "author": [
"install_msg" : "Thank you for installing Backup!\nYou can find the source code of this cog [here](https://coastalcommits.com/cswimr/SeaCogs).", "cswimr"
"name" : "Backup", ],
"short" : "A utility to make reinstalling repositories and cogs after migrating the bot far easier.", "install_msg": "Thank you for installing Backup!\nYou can find the source code of this cog [here](https://coastalcommits.com/cswimr/SeaCogs).",
"description" : "A utility to make reinstalling repositories and cogs after migrating the bot far easier.", "name": "Backup",
"end_user_data_statement" : "This cog does not store end user data.", "short": "A utility to make reinstalling repositories and cogs after migrating the bot far easier.",
"description": "A utility to make reinstalling repositories and cogs after migrating the bot far easier.",
"end_user_data_statement": "This cog does not store end user data.",
"hidden": false, "hidden": false,
"disabled": false, "disabled": false,
"min_bot_version": "3.5.6", "min_bot_version": "3.5.6",
"max_bot_version": "3.5.13", "max_bot_version": "3.5.14",
"min_python_version": [3, 9, 0], "min_python_version": [
3,
9,
0
],
"tags": [ "tags": [
"utility", "utility",
"backup", "backup",