reykit 1.0.0__py3-none-any.whl

reykit/rschedule.py

@@ -0,0 +1,272 @@
+# !/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+@Time    : 2024-01-09 21:44:48
+@Author  : Rey
+@Contact : reyxbo@163.com
+@Explain : Schedule methods.
+"""
+
+
+from typing import Any, Literal, Union, Optional
+from collections.abc import Callable
+from apscheduler.executors.pool import ThreadPoolExecutor
+from apscheduler.schedulers.background import BackgroundScheduler
+from apscheduler.schedulers.blocking import BlockingScheduler
+from apscheduler.job import Job
+
+
+__all__ = (
+    'RSchedule',
+)
+
+
+class RSchedule(object):
+    """
+    Rey's `schedule` type.
+    """
+
+    def __init__(
+        self,
+        max_workers: int = 10,
+        max_instances: int = 1,
+        coalesce: bool = True,
+        block: bool = False
+    ) -> None:
+        """
+        Build `schedule` attributes.
+
+        Parameters
+        ----------
+        max_workers : Maximum number of synchronized executions.
+        max_instances : Maximum number of synchronized executions of tasks with the same ID.
+        coalesce : Whether to coalesce tasks with the same ID.
+        block : Whether to block.
+        """
+
+        # Set parameter.
+        executor = ThreadPoolExecutor(max_workers)
+        executors = {'default': executor}
+        job_defaults = {
+            'coalesce': coalesce,
+            'max_instances': max_instances
+        }
+
+        # Instance.
+        if block:
+            scheduler = BlockingScheduler(
+                executors=executors,
+                job_defaults=job_defaults
+            )
+        else:
+            scheduler = BackgroundScheduler(
+                executors=executors,
+                job_defaults=job_defaults
+            )
+
+        # Set attribute.
+        self.scheduler = scheduler
+
+
+    def start(self) -> None:
+        """
+        Start scheduler.
+        """
+
+        # Start.
+        self.scheduler.start()
+
+
+    def pause(self) -> None:
+        """
+        Pause scheduler.
+
+        Parameters
+        ----------
+        task : Task instance.
+        """
+
+        # Pause.
+        self.scheduler.pause()
+
+
+    def resume(self) -> None:
+        """
+        Resume scheduler.
+
+        Parameters
+        ----------
+        task : Task instance.
+        """
+
+        # Resume.
+        self.scheduler.resume()
+
+
+    def tasks(self) -> list[Job]:
+        """
+        Return to task list.
+
+        Returns
+        -------
+        Task list.
+        """
+
+        # Get.
+        jobs = self.scheduler.get_jobs()
+
+        return jobs
+
+
+    def add_task(
+        self,
+        func: Callable,
+        trigger: Literal['date', 'interval', 'cron'] = 'date',
+        args: Optional[tuple] = None,
+        kwargs: Optional[dict] = None,
+        **trigger_kwargs: Any
+    ) -> Job:
+        """
+        Add task.
+
+        Parameters
+        ----------
+        func : Task function.
+        trigger : Trigger type.
+        args : Task position arguments.
+        kwargs : Task keyword arguments.
+        trigger_kwargs : Trigger keyword arguments.
+
+        Returns
+        -------
+        Task instance.
+        """
+
+        # Add.
+        job = self.scheduler.add_job(
+            func,
+            trigger,
+            args,
+            kwargs,
+            **trigger_kwargs
+        )
+
+        return job
+
+
+    def modify_task(
+        self,
+        task: Union[Job, str],
+        trigger: Optional[Literal['date', 'interval', 'cron']] = None,
+        args: Optional[tuple] = None,
+        kwargs: Optional[dict] = None,
+        **trigger_kwargs: Any
+    ) -> None:
+        """
+        Modify task.
+
+        Parameters
+        ----------
+        task : Task instance or ID.
+        trigger : Trigger type.
+        args : Task position arguments.
+        kwargs : Task keyword arguments.
+        trigger_kwargs : Trigger keyword arguments.
+        """
+
+        # Arguments.
+            
+        ## Get parameter.
+        params_arg = {}
+        if args is not None:
+            params_arg['args'] = args
+        if kwargs is not None:
+            params_arg['kwargs'] = kwargs
+
+        ## Modify.
+        if params_arg != {}:
+            self.scheduler.modify_job(
+                task.id,
+                **params_arg
+            )
+
+        # Trigger.
+        if (
+            trigger is not None
+            or trigger_kwargs != {}
+        ):
+            self.scheduler.reschedule_job(
+                task.id,
+                trigger=trigger,
+                **trigger_kwargs
+            )
+
+
+    def remove_task(
+        self,
+        task: Union[Job, str]
+    ) -> None:
+        """
+        Remove task.
+
+        Parameters
+        ----------
+        task : Task instance or ID.
+        """
+
+        # Get parameter.
+        if task.__class__ == Job:
+            id_ = task.id
+        else:
+            id_ = task
+
+        # Remove.
+        self.scheduler.remove_job(id_)
+
+
+    def pause_task(
+        self,
+        task: Union[Job, str]   
+    ) -> None:
+        """
+        Pause task.
+
+        Parameters
+        ----------
+        task : Task instance or ID.
+        """
+
+        # Get parameter.
+        if task.__class__ == Job:
+            id_ = task.id
+        else:
+            id_ = task
+
+        # Pause.
+        self.scheduler.pause_job(id_)
+
+
+    def resume_task(
+        self,
+        task: Union[Job, str]
+    ) -> None:
+        """
+        Resume task.
+
+        Parameters
+        ----------
+        task : Task instance or ID.
+        """
+
+        # Get parameter.
+        if task.__class__ == Job:
+            id_ = task.id
+        else:
+            id_ = task
+
+        # Resume.
+        self.scheduler.resume_job(id_)
+
+
+    __iter__ = tasks

reykit/rstdout.py

@@ -0,0 +1,356 @@
+# !/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+@Time    : 2023-10-01 14:47:47
+@Author  : Rey
+@Contact : reyxbo@163.com
+@Explain : Standard output methods.
+"""
+
+
+from typing import Any, Literal, Optional, Union, Final, Self
+from collections.abc import Callable
+import sys
+from io import TextIOWrapper
+from os import devnull as os_devnull
+from os.path import abspath as os_abspath
+
+from .rsystem import get_first_notnull, get_name, get_stack_param
+from .rtext import to_text, add_text_frame
+from .rtype import RConfigMeta
+
+
+__all__ = (
+    'RConfigStdout',
+    'beautify_text',
+    'echo',
+    'rinput',
+    'stop_print',
+    'start_print',
+    'modify_print',
+    'reset_print',
+    'add_print_position'
+)
+
+
+class RConfigStdout(object, metaclass=RConfigMeta):
+    """
+    Rey's `config standard output` type.
+    """
+
+    # Module path.
+    _path_rstdout: Final[str] = os_abspath(__file__)
+
+    # Status.
+    _stoped: bool = False
+    _modified: bool = False
+
+    # IO.
+    _io_null: TextIOWrapper = open(os_devnull, 'w')
+    _io_stdout: TextIOWrapper = sys.stdout
+    _io_stdout_write: Callable[[str], int] = sys.stdout.write
+
+    # Is the print frame plain.
+    is_frame_plain: bool = False
+
+    # print default width.
+    default_width: int = 100
+
+
+def beautify_text(
+    data: tuple[Any],
+    title: Union[bool, str] = True,
+    width: Optional[int] = None,
+    frame: Optional[Literal['full', 'half', 'top', 'half_plain', 'top_plain']] = 'full'
+) -> str:
+    """
+    Beautify data to text.
+
+    Parameters
+    ----------
+    data : Text data.
+    title : Text title.
+        - `Literal[True]`: Automatic get data variable name.
+        - `Literal[False]`: No title.
+        - `str`: Use this value as the title.
+    width : Text width.
+        - `None`: Use attribute `RConfigStdout.default_width`.
+        - `int`: Use this value.
+    frame : Text frame type.
+        - `Literal[`full`]`: Add beautiful four side frame and limit length.
+            When attribute `RConfigStdout.is_frame_plain` is True, then frame is `half_plain` type.
+            When throw `exception`, then frame is `half` type.
+        - `Literal[`half`]`: Add beautiful top and bottom side frame.
+            When attribute `RConfigStdout.is_frame_plain` is True, then frame is `half_plain` type.
+        - `Literal[`top`]`: Add beautiful top side frame.
+            When attribute `RConfigStdout.is_frame_plain` is True, then frame is `top_plain` type.
+        - `Literal[`half_plain`]`: Add plain top and bottom side frame.
+        - `Literal[`top_plain`]`: Add plain top side frame.
+
+    Returns
+    -------
+    Beautify text.
+    """
+
+    # Get parameter.
+
+    ## Title.
+    if title is True:
+        titles = get_name(data, 3)
+        if titles is not None:
+            titles = [title if not title.startswith('`') else '' for title in titles]
+            if set(titles) != {''}:
+                title = ' │ '.join(titles)
+    if title.__class__ != str:
+        title = None
+
+    ## Width.
+    width = get_first_notnull(width, RConfigStdout.default_width, default='exception')
+
+    ## Frame.
+    if RConfigStdout.is_frame_plain:
+        match frame:
+            case 'full':
+                frame = 'half_plain'
+            case 'half':
+                frame = 'half_plain'
+            case 'top':
+                frame = 'top_plain'
+
+    # To text.
+    text_list = [
+        to_text(content, width=width)
+        for content in data
+    ]
+
+    # Add frame.
+    text = add_text_frame(*text_list, title=title, width=width, frame=frame)
+
+    return text
+
+
+def echo(
+    *data: Any,
+    title: Union[bool, str] = True,
+    width: Optional[int] = None,
+    frame: Optional[Literal['full', 'half', 'top', 'half_plain', 'top_plain']] = 'full'
+) -> str:
+    """
+    Beautify data to text, and print.
+
+    Parameters
+    ----------
+    data : Text data.
+    title : Text title.
+        - `Literal[True]`: Automatic get data variable name.
+        - `Literal[False]`: No title.
+        - `str`: Use this value as the title.
+    width : Text width.
+        - `None`: Use attribute `RConfigStdout.default_width`.
+        - `int`: Use this value.
+    frame : Text frame type.
+        - `Literal[`full`]`: Add beautiful four side frame and limit length.
+            When attribute `RConfigStdout.is_frame_plain` is True, then frame is `half_plain` type.
+            When throw `exception`, then frame is `half` type.
+        - `Literal[`half`]`: Add beautiful top and bottom side frame.
+            When attribute `RConfigStdout.is_frame_plain` is True, then frame is `half_plain` type.
+        - `Literal[`top`]`: Add beautiful top side frame.
+            When attribute `RConfigStdout.is_frame_plain` is True, then frame is `top_plain` type.
+        - `Literal[`half_plain`]`: Add plain top and bottom side frame.
+        - `Literal[`top_plain`]`: Add plain top side frame.
+
+    Returns
+    -------
+    Beautify text.
+    """
+
+    # Beautify.
+    text = beautify_text(data, title=title, width=width, frame=frame)
+
+    # Print.
+    print(text)
+
+    return text
+
+
+def rinput(
+    *data: Any,
+    title: Union[bool, str] = True,
+    width: Optional[int] = None,
+    frame: Optional[Literal['full', 'half', 'top', 'half_plain', 'top_plain']] = 'full',
+    extra: Optional[str] = None
+) -> str:
+    """
+    Beautify data to text, and print data, and read string from standard input.
+
+    Parameters
+    ----------
+    data : Text data.
+    title : Text title.
+        - `Literal[True]`: Automatic get data variable name.
+        - `Literal[False]`: No title.
+        - `str`: Use this value as the title.
+    width : Text width.
+        - `None`: Use attribute `RConfigStdout.default_width`.
+        - `int`: Use this value.
+    frame : Text frame type.
+        - `Literal[`full`]`: Add beautiful four side frame and limit length.
+            When attribute `RConfigStdout.is_frame_plain` is True, then frame is `half_plain` type.
+            When throw `exception`, then frame is `half` type.
+        - `Literal[`half`]`: Add beautiful top and bottom side frame.
+            When attribute `RConfigStdout.is_frame_plain` is True, then frame is `half_plain` type.
+        - `Literal[`top`]`: Add beautiful top side frame.
+            When attribute `RConfigStdout.is_frame_plain` is True, then frame is `top_plain` type.
+        - `Literal[`half_plain`]`: Add plain top and bottom side frame.
+        - `Literal[`top_plain`]`: Add plain top side frame.
+    extra : Extra print text at the end.
+
+    Returns
+    -------
+    Standard input string.
+    """
+
+    # Beautify.
+    text = beautify_text(data, title=title, width=width, frame=frame)
+
+    # Extra.
+    if extra is not None:
+        text += extra
+
+    # Print.
+    stdin = input(text)
+
+    return stdin
+
+
+def stop_print() -> None:
+    """
+    Stop standard output print.
+    """
+
+    # Stop.
+    sys.stdout = RConfigStdout._io_null
+
+    # Update status.
+    RConfigStdout._stoped = True
+
+
+def start_print() -> None:
+    """
+    Start standard output print.
+    """
+
+    # Check.
+    if not RConfigStdout._stoped: return
+
+    # Start.
+    sys.stdout = RConfigStdout._io_stdout
+
+    # Update status.
+    RConfigStdout._stoped = False
+
+
+def modify_print(preprocess: Callable[[str], Optional[str]]) -> None:
+    """
+    Modify standard output print write method.
+
+    Parameters
+    ----------
+    preprocess : Preprocess function.
+        - `Callable[[str], str]`: Input old text, output new text, will trigger printing.
+        - `Callable[[str], None]`: Input old text, no output, will not trigger printing.
+    """
+
+
+    # Define.
+    def write(__s: str) -> Optional[int]:
+        """
+        Modified standard output write method.
+
+        Parameters
+        ----------
+        __s : Write text.
+
+        Returns
+        -------
+        Number of text characters.
+        """
+
+        # Preprocess.
+        __s = preprocess(__s)
+
+        # Write.
+        if __s.__class__ == str:
+            write_len = RConfigStdout._io_stdout_write(__s)
+            return write_len
+
+
+    # Modify.
+    RConfigStdout._io_stdout.write = write
+
+    # Update status.
+    RConfigStdout._modified = True
+
+
+def reset_print() -> None:
+    """
+    Reset standard output print write method.
+    """
+
+    # Check.
+    if not RConfigStdout._modified: return
+
+    # Reset.
+    RConfigStdout._io_stdout.write = RConfigStdout._io_stdout_write
+
+    # Update status.
+    RConfigStdout._modified = False
+
+
+def add_print_position() -> None:
+    """
+    Add position text to standard output.
+    """
+
+
+    # Define.
+    def preprocess(__s: str) -> str:
+        """
+        Preprocess function.
+
+        Parameters
+        ----------
+        __s : Standard ouput text.
+
+        Returns
+        -------
+        Preprocessed text.
+        """
+
+        # Break.
+        if __s in ('\n', ' ', ''): return __s
+
+        # Get parameter.
+        stack_params = get_stack_param('full', 3)
+        stack_floor = stack_params[-1]
+
+        ## Compatible 'echo'.
+        if (
+            stack_floor['filename'] == RConfigStdout._path_rstdout
+            and stack_floor['name'] == 'echo'
+        ):
+            stack_floor = stack_params[-2]
+
+        # Add.
+        __s = 'File "%s", line %s\n%s' % (
+            stack_floor['filename'],
+            stack_floor['lineno'],
+            __s
+        )
+
+        return __s
+
+
+    # Modify.
+    modify_print(preprocess)