user_topics: Move topic muting functions to user_topics.py.

This commit moves topic related stuff i.e. topic muting functions
to a separate file 'views/user_topics.py'.

'views/muting.py' contains functions related to user-mutes only.

zerver/tests/test_topic_visibility_policies.py

@@ -98,7 +98,7 @@ class MutedTopicsTests(ZulipTestCase):
         mock_date_muted = datetime(2020, 1, 1, tzinfo=timezone.utc).timestamp()
         for data in payloads:
             with mock.patch(
-                "zerver.views.muting.timezone_now",
+                "zerver.views.user_topics.timezone_now",
                 return_value=datetime(2020, 1, 1, tzinfo=timezone.utc),
             ):
                 result = self.api_patch(user, url, data)
@@ -127,7 +127,7 @@ class MutedTopicsTests(ZulipTestCase):
             date_muted=datetime(2020, 1, 1, tzinfo=timezone.utc),
         )
 
-        with mock.patch("zerver.views.muting.topic_is_muted", return_value=False):
+        with mock.patch("zerver.views.user_topics.topic_is_muted", return_value=False):
             result = self.api_patch(user, url, data)
             self.assert_json_error(result, "Topic already muted")
 

zerver/views/muting.py

@@ -1,98 +1,16 @@
-import datetime
-from typing import Optional
-
 from django.db import IntegrityError
 from django.http import HttpRequest, HttpResponse
 from django.utils.timezone import now as timezone_now
 from django.utils.translation import gettext as _
 
 from zerver.actions.muted_users import do_mute_user, do_unmute_user
-from zerver.actions.user_topics import do_mute_topic, do_unmute_topic
 from zerver.lib.exceptions import JsonableError
-from zerver.lib.request import REQ, has_request_variables
 from zerver.lib.response import json_success
-from zerver.lib.streams import (
-    access_stream_by_id,
-    access_stream_by_name,
-    access_stream_for_unmute_topic_by_id,
-    access_stream_for_unmute_topic_by_name,
-    check_for_exactly_one_stream_arg,
-)
 from zerver.lib.user_mutes import get_mute_object
-from zerver.lib.user_topics import topic_is_muted
 from zerver.lib.users import access_user_by_id
-from zerver.lib.validator import check_int, check_string_in
 from zerver.models import UserProfile
 
 
-def mute_topic(
-    user_profile: UserProfile,
-    stream_id: Optional[int],
-    stream_name: Optional[str],
-    topic_name: str,
-    date_muted: datetime.datetime,
-) -> None:
-    if stream_name is not None:
-        (stream, sub) = access_stream_by_name(user_profile, stream_name)
-    else:
-        assert stream_id is not None
-        (stream, sub) = access_stream_by_id(user_profile, stream_id)
-
-    if topic_is_muted(user_profile, stream.id, topic_name):
-        raise JsonableError(_("Topic already muted"))
-
-    try:
-        do_mute_topic(user_profile, stream, topic_name, date_muted)
-    except IntegrityError:
-        raise JsonableError(_("Topic already muted"))
-
-
-def unmute_topic(
-    user_profile: UserProfile,
-    stream_id: Optional[int],
-    stream_name: Optional[str],
-    topic_name: str,
-) -> None:
-    error = _("Topic is not muted")
-
-    if stream_name is not None:
-        stream = access_stream_for_unmute_topic_by_name(user_profile, stream_name, error)
-    else:
-        assert stream_id is not None
-        stream = access_stream_for_unmute_topic_by_id(user_profile, stream_id, error)
-
-    do_unmute_topic(user_profile, stream, topic_name)
-
-
-@has_request_variables
-def update_muted_topic(
-    request: HttpRequest,
-    user_profile: UserProfile,
-    stream_id: Optional[int] = REQ(json_validator=check_int, default=None),
-    stream: Optional[str] = REQ(default=None),
-    topic: str = REQ(),
-    op: str = REQ(str_validator=check_string_in(["add", "remove"])),
-) -> HttpResponse:
-    check_for_exactly_one_stream_arg(stream_id=stream_id, stream=stream)
-
-    if op == "add":
-        mute_topic(
-            user_profile=user_profile,
-            stream_id=stream_id,
-            stream_name=stream,
-            topic_name=topic,
-            date_muted=timezone_now(),
-        )
-    elif op == "remove":
-        unmute_topic(
-            user_profile=user_profile,
-            stream_id=stream_id,
-            stream_name=stream,
-            topic_name=topic,
-        )
-    return json_success(request)
-
-
 def mute_user(request: HttpRequest, user_profile: UserProfile, muted_user_id: int) -> HttpResponse:
     if user_profile.id == muted_user_id:
         raise JsonableError(_("Cannot mute self"))

