check for too many dimensions

Author: dbatten5

README.md

@@ -40,6 +40,7 @@ Inspired by @josephcslater's [array_to_latex](https://github.com/josephcslater/a
 
 - Support for different environment delimiters (`bmatrix` or `pmatrix`) and different
   number formatters (`:.2f`, `:.3e`, etc.).
+- Fully tested and typed.
 
 ## Requirements
 

src/arraytex/api.py

@@ -8,6 +8,8 @@
 import numpy as np
 from numpy.typing import NDArray
 
+from .errors import TooManyDimensionsError
+
 
 def to_matrix(
     arr: NDArray[Any],
@@ -26,7 +28,13 @@ def to_matrix(
 
     Returns:
         the string representation of the array
+
+    Raises:
+        TooManyDimensionsError: when the supplied array has more than 2 dimensions
     """
+    if len(arr.shape) > 2:
+        raise TooManyDimensionsError
+
     environment = f"{style}matrix"
 
     formatter = {}

src/arraytex/errors.py

@@ -0,0 +1,5 @@
+"""Module to hold custom errors."""
+
+
+class TooManyDimensionsError(Exception):
+    """Raised when an array of more than 2 dimensions is supplied."""

tests/test_api.py

@@ -1,7 +1,9 @@
 """Tests for the main API."""
 import numpy as np
+import pytest
 
 from arraytex.api import to_matrix
+from arraytex.errors import TooManyDimensionsError
 
 
 class TestToMatrix:
@@ -101,3 +103,36 @@ def test_scientific_notation(self) -> None:
 4.00 \times 10^{-03} & 5.00 \times 10^{-03} & 6.00 \times 10^{-03} \\
 \end{bmatrix}"""
         )
+
+    def test_one_d(self) -> None:
+        """One dimensional vectors are handled correctly."""
+        mat = np.array([1, 2, 3])
+
+        out = to_matrix(mat)
+
+        assert (
+            out
+            == r"""\begin{bmatrix}
+1 & 2 & 3 \\
+\end{bmatrix}"""
+        )
+
+    def test_0_d(self) -> None:
+        """0 dimensional vectors are handled correctly."""
+        mat = np.array(1)
+
+        out = to_matrix(mat)
+
+        assert (
+            out
+            == r"""\begin{bmatrix}
+1 \\
+\end{bmatrix}"""
+        )
+
+    def test_3_d(self) -> None:
+        """>2 dimensional arrays are handled correctly."""
+        mat = np.arange(8).reshape(2, 2, 2)
+
+        with pytest.raises(TooManyDimensionsError):
+            to_matrix(mat)