Merge pull request #76 from python-thread/feature/v2.0.0

v2.0.0


Signed-off-by: AlexNg <[email protected]>

CITATION.cff

@@ -9,11 +9,11 @@ identifiers:
     value: 10.5281/zenodo.10799219
     description: This is the collection of archived snapshots of all versions of thread.
   - type: url
-    value: https://github.com/python-thread/thread/releases/tag/v1.1.1
-    description: The GitHub release URL of tag v1.1.1.
+    value: https://github.com/python-thread/thread/releases/tag/v2.0.0
+    description: The GitHub release URL of tag v2.0.0.
   - type: url
-    value: https://pypi.org/project/thread/1.1.1
-    description: The PyPI release URL of tag v1.1.1.
+    value: https://pypi.org/project/thread/2.0.0
+    description: The PyPI release URL of tag v2.0.0.
 cff-version: 1.2.0
 date-released: 2024-03-07
 keywords:
@@ -32,6 +32,6 @@ repository-code: https://github.com/python-thread/thread
 repository-artifact: https://pypi.org/project/thread
 title: thread
 type: software
-version: 1.1.1
+version: 2.0.0
 url: https://thread.ngjx.org
 

README.md

@@ -79,7 +79,7 @@ _Below is an example of how you can install and use thread._
 2. Import thread into your library!
    ```py
    import thread
-   from thread import Thread, ParallelProcessing
+   from thread import Thread, ConcurrentProcessing
    ```
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
@@ -98,7 +98,7 @@ Our docs are [here!](https://thread.ngjx.org)
 <!-- ROADMAP -->
 ## Roadmap
 
-- [x] v1.1.1 Release
+- [x] v2.0.0 Release
 - [ ] Bug fixes
 - [ ] New features
 - [ ] Testing

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "thread"
-version = "1.1.1"
+version = "2.0.0"
 description = "Threading module extension"
 authors = ["Alex <[email protected]>"]
 license = "BSD-3-Clause"
@@ -30,7 +30,7 @@ classifiers = [
 
 [tool.poetry.urls]
 Homepage = "https://thread.ngjx.org"
-Documentation = "https://thread.ngjx.org/docs/v1.1.1"
+Documentation = "https://thread.ngjx.org/docs/v2.0.0"
 Source = "https://github.com/python-thread/thread"
 Download = "https://pypi.org/project/thread/#files"
 "Release Notes" = "https://github.com/python-thread/thread/releases"

src/thread/__init__.py

@@ -1,11 +1,11 @@
 """
 ## Thread Library
-Documentation at https://thread.ngjx.org/docs/v1.1.1
+Documentation at https://thread.ngjx.org/docs/2.0.0
 
 
 ---
 
-Released under the GPG-3 License
+Released under the BSD-3 License
 
 Copyright (c) thread.ngjx.org, All rights reserved
 """
@@ -18,11 +18,11 @@
 """
 
 
-__version__ = '1.1.1'
+__version__ = '2.0.0'
 
 
 # Export Core
-from .thread import Thread, ParallelProcessing
+from .thread import Thread, ConcurrentProcessing
 
 
 from . import _types as types, exceptions
@@ -39,7 +39,7 @@
 # Wildcard Export
 __all__ = [
     'Thread',
-    'ParallelProcessing',
+    'ConcurrentProcessing',
     'threaded',
     'processor',
     'types',

src/thread/_types.py

@@ -1,7 +1,7 @@
 """
 ## Types
 
-Documentation: https://thread.ngjx.org/docs/v1.1.1
+Documentation: https://thread.ngjx.org/docs/v2.0.0
 """
 
 from typing import Any, Literal, Callable, Union, Sized

src/thread/decorators/_processor.py

@@ -1,11 +1,11 @@
 """
 ## Processor
 
-Documentation: https://thread.ngjx.org/docs/v1.1.1
+Documentation: https://thread.ngjx.org/docs/v2.0.0
 """
 
 from functools import wraps
-from ..thread import ParallelProcessing
+from ..thread import ConcurrentProcessing
 
 from .._types import (
     Overflow_In,
@@ -29,22 +29,23 @@
 
 NoParamReturn = Callable[
     Concatenate[Dataset[_DataT], _TargetP],
-    ParallelProcessing[_TargetP, _TargetT, _DataT],
+    ConcurrentProcessing[_TargetP, _TargetT, _DataT],
 ]
 WithParamReturn = Callable[
     [TargetFunction[_DataT, _TargetP, _TargetT]],
     NoParamReturn[_DataT, _TargetP, _TargetT],
 ]
 FullParamReturn = Callable[
     Concatenate[Dataset[_DataT], _TargetP],
-    ParallelProcessing[_TargetP, _TargetT, _DataT],
+    ConcurrentProcessing[_TargetP, _TargetT, _DataT],
 ]
 
 
 @overload
 def processor(
     __function: TargetFunction[_DataT, _TargetP, _TargetT],
-) -> NoParamReturn[_DataT, _TargetP, _TargetT]: ...
+) -> NoParamReturn[_DataT, _TargetP, _TargetT]:
+    ...
 
 
 @overload
@@ -55,7 +56,8 @@ def processor(
     ignore_errors: Sequence[type[Exception]] = (),
     suppress_errors: bool = False,
     **overflow_kwargs: Overflow_In,
-) -> WithParamReturn[_DataT, _TargetP, _TargetT]: ...
+) -> WithParamReturn[_DataT, _TargetP, _TargetT]:
+    ...
 
 
 @overload
@@ -67,7 +69,8 @@ def processor(
     ignore_errors: Sequence[type[Exception]] = (),
     suppress_errors: bool = False,
     **overflow_kwargs: Overflow_In,
-) -> FullParamReturn[_DataT, _TargetP, _TargetT]: ...
+) -> FullParamReturn[_DataT, _TargetP, _TargetT]:
+    ...
 
 
 def processor(
@@ -150,15 +153,15 @@ def wrapped(
         data: Dataset[_DataT],
         *parsed_args: _TargetP.args,
         **parsed_kwargs: _TargetP.kwargs,
-    ) -> ParallelProcessing[_TargetP, _TargetT, _DataT]:
+    ) -> ConcurrentProcessing[_TargetP, _TargetT, _DataT]:
         kwargs.update(parsed_kwargs)
 
         processed_args = (*args, *parsed_args)
         processed_kwargs = {
             i: v for i, v in kwargs.items() if i not in ['args', 'kwargs']
         }
 
-        job = ParallelProcessing(
+        job = ConcurrentProcessing(
             function=__function,
             dataset=data,
             args=processed_args,

src/thread/decorators/_threaded.py

@@ -1,7 +1,7 @@
 """
 ## Threaded
 
-Documentation: https://thread.ngjx.org/docs/v1.1.1
+Documentation: https://thread.ngjx.org/docs/v2.0.0
 """
 
 from functools import wraps
@@ -23,7 +23,8 @@
 
 
 @overload
-def threaded(__function: TargetFunction[P, T]) -> NoParamReturn[P, T]: ...
+def threaded(__function: TargetFunction[P, T]) -> NoParamReturn[P, T]:
+    ...
 
 
 @overload
@@ -34,7 +35,8 @@ def threaded(
     ignore_errors: Sequence[type[Exception]] = (),
     suppress_errors: bool = False,
     **overflow_kwargs: Overflow_In,
-) -> WithParamReturn[P, T]: ...
+) -> WithParamReturn[P, T]:
+    ...
 
 
 @overload
@@ -46,7 +48,8 @@ def threaded(
     ignore_errors: Sequence[type[Exception]] = (),
     suppress_errors: bool = False,
     **overflow_kwargs: Overflow_In,
-) -> FullParamReturn[P, T]: ...
+) -> FullParamReturn[P, T]:
+    ...
 
 
 def threaded(

src/thread/exceptions.py

@@ -1,7 +1,7 @@
 """
 ## Thread Exceptions
 
-Documentation: https://thread.ngjx.org/docs/v1.1.1
+Documentation: https://thread.ngjx.org/docs/v2.0.0
 """
 
 import traceback

src/thread/thread.py

@@ -5,10 +5,10 @@
 class Thread: ...
 
 
-class ParallelProcessing: ...
+class ConcurrentProcessing: ...
 ```
 
-Documentation: https://thread.ngjx.org/docs/v1.1.1
+Documentation: https://thread.ngjx.org/docs/v2.0.0
 """
 
 import sys
@@ -230,18 +230,14 @@ def add_hook(self, hook: HookFunction[_Target_T]) -> None:
         """
         self.hooks.append(hook)
 
-    def join(self, timeout: Optional[float] = None) -> bool:
+    def join(self, timeout: Optional[float] = None) -> None:
         """
         Halts the current thread execution until a thread completes or exceeds the timeout
 
         Parameters
         ----------
         :param timeout: The maximum time allowed to halt the thread
 
-        Returns
-        -------
-        :returns bool: True if the thread is no-longer alive
-
         Raises
         ------
         ThreadNotInitializedError: If the thread is not initialized
@@ -255,7 +251,6 @@ def join(self, timeout: Optional[float] = None) -> bool:
 
         super().join(timeout)
         self._handle_exceptions()
-        return not self.is_alive()
 
     def get_return_value(self) -> _Target_T:
         """
@@ -341,9 +336,9 @@ def __init__(self, thread: Thread, progress: float = 0) -> None:
         self.progress = progress
 
 
-class ParallelProcessing(Generic[_Target_P, _Target_T, _Dataset_T]):
+class ConcurrentProcessing(Generic[_Target_P, _Target_T, _Dataset_T]):
     """
-    Multi-Threaded Parallel Processing
+    Concurrent Processing
     ---------------------------------------
 
     Type-Safe and provides more functionality on top
@@ -378,7 +373,8 @@ def __init__(
         _get_value: Optional[Callable[[LengthandGetLike_T, int], _Dataset_T]] = None,
         _length: Optional[Union[int, Callable[[Any], int]]] = None,
         **overflow_kwargs: Overflow_In,
-    ) -> None: ...
+    ) -> None:
+        ...
 
     # Has __len__, require _get_value to be set
     @overload
@@ -391,7 +387,8 @@ def __init__(
         _get_value: Callable[[LengthLike_T, int], _Dataset_T],
         _length: Optional[Union[int, Callable[[Any], int]]] = None,
         **overflow_kwargs: Overflow_In,
-    ) -> None: ...
+    ) -> None:
+        ...
 
     # Has __getitem__, require _length to be set
     @overload
