drawlib 0.1.1__py3-none-any.whl

drawlib/.pylintrc

@@ -0,0 +1,2 @@
+[FORMAT]
+max-line-length=80

drawlib/__init__.py

@@ -0,0 +1,33 @@
+# 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.
+
+"""drawlib root package
+
+this package contains latest modules.
+
+- basic: provides single interface of basic classes and functions.
+- advance: provides single interface of basic and advance classes and functions.
+- settings: provides application setting interfaces.
+
+subpackages contains latest and old implementations.
+
+- drawlib.v0_1: API v0.1 interface (latest)
+
+"""
+
+from typing import Final
+
+# please update here when you release new version
+VERSION = "0.1.1"
+
+# might not be changed
+LIB_NAME: Final[str] = "drawlib"
+AUTHOR: Final[str] = "Yuichi Ito"
+CONTACT: Final[str] = "yuichi@yuichi.com"
+__version__: Final[str] = VERSION

drawlib/__main__.py

@@ -0,0 +1,21 @@
+# 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.
+
+"""Entry point of ``drawlib``
+
+When you run ``drawlib <options>`` or ``python -m drawlib <options>``, 
+this module will be called.
+And then, latest API's ``command.call()`` will be called.
+
+"""
+
+from drawlib.v0_1.private.command import call
+
+if __name__ == "__main__":
+    call()

drawlib/apis.py

@@ -0,0 +1,22 @@
+# 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.
+
+"""Module for importing functions and classes at latest drawlib API.
+
+drawlib posses lots of functions and classes on various modules.
+This module provides single interface for importing public latest API objects.
+
+``from drawlib.apis import *``
+
+If you want to specify API version, 
+please use ``drawlib.<version>.apis`` instead.
+
+"""
+
+from drawlib.v0_1.apis import *

drawlib/assets/__init__.py

@@ -0,0 +1,8 @@
+# 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.

drawlib/assets/v0_1/__init__.py

@@ -0,0 +1,8 @@
+# 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.

drawlib/assets/v0_1/fonticons/__init__.py

@@ -0,0 +1,8 @@
+# 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.

drawlib/assets/v0_1/fonts/__init__.py

@@ -0,0 +1,8 @@
+# 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.

drawlib/v0_1/__init__.py

@@ -0,0 +1,31 @@
+# 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.
+
+"""drawlib API 0.1 package.
+
+this package contains API v0.1 modules.
+
+- basic: provides single interface of basic classes and functions.
+- advance: provides single interface of basic and advance classes and functions.
+- settings: provides application setting interfaces.
+
+These implementation will not be changed after new API is released.
+We recommend user code change before API deprication.
+
+"""
+
+from typing import Final
+import drawlib
+
+# this API package is latest now. So, API version is same to software's one.
+# When you create newer API, please set string value instead.
+VERSION: Final[str] = drawlib.VERSION
+
+# might not be changed
+__version__: Final[str] = VERSION

drawlib/v0_1/__main__.py

@@ -0,0 +1,20 @@
+# 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.
+
+"""Entry point of ``drawlib.v0_1``
+
+When you run ``python -m drawlib.v0_1 <options>``, this module is called.
+And then, drawlib.v0_1.command.call() will be called.
+
+"""
+
+from drawlib.v0_1.private.command import call
+
+if __name__ == "__main__":
+    call()

drawlib/v0_1/apis.py

