MirrorHub/synapse
0
0
Fork 1
mirror of https://mau.dev/maunium/synapse.git synced 2024-12-15 07:23:52 +01:00
Code Issues Projects Releases Wiki Activity

Improve the backwards compatibility re-exports of synapse.logging.context (#5617)

Browse source 
* Improve the backwards compatibility re-exports of synapse.logging.context.

* reexport logformatter too
This commit is contained in:
Amber Brown 2019-07-05 02:32:02 +10:00 committed by GitHub
parent ee91ac179c
commit 1ee268d33d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 62 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelog.d/5617.misc Normal file
View file

@ -0,0 +1 @@
Move logging code out of `synapse.util` and into `synapse.logging`.

6
synapse/util/__init__.py
View file

@ -21,14 +21,10 @@ import attr
from twisted.internet import defer, task from twisted.internet import defer, task
from synapse.logging import context, formatter from synapse.logging import context
logger = logging.getLogger(__name__) logger = logging.getLogger(__name__)
# Compatibility alias, for existing logconfigs.
logcontext = context
logformatter = formatter
def unwrapFirstError(failure): def unwrapFirstError(failure):
# defer.gatherResults and DeferredLists wrap failures. # defer.gatherResults and DeferredLists wrap failures.

39
synapse/util/logcontext.py Normal file
View file

@ -0,0 +1,39 @@
# Copyright 2019 The Matrix.org Foundation C.I.C.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""
Backwards compatibility re-exports of ``synapse.logging.context`` functionality.
"""
from synapse.logging.context import (
LoggingContext,
LoggingContextFilter,
PreserveLoggingContext,
defer_to_thread,
make_deferred_yieldable,
nested_logging_context,
preserve_fn,
run_in_background,
)
__all__ = [
"defer_to_thread",
"LoggingContext",
"LoggingContextFilter",
"make_deferred_yieldable",
"nested_logging_context",
"preserve_fn",
"PreserveLoggingContext",
"run_in_background",
]

21
synapse/util/logformatter.py Normal file
View file

@ -0,0 +1,21 @@
# Copyright 2019 The Matrix.org Foundation C.I.C.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""
Backwards compatibility re-exports of ``synapse.logging.formatter`` functionality.
"""
from synapse.logging.formatter import LogFormatter
__all__ = ["LogFormatter"]