Skip to content

Commit 1974ad4

Browse files
committed
zulip: Standardize the names of bindings with OperationIDs.
Some bindings had names that differed from the names that were used in the OperationID. This commit deprecates the older names, and changes the names of the bindings to match operationIDs.
1 parent 285a946 commit 1974ad4

File tree

1 file changed

+96
-2
lines changed

1 file changed

+96
-2
lines changed

zulip/zulip/__init__.py

Lines changed: 96 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -951,6 +951,10 @@ def remove_reaction(self, reaction_data: Dict[str, Any]) -> Dict[str, Any]:
951951
)
952952

953953
def get_realm_emoji(self) -> Dict[str, Any]:
954+
logger.warning("get_realm_emoji() is deprecated." " Please use get_custom_emoji() instead.")
955+
return self.get_custom_emoji()
956+
957+
def get_custom_emoji(self) -> Dict[str, Any]:
954958
"""
955959
See examples/realm-emoji for example usage.
956960
"""
@@ -978,6 +982,12 @@ def delete_custom_emoji(self, emoji_name: str) -> Dict[str, Any]:
978982
)
979983

980984
def get_realm_linkifiers(self) -> Dict[str, Any]:
985+
logger.warning(
986+
"get_realm_linkifiers() is deprecated." " Please use get_linkifiers() instead."
987+
)
988+
return self.get_linkifiers()
989+
990+
def get_linkifiers(self) -> Dict[str, Any]:
981991
"""
982992
Example usage:
983993
@@ -1000,6 +1010,10 @@ def get_realm_linkifiers(self) -> Dict[str, Any]:
10001010
)
10011011

10021012
def add_realm_filter(self, pattern: str, url_format_string: str) -> Dict[str, Any]:
1013+
logger.warning("get_members() is deprecated." " Please use get_users() instead.")
1014+
self.add_linkifier(pattern, url_format_string)
1015+
1016+
def add_linkifier(self, pattern: str, url_format_string: str) -> Dict[str, Any]:
10031017
"""
10041018
Example usage:
10051019
@@ -1016,6 +1030,12 @@ def add_realm_filter(self, pattern: str, url_format_string: str) -> Dict[str, An
10161030
)
10171031

10181032
def remove_realm_filter(self, filter_id: int) -> Dict[str, Any]:
1033+
logger.warning(
1034+
"remove_realm_filter() is deprecated." " Please use remove_linkifier() instead."
1035+
)
1036+
return self.remove_linkifier(filter_id)
1037+
1038+
def remove_linkifier(self, filter_id: int) -> Dict[str, Any]:
10191039
"""
10201040
Example usage:
10211041
@@ -1028,6 +1048,11 @@ def remove_realm_filter(self, filter_id: int) -> Dict[str, Any]:
10281048
)
10291049

10301050
def get_realm_profile_fields(self) -> Dict[str, Any]:
1051+
logger.warning(
1052+
"get_realm_profile_fields() is deprecated." " Please use get_custom_profile_fields() instead."
1053+
)
1054+
return self.get_custom_profile_fields()
1055+
def get_custom_profile_fields(self) -> Dict[str, Any]:
10311056
"""
10321057
Example usage:
10331058
@@ -1039,7 +1064,14 @@ def get_realm_profile_fields(self) -> Dict[str, Any]:
10391064
method="GET",
10401065
)
10411066

1067+
10421068
def create_realm_profile_field(self, **request: Any) -> Dict[str, Any]:
1069+
logger.warning(
1070+
"create_realm_profile_field() is deprecated." " Please use create_custom_profile_field() instead."
1071+
)
1072+
return self.create_custom_profile_field(request)
1073+
1074+
def create_custom_profile_field(self, **request: Any) -> Dict[str, Any]:
10431075
"""
10441076
Example usage:
10451077
@@ -1065,6 +1097,12 @@ def remove_realm_profile_field(self, field_id: int) -> Dict[str, Any]:
10651097
)
10661098

10671099
def reorder_realm_profile_fields(self, **request: Any) -> Dict[str, Any]:
1100+
logger.warning(
1101+
"reorder_realm_profile_fields() is deprecated." " Please use reorder_custom_profile_fields() instead."
1102+
)
1103+
return self.reorder_custom_profile_fields(request)
1104+
1105+
def reorder_custom_profile_fields(self, **request: Any) -> Dict[str, Any]:
10681106
"""
10691107
Example usage:
10701108
@@ -1078,6 +1116,12 @@ def reorder_realm_profile_fields(self, **request: Any) -> Dict[str, Any]:
10781116
)
10791117

10801118
def update_realm_profile_field(self, field_id: int, **request: Any) -> Dict[str, Any]:
1119+
logger.warning(
1120+
"update_realm_profile_field() is deprecated." " Please use update_linkifier() instead."
1121+
)
1122+
return self.update_linkifier(field_id)
1123+
1124+
def update_linkifier(self, field_id: int, **request: Any) -> Dict[str, Any]:
10811125
"""
10821126
Example usage:
10831127
@@ -1118,6 +1162,17 @@ def register(
11181162
event_types: Optional[Iterable[str]] = None,
11191163
narrow: Optional[List[List[str]]] = None,
11201164
**kwargs: object,
1165+
) -> Dict[str, Any]:
1166+
logger.warning(
1167+
"register() is deprecated." " Please use register_queue() instead."
1168+
)
1169+
return self.register_queue(event_types, narrow)
1170+
1171+
def register_queue(
1172+
self,
1173+
event_types: Optional[Iterable[str]] = None,
1174+
narrow: Optional[List[List[str]]] = None,
1175+
**kwargs: object,
11211176
) -> Dict[str, Any]:
11221177
"""
11231178
Example usage:
@@ -1139,6 +1194,12 @@ def register(
11391194
)
11401195

