add to_clp support

Author: dbatten5

README.md

@@ -34,7 +34,8 @@ Convert a `numpy.NDArray` to various LaTeX forms.
 \end{bmatrix}
 ```
 
-Inspired by @josephcslater's [array_to_latex](https://github.com/josephcslater/array_to_latex).
+Inspired by [@josephcslater](https://github.com/josephcslater)'s
+[array_to_latex](https://github.com/josephcslater/array_to_latex).
 
 ## Features
 

poetry.lock

@@ -19,6 +19,7 @@ Changelog = "https://github.com/dbatten5/arraytex/releases"
 python = "^3.8"
 click = ">=8.0.1"
 numpy = "^1.24.2"
+pyperclip = "^1.8.2"
 
 [tool.poetry.group.test.dependencies]
 pytest = "^6.2.4"

pyproject.toml

@@ -9,13 +9,16 @@
 from numpy.typing import NDArray
 
 from .errors import TooManyDimensionsError
+from .utils import use_clipboard
 
 
+@use_clipboard
 def to_matrix(
     arr: NDArray[Any],
     style: str = "b",
     num_format: Optional[str] = None,
     scientific_notation: bool = False,
+    to_clp: bool = False,
 ) -> str:
     """Convert a numpy.NDArray to LaTeX matrix.
 
@@ -25,6 +28,7 @@ def to_matrix(
         num_format: a number formatter string, e.g. ".2f"
         scientific_notation: a flag to determine whether 1 x 10^3 should be used,
             otherwise e-notation is used (1e3)
+        to_clp: copy the output to the system clipboard
 
     Returns:
         the string representation of the array

src/arraytex/api.py

@@ -0,0 +1,29 @@
+"""Utils module."""
+
+from functools import wraps
+from typing import Any
+from typing import Callable
+from typing import TypeVar
+from typing import cast
+
+import pyperclip
+
+
+F = TypeVar("F", bound=Callable[..., str])
+
+
+def use_clipboard(func: F) -> F:
+    """Augument decorated functions argument to copy the output to the clipboard."""
+
+    @wraps(func)
+    def wrapper_func(*args: Any, **kwargs: Any) -> str:
+        """Wrapped function."""
+        out = func(*args, **kwargs)
+
+        if kwargs.get("to_clp"):
+            pyperclip.copy(out)
+            print("ArrayTeX: copied to clipboard")
+
+        return out
+
+    return cast(F, wrapper_func)

src/arraytex/utils.py

@@ -1,4 +1,7 @@
 """Tests for the main API."""
+from unittest import mock
+from unittest.mock import MagicMock
+
 import numpy as np
 import pytest
 
@@ -136,3 +139,18 @@ def test_3_d(self) -> None:
 
         with pytest.raises(TooManyDimensionsError):
             to_matrix(mat)
+
+
+class TestClipboard:
+    """Tests for the `to_clp` arg."""
+
+    @mock.patch("arraytex.utils.pyperclip", autospec=True)
+    def test_success(self, mock_pyperclip: MagicMock) -> None:
+        """Outputs are copied to the clipboard."""
+        mat = np.array(1)
+
+        to_matrix(mat, to_clp=True)
+
+        mock_pyperclip.copy.assert_called_once_with(
+            "\\begin{bmatrix}\n1 \\\\\n\\end{bmatrix}"
+        )