MatrixSynapse/synapse/util/__init__.py

156 lines
4.6 KiB
Python
Raw Normal View History

2014-08-12 16:10:52 +02:00
# -*- coding: utf-8 -*-
2016-01-07 05:26:29 +01:00
# Copyright 2014-2016 OpenMarket Ltd
2014-08-12 16:10:52 +02:00
#
# 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.
import logging
import re
import attr
from canonicaljson import json
2018-07-09 08:09:20 +02:00
from twisted.internet import defer, task
from synapse.logging import context
logger = logging.getLogger(__name__)
2014-08-12 16:10:52 +02:00
# Create a custom encoder to reduce the whitespace produced by JSON encoding.
json_encoder = json.JSONEncoder(separators=(",", ":"))
2014-08-12 16:10:52 +02:00
2015-05-12 14:14:29 +02:00
def unwrapFirstError(failure):
# defer.gatherResults and DeferredLists wrap failures.
failure.trap(defer.FirstError)
return failure.value.subFailure
@attr.s
2014-08-12 16:10:52 +02:00
class Clock(object):
"""
A Clock wraps a Twisted reactor and provides utilities on top of it.
Args:
reactor: The Twisted reactor to use.
"""
2019-06-20 11:32:02 +02:00
_reactor = attr.ib()
@defer.inlineCallbacks
def sleep(self, seconds):
d = defer.Deferred()
with context.PreserveLoggingContext():
self._reactor.callLater(seconds, d.callback, seconds)
res = yield d
return res
2014-08-12 16:10:52 +02:00
def time(self):
"""Returns the current system time in seconds since epoch."""
return self._reactor.seconds()
2014-08-12 16:10:52 +02:00
def time_msec(self):
"""Returns the current system time in milliseconds since epoch."""
2016-02-15 18:10:40 +01:00
return int(self.time() * 1000)
2014-08-12 16:10:52 +02:00
2019-07-29 10:03:14 +02:00
def looping_call(self, f, msec, *args, **kwargs):
"""Call a function repeatedly.
Waits `msec` initially before calling `f` for the first time.
Note that the function will be called with no logcontext, so if it is anything
other than trivial, you probably want to wrap it in run_as_background_process.
Args:
f(function): The function to call repeatedly.
msec(float): How long to wait between calls in milliseconds.
2019-07-29 10:03:14 +02:00
*args: Postional arguments to pass to function.
**kwargs: Key arguments to pass to function.
"""
2019-07-29 10:03:14 +02:00
call = task.LoopingCall(f, *args, **kwargs)
call.clock = self._reactor
d = call.start(msec / 1000.0, now=False)
2019-06-20 11:32:02 +02:00
d.addErrback(log_failure, "Looping call died", consumeErrors=False)
return call
2015-02-09 15:47:59 +01:00
def call_later(self, delay, callback, *args, **kwargs):
"""Call something later
Note that the function will be called with no logcontext, so if it is anything
other than trivial, you probably want to wrap it in run_as_background_process.
Args:
delay(float): How long to wait in seconds.
callback(function): Function to call
*args: Postional arguments to pass to function.
**kwargs: Key arguments to pass to function.
"""
2019-06-20 11:32:02 +02:00
def wrapped_callback(*args, **kwargs):
with context.PreserveLoggingContext():
callback(*args, **kwargs)
with context.PreserveLoggingContext():
return self._reactor.callLater(delay, wrapped_callback, *args, **kwargs)
2014-08-12 16:10:52 +02:00
def cancel_call_later(self, timer, ignore_errs=False):
try:
timer.cancel()
except Exception:
if not ignore_errs:
raise
def log_failure(failure, msg, consumeErrors=True):
"""Creates a function suitable for passing to `Deferred.addErrback` that
logs any failures that occur.
Args:
msg (str): Message to log
consumeErrors (bool): If true consumes the failure, otherwise passes
on down the callback chain
Returns:
func(Failure)
"""
logger.error(
2019-06-20 11:32:02 +02:00
msg, exc_info=(failure.type, failure.value, failure.getTracebackObject())
)
if not consumeErrors:
return failure
def glob_to_regex(glob):
"""Converts a glob to a compiled regex object.
The regex is anchored at the beginning and end of the string.
Args:
glob (str)
Returns:
re.RegexObject
"""
2019-06-20 11:32:02 +02:00
res = ""
for c in glob:
2019-06-20 11:32:02 +02:00
if c == "*":
res = res + ".*"
elif c == "?":
res = res + "."
else:
res = res + re.escape(c)
# \A anchors at start of string, \Z at end of string
return re.compile(r"\A" + res + r"\Z", re.IGNORECASE)