summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMarc Abramowitz <marc@marc-abramowitz.com>2015-09-14 17:05:19 -0700
committerMarc Abramowitz <marc@marc-abramowitz.com>2015-09-14 18:45:27 -0700
commitfec3871f05b028b6f638098c295fbcb193de5587 (patch)
tree06cb4e9f7e59d83a6b5ffac9564df4b7b63d91ea /docs
parenta1b3f94c1fb39a384f5e5273904a4e8ac523ab21 (diff)
downloadurllib3-fec3871f05b028b6f638098c295fbcb193de5587.tar.gz
Add info about disabling warnings for end users
For example, you can use `PYTHONWARNINGS` to disable warnings without modifying code (when using Python >= 2.7). Relates to: - https://github.com/pypa/pip/pull/3109 - https://github.com/pypa/pip/issues/2681
Diffstat (limited to 'docs')
-rw-r--r--docs/security.rst55
1 files changed, 38 insertions, 17 deletions
diff --git a/docs/security.rst b/docs/security.rst
index 0f5aa1c7..ad13d602 100644
--- a/docs/security.rst
+++ b/docs/security.rst
@@ -185,21 +185,8 @@ Unverified HTTPS requests will trigger a warning via Python's ``warnings`` modul
This would be a great time to enable HTTPS verification:
:ref:`certifi-with-urllib3`.
-If you know what you're doing and would like to disable this and other warnings,
-you can use :func:`~urllib3.disable_warnings`::
-
- import urllib3
- urllib3.disable_warnings()
-
-Making unverified HTTPS requests is strongly discouraged. ˙ ͜ʟ˙
-
-Alternatively, if you are using Python's ``logging`` module, you can capture the
-warnings to your own log::
+For info about disabling warnings, see `Disabling Warnings`_.
- logging.captureWarnings(True)
-
-Capturing the warnings to your own log is much preferred over simply disabling
-the warnings.
InsecurePlatformWarning
-----------------------
@@ -216,6 +203,40 @@ If you encounter this warning, it is strongly recommended you upgrade to a
newer Python version, or that you use pyOpenSSL as described in the
:ref:`pyopenssl` section.
-If you know what you are doing and would like to disable this and other
-warnings, please consult the :ref:`insecurerequestwarning` section for
-instructions on how to handle the warnings.
+For info about disabling warnings, see `Disabling Warnings`_.
+
+
+Disabling Warnings
+------------------
+
+Making unverified HTTPS requests is strongly discouraged. ˙ ͜ʟ˙
+
+But if you understand the ramifications and still want to do it...
+
+Within the code
++++++++++++++++
+
+If you know what you're doing and would like to disable all ``urllib3`` warnings,
+you can use :func:`~urllib3.disable_warnings`::
+
+ import urllib3
+ urllib3.disable_warnings()
+
+Alternatively, if you are using Python's ``logging`` module, you can capture the
+warnings to your own log::
+
+ logging.captureWarnings(True)
+
+Capturing the warnings to your own log is much preferred over simply disabling
+the warnings.
+
+Without modifying code
+++++++++++++++++++++++
+
+If you are using a program that uses ``urllib3`` and don't want to change the
+code, you can suppress warnings by setting the ``PYTHONWARNINGS`` environment
+variable in Python 2.7+ or by using the ``-W`` flag with the Python
+interpreter (see `docs
+<https://docs.python.org/2/using/cmdline.html#cmdoption-W>`_), such as::
+
+ PYTHONWARNINGS="ignore:Unverified HTTPS request" ./do-insecure-request.py