pyloid 0.13.0__py3-none-any.whl → 0.14.0__py3-none-any.whl

pyloid/timer.py

@@ -1,28 +1,80 @@
-from PySide6.QtCore import QTimer, QObject
+from PySide6.QtCore import QTimer, QObject, Qt
 
 class PyloidTimer(QObject):
     def __init__(self):
+        """
+        Constructor for the PyloidTimer class.
+
+        This class is based on PySide6's QTimer and allows for easy creation and management of various types of timers.
+        """
         super().__init__()
         self.timers = {}
 
     def start_periodic_timer(self, interval, callback):
         """
-        주기적으로 실행되는 타이머를 시작합니다.
-        
-        :param interval: 밀리초 단위의 간격
-        :param callback: 실행할 콜백 함수
-        :param auto_remove: 타이머 중지 시 자동 삭제 여부
-        :return: 타이머 ID
+        Starts a periodic timer.
+
+        This function starts a timer that repeatedly executes the callback function at the given interval.
+
+        Parameters
+        ----------
+        interval : int
+            Interval in milliseconds
+        callback : function
+            Callback function to execute
+
+        Returns
+        -------
+        int
+            Timer ID
+
+        Example
+        -------
+        ```python
+        from pyloid.timer import PyloidTimer
+
+        timer_manager = PyloidTimer()
+
+        def print_hello():
+            print("Hello!")
+
+        # Start a timer that prints "Hello!" every 2 seconds
+        timer_id = timer_manager.start_periodic_timer(2000, print_hello)
+        ```
         """
         return self._create_timer(interval, callback, single_shot=False, auto_remove=False)
 
     def start_single_shot_timer(self, delay, callback):
         """
-        한 번만 실행되는 타이머를 시작합니다.
-        
-        :param delay: 밀리초 단위의 지연 시간
-        :param callback: 실행할 콜백 함수
-        :return: 타이머 ID
+        Starts a single-shot timer.
+
+        This function starts a timer that executes the callback function once after the given delay.
+
+        Parameters
+        ----------
+        delay : int
+            Delay in milliseconds
+        callback : function
+            Callback function to execute
+
+        Returns
+        -------
+        int
+            Timer ID
+
+        Example
+        -------
+        ```python
+        from pyloid.timer import PyloidTimer
+
+        timer_manager = PyloidTimer()
+
+        def delayed_message():
+            print("5 seconds have passed!")
+
+        # Start a single-shot timer that prints a message after 5 seconds
+        timer_id = timer_manager.start_single_shot_timer(5000, delayed_message)
+        ```
         """
         return self._create_timer(delay, callback, single_shot=True, auto_remove=True)
 
@@ -48,9 +100,25 @@ class PyloidTimer(QObject):
 
     def stop_timer(self, timer_id):
         """
-        지정된 ID의 타이머를 중지합니다.
-        
-        :param timer_id: 중지할 타이머의 ID
+        Stops the timer with the specified ID.
+
+        This function stops the timer corresponding to the given timer ID and removes it from the timer list.
+
+        Parameters
+        ----------
+        timer_id : int
+            ID of the timer to stop
+
+        Example
+        -------
+        ```python
+        from pyloid.timer import PyloidTimer
+
+        timer_manager = PyloidTimer()
+
+        # Stop the timer using its ID
+        timer_manager.stop_timer(timer_id)
+        ```
         """
         if timer_id in self.timers:
             self.timers[timer_id].stop()
