added ExperimentalWarning to API and documentation (#455)

neo4j · Jul 23, 2020 · 0b31f60 · 0b31f60
1 parent dfc0feb
commit 0b31f60
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -1237,6 +1237,30 @@ Please provide details about your running environment,
 + The error message:
 
 
+********
+Warnings
+********
+
+The Python Driver uses the built-in :class:`python:DeprecationWarning` class to warn about deprecations.
+
+The Python Driver uses the :class:`neo4j.ExperimentalWarning` class to warn about experimental features.
+
+.. autoclass:: neo4j.ExperimentalWarning
+
+
+Filter Warnings
+===============
+
+This example shows how to suppress the :class:`neo4j.ExperimentalWarning` using the :func:`python:warnings.filterwarnings` function.
+
+.. code-block:: python
+
+    import warnings
+    from neo4j import ExperimentalWarning
+
+    warnings.filterwarnings("ignore", category=ExperimentalWarning)
+
+
 ********
 Bookmark
 ********

diff --git a/neo4j/__init__.py b/neo4j/__init__.py
@@ -53,6 +53,7 @@
     "Query",
     "Session",
     "unit_of_work",
+    "ExperimentalWarning",
 ]
 
 from logging import getLogger
@@ -87,6 +88,7 @@
 )
 from neo4j.meta import (
     experimental,
+    ExperimentalWarning,
     get_user_agent,
     version as __version__,
 )