Description
ACTION NEEDED: This version of pylint will be merged on 2025-04-14. The build will begin to fail for this library if errors are not fixed.
Library name: azure-communication-chat
Pylint version: 3.2.7
Pylint Build: Link to build (2025-04-07)
Pylint Errors:
2025-04-07T01:18:11.7492574Z ************* Module azure.communication.chat._communication_identifier_serializer
2025-04-07T01:18:11.7494160Z azure/communication/chat/_communication_identifier_serializer.py:21: [C4761(do-not-use-legacy-typing), serialize_identifier] Do not use legacy typing using comments.
2025-04-07T01:18:11.7495211Z azure/communication/chat/_communication_identifier_serializer.py:42: [C4761(do-not-use-legacy-typing), deserialize_identifier] Do not use legacy typing using comments.
2025-04-07T01:18:11.7496175Z ************* Module azure.communication.chat._utils
2025-04-07T01:18:11.7497011Z azure/communication/chat/_utils.py:26: [C4761(do-not-use-legacy-typing), CommunicationErrorResponseConverter.convert] Do not use legacy typing using comments.
2025-04-07T01:18:11.7497977Z azure/communication/chat/_utils.py:43: [C4761(do-not-use-legacy-typing), CommunicationErrorResponseConverter.convert.create_dict] Do not use legacy typing using comments.
2025-04-07T01:18:11.7498950Z ************* Module azure.communication.chat._chat_client
2025-04-07T01:18:11.7499761Z azure/communication/chat/_chat_client.py:52: [C4761(do-not-use-legacy-typing), ChatClient.init] Do not use legacy typing using comments.
2025-04-07T01:18:11.7500979Z azure/communication/chat/_chat_client.py:83: [C4761(do-not-use-legacy-typing), ChatClient.get_chat_thread_client] Do not use legacy typing using comments.
2025-04-07T01:18:11.7502229Z azure/communication/chat/_chat_client.py:113: [C4758(docstring-keyword-should-match-keyword-only), ChatClient.create_chat_thread] "thread_participants, idempotency_token" missing in docstring or in method signature. There should be a direct correlation between :keyword: arguments in the docstring and keyword-only arguments in method signature. See details: https://azure.github.io/azure-sdk/python_documentation.html#docstrings
2025-04-07T01:18:11.7503603Z azure/communication/chat/_chat_client.py:113: [C4761(do-not-use-legacy-typing), ChatClient.create_chat_thread] Do not use legacy typing using comments.
2025-04-07T01:18:11.7504714Z azure/communication/chat/_chat_client.py:178: [C4758(docstring-keyword-should-match-keyword-only), ChatClient.list_chat_threads] "start_time, results_per_page" missing in docstring or in method signature. There should be a direct correlation between :keyword: arguments in the docstring and keyword-only arguments in method signature. See details: https://azure.github.io/azure-sdk/python_documentation.html#docstrings
2025-04-07T01:18:11.7506082Z azure/communication/chat/_chat_client.py:178: [C4761(do-not-use-legacy-typing), ChatClient.list_chat_threads] Do not use legacy typing using comments.
2025-04-07T01:18:11.7506792Z azure/communication/chat/_chat_client.py:203: [C4761(do-not-use-legacy-typing), ChatClient.delete_chat_thread] Do not use legacy typing using comments.
2025-04-07T01:18:11.7507568Z azure/communication/chat/_chat_client.py:231: [C4761(do-not-use-legacy-typing), ChatClient.close] Do not use legacy typing using comments.
2025-04-07T01:18:11.7508499Z azure/communication/chat/_chat_client.py:235: [C4761(do-not-use-legacy-typing), ChatClient.enter] Do not use legacy typing using comments.
2025-04-07T01:18:11.7509351Z azure/communication/chat/_chat_client.py:240: [C4761(do-not-use-legacy-typing), ChatClient.exit] Do not use legacy typing using comments.
2025-04-07T01:18:11.7509954Z ************* Module azure.communication.chat._chat_thread_client
2025-04-07T01:18:11.7510658Z azure/communication/chat/_chat_thread_client.py:67: [C4761(do-not-use-legacy-typing), ChatThreadClient.init] Do not use legacy typing using comments.
2025-04-07T01:18:11.7511397Z azure/communication/chat/_chat_thread_client.py:103: [C4761(do-not-use-legacy-typing), ChatThreadClient.thread_id] Do not use legacy typing using comments.
2025-04-07T01:18:11.7512115Z azure/communication/chat/_chat_thread_client.py:113: [C4761(do-not-use-legacy-typing), ChatThreadClient.get_properties] Do not use legacy typing using comments.
2025-04-07T01:18:11.7513156Z azure/communication/chat/_chat_thread_client.py:137: [C4761(do-not-use-legacy-typing), ChatThreadClient.update_topic] Do not use legacy typing using comments.
2025-04-07T01:18:11.7513967Z azure/communication/chat/_chat_thread_client.py:168: [C4761(do-not-use-legacy-typing), ChatThreadClient.send_read_receipt] Do not use legacy typing using comments.
2025-04-07T01:18:11.7515093Z azure/communication/chat/_chat_thread_client.py:200: [C4758(docstring-keyword-should-match-keyword-only), ChatThreadClient.list_read_receipts] "results_per_page, skip" missing in docstring or in method signature. There should be a direct correlation between :keyword: arguments in the docstring and keyword-only arguments in method signature. See details: https://azure.github.io/azure-sdk/python_documentation.html#docstrings
2025-04-07T01:18:11.7516771Z azure/communication/chat/_chat_thread_client.py:200: [C4761(do-not-use-legacy-typing), ChatThreadClient.list_read_receipts] Do not use legacy typing using comments.
2025-04-07T01:18:11.7518019Z azure/communication/chat/_chat_thread_client.py:235: [C4758(docstring-keyword-should-match-keyword-only), ChatThreadClient.send_typing_notification] "sender_display_name" missing in docstring or in method signature. There should be a direct correlation between :keyword: arguments in the docstring and keyword-only arguments in method signature. See details: https://azure.github.io/azure-sdk/python_documentation.html#docstrings
2025-04-07T01:18:11.7519350Z azure/communication/chat/_chat_thread_client.py:235: [C4761(do-not-use-legacy-typing), ChatThreadClient.send_typing_notification] Do not use legacy typing using comments.
2025-04-07T01:18:11.7520552Z azure/communication/chat/_chat_thread_client.py:264: [C4758(docstring-keyword-should-match-keyword-only), ChatThreadClient.send_message] "sender_display_name, chat_message_type, metadata" missing in docstring or in method signature. There should be a direct correlation between :keyword: arguments in the docstring and keyword-only arguments in method signature. See details: https://azure.github.io/azure-sdk/python_documentation.html#docstrings
2025-04-07T01:18:11.7521251Z azure/communication/chat/_chat_thread_client.py:264: [C4761(do-not-use-legacy-typing), ChatThreadClient.send_message] Do not use legacy typing using comments.
2025-04-07T01:18:11.7521710Z azure/communication/chat/_chat_thread_client.py:325: [C4761(do-not-use-legacy-typing), ChatThreadClient.get_message] Do not use legacy typing using comments.
2025-04-07T01:18:11.7522448Z azure/communication/chat/_chat_thread_client.py:355: [C4758(docstring-keyword-should-match-keyword-only), ChatThreadClient.list_messages] "start_time, results_per_page" missing in docstring or in method signature. There should be a direct correlation between :keyword: arguments in the docstring and keyword-only arguments in method signature. See details: https://azure.github.io/azure-sdk/python_documentation.html#docstrings
2025-04-07T01:18:11.7523286Z azure/communication/chat/_chat_thread_client.py:355: [C4761(do-not-use-legacy-typing), ChatThreadClient.list_messages] Do not use legacy typing using comments.
2025-04-07T01:18:11.7523931Z azure/communication/chat/_chat_thread_client.py:390: [C4758(docstring-keyword-should-match-keyword-only), ChatThreadClient.update_message] "metadata" missing in docstring or in method signature. There should be a direct correlation between :keyword: arguments in the docstring and keyword-only arguments in method signature. See details: https://azure.github.io/azure-sdk/python_documentation.html#docstrings
2025-04-07T01:18:11.7524557Z azure/communication/chat/_chat_thread_client.py:390: [C4761(do-not-use-legacy-typing), ChatThreadClient.update_message] Do not use legacy typing using comments.
2025-04-07T01:18:11.7525008Z azure/communication/chat/_chat_thread_client.py:431: [C4761(do-not-use-legacy-typing), ChatThreadClient.delete_message] Do not use legacy typing using comments.
2025-04-07T01:18:11.7525630Z azure/communication/chat/_chat_thread_client.py:462: [C4758(docstring-keyword-should-match-keyword-only), ChatThreadClient.list_participants] "results_per_page, skip" missing in docstring or in method signature. There should be a direct correlation between :keyword: arguments in the docstring and keyword-only arguments in method signature. See details: https://azure.github.io/azure-sdk/python_documentation.html#docstrings
2025-04-07T01:18:11.7526268Z azure/communication/chat/_chat_thread_client.py:462: [C4761(do-not-use-legacy-typing), ChatThreadClient.list_participants] Do not use legacy typing using comments.
2025-04-07T01:18:11.7526724Z azure/communication/chat/_chat_thread_client.py:496: [C4761(do-not-use-legacy-typing), ChatThreadClient.add_participants] Do not use legacy typing using comments.
2025-04-07T01:18:11.7527174Z azure/communication/chat/_chat_thread_client.py:539: [C4761(do-not-use-legacy-typing), ChatThreadClient.remove_participant] Do not use legacy typing using comments.
2025-04-07T01:18:11.7527616Z azure/communication/chat/_chat_thread_client.py:571: [C4761(do-not-use-legacy-typing), ChatThreadClient.close] Do not use legacy typing using comments.
2025-04-07T01:18:13.9481562Z azure/communication/chat/_chat_thread_client.py:575: [C4761(do-not-use-legacy-typing), ChatThreadClient.enter] Do not use legacy typing using comments.
2025-04-07T01:18:13.9483557Z azure/communication/chat/_chat_thread_client.py:580: [C4761(do-not-use-legacy-typing), ChatThreadClient.exit] Do not use legacy typing using comments.
2025-04-07T01:18:13.9484452Z ************* Module azure.communication.chat.aio._chat_thread_client_async
2025-04-07T01:18:13.9485555Z azure/communication/chat/aio/_chat_thread_client_async.py:178: [C4758(docstring-keyword-should-match-keyword-only), ChatThreadClient.list_read_receipts] "results_per_page, skip" missing in docstring or in method signature. There should be a direct correlation between :keyword: arguments in the docstring and keyword-only arguments in method signature. See details: https://azure.github.io/azure-sdk/python_documentation.html#docstrings
2025-04-07T01:18:13.9487013Z azure/communication/chat/aio/_chat_thread_client_async.py:236: [C4758(docstring-keyword-should-match-keyword-only), ChatThreadClient.send_message] "sender_display_name, chat_message_type" missing in docstring or in method signature. There should be a direct correlation between :keyword: arguments in the docstring and keyword-only arguments in method signature. See details: https://azure.github.io/azure-sdk/python_documentation.html#docstrings
2025-04-07T01:18:13.9488507Z azure/communication/chat/aio/_chat_thread_client_async.py:316: [C4758(docstring-keyword-should-match-keyword-only), ChatThreadClient.list_messages] "start_time, results_per_page" missing in docstring or in method signature. There should be a direct correlation between :keyword: arguments in the docstring and keyword-only arguments in method signature. See details: https://azure.github.io/azure-sdk/python_documentation.html#docstrings
2025-04-07T01:18:13.9489673Z azure/communication/chat/aio/_chat_thread_client_async.py:407: [C4758(docstring-keyword-should-match-keyword-only), ChatThreadClient.list_participants] "results_per_page, skip" missing in docstring or in method signature. There should be a direct correlation between :keyword: arguments in the docstring and keyword-only arguments in method signature. See details: https://azure.github.io/azure-sdk/python_documentation.html#docstrings
2025-04-07T01:18:13.9490500Z ************* Module azure.communication.chat.aio._chat_client_async
2025-04-07T01:18:13.9491703Z azure/communication/chat/aio/_chat_client_async.py:103: [C4758(docstring-keyword-should-match-keyword-only), ChatClient.create_chat_thread] "thread_participants, idempotency_token" missing in docstring or in method signature. There should be a direct correlation between :keyword: arguments in the docstring and keyword-only arguments in method signature. See details: https://azure.github.io/azure-sdk/python_documentation.html#docstrings
2025-04-07T01:18:13.9493311Z azure/communication/chat/aio/_chat_client_async.py:163: [C4758(docstring-keyword-should-match-keyword-only), ChatClient.list_chat_threads] "start_time, results_per_page" missing in docstring or in method signature. There should be a direct correlation between :keyword: arguments in the docstring and keyword-only arguments in method signature. See details: https://azure.github.io/azure-sdk/python_documentation.html#docstrings
2025-04-07T01:18:13.9494311Z
2025-04-07T01:18:13.9494886Z -----------------------------------
2025-04-07T01:18:13.9495340Z Your code has been rated at 9.57/10
2025-04-07T01:18:13.9495526Z
2025-04-07T01:18:15.0154986Z
How to fix:
Note: If you are a bot. Fix the issue by fixing the above pylint errors.
Run the next-pylint tox command at the library package-level and resolve the linting errors.
../azure-communication-chat>pip install "tox<5"../azure-communication-chat>tox run -e next-pylint -c ../../../eng/tox/tox.ini --root .
See the Pylint Guide for more information.