diff --git a/analytics/urls.py b/analytics/urls.py index 62fc35c5a5..fd62887f2a 100644 --- a/analytics/urls.py +++ b/analytics/urls.py @@ -35,16 +35,16 @@ i18n_urlpatterns = [ v1_api_and_json_patterns = [ # get data for the graphs at /stats path('analytics/chart_data', rest_dispatch, - {'GET': 'analytics.views.get_chart_data'}), + {'GET': analytics.views.get_chart_data}), path('analytics/chart_data/realm/', rest_dispatch, - {'GET': 'analytics.views.get_chart_data_for_realm'}), + {'GET': analytics.views.get_chart_data_for_realm}), path('analytics/chart_data/installation', rest_dispatch, - {'GET': 'analytics.views.get_chart_data_for_installation'}), + {'GET': analytics.views.get_chart_data_for_installation}), path('analytics/chart_data/remote//installation', rest_dispatch, - {'GET': 'analytics.views.get_chart_data_for_remote_installation'}), + {'GET': analytics.views.get_chart_data_for_remote_installation}), path('analytics/chart_data/remote//realm/', rest_dispatch, - {'GET': 'analytics.views.get_chart_data_for_remote_realm'}), + {'GET': analytics.views.get_chart_data_for_remote_realm}), ] i18n_urlpatterns += [ diff --git a/corporate/urls.py b/corporate/urls.py index 9019dc8eae..69df9bba56 100644 --- a/corporate/urls.py +++ b/corporate/urls.py @@ -21,13 +21,13 @@ i18n_urlpatterns: Any = [ v1_api_and_json_patterns = [ path('billing/upgrade', rest_dispatch, - {'POST': 'corporate.views.upgrade'}), + {'POST': corporate.views.upgrade}), path('billing/sponsorship', rest_dispatch, - {'POST': 'corporate.views.sponsorship'}), + {'POST': corporate.views.sponsorship}), path('billing/plan/change', rest_dispatch, - {'POST': 'corporate.views.change_plan_status'}), + {'POST': corporate.views.change_plan_status}), path('billing/sources/change', rest_dispatch, - {'POST': 'corporate.views.replace_payment_source'}), + {'POST': corporate.views.replace_payment_source}), ] # Make a copy of i18n_urlpatterns so that they appear without prefix for English diff --git a/docs/tutorials/life-of-a-request.md b/docs/tutorials/life-of-a-request.md index 9a5c83b494..8f278ba5f8 100644 --- a/docs/tutorials/life-of-a-request.md +++ b/docs/tutorials/life-of-a-request.md @@ -140,9 +140,9 @@ yields a response with this HTTP header: We can see this reflected in [zproject/urls.py](https://github.com/zulip/zulip/blob/master/zproject/urls.py): - path('users', 'zerver.lib.rest.rest_dispatch', - {'GET': 'zerver.views.users.get_members_backend', - 'PUT': 'zerver.views.users.create_user_backend'}), + path('users', zerver.lib.rest.rest_dispatch, + {'GET': zerver.views.users.get_members_backend, + 'PUT': zerver.views.users.create_user_backend}), In this way, the API is partially self-documenting. @@ -176,8 +176,8 @@ the request, and then figure out which view to show from that. In our example, ``` -{'GET': 'zerver.views.users.get_members_backend', - 'PUT': 'zerver.views.users.create_user_backend'} +{'GET': zerver.views.users.get_members_backend, + 'PUT': zerver.views.users.create_user_backend} ``` is supplied as an argument to `rest_dispatch`, along with the diff --git a/zerver/lib/rest.py b/zerver/lib/rest.py index f0d36326f8..15caa204dd 100644 --- a/zerver/lib/rest.py +++ b/zerver/lib/rest.py @@ -3,7 +3,6 @@ from typing import Any, Dict, cast from django.http import HttpRequest, HttpResponse from django.utils.cache import add_never_cache_headers -from django.utils.module_loading import import_string from django.views.decorators.csrf import csrf_exempt, csrf_protect from zerver.decorator import ( @@ -90,9 +89,8 @@ def rest_dispatch(request: HttpRequest, **kwargs: Any) -> HttpResponse: entry = supported_methods[method_to_use] if isinstance(entry, tuple): target_function, view_flags = entry - target_function = import_string(target_function) else: - target_function = import_string(supported_methods[method_to_use]) + target_function = supported_methods[method_to_use] view_flags = set() # Set request._query for update_activity_user(), which is called diff --git a/zerver/tests/test_openapi.py b/zerver/tests/test_openapi.py index 0d0a76b591..3c56d47658 100644 --- a/zerver/tests/test_openapi.py +++ b/zerver/tests/test_openapi.py @@ -23,6 +23,7 @@ from django.http import HttpResponse from jsonschema.exceptions import ValidationError from zerver.lib.request import _REQ, arguments_map +from zerver.lib.rest import rest_dispatch from zerver.lib.test_classes import ZulipTestCase from zerver.openapi.markdown_extension import ( generate_curl_example, @@ -43,6 +44,7 @@ from zerver.openapi.openapi import ( validate_request, validate_schema, ) +from zerver.tornado.views import get_events, get_events_backend TEST_ENDPOINT = '/messages/{message_id}' TEST_METHOD = 'patch' @@ -544,10 +546,10 @@ do not match the types declared in the implementation of {function.__name__}.\n" # for those using the rest_dispatch decorator; we then parse # its mapping of (HTTP_METHOD -> FUNCTION). for p in urlconf.v1_api_and_json_patterns + urlconf.v1_api_mobile_patterns: - if p.lookup_str != 'zerver.lib.rest.rest_dispatch': + if p.callback is not rest_dispatch: # Endpoints not using rest_dispatch don't have extra data. methods_endpoints = dict( - GET=p.lookup_str, + GET=p.callback, ) else: methods_endpoints = p.default_args @@ -555,13 +557,13 @@ do not match the types declared in the implementation of {function.__name__}.\n" # since the module was already imported and is now residing in # memory, we won't actually face any performance penalties here. for method, value in methods_endpoints.items(): - if isinstance(value, str): - function_name = value + if callable(value): + function: Callable[..., HttpResponse] = value tags: Set[str] = set() else: - function_name, tags = value + function, tags = value - if function_name == 'zerver.tornado.views.get_events': + if function is get_events: # Work around the fact that the registered # get_events view function isn't where we do # @has_request_variables. @@ -569,11 +571,9 @@ do not match the types declared in the implementation of {function.__name__}.\n" # TODO: Make this configurable via an optional argument # to has_request_variables, e.g. # @has_request_variables(view_func_name="zerver.tornado.views.get_events") - function_name = 'zerver.tornado.views.get_events_backend' + function = get_events_backend - lookup_parts = function_name.split('.') - module = __import__('.'.join(lookup_parts[:-1]), {}, {}, ['']) - function = getattr(module, lookup_parts[-1]) + function_name = f"{function.__module__}.{function.__name__}" # Our accounting logic in the `has_request_variables()` # code means we have the list of all arguments diff --git a/zerver/tests/test_urls.py b/zerver/tests/test_urls.py index 1c4ce85a73..28711c4225 100644 --- a/zerver/tests/test_urls.py +++ b/zerver/tests/test_urls.py @@ -108,17 +108,6 @@ class URLResolutionTest(ZulipTestCase): module = importlib.import_module(module_name) self.assertTrue(hasattr(module, view), f"View {module_name}.{view} does not exist") - # Tests that all views in urls.v1_api_and_json_patterns exist - def test_rest_api_url_resolution(self) -> None: - for pattern in urls.v1_api_and_json_patterns: - callback_str = self.get_callback_string(pattern) - if callback_str and hasattr(pattern, "default_args"): - for func_string in pattern.default_args.values(): - if isinstance(func_string, tuple): - func_string = func_string[0] - module_name, view = func_string.rsplit('.', 1) - self.check_function_exists(module_name, view) - # Tests function-based views declared in urls.urlpatterns for # whether the function exists. We at present do not test the # class-based views. diff --git a/zilencer/urls.py b/zilencer/urls.py index e65ba66c39..5a89b56d5e 100644 --- a/zilencer/urls.py +++ b/zilencer/urls.py @@ -11,22 +11,22 @@ i18n_urlpatterns: Any = [] # Zilencer views following the REST API style v1_api_and_json_patterns = [ path('remotes/push/register', rest_dispatch, - {'POST': 'zilencer.views.register_remote_push_device'}), + {'POST': zilencer.views.register_remote_push_device}), path('remotes/push/unregister', rest_dispatch, - {'POST': 'zilencer.views.unregister_remote_push_device'}), + {'POST': zilencer.views.unregister_remote_push_device}), path('remotes/push/unregister/all', rest_dispatch, - {'POST': 'zilencer.views.unregister_all_remote_push_devices'}), + {'POST': zilencer.views.unregister_all_remote_push_devices}), path('remotes/push/notify', rest_dispatch, - {'POST': 'zilencer.views.remote_server_notify_push'}), + {'POST': zilencer.views.remote_server_notify_push}), # Push signup doesn't use the REST API, since there's no auth. path('remotes/server/register', zilencer.views.register_remote_server), # For receiving table data used in analytics and billing path('remotes/server/analytics', rest_dispatch, - {'POST': 'zilencer.views.remote_server_post_analytics'}), + {'POST': zilencer.views.remote_server_post_analytics}), path('remotes/server/analytics/status', rest_dispatch, - {'GET': 'zilencer.views.remote_server_check_analytics'}), + {'GET': zilencer.views.remote_server_check_analytics}), ] urlpatterns = [ diff --git a/zproject/urls.py b/zproject/urls.py index 3267239696..f67a713a80 100644 --- a/zproject/urls.py +++ b/zproject/urls.py @@ -15,25 +15,45 @@ from django.views.generic import RedirectView, TemplateView import zerver.forms import zerver.tornado.views -import zerver.views +import zerver.views.alert_words import zerver.views.archive +import zerver.views.attachments import zerver.views.auth import zerver.views.camo import zerver.views.compatibility +import zerver.views.custom_profile_fields import zerver.views.digest import zerver.views.documentation +import zerver.views.drafts import zerver.views.email_mirror +import zerver.views.events_register import zerver.views.home +import zerver.views.hotspots +import zerver.views.invite import zerver.views.message_edit import zerver.views.message_fetch import zerver.views.message_flags import zerver.views.message_send import zerver.views.muting import zerver.views.portico +import zerver.views.presence +import zerver.views.push_notifications +import zerver.views.reactions import zerver.views.realm +import zerver.views.realm_domains +import zerver.views.realm_emoji import zerver.views.realm_export +import zerver.views.realm_filters +import zerver.views.realm_icon +import zerver.views.realm_logo import zerver.views.registration +import zerver.views.report +import zerver.views.storage import zerver.views.streams +import zerver.views.submessage +import zerver.views.thumbnail +import zerver.views.tutorial +import zerver.views.typing import zerver.views.unsubscribe import zerver.views.upload import zerver.views.user_groups @@ -77,7 +97,7 @@ if settings.TWO_FACTOR_AUTHENTICATION_ENABLED: v1_api_and_json_patterns = [ # realm-level calls path('realm', rest_dispatch, - {'PATCH': 'zerver.views.realm.update_realm'}), + {'PATCH': zerver.views.realm.update_realm}), # Returns a 204, used by desktop app to verify connectivity status path('generate_204', zerver.views.registration.generate_204), @@ -86,144 +106,144 @@ v1_api_and_json_patterns = [ # realm/domains -> zerver.views.realm_domains path('realm/domains', rest_dispatch, - {'GET': 'zerver.views.realm_domains.list_realm_domains', - 'POST': 'zerver.views.realm_domains.create_realm_domain'}), + {'GET': zerver.views.realm_domains.list_realm_domains, + 'POST': zerver.views.realm_domains.create_realm_domain}), path('realm/domains/', rest_dispatch, - {'PATCH': 'zerver.views.realm_domains.patch_realm_domain', - 'DELETE': 'zerver.views.realm_domains.delete_realm_domain'}), + {'PATCH': zerver.views.realm_domains.patch_realm_domain, + 'DELETE': zerver.views.realm_domains.delete_realm_domain}), # realm/emoji -> zerver.views.realm_emoji path('realm/emoji', rest_dispatch, - {'GET': 'zerver.views.realm_emoji.list_emoji'}), + {'GET': zerver.views.realm_emoji.list_emoji}), path('realm/emoji/', rest_dispatch, - {'POST': 'zerver.views.realm_emoji.upload_emoji', - 'DELETE': ('zerver.views.realm_emoji.delete_emoji', {"intentionally_undocumented"})}), + {'POST': zerver.views.realm_emoji.upload_emoji, + 'DELETE': (zerver.views.realm_emoji.delete_emoji, {"intentionally_undocumented"})}), # this endpoint throws a status code 400 JsonableError when it should be a 404. # realm/icon -> zerver.views.realm_icon path('realm/icon', rest_dispatch, - {'POST': 'zerver.views.realm_icon.upload_icon', - 'DELETE': 'zerver.views.realm_icon.delete_icon_backend', - 'GET': 'zerver.views.realm_icon.get_icon_backend'}), + {'POST': zerver.views.realm_icon.upload_icon, + 'DELETE': zerver.views.realm_icon.delete_icon_backend, + 'GET': zerver.views.realm_icon.get_icon_backend}), # realm/logo -> zerver.views.realm_logo path('realm/logo', rest_dispatch, - {'POST': 'zerver.views.realm_logo.upload_logo', - 'DELETE': 'zerver.views.realm_logo.delete_logo_backend', - 'GET': 'zerver.views.realm_logo.get_logo_backend'}), + {'POST': zerver.views.realm_logo.upload_logo, + 'DELETE': zerver.views.realm_logo.delete_logo_backend, + 'GET': zerver.views.realm_logo.get_logo_backend}), # realm/filters -> zerver.views.realm_filters path('realm/filters', rest_dispatch, - {'GET': 'zerver.views.realm_filters.list_filters', - 'POST': 'zerver.views.realm_filters.create_filter'}), + {'GET': zerver.views.realm_filters.list_filters, + 'POST': zerver.views.realm_filters.create_filter}), path('realm/filters/', rest_dispatch, - {'DELETE': 'zerver.views.realm_filters.delete_filter'}), + {'DELETE': zerver.views.realm_filters.delete_filter}), # realm/profile_fields -> zerver.views.custom_profile_fields path('realm/profile_fields', rest_dispatch, - {'GET': 'zerver.views.custom_profile_fields.list_realm_custom_profile_fields', - 'PATCH': 'zerver.views.custom_profile_fields.reorder_realm_custom_profile_fields', - 'POST': 'zerver.views.custom_profile_fields.create_realm_custom_profile_field'}), + {'GET': zerver.views.custom_profile_fields.list_realm_custom_profile_fields, + 'PATCH': zerver.views.custom_profile_fields.reorder_realm_custom_profile_fields, + 'POST': zerver.views.custom_profile_fields.create_realm_custom_profile_field}), path('realm/profile_fields/', rest_dispatch, - {'PATCH': 'zerver.views.custom_profile_fields.update_realm_custom_profile_field', - 'DELETE': 'zerver.views.custom_profile_fields.delete_realm_custom_profile_field'}), + {'PATCH': zerver.views.custom_profile_fields.update_realm_custom_profile_field, + 'DELETE': zerver.views.custom_profile_fields.delete_realm_custom_profile_field}), # realm/deactivate -> zerver.views.deactivate_realm path('realm/deactivate', rest_dispatch, - {'POST': 'zerver.views.realm.deactivate_realm'}), + {'POST': zerver.views.realm.deactivate_realm}), # users -> zerver.views.users path('users', rest_dispatch, - {'GET': 'zerver.views.users.get_members_backend', - 'POST': 'zerver.views.users.create_user_backend'}), + {'GET': zerver.views.users.get_members_backend, + 'POST': zerver.views.users.create_user_backend}), path('users/me', rest_dispatch, - {'GET': 'zerver.views.users.get_profile_backend', - 'DELETE': 'zerver.views.users.deactivate_user_own_backend'}), + {'GET': zerver.views.users.get_profile_backend, + 'DELETE': zerver.views.users.deactivate_user_own_backend}), path('users//reactivate', rest_dispatch, - {'POST': 'zerver.views.users.reactivate_user_backend'}), + {'POST': zerver.views.users.reactivate_user_backend}), path('users/', rest_dispatch, - {'GET': 'zerver.views.users.get_members_backend', - 'PATCH': 'zerver.views.users.update_user_backend', - 'DELETE': 'zerver.views.users.deactivate_user_backend'}), + {'GET': zerver.views.users.get_members_backend, + 'PATCH': zerver.views.users.update_user_backend, + 'DELETE': zerver.views.users.deactivate_user_backend}), path('users//subscriptions/', rest_dispatch, - {'GET': 'zerver.views.users.get_subscription_backend'}), + {'GET': zerver.views.users.get_subscription_backend}), path('bots', rest_dispatch, - {'GET': 'zerver.views.users.get_bots_backend', - 'POST': 'zerver.views.users.add_bot_backend'}), + {'GET': zerver.views.users.get_bots_backend, + 'POST': zerver.views.users.add_bot_backend}), path('bots//api_key/regenerate', rest_dispatch, - {'POST': 'zerver.views.users.regenerate_bot_api_key'}), + {'POST': zerver.views.users.regenerate_bot_api_key}), path('bots/', rest_dispatch, - {'PATCH': 'zerver.views.users.patch_bot_backend', - 'DELETE': 'zerver.views.users.deactivate_bot_backend'}), + {'PATCH': zerver.views.users.patch_bot_backend, + 'DELETE': zerver.views.users.deactivate_bot_backend}), # invites -> zerver.views.invite path('invites', rest_dispatch, - {'GET': 'zerver.views.invite.get_user_invites', - 'POST': 'zerver.views.invite.invite_users_backend'}), + {'GET': zerver.views.invite.get_user_invites, + 'POST': zerver.views.invite.invite_users_backend}), path('invites/', rest_dispatch, - {'DELETE': 'zerver.views.invite.revoke_user_invite'}), + {'DELETE': zerver.views.invite.revoke_user_invite}), path('invites//resend', rest_dispatch, - {'POST': 'zerver.views.invite.resend_user_invite_email'}), + {'POST': zerver.views.invite.resend_user_invite_email}), # invites/multiuse -> zerver.views.invite path('invites/multiuse', rest_dispatch, - {'POST': 'zerver.views.invite.generate_multiuse_invite_backend'}), + {'POST': zerver.views.invite.generate_multiuse_invite_backend}), # invites/multiuse -> zerver.views.invite path('invites/multiuse/', rest_dispatch, - {'DELETE': 'zerver.views.invite.revoke_multiuse_invite'}), + {'DELETE': zerver.views.invite.revoke_multiuse_invite}), # mark messages as read (in bulk) path('mark_all_as_read', rest_dispatch, - {'POST': 'zerver.views.message_flags.mark_all_as_read'}), + {'POST': zerver.views.message_flags.mark_all_as_read}), path('mark_stream_as_read', rest_dispatch, - {'POST': 'zerver.views.message_flags.mark_stream_as_read'}), + {'POST': zerver.views.message_flags.mark_stream_as_read}), path('mark_topic_as_read', rest_dispatch, - {'POST': 'zerver.views.message_flags.mark_topic_as_read'}), + {'POST': zerver.views.message_flags.mark_topic_as_read}), path('zcommand', rest_dispatch, - {'POST': 'zerver.views.message_send.zcommand_backend'}), + {'POST': zerver.views.message_send.zcommand_backend}), # Endpoints for syncing drafts. path('drafts', rest_dispatch, - {'GET': ('zerver.views.drafts.fetch_drafts', + {'GET': (zerver.views.drafts.fetch_drafts, {'intentionally_undocumented'}), - 'POST': ('zerver.views.drafts.create_drafts', + 'POST': (zerver.views.drafts.create_drafts, {'intentionally_undocumented'})}), path('drafts/', rest_dispatch, - {'PATCH': ('zerver.views.drafts.edit_draft', + {'PATCH': (zerver.views.drafts.edit_draft, {'intentionally_undocumented'}), - 'DELETE': ('zerver.views.drafts.delete_draft', + 'DELETE': (zerver.views.drafts.delete_draft, {'intentionally_undocumented'})}), # messages -> zerver.views.message* # GET returns messages, possibly filtered, POST sends a message path('messages', rest_dispatch, - {'GET': ('zerver.views.message_fetch.get_messages_backend', + {'GET': (zerver.views.message_fetch.get_messages_backend, {'allow_anonymous_user_web'}), - 'POST': ('zerver.views.message_send.send_message_backend', + 'POST': (zerver.views.message_send.send_message_backend, {'allow_incoming_webhooks'})}), path('messages/', rest_dispatch, - {'GET': 'zerver.views.message_edit.json_fetch_raw_message', - 'PATCH': 'zerver.views.message_edit.update_message_backend', - 'DELETE': 'zerver.views.message_edit.delete_message_backend'}), + {'GET': zerver.views.message_edit.json_fetch_raw_message, + 'PATCH': zerver.views.message_edit.update_message_backend, + 'DELETE': zerver.views.message_edit.delete_message_backend}), path('messages/render', rest_dispatch, - {'POST': 'zerver.views.message_send.render_message_backend'}), + {'POST': zerver.views.message_send.render_message_backend}), path('messages/flags', rest_dispatch, - {'POST': 'zerver.views.message_flags.update_message_flags'}), + {'POST': zerver.views.message_flags.update_message_flags}), path('messages//history', rest_dispatch, - {'GET': 'zerver.views.message_edit.get_message_edit_history'}), + {'GET': zerver.views.message_edit.get_message_edit_history}), path('messages/matches_narrow', rest_dispatch, - {'GET': 'zerver.views.message_fetch.messages_in_narrow_backend'}), + {'GET': zerver.views.message_fetch.messages_in_narrow_backend}), path('users/me/subscriptions/properties', rest_dispatch, - {'POST': 'zerver.views.streams.update_subscription_properties_backend'}), + {'POST': zerver.views.streams.update_subscription_properties_backend}), path('users/me/subscriptions/', rest_dispatch, - {'PATCH': 'zerver.views.streams.update_subscriptions_property'}), + {'PATCH': zerver.views.streams.update_subscriptions_property}), path('submessage', rest_dispatch, - {'POST': 'zerver.views.submessage.process_submessage'}), + {'POST': zerver.views.submessage.process_submessage}), # New endpoint for handling reactions. # reactions -> zerver.view.reactions @@ -231,164 +251,164 @@ v1_api_and_json_patterns = [ # DELETE removes a reaction from a message path('messages//reactions', rest_dispatch, - {'POST': 'zerver.views.reactions.add_reaction', - 'DELETE': 'zerver.views.reactions.remove_reaction'}), + {'POST': zerver.views.reactions.add_reaction, + 'DELETE': zerver.views.reactions.remove_reaction}), # attachments -> zerver.views.attachments path('attachments', rest_dispatch, - {'GET': 'zerver.views.attachments.list_by_user'}), + {'GET': zerver.views.attachments.list_by_user}), path('attachments/', rest_dispatch, - {'DELETE': 'zerver.views.attachments.remove'}), + {'DELETE': zerver.views.attachments.remove}), # typing -> zerver.views.typing # POST sends a typing notification event to recipients path('typing', rest_dispatch, - {'POST': 'zerver.views.typing.send_notification_backend'}), + {'POST': zerver.views.typing.send_notification_backend}), # user_uploads -> zerver.views.upload path('user_uploads', rest_dispatch, - {'POST': 'zerver.views.upload.upload_file_backend'}), + {'POST': zerver.views.upload.upload_file_backend}), path('user_uploads//', rest_dispatch, - {'GET': ('zerver.views.upload.serve_file_url_backend', + {'GET': (zerver.views.upload.serve_file_url_backend, {'override_api_url_scheme'})}), # bot_storage -> zerver.views.storage path('bot_storage', rest_dispatch, - {'PUT': 'zerver.views.storage.update_storage', - 'GET': 'zerver.views.storage.get_storage', - 'DELETE': 'zerver.views.storage.remove_storage'}), + {'PUT': zerver.views.storage.update_storage, + 'GET': zerver.views.storage.get_storage, + 'DELETE': zerver.views.storage.remove_storage}), # Endpoint used by mobile devices to register their push # notification credentials path('users/me/apns_device_token', rest_dispatch, - {'POST': 'zerver.views.push_notifications.add_apns_device_token', - 'DELETE': 'zerver.views.push_notifications.remove_apns_device_token'}), + {'POST': zerver.views.push_notifications.add_apns_device_token, + 'DELETE': zerver.views.push_notifications.remove_apns_device_token}), path('users/me/android_gcm_reg_id', rest_dispatch, - {'POST': 'zerver.views.push_notifications.add_android_reg_id', - 'DELETE': 'zerver.views.push_notifications.remove_android_reg_id'}), + {'POST': zerver.views.push_notifications.add_android_reg_id, + 'DELETE': zerver.views.push_notifications.remove_android_reg_id}), # users/*/presnece => zerver.views.presence. path('users/me/presence', rest_dispatch, - {'POST': 'zerver.views.presence.update_active_status_backend'}), + {'POST': zerver.views.presence.update_active_status_backend}), # It's important that this sit after users/me/presence so that # Django's URL resolution order doesn't break the # /users/me/presence endpoint. path(r'users//presence', rest_dispatch, - {'GET': 'zerver.views.presence.get_presence_backend'}), + {'GET': zerver.views.presence.get_presence_backend}), path('realm/presence', rest_dispatch, - {'GET': 'zerver.views.presence.get_statuses_for_realm'}), + {'GET': zerver.views.presence.get_statuses_for_realm}), path('users/me/status', rest_dispatch, - {'POST': 'zerver.views.presence.update_user_status_backend'}), + {'POST': zerver.views.presence.update_user_status_backend}), # user_groups -> zerver.views.user_groups path('user_groups', rest_dispatch, - {'GET': 'zerver.views.user_groups.get_user_group'}), + {'GET': zerver.views.user_groups.get_user_group}), path('user_groups/create', rest_dispatch, - {'POST': 'zerver.views.user_groups.add_user_group'}), + {'POST': zerver.views.user_groups.add_user_group}), path('user_groups/', rest_dispatch, - {'PATCH': 'zerver.views.user_groups.edit_user_group', - 'DELETE': 'zerver.views.user_groups.delete_user_group'}), + {'PATCH': zerver.views.user_groups.edit_user_group, + 'DELETE': zerver.views.user_groups.delete_user_group}), path('user_groups//members', rest_dispatch, - {'POST': 'zerver.views.user_groups.update_user_group_backend'}), + {'POST': zerver.views.user_groups.update_user_group_backend}), # users/me -> zerver.views.user_settings path('users/me/api_key/regenerate', rest_dispatch, - {'POST': 'zerver.views.user_settings.regenerate_api_key'}), + {'POST': zerver.views.user_settings.regenerate_api_key}), path('users/me/enter-sends', rest_dispatch, - {'POST': ('zerver.views.user_settings.change_enter_sends', + {'POST': (zerver.views.user_settings.change_enter_sends, # This endpoint should be folded into user settings {'intentionally_undocumented'})}), path('users/me/avatar', rest_dispatch, - {'POST': 'zerver.views.user_settings.set_avatar_backend', - 'DELETE': 'zerver.views.user_settings.delete_avatar_backend'}), + {'POST': zerver.views.user_settings.set_avatar_backend, + 'DELETE': zerver.views.user_settings.delete_avatar_backend}), # users/me/hotspots -> zerver.views.hotspots path('users/me/hotspots', rest_dispatch, - {'POST': ('zerver.views.hotspots.mark_hotspot_as_read', + {'POST': (zerver.views.hotspots.mark_hotspot_as_read, # This endpoint is low priority for documentation as # it is part of the webapp-specific tutorial. {'intentionally_undocumented'})}), # users/me/tutorial_status -> zerver.views.tutorial path('users/me/tutorial_status', rest_dispatch, - {'POST': ('zerver.views.tutorial.set_tutorial_status', + {'POST': (zerver.views.tutorial.set_tutorial_status, # This is a relic of an old Zulip tutorial model and # should be deleted. {'intentionally_undocumented'})}), # settings -> zerver.views.user_settings path('settings', rest_dispatch, - {'PATCH': 'zerver.views.user_settings.json_change_settings'}), + {'PATCH': zerver.views.user_settings.json_change_settings}), path('settings/display', rest_dispatch, - {'PATCH': 'zerver.views.user_settings.update_display_settings_backend'}), + {'PATCH': zerver.views.user_settings.update_display_settings_backend}), path('settings/notifications', rest_dispatch, - {'PATCH': 'zerver.views.user_settings.json_change_notify_settings'}), + {'PATCH': zerver.views.user_settings.json_change_notify_settings}), # users/me/alert_words -> zerver.views.alert_words path('users/me/alert_words', rest_dispatch, - {'GET': 'zerver.views.alert_words.list_alert_words', - 'POST': 'zerver.views.alert_words.add_alert_words', - 'DELETE': 'zerver.views.alert_words.remove_alert_words'}), + {'GET': zerver.views.alert_words.list_alert_words, + 'POST': zerver.views.alert_words.add_alert_words, + 'DELETE': zerver.views.alert_words.remove_alert_words}), # users/me/custom_profile_data -> zerver.views.custom_profile_data path('users/me/profile_data', rest_dispatch, - {'PATCH': 'zerver.views.custom_profile_fields.update_user_custom_profile_data', - 'DELETE': 'zerver.views.custom_profile_fields.remove_user_custom_profile_data'}), + {'PATCH': zerver.views.custom_profile_fields.update_user_custom_profile_data, + 'DELETE': zerver.views.custom_profile_fields.remove_user_custom_profile_data}), path('users/me//topics', rest_dispatch, - {'GET': ('zerver.views.streams.get_topics_backend', + {'GET': (zerver.views.streams.get_topics_backend, {'allow_anonymous_user_web'})}), # streams -> zerver.views.streams # (this API is only used externally) path('streams', rest_dispatch, - {'GET': 'zerver.views.streams.get_streams_backend'}), + {'GET': zerver.views.streams.get_streams_backend}), # GET returns `stream_id`, stream name should be encoded in the url query (in `stream` param) path('get_stream_id', rest_dispatch, - {'GET': 'zerver.views.streams.json_get_stream_id'}), + {'GET': zerver.views.streams.json_get_stream_id}), # GET returns "stream info" (undefined currently?), HEAD returns whether stream exists (200 or 404) path('streams//members', rest_dispatch, - {'GET': 'zerver.views.streams.get_subscribers_backend'}), + {'GET': zerver.views.streams.get_subscribers_backend}), path('streams/', rest_dispatch, - {'PATCH': 'zerver.views.streams.update_stream_backend', - 'DELETE': 'zerver.views.streams.deactivate_stream_backend'}), + {'PATCH': zerver.views.streams.update_stream_backend, + 'DELETE': zerver.views.streams.deactivate_stream_backend}), # Delete topic in stream path('streams//delete_topic', rest_dispatch, - {'POST': 'zerver.views.streams.delete_in_topic'}), + {'POST': zerver.views.streams.delete_in_topic}), path('default_streams', rest_dispatch, - {'POST': 'zerver.views.streams.add_default_stream', - 'DELETE': 'zerver.views.streams.remove_default_stream'}), + {'POST': zerver.views.streams.add_default_stream, + 'DELETE': zerver.views.streams.remove_default_stream}), path('default_stream_groups/create', rest_dispatch, - {'POST': 'zerver.views.streams.create_default_stream_group'}), + {'POST': zerver.views.streams.create_default_stream_group}), path('default_stream_groups/', rest_dispatch, - {'PATCH': 'zerver.views.streams.update_default_stream_group_info', - 'DELETE': 'zerver.views.streams.remove_default_stream_group'}), + {'PATCH': zerver.views.streams.update_default_stream_group_info, + 'DELETE': zerver.views.streams.remove_default_stream_group}), path('default_stream_groups//streams', rest_dispatch, - {'PATCH': 'zerver.views.streams.update_default_stream_group_streams'}), + {'PATCH': zerver.views.streams.update_default_stream_group_streams}), # GET lists your streams, POST bulk adds, PATCH bulk modifies/removes path('users/me/subscriptions', rest_dispatch, - {'GET': 'zerver.views.streams.list_subscriptions_backend', - 'POST': 'zerver.views.streams.add_subscriptions_backend', - 'PATCH': 'zerver.views.streams.update_subscriptions_backend', - 'DELETE': 'zerver.views.streams.remove_subscriptions_backend'}), + {'GET': zerver.views.streams.list_subscriptions_backend, + 'POST': zerver.views.streams.add_subscriptions_backend, + 'PATCH': zerver.views.streams.update_subscriptions_backend, + 'DELETE': zerver.views.streams.remove_subscriptions_backend}), # muting -> zerver.views.muting path('users/me/subscriptions/muted_topics', rest_dispatch, - {'PATCH': 'zerver.views.muting.update_muted_topic'}), + {'PATCH': zerver.views.muting.update_muted_topic}), # used to register for an event queue in tornado path('register', rest_dispatch, - {'POST': 'zerver.views.events_register.events_register_backend'}), + {'POST': zerver.views.events_register.events_register_backend}), # events -> zerver.tornado.views path('events', rest_dispatch, - {'GET': 'zerver.tornado.views.get_events', - 'DELETE': 'zerver.tornado.views.cleanup_event_queue'}), + {'GET': zerver.tornado.views.get_events, + 'DELETE': zerver.tornado.views.cleanup_event_queue}), # report -> zerver.views.report # @@ -397,30 +417,30 @@ v1_api_and_json_patterns = [ # include in our API documentation. path('report/error', rest_dispatch, # Logged-out browsers can hit this endpoint, for portico page JS exceptions. - {'POST': ('zerver.views.report.report_error', {'allow_anonymous_user_web', - 'intentionally_undocumented'})}), + {'POST': (zerver.views.report.report_error, {'allow_anonymous_user_web', + 'intentionally_undocumented'})}), path('report/send_times', rest_dispatch, - {'POST': ('zerver.views.report.report_send_times', {'intentionally_undocumented'})}), + {'POST': (zerver.views.report.report_send_times, {'intentionally_undocumented'})}), path('report/narrow_times', rest_dispatch, - {'POST': ('zerver.views.report.report_narrow_times', {'allow_anonymous_user_web', - 'intentionally_undocumented'})}), + {'POST': (zerver.views.report.report_narrow_times, {'allow_anonymous_user_web', + 'intentionally_undocumented'})}), path('report/unnarrow_times', rest_dispatch, - {'POST': ('zerver.views.report.report_unnarrow_times', {'allow_anonymous_user_web', - 'intentionally_undocumented'})}), + {'POST': (zerver.views.report.report_unnarrow_times, {'allow_anonymous_user_web', + 'intentionally_undocumented'})}), # Used to generate a Zoom video call URL path('calls/zoom/create', rest_dispatch, - {'POST': 'zerver.views.video_calls.make_zoom_video_call'}), + {'POST': zerver.views.video_calls.make_zoom_video_call}), # Used to generate a Big Blue Button video call URL path('calls/bigbluebutton/create', rest_dispatch, - {'GET': 'zerver.views.video_calls.get_bigbluebutton_url'}), + {'GET': zerver.views.video_calls.get_bigbluebutton_url}), # export/realm -> zerver.views.realm_export path('export/realm', rest_dispatch, - {'POST': 'zerver.views.realm_export.export_realm', - 'GET': 'zerver.views.realm_export.get_realm_exports'}), + {'POST': zerver.views.realm_export.export_realm, + 'GET': zerver.views.realm_export.get_realm_exports}), path('export/realm/', rest_dispatch, - {'DELETE': 'zerver.views.realm_export.delete_realm_export'}), + {'DELETE': zerver.views.realm_export.delete_realm_export}), ] integrations_view = IntegrationView.as_view() @@ -610,22 +630,22 @@ urls += [ name='local_file_unauthed'), path('user_uploads//', rest_dispatch, - {'GET': ('zerver.views.upload.serve_file_backend', + {'GET': (zerver.views.upload.serve_file_backend, {'override_api_url_scheme'})}), # This endpoint serves thumbnailed versions of images using thumbor; # it requires an exception for the same reason. path('thumbnail', rest_dispatch, - {'GET': ('zerver.views.thumbnail.backend_serve_thumbnail', + {'GET': (zerver.views.thumbnail.backend_serve_thumbnail, {'override_api_url_scheme'})}), # Avatars have the same constraint because their URLs are included # in API data structures used by both the mobile and web clients. path('avatar/', rest_dispatch, - {'GET': ('zerver.views.users.avatar', + {'GET': (zerver.views.users.avatar, {'override_api_url_scheme'})}), path('avatar//medium', rest_dispatch, - {'GET': ('zerver.views.users.avatar', + {'GET': (zerver.views.users.avatar, {'override_api_url_scheme'}), 'medium': True}), ] @@ -655,7 +675,7 @@ for incoming_webhook in WEBHOOK_INTEGRATIONS: # Desktop-specific authentication URLs urls += [ path('json/fetch_api_key', rest_dispatch, - {'POST': 'zerver.views.auth.json_fetch_api_key'}), + {'POST': zerver.views.auth.json_fetch_api_key}), ] # Mobile-specific authentication URLs