azure-sdk-tools/tools/pylint-extensions/azure-pylint-guidelines-checker

Linting the Guidelines

The code presented in this repository is a lift-and-shift of code originally written by @kristapratico

Running guidelines checks in Azure/azure-sdk-for-python repository

In order to lint for the guidelines, you must make sure you are enabling the azure-pylint-guidelines-checker in your pylint invocation. Using the rcfile at the root of the repo will ensure that the plugin is properly activated

It is recommended you run pylint at the library package level to be consistent with how the CI runs pylint.

Check that you are running pylint version >=2.14.5 and astroid version >=2.12.0.

0. Install the pylint checker from the azure-sdk development feed.

   pip install --index-url="https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-python/pypi/simple/" azure-pylint-guidelines-checker
   

1. Run pylint at the root of the repo and it will automatically find the pylintrc:

   C:\azure-sdk-for-python>pylint sdk/storage/azure-storage-blob/azure
   

2. Add the --rcfile command line argument with a relative path to the pylintrc from your current directory:

   C:\azure-sdk-for-python\sdk\storage>pylint --rcfile="../../pylintrc" azure-storage-blob
   

3. Set the environment variable PYLINTRC to the absolute path of the pylintrc file:

   set PYLINTRC=C:\azure-sdk-for-python\pylintrc
   

   Run pylint:

   C:\azure-sdk-for-python\sdk\storage>pylint azure-storage-blob
   

4. Run pylint at the package level using tox and it will find the pylintrc file:

   pip install tox tox-monorepo
   C:\azure-sdk-for-python\sdk\storage\azure-storage-blob>tox -e lint -c ../../../eng/tox/tox.ini
   

5. If you use the pylint extension for VS code or Pycharm it should find the pylintrc automatically.

How to disable a pylint error

# pylint:disable=connection-string-should-not-be-constructor-param

The pylint custom checkers for SDK guidelines fall into messages range C4717 - C4738. You will know you came across a custom checker if it contains a link to the guidelines.

In the case of a false positive, use the disable command to remove the pylint error.

Rules List

