xkits-thread 0.1__tar.gz

xkits_thread-0.1/LICENSE

@@ -0,0 +1,339 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

xkits_thread-0.1/PKG-INFO

@@ -0,0 +1,25 @@
+Metadata-Version: 2.1
+Name: xkits-thread
+Version: 0.1
+Summary: Thread module
+Home-page: https://github.com/bondbox/xthreads/
+Author: Mingzhe Zou
+Author-email: zoumingzhe@outlook.com
+License: GPLv2
+Project-URL: Source Code, https://github.com/bondbox/xthreads/
+Project-URL: Bug Tracker, https://github.com/bondbox/xthreads/issues
+Project-URL: Documentation, https://github.com/bondbox/xthreads/
+Keywords: thread-pool,threads,thread,task
+Platform: any
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: xkits-command>=0.2
+Requires-Dist: xkits-logger>=0.1
+Requires-Dist: xkits-lib>=0.1
+
+# xthreads
+
+Thread module

xkits_thread-0.1/README.md

@@ -0,0 +1,3 @@
+# xthreads
+
+Thread module

xkits_thread-0.1/setup.cfg

@@ -0,0 +1,20 @@
+[metadata]
+keywords = thread-pool, threads, thread, task
+long_description = file: README.md
+long_description_content_type = text/markdown
+license = GPLv2
+license_files = LICENSE
+platforms = any
+classifiers = 
+	Programming Language :: Python
+	Programming Language :: Python :: 3
+
+[options]
+zip_safe = True
+include_package_data = True
+python_requires = >=3.8
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

xkits_thread-0.1/setup.py

@@ -0,0 +1,40 @@
+# coding=utf-8
+
+from urllib.parse import urljoin
+
+from setuptools import find_packages
+from setuptools import setup
+
+from xkits_thread.attribute import __author__
+from xkits_thread.attribute import __author_email__
+from xkits_thread.attribute import __description__
+from xkits_thread.attribute import __project__
+from xkits_thread.attribute import __urlhome__
+from xkits_thread.attribute import __version__
+
+__urlcode__ = __urlhome__
+__urldocs__ = __urlhome__
+__urlbugs__ = urljoin(__urlhome__, "issues")
+
+
+def all_requirements():
+    def read_requirements(path: str):
+        with open(path, "r", encoding="utf-8") as rhdl:
+            return rhdl.read().splitlines()
+
+    requirements = read_requirements("requirements.txt")
+    return requirements
+
+
+setup(
+    name=__project__,
+    version=__version__,
+    description=__description__,
+    url=__urlhome__,
+    author=__author__,
+    author_email=__author_email__,
+    project_urls={"Source Code": __urlcode__,
+                  "Bug Tracker": __urlbugs__,
+                  "Documentation": __urldocs__},
+    packages=find_packages(include=["xkits_thread*"], exclude=["xkits_thread.unittest"]),  # noqa:E501
+    install_requires=all_requirements())

xkits_thread-0.1/xkits_thread/__init__.py

@@ -0,0 +1,9 @@
+# coding:utf-8
+
+from xkits_thread.executor import ThreadPool  # noqa:F401
+from xkits_thread.executor import hourglass  # noqa:F401
+from xkits_thread.lock import NamedLock  # noqa:F401
+from xkits_thread.task import DaemonTaskJob  # noqa:F401
+from xkits_thread.task import DelayTaskJob  # noqa:F401
+from xkits_thread.task import TaskJob  # noqa:F401
+from xkits_thread.task import TaskPool  # noqa:F401

xkits_thread-0.1/xkits_thread/attribute.py

@@ -0,0 +1,10 @@
+# coding:utf-8
+
+__project__ = "xkits-thread"
+__version__ = "0.1"
+__urlhome__ = "https://github.com/bondbox/xthreads/"
+__description__ = "Thread module"
+
+# author
+__author__ = "Mingzhe Zou"
+__author_email__ = "zoumingzhe@outlook.com"

xkits_thread-0.1/xkits_thread/executor.py

