Plugin example: move wikilink processing #96
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- This commit uses the `pluggy` framework mentioned in redimp#91 to move the "wikilink" parsing functionality to a separate "plugin" that is still housed within the OtterWiki codebase. - The wikilink parsing code is unchanged, and was just moved to a WikiLinkPlugin class, which implements the new `preprocess_markdown` hook. - The WikiLinkPlugin is manually registered, but this commit also includes code to automatically discover plugins installed as Python packages if they use the "otterwiki" Setuptools entrypoint. This has yet to be tested, but should work. - Tests have been updated.
|
I'm running out of superlatives. This is brilliant.
TBH: Using preprocessing for handling the wiki links was a workaround, because at this time my approaches to extend mistune were not working as I expected. Happy to see that this somehow became useful. 😅 Still need to understand how pluggy works exactly, but that will be easy with this PR. Will merge as soon as I get the hang of it. I'll check tomorrow or at the weekend to see what other places there are that are suitable for hooks. I look forward to your suggestions. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR uses the
pluggyframework mentioned in Thoughts on extensibility #91 to move the "wikilink" parsing functionality to a separate "plugin" that is still housed within the OtterWiki codebase.The wikilink parsing code is unchanged, and was just moved to a WikiLinkPlugin class, which implements the new
preprocess_markdownhook.The WikiLinkPlugin is manually registered, but this commit also includes code to automatically discover plugins installed as Python packages if they use the "otterwiki" Setuptools entrypoint. This has yet to be tested, but should work.
Tests have been updated.
CC @redimp - what do you think? This should be a really easy/simple hook to start with.