extern/apprise
1
0
Fork 0
mirror of https://github.com/caronc/apprise.git synced 2025-08-11 17:28:44 +02:00
Code Issues Packages Projects Releases Wiki Activity

Refactor: Python Module Naming & Namespace Harmonization (#1119)

Browse Source
This commit is contained in:
Chris Caron
2024-04-27 13:02:27 -04:00
committed by GitHub
parent 08cb018e11
commit b8da1334ab
267 changed files with 678 additions and 639 deletions
Download Patch File Download Diff File Expand all files Collapse all files

84
test/helpers/module.py
View File

@ -28,8 +28,8 @@
from itertools import chain
from importlib import import_module, reload
from apprise.NotificationManager import NotificationManager
from apprise.AttachmentManager import AttachmentManager
from apprise.manager_plugins import NotificationManager
from apprise.manager_attachment import AttachmentManager
import sys
import re
@ -39,6 +39,14 @@ N_MGR = NotificationManager()
# Grant access to our Attachment Manager Singleton
A_MGR = AttachmentManager()
# For filtering our result when scanning a module
# Identify any items below we should match on that we can freely
# directly copy around between our modules. This should only
# catch class/function/variables we want to allow explicity
# copy/paste access with
module_filter_re = \
re.compile(r'^(?P<name>(Notify|Config|Attach)[A-Za-z0-9]+)$')
def reload_plugin(name):
"""
@ -52,42 +60,71 @@ def reload_plugin(name):
A_MGR.unload_modules()
reload(sys.modules['apprise.attachment.AttachBase'])
reload(sys.modules['apprise.AppriseAttachment'])
new_apprise_attachment_mod = import_module('apprise.AppriseAttachment')
reload(sys.modules['apprise.AttachmentManager'])
reload(sys.modules['apprise.apprise_attachment'])
reload(sys.modules['apprise.attachment.base'])
new_apprise_attachment_mod = import_module('apprise.apprise_attachment')
new_apprise_attach_base_mod = import_module('apprise.attachment.base')
reload(sys.modules['apprise.manager_attachment'])
module_pyname = '{}.{}'.format(N_MGR.module_name_prefix, name)
if module_pyname in sys.modules:
reload(sys.modules[module_pyname])
new_notify_mod = import_module(module_pyname)
reload(sys.modules['apprise.NotificationManager'])
reload(sys.modules['apprise.Apprise'])
# Detect our class object
class_matches = {}
for class_name in [obj for obj in dir(new_notify_mod)
if module_filter_re.match(obj)]:
# Store our entry
class_matches[class_name] = getattr(new_notify_mod, class_name)
# the user running the tests did not correctly use reload_plugin() or
# they did, but libraries around them have shifted. We need to error out
# so the test can be fixed
if not class_matches:
raise AttributeError(f"Module {name} has no URLBase defined in it!")
reload(sys.modules['apprise.manager_plugins'])
reload(sys.modules['apprise.apprise'])
reload(sys.modules['apprise.utils'])
reload(sys.modules['apprise.locale'])
reload(sys.modules['apprise'])
# Filter our keys
# Acquire all of the test files we have
tests = [k for k in sys.modules.keys() if re.match(r'^test_.+$', k)]
# Iterate over all of our test modules
for module_name in tests:
# Filter the test files by only those using the class_name we found
# within our module
possible_matches = \
[m for m in dir(sys.modules[module_name])
if re.match(r'^(?P<name>Notify[a-z0-9]+)$', m, re.I)]
if re.match('^(?P<name>{})$'.format(
'|'.join(class_matches.keys())), m)]
if not possible_matches:
continue
# if we get here, we have test_ files that utilize the Class we just
# reloaded
# Fix reference to new plugin class in given module.
# Needed for updating the module-level import reference like
# `from apprise.plugins.NotifyABCDE import NotifyABCDE`.
#
# We reload NotifyABCDE and place it back in its spot
test_mod = import_module(module_name)
setattr(test_mod, name, getattr(new_notify_mod, name))
for class_name, class_plugin in class_matches.items():
if hasattr(test_mod, class_name):
setattr(test_mod, class_name, class_plugin)
#
# This section below reloads our attachment classes
#
# Detect our Apprise Modules (include helpers)
apprise_modules = \
[k for k in sys.modules.keys()
if re.match(r'^(apprise|helpers)(\.|.+)$', k)]
sorted([k for k in sys.modules.keys()
if re.match(r'^(apprise|helpers)(\.|.+)$', k)], reverse=True)
for entry in A_MGR:
reload(sys.modules[entry['path']])
@ -104,7 +141,7 @@ def reload_plugin(name):
apprise_mod = import_module(module_pyname)
# Fix reference to new plugin class in given module.
# Needed for updating the module-level import reference
# like `from apprise.<etc> import NotifyABCDE`.
# like `from apprise.<etc> import AttachABCDE`.
#
# We reload NotifyABCDE and place it back in its spot
# new_attach = import_module(entry['path'])
@ -114,8 +151,25 @@ def reload_plugin(name):
apprise_mod, name,
getattr(new_apprise_attachment_mod, name))
elif name == 'AttachBase':
setattr(
apprise_mod, name,
getattr(new_apprise_attach_base_mod, name))
else:
module_pyname = '{}.{}'.format(
A_MGR.module_name_prefix, name)
new_attach_mod = import_module(module_pyname)
setattr(apprise_mod, name, getattr(new_attach_mod, name))
# Detect our class object
class_matches = {}
for class_name in [obj for obj in dir(new_attach_mod)
if module_filter_re.match(obj)]:
# Store our entry
class_matches[class_name] = \
getattr(new_attach_mod, class_name)
for class_name, class_plugin in class_matches.items():
if hasattr(apprise_mod, class_name):
setattr(apprise_mod, class_name, class_plugin)