@@ -0,0 +1,72 @@
+# coding:utf-8
+
+from concurrent.futures import ThreadPoolExecutor
+from concurrent.futures import TimeoutError as ThreadTimeout
+from threading import Thread
+from threading import current_thread  # noqa:H306
+from typing import Callable
+from typing import Optional
+from typing import Set
+from typing import Tuple
+
+from xkits_command.actuator import Command
+from xkits_lib.meter import TimeUnit
+
+
+class Executor():  # pylint: disable=too-few-public-methods
+    def __init__(self, fn: Callable, *args, **kwargs) -> None:
+        self.__fn = fn
+        self.__args = args
+        self.__kwargs = kwargs
+
+    def countdown(self, seconds: TimeUnit):
+        with ThreadPoolExecutor() as executor:
+            try:
+                future = executor.submit(self.__fn, *self.__args, **self.__kwargs)  # noqa:E501
+                return future.result(seconds)
+            except ThreadTimeout as exc:
+                message: str = f"Run timeout of {seconds} seconds"
+                raise TimeoutError(message) from exc
+
+
+def hourglass(seconds: TimeUnit):
+    def decorator(fn):
+        def inner(*args, **kwargs):
+            return Executor(fn, *args, **kwargs).countdown(seconds)
+        return inner
+    return decorator
+
+
+class ThreadPool(ThreadPoolExecutor):
+    '''Thread Pool'''
+
+    def __init__(self, max_workers: Optional[int] = None,
+                 thread_name_prefix: str = "work_thread",
+                 initializer: Optional[Callable] = None,
+                 initargs: Tuple = ()):
+        '''Initializes an instance based on ThreadPoolExecutor.'''
+        self.__cmds: Command = Command()
+        if isinstance(max_workers, int):
+            max_workers = max(max_workers, 2)
+        super().__init__(max_workers, thread_name_prefix, initializer, initargs)  # noqa:E501
+
+    @property
+    def cmds(self) -> Command:
+        '''command-line toolkit'''
+        return self.__cmds
+
+    @property
+    def alive_threads(self) -> Set[Thread]:
+        '''alive threads'''
+        return {thread for thread in self._threads if thread.is_alive()}
+
+    @property
+    def other_threads(self) -> Set[Thread]:
+        '''other threads'''
+        current: Thread = current_thread()
+        return {thread for thread in self._threads if thread is not current}
+
+    @property
+    def other_alive_threads(self) -> Set[Thread]:
+        '''other alive threads'''
+        return {thread for thread in self.other_threads if thread.is_alive()}

xkits_thread-0.1/xkits_thread/lock.py

@@ -0,0 +1,57 @@
+# coding:utf-8
+
+from threading import Lock
+from typing import Dict
+from typing import Generic
+from typing import Iterator
+from typing import TypeVar
+
+LKIT = TypeVar("LKIT")
+LKNT = TypeVar("LKNT")
+
+
+class NamedLock(Generic[LKNT]):
+
+    class LockItem(Generic[LKIT]):
+        def __init__(self, name: LKIT):
+            self.__lock: Lock = Lock()
+            self.__name: LKIT = name
+
+        @property
+        def name(self) -> LKIT:
+            return self.__name
+
+        @property
+        def lock(self) -> Lock:
+            return self.__lock
+
+    def __init__(self):
+        self.__locks: Dict[LKNT, NamedLock.LockItem[LKNT]] = {}
+        self.__inter: Lock = Lock()  # internal lock
+
+    def __len__(self) -> int:
+        return len(self.__locks)
+
+    def __iter__(self) -> Iterator[LockItem[LKNT]]:
+        return iter(self.__locks.values())
+
+    def __contains__(self, name: LKNT) -> bool:
+        return name in self.__locks
+
+    def __getitem__(self, name: LKNT) -> Lock:
+        return self.lookup(name).lock
+
+    def lookup(self, name: LKNT) -> LockItem[LKNT]:
+        try:
+            return self.__locks[name]
+        except KeyError:
+            with self.__inter:
+                if name not in self.__locks:
+                    lock = self.LockItem(name)
+                    self.__locks.setdefault(name, lock)
+                    assert self.__locks[name] is lock
+                    return lock
+
+                lock = self.__locks[name]  # pragma: no cover
+                assert lock.name == name  # pragma: no cover
+                return lock  # pragma: no cover

xkits_thread-0.1/xkits_thread/task.py

