gsplot 0.0.5__tar.gz → 0.1.0__tar.gz

{gsplot-0.0.5 → gsplot-0.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gsplot
-Version: 0.0.5
+Version: 0.1.0
 Summary: General-scientific plot based on matplotlib
 Author: Giordano Mattoni
 Author-email: mattoni@scphys.kyoto-u.ac.jp
@@ -32,13 +32,16 @@ Description-Content-Type: text/markdown
 ----------------
 
 <p align="center" style="font-weight: bold; font-size: 1.2em; margin: 20px 0;">
-  <a href="https://soichiroyamane.github.io/gsplot/" style="text-decoration: none;">Docs</a> |
+  <a href="https://soichiroyamane.github.io/gsplot/stable" style="text-decoration: none;">Docs</a> |
   <a href="#authors" style="text-decoration: none;">Authors</a> |
   <a href="#license" style="text-decoration: none;">License</a>
 </p>
 
 Welcome to **gsplot** (general-scientific plot), a toolkit designed to enhance the capabilities of data visualization based on [matplotlib](https://matplotlib.org). This package is specifically tailored for creating high-quality figures aimed at the scientific field.
 
+> [!WARNING]
+> This package is _beta_ quality. Expect breaking changes and many bugs 🐛. Please report any issue you encounter 🤝.
+
 ## ✨ Features
 
 - **Better Plot, Less Code**: Simplify the process of creating high-quality figures ⚛️
@@ -48,13 +51,13 @@ Welcome to **gsplot** (general-scientific plot), a toolkit designed to enhance t
 
 ### 📈 Example using gsplot
 
-[See more details](https://soichiroyamane.github.io/gsplot/guides/demo/4_paper_plot.html)
+[See more details](https://soichiroyamane.github.io/gsplot/guides/stable/demo/4_paper_plot.html)
 
 ![example](docs/_static/tutorial/SC_cal.png)
 
 ### 🌃 Example with Python REPL 🐍 and neovim 🌟
 
-[See more details](https://soichiroyamane.github.io/gsplot/guides/demo/13_REPL.html)
+[See more details](https://soichiroyamane.github.io/gsplot/stable/guides/demo/13_REPL.html)
 
 ![repl_tutorial](./docs/_static/tutorial/repl_tutorial_sp.gif)
 

{gsplot-0.0.5 → gsplot-0.1.0}/README.md

@@ -12,13 +12,16 @@
 ----------------
 
 <p align="center" style="font-weight: bold; font-size: 1.2em; margin: 20px 0;">
-  <a href="https://soichiroyamane.github.io/gsplot/" style="text-decoration: none;">Docs</a> |
+  <a href="https://soichiroyamane.github.io/gsplot/stable" style="text-decoration: none;">Docs</a> |
   <a href="#authors" style="text-decoration: none;">Authors</a> |
   <a href="#license" style="text-decoration: none;">License</a>
 </p>
 
 Welcome to **gsplot** (general-scientific plot), a toolkit designed to enhance the capabilities of data visualization based on [matplotlib](https://matplotlib.org). This package is specifically tailored for creating high-quality figures aimed at the scientific field.
 
+> [!WARNING]
+> This package is _beta_ quality. Expect breaking changes and many bugs 🐛. Please report any issue you encounter 🤝.
+
 ## ✨ Features
 
 - **Better Plot, Less Code**: Simplify the process of creating high-quality figures ⚛️
@@ -28,13 +31,13 @@ Welcome to **gsplot** (general-scientific plot), a toolkit designed to enhance t
 
 ### 📈 Example using gsplot
 
-[See more details](https://soichiroyamane.github.io/gsplot/guides/demo/4_paper_plot.html)
+[See more details](https://soichiroyamane.github.io/gsplot/guides/stable/demo/4_paper_plot.html)
 
 ![example](docs/_static/tutorial/SC_cal.png)
 
 ### 🌃 Example with Python REPL 🐍 and neovim 🌟
 
-[See more details](https://soichiroyamane.github.io/gsplot/guides/demo/13_REPL.html)
+[See more details](https://soichiroyamane.github.io/gsplot/stable/guides/demo/13_REPL.html)
 
 ![repl_tutorial](./docs/_static/tutorial/repl_tutorial_sp.gif)
 

{gsplot-0.0.5 → gsplot-0.1.0}/gsplot/__init__.py

@@ -1,6 +1,6 @@
 from .color.colormap import get_cmap
 from .config.config import (Config, config_dict, config_entry_option,
-                            config_load)
+                            config_load, save_metadata)
 from .data.load_file import load_file
 from .figure.axes import axes
 from .figure.figure_tools import get_figure_size
@@ -33,6 +33,10 @@ Config()
 # ╰──────────────────────────────────────────────────────────╯
 logger()
 
+# ╭──────────────────────────────────────────────────────────╮
+# │ Save Metadata                                            │
+# ╰──────────────────────────────────────────────────────────╯
+save_metadata()
 
 __version__ = __version__
 __commit__ = __commit__

{gsplot-0.0.5 → gsplot-0.1.0}/gsplot/config/config.py

@@ -2,13 +2,18 @@ from __future__ import annotations
 
 import json
 import os
+from datetime import datetime
 from threading import Lock
 from typing import Any, cast
 
 import matplotlib as mpl
+import yaml
 from matplotlib import rcParams
 from rich.traceback import install
 
+from ..path.path import PathToMain
+from ..version import __commit__, __version__
+
 rcParams["pdf.fonttype"] = 42
 rcParams["ps.fonttype"] = 42
 
@@ -148,9 +153,14 @@ class Config:
             loader.init_load() if config_path else loader.get_config()
         )
         self.config_dict = config_dict
+
+        # Save metadata
+        metadata_store = MetadataStore()
+        metadata_store.create_metadata()
+
         return config_dict
 
-    def get_config_entry_option(self, key: str) -> dict[str, Any]:
+    def get_config_entry_option(self, key: str) -> Any | dict[str, Any]:
         """
         Retrieves a specific entry from the configuration dictionary.
 
@@ -161,7 +171,7 @@ class Config:
 
         Returns
         --------------------
-        dict of str, Any
+        Any and dict of str, Any
             The configuration entry corresponding to the provided key.
 
         Examples
@@ -420,3 +430,170 @@ def config_entry_option(key: str) -> dict[str, Any]:
     _config: Config = Config()
     entry_option: dict[str, Any] = _config.get_config_entry_option(key)
     return entry_option
+
+
+class MetadataHistory:
+    def __init__(
+        self,
+        new_metadata: Any,
+        new_config: Any,
+        metadata_dir: str,
+    ) -> None:
+        self.new_metadata = new_metadata.copy()
+        self.new_config = new_config.copy()
+        self.metadata_dir = metadata_dir
+
+        self.needs_update = False
+
+        self.history: Any = {}
+        self.new_entry: Any = {}
+        self.history_dir = os.path.join(self.metadata_dir, "history")
+
+    def _get_old_metadata(self) -> None | Any:
+        if not os.path.exists(os.path.join(self.metadata_dir, "metadata.yml")):
+            return None
+
+        with open(os.path.join(self.metadata_dir, "metadata.yml"), "r") as file:
+            return yaml.safe_load(file)
+
+    def _get_old_config(self) -> None | Any:
+        if not os.path.exists(os.path.join(self.metadata_dir, "config.json")):
+            return None
+
+        with open(os.path.join(self.metadata_dir, "config.json"), "r") as file:
+            return json.load(file)
+
+    def _is_identical(self) -> None:
+        old_metadata = self._get_old_metadata()
+        old_config = self._get_old_config()
+
+        if not old_metadata or not old_config:
+            self.needs_update = True
+            return None
+
+        exclude_keys = ["date"]
+
+        def remove_keys(data: dict, keys: list) -> dict:
+            return {k: v for k, v in data.items() if k not in keys}
+
+        filtered_old_metadata = remove_keys(old_metadata, exclude_keys)
+        filtered_new_metadata = remove_keys(self.new_metadata, exclude_keys)
+
+        if filtered_old_metadata != filtered_new_metadata:
+            self.needs_update = True
+            return None
+
+        if old_config != self.new_config:
+            self.needs_update = True
+            return None
+
+    def _create_history_dir(self) -> None:
+        metadata_history_dir = os.path.join(self.history_dir)
+
+        if not os.path.exists(metadata_history_dir):
+            os.makedirs(metadata_history_dir)
+
+    def _read_history(self) -> Any:
+        self._create_history_dir()
+        history_file = os.path.join(self.history_dir, "history.txt")
+
+        if not os.path.exists(history_file):
+            return []
+
+        try:
+            with open(history_file, "r") as file:
+                return [json.loads(line) for line in file if line.strip()]
+        except Exception as e:
+            print(f"Error reading history file: {e}")
+            return []
+
+    def _create_new_history(self) -> None:
+        if not self.needs_update:
+            return None
+
+        self.history = self._read_history()
+
+        self.new_entry = self.new_metadata
+        self.new_entry["config"] = self.new_config
+
+    def _write_history(self) -> None:
+        history_file = os.path.join(self.history_dir, "history.txt")
+
+        with open(history_file, "a") as file:
+            json.dump(self.new_entry, file)
+            file.write("\n")
+
+    def create_history(self) -> None:
+        self._is_identical()
+        self._create_new_history()
+        if self.new_entry:
+            self._write_history()
+
+
+class MetadataStore:
+    def __init__(
+        self,
+    ) -> None:
+        path_to_main = PathToMain()
+        self.main_dir = path_to_main.get_executed_file_dir()
+        self.meta_data_dir_name = ".gsplot"
+        self.meta_data_dir = os.path.join(
+            self.main_dir,
+            self.meta_data_dir_name,
+        )
+
+        self.date = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
+        self.version = __version__
+        self.commit = __commit__
+
+        self.new_metadata = {
+            "date": self.date,
+            "version": self.version,
+            "commit": self.commit,
+        }
+
+        # get config dictionary
+        config = Config()
+        self.new_config_dict = config.config_dict
+        self.is_stored = config.get_config_entry_option("metadata")
+
+    def _create_metadata_dir(self) -> None:
+        if not os.path.exists(self.meta_data_dir):
+            os.makedirs(self.meta_data_dir)
+
+    def _create_new_metadata(self) -> None:
+
+        with open(os.path.join(self.meta_data_dir, "metadata.yml"), "w") as file:
+            yaml.dump(
+                self.new_metadata,
+                file,
+                default_flow_style=False,
+                sort_keys=False,
+                indent=2,
+            )
+
+    def _create_new_config(self) -> None:
+        with open(os.path.join(self.meta_data_dir, "config.json"), "w") as file:
+            # write config dictionary to file as json
+            json.dump(self.new_config_dict, file, indent=2)
+
+    def create_metadata(self) -> None:
+        if not self.is_stored:
+            return None
+
+        self._create_metadata_dir()
+
+        metadata_history = MetadataHistory(
+            new_metadata=self.new_metadata,
+            new_config=self.new_config_dict,
+            metadata_dir=self.meta_data_dir,
+        )
+        metadata_history.create_history()
+
+        self._create_new_metadata()
+        self._create_new_config()
+
+
+def save_metadata() -> None:
+    _metadata = MetadataStore()
+    _metadata.create_metadata()

{gsplot-0.0.5 → gsplot-0.1.0}/gsplot/figure/axes.py

@@ -8,7 +8,7 @@ from matplotlib.typing import HashableList
 
 from ..base.base import CreateClassParams, ParamsGetter, bind_passed_params
 from ..plot.line_base import NumLines
-from .axes_base import AxesRangeSingleton
+from .axes_range_base import AxesRangeSingleton
 from .store import StoreSingleton
 
 _T = TypeVar("_T")
@@ -285,7 +285,7 @@ class AxesHandler(Generic[_T]):
             raise ValueError("Mosaic must be specified.")
 
         # Initialize the axes range list by the number of axes in the current figure
-        AxesRangeSingleton().reset(plt.gcf().axes)
+        AxesRangeSingleton().reset()
 
 
 @bind_passed_params()

gsplot-0.1.0/gsplot/figure/axes_base.py

@@ -0,0 +1,288 @@
+from __future__ import annotations
+
+from typing import Any, Callable, TypeVar
+
+import matplotlib.pyplot as plt
+import numpy as np
+from matplotlib.axes import Axes
+from matplotlib.transforms import Bbox
+from numpy.typing import NDArray
+
+from .figure_tools import FigureLayout
+
+F = TypeVar("F", bound=Callable[..., Any])
+
+__all__: list[str] = []
+
+
+# class AxesResolver:
+#     """
+#     Resolves an axis target to a Matplotlib `Axes` object or its index.
+#
+#     This class provides a mechanism to convert an axis target, which can be either
+#     an integer (index of the axis) or an `Axes` object, into a consistent representation
+#     including the corresponding `Axes` object and its index within the current figure.
+#
+#     Parameters
+#     --------------------
+#     axis_target : int or matplotlib.axes.Axes
+#         The target axis to resolve. Can be an integer representing the index of the
+#         axis in the current figure or a specific `Axes` object.
+#
+#     Attributes
+#     --------------------
+#     axis_target : int or matplotlib.axes.Axes
+#         The input target axis (as provided by the user).
+#     _axis_index : int or None
+#         The resolved index of the target axis in the current figure.
+#     _axis : matplotlib.axes.Axes or None
+#         The resolved `Axes` object corresponding to the target.
+#
+#     Methods
+#     --------------------
+#     _resolve_type()
+#         Resolves the type of the axis target and retrieves the corresponding
+#         `Axes` object and its index.
+#     axis_index
+#         Returns the resolved index of the axis.
+#     axis
+#         Returns the resolved `Axes` object.
+#
+#     Raises
+#     --------------------
+#     IndexError
+#         If the provided axis index is out of range for the current figure.
+#     ValueError
+#         If the axis target is neither an integer nor an `Axes` object.
+#
+#     Examples
+#     --------------------
+#     >>> import matplotlib.pyplot as plt
+#     >>> fig, axs = plt.subplots(2, 2)
+#     >>> resolver = AxesResolver(1)  # Resolves the second axis (index 1)
+#     >>> print(resolver.axis)
+#     AxesSubplot(0.5,0.5;0.352273x0.352273)
+#
+#     >>> resolver = AxesResolver(axs[0, 0])  # Resolves an Axes object directly
+#     >>> print(resolver.axis_index)
+#     0
+#     """
+#
+#     def __init__(self, axis_target: int | Axes) -> None:
+#         self.axis_target: int | Axes = axis_target
+#
+#         self._axis_index: int | None = None
+#         self._axis: Axes | None = None
+#
+#         self._resolve_type()
+#
+#     def _resolve_type(self) -> None:
+#         """
+#         Resolves the type of the axis target and retrieves the corresponding
+#         `Axes` object and its index.
+#
+#         Raises
+#         --------------------
+#         IndexError
+#             If the provided axis index is out of range for the current figure.
+#         ValueError
+#             If the axis target is neither an integer nor an `Axes` object.
+#         """
+#
+#         def ordinal_suffix(n: int) -> str:
+#             if 11 <= n % 100 <= 13:
+#                 suffix = "th"
+#             else:
+#                 suffix = {1: "st", 2: "nd", 3: "rd"}.get(n % 10, "th")
+#             return f"{n}{suffix}"
+#
+#         if isinstance(self.axis_target, int):
+#             self._axis_index = self.axis_target
+#             axes = plt.gcf().axes
+#             try:
+#                 self._axis = axes[self._axis_index]
+#             except IndexError:
+#                 error_message = f"Axes out of range: {self._axis_index} => Number of axes: {len(axes)}, but requested {ordinal_suffix(self._axis_index + 1)} axis."
+#                 raise IndexError(error_message)
+#         elif isinstance(self.axis_target, Axes):
+#             self._axis = self.axis_target
+#             if self.axis_target in plt.gcf().axes:
+#                 self._axis_index = plt.gcf().axes.index(self._axis)
+#             else:
+#                 # Add the axis to the current figure if it is not present
+#                 plt.gcf().add_axes(self._axis)
+#                 self._axis_index = len(plt.gcf().axes) - 1
+#         else:
+#             raise ValueError(
+#                 "Invalid axis target. Please provide an integer or Axes object."
+#             )
+#
+#     @property
+#     def axis_index(self) -> int:
+#         """
+#         Returns the resolved index of the target axis.
+#
+#         Returns
+#         --------------------
+#         int
+#             The index of the resolved axis.
+#
+#         Raises
+#         --------------------
+#         ValueError
+#             If the axis index is not resolved.
+#         """
+#         if isinstance(self._axis_index, int):
+#             return self._axis_index
+#         else:
+#             raise ValueError("Axis index not resolved. Please check the AxisResolver")
+#
+#     @property
+#     def axis(self) -> Axes:
+#         """
+#         Returns the resolved `Axes` object.
+#
+#         Returns
+#         --------------------
+#         matplotlib.axes.Axes
+#             The resolved `Axes` object.
+#
+#         Raises
+#         --------------------
+#         ValueError
+#             If the axis is not resolved.
+#         """
+#         if isinstance(self._axis, Axes):
+#             return self._axis
+#         else:
+#             raise ValueError("Axis not resolced. Please check the AxisResolver")
+
+
+class AxisLayout:
+    """
+    A utility class for managing axis layout properties in a Matplotlib figure.
+
+    This class provides methods to retrieve an axis's position and size, both in
+    normalized figure coordinates and in physical units (inches). It integrates
+    with the `AxesResolver` and `FigureLayout` classes to ensure consistent layout
+    calculations.
+
+    Parameters
+    --------------------
+    ax : matplotlib.axes.Axes
+        The target `Axes` object for which to manage the
+
+    Attributes
+    --------------------
+    ax : matplotlib.axes.Axes
+        The target `Axes` object for which to manage the layout.
+    fig_size : numpy.ndarray
+        The size of the figure in inches as a NumPy array.
+
+    Methods
+    --------------------
+    get_axis_position()
+        Returns the position of the axis in normalized figure coordinates.
+    get_axis_size()
+        Returns the size of the axis in normalized figure coordinates.
+    get_axis_position_inches()
+        Returns the position of the axis in physical units (inches).
+    get_axis_size_inches()
+        Returns the size of the axis in physical units (inches).
+
+    Examples
+    --------------------
+    >>> fig, ax = plt.subplots()
+    >>> layout = AxisLayout(ax)
+    >>> position = layout.get_axis_position()
+    >>> size = layout.get_axis_size()
+    >>> position_inches = layout.get_axis_position_inches()
+    """
+
+    def __init__(self, ax: Axes) -> None:
+        self.ax: Axes = ax
+        self.fig_size: NDArray[Any] = FigureLayout().get_figure_size()
+
+    def get_axis_position(self) -> Bbox:
+        """
+        Retrieves the position of the axis in normalized figure coordinates.
+
+        Returns
+        --------------------
+        matplotlib.transforms.Bbox
+            The position of the axis as a bounding box in normalized coordinates.
+
+        Examples
+        --------------------
+        >>> layout = AxisLayout(axis_index=0)
+        >>> position = layout.get_axis_position()
+        >>> print(position)
+        Bbox(x0=0.1, y0=0.1, x1=0.9, y1=0.9)
+        """
+        axis_position = self.ax.get_position()
+        return axis_position
+
+    def get_axis_size(self) -> NDArray[Any]:
+        """
+        Retrieves the size of the axis in normalized figure coordinates.
+
+        Returns
+        --------------------
+        numpy.ndarray
+            The width and height of the axis as a NumPy array.
+
+        Examples
+        --------------------
+        >>> layout = AxisLayout(axis_index=0)
+        >>> size = layout.get_axis_size()
+        >>> print(size)
+        array([0.8, 0.8])
+        """
+        axis_position_size = np.array(self.get_axis_position().size)
+        return axis_position_size
+
+    def get_axis_position_inches(self) -> Bbox:
+        """
+        Retrieves the position of the axis in physical units (inches).
+
+        Returns
+        --------------------
+        matplotlib.transforms.Bbox
+            The position of the axis as a bounding box in inches.
+
+        Examples
+        --------------------
+        >>> layout = AxisLayout(axis_index=0)
+        >>> position_inches = layout.get_axis_position_inches()
+        >>> print(position_inches)
+        Bbox(x0=1.6, y0=1.6, x1=14.4, y1=14.4)
+        """
+
+        axis_position = self.get_axis_position()
+
+        axis_position_inches = Bbox.from_bounds(
+            axis_position.x0 * self.fig_size[0],
+            axis_position.y0 * self.fig_size[1],
+            axis_position.width * self.fig_size[0],
+            axis_position.height * self.fig_size[1],
+        )
+        return axis_position_inches
+
+    def get_axis_size_inches(self) -> NDArray[Any]:
+        """
+        Retrieves the size of the axis in physical units (inches).
+
+        Returns
+        --------------------
+        numpy.ndarray
+            The width and height of the axis in inches as a NumPy array.
+
+        Examples
+        --------------------
+        >>> layout = AxisLayout(axis_index=0)
+        >>> size_inches = layout.get_axis_size_inches()
+        >>> print(size_inches)
+        array([12.8, 12.8])
+        """
+        axis_position_size_inches = np.array(self.get_axis_position_inches().size)
+        return axis_position_size_inches