Add an explaining comment to ExtraAdder (#382)

hynek · Dec 11, 2021 · 51132d5 · 51132d5
1 parent 9446227
commit 51132d5
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/structlog/stdlib.py b/src/structlog/stdlib.py
@@ -695,6 +695,9 @@ class ExtraAdder:
     def __init__(self, allow: Optional[Collection[str]] = None) -> None:
         self._copier: Callable[[EventDict, logging.LogRecord], None]
         if allow is not None:
+            # The contents of allow is copied to a new list so that changes to
+            # the list passed into the constructor does not change the
+            # behaviour of this processor.
             self._copier = functools.partial(self._copy_allowed, [*allow])
         else:
             self._copier = self._copy_all