@@ -0,0 +1,350 @@
+# coding:utf-8
+
+from queue import Queue
+import sys
+from threading import Lock
+from threading import Thread
+from threading import current_thread  # noqa:H306
+from time import sleep
+from typing import Any
+from typing import Callable
+from typing import Dict
+from typing import Optional
+from typing import Set
+from typing import Tuple
+
+from xkits_command.actuator import Command
+from xkits_lib.meter import CountMeter
+from xkits_lib.meter import StatusCountMeter
+from xkits_lib.meter import TimeMeter
+from xkits_lib.meter import TimeUnit
+from xkits_logger.logger import Logger
+
+
+class TaskJob():
+    '''Task Job'''
+
+    def __init__(self, no: int, fn: Callable, *args: Any, **kwargs: Any):
+        self.__no: int = no
+        self.__fn: Callable = fn
+        self.__args: Tuple[Any, ...] = args
+        self.__kwargs: Dict[str, Any] = kwargs
+        self.__result: Any = LookupError(f"{self} is not started")
+        self.__running_timer: TimeMeter = TimeMeter(startup=False)
+
+    @classmethod
+    def create_task(cls, fn: Callable, *args: Any, **kwargs: Any) -> "TaskJob":
+        return cls(-1, fn, *args, **kwargs)
+
+    def __str__(self) -> str:
+        args = list(self.args) + list(f"{k}={v}" for k, v in self.kwargs)
+        info: str = ", ".join(f"{a}" for a in args)
+        return f"{self.__class__.__name__}{self.id} {self.fn}({info})"
+
+    @property
+    def id(self) -> int:
+        '''job id'''
+        return self.__no
+
+    @property
+    def fn(self) -> Callable:
+        '''job callable function'''
+        return self.__fn
+
+    @property
+    def args(self) -> Tuple[Any, ...]:
+        '''job callable arguments'''
+        return self.__args
+
+    @property
+    def kwargs(self) -> Dict[str, Any]:
+        '''job callable keyword arguments'''
+        return self.__kwargs
+
+    @property
+    def result(self) -> Any:
+        '''job callable function return value'''
+        if isinstance(self.__result, Exception):
+            raise self.__result
+        return self.__result
+
+    @property
+    def running_timer(self) -> TimeMeter:
+        '''job running timer'''
+        return self.__running_timer
+
+    def run(self) -> bool:
+        '''run job'''
+        try:
+            if self.running_timer.started:
+                raise RuntimeError(f"{self} is already started")
+            assert not self.running_timer.started, f"{self} is already started"
+            self.running_timer.startup()
+            assert self.running_timer.started, f"failed to start {self}"
+            self.__result = self.fn(*self.args, **self.kwargs)
+            return True
+        except Exception as error:  # pylint: disable=broad-exception-caught
+            self.__result = error
+            return False
+        finally:
+            self.running_timer.shutdown()
+
+    def shutdown(self) -> None:
+        '''wait for job to finish'''
+        while self.running_timer.started:
+            sleep(0.05)
+
+    def startup(self) -> None:
+        '''same as run'''
+        self.run()
+
+    def restart(self) -> None:
+        '''restart job'''
+        self.shutdown()
+        self.startup()
+
+    def barrier(self) -> None:
+        '''same as shutdown'''
+        self.shutdown()
+
+
+class DelayTaskJob(TaskJob):
+    '''Delay Task Job'''
+    MIN_DELAY_TIME: float = 0.001
+
+    def __init__(self, delay: TimeUnit, no: int, fn: Callable, *args: Any, **kwargs: Any):  # noqa:E501
+        self.__delay_time: float = float(max(delay, self.MIN_DELAY_TIME))
+        self.__delay_timer: TimeMeter = TimeMeter(startup=True)
+        super().__init__(no, fn, *args, **kwargs)
+
+    @classmethod
+    def create_delay_task(cls, delay: TimeUnit, fn: Callable, *args: Any, **kwargs: Any) -> "DelayTaskJob":  # noqa:E501
+        return cls(delay, -1, fn, *args, **kwargs)
+
+    @property
+    def delay_timer(self) -> TimeMeter:
+        '''job delay timer'''
+        return self.__delay_timer
+
+    @property
+    def delay_time(self) -> float:
+        '''job delay time'''
+        return self.__delay_time
+
+    @property
+    def waiting(self) -> bool:
+        '''job waiting to run'''
+        return self.delay_timer.runtime < self.delay_time
+
+    def renew(self, delay: Optional[TimeUnit] = None) -> None:
+        '''renew delay time'''
+        if delay is not None:
+            self.__delay_time = float(max(delay, self.MIN_DELAY_TIME))
+        self.delay_timer.restart()
+
+    def run(self) -> bool:
+        '''run delay job'''
+        self.delay_timer.alarm(self.delay_time)
+        assert not self.waiting, f"{self} is waiting to run"
+        return super().run()
+
+
+class DaemonTaskJob(TaskJob):
+    '''Daemon Task Job'''
+
+    def __init__(self, no: int, fn: Callable, *args: Any, **kwargs: Any):
+        self.__counter: StatusCountMeter = StatusCountMeter()
+        super().__init__(no, fn, *args, **kwargs)
+        self.__running: bool = False
+
+    @classmethod
+    def create_daemon_task(cls, fn: Callable, *args: Any, **kwargs: Any) -> "DaemonTaskJob":  # noqa:E501
+        return cls(-1, fn, *args, **kwargs)
+
+    @property
+    def daemon_counter(self) -> StatusCountMeter:
+        '''daemon status counter'''
+        return self.__counter
+
+    @property
+    def daemon_running(self) -> bool:
+        '''daemon running flag'''
+        return self.__running
+
+    def run_in_background(self) -> Thread:
+        '''run job in daemon mode in background'''
+        thread: Thread = Thread(target=self.run)
+        thread.start()
+        return thread
+
+    def run(self):
+        '''run job in daemon mode in current thread'''
+        self.__running = True
+        while self.daemon_running:
+            success: bool = super().run()
+            self.daemon_counter.inc(success)
+
+    def shutdown(self) -> None:
+        '''wait for job to finish'''
+        self.__running = False
+        super().shutdown()
+
+    def startup(self) -> None:
+        '''same as run in background'''
+        self.run_in_background()
+
+    def restart(self) -> None:
+        '''restart job'''
+        self.shutdown()
+        self.startup()
+
+    def barrier(self) -> None:
+        '''same as restart'''
+        self.restart()
+
+
+if sys.version_info >= (3, 9):
+    JobQueue = Queue[Optional[TaskJob]]  # noqa: E501, pragma: no cover, pylint: disable=unsubscriptable-object
+else:  # Python3.8 TypeError
+    JobQueue = Queue  # pragma: no cover
+
+
+class TaskPool(Dict[int, TaskJob]):  # noqa: E501, pylint: disable=too-many-instance-attributes
+    '''Task Thread Pool'''
+
+    def __init__(self, workers: int = 1, jobs: int = 0, prefix: str = "task"):
+        wsize: int = max(workers, 1)
+        qsize = max(wsize, jobs) if jobs > 0 else jobs
+        self.__cmds: Command = Command()
+        self.__jobs: JobQueue = Queue(qsize)
+        self.__prefix: str = prefix or "task"
+        self.__status: StatusCountMeter = StatusCountMeter()
+        self.__counter: CountMeter = CountMeter()
+        self.__threads: Set[Thread] = set()
+        self.__intlock: Lock = Lock()  # internal lock
+        self.__running: bool = False
+        self.__workers: int = wsize
+        super().__init__()
+
+    def __enter__(self):
+        self.startup()
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        self.shutdown()
+
+    @property
+    def jobs(self) -> JobQueue:
+        '''task jobs'''
+        return self.__jobs
+
+    @property
+    def cmds(self) -> Command:
+        '''command-line toolkit'''
+        return self.__cmds
+
+    @property
+    def thread_name_prefix(self) -> str:
+        '''task thread name prefix'''
+        return self.__prefix
+
+    @property
+    def threads(self) -> Set[Thread]:
+        '''task threads'''
+        return self.__threads
+
+    @property
+    def running(self) -> bool:
+        '''task threads are started'''
+        return self.__running
+
+    @property
+    def workers(self) -> int:
+        '''task workers'''
+        return self.__workers
+
+    @property
+    def status_counter(self) -> StatusCountMeter:
+        '''task job status counter'''
+        return self.__status
+
+    def task(self):
+        '''execute a task from jobs queue'''
+        status_counter: StatusCountMeter = StatusCountMeter()
+
+        logger: Logger = self.cmds.logger
+        logger.debug("Task thread %s is running", current_thread().name)
+
+        while True:
+            job: Optional[TaskJob] = self.jobs.get(block=True)
+            if job is None:  # stop task
+                self.jobs.put(job)  # notice other tasks
+                break
+
+            if isinstance(job, DelayTaskJob) and job.waiting and self.running:
+                self.jobs.put(job)  # delay run task
+                continue
+
+            if not job.run():
+                self.status_counter.inc(False)
+                status_counter.inc(False)
+            else:
+                self.status_counter.inc(True)
+                status_counter.inc(True)
+
+        logger.debug("Task thread %s is stopped, %s", current_thread().name,
+                     f"{status_counter.total} jobs: {status_counter.success} success and {status_counter.failure} failure")  # noqa:E501
+
+    def submit_job(self, job: TaskJob) -> TaskJob:
+        assert isinstance(job, TaskJob), f"{job} is not a TaskJob"
+        assert job.id not in self, f"{job} id is already in pool"
+        assert job.id > 0, f"{job} id is invalid"
+        self.jobs.put(job, block=True)
+        self.setdefault(job.id, job)
+        return job
+
+    def submit_task(self, fn: Callable, *args: Any, **kwargs: Any) -> TaskJob:
+        '''submit a task to jobs queue'''
+        with self.__intlock:  # generate job id under lock protection
+            sn: int = self.__counter.inc()  # serial number
+            return self.submit_job(TaskJob(sn, fn, *args, **kwargs))
+
+    def submit_delay_task(self, delay: TimeUnit, fn: Callable, *args: Any, **kwargs: Any) -> TaskJob:  # noqa:E501
+        '''submit a delay task to jobs queue'''
+        with self.__intlock:  # generate job id under lock protection
+            sn: int = self.__counter.inc()  # serial number
+            return self.submit_job(DelayTaskJob(delay, sn, fn, *args, **kwargs))  # noqa:E501
+
+    def shutdown(self) -> None:
+        '''stop all task threads and waiting for all jobs finish'''
+        with self.__intlock:  # block submit new tasks
+            self.cmds.logger.debug("Shutdown %s tasks", self.thread_name_prefix)  # noqa:E501
+            self.__running = False
+            self.jobs.put(None)  # notice tasks
+            while len(self.threads) > 0:
+                thread: Thread = self.threads.pop()
+                thread.join()
+            while not self.jobs.empty():
+                job: Optional[TaskJob] = self.jobs.get(block=True)
+                if job is not None:  # shutdown only after executed
+                    raise RuntimeError(f"Unexecuted job: {job}")  # noqa:E501, pragma: no cover
+
+    def startup(self) -> None:
+        '''start task threads'''
+        with self.__intlock:
+            self.cmds.logger.debug("Startup %s tasks", self.thread_name_prefix)
+            for i in range(self.workers):
+                thread_name: str = f"{self.thread_name_prefix}_{i}"
+                thread = Thread(name=thread_name, target=self.task)
+                self.threads.add(thread)
+                thread.start()  # run
+            self.__running = True
+
+    def restart(self) -> None:
+        '''stop submit new tasks and waiting for all submitted tasks to end'''
+        self.shutdown()
+        self.startup()
+
+    def barrier(self) -> None:
+        '''same as restart'''
+        self.restart()

