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-digitaltwins-core
Pylint version: 3.2.7
Pylint Build: Link to build (2025-04-06)
Pylint Errors:
2025-04-06T12:03:12.8597752Z ************* Module azure.digitaltwins.core._utils
2025-04-06T12:03:12.8599241Z azure/digitaltwins/core/_utils.py:14: [C4761(do-not-use-legacy-typing), prep_if_match] Do not use legacy typing using comments.
2025-04-06T12:03:12.8600456Z azure/digitaltwins/core/_utils.py:30: [C4761(do-not-use-legacy-typing), prep_if_none_match] Do not use legacy typing using comments.
2025-04-06T12:03:12.8601628Z ************* Module azure.digitaltwins.core._digitaltwins_client
2025-04-06T12:03:12.8602293Z azure/digitaltwins/core/_digitaltwins_client.py:46: [C4761(do-not-use-legacy-typing), DigitalTwinsClient.init] Do not use legacy typing using comments.
2025-04-06T12:03:12.8603271Z azure/digitaltwins/core/_digitaltwins_client.py:58: [C4761(do-not-use-legacy-typing), DigitalTwinsClient.get_digital_twin] Do not use legacy typing using comments.
2025-04-06T12:03:12.8604417Z azure/digitaltwins/core/_digitaltwins_client.py:75: [C4758(docstring-keyword-should-match-keyword-only), DigitalTwinsClient.upsert_digital_twin] "match_condition, etag" 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-06T12:03:12.8605566Z azure/digitaltwins/core/_digitaltwins_client.py:75: [C4761(do-not-use-legacy-typing), DigitalTwinsClient.upsert_digital_twin] Do not use legacy typing using comments.
2025-04-06T12:03:12.8606705Z azure/digitaltwins/core/_digitaltwins_client.py:107: [C4758(docstring-keyword-should-match-keyword-only), DigitalTwinsClient.update_digital_twin] "match_condition, etag" 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-06T12:03:12.8607875Z azure/digitaltwins/core/_digitaltwins_client.py:107: [C4761(do-not-use-legacy-typing), DigitalTwinsClient.update_digital_twin] Do not use legacy typing using comments.
2025-04-06T12:03:12.8608982Z azure/digitaltwins/core/_digitaltwins_client.py:141: [C4758(docstring-keyword-should-match-keyword-only), DigitalTwinsClient.delete_digital_twin] "match_condition, etag" 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-06T12:03:12.8610334Z azure/digitaltwins/core/_digitaltwins_client.py:141: [C4761(do-not-use-legacy-typing), DigitalTwinsClient.delete_digital_twin] Do not use legacy typing using comments.
2025-04-06T12:03:12.8611087Z azure/digitaltwins/core/_digitaltwins_client.py:171: [C4761(do-not-use-legacy-typing), DigitalTwinsClient.get_component] Do not use legacy typing using comments.
2025-04-06T12:03:12.8612223Z azure/digitaltwins/core/_digitaltwins_client.py:190: [C4758(docstring-keyword-should-match-keyword-only), DigitalTwinsClient.update_component] "match_condition, etag" 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-06T12:03:12.8613405Z azure/digitaltwins/core/_digitaltwins_client.py:190: [C4761(do-not-use-legacy-typing), DigitalTwinsClient.update_component] Do not use legacy typing using comments.
2025-04-06T12:03:12.8614157Z azure/digitaltwins/core/_digitaltwins_client.py:230: [C4761(do-not-use-legacy-typing), DigitalTwinsClient.get_relationship] Do not use legacy typing using comments.
2025-04-06T12:03:12.8615256Z azure/digitaltwins/core/_digitaltwins_client.py:249: [C4758(docstring-keyword-should-match-keyword-only), DigitalTwinsClient.upsert_relationship] "match_condition, etag" 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-06T12:03:12.8616383Z azure/digitaltwins/core/_digitaltwins_client.py:249: [C4761(do-not-use-legacy-typing), DigitalTwinsClient.upsert_relationship] Do not use legacy typing using comments.
2025-04-06T12:03:12.8617685Z azure/digitaltwins/core/_digitaltwins_client.py:283: [C4758(docstring-keyword-should-match-keyword-only), DigitalTwinsClient.update_relationship] "match_condition, etag" 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-06T12:03:12.8618954Z azure/digitaltwins/core/_digitaltwins_client.py:283: [C4761(do-not-use-legacy-typing), DigitalTwinsClient.update_relationship] Do not use legacy typing using comments.
2025-04-06T12:03:12.8620099Z azure/digitaltwins/core/_digitaltwins_client.py:324: [C4758(docstring-keyword-should-match-keyword-only), DigitalTwinsClient.delete_relationship] "match_condition, etag" 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-06T12:03:12.8621023Z azure/digitaltwins/core/_digitaltwins_client.py:324: [C4761(do-not-use-legacy-typing), DigitalTwinsClient.delete_relationship] Do not use legacy typing using comments.
2025-04-06T12:03:12.8621616Z azure/digitaltwins/core/_digitaltwins_client.py:361: [C4761(do-not-use-legacy-typing), DigitalTwinsClient.list_relationships] Do not use legacy typing using comments.
2025-04-06T12:03:12.8622265Z azure/digitaltwins/core/_digitaltwins_client.py:381: [C4761(do-not-use-legacy-typing), DigitalTwinsClient.list_incoming_relationships] Do not use legacy typing using comments.
2025-04-06T12:03:12.8623205Z azure/digitaltwins/core/_digitaltwins_client.py:398: [C4758(docstring-keyword-should-match-keyword-only), DigitalTwinsClient.publish_telemetry] "message_id" 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-06T12:03:12.8623819Z azure/digitaltwins/core/_digitaltwins_client.py:398: [C4761(do-not-use-legacy-typing), DigitalTwinsClient.publish_telemetry] Do not use legacy typing using comments.
2025-04-06T12:03:12.8624375Z azure/digitaltwins/core/_digitaltwins_client.py:425: [C4758(docstring-keyword-should-match-keyword-only), DigitalTwinsClient.publish_component_telemetry] "message_id" 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-06T12:03:12.8624899Z azure/digitaltwins/core/_digitaltwins_client.py:425: [C4761(do-not-use-legacy-typing), DigitalTwinsClient.publish_component_telemetry] Do not use legacy typing using comments.
2025-04-06T12:03:12.8625431Z azure/digitaltwins/core/_digitaltwins_client.py:460: [C4758(docstring-keyword-should-match-keyword-only), DigitalTwinsClient.get_model] "include_model_definition" 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-06T12:03:12.8625945Z azure/digitaltwins/core/_digitaltwins_client.py:460: [C4761(do-not-use-legacy-typing), DigitalTwinsClient.get_model] Do not use legacy typing using comments.
2025-04-06T12:03:12.8626474Z azure/digitaltwins/core/_digitaltwins_client.py:481: [C4758(docstring-keyword-should-match-keyword-only), DigitalTwinsClient.list_models] "results_per_page, include_model_definition" 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-06T12:03:12.8627129Z azure/digitaltwins/core/_digitaltwins_client.py:481: [C4761(do-not-use-legacy-typing), DigitalTwinsClient.list_models] Do not use legacy typing using comments.
2025-04-06T12:03:12.8627613Z azure/digitaltwins/core/_digitaltwins_client.py:509: [C4739(docstring-missing-param), DigitalTwinsClient.create_models] Params missing in docstring: "dtdl_models". See details: https://azure.github.io/azure-sdk/python_documentation.html#docstrings
2025-04-06T12:03:13.2456077Z azure/digitaltwins/core/_digitaltwins_client.py:509: [C4743(docstring-should-be-keyword), DigitalTwinsClient.create_models] "model_list" not found as a parameter. Use :keyword type myarg: if a keyword argument. See details: https://azure.github.io/azure-sdk/python_documentation.html#docstrings
2025-04-06T12:03:13.2457451Z azure/digitaltwins/core/_digitaltwins_client.py:509: [C4761(do-not-use-legacy-typing), DigitalTwinsClient.create_models] Do not use legacy typing using comments.
2025-04-06T12:03:13.2458338Z azure/digitaltwins/core/_digitaltwins_client.py:527: [C4761(do-not-use-legacy-typing), DigitalTwinsClient.decommission_model] Do not use legacy typing using comments.
2025-04-06T12:03:13.2459208Z azure/digitaltwins/core/_digitaltwins_client.py:546: [C4761(do-not-use-legacy-typing), DigitalTwinsClient.delete_model] Do not use legacy typing using comments.
2025-04-06T12:03:13.2460150Z azure/digitaltwins/core/_digitaltwins_client.py:565: [C4761(do-not-use-legacy-typing), DigitalTwinsClient.get_event_route] Do not use legacy typing using comments.
2025-04-06T12:03:13.2462881Z azure/digitaltwins/core/_digitaltwins_client.py:582: [C4758(docstring-keyword-should-match-keyword-only), DigitalTwinsClient.list_event_routes] "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-06T12:03:13.2466356Z azure/digitaltwins/core/_digitaltwins_client.py:582: [C4761(do-not-use-legacy-typing), DigitalTwinsClient.list_event_routes] Do not use legacy typing using comments.
2025-04-06T12:03:13.2467174Z azure/digitaltwins/core/_digitaltwins_client.py:603: [C4761(do-not-use-legacy-typing), DigitalTwinsClient.upsert_event_route] Do not use legacy typing using comments.
2025-04-06T12:03:13.2467918Z azure/digitaltwins/core/_digitaltwins_client.py:620: [C4761(do-not-use-legacy-typing), DigitalTwinsClient.delete_event_route] Do not use legacy typing using comments.
2025-04-06T12:03:13.2468656Z azure/digitaltwins/core/_digitaltwins_client.py:637: [C4761(do-not-use-legacy-typing), DigitalTwinsClient.query_twins] Do not use legacy typing using comments.
2025-04-06T12:03:13.2469227Z ************* Module azure.digitaltwins.core.aio._digitaltwins_client_async
2025-04-06T12:03:13.2470413Z azure/digitaltwins/core/aio/_digitaltwins_client_async.py:88: [C4758(docstring-keyword-should-match-keyword-only), DigitalTwinsClient.upsert_digital_twin] "match_condition, etag" 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-06T12:03:13.2471853Z azure/digitaltwins/core/aio/_digitaltwins_client_async.py:125: [C4758(docstring-keyword-should-match-keyword-only), DigitalTwinsClient.update_digital_twin] "match_condition, etag" 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-06T12:03:13.2473274Z azure/digitaltwins/core/aio/_digitaltwins_client_async.py:163: [C4758(docstring-keyword-should-match-keyword-only), DigitalTwinsClient.delete_digital_twin] "match_condition, etag" 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-06T12:03:13.2474990Z azure/digitaltwins/core/aio/_digitaltwins_client_async.py:214: [C4758(docstring-keyword-should-match-keyword-only), DigitalTwinsClient.update_component] "match_condition, etag" 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-06T12:03:13.2476398Z azure/digitaltwins/core/aio/_digitaltwins_client_async.py:276: [C4758(docstring-keyword-should-match-keyword-only), DigitalTwinsClient.upsert_relationship] "match_condition, etag" 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-06T12:03:13.2477770Z azure/digitaltwins/core/aio/_digitaltwins_client_async.py:315: [C4758(docstring-keyword-should-match-keyword-only), DigitalTwinsClient.update_relationship] "match_condition, etag" 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-06T12:03:13.2479097Z azure/digitaltwins/core/aio/_digitaltwins_client_async.py:355: [C4758(docstring-keyword-should-match-keyword-only), DigitalTwinsClient.delete_relationship] "match_condition, etag" 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-06T12:03:13.2480553Z azure/digitaltwins/core/aio/_digitaltwins_client_async.py:435: [C4758(docstring-keyword-should-match-keyword-only), DigitalTwinsClient.publish_telemetry] "message_id" 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-06T12:03:13.2481806Z azure/digitaltwins/core/aio/_digitaltwins_client_async.py:466: [C4758(docstring-keyword-should-match-keyword-only), DigitalTwinsClient.publish_component_telemetry] "message_id" 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-06T12:03:13.2483087Z azure/digitaltwins/core/aio/_digitaltwins_client_async.py:500: [C4758(docstring-keyword-should-match-keyword-only), DigitalTwinsClient.get_model] "include_model_definition" 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-06T12:03:13.2484172Z azure/digitaltwins/core/aio/_digitaltwins_client_async.py:520: [C4758(docstring-keyword-should-match-keyword-only), DigitalTwinsClient.list_models] "results_per_page, include_model_definition" 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-06T12:03:13.2484891Z azure/digitaltwins/core/aio/_digitaltwins_client_async.py:551: [C4739(docstring-missing-param), DigitalTwinsClient.create_models] Params missing in docstring: "dtdl_models". See details: https://azure.github.io/azure-sdk/python_documentation.html#docstrings
2025-04-06T12:03:13.2485644Z azure/digitaltwins/core/aio/_digitaltwins_client_async.py:551: [C4743(docstring-should-be-keyword), DigitalTwinsClient.create_models] "model_list" not found as a parameter. Use :keyword type myarg: if a keyword argument. See details: https://azure.github.io/azure-sdk/python_documentation.html#docstrings
2025-04-06T12:03:13.2486485Z azure/digitaltwins/core/aio/_digitaltwins_client_async.py:620: [C4758(docstring-keyword-should-match-keyword-only), DigitalTwinsClient.list_event_routes] "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-06T12:03:13.2486882Z
2025-04-06T12:03:13.2487219Z -----------------------------------
2025-04-06T12:03:13.2487525Z Your code has been rated at 8.24/10
2025-04-06T12:03:13.2487670Z
2025-04-06T12:03:13.8900704Z
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-digitaltwins-core>pip install "tox<5"../azure-digitaltwins-core>tox run -e next-pylint -c ../../../eng/tox/tox.ini --root .
See the Pylint Guide for more information.