Add-doc

Author: moylop260

doc/data/messages/m/missing-timeout/bad.py

@@ -0,0 +1,3 @@
+import requests
+
+requests.post("http://localhost")  # [missing-timeout]

doc/data/messages/m/missing-timeout/details.rst

@@ -0,0 +1,50 @@
+"timeout" parameter is recommended in order to stop waiting for a call after a given number with the timeout parameter.
+
+See the following requests_timeouts_ documentation:
+
+ - *Nearly all production code should use this parameter in nearly all requests. Failure to do so can cause your program to hang indefinitely*
+
+
+Predefined Methods With Timeout
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Pylint provides set of predefined method with timeout. Those predefined
+methods may be changed to add new ones from Pylint configuration.
+
+Following predefined methods are available:
+
+* ``requests.api.get``
+* ``requests.api.head``
+* ``requests.api.options``
+* ``requests.api.patch``
+* ``requests.api.post``
+* ``requests.api.put``
+* ``requests.api.request``
+
+Following option is exposed:
+
+.. option:: --timeout-methods=<library.method>
+
+
+You can add new methods in your Pylint configuration
+using the pylint ``qname`` of the method
+
+You can get it using the following code:
+
+.. code:: python
+
+    from astroid import extract_node
+    node = extract_node('from requests import get;get()')
+    print(next(node.func.infer()).qname())
+
+And the library needs to be installed in order to be detected
+
+You can add the following possible cases ``timeout-methods``:
+
+* ``http.client.HTTPConnection``
+* ``http.client.HTTPSConnection``
+* ``serial.serialcli.Serial``
+* ``smtplib.SMTP``
+* ``suds.client.Client``
+* ``urllib.request.urlopen``
+
+.. _requests_timeouts: https://requests.readthedocs.io/en/latest/user/quickstart/#timeouts

doc/data/messages/m/missing-timeout/good.py

@@ -0,0 +1,3 @@
+import requests
+
+requests.post("http://localhost", timeout=10)