@@ -0,0 +1,127 @@
+# 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.
+
+"""Module for importing functions and classes at API v0.1.
+
+drawlib posses lots of functions and classes on various modules.
+This module provides single interface for importing public API v1.0 objects.
+
+``from drawlib.v0_1.apis import *``
+
+If you requires latest API, import root module instead.
+
+``from drawlib.apis import *``
+
+"""
+
+# pylint: disable=unused-import
+
+#############
+### Class ###
+#############
+
+from drawlib.v0_1.private.core.colors import (
+    Colors,
+    Colors140,
+)
+from drawlib.v0_1.private.core.model import (
+    IconStyle,
+    ImageStyle,
+    LineStyle,
+    LineArrowStyle,
+    ShapeStyle,
+    ShapeTextStyle,
+    TextStyle,
+)
+from drawlib.v0_1.private.core.fonts import (
+    Font,
+    FontArabic,
+    FontChinese,
+    FontJapanese,
+    FontKorean,
+    FontMonoSpace,
+    FontRoboto,
+    FontSanSerif,
+    FontSerif,
+    FontThai,
+    FontSourceCode,
+    FontFile,
+)
+from drawlib.v0_1.private.core.dimage import (
+    Dimage,
+)
+
+######################
+### Canvas Methods ###
+######################
+
+from drawlib.v0_1.private.core_canvas.canvas import (
+    # basics
+    clear,
+    config,
+    save,
+    shape,
+    # image
+    image,
+    # text
+    text,
+    text_vertical,
+    # line
+    line,
+    line_curved,
+    line_bezier1,
+    line_bezier2,
+    lines,
+    lines_bezier,
+    # patches
+    arc,
+    circle,
+    ellipse,
+    polygon,
+    rectangle,
+    regularpolygon,
+    wedge,
+    donuts,
+    fan,
+    # original
+    arrow,
+    rhombus,
+    parallelogram,
+    trapezoid,
+    triangle,
+    bubblespeech,
+    star,
+    chevron,
+)
+
+#################
+### Utilities ###
+#################
+
+from drawlib.v0_1.private.tools import (
+    dload,
+)
+from drawlib.v0_1.private import (
+    dutil,
+)
+from drawlib.v0_1.private.settings import (
+    dsettings,
+)
+from drawlib.v0_1.private.icons.util import (
+    dicon,
+)
+from drawlib.v0_1.private.icons import (
+    phosphor as dicon_phosphor,
+)
+from drawlib.v0_1.private.smartarts import (
+    dsart,
+)
+from drawlib.v0_1.private.core.theme import (
+    dtheme,
+)

drawlib/v0_1/private/__init__.py

@@ -0,0 +1,20 @@
+# 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.
+
+"""drawlib API 0.1 implementation package.
+
+This package contains drawlib's implementations.
+However it is not designed to import directory except tests.
+Please import them through module ``drawlib.v0_1.basic`` or
+``drawlib.v0_1.advance``.
+
+Subpackage ``drawlib.v0_1.core`` contains core drawing features.
+Other moduels under this module is helpers.
+
+"""

drawlib/v0_1/private/arg_validator.py

