streamline event/hook/command naming conventions

This commit is contained in:
Maximilian Hils 2021-01-05 08:17:40 +01:00
parent 90df4168f8
commit 6c0e4f1cb7
35 changed files with 171 additions and 170 deletions

View file

@ -4,14 +4,14 @@ import textwrap
from typing import List, Type
import mitmproxy.addons.next_layer # noqa
from mitmproxy import events, log, addonmanager
from mitmproxy import event_hooks, log, addonmanager
from mitmproxy.proxy import server_hooks, layer
from mitmproxy.proxy.layers import http, tcp, tls, websocket
known = set()
def category(name: str, hooks: List[Type[events.MitmproxyEvent]]) -> None:
def category(name: str, hooks: List[Type[event_hooks.EventHook]]) -> None:
print(f"### {name} Events")
print("```python")
@ -65,10 +65,10 @@ def category(name: str, hooks: List[Type[events.MitmproxyEvent]]) -> None:
category(
"Lifecycle",
[
addonmanager.LoadEvent,
events.RunningEvent,
events.ConfigureEvent,
events.DoneEvent,
addonmanager.LoadEventHook,
event_hooks.RunningEventHook,
event_hooks.ConfigureEventHook,
event_hooks.DoneEventHook,
]
)
@ -127,12 +127,12 @@ category(
"Advanced Lifecycle",
[
layer.NextLayerHook,
events.UpdateEvent,
log.AddLogEvent,
event_hooks.UpdateEventHook,
log.AddLogEventHook,
]
)
not_documented = set(events.all_events.keys()) - known
not_documented = set(event_hooks.all_events.keys()) - known
if not_documented:
raise RuntimeError(f"Not documented: {not_documented}")

View file

@ -1,5 +1,5 @@
---
title: "Events"
title: "Event Hooks"
menu:
addons:
weight: 2