Frisk/RcGcDw
1
0
Fork 0
mirror of https://gitlab.com/chicken-riders/RcGcDw.git synced 2025-02-23 00:24:09 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Added additional argument to post-hooks containing main change body

Browse source 
This was a suggestion by MarkusRost
This commit is contained in:
Frisk 2021-05-22 13:48:01 +02:00
parent e63188f411
commit 4cd5e42bee
No known key found for this signature in database
GPG key ID: 213F7C15068AF8AC
4 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/API spec.md
View file

@ -148,4 +148,4 @@ RcGcDw implements i18n with gettext and already exposes Translations instance wi
**Path**: `src.api.hook` **Path**: `src.api.hook`
There are two decorator functions available in the module: `pre_hook` and `post_hook`. They don't take arguments and simply register the function as a hook. There are two decorator functions available in the module: `pre_hook` and `post_hook`. They don't take arguments and simply register the function as a hook.
Pre-hook functions take the following arguments: `context` ([Context object](#Context)) and `change` (dict object with change). Pre-hook functions take the following arguments: `context` ([Context object](#Context)) and `change` (dict object with change).
Post-hook functions take the following arguments: `message` ([Discord message object](#DiscordMessage)), `metadata` ([Discord message metadata](#DiscordMessageMetadata)) and `context` ([Context object](#Context)) Post-hook functions take the following arguments: `message` ([Discord message object](#DiscordMessage)), `metadata` ([Discord message metadata](#DiscordMessageMetadata)), `context` ([Context object](#Context)) and `change` (dictionary of main change body)

2
extensions/hooks/example_hook.py
View file

@ -23,6 +23,6 @@ def example_pre_hook(context, change):
@post_hook @post_hook
def example_post_hook(message, metadata, context): def example_post_hook(message, metadata, context, change):
print("Our Discord message looks as follows: ") print("Our Discord message looks as follows: ")
print(message) print(message)

2
src/discussions.py
View file

@ -124,7 +124,7 @@ def parse_discussion_post(post, comment_pages):
run_hooks(pre_hooks, context, post) run_hooks(pre_hooks, context, post)
discord_message = default_message(event_type, formatter_hooks)(context, post) discord_message = default_message(event_type, formatter_hooks)(context, post)
metadata = DiscordMessageMetadata("POST") metadata = DiscordMessageMetadata("POST")
run_hooks(post_hooks, discord_message, metadata, context) run_hooks(post_hooks, discord_message, metadata, context, post)
send_to_discord(discord_message, metadata) send_to_discord(discord_message, metadata)

4
src/rcgcdw.py
View file

@ -256,7 +256,7 @@ def rc_processor(change, changed_categories):
else: else:
for revid in logparams.get("ids", []): for revid in logparams.get("ids", []):
delete_messages(dict(revid=revid)) delete_messages(dict(revid=revid))
run_hooks(post_hooks, discord_message, metadata, context) run_hooks(post_hooks, discord_message, metadata, context, change)
send_to_discord(discord_message, metadata) send_to_discord(discord_message, metadata)
@ -269,7 +269,7 @@ def abuselog_processing(entry):
context.event = action context.event = action
discord_message: Optional[DiscordMessage] = default_message(action, formatter_hooks)(context, entry) discord_message: Optional[DiscordMessage] = default_message(action, formatter_hooks)(context, entry)
metadata = DiscordMessageMetadata("POST") metadata = DiscordMessageMetadata("POST")
run_hooks(post_hooks, discord_message, metadata, context) run_hooks(post_hooks, discord_message, metadata, context, entry)
send_to_discord(discord_message, metadata) send_to_discord(discord_message, metadata)