@@ -58,19 +126,62 @@ class PyloidTimer(QObject):
 
     def is_timer_active(self, timer_id):
         """
-        지정된 ID의 타이머가 활성 상태인지 확인합니다.
-        
-        :param timer_id: 확인할 타이머의 ID
-        :return: 타이머가 활성 상태이면 True, 그렇지 않으면 False
+        Checks if the timer with the specified ID is active.
+
+        This function returns whether the timer corresponding to the given timer ID is currently active.
+
+        Parameters
+        ----------
+        timer_id : int
+            ID of the timer to check
+
+        Returns
+        -------
+        bool
+            True if the timer is active, False otherwise
+
+        Example
+        -------
+        ```python
+        from pyloid.timer import PyloidTimer
+
+        timer_manager = PyloidTimer()
+
+        if timer_manager.is_timer_active(timer_id):
+            print("The timer is still running.")
+        else:
+            print("The timer has stopped.")
+        ```
         """
         return timer_id in self.timers and self.timers[timer_id].isActive()
 
     def get_remaining_time(self, timer_id):
         """
-        지정된 ID의 타이머의 남은 시간을 반환합니다.
-        
-        :param timer_id: 확인할 타이머의 ID
-        :return: 남은 시간 (밀리초), 타이머가 없으면 None
+        Returns the remaining time of the timer with the specified ID.
+
+        This function returns the remaining time of the timer corresponding to the given timer ID in milliseconds.
+
+        Parameters
+        ----------
+        timer_id : int
+            ID of the timer to check
+
+        Returns
+        -------
+        int or None
+            Remaining time in milliseconds, or None if the timer does not exist
+
+        Example
+        -------
+        ```python
+        from pyloid.timer import PyloidTimer
+
+        timer_manager = PyloidTimer()
+
+        remaining_time = timer_manager.get_remaining_time(timer_id)
+        if remaining_time is not None:
+            print(f"{remaining_time}ms remaining.")
+        ```
         """
         if timer_id in self.timers:
             return self.timers[timer_id].remainingTime()
@@ -78,33 +189,106 @@ class PyloidTimer(QObject):
 
     def set_interval(self, timer_id, interval):
         """
-        지정된 ID의 타이머의 간격을 설정합니다.
-        
-        :param timer_id: 설정할 타이머의 ID
-        :param interval: 새로운 간격 (밀리초)
+        Sets the interval of the timer with the specified ID.
+
+        This function sets a new interval for the timer corresponding to the given timer ID.
+
+        Parameters
+        ----------
+        timer_id : int
+            ID of the timer to set
+        interval : int
+            New interval in milliseconds
+
+        Example
+        -------
+        ```python
+        from pyloid.timer import PyloidTimer
+
+        timer_manager = PyloidTimer()
+
+        # Change the timer interval to 3 seconds
+        timer_manager.set_interval(timer_id, 3000)
+        ```
         """
         if timer_id in self.timers:
             self.timers[timer_id].setInterval(interval)
 
     def start_precise_periodic_timer(self, interval, callback):
         """
-        정밀한 주기적 타이머를 시작합니다.
+        Starts a precise periodic timer.
+
+        This function starts a timer that repeatedly executes the callback function at precise intervals.
         
-        :param interval: 밀리초 단위의 간격
-        :param callback: 실행할 콜백 함수
-        :return: 타이머 ID
+        Note
+        ----
+        Precise timers consume more CPU resources.
+
+        Parameters
+        ----------
+        interval : int
+            Interval in milliseconds
+        callback : function
+            Callback function to execute
+
+        Returns
+        -------
+        int
+            Timer ID
+
+        Example
+        -------
+        ```python
+        from pyloid.timer import PyloidTimer
+
+        timer_manager = PyloidTimer()
+
+        def precise_task():
+            print("Executing precise task")
+
+        # Start a precise periodic timer with a 100ms interval
+        precise_timer_id = timer_manager.start_precise_periodic_timer(100, precise_task)
+        ```
         """
-        return self._create_timer_with_type(interval, callback, QTimer.TimerType.PreciseTimer)
+        return self._create_timer_with_type(interval, callback, Qt.TimerType.PreciseTimer)
 
     def start_coarse_periodic_timer(self, interval, callback):
         """
-        덜 정밀한 주기적 타이머를 시작합니다.
-        
-        :param interval: 밀리초 단위의 간격
-        :param callback: 실행할 콜백 함수
-        :return: 타이머 ID
+        Starts a coarse periodic timer.
+
+        This function starts a timer that repeatedly executes the callback function at coarse intervals.
+
+        Note
+        ----
+        Coarse timers consume less CPU resources.
+
+        Parameters
+        ----------
+        interval : int
+            Interval in milliseconds
+        callback : function
+            Callback function to execute
+
+        Returns
+        -------
+        int
+            Timer ID
+
+        Example
+        -------
+        ```python
+        from pyloid.timer import PyloidTimer
+
+        timer_manager = PyloidTimer()
+
+        def coarse_task():
+            print("Executing coarse task")
+
+        # Start a coarse periodic timer with a 500ms interval
+        coarse_timer_id = timer_manager.start_coarse_periodic_timer(500, coarse_task)
+        ```
         """