@@ -404,7 +401,8 @@ def __init__(
         _get_value: Optional[Callable[[GetLike_T, int], _Dataset_T]] = None,
         _length: Union[int, Callable[[GetLike_T], int]],
         **overflow_kwargs: Overflow_In,
-    ) -> None: ...
+    ) -> None:
+        ...
 
     # Does not support __getitem__ and __len__
     @overload
@@ -417,7 +415,8 @@ def __init__(
         _get_value: Callable[[Any, int], _Dataset_T],
         _length: Union[int, Callable[[Any], int]],
         **overflow_kwargs: Overflow_In,
-    ) -> None: ...
+    ) -> None:
+        ...
 
     def __init__(
         self,
@@ -442,10 +441,10 @@ def __init__(
         **overflow_kwargs: Overflow_In,
     ) -> None:
         """
-        Initializes a new Multi-Threaded Pool\n
+        Initializes a new Concurrent Process\n
         Best for data processing
 
-        Splits a dataset as evenly as it can among the threads and run them in parallel
+        Splits a dataset as evenly as it can among the threads and run them concurrently
 
         Parameters
         ----------
@@ -598,14 +597,10 @@ def get_return_values(self) -> List[_Dataset_T]:
             results += entry.thread.result
         return results
 
-    def join(self) -> bool:
+    def join(self) -> None:
         """
         Halts the current thread execution until a thread completes or exceeds the timeout
 
-        Returns
-        -------
-        :returns bool: True if the thread is no-longer alive
-
         Raises
         ------
         ThreadNotInitializedError: If the thread is not initialized
@@ -619,7 +614,6 @@ def join(self) -> bool:
 
         for entry in self._threads:
             entry.thread.join()
-        return True
 
     def kill(self) -> None:
         """