@@ -0,0 +1,163 @@
+from typing import Tuple, Union, List
+from PIL.Image import Image
+
+from drawlib.v0_1.private.core.dimage import Dimage
+from drawlib.v0_1.private.core.model_validator import ColorValidator, CoordinateValidator
+from drawlib.v0_1.private.core.model import (
+    LineStyle,
+    LineArrowStyle,
+    ShapeStyle,
+    ShapeTextStyle,
+    TextStyle,
+    ImageStyle,
+    IconStyle,
+)
+from drawlib.v0_1.private.core.fonts import FontSourceCode
+
+
+class ArgValidator:
+
+    # basic type
+
+    @staticmethod
+    def validate_bool(name: str, value: bool):
+        if not isinstance(value, bool):
+            raise ValueError(f'Arg "{name}" requires int value. But type {type(value)} "{value}" is given.')
+
+    @staticmethod
+    def validate_int(name: str, value: int):
+        if not isinstance(value, int):
+            raise ValueError(f'Arg "{name}" requires int value. But "{value}" is given.')
+
+    @staticmethod
+    def validate_float(name: str, value: Union[int, float]):
+        if not (isinstance(value, int) or isinstance(value, float)):
+            raise ValueError(f'Arg "{name}" requires int/float value. But "{value}" is given.')
+
+    @staticmethod
+    def validate_str(name: str, value: int):
+        if not isinstance(value, str):
+            raise ValueError(f'Arg "{name}" requires str value. But "{value}" is given.')
+
+    # drawlib coordinate system
+
+    @staticmethod
+    def validate_xy(name: str, value: Tuple[float, float]):
+        try:
+            CoordinateValidator.validate_xy(value)
+        except ValueError:
+            raise ValueError(f'Arg "{name}" requires coordinate (x, y). But "{value}" is given.')
+
+    @staticmethod
+    def validate_xys(name: str, value: List[Tuple[float, float]]):
+        try:
+            CoordinateValidator.validate_xys(value)
+        except ValueError:
+            raise ValueError(
+                f'Arg "{name}" requires list of coordinates [(x, y), (x, y), ...] '
+                f'at least 2 elements. But "{value}" is given.'
+            )
+
+    @staticmethod
+    def validate_path_points(
+        name: str,
+        value: List[
+            Union[
+                Tuple[float, float],
+                Tuple[float, float, float, float],
+                Tuple[float, float, float, float, float, float],
+            ]
+        ],
+    ):
+        try:
+            CoordinateValidator.validate_path_points(value)
+        except ValueError:
+            raise ValueError(f'Arg "{name}" requires list of path_points. Your input value has problem.')
+
+    @staticmethod
+    def validate_angle(name: str, value: int):
+        try:
+            CoordinateValidator.validate_angle(value)
+        except ValueError:
+            raise ValueError(f'Arg "{name}" requires angle 0.0 ~ 360.0. But {value} is given.')
+
+    # drawlib color
+
+    @staticmethod
+    def validate_color(name: str, value: Union[Tuple[int, int, int], Tuple[int, int, int, float]]):
+        try:
+            ColorValidator.validate_color(value)
+        except ValueError:
+            raise ValueError(
+                f'Arg "{name}" requires color value(tuple[int, int, int] | '
+                f"tuple[int, int, int, float]). But {value} is given."
+            )
+
+    @staticmethod
+    def validate_alpha(name: str, value: Union[int, float]):
+        try:
+            ColorValidator.validate_alpha(value)
+        except ValueError:
+            raise ValueError(f'Arg "{name}" requires alpha value 0.0 ~ 1.0. But {value} is given.')
+
+    # drawlib style
+
+    @staticmethod
+    def validate_iconstyle(name: str, value: IconStyle):
+        if not isinstance(value, IconStyle):
+            raise ValueError(f'Arg "{name}" requires IconStyle. But "{value}" is given.')
+
+    @staticmethod
+    def validate_imagestyle(name: str, value: ImageStyle):
+        if not isinstance(value, ImageStyle):
+            raise ValueError(f'Arg "{name}" requires ImageStyle. But "{value}" is given.')
+
+    @staticmethod
+    def validate_linestyle(name: str, value: LineStyle):
+        if not isinstance(value, LineStyle):
+            raise ValueError(f'Arg "{name}" requires LineStyle. But "{value}" is given.')
+
+    @staticmethod
+    def validate_linearrowstyle(name: str, value: LineArrowStyle):
+        if not isinstance(value, LineArrowStyle):
+            raise ValueError(f'Arg "{name}" requires LineArrowStyle. But "{value}" is given.')
+
+    @staticmethod
+    def validate_linestyle_or_linearrowstyle(name: str, value: Union[LineStyle, LineArrowStyle]):
+        if isinstance(value, LineStyle):
+            return
+        if isinstance(value, LineArrowStyle):
+            return
+        raise ValueError(f'Arg "{name}" requires LineStyle or LineArrowStyle. But "{value}" is given.')
+
+    @staticmethod
+    def validate_shapestyle(name: str, value: ShapeStyle):
+        if not isinstance(value, ShapeStyle):
+            raise ValueError(f'Arg "{name}" requires ShapeStyle. But "{value}" is given.')
+
+    @staticmethod
+    def validate_shapetextstyle(name: str, value: ShapeTextStyle):
+        if not isinstance(value, ShapeTextStyle):
+            raise ValueError(f'Arg "{name}" requires ShapeTextStyle. But "{value}" is given.')
+
+    @staticmethod
+    def validate_textstyle(name: str, value: TextStyle):
+        if not isinstance(value, TextStyle):
+            raise ValueError(f'Arg "{name}" requires TextStyle. But "{value}" is given.')
+
+    # others
+    @staticmethod
+    def validate_image_objects(name: str, value: Union[str, Image, Dimage]):
+        if isinstance(value, str):
+            return
+        if isinstance(value, Image):
+            return
+        if isinstance(value, Dimage):
+            return
+
+        raise ValueError(f'Arg "{name}" requires str or PIL.Image.Image or ShapeTextStyle. But {value} is given.')
+
+    @staticmethod
+    def validate_fontsourcecode(name, str, value: FontSourceCode):
+        if not isinstance(value, FontSourceCode):
+            raise ValueError(f'Arg "{name}" requirest FontSourcecode. But {value} is given.')

drawlib/v0_1/private/command.py