11411196
def deregister(self, queue_id: str, timeout: Optional[float] = None) -> Dict[str, Any]:
1197+
logger.warning(
1198+
"deregister() is deprecated." " Please use delete_queue() instead."
1199+
)
1200+
return self.delete_queue(queue_id, timeout)
1201+
1202+
def delete_queue(self, queue_id: str, timeout: Optional[float] = None) -> Dict[str, Any]:
11421203
"""
11431204
Example usage:
11441205
@@ -1157,6 +1218,10 @@ def deregister(self, queue_id: str, timeout: Optional[float] = None) -> Dict[str
11571218
)
11581219

11591220
def get_profile(self, request: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
1221+
logger.warning("get_profile() is deprecated." " Please use get_own_user() instead.")
1222+
self.get_own_user(request)
1223+
1224+
def get_own_user(self, request: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
11601225
"""
11611226
Example usage:
11621227
@@ -1232,6 +1297,10 @@ def update_stream(self, stream_data: Dict[str, Any]) -> Dict[str, Any]:
12321297
)
12331298

12341299
def delete_stream(self, stream_id: int) -> Dict[str, Any]:
1300+
logger.warning("delete_stream() is deprecated." " Please use archive_stream() instead.")
1301+
return self.archive_stream(stream_id)
1302+
1303+
def archive_stream(self, stream_id: int) -> Dict[str, Any]:
12351304
"""
12361305
See examples/delete-stream for example usage.
12371306
"""
@@ -1255,6 +1324,10 @@ def add_default_stream(self, stream_id: int) -> Dict[str, Any]:
12551324
)
12561325

12571326
def get_user_by_id(self, user_id: int, **request: Any) -> Dict[str, Any]:
1327+
logger.warning("get_user_by_id() is deprecated." " Please use get_user() instead.")
1328+
return self.get_user(user_id)
1329+
1330+
def get_user(self, user_id: int, **request: Any) -> Dict[str, Any]:
12581331

12591332
"""
12601333
Example usage:
@@ -1269,6 +1342,10 @@ def get_user_by_id(self, user_id: int, **request: Any) -> Dict[str, Any]:
12691342
)
12701343

12711344
def deactivate_user_by_id(self, user_id: int) -> Dict[str, Any]:
1345+
logger.warning("deactivate_user_by_id() is deprecated." " Please use deactivate_user() instead.")
1346+
return self.deactivate_user(user_id)
1347+
1348+
def deactivate_user(self, user_id: int) -> Dict[str, Any]:
12721349

12731350
"""
12741351
Example usage:
@@ -1282,6 +1359,10 @@ def deactivate_user_by_id(self, user_id: int) -> Dict[str, Any]:
12821359
)
12831360

12841361
def reactivate_user_by_id(self, user_id: int) -> Dict[str, Any]:
1362+
logger.warning("reactivate_user_by_id() is deprecated." " Please use reactivate_user() instead.")
1363+
return self.reactivate_user(user_id)
1364+
1365+
def reactivate_user(self, user_id: int) -> Dict[str, Any]:
12851366

12861367
"""
12871368
Example usage:
@@ -1295,6 +1376,10 @@ def reactivate_user_by_id(self, user_id: int) -> Dict[str, Any]:
12951376
)
12961377

12971378
def update_user_by_id(self, user_id: int, **request: Any) -> Dict[str, Any]:
1379+
logger.warning("update_user_by_id() is deprecated." " Please use update_user() instead.")
1380+
return self.update_user(user_id, request)
1381+
1382+
def update_user(self, user_id: int, **request: Any) -> Dict[str, Any]:
12981383

12991384
"""
13001385
Example usage:
@@ -1321,8 +1406,7 @@ def get_users(self, request: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
13211406
def get_members(self, request: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
13221407
# This exists for backwards-compatibility; we renamed this
13231408
# function get_users for consistency with the rest of the API.
1324-
# Later, we may want to add a warning for clients using this
1325-
# legacy name.
1409+
logger.warning("get_members() is deprecated." " Please use get_users() instead.")
13261410
return self.get_users(request=request)
13271411

13281412
def get_alert_words(self) -> Dict[str, Any]:
@@ -1364,6 +1448,10 @@ def list_subscriptions(self, request: Optional[Dict[str, Any]] = None) -> Dict[s
13641448
return self.get_subscriptions(request)
13651449

13661450
def add_subscriptions(self, streams: Iterable[Dict[str, Any]], **kwargs: Any) -> Dict[str, Any]:
1451+
logger.warning("add_subscriptions() is deprecated." " Please use subscribe() instead.")
1452+
return self.subscribe(streams)
1453+
1454+
def subscribe(self, streams: Iterable[Dict[str, Any]], **kwargs: Any) -> Dict[str, Any]:
13671455
"""
13681456
See examples/subscribe for example usage.
13691457
"""
@@ -1376,6 +1464,12 @@ def add_subscriptions(self, streams: Iterable[Dict[str, Any]], **kwargs: Any) ->
13761464

13771465
def remove_subscriptions(
13781466
self, streams: Iterable[str], principals: Union[Sequence[str], Sequence[int]] = []
1467+
) -> Dict[str, Any]:
1468+
logger.warning("remove_subscriptions() is deprecated." " Please use unsubscribe() instead.")
1469+
return self.unsubscribe(streams, principals)
1470+
1471+
def unsubscribe(
1472+
self, streams: Iterable[str], principals: Union[Sequence[str], Sequence[int]] = []
13791473
) -> Dict[str, Any]:
13801474
"""
13811475
See examples/unsubscribe for example usage.

0 commit comments

Comments
 (0)