-        return self._create_timer_with_type(interval, callback, QTimer.TimerType.CoarseTimer)
+        return self._create_timer_with_type(interval, callback, Qt.TimerType.CoarseTimer)
 
     def _create_timer_with_type(self, interval, callback, timer_type, auto_remove=False):
         timer = QTimer(self)

pyloid/tray.py

@@ -3,6 +3,36 @@ from PySide6.QtWidgets import QSystemTrayIcon
 
 
 class TrayEvent(Enum):
+    """
+    TrayEvent is an enumeration class representing events related to the system tray icon.
+
+    Enumeration Members
+    -------------------
+    DoubleClick : Event that occurs when the tray icon is double-clicked
+    MiddleClick : Event that occurs when the tray icon is clicked with the middle button
+    RightClick : Event that occurs when the tray icon is right-clicked (context menu)
+    LeftClick : Event that occurs when the tray icon is left-clicked
+    Unknown : Unknown event
+
+    Usage Example
+    -------------
+    ```python
+    from pyloid import Pyloid, TrayEvent
+
+    app = Pyloid(app_name="Pyloid-App")
+
+    app.set_tray_icon("icons/icon.ico")
+
+    app.set_tray_actions(
+        {
+        TrayEvent.DoubleClick: lambda: print("Tray icon was double-clicked."),
+        TrayEvent.MiddleClick: lambda: print("Tray icon was middle-clicked."),
+        TrayEvent.RightClick: lambda: print("Tray icon was right-clicked."),
+        TrayEvent.LeftClick: lambda: print("Tray icon was left-clicked."),
+        }
+    )
+    ```
+    """
     DoubleClick = QSystemTrayIcon.ActivationReason.DoubleClick
     MiddleClick = QSystemTrayIcon.ActivationReason.MiddleClick
     RightClick = QSystemTrayIcon.ActivationReason.Context

pyloid/utils.py

@@ -1,5 +1,6 @@
 import sys
 import os
+import platform
 from typing import Optional
 
 
@@ -8,8 +9,20 @@ def get_production_path() -> Optional[str]:
     Returns the path to the resource files in a production environment.
     If running as a regular Python script, returns None.
 
-    Returns:
-        str | None
+    Returns
+    -------
+    str | None
+        The path to the resource files if in a production environment, 
+        otherwise None.
+
+    Examples
+    --------
+    >>> from pyloid.utils import get_production_path
+    >>> path = get_production_path()
+    >>> if path:
+    >>>     print(f"Production path: {path}")
+    >>> else:
+    >>>     print("Not in a production environment.")
     """
     if getattr(sys, 'frozen', False):
         # If built with PyInstaller
@@ -18,12 +31,48 @@ def get_production_path() -> Optional[str]:
         # If running as a regular Python script
         return None
 
-
-def is_production():
+def is_production() -> bool:
     """
     Checks if the current environment is a production environment.
 