zerver/views/user_topics.py

@@ -0,0 +1,90 @@
+import datetime
+from typing import Optional
+
+from django.db import IntegrityError
+from django.http import HttpRequest, HttpResponse
+from django.utils.timezone import now as timezone_now
+from django.utils.translation import gettext as _
+
+from zerver.actions.user_topics import do_mute_topic, do_unmute_topic
+from zerver.lib.exceptions import JsonableError
+from zerver.lib.request import REQ, has_request_variables
+from zerver.lib.response import json_success
+from zerver.lib.streams import (
+    access_stream_by_id,
+    access_stream_by_name,
+    access_stream_for_unmute_topic_by_id,
+    access_stream_for_unmute_topic_by_name,
+    check_for_exactly_one_stream_arg,
+)
+from zerver.lib.user_topics import topic_is_muted
+from zerver.lib.validator import check_int, check_string_in
+from zerver.models import UserProfile
+
+
+def mute_topic(
+    user_profile: UserProfile,
+    stream_id: Optional[int],
+    stream_name: Optional[str],
+    topic_name: str,
+    date_muted: datetime.datetime,
+) -> None:
+    if stream_name is not None:
+        (stream, sub) = access_stream_by_name(user_profile, stream_name)
+    else:
+        assert stream_id is not None
+        (stream, sub) = access_stream_by_id(user_profile, stream_id)
+
+    if topic_is_muted(user_profile, stream.id, topic_name):
+        raise JsonableError(_("Topic already muted"))
+
+    try:
+        do_mute_topic(user_profile, stream, topic_name, date_muted)
+    except IntegrityError:
+        raise JsonableError(_("Topic already muted"))
+
+
+def unmute_topic(
+    user_profile: UserProfile,
+    stream_id: Optional[int],
+    stream_name: Optional[str],
+    topic_name: str,
+) -> None:
+    error = _("Topic is not muted")
+
+    if stream_name is not None:
+        stream = access_stream_for_unmute_topic_by_name(user_profile, stream_name, error)
+    else:
+        assert stream_id is not None
+        stream = access_stream_for_unmute_topic_by_id(user_profile, stream_id, error)
+
+    do_unmute_topic(user_profile, stream, topic_name)
+
+
+@has_request_variables
+def update_muted_topic(
+    request: HttpRequest,
+    user_profile: UserProfile,
+    stream_id: Optional[int] = REQ(json_validator=check_int, default=None),
+    stream: Optional[str] = REQ(default=None),
+    topic: str = REQ(),
+    op: str = REQ(str_validator=check_string_in(["add", "remove"])),
+) -> HttpResponse:
+    check_for_exactly_one_stream_arg(stream_id=stream_id, stream=stream)
+
+    if op == "add":
+        mute_topic(
+            user_profile=user_profile,
+            stream_id=stream_id,
+            stream_name=stream,
+            topic_name=topic,
+            date_muted=timezone_now(),
+        )
+    elif op == "remove":
+        unmute_topic(
+            user_profile=user_profile,
+            stream_id=stream_id,
+            stream_name=stream,
+            topic_name=topic,
+        )
+    return json_success(request)

zproject/urls.py

@@ -79,7 +79,7 @@ from zerver.views.message_flags import (
     update_message_flags_for_narrow,
 )
 from zerver.views.message_send import render_message_backend, send_message_backend, zcommand_backend
-from zerver.views.muting import mute_user, unmute_user, update_muted_topic
+from zerver.views.muting import mute_user, unmute_user
 from zerver.views.presence import (
     get_presence_backend,
     get_statuses_for_realm,
@@ -190,6 +190,7 @@ from zerver.views.user_settings import (
     regenerate_api_key,
     set_avatar_backend,
 )
+from zerver.views.user_topics import update_muted_topic
 from zerver.views.users import (
     add_bot_backend,
     avatar,