@@ -0,0 +1,204 @@
+# 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.
+
+"""Handle drawlib command
+
+Entry point ``__main__`` calls this module's function ``call()``.
+After that class ``DrawlibArgParser`` parse options.
+Then operate appropriate actions.
+
+"""
+
+import os
+import sys
+import argparse
+from typing import Optional, List
+import drawlib
+import drawlib.v0_1
+from drawlib.v0_1.private.logging import logger
+from drawlib.v0_1.private.settings import dsettings
+from drawlib.v0_1.private.tools import dload
+
+
+def call() -> None:
+    """drawlib command handling function.
+
+    This method is called from each API's ``__main__`` module.
+    If the API is latest, called from root package's ``__main__`` module too.
+
+    Abstract procedure of this function.
+
+    1. Crate DrawlibArgParser instance.
+    2. Parse command line options
+    3. If options requests version info, show it and quit.
+    4. Apply options such as logging level
+    5. get target files and directories which drawlib run.
+    6. call ``tools.run()`` for each files, directories
+
+    Returns:
+        None
+
+    """
+
+    argparser = DrawlibArgParser()
+    argparser.parse()
+    argparser.show_version_then_exit0_if_requested()
+    argparser.apply_options()
+    paths = argparser.get_positional_args()
+
+    if len(paths) == 0:
+        logger.critical("no input files and directories")
+        logger.critical('check options with "drawlib --help"')
+        sys.exit(1)
+
+    for path in paths:
+        if not os.path.isfile(path) and not os.path.isdir(path):
+            msg = f'ignore arg "{path}" since it is not a file/dir path'
+            logger.warning(msg)
+            continue
+
+        abspath = os.path.abspath(path)
+        realpath = os.path.realpath(abspath)
+        logger.info(realpath)
+        dload(realpath)
+
+
+class DrawlibArgParser:
+    """drawlib ArgParser Class"""
+
+    def __init__(self) -> None:
+        """Initializa DrawlibArgParser
+
+        In this method, create ``ArgumentParser`` instance and
+        define command line options.
+
+        Returns:
+            None
+
+        """
+
+        parser = argparse.ArgumentParser(
+            description="Ilustration as code by python",
+        )
+        parser.add_argument(
+            "file_or_directory",
+            nargs="...",
+            help="Target python file or directory which contains python codes",
+        )
+        parser.add_argument(
+            "-v",
+            "--version",
+            action="store_true",
+            help="Show version",
+        )
+        parser.add_argument(
+            "--quiet",
+            action="store_true",
+            help="Enable quiet logging. show only error messages",
+        )
+        parser.add_argument(
+            "--verbose",
+            action="store_true",
+            help="Enable verbose logging.",
+        )
+        parser.add_argument(
+            "--developer",
+            action="store_true",
+            help=("Enable verbose logging. " "Disable error handling for library users."),
+        )
+        self._parser = parser
+        self._positional_args: Optional[List[str]] = None
+        self._name_args: Optional[argparse.Namespace] = None
+
+    def parse(self) -> None:
+        """Parse command line options.
+
+        Parse command line options.
+        This method must be called before calling get methods.
+
+        Returns:
+            None
+
+        """
+
+        self._name_args, _ = self._parser.parse_known_args()
+        args = self._parser.parse_args()
+        self._positional_args = args.file_or_directory
+
+    def get_positional_args(self) -> List[str]:
+        """Get positional args. which are files and directories.
+
+        drawlib command requires files and directories as positional args.
+        They are the target of ``tool.run()`` function.
+        It means specified file or files inside directories
+        are called from python.
+        If those python files are drawlib's one, generate images.
+
+        This method must be called after ``parse()`` method is called.
+
+        Returns:
+            List[str]: Positional args (files and directories)
+
+        """
+
+        if self._positional_args is None:
+            logger.critical("DrawlibArgParser must be parsed before getting optional args")
+            sys.exit(1)
+
+        return self._positional_args
+
+    def show_version_then_exit0_if_requested(self) -> None:
+        """show version if option ``-v/`` or ``--version`` exists. And then quit.
+
+        Check whether option has ``-v`` or ``--version``.
+        If yes, show version. And then, quit with ``sys.exit(0)``.
+
+        Returns:
+            None
+
+        """
+
+        if self._name_args is None:
+            logger.critical("DrawlibArgParser must be parsed before apply options")
+            sys.exit(1)
+
+        if self._name_args.version:
+            logger.critical(f"software={drawlib.VERSION}")
+            logger.critical(f"api={drawlib.v0_1.VERSION}")
+            sys.exit(0)
+
+    def apply_options(self) -> None:
+        """Check named args and apply appropriate configs.
+
+        Check these named argses. And do appropriate actions.
+
+        * --quiet: make logging mode quiet
+        * --debug: make logging mode verbose
+        * --devdebug: make logging mode developer
+
+        Returns:
+            None
+
+        """
+
+        if self._name_args is None:
+            logger.critical("DrawlibArgParser must be parsed before apply options")
+            sys.exit(1)
+
+        if self._name_args.quiet and (self._name_args.verbose or self._name_args.developer):
+            raise ValueError("option --quiet can't use with option --debug and --devdebug")
+
+        if self._name_args.quiet:
+            dsettings.set_logging_mode("quiet")
+
+        if self._name_args.verbose:
+            dsettings.set_logging_mode("verbose")
+
+        if self._name_args.developer:
+            dsettings.set_logging_mode("developer")