Fix inconsistent exceptions raised with no rich installed (#11360)

Co-authored-by: Carlos Mocholi <[email protected]>

CHANGELOG.md

@@ -207,6 +207,9 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 - `Trainer.logged_metrics` now always contains scalar tensors, even when a Python scalar was logged ([#11270](https://github.com/PyTorchLightning/pytorch-lightning/pull/11270))
 
 
+- Changed `MisconfigurationException` to `ModuleNotFoundError` when `rich` isn't available ([#11360](https://github.com/PyTorchLightning/pytorch-lightning/pull/11360))
+
+
 ### Deprecated
 
 - Deprecated `ClusterEnvironment.master_{address,port}` in favor of `ClusterEnvironment.main_{address,port}` ([#10103](https://github.com/PyTorchLightning/pytorch-lightning/issues/10103))

pytorch_lightning/callbacks/progress/rich_progress.py

@@ -17,7 +17,6 @@
 from typing import Any, Dict, Optional, Union
 
 from pytorch_lightning.callbacks.progress.base import ProgressBarBase
-from pytorch_lightning.utilities.exceptions import MisconfigurationException
 from pytorch_lightning.utilities.imports import _RICH_AVAILABLE
 
 Task, Style = None, None
@@ -231,7 +230,7 @@ def __init__(
         console_kwargs: Optional[Dict[str, Any]] = None,
     ) -> None:
         if not _RICH_AVAILABLE:
-            raise MisconfigurationException(
+            raise ModuleNotFoundError(
                 "`RichProgressBar` requires `rich` >= 10.2.2. Install it by running `pip install -U rich`."
             )
 

pytorch_lightning/callbacks/rich_model_summary.py

@@ -61,7 +61,7 @@ class RichModelSummary(ModelSummary):
     def __init__(self, max_depth: int = 1) -> None:
         if not _RICH_AVAILABLE:
             raise ModuleNotFoundError(
-                "`RichProgressBar` requires `rich` to be installed. Install it by running `pip install -U rich`."
+                "`RichModelSummary` requires `rich` to be installed. Install it by running `pip install -U rich`."
             )
         super().__init__(max_depth)
 

tests/callbacks/test_rich_model_summary.py

@@ -19,7 +19,6 @@
 
 from pytorch_lightning import Trainer
 from pytorch_lightning.callbacks import RichModelSummary, RichProgressBar
-from pytorch_lightning.utilities.imports import _RICH_AVAILABLE
 from pytorch_lightning.utilities.model_summary import summarize
 from tests.helpers import BoringModel
 from tests.helpers.runif import RunIf
@@ -33,10 +32,12 @@ def test_rich_model_summary_callback():
     assert isinstance(trainer.progress_bar_callback, RichProgressBar)
 
 
-def test_rich_progress_bar_import_error():
-    if not _RICH_AVAILABLE:
-        with pytest.raises(ImportError, match="`RichModelSummary` requires `rich` to be installed."):
-            Trainer(callbacks=RichModelSummary())
+def test_rich_progress_bar_import_error(monkeypatch):
+    import pytorch_lightning.callbacks.rich_model_summary as imports
+
+    monkeypatch.setattr(imports, "_RICH_AVAILABLE", False)
+    with pytest.raises(ModuleNotFoundError, match="`RichModelSummary` requires `rich` to be installed."):
+        RichModelSummary()
 
 
 @RunIf(rich=True)

tests/callbacks/test_rich_progress_bar.py

@@ -20,7 +20,6 @@
 from pytorch_lightning import Trainer
 from pytorch_lightning.callbacks import ProgressBarBase, RichProgressBar
 from pytorch_lightning.callbacks.progress.rich_progress import RichProgressBarTheme
-from pytorch_lightning.utilities.imports import _RICH_AVAILABLE
 from tests.helpers.boring_model import BoringModel, RandomDataset, RandomIterableDataset
 from tests.helpers.runif import RunIf
 
@@ -83,10 +82,12 @@ def predict_dataloader(self):
     assert progress_update.call_count == 8
 
 
-def test_rich_progress_bar_import_error():
-    if not _RICH_AVAILABLE:
-        with pytest.raises(ImportError, match="`RichProgressBar` requires `rich` >= 10.2.2."):
-            Trainer(callbacks=RichProgressBar())
+def test_rich_progress_bar_import_error(monkeypatch):
+    import pytorch_lightning.callbacks.progress.rich_progress as imports
+
+    monkeypatch.setattr(imports, "_RICH_AVAILABLE", False)
+    with pytest.raises(ModuleNotFoundError, match="`RichProgressBar` requires `rich` >= 10.2.2."):
+        RichProgressBar()
 
 
 @RunIf(rich=True)