Pylint checker name	How to fix this	How to disable this rule	Link to python guideline
client-method-should-not-use-static-method	Use module level functions instead.	# pylint:disable=client-method-should-not-use-static-method	link
missing-client-constructor-parameter-credential	Add a credential parameter to the client constructor. Do not use plural form "credentials".	# pylint:disable=missing-client-constructor-parameter-credential	link
missing-client-constructor-parameter-kwargs	Add a **kwargs parameter to the client constructor.	# pylint:disable=missing-client-constructor-parameter-kwargs	link
client-method-has-more-than-5-positional-arguments	Use keyword arguments to reduce number of positional arguments.	# pylint:disable=client-method-has-more-than-5-positional-arguments	link
client-method-missing-type-annotations	Check that param/return type comments are present or that param/return type annotations are present. Check that you did not mix type comments with type annotations.	# pylint:disable=client-method-missing-type-annotations	link
client-incorrect-naming-convention	Check that you use... snake_case for variable, function, and method names. Pascal case for types. ALL CAPS for constants.	# pylint:disable=client-incorrect-naming-convention	link
client-method-missing-kwargs	Check that any methods that make network calls have a **kwargs parameter.	# pylint:disable=client-method-missing-kwargs	link
config-missing-kwargs-in-policy	Check that the policies in your configuration function contain a **kwargs parameter.	# pylint:disable=config-missing-kwargs-in-policy	link
async-client-bad-name	Remove "Async" from your service client's name.	# pylint:disable=async-client-bad-name	link
file-needs-copyright-header	Add a copyright header to the top of your file.	# pylint:disable=file-needs-copyright-header	link
client-method-name-no-double-underscore	Don't use method names prefixed with "__".	# pylint:disable=client-method-name-no-double-underscore	link
specify-parameter-names-in-call	Specify the parameter names when calling methods with more than 2 required positional parameters. e.g. self.get_foo(one, two, three=three, four=four, five=five)	# pylint:disable=specify-parameter-names-in-call	link
connection-string-should-not-be-constructor-param	Remove connection string parameter from client constructor. Create a method that creates the client using a connection string.	# pylint:disable=connection-string-should-not-be-constructor-param	link
package-name-incorrect	Change your distribution package name to only include dashes, e.g. azure-storage-file-share	# pylint:disable=package-name-incorrect	link
client-suffix-needed	Service client types should use a "Client" suffix, e.g. BlobClient.	# pylint:disable=client-suffix-needed	link
docstring-admonition-needs-newline	Add a blank newline above the .. literalinclude statement.	# pylint:disable=docstring-admonition-needs-newline	No guideline, just helps our docs get built correctly for microsoft docs.
naming-mismatch	Do not alias models imported from the generated code.	# pylint:disable=naming-mismatch	link
client-accepts-api-version-keyword	Ensure that the client constructor accepts a keyword-only api_version argument.	# pylint:disable=client-accepts-api-version-keyword	link
enum-must-be-uppercase	The enum name must be all uppercase.	# pylint:disable=enum-must-be-uppercase	link
enum-must-inherit-case-insensitive-enum-meta	The enum should inherit from CaseInsensitiveEnumMeta.	# pylint:disable=enum-must-inherit-case-insensitive-enum-meta	link
networking-import-outside-azure-core-transport	This import is only allowed in azure.core.pipeline.transport.	# pylint:disable=networking-import-outside-azure-core-transport	link
non-abstract-transport-import	Only import abstract transports. Let core or end-user decide which transport to use.	# pylint:disable=non-abstract-transport-import	link
no-raise-with-traceback	Check that raise_with_traceback from azure-core is replaced with python 3 'raise from' syntax.	# pylint:disable=no-raise-with-traceback	link
name-too-long	Check that the length of class names, function names, and variable names are under 40 characters.	# pylint:disable=name-too-long	link
delete-operation-wrong-return-type	Check that delete* or begin_delete* methods return None or LROPoller[None].	# pylint:disable=delete-operation-wrong-return-type	link
client-method-missing-tracing-decorator	Check that sync client methods that make network calls have the sync distributed tracing decorator.	pylint:disable=client-method-missing-tracing-decorator	link
client-method-missing-tracing-decorator-async	Check that async client methods that make network calls have the async distributed tracing decorator.	pylint:disable=client-method-missing-tracing-decorator-async	link
client-list-methods-use-paging	Client methods that return collections should use the Paging protocol.	pylint:disable=client-list-methods-use-paging	link
docstring-missing-param	Docstring missing for param.	pylint:disable=docstring-missing-param	link
docstring-missing-type	Docstring missing for param type.	pylint:disable=docstring-missing-type	link
docstring-missing-return	Docstring missing return.	pylint:disable=docstring-missing-return	link
docstring-missing-rtype	Docstring missing return type.	pylint:disable=docstring-missing-rtype	link
docstring-should-be-keyword	Docstring should use keywords.	pylint:disable=docstring-should-be-keyword	link
do-not-import-legacy-six	Do not import six.	pylint:disable=do-not-import-legacy-six	No Link.
no-legacy-azure-core-http-response-import	Do not import HttpResponse from azure.core.pipeline.transport outside of Azure Core. You can import HttpResponse from azure.core.rest instead.	pylint:disable=no-legacy-azure-core-http-response-import	link
docstring-keyword-should-match-keyword-only	Docstring keyword arguments and keyword-only method arguments should match.	pylint:disable=docstring-keyword-should-match-keyword-only	link
docstring-type-do-not-use-class	Docstring type is formatted incorrectly. Do not use :class in docstring type.	pylint:disable=docstring-type-do-not-use-class	link
no-typing-import-in-type-check	Do not import typing under TYPE_CHECKING.	pylint:disable=no-typing-import-in-type-check	No Link.
do-not-log-raised-errors	Do not log errors at error or warning level when error is raised in an exception block.	pylint:disable=do-not-log-raised-errors	No Link.
do-not-use-legacy-typing	Do not use legacy (<Python 3.8) type hinting comments	pylint:disable=do-not-use-legacy-typing	No Link.
do-not-import-asyncio	Do not import asyncio directly.	pylint:disable=do-not-import-asyncio	No Link.
invalid-use-of-overload	Do not mix async and synchronous overloads	pylint:disable=invalid-use-of-overload	No Link.
do-not-hardcode-connection-verify	Do not hardcode a boolean value to connection_verify	pylint:disable=do-not-hardcode-connection-verify	No LInk.
do-not-log-exceptions	Do not log exceptions in levels other than debug, otherwise it can reveal sensitive information	pylint:disable=do-not-log-exceptions	link
unapproved-client-method-name-prefix	Clients should use preferred verbs for method names	pylint:disable=unapproved-client-method-name-prefix	link