docs(python): Include a doc entry for every exception type (#17001)

pola-rs · Jun 16, 2024 · ce62b33 · ce62b33
1 parent 1b57f9d
commit ce62b33
Show file tree

Hide file tree

Showing 3 changed files with 61 additions and 6 deletions.
diff --git a/py-polars/docs/source/reference/exceptions.rst b/py-polars/docs/source/reference/exceptions.rst
@@ -3,21 +3,49 @@ Exceptions
 ==========
 .. currentmodule:: polars.exceptions
 
+Errors
+~~~~~~
+
 .. autosummary::
     :toctree: api/
     :nosignatures:
 
+    PolarsError
+    ChronoFormatWarning
     ColumnNotFoundError
     ComputeError
     DuplicateError
+    InvalidAssert
     InvalidOperationError
+    ModuleUpgradeRequired
     NoDataError
     NoRowsReturnedError
-    PolarsError
+    OutOfBoundsError
+    ParameterCollisionError
     PolarsPanicError
     RowsError
+    SQLInterfaceError
+    SQLSyntaxError
     SchemaError
     SchemaFieldNotFoundError
     ShapeError
+    StringCacheMismatchError
     StructFieldNotFoundError
     TooManyRowsReturnedError
+    UnsuitableSQLError
+
+Warnings
+~~~~~~~~
+
+.. autosummary::
+    :toctree: api/
+    :nosignatures:
+
+    PolarsWarning
+    CategoricalRemappingWarning
+    ChronoFormatWarning
+    CustomUFuncWarning
+    MapWithoutReturnDtypeWarning
+    PerformanceWarning
+    PolarsInefficientMapWarning
+    UnstableWarning
diff --git a/py-polars/polars/__init__.py b/py-polars/polars/__init__.py
@@ -82,21 +82,32 @@
     ChronoFormatWarning,
     ColumnNotFoundError,
     ComputeError,
+    CustomUFuncWarning,
     DuplicateError,
+    InvalidAssert,
     InvalidOperationError,
     MapWithoutReturnDtypeWarning,
+    ModuleUpgradeRequired,
     NoDataError,
+    NoRowsReturnedError,
     OutOfBoundsError,
+    ParameterCollisionError,
+    PerformanceWarning,
     PolarsError,
+    PolarsInefficientMapWarning,
     PolarsPanicError,
     PolarsWarning,
+    RowsError,
     SchemaError,
     SchemaFieldNotFoundError,
     ShapeError,
     SQLInterfaceError,
     SQLSyntaxError,
+    StringCacheMismatchError,
     StructFieldNotFoundError,
+    TooManyRowsReturnedError,
     UnstableWarning,
+    UnsuitableSQLError,
 )
 from polars.expr import Expr
 from polars.functions import (
@@ -229,29 +240,42 @@
 del _get_polars_version
 
 __all__ = [
+    # modules
     "api",
     "exceptions",
     "plugins",
-    # exceptions/errors
+    # exceptions - errors
+    "PolarsError",
+    "ChronoFormatWarning",
     "ColumnNotFoundError",
     "ComputeError",
     "DuplicateError",
+    "InvalidAssert",
     "InvalidOperationError",
+    "ModuleUpgradeRequired",
     "NoDataError",
+    "NoRowsReturnedError",
     "OutOfBoundsError",
-    "PolarsError",
+    "ParameterCollisionError",
     "PolarsPanicError",
+    "RowsError",
     "SQLInterfaceError",
     "SQLSyntaxError",
     "SchemaError",
     "SchemaFieldNotFoundError",
     "ShapeError",
+    "StringCacheMismatchError",
     "StructFieldNotFoundError",
-    # warnings
+    "TooManyRowsReturnedError",
+    "UnsuitableSQLError",
+    # exceptions - warnings
+    "PolarsWarning",
     "CategoricalRemappingWarning",
     "ChronoFormatWarning",
+    "CustomUFuncWarning",
     "MapWithoutReturnDtypeWarning",
-    "PolarsWarning",
+    "PerformanceWarning",
+    "PolarsInefficientMapWarning",
     "UnstableWarning",
     # core classes
     "DataFrame",

diff --git a/py-polars/polars/exceptions.py b/py-polars/polars/exceptions.py
@@ -159,16 +159,18 @@ class UnstableWarning(PolarsWarning):  # type: ignore[misc]
 
 __all__ = [
     # Errors
+    "PolarsError",
     "ChronoFormatWarning",
     "ColumnNotFoundError",
     "ComputeError",
     "DuplicateError",
+    "InvalidAssert",
     "InvalidOperationError",
     "ModuleUpgradeRequired",
     "NoDataError",
     "NoRowsReturnedError",
     "OutOfBoundsError",
-    "PolarsError",
+    "ParameterCollisionError",
     "PolarsPanicError",
     "RowsError",
     "SQLInterfaceError",
@@ -179,6 +181,7 @@ class UnstableWarning(PolarsWarning):  # type: ignore[misc]
     "StringCacheMismatchError",
     "StructFieldNotFoundError",
     "TooManyRowsReturnedError",
+    "UnsuitableSQLError",
     # Warnings
     "PolarsWarning",
     "CategoricalRemappingWarning",