gsplot 0.0.4__tar.gz → 0.0.6__tar.gz

{gsplot-0.0.4 → gsplot-0.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gsplot
-Version: 0.0.4
+Version: 0.0.6
 Summary: General-scientific plot based on matplotlib
 Author: Giordano Mattoni
 Author-email: mattoni@scphys.kyoto-u.ac.jp
@@ -32,7 +32,7 @@ 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>
@@ -48,13 +48,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.4 → gsplot-0.0.6}/README.md

@@ -12,7 +12,7 @@
 ----------------
 
 <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>
@@ -28,13 +28,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.4 → gsplot-0.0.6}/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.4 → gsplot-0.0.6}/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.4 → gsplot-0.0.6}/gsplot/logger.py

@@ -8,6 +8,8 @@ from rich.console import Console
 from rich.panel import Panel
 from rich.text import Text
 
+from .config.config import Config
+from .path.path import PathToMain
 from .version import __commit__, __version__
 
 

{gsplot-0.0.4 → gsplot-0.0.6}/gsplot/plot/line.py

@@ -121,7 +121,9 @@ class Line:
         """
         Sets the colors for the line, marker edge, and marker face.
         """
-        cycle_color: NDArray[Any] | str = AutoColor(self.axis_index).get_color()
+        # TODO: Remove next line
+        self.ax = self.axis
+        cycle_color: NDArray[Any] | str = AutoColor(self.ax).get_color()
         if isinstance(cycle_color, np.ndarray):
             cycle_color = colors.to_hex(
                 tuple(cycle_color)

{gsplot-0.0.4 → gsplot-0.0.6}/gsplot/plot/line_base.py

@@ -4,6 +4,7 @@ import threading
 from typing import Any, Callable, TypeVar, cast
 
 import numpy as np
+from matplotlib.axes import Axes
 from numpy.typing import NDArray
 
 from ..color.colormap import Colormap
@@ -70,50 +71,36 @@ class NumLines:
 
     def _initialize_num_lines(self) -> None:
         """
-        Initializes the line count to its default value ([0]).
+        Initializes the line count to its default dictionary ({}).
         """
         # Explicitly initialize the instance variable with a type hint
-        self._num_lines: list[int] = [0]
-
-    def update_num_lines(self, axis_index: int) -> None:
-        """
-        Ensures the line count list is large enough to include the given axis index.
-
-        Parameters
-        --------------------
-        axis_index : int
-            The index of the axis to update.
-        """
-        length = len(self._num_lines)
-        if axis_index + 1 > length:
-            self._num_lines.extend([0] * (axis_index - length + 1))
+        self._num_lines_dict: dict[Axes, int] = {}
 
     @property
-    def num_lines(self) -> list[int]:
+    def num_lines_dict(self) -> dict[Axes, int]:
         """
-        Retrieves the list of line counts for all axes.
+        Retrieves the dictionary containing the number of lines plotted on each axis.
 
         Returns
         --------------------
-        list[int]
-            The list of line counts, where each index corresponds to an axis.
+        dict[matplotlib.axes.Axes, int]
+            A dictionary where each key is an axis and the value is the number of lines plotted.
 
         Examples
         --------------------
         >>> num_lines = NumLines()
-        >>> print(num_lines.num_lines)
-        [0]
+        >>> print(num_lines.num_lines_dict)
         """
-        return self._num_lines
+        return self._num_lines_dict
 
-    def num_lines_axis(self, axis_index: int) -> int:
+    def num_lines(self, ax: Axes) -> int:
         """
         Retrieves the number of lines plotted on a specific axis.
 
         Parameters
         --------------------
-        axis_index : int
-            The index of the axis.
+        ax : matplotlib.axes.Axes
+            The axis to query.
 
         Returns
         --------------------
@@ -123,30 +110,29 @@ class NumLines:
         Examples
         --------------------
         >>> num_lines = NumLines()
-        >>> print(num_lines.num_lines_axis(0))
-        0
+        >>> print(num_lines.num_lines_axis(axs[0]))
         """
-        self.update_num_lines(axis_index)
-        return self._num_lines[axis_index]
+        if ax not in self._num_lines_dict:
+            self._num_lines_dict[ax] = 0
+        return self._num_lines_dict[ax]
 
-    def increment(self, axis_index: int) -> None:
+    def increment(self, ax: Axes) -> None:
         """
         Increments the line count for a specific axis.
 
         Parameters
         --------------------
-        axis_index : int
-            The index of the axis.
+        ax : matplotlib.axes.Axes
+            The axis to increment.
 
         Examples
         --------------------
         >>> num_lines = NumLines()
-        >>> num_lines.increment(0)
-        >>> print(num_lines.num_lines_axis(0))
-        1
+        >>> num_lines.increment(axs[1])
         """
-        self.update_num_lines(axis_index)
-        self._num_lines[axis_index] += 1
+        if ax not in self._num_lines_dict:
+            self._num_lines_dict[ax] = 0
+        self._num_lines_dict[ax] += 1
 
     @classmethod
     def count(cls, func: F) -> F:
@@ -169,14 +155,12 @@ class NumLines:
         ... def plot_line(axis_index):
         ...     print(f"Plotting on axis {axis_index}")
         >>> plot_line(0)
-        Plotting on axis 0
-        >>> num_lines = NumLines()
-        >>> print(num_lines.num_lines_axis(0))
-        1
         """
 
         def wrapper(self, *args: Any, **kwargs: Any) -> Any:
-            cls().increment(self.axis_index)
+            # TODO: Remove next line
+            ax = self.axis
+            cls().increment(ax)
             result = func(self, *args, **kwargs)
             return result
 
@@ -240,15 +224,18 @@ class AutoColor:
     array([0.267004, 0.004874, 0.329415, 1.0])  # Example RGBA color from the colormap
     """
 
-    def __init__(self, axis_index: int) -> None:
+    def __init__(self, ax) -> None:
+        self.ax: Axes = ax
         self.COLORMAP_LENGTH: int = 5
         self.CMAP = "viridis"
         self.colormap: NDArray[Any] = Colormap(
             cmap=self.CMAP, N=self.COLORMAP_LENGTH
         ).get_split_cmap()
 
-        self.num_lines_axis: int = NumLines().num_lines_axis(axis_index)
-        self.cycle_color_index: int = self.num_lines_axis % self.COLORMAP_LENGTH
+        _num_lines = NumLines()
+        self.num_lines: int = _num_lines.num_lines(self.ax)
+
+        self.cycle_color_index: int = self.num_lines % self.COLORMAP_LENGTH
 
     def get_color(self) -> NDArray[Any]:
         """

{gsplot-0.0.4 → gsplot-0.0.6}/gsplot/plot/scatter.py

@@ -87,6 +87,8 @@ class Scatter:
         self.x: NDArray[Any] = np.array(self._x)
         self.y: NDArray[Any] = np.array(self._y)
 
+        self.color = self.get_color()
+
     def get_color(self) -> ColorType:
         """
         Determines the color for the scatter points.
@@ -109,7 +111,9 @@ class Scatter:
         >>> scatter = Scatter(axis_target=0, x=[1, 2], y=[3, 4])
         >>> scatter.get_color()
         """
-        cycle_color: NDArray | str = AutoColor(self.axis_index).get_color()
+        # TODO: fix the next line
+        self.ax = self.axis
+        cycle_color: NDArray | str = AutoColor(self.ax).get_color()
         if isinstance(cycle_color, np.ndarray):
             cycle_color = colors.to_hex(
                 tuple(cycle_color)
@@ -146,7 +150,7 @@ class Scatter:
             self.x,
             self.y,
             s=self.size,
-            c=self.get_color(),
+            c=self.color,
             alpha=self.alpha,
             **self.kwargs,
         )

gsplot-0.0.6/gsplot/version.py

@@ -0,0 +1,2 @@
+__version__ = '0.0.6'
+__commit__ = 'c31bab11b951aabb64161cd75e0c34e7cd9c9164'

{gsplot-0.0.4 → gsplot-0.0.6}/pyproject.toml

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

gsplot-0.0.4/gsplot/version.py

@@ -1,2 +0,0 @@
-__version__ = '0.0.4'
-__commit__ = 'b4abb098ff682226095e5a00ef7c66de4e55b589'