diff options
author | Brendan Abolivier <babolivier@matrix.org> | 2022-05-31 12:04:53 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-05-31 12:04:53 +0200 |
commit | 8fd87739bf9653a77fff9669d4f307e8b1bcd1eb (patch) | |
tree | f0b209980fdb2c0818320b7e91ba0a7a95530e5c /synapse/spam_checker_api | |
parent | 1.60.0rc2 (diff) | |
download | synapse-8fd87739bf9653a77fff9669d4f307e8b1bcd1eb.tar.xz |
Fix import in module_api module and docs on the new check_event_for_spam signature (#12918)
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
Diffstat (limited to 'synapse/spam_checker_api')
-rw-r--r-- | synapse/spam_checker_api/__init__.py | 25 |
1 files changed, 0 insertions, 25 deletions
diff --git a/synapse/spam_checker_api/__init__.py b/synapse/spam_checker_api/__init__.py index 95132c80b7..75578270ac 100644 --- a/synapse/spam_checker_api/__init__.py +++ b/synapse/spam_checker_api/__init__.py @@ -12,9 +12,6 @@ # See the License for the specific language governing permissions and # limitations under the License. from enum import Enum -from typing import Union - -from synapse.api.errors import Codes class RegistrationBehaviour(Enum): @@ -25,25 +22,3 @@ class RegistrationBehaviour(Enum): ALLOW = "allow" SHADOW_BAN = "shadow_ban" DENY = "deny" - - -# We define the following singleton enum rather than a string to be able to -# write `Union[Allow, ..., str]` in some of the callbacks for the spam-checker -# API, where the `str` is required to maintain backwards compatibility with -# previous versions of the API. -class Allow(Enum): - """ - Singleton to allow events to pass through in SpamChecker APIs. - """ - - ALLOW = "allow" - - -Decision = Union[Allow, Codes] -""" -Union to define whether a request should be allowed or rejected. - -To accept a request, return `ALLOW`. - -To reject a request without any specific information, use `Codes.FORBIDDEN`. -""" |