xkits_thread-0.1/xkits_thread.egg-info/PKG-INFO

@@ -0,0 +1,25 @@
+Metadata-Version: 2.1
+Name: xkits-thread
+Version: 0.1
+Summary: Thread module
+Home-page: https://github.com/bondbox/xthreads/
+Author: Mingzhe Zou
+Author-email: zoumingzhe@outlook.com
+License: GPLv2
+Project-URL: Source Code, https://github.com/bondbox/xthreads/
+Project-URL: Bug Tracker, https://github.com/bondbox/xthreads/issues
+Project-URL: Documentation, https://github.com/bondbox/xthreads/
+Keywords: thread-pool,threads,thread,task
+Platform: any
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: xkits-command>=0.2
+Requires-Dist: xkits-logger>=0.1
+Requires-Dist: xkits-lib>=0.1
+
+# xthreads
+
+Thread module

xkits_thread-0.1/xkits_thread.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+LICENSE
+README.md
+setup.cfg
+setup.py
+xkits_thread/__init__.py
+xkits_thread/attribute.py
+xkits_thread/executor.py
+xkits_thread/lock.py
+xkits_thread/task.py
+xkits_thread.egg-info/PKG-INFO
+xkits_thread.egg-info/SOURCES.txt
+xkits_thread.egg-info/dependency_links.txt
+xkits_thread.egg-info/requires.txt
+xkits_thread.egg-info/top_level.txt
+xkits_thread.egg-info/zip-safe

xkits_thread-0.1/xkits_thread.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

xkits_thread-0.1/xkits_thread.egg-info/requires.txt

@@ -0,0 +1,3 @@
+xkits-command>=0.2
+xkits-logger>=0.1
+xkits-lib>=0.1

xkits_thread-0.1/xkits_thread.egg-info/top_level.txt

@@ -0,0 +1 @@
+xkits_thread

xkits_thread-0.1/xkits_thread.egg-info/zip-safe

@@ -0,0 +1 @@
+