gsplot 0.1.4__tar.gz → 0.2.0__tar.gz

{gsplot-0.1.4 → gsplot-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: gsplot
-Version: 0.1.4
+Version: 0.2.0
 Summary: General-scientific plot based on matplotlib
 Author: Giordano Mattoni
 Author-email: mattoni@scphys.kyoto-u.ac.jp

{gsplot-0.1.4 → gsplot-0.2.0}/gsplot/figure/axes.py

@@ -150,8 +150,8 @@ class AxesHandler(Generic[_T]):
     --------------------
     store : bool, optional
         Whether to use a shared storage for axes or figure states (default is False).
-    size : list of int or float, optional
-        The size of the figure in the specified unit (default is [5, 5]).
+    size : tuple of int or float, optional
+        The size of the figure in the specified unit (default is (5, 5)).
     unit : str, optional
         The unit for the figure size. Supported units are "mm", "cm", "in", and "pt" (default is "in").
     mosaic : str or list of HashableList[_T] or list of HashableList[Hashable], optional
@@ -160,16 +160,14 @@ class AxesHandler(Generic[_T]):
         Whether to clear the current figure before creating a new one (default is True).
     ion : bool, optional
         Whether to enable interactive mode for the figure (default is False).
-    *args : Any
-        Additional positional arguments to pass to Matplotlib's figure creation methods.
     **kwargs : Any
-        Additional keyword arguments to pass to Matplotlib's figure creation methods.
+        Additional keyword arguments to pas to `subplot_mosaic`.
 
     Attributes
     --------------------
     store : bool
         Indicates whether shared storage is used.
-    size : list of int or float
+    size : tuple of int or float
         The size of the figure in the specified unit.
     unit : {"mm", "cm", "in", "pt"}
         The unit for the figure size.
@@ -194,7 +192,7 @@ class AxesHandler(Generic[_T]):
     Examples
     --------------------
     >>> handler = AxesHandler(
-    ...     size=[10, 8],
+    ...     size=(10, 8),
     ...     unit="cm",
     ...     mosaic="AB;CD",
     ...     ion=True
@@ -208,23 +206,22 @@ class AxesHandler(Generic[_T]):
     def __init__(
         self,
         store: bool = False,
-        size: list[int | float] = [5, 5],
+        size: tuple[int | float, int | float] = (5, 5),
         unit: Literal["mm", "cm", "in", "pt"] = "in",
         mosaic: str | list[HashableList[_T]] | list[HashableList[Hashable]] = "A",
         clear: bool = True,
         ion: bool = False,
-        *args: Any,
         **kwargs: Any,
     ) -> None:
         self.store = store
-        self.size: list[int | float] = size
+        self.size: tuple[int | float, int | float] = size
         self.unit: str = unit
         self.mosaic: str | list[HashableList[_T]] | list[HashableList[Hashable]] = (
             mosaic
         )
+
         self.clear: bool = clear
         self.ion: bool = ion
-        self.args: Any = args
         self.kwargs: Any = kwargs
 
         self._store_singleton = StoreSingleton()
@@ -256,7 +253,7 @@ class AxesHandler(Generic[_T]):
 
         Examples
         --------------------
-        >>> handler = AxesHandler(size=[10, 8], unit="cm", mosaic="AB;CD", ion=True)
+        >>> handler = AxesHandler(size=(10, 8), unit="cm", mosaic="AB;CD", ion=True)
         >>> handler.create_figure()
         """
         NumLines().reset()
@@ -274,11 +271,10 @@ class AxesHandler(Generic[_T]):
             self.unit_conv.convert(self.size[0], self.unit_enum),
             self.unit_conv.convert(self.size[1], self.unit_enum),
         )
-        plt.gcf().set_size_inches(*conv_size, *self.args, **self.kwargs)
+        plt.gcf().set_size_inches(*conv_size)
 
         if self.mosaic != "":
-            plt.gcf().subplot_mosaic(self.mosaic)
-
+            plt.gcf().subplot_mosaic(mosaic=self.mosaic, **self.kwargs)
             # To ensure that the axes are tightly packed, otherwise axes sizes will be different after tight_layout is called
             plt.tight_layout()
         else:
@@ -291,12 +287,11 @@ class AxesHandler(Generic[_T]):
 @bind_passed_params()
 def axes(
     store: bool = False,
-    size: list[int | float] = [5, 5],
+    size: tuple[int | float, int | float] = (5, 5),
     unit: Literal["mm", "cm", "in", "pt"] = "in",
     mosaic: str | list[HashableList[_T]] | list[HashableList[Hashable]] = "A",
     clear: bool = True,
     ion: bool = False,
-    *args: Any,
     **kwargs: Any,
 ):
     """
@@ -310,8 +305,8 @@ def axes(
     --------------------
     store : bool, optional
         Whether to use a shared storage for axes or figure states (default is False).
-    size : list of int or float, optional
-        The size of the figure in the specified unit (default is [5, 5]).
+    size : tuple of int or float, optional
+        The size of the figure in the specified unit (default is (5, 5)).
     unit : {"mm", "cm", "in", "pt"}, optional
         The unit for the figure size. Supported units are "mm", "cm", "in", and "pt" (default is "in").
     mosaic : str or list of HashableList[_T] or list of HashableList[Hashable], optional
@@ -320,10 +315,8 @@ def axes(
         Whether to clear the current figure before creating a new one (default is True).
     ion : bool, optional
         Whether to enable interactive mode for the figure (default is False).
-    *args : Any
-        Additional positional arguments to pass to Matplotlib's figure creation methods.
     **kwargs : Any
-        Additional keyword arguments to pass to Matplotlib's figure creation methods.
+        Additional keyword arguments to pass to `subplot_mosaic`.
 
     Notes
     --------------------
@@ -339,7 +332,7 @@ def axes(
     Examples
     --------------------
     >>> import gsplot as
-    >>> axs = gs.axes(size=[10, 8], unit="cm", mosaic="AB;CD", ion=True)
+    >>> axs = gs.axes(size=(10, 8), unit="cm", mosaic="AB;CD", ion=True)
     >>> print(axs)
     [<Axes: label='A'>, <Axes: label='B'>, <Axes: label='C'>, <Axes: label='D'>]
     """

{gsplot-0.1.4 → gsplot-0.2.0}/gsplot/style/label.py

@@ -758,8 +758,47 @@ class Label:
                 ax, x_lab, y_lab, self.xpad_label, self.ypad_label, **self.kwargs
             )
 
-            # Configure axis limits and scales
-            self.configure_axis_limits(ax, lims, final_axes_ranges)
+            # Configure axis limits and scales if not polar axis
+            if not ax.name.startswith("polar"):
+                self.configure_axis_limits(ax, lims, final_axes_ranges)
+            else:
+                self._configure_polar_axis(ax, x_lab, y_lab, lims)
+
+    def _configure_polar_axis(
+        self, ax: Axes, x_lab: str, y_lab: str, lims: list
+    ) -> None:
+        """
+        Configures labels and limits for a polar axis.
+        Parameters
+        --------------------
+        ax : Axes
+            The polar axis to configure.
+        x_lab : str
+            The label for the x-axis (theta).
+        y_lab : str
+            The label for the y-axis (r).
+        lims : list
+            The limits for the polar axis, where lims[0] is theta limits and lims[1] is r limits.
+        Returns
+        --------------------
+        None
+        """
+        # Set labels for polar axis
+        ax.set_xlabel(x_lab, labelpad=self.xpad_label, **self.kwargs)
+        ax.set_ylabel(y_lab, labelpad=self.ypad_label, **self.kwargs)
+        # Set limits for polar axis: theta
+        # check if component is a number
+        if isinstance(lims[0][0], (int, float)) and isinstance(
+            lims[0][1], (int, float)
+        ):
+            ax.set_thetamin(lims[0][0])  # type: ignore # mypy-ignore[no-untyped-call]
+            ax.set_thetamax(lims[0][1])  # type: ignore # mypy-ignore[no-untyped-call]
+        # Set limits for polar axis: r
+        if isinstance(lims[1][0], (int, float)) and isinstance(
+            lims[1][1], (int, float)
+        ):
+            ax.set_rmin(lims[1][0])  # type: ignore # mypy-ignore[no-untyped-call]
+            ax.set_rmax(lims[1][1])  # type: ignore # mypy-ignore[no-untyped-call]
 
     def _calculate_padding_range(self, range: NDArray[Any]) -> NDArray[Any]:
         """

gsplot-0.2.0/gsplot/version.py

@@ -0,0 +1,2 @@
+__version__ = '0.2.0'
+__commit__ = '1d0c220a25e2ec79eea0d73212d4631524f25150'

{gsplot-0.1.4 → gsplot-0.2.0}/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "gsplot"
 
-version = "0.1.4"
+version = "0.2.0"
 
 description = "General-scientific plot based on matplotlib"
 authors = [

gsplot-0.1.4/gsplot/version.py

@@ -1,2 +0,0 @@
-__version__ = '0.1.4'
-__commit__ = '0a12f2e70bdfc952f9e6467e52fdd60e56412894'