drawlib 0.1.33.dev2__tar.gz → 0.1.35__tar.gz

{drawlib-0.1.33.dev2 → drawlib-0.1.35}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: drawlib
-Version: 0.1.33.dev2
+Version: 0.1.35
 Summary: Python drawing library. Illustration as Code.
 Home-page: https://www.drawlib.com
 Author: Yuichi Ito

drawlib-0.1.35/drawlib/__init__.py

@@ -0,0 +1,87 @@
+# Copyright (c) 2024 Yuichi Ito (yuichi@yuichi.com)
+#
+# This software is licensed under the Apache License, Version 2.0.
+# For more information, please visit: https://github.com/yuichi110/drawlib
+#
+# This software is provided "as is", without warranty of any kind,
+# express or implied, including but not limited to the warranties of
+# merchantability, fitness for a particular purpose and noninfringement.
+
+"""Root package."""
+
+import re
+import sys
+from typing import Final, List
+
+# please update here when you release new version
+LIB_VERSION = "0.1.35"
+
+# please list active main committers (1+ commits per month)
+AUTHORS: Final[List[str]] = [
+    "Yuichi Ito <yuichi@yuichi.com>",
+]
+
+# please change accordingly
+LIB_NAME: Final[str] = "drawlib"
+DESCRIPTION: Final[str] = "Python drawing library. Illustration as Code."
+HOMEPAGE: Final[str] = "https://www.drawlib.com"
+REPOSITORY: Final[str] = "https://github.com/yuichi110/drawlib"
+README: Final[str] = "pypi.md"
+
+__version__: Final[str] = LIB_VERSION
+
+
+def _check_version_syntax() -> None:  # noqa: C901
+    parts = tuple(int(part) if part.isdigit() else part for part in LIB_VERSION.split("."))
+
+    if not isinstance(parts[0], int):
+        raise ValueError(f"Major version must be int. But {LIB_VERSION}")
+
+    if not isinstance(parts[1], int):
+        raise ValueError(f"Minor version must be int. But {LIB_VERSION}")
+
+    if not isinstance(parts[0], int):
+        raise ValueError(f"Patch version must be int. But {LIB_VERSION}")
+
+    if len(parts) == 3:
+        return
+
+    if len(parts) != 4:
+        raise ValueError(
+            f'Version syntax is "major.minor.patch" or "major.minor.patch.pre-release". But {LIB_VERSION}',
+        )
+
+    pre_version = parts[3]
+    if not isinstance(pre_version, str):
+        raise ValueError(f"Pre-release version can't be int. But {LIB_VERSION}")
+
+    def get_dev_value(text: str) -> int:
+        matches = re.findall(r"dev(\d+)", text)
+        values = [int(match) for match in matches]
+        if not values:
+            return -1
+        return values[0]
+
+    def get_rc_value(text: str) -> int:
+        matches = re.findall(r"rc(\d+)", text)
+        values = [int(match) for match in matches]
+        if not values:
+            return -1
+        return values[0]
+
+    if get_dev_value(pre_version) >= 1:
+        return
+
+    if get_rc_value(pre_version) >= 1:
+        return
+
+    raise ValueError(f"Pre-release version must be dev<n> or rc<n>. But {LIB_VERSION}")
+
+
+try:
+    _check_version_syntax()
+except ValueError as e:
+    print(f"System Error. Version syntax has problem. {str(e)}")
+    print("Please check drawlib.__init__.py")
+    print("Abort.")
+    sys.exit(1)

drawlib-0.1.35/drawlib/__init__.pyi

@@ -0,0 +1,17 @@
+"""
+This type stub file was generated by pyright.
+"""
+
+import re
+import sys
+from typing import Final, List
+
+"""Root package."""
+LIB_VERSION = ...
+AUTHORS: Final[List[str]] = ...
+LIB_NAME: Final[str] = ...
+DESCRIPTION: Final[str] = ...
+HOMEPAGE: Final[str] = ...
+REPOSITORY: Final[str] = ...
+README: Final[str] = ...
+__version__: Final[str] = ...

drawlib-0.1.35/drawlib/__main__.pyi

