From fe2512e66273d13f54ef4b805827633973939a3e Mon Sep 17 00:00:00 2001 From: Ang Li Date: Wed, 7 Oct 2026 19:30:16 +0000 Subject: [PATCH] Remove deprecated snippet_event module `mobly.controllers.android_device_lib.snippet_event` has been a deprecated alias of `mobly.snippet.callback_event` since 1.12 (see CHANGELOG), emitting a DeprecationWarning on import. Its last siblings from that era (`jsonrpc_client_base`, `callback_handler`) were removed in #1037. Migration: `from mobly.snippet import callback_event` and `callback_event.CallbackEvent` / `callback_event.from_dict`; the class is identical. --- .../android_device_lib/snippet_event.py | 64 ------------------- .../android_device_lib/snippet_event_test.py | 40 ------------ 2 files changed, 104 deletions(-) delete mode 100644 mobly/controllers/android_device_lib/snippet_event.py delete mode 100755 tests/mobly/controllers/android_device_lib/snippet_event_test.py diff --git a/mobly/controllers/android_device_lib/snippet_event.py b/mobly/controllers/android_device_lib/snippet_event.py deleted file mode 100644 index 860335bfa..000000000 --- a/mobly/controllers/android_device_lib/snippet_event.py +++ /dev/null @@ -1,64 +0,0 @@ -# Copyright 2017 Google Inc. -# -# 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 - -logging.warning( - 'The module mobly.controllers.android_device_lib.snippet_event ' - 'is deprecated and will be removed in a future version. Use ' - 'module mobly.snippet.callback_event instead.' -) - - -def from_dict(event_dict): - """Create a SnippetEvent object from a dictionary. - - DEPRECATED: Use mobly.snippet.callback_event.from_dict instead. - - Args: - event_dict: a dictionary representing an event. - - Returns: - A SnippetEvent object. - """ - return SnippetEvent( - callback_id=event_dict['callbackId'], - name=event_dict['name'], - creation_time=event_dict['time'], - data=event_dict['data'], - ) - - -class SnippetEvent: - """The class that represents callback events for mobly snippet library. - - DEPRECATED: Use mobly.snippet.callback_event.CallbackEvent instead. - - Attributes: - callback_id: string, the callback ID associated with the event. - name: string, the name of the event. - creation_time: int, the epoch time when the event is created on the - Rpc server side. - data: dictionary, the data held by the event. Can be None. - """ - - def __init__(self, callback_id, name, creation_time, data): - self.callback_id = callback_id - self.name = name - self.creation_time = creation_time - self.data = data - - def __repr__(self): - return ( - 'SnippetEvent(callback_id: %s, name: %s, creation_time: %s, data: %s)' - ) % (self.callback_id, self.name, self.creation_time, self.data) diff --git a/tests/mobly/controllers/android_device_lib/snippet_event_test.py b/tests/mobly/controllers/android_device_lib/snippet_event_test.py deleted file mode 100755 index 367a1399b..000000000 --- a/tests/mobly/controllers/android_device_lib/snippet_event_test.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2018 Google Inc. -# -# 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 unittest - -from mobly.controllers.android_device_lib import snippet_event - -MOCK_CALLBACK_ID = 'myCallbackId' -MOCK_EVENT_NAME = 'onXyzEvent' -MOCK_CREATION_TIME = '12345678' -MOCK_DATA = {'foo': 'bar'} - - -class SnippetEventTest(unittest.TestCase): - - def test_basic(self): - """Verifies that an event object can be created and logged properly.""" - event = snippet_event.SnippetEvent( - MOCK_CALLBACK_ID, MOCK_EVENT_NAME, MOCK_CREATION_TIME, MOCK_DATA - ) - self.assertEqual( - repr(event), - 'SnippetEvent(callback_id: myCallbackId, name: onXyzEvent, ' - "creation_time: 12345678, data: {'foo': 'bar'})", - ) - - -if __name__ == '__main__': - unittest.main()