-    Returns:
-        bool: True if in a production environment, False otherwise.
+    Returns
+    -------
+    bool
+        True if in a production environment, False otherwise.
+
+    Examples
+    --------
+    >>> from pyloid.utils import is_production
+    >>> if is_production():
+    >>>     print("Running in production environment.")
+    >>> else:
+    >>>     print("Not in production environment.")
     """
     return getattr(sys, 'frozen', False)
+
+
+def get_platform() -> str:
+    """
+    Returns the name of the current system's platform.
+
+    This function uses `platform.system()` to return the name of the current operating system.
+
+    Returns
+    -------
+    "Windows" | "Darwin" | "Linux"
+        - "Windows" for Windows systems
+        - "Darwin" for macOS systems
+        - "Linux" for Linux systems
+
+    Examples
+    --------
+    >>> from pyloid.utils import get_platform
+    >>> platform_name = get_platform()
+    >>> print(platform_name)
+    Windows
+    """
+    return platform.system()
+
+
+
+

{pyloid-0.13.0.dist-info → pyloid-0.14.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyloid
-Version: 0.13.0
+Version: 0.14.0
 Summary: 
 Author: aesthetics-of-record
 Author-email: 111675679+aesthetics-of-record@users.noreply.github.com

pyloid-0.14.0.dist-info/RECORD

@@ -0,0 +1,17 @@
+pyloid/__init__.py,sha256=OOPhOKNQVmAM8hnfTeE7lHzxb8LsFNcgegBAvDrA-vY,293
+pyloid/api.py,sha256=waOHddz-rmeTxTvMWRH7Dq24RTKkkJpLw55Ava--TWw,2204
+pyloid/autostart.py,sha256=K7DQYl4LHItvPp0bt1V9WwaaZmVSTeGvadkcwG-KKrI,3899
+pyloid/browser_window.py,sha256=dMdmMTMqgAp2wViGZqZmUO4J5_GtNkYSQ_BCpq65ybo,37543
+pyloid/custom/titlebar.py,sha256=itzK9pJbZMQ7BKca9kdbuHMffurrw15UijR6OU03Xsk,3894
+pyloid/filewatcher.py,sha256=3M5zWVUf1OhlkWJcDFC8ZA9agO4Q-U8WdgGpy6kaVz0,4601
+pyloid/js_api/event_api.py,sha256=_52yyBonqecmMvJpFW7OMNi_jX8Nrteqw_kI6r-DGG0,951
+pyloid/js_api/window_api.py,sha256=JDAFIMMiw75PNcyO8_163PJdRY-dvFNBO3IN0TA-Xsw,5383
+pyloid/monitor.py,sha256=nmcoOmlHeTysrZVT5mmL92ASbqMg8aH-hQg35qKWi0M,27540
+pyloid/pyloid.py,sha256=e_5G4wdkhZchPiwgydo2w5IIIpj-ZP8ge4ZQp9lmcXs,37889
+pyloid/timer.py,sha256=RqMsChFUd93cxMVgkHWiIKrci0QDTBgJSTULnAtYT8M,8712
+pyloid/tray.py,sha256=D12opVEc2wc2T4tK9epaN1oOdeziScsIVNM2uCN7C-A,1710
+pyloid/utils.py,sha256=VGZE2liY8_AElEqxVe1YLbk3fWlcAevpRc6oOTTgi-U,1927
+pyloid-0.14.0.dist-info/LICENSE,sha256=F96EzotgWhhpnQTW2TcdoqrMDir1jyEo6H915tGQ-QE,11524
+pyloid-0.14.0.dist-info/METADATA,sha256=QhNFQVNOyvDMqwD2QIz4RMpdxP_QUWkimmLaUsPO_jE,3634
+pyloid-0.14.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+pyloid-0.14.0.dist-info/RECORD,,

pyloid-0.13.0.dist-info/RECORD

@@ -1,14 +0,0 @@
-pyloid/__init__.py,sha256=OOPhOKNQVmAM8hnfTeE7lHzxb8LsFNcgegBAvDrA-vY,293
-pyloid/api.py,sha256=whgfvPr1A6iwZ1Ewo-0FnOUNnt1K58c-P7YjzuQHcUM,194
-pyloid/autostart.py,sha256=K7DQYl4LHItvPp0bt1V9WwaaZmVSTeGvadkcwG-KKrI,3899
-pyloid/custom/titlebar.py,sha256=itzK9pJbZMQ7BKca9kdbuHMffurrw15UijR6OU03Xsk,3894
-pyloid/filewatcher.py,sha256=n8N56D65le5TpsgxXb7z-FO_0lqv4UYD4yGq_UuMrAs,1285
-pyloid/monitor.py,sha256=fqDnZ_7dpxVZLVJ5gCluDRY2USrQ5YL_fw1AnYivhsk,12741
-pyloid/pyloid.py,sha256=Fj60bHP6x9_GPCxWSB97t21VwzdDjQmhf_RIWzc4_k0,53585
-pyloid/timer.py,sha256=1bYhqte3rV77vaeMUkcTgmx2ux7FtCqLCx9lIC2-COg,4360
-pyloid/tray.py,sha256=rXgdkvzGxtie_EIcTSA7fjuta4nJk5THhNkGFcfv5Ew,634
-pyloid/utils.py,sha256=DQerZWU_0o8dHcJ5y3yXf9i5OXn7KQZqU-hVBq3uPUA,711
-pyloid-0.13.0.dist-info/LICENSE,sha256=F96EzotgWhhpnQTW2TcdoqrMDir1jyEo6H915tGQ-QE,11524
-pyloid-0.13.0.dist-info/METADATA,sha256=q61MnQEpscRzhp5cQDk33lKSBgTCLm5xJ5-nX5L2o7w,3634
-pyloid-0.13.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-pyloid-0.13.0.dist-info/RECORD,,