@@ -0,0 +1,11 @@
+"""
+This type stub file was generated by pyright.
+"""
+
+"""Entry point of drawlib command."""
+def main() -> None:
+    """Call latest drawlib command"""
+    ...
+
+if __name__ == "__main__":
+    ...

drawlib-0.1.35/drawlib/apis.pyi

@@ -0,0 +1,7 @@
+"""
+This type stub file was generated by pyright.
+"""
+
+from drawlib.v0_1.apis import *
+
+"""Latest API module."""

drawlib-0.1.35/drawlib/assets/__init__.pyi

@@ -0,0 +1,5 @@
+"""
+This type stub file was generated by pyright.
+"""
+
+"""Root of asset package."""

drawlib-0.1.35/drawlib/assets/v0_1/__init__.pyi

@@ -0,0 +1,5 @@
+"""
+This type stub file was generated by pyright.
+"""
+
+"""Root of v0.1 asset package."""

drawlib-0.1.35/drawlib/v0_1/__init__.pyi

@@ -0,0 +1,10 @@
+"""
+This type stub file was generated by pyright.
+"""
+
+import drawlib
+from typing import Final
+
+"""Root package of API v0.1"""
+LIB_VERSION: Final[str] = ...
+__version__: Final[str] = ...

drawlib-0.1.35/drawlib/v0_1/apis.pyi

@@ -0,0 +1,5 @@
+"""
+This type stub file was generated by pyright.
+"""
+
+"""API v0.1 module."""

drawlib-0.1.35/drawlib/v0_1/private/__init__.pyi

@@ -0,0 +1,5 @@
+"""
+This type stub file was generated by pyright.
+"""
+
+"""Root package of API v0.1 implementation."""

drawlib-0.1.35/drawlib/v0_1/private/command.pyi

@@ -0,0 +1,165 @@
+"""
+This type stub file was generated by pyright.
+"""
+
+from typing import List, Literal
+from drawlib.v0_1.private.util import error_handler
+
+"""Implementation of drawlib command."""
+def call() -> None:
+    """Handle drawlib command execution.
+
+    This function serves as the entry point for executing drawlib commands.
+    It parses command-line arguments, processes options like showing version info
+    or purging font cache, sets logging levels, retrieves target files and directories,
+    and executes each target file using the DrawlibExecuter.
+
+    Raises:
+        ValueError: If an invalid logging mode is specified.
+    """
+    ...
+
+class DrawlibArgParser:
+    """Command-line argument parser for drawlib.
+
+    Parses command-line options related to drawlib execution, such as target files,
+    version display, font cache purging, logging modes, and execution modes.
+    """
+    def __init__(self) -> None:
+        """
+        Initializes a DrawlibArgParser instance.
+
+        In this method, an ArgumentParser instance is created to define command line options
+        for drawlib execution related parameters such as target files, version display, font cache purging,
+        logging modes, and execution modes.
+
+        Returns:
+            None
+        """
+        ...
+    
+    def parse(self) -> None:
+        """Parse command line options.
+
+        Parses command line options using the ArgumentParser instance.
+        It separates special options from main positional arguments and stores them internally.
+
+        This method must be called before calling any other methods that retrieve parsed options.
+
+        Returns:
+            None
+        """
+        ...
+    
+    def is_show_version(self) -> bool:
+        """Check if the version option is specified.
+
+        Checks whether the command line options include `-v` or `--version`.
+        If either option is present, it returns True; otherwise, False.
+
+        Returns:
+            bool: True if version option is specified, False otherwise.
+
+        """
+        ...
+    
+    def is_purge_font_cache(self) -> bool:
+        """Check if the purge font cache option is specified.
+
+        Checks whether the command line options include `--purge_font_cache`.
+        If the option is present, it returns True; otherwise, False.
+
+        Returns:
+            bool: True if purge font cache option is specified, False otherwise.
+
+        """
+        ...
+    
+    def get_logging_mode(self) -> Literal["quiet", "normal", "verbose", "developer"]:
+        """Retrieve the logging mode based on command line options.
+
+        Checks the command line options for logging-related flags:
+        - `--quiet`: Returns "quiet" logging mode.
+        - `--verbose` or `--debug`: Returns "verbose" logging mode.
+        - `--developer`: Returns "developer" logging mode.
+
+        Raises:
+            ValueError: If conflicting logging options are specified.
+
+        Returns:
+            Literal["quiet", "normal", "verbose", "developer"]: Logging mode.
+        """
+        ...
+    
+    def get_exec_mode(self) -> Literal["none", "auto_clear", "auto_initialize"]:
+        """Retrieve the execution mode based on command line options.
+
+        Checks the command line options for execution mode flags:
+        - `--disable_auto_clear`: Returns "none" execution mode.
+        - `--enable_auto_initialize`: Returns "auto_initialize" execution mode.
+
+        Returns:
+            Literal["none", "auto_clear", "auto_initialize"]: Execution mode.
+        """
+        ...
+    
+    def get_target_files(self) -> List[str]:
+        """Retrieve positional arguments representing target files and directories.
+
+        Retrieves the positional arguments passed to the drawlib command,
+        which are intended as target files or directories for execution.
+
+        Returns:
+            List[str]: List of positional arguments (files and directories).
+        """
+        ...
+    
+
+
+class DrawlibExecuter:
+    """Executor for running Python files or directories containing drawing code.
+
+    Executes Python files specified as targets or recursively runs all Python files
+    within a specified directory. Handles logging, module loading, and error handling.
+    """
+    def __init__(self, mode: Literal["none", "auto_clear", "auto_initialize"]) -> None:
+        """Initializes a DrawlibExecuter instance with the specified mode.
+
+        Args:
+            mode (Literal["none", "auto_clear", "auto_initialize"]):
+                The execution mode for handling Python file execution:
+                - "none": Executes Python files without clearing canvas between executions.
+                - "auto_clear": Automatically clears the canvas between executing each Python file.
+                - "auto_initialize": Automatically initializes theme/canvas/image_cache per execution.
+
+                Raises ValueError if mode is not one of ["none", "auto_clear", "auto_initialize"].
+
+        Raises:
+            ValueError: If mode is not one of ["none", "auto_clear", "auto_initialize"].
+        """
+        ...
+    
+    @error_handler
+    def execute(self, file_or_directory: str) -> None:
+        """Execute the specified Python file or all Python files in the specified directory.
+
+        Executes the Python file specified by `file_or_directory` or recursively executes all Python files
+        found within the specified directory. Each Python file is executed only once.
+
+        For directories, strongly recommend setting `auto_clear=True` to avoid shared canvas state
+        between different Python files.
+
+        Args:
+            file_or_directory (str): Path to the Python file or directory containing Python files to execute.
+
+        Returns:
+            None
+
+        Raises:
+            ValueError: If the specified path `file_or_directory` does not exist.
+
+        """
+        ...
+    
+
+

