OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Fixed group plugin crashing when using hooks

Browse Source
This commit is contained in:
squidfunk 2023-09-11 18:17:41 +02:00
parent c9a7339411
commit eb1c32327b
No known key found for this signature in database
GPG Key ID: 5ED40BC4F9C436DF
2 changed files with 32 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
material/plugins/group/plugin.py
View File

@ -82,11 +82,18 @@ class GroupPlugin(BasePlugin[GroupConfig]):
# Invoke `on_startup` event for plugins in group # Invoke `on_startup` event for plugins in group
command = "serve" if self.is_serve else "build" command = "serve" if self.is_serve else "build"
for method in option.plugins.events["startup"]: for method in option.plugins.events["startup"]:
if method.__self__ in self.plugins.values(): plugin = self._get_plugin(method)
# Ensure that we have a method bound to a plugin (and not a hook)
if plugin and plugin in self.plugins.values():
method(command = command, dirty = self.is_dirty) method(command = command, dirty = self.is_dirty)
# ------------------------------------------------------------------------- # -------------------------------------------------------------------------
# Retrieve plugin instance for bound method or nothing
def _get_plugin(self, method: Callable):
return getattr(method, "__self__", None)
# Retrieve priority of plugin method # Retrieve priority of plugin method
def _get_priority(self, method: Callable): def _get_priority(self, method: Callable):
return getattr(method, "mkdocs_priority", 0) return getattr(method, "mkdocs_priority", 0)
@ -117,7 +124,8 @@ class GroupPlugin(BasePlugin[GroupConfig]):
head = methods[at] head = methods[at]
# Skip if the plugin is not part of the group # Skip if the plugin is not part of the group
if not head.__self__ in self.plugins.values(): plugin = self._get_plugin(head)
if not plugin or plugin not in self.plugins.values():
continue continue
# Skip if the previous method has a higher priority than the current # Skip if the previous method has a higher priority than the current
@ -125,9 +133,14 @@ class GroupPlugin(BasePlugin[GroupConfig]):
if self._get_priority(tail) > self._get_priority(head): if self._get_priority(tail) > self._get_priority(head):
continue continue
# Ensure that we have a method bound to a plugin (and not a hook)
plugin = self._get_plugin(tail)
if not plugin:
continue
# Both methods have the same priority, so we check if the ordering # Both methods have the same priority, so we check if the ordering
# of both methods is violated, and if it is, swap them # of both methods is violated, and if it is, swap them
if (position < self._get_position(tail.__self__, config)): if (position < self._get_position(plugin, config)):
methods[at], methods[at - 1] = tail, head methods[at], methods[at - 1] = tail, head
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------

19
src/plugins/group/plugin.py
View File

@ -82,11 +82,18 @@ class GroupPlugin(BasePlugin[GroupConfig]):
# Invoke `on_startup` event for plugins in group # Invoke `on_startup` event for plugins in group
command = "serve" if self.is_serve else "build" command = "serve" if self.is_serve else "build"
for method in option.plugins.events["startup"]: for method in option.plugins.events["startup"]:
if method.__self__ in self.plugins.values(): plugin = self._get_plugin(method)
# Ensure that we have a method bound to a plugin (and not a hook)
if plugin and plugin in self.plugins.values():
method(command = command, dirty = self.is_dirty) method(command = command, dirty = self.is_dirty)
# ------------------------------------------------------------------------- # -------------------------------------------------------------------------
# Retrieve plugin instance for bound method or nothing
def _get_plugin(self, method: Callable):
return getattr(method, "__self__", None)
# Retrieve priority of plugin method # Retrieve priority of plugin method
def _get_priority(self, method: Callable): def _get_priority(self, method: Callable):
return getattr(method, "mkdocs_priority", 0) return getattr(method, "mkdocs_priority", 0)
@ -117,7 +124,8 @@ class GroupPlugin(BasePlugin[GroupConfig]):
head = methods[at] head = methods[at]
# Skip if the plugin is not part of the group # Skip if the plugin is not part of the group
if not head.__self__ in self.plugins.values(): plugin = self._get_plugin(head)
if not plugin or plugin not in self.plugins.values():
continue continue
# Skip if the previous method has a higher priority than the current # Skip if the previous method has a higher priority than the current
@ -125,9 +133,14 @@ class GroupPlugin(BasePlugin[GroupConfig]):
if self._get_priority(tail) > self._get_priority(head): if self._get_priority(tail) > self._get_priority(head):
continue continue
# Ensure that we have a method bound to a plugin (and not a hook)
plugin = self._get_plugin(tail)
if not plugin:
continue
# Both methods have the same priority, so we check if the ordering # Both methods have the same priority, so we check if the ordering
# of both methods is violated, and if it is, swap them # of both methods is violated, and if it is, swap them
if (position < self._get_position(tail.__self__, config)): if (position < self._get_position(plugin, config)):
methods[at], methods[at - 1] = tail, head methods[at], methods[at - 1] = tail, head
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------