drawlib-0.1.35/drawlib/v0_1/private/core/__init__.pyi

@@ -0,0 +1,5 @@
+"""
+This type stub file was generated by pyright.
+"""
+
+"""Helper package of core drawing actions."""

drawlib-0.1.35/drawlib/v0_1/private/core/colors.pyi

@@ -0,0 +1,226 @@
+"""
+This type stub file was generated by pyright.
+"""
+
+from typing import Final, Tuple
+
+"""Color definition module."""
+class ColorsBase:
+    """Base class for color-related classes, providing common attributes."""
+    Transparent: Final[Tuple[int, int, int, float]] = ...
+
+
+class Colors(ColorsBase):
+    """Class representing the 16 basic web colors along with a transparent color."""
+    Aqua: Final[Tuple[int, int, int]] = ...
+    Black: Final[Tuple[int, int, int]] = ...
+    Blue: Final[Tuple[int, int, int]] = ...
+    Fuchsia: Final[Tuple[int, int, int]] = ...
+    Gray: Final[Tuple[int, int, int]] = ...
+    Green: Final[Tuple[int, int, int]] = ...
+    Lime: Final[Tuple[int, int, int]] = ...
+    Maroon: Final[Tuple[int, int, int]] = ...
+    Navy: Final[Tuple[int, int, int]] = ...
+    Olive: Final[Tuple[int, int, int]] = ...
+    Purple: Final[Tuple[int, int, int]] = ...
+    Red: Final[Tuple[int, int, int]] = ...
+    Silver: Final[Tuple[int, int, int]] = ...
+    Teal: Final[Tuple[int, int, int]] = ...
+    White: Final[Tuple[int, int, int]] = ...
+    Yellow: Final[Tuple[int, int, int]] = ...
+
+
+class Colors140(ColorsBase):
+    """Class representing the 140 basic web colors(CSS Color Module Level3) along with a transparent color."""
+    AliceBlue: Final[Tuple[int, int, int]] = ...
+    AntiqueWhite: Final[Tuple[int, int, int]] = ...
+    Aqua: Final[Tuple[int, int, int]] = ...
+    Aquamarine: Final[Tuple[int, int, int]] = ...
+    Azure: Final[Tuple[int, int, int]] = ...
+    Beige: Final[Tuple[int, int, int]] = ...
+    Bisque: Final[Tuple[int, int, int]] = ...
+    Black: Final[Tuple[int, int, int]] = ...
+    BlanchedAlmond: Final[Tuple[int, int, int]] = ...
+    Blue: Final[Tuple[int, int, int]] = ...
+    BlueViolet: Final[Tuple[int, int, int]] = ...
+    Brown: Final[Tuple[int, int, int]] = ...
+    BurlyWood: Final[Tuple[int, int, int]] = ...
+    CadetBlue: Final[Tuple[int, int, int]] = ...
+    Chartreuse: Final[Tuple[int, int, int]] = ...
+    Chocolate: Final[Tuple[int, int, int]] = ...
+    Coral: Final[Tuple[int, int, int]] = ...
+    CornflowerBlue: Final[Tuple[int, int, int]] = ...
+    Cornsilk: Final[Tuple[int, int, int]] = ...
+    Crimson: Final[Tuple[int, int, int]] = ...
+    Cyan: Final[Tuple[int, int, int]] = ...
+    DarkBlue: Final[Tuple[int, int, int]] = ...
+    DarkCyan: Final[Tuple[int, int, int]] = ...
+    DarkGoldenRod: Final[Tuple[int, int, int]] = ...
+    DarkGray: Final[Tuple[int, int, int]] = ...
+    DarkGreen: Final[Tuple[int, int, int]] = ...
+    DarkKhaki: Final[Tuple[int, int, int]] = ...
+    DarkMagenta: Final[Tuple[int, int, int]] = ...
+    DarkOliveGreen: Final[Tuple[int, int, int]] = ...
+    DarkOrange: Final[Tuple[int, int, int]] = ...
+    DarkOrchid: Final[Tuple[int, int, int]] = ...
+    DarkRed: Final[Tuple[int, int, int]] = ...
+    DarkSalmon: Final[Tuple[int, int, int]] = ...
+    DarkSeaGreen: Final[Tuple[int, int, int]] = ...
+    DarkSlateBlue: Final[Tuple[int, int, int]] = ...
+    DarkSlateGray: Final[Tuple[int, int, int]] = ...
+    DarkTurquoise: Final[Tuple[int, int, int]] = ...
+    DarkViolet: Final[Tuple[int, int, int]] = ...
+    DeepPink: Final[Tuple[int, int, int]] = ...
+    DeepSkyBlue: Final[Tuple[int, int, int]] = ...
+    DimGray: Final[Tuple[int, int, int]] = ...
+    DodgerBlue: Final[Tuple[int, int, int]] = ...
+    FireBrick: Final[Tuple[int, int, int]] = ...
+    FloralWhite: Final[Tuple[int, int, int]] = ...
+    ForestGreen: Final[Tuple[int, int, int]] = ...
+    Fuchsia: Final[Tuple[int, int, int]] = ...
+    Gainsboro: Final[Tuple[int, int, int]] = ...
+    GhostWhite: Final[Tuple[int, int, int]] = ...
+    Gold: Final[Tuple[int, int, int]] = ...
+    GoldenRod: Final[Tuple[int, int, int]] = ...
+    Gray: Final[Tuple[int, int, int]] = ...
+    Green: Final[Tuple[int, int, int]] = ...
+    GreenYellow: Final[Tuple[int, int, int]] = ...
+    HoneyDew: Final[Tuple[int, int, int]] = ...
+    HotPink: Final[Tuple[int, int, int]] = ...
+    IndianRed: Final[Tuple[int, int, int]] = ...
+    Indigo: Final[Tuple[int, int, int]] = ...
+    Ivory: Final[Tuple[int, int, int]] = ...
+    Khaki: Final[Tuple[int, int, int]] = ...
+    Lavender: Final[Tuple[int, int, int]] = ...
+    LavenderBlush: Final[Tuple[int, int, int]] = ...
+    LawnGreen: Final[Tuple[int, int, int]] = ...
+    LemonChiffon: Final[Tuple[int, int, int]] = ...
+    LightBlue: Final[Tuple[int, int, int]] = ...
+    LightCoral: Final[Tuple[int, int, int]] = ...
+    LightCyan: Final[Tuple[int, int, int]] = ...
+    LightGoldenRodYellow: Final[Tuple[int, int, int]] = ...
+    LightGray: Final[Tuple[int, int, int]] = ...
+    LightGreen: Final[Tuple[int, int, int]] = ...
+    LightPink: Final[Tuple[int, int, int]] = ...
+    LightSalmon: Final[Tuple[int, int, int]] = ...
+    LightSeaGreen: Final[Tuple[int, int, int]] = ...
+    LightSkyBlue: Final[Tuple[int, int, int]] = ...
+    LightSlateGray: Final[Tuple[int, int, int]] = ...
+    LightSteelBlue: Final[Tuple[int, int, int]] = ...
+    LightYellow: Final[Tuple[int, int, int]] = ...
+    Lime: Final[Tuple[int, int, int]] = ...
+    LimeGreen: Final[Tuple[int, int, int]] = ...
+    Linen: Final[Tuple[int, int, int]] = ...
+    Magenta: Final[Tuple[int, int, int]] = ...
+    Maroon: Final[Tuple[int, int, int]] = ...
+    MediumAquaMarine: Final[Tuple[int, int, int]] = ...
+    MediumBlue: Final[Tuple[int, int, int]] = ...
+    MediumOrchid: Final[Tuple[int, int, int]] = ...
+    MediumPurple: Final[Tuple[int, int, int]] = ...
+    MediumSeaGreen: Final[Tuple[int, int, int]] = ...
+    MediumSlateBlue: Final[Tuple[int, int, int]] = ...
+    MediumSpringGreen: Final[Tuple[int, int, int]] = ...
+    MediumTurquoise: Final[Tuple[int, int, int]] = ...
+    MediumVioletRed: Final[Tuple[int, int, int]] = ...
+    MidnightBlue: Final[Tuple[int, int, int]] = ...
+    MintCream: Final[Tuple[int, int, int]] = ...
+    MistyRose: Final[Tuple[int, int, int]] = ...
+    Moccasin: Final[Tuple[int, int, int]] = ...
+    NavajoWhite: Final[Tuple[int, int, int]] = ...
+    Navy: Final[Tuple[int, int, int]] = ...
+    OldLace: Final[Tuple[int, int, int]] = ...
+    Olive: Final[Tuple[int, int, int]] = ...
+    OliveDrab: Final[Tuple[int, int, int]] = ...
+    Orange: Final[Tuple[int, int, int]] = ...
+    OrangeRed: Final[Tuple[int, int, int]] = ...
+    Orchid: Final[Tuple[int, int, int]] = ...
+    PaleGoldenRod: Final[Tuple[int, int, int]] = ...
+    PaleGreen: Final[Tuple[int, int, int]] = ...
+    PaleTurquoise: Final[Tuple[int, int, int]] = ...
+    PaleVioletRed: Final[Tuple[int, int, int]] = ...
+    PapayaWhip: Final[Tuple[int, int, int]] = ...
+    PeachPuff: Final[Tuple[int, int, int]] = ...
+    Peru: Final[Tuple[int, int, int]] = ...
+    Pink: Final[Tuple[int, int, int]] = ...
+    Plum: Final[Tuple[int, int, int]] = ...
+    PowderBlue: Final[Tuple[int, int, int]] = ...
+    Purple: Final[Tuple[int, int, int]] = ...
+    RebeccaPurple: Final[Tuple[int, int, int]] = ...
+    Red: Final[Tuple[int, int, int]] = ...
+    RosyBrown: Final[Tuple[int, int, int]] = ...
+    RoyalBlue: Final[Tuple[int, int, int]] = ...
+    SaddleBrown: Final[Tuple[int, int, int]] = ...
+    Salmon: Final[Tuple[int, int, int]] = ...
+    SandyBrown: Final[Tuple[int, int, int]] = ...
+    SeaGreen: Final[Tuple[int, int, int]] = ...
+    SeaShell: Final[Tuple[int, int, int]] = ...
+    Sienna: Final[Tuple[int, int, int]] = ...
+    Silver: Final[Tuple[int, int, int]] = ...
+    SkyBlue: Final[Tuple[int, int, int]] = ...
+    SlateBlue: Final[Tuple[int, int, int]] = ...
+    SlateGray: Final[Tuple[int, int, int]] = ...
+    Snow: Final[Tuple[int, int, int]] = ...
+    SpringGreen: Final[Tuple[int, int, int]] = ...
+    SteelBlue: Final[Tuple[int, int, int]] = ...
+    Tan: Final[Tuple[int, int, int]] = ...
+    Teal: Final[Tuple[int, int, int]] = ...
+    Thistle: Final[Tuple[int, int, int]] = ...
+    Tomato: Final[Tuple[int, int, int]] = ...
+    Turquoise: Final[Tuple[int, int, int]] = ...
+    Violet: Final[Tuple[int, int, int]] = ...
+    Wheat: Final[Tuple[int, int, int]] = ...
+    White: Final[Tuple[int, int, int]] = ...
+    WhiteSmoke: Final[Tuple[int, int, int]] = ...
+    Yellow: Final[Tuple[int, int, int]] = ...
+    YellowGreen: Final[Tuple[int, int, int]] = ...
+
+
+class ColorsThemeEssentials(ColorsBase):
+    """Class representing essential theme colors along with a transparent color."""
+    Red: Final[Tuple[int, int, int]] = ...
+    LightRed: Final[Tuple[int, int, int]] = ...
+    Green: Final[Tuple[int, int, int]] = ...
+    LightGreen: Final[Tuple[int, int, int]] = ...
+    Blue: Final[Tuple[int, int, int]] = ...
+    LightBlue: Final[Tuple[int, int, int]] = ...
+    Yellow: Final[Tuple[int, int, int]] = ...
+    Purple: Final[Tuple[int, int, int]] = ...
+    Orange: Final[Tuple[int, int, int]] = ...
+    Navy: Final[Tuple[int, int, int]] = ...
+    Pink: Final[Tuple[int, int, int]] = ...
+    Charcoal: Final[Tuple[int, int, int]] = ...
+    Graphite: Final[Tuple[int, int, int]] = ...
+    Gray: Final[Tuple[int, int, int]] = ...
+    Silver: Final[Tuple[int, int, int]] = ...
+    Snow: Final[Tuple[int, int, int]] = ...
+    Teal: Final[Tuple[int, int, int]] = ...
+    Olive: Final[Tuple[int, int, int]] = ...
+    Brown: Final[Tuple[int, int, int]] = ...
+    Black: Final[Tuple[int, int, int]] = ...
+    White: Final[Tuple[int, int, int]] = ...
+    Aqua: Final[Tuple[int, int, int]] = ...
+    GreenYellow: Final[Tuple[int, int, int]] = ...
+    Ivory: Final[Tuple[int, int, int]] = ...
+    Steel: Final[Tuple[int, int, int]] = ...
+
+
+class ColorsThemeDefault(ColorsBase):
+    """Class representing default theme colors along with a transparent color."""
+    Red: Final[Tuple[int, int, int]] = ...
+    Green: Final[Tuple[int, int, int]] = ...
+    Blue: Final[Tuple[int, int, int]] = ...
+    Black: Final[Tuple[int, int, int]] = ...
+    White: Final[Tuple[int, int, int]] = ...
+
+
+class ColorsThemeMonochrome(ColorsBase):
+    """Class representing monochrome theme colors along with a transparent color."""
+    Black: Final[Tuple[int, int, int]] = ...
+    Charcoal: Final[Tuple[int, int, int]] = ...
+    Graphite: Final[Tuple[int, int, int]] = ...
+    Gray: Final[Tuple[int, int, int]] = ...
+    Silver: Final[Tuple[int, int, int]] = ...
+    Snow: Final[Tuple[int, int, int]] = ...
+    White: Final[Tuple[int, int, int]] = ...
+
+