Imported Upstream version 1.4
authorBen Carrillo <ben@futeisha.org>
Mon, 7 Jul 2014 16:11:00 +0000 (11:11 -0500)
committerBen Carrillo <ben@futeisha.org>
Mon, 7 Jul 2014 16:11:00 +0000 (11:11 -0500)
20 files changed:
.gitignore [new file with mode: 0644]
.travis.yml [new file with mode: 0644]
LICENSE [new file with mode: 0644]
Makefile [new file with mode: 0644]
PKG-INFO [new file with mode: 0644]
README.rst [new file with mode: 0644]
docs/Makefile [new file with mode: 0644]
docs/conf.py [new file with mode: 0644]
docs/index.rst [new file with mode: 0644]
setup.cfg [new file with mode: 0644]
setup.py [new file with mode: 0644]
taskthread.egg-info/PKG-INFO [new file with mode: 0644]
taskthread.egg-info/SOURCES.txt [new file with mode: 0644]
taskthread.egg-info/dependency_links.txt [new file with mode: 0644]
taskthread.egg-info/top_level.txt [new file with mode: 0644]
taskthread/__init__.py [new file with mode: 0644]
taskthread/tests/__init__.py [new file with mode: 0644]
taskthread/tests/unit/__init__.py [new file with mode: 0644]
taskthread/tests/unit/test_taskthread.py [new file with mode: 0644]
test-requirements.txt [new file with mode: 0644]

diff --git a/.gitignore b/.gitignore
new file mode 100644 (file)
index 0000000..ef7b95c
--- /dev/null
@@ -0,0 +1,40 @@
+*.py[cod]
+
+# C extensions
+*.so
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+lib
+lib64
+__pycache__
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.tox
+nosetests.xml
+
+# Translations
+*.mo
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+# sphinx
+_build
+htmlcov
diff --git a/.travis.yml b/.travis.yml
new file mode 100644 (file)
index 0000000..0f22ed2
--- /dev/null
@@ -0,0 +1,9 @@
+language: python
+python:
+  - "2.7"
+  - "2.6"
+before_install:
+ - sudo apt-get update -qq
+ - sudo apt-get install -qq unixodbc-dev
+install: pip install -r test-requirements.txt --use-mirrors
+script: make test
diff --git a/LICENSE b/LICENSE
new file mode 100644 (file)
index 0000000..e06d208
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
diff --git a/Makefile b/Makefile
new file mode 100644 (file)
index 0000000..e835fed
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,17 @@
+clean-pyc:
+       find . -type f -name "*.pyc" -delete
+       find . -type f -name "*.pyo" -delete
+
+documentation:
+       cd docs && make clean html
+
+pep8:
+       pep8 -r taskthread && echo "All good!"
+
+unittest: clean-pyc
+       coverage erase
+       coverage run --include "taskthread*" --omit "*test*" -m unittest2 discover
+       coverage report
+       coverage html
+
+test: pep8 unittest documentation
diff --git a/PKG-INFO b/PKG-INFO
new file mode 100644 (file)
index 0000000..5dc1fe1
--- /dev/null
+++ b/PKG-INFO
@@ -0,0 +1,79 @@
+Metadata-Version: 1.0
+Name: taskthread
+Version: 1.4
+Summary: Simple thread module to repetitively perform a task on a single thread
+Home-page: http://hpcloud.com
+Author: John Herndon
+Author-email: john.herndon@hp.com
+License: Apache
+Description: TaskThread
+        ==========
+        
+        Python thread module to repeat an predefined task on a thread mulitple times.
+        A TaskThread is useful when a task needs to be repeated several times on 
+        a separate thread. Normal usage of the threading.Thread class would call for
+        creation of a new thread each time the same task needs to be run. This module
+        allows for repetitive tasks to be run multiple times on the same thread by having
+        the thread wait until the task needs to be executed again.
+        
+        
+        Provided Classes
+        ----------------
+        ``taskthread.TaskThread```
+            A sub-class of ``threading.Thread`` that may execute a single task
+            multiple times without the overhead of starting a new thread.
+        ``taskthread.TaskInProcessException``
+            Exception that is thrown if a task is started on a thread that is
+            already executing.
+        
+        
+        Installation
+        ------------
+        
+        *taskthread* may be installed by executing ``pip install taskthread``.
+        
+        
+        Links
+        -------------
+        
+        * `documentation <http://taskthread.readthedocs.org/en/latest/>`_ 
+        * `source <http://github.com/hpcs-som/taskthread/>`_
+        
+        
+        Changes
+        -------
+        
+        v1.4
+        ~~~~
+        
+        * **ADD** ``TimerTask`` class that runs a repetitive task on a taskthread.
+        
+        
+        v1.3
+        ~~~~
+        
+        * Change task loop to support python 2.6.
+        
+        
+        v1.2
+        ~~~~
+        
+        * Refactor the module so classes are defined in __init__.py.
+        
+        
+        v1.1
+        ~~~~
+        
+        * **ADD** ``TaskThread.join_task`` method that waits for the currently executing.
+          task to complete.
+        
+        
+        v1.0
+        ~~~~
+        
+        * First release
+        
+        
+        
+        
+Platform: UNKNOWN
diff --git a/README.rst b/README.rst
new file mode 100644 (file)
index 0000000..8587918
--- /dev/null
@@ -0,0 +1,69 @@
+TaskThread
+==========
+
+Python thread module to repeat an predefined task on a thread mulitple times.
+A TaskThread is useful when a task needs to be repeated several times on 
+a separate thread. Normal usage of the threading.Thread class would call for
+creation of a new thread each time the same task needs to be run. This module
+allows for repetitive tasks to be run multiple times on the same thread by having
+the thread wait until the task needs to be executed again.
+
+
+Provided Classes
+----------------
+``taskthread.TaskThread```
+    A sub-class of ``threading.Thread`` that may execute a single task
+    multiple times without the overhead of starting a new thread.
+``taskthread.TaskInProcessException``
+    Exception that is thrown if a task is started on a thread that is
+    already executing.
+
+
+Installation
+------------
+
+*taskthread* may be installed by executing ``pip install taskthread``.
+
+
+Links
+-------------
+
+* `documentation <http://taskthread.readthedocs.org/en/latest/>`_ 
+* `source <http://github.com/hpcs-som/taskthread/>`_
+
+
+Changes
+-------
+
+v1.4
+~~~~
+
+* **ADD** ``TimerTask`` class that runs a repetitive task on a taskthread.
+
+
+v1.3
+~~~~
+
+* Change task loop to support python 2.6.
+
+
+v1.2
+~~~~
+
+* Refactor the module so classes are defined in __init__.py.
+
+
+v1.1
+~~~~
+
+* **ADD** ``TaskThread.join_task`` method that waits for the currently executing.
+  task to complete.
+
+
+v1.0
+~~~~
+
+* First release
+
+
+
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644 (file)
index 0000000..2aad710
--- /dev/null
@@ -0,0 +1,153 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+       @echo "Please use \`make <target>' where <target> is one of"
+       @echo "  html       to make standalone HTML files"
+       @echo "  dirhtml    to make HTML files named index.html in directories"
+       @echo "  singlehtml to make a single large HTML file"
+       @echo "  pickle     to make pickle files"
+       @echo "  json       to make JSON files"
+       @echo "  htmlhelp   to make HTML files and a HTML help project"
+       @echo "  qthelp     to make HTML files and a qthelp project"
+       @echo "  devhelp    to make HTML files and a Devhelp project"
+       @echo "  epub       to make an epub"
+       @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+       @echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+       @echo "  text       to make text files"
+       @echo "  man        to make manual pages"
+       @echo "  texinfo    to make Texinfo files"
+       @echo "  info       to make Texinfo files and run them through makeinfo"
+       @echo "  gettext    to make PO message catalogs"
+       @echo "  changes    to make an overview of all changed/added/deprecated items"
+       @echo "  linkcheck  to check all external links for integrity"
+       @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+       -rm -rf $(BUILDDIR)/*
+
+html:
+       $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+       @echo
+       @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+       $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+       @echo
+       @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+       $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+       @echo
+       @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+       $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+       @echo
+       @echo "Build finished; now you can process the pickle files."
+
+json:
+       $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+       @echo
+       @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+       $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+       @echo
+       @echo "Build finished; now you can run HTML Help Workshop with the" \
+             ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+       $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+       @echo
+       @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+             ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+       @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/taskthread.qhcp"
+       @echo "To view the help file:"
+       @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/taskthread.qhc"
+
+devhelp:
+       $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+       @echo
+       @echo "Build finished."
+       @echo "To view the help file:"
+       @echo "# mkdir -p $$HOME/.local/share/devhelp/taskthread"
+       @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/taskthread"
+       @echo "# devhelp"
+
+epub:
+       $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+       @echo
+       @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+       $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+       @echo
+       @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+       @echo "Run \`make' in that directory to run these through (pdf)latex" \
+             "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+       $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+       @echo "Running LaTeX files through pdflatex..."
+       $(MAKE) -C $(BUILDDIR)/latex all-pdf
+       @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+       $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+       @echo
+       @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+       $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+       @echo
+       @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+       $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+       @echo
+       @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+       @echo "Run \`make' in that directory to run these through makeinfo" \
+             "(use \`make info' here to do that automatically)."
+
+info:
+       $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+       @echo "Running Texinfo files through makeinfo..."
+       make -C $(BUILDDIR)/texinfo info
+       @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+       $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+       @echo
+       @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+       $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+       @echo
+       @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+       $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+       @echo
+       @echo "Link check complete; look for any errors in the above output " \
+             "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+       $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+       @echo "Testing of doctests in the sources finished, look at the " \
+             "results in $(BUILDDIR)/doctest/output.txt."
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644 (file)
index 0000000..cdcfa82
--- /dev/null
@@ -0,0 +1,247 @@
+# -*- coding: utf-8 -*-
+#
+# taskthread documentation build configuration file, created by
+# sphinx-quickstart on Wed Dec  4 15:35:14 2013.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+sys.path.insert(0, os.path.abspath('..'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'taskthread'
+copyright = u'2013, Hewlett-Packard Development Company'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+import taskthread
+# The short X.Y version.
+version = taskthread.__version__
+# The full version, including alpha/beta/rc tags.
+release = version
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+if on_rtd:
+    html_theme = 'default'
+else:
+    html_theme = 'agogo'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'taskthreaddoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'taskthread.tex', u'taskthread Documentation',
+   u'John Herndon', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'taskthread', u'taskthread Documentation',
+     [u'John Herndon'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'taskthread', u'taskthread Documentation',
+   u'John Herndon', 'taskthread', 'Repetitive task on a thread.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644 (file)
index 0000000..d52b808
--- /dev/null
@@ -0,0 +1,33 @@
+.. taskthread documentation master file, created by
+   sphinx-quickstart on Wed Dec  4 15:35:14 2013.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to taskthread's documentation!
+======================================
+
+*taskthread* provides a thread implementation that executes a repetitive
+task several times without the need to start up a new thread.
+
+Installation
+------------
+
+*taskthread* can be installed with pip, via ``pip install taskthread``.
+
+Usage
+-----
+
+TaskThread
+~~~~~~~~~~
+.. autoclass:: taskthread.TaskThread
+    :members:
+
+TaskInProcessException
+~~~~~~~~~~~~~~~~~~~~~~
+.. autoclass:: taskthread.TaskInProcessException
+    :members:
+
+TimerThread
+~~~~~~~~~~~~~~~~~~~~~~
+.. autoclass:: taskthread.TimerTask
+    :members:
diff --git a/setup.cfg b/setup.cfg
new file mode 100644 (file)
index 0000000..861a9f5
--- /dev/null
+++ b/setup.cfg
@@ -0,0 +1,5 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+tag_svn_revision = 0
+
diff --git a/setup.py b/setup.py
new file mode 100644 (file)
index 0000000..bc6abae
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,16 @@
+from setuptools import setup, find_packages
+
+import taskthread
+
+
+setup(
+    name='taskthread',
+    version=taskthread.__version__,
+    url='http://hpcloud.com',
+    license='Apache',
+    author='John Herndon',
+    author_email='john.herndon@hp.com',
+    description='Simple thread module to repetitively perform a task on a single thread',
+    long_description=open('README.rst').read(),
+    packages=find_packages()
+)
diff --git a/taskthread.egg-info/PKG-INFO b/taskthread.egg-info/PKG-INFO
new file mode 100644 (file)
index 0000000..5dc1fe1
--- /dev/null
@@ -0,0 +1,79 @@
+Metadata-Version: 1.0
+Name: taskthread
+Version: 1.4
+Summary: Simple thread module to repetitively perform a task on a single thread
+Home-page: http://hpcloud.com
+Author: John Herndon
+Author-email: john.herndon@hp.com
+License: Apache
+Description: TaskThread
+        ==========
+        
+        Python thread module to repeat an predefined task on a thread mulitple times.
+        A TaskThread is useful when a task needs to be repeated several times on 
+        a separate thread. Normal usage of the threading.Thread class would call for
+        creation of a new thread each time the same task needs to be run. This module
+        allows for repetitive tasks to be run multiple times on the same thread by having
+        the thread wait until the task needs to be executed again.
+        
+        
+        Provided Classes
+        ----------------
+        ``taskthread.TaskThread```
+            A sub-class of ``threading.Thread`` that may execute a single task
+            multiple times without the overhead of starting a new thread.
+        ``taskthread.TaskInProcessException``
+            Exception that is thrown if a task is started on a thread that is
+            already executing.
+        
+        
+        Installation
+        ------------
+        
+        *taskthread* may be installed by executing ``pip install taskthread``.
+        
+        
+        Links
+        -------------
+        
+        * `documentation <http://taskthread.readthedocs.org/en/latest/>`_ 
+        * `source <http://github.com/hpcs-som/taskthread/>`_
+        
+        
+        Changes
+        -------
+        
+        v1.4
+        ~~~~
+        
+        * **ADD** ``TimerTask`` class that runs a repetitive task on a taskthread.
+        
+        
+        v1.3
+        ~~~~
+        
+        * Change task loop to support python 2.6.
+        
+        
+        v1.2
+        ~~~~
+        
+        * Refactor the module so classes are defined in __init__.py.
+        
+        
+        v1.1
+        ~~~~
+        
+        * **ADD** ``TaskThread.join_task`` method that waits for the currently executing.
+          task to complete.
+        
+        
+        v1.0
+        ~~~~
+        
+        * First release
+        
+        
+        
+        
+Platform: UNKNOWN
diff --git a/taskthread.egg-info/SOURCES.txt b/taskthread.egg-info/SOURCES.txt
new file mode 100644 (file)
index 0000000..e676550
--- /dev/null
@@ -0,0 +1,18 @@
+.gitignore
+.travis.yml
+LICENSE
+Makefile
+README.rst
+setup.py
+test-requirements.txt
+docs/Makefile
+docs/conf.py
+docs/index.rst
+taskthread/__init__.py
+taskthread.egg-info/PKG-INFO
+taskthread.egg-info/SOURCES.txt
+taskthread.egg-info/dependency_links.txt
+taskthread.egg-info/top_level.txt
+taskthread/tests/__init__.py
+taskthread/tests/unit/__init__.py
+taskthread/tests/unit/test_taskthread.py
\ No newline at end of file
diff --git a/taskthread.egg-info/dependency_links.txt b/taskthread.egg-info/dependency_links.txt
new file mode 100644 (file)
index 0000000..8b13789
--- /dev/null
@@ -0,0 +1 @@
+
diff --git a/taskthread.egg-info/top_level.txt b/taskthread.egg-info/top_level.txt
new file mode 100644 (file)
index 0000000..23228ee
--- /dev/null
@@ -0,0 +1 @@
+taskthread
diff --git a/taskthread/__init__.py b/taskthread/__init__.py
new file mode 100644 (file)
index 0000000..a734a82
--- /dev/null
@@ -0,0 +1,296 @@
+# Copyright 2013 Hewlett-Packard Development Company, L.P.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+import logging
+import threading
+
+__version__ = '1.4'
+
+
+logger = logging.getLogger(__name__)
+
+
+class TaskInProcessException(BaseException):
+    pass
+
+
+class TaskThread(threading.Thread):
+    """
+    A thread object that repeats a task.
+
+    Usage example::
+
+        from taskthread import TaskThread
+
+        import time
+
+        def my_task(*args, **kwargs):
+            print args, kwargs
+
+        task_thread = TaskThread(my_task)
+        task_thread.start()
+        for i in xrange(10):
+            task_thread.run_task()
+            task_thread.join_task()
+        task_thread.join()
+
+    .. note:: If :py:meth:`~TaskThread.run_task` is
+        invoked while run_task is in progress,
+        :py:class:`~.TaskInProcessException` will
+        be raised.
+
+    :param task:
+        A ``function``. This param is the task to execute when
+         run_task is called.
+    :param event:
+        A ``threading.Event``. This event will be set when run_task
+         is called. The default value is a new event, but may be
+         specified for testing purposes.
+    """
+
+    daemon = True
+    '''
+    Threads marked as daemon will be terminated.
+    '''
+    def __init__(self, task, event=threading.Event(),
+                 *args, **kwargs):
+        super(TaskThread, self).__init__()
+        self.task = task
+        self.task_event = event
+        self.running = True
+        self.running_lock = threading.Lock()
+        self.in_task = False
+        self.task_complete = threading.Event()
+        self.args = args
+        self.kwargs = kwargs
+
+    def run(self):
+        """
+        Called by threading.Thread, this runs in the new thread.
+        """
+        while True:
+            self.task_event.wait()
+            if not self.running:
+                logger.debug("TaskThread exiting")
+                return
+            logger.debug("TaskThread starting task")
+            with self.running_lock:
+                self.task_event.clear()
+            self.task_complete.clear()
+            self.task(*self.args, **self.kwargs)
+            with self.running_lock:
+                self.in_task = False
+            self.task_complete.set()
+
+    def run_task(self, *args, **kwargs):
+        """
+        Run an instance of the task.
+
+        :param args:
+            The arguments to pass to the task.
+
+        :param kwargs:
+            The keyword arguments to pass to the task.
+        """
+        # Don't allow this call if the thread is currently
+        # in a task.
+        with self.running_lock:
+            if self.in_task:
+                raise TaskInProcessException()
+            self.in_task = True
+        logger.debug("Waking up the thread")
+        self.args = args
+        self.kwargs = kwargs
+        # Wake up the thread to do it's thing
+        self.task_event.set()
+
+    def join_task(self, time_out):
+        """
+        Wait for the currently running task to complete.
+
+        :param time_out:
+            An ``int``. The amount of time to wait for the
+            task to finish.
+        """
+        with self.running_lock:
+            if not self.in_task:
+                return
+
+        success = self.task_complete.wait(time_out)
+        if success:
+            self.task_complete.clear()
+        return success
+
+    def join(self, timeout=None):
+        """
+        Wait for the task to finish
+        """
+        self.running = False
+        self.task_event.set()
+        super(TaskThread, self).join(timeout=timeout)
+
+
+class TimerTask(object):
+    """
+    An object that executes a commit function at a given interval.
+    This class is driven by a TaskThread. A new TaskThread will be
+    created the first time :py:meth:`.~start` is called. All
+    subsequent calls to start will reuse the same thread.
+
+    Usage example::
+
+        from taskthread import TimerTask
+        import time
+
+        count = 0
+        def get_count():
+            return count
+        def execute():
+            print "Count: %d" % count
+
+        task = TimerTask(execute,
+                         timeout=10,
+                         count_fcn=get_count,
+                         threshold=1)
+
+        task.start()
+
+        for i in xrange(100000):
+            count += 1
+            time.sleep(1)
+        task.stop()
+        count = 0
+        task.start()
+        for i in xrange(100000):
+            count += 1
+            time.sleep(1)
+        task.shutdown()
+
+    :param execute_fcn:
+        A `function`. This function will be executed on each time interval.
+
+    :param delay:
+        An `int`. The delay in **seconds** invocations of
+        `execute_fcn`. Default: `10`.
+
+    :param count_fcn:
+        A `function`. This function returns a current count. If the count
+        has not changed more the `threshold` since the last invocation of
+        `execute_fcn`, `execute_fcn` will not be called again. If not
+        specified, `execute_fcn` will be called each time the timer fires.
+        **Optional**. If count_fcn is specified, ``threshold`` is required.
+
+    :param threshold:
+        An `int`. Specifies the minimum delta in `count_fcn` that must be
+        met for `execute_fcn` to be invoked. **Optional**. Must be
+        specified in conjunction with `count_fcn`.
+
+    """
+    def __init__(self, execute_fcn, delay=10, count_fcn=None, threshold=None):
+        self.running = True
+        self.execute_fcn = execute_fcn
+        self.last_count = 0
+        self.event = threading.Event()
+        self.delay = delay
+        self.thread = None
+        self.running_lock = threading.RLock()
+        if bool(threshold) != bool(count_fcn):
+            raise ValueError("Must specify threshold "
+                             "and count_fcn, or neither")
+
+        self.count_fcn = count_fcn
+        self.threshold = threshold
+
+    def start(self):
+        """
+        Start the task. This starts a :py:class:`.~TaskThread`, and starts
+        running run_threshold_timer on the thread.
+
+        """
+        if not self.thread:
+            logger.debug('Starting up the taskthread')
+            self.thread = TaskThread(self._run_threshold_timer)
+            self.thread.start()
+
+        if self.threshold:
+            self.last_count = 0
+
+        logger.debug('Running the task')
+        self.running = True
+        self.thread.run_task()
+
+    def stop(self):
+        """
+        Stop the task, leaving the :py:class:`.~TaskThread` running
+        so start can be called again.
+
+        """
+        logger.debug('Stopping the task')
+        wait = False
+        with self.running_lock:
+            if self.running:
+                wait = True
+                self.running = False
+        if wait:
+            self.event.set()
+            self.thread.join_task(2)
+
+    def shutdown(self):
+        """
+        Close down the task thread and stop the task if it is running.
+
+        """
+        logger.debug('Shutting down the task')
+        self.stop()
+        self.thread.join(2)
+
+    def _exec_if_threshold_met(self):
+        new_count = self.count_fcn()
+        logger.debug('new_count: %d' % new_count)
+        if new_count >= self.last_count + self.threshold:
+            self.execute_fcn()
+            self.last_count = new_count
+
+    def _exec(self):
+        if self.count_fcn:
+            self._exec_if_threshold_met()
+        else:
+            self.execute_fcn()
+
+    def _wait(self):
+        self.event.wait(timeout=self.delay)
+        self.event.clear()
+        logger.debug('Task woken up')
+
+    def _exit_loop(self):
+        """
+        If self.running is false, it means the task should shut down.
+        """
+        exit_loop = False
+        with self.running_lock:
+            if not self.running:
+                exit_loop = True
+                logger.debug('Task shutting down')
+        return exit_loop
+
+    def _run_threshold_timer(self):
+        """
+        Main loop of the timer task
+
+        """
+        logger.debug('In Task')
+        while True:
+            self._wait()
+            if self._exit_loop():
+                return
+            self._exec()
diff --git a/taskthread/tests/__init__.py b/taskthread/tests/__init__.py
new file mode 100644 (file)
index 0000000..92bd912
--- /dev/null
@@ -0,0 +1,13 @@
+# Copyright 2013 Hewlett-Packard Development Company, L.P.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
diff --git a/taskthread/tests/unit/__init__.py b/taskthread/tests/unit/__init__.py
new file mode 100644 (file)
index 0000000..92bd912
--- /dev/null
@@ -0,0 +1,13 @@
+# Copyright 2013 Hewlett-Packard Development Company, L.P.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
diff --git a/taskthread/tests/unit/test_taskthread.py b/taskthread/tests/unit/test_taskthread.py
new file mode 100644 (file)
index 0000000..8256592
--- /dev/null
@@ -0,0 +1,315 @@
+# -*- coding: utf-8 -*-
+# Copyright 2013 Hewlett-Packard Development Company, L.P.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.:w
+
+
+import threading
+import unittest2 as unittest
+
+from mock import Mock, patch
+
+from taskthread import TaskThread, TaskInProcessException, TimerTask
+
+forever_event = threading.Event()
+
+
+def forever_function(*args, **kwargs):
+    forever_event.wait()
+    forever_event.clear()
+
+
+class TaskThreadTestCase(unittest.TestCase):
+    """
+    Tests for :py:class:`.TaskThread`.
+    """
+
+    def test___init__(self):
+        """
+        Test the __init__ method. It doesn't really do much.
+        """
+        task_thread = TaskThread(forever_function)
+        self.assertEqual(forever_function, task_thread.task)
+
+    def test_run_not_running(self):
+        """
+        Verifies that thread will shut down when running is false
+        """
+        event = Mock()
+        event.wait = Mock(side_effect=[True])
+        event.clear = Mock(side_effect=Exception("Should never be called"))
+        task_thread = TaskThread(forever_function,
+                                 event=event)
+        task_thread.running = False
+        task_thread.run()
+        event.wait.assert_called_once_with()
+
+    def test_run_executes_task(self):
+        event = Mock()
+        event.wait = Mock(side_effect=[True, True])
+
+        def stop_iteration(*args, **kwargs):
+            args[0].running = False
+
+        task_thread = TaskThread(stop_iteration,
+                                 event=event)
+
+        task_thread.args = [task_thread]
+        task_thread.kwargs = {'a': 2}
+        task_thread.in_task = True
+        task_thread.run()
+        self.assertEqual(False, task_thread.in_task)
+
+    def test_run_task(self):
+        event = Mock()
+        task_thread = TaskThread(forever_function,
+                                 event=event)
+        args = [1]
+        kwargs = {'a': 1}
+
+        task_thread.run_task(*args, **kwargs)
+        self.assertEqual(tuple(args), task_thread.args)
+        self.assertEqual(kwargs, task_thread.kwargs)
+        event.set.assert_called_once_with()
+
+    def test_run_task_task_in_progress(self):
+        event = Mock()
+        task_thread = TaskThread(forever_function,
+                                 event=event)
+        task_thread.in_task = True
+        self.assertRaises(TaskInProcessException, task_thread.run_task)
+
+    def test_join_task(self):
+        task_thread = TaskThread(forever_function)
+        task_thread.in_task = True
+        task_thread.task_complete = Mock()
+        task_thread.task_complete.wait = Mock(side_effect=[True])
+        success = task_thread.join_task(1)
+        self.assertTrue(success)
+
+    def test_join_task_not_running(self):
+        task_thread = TaskThread(forever_function)
+        task_thread.task_complete = Mock()
+        task_thread.wait =\
+            Mock(side_effect=Exception("Should never be called"))
+        task_thread.join_task(1)
+
+    def test_join(self):
+        task_thread = TaskThread(forever_function)
+        task_thread.start()
+        task_thread.run_task()
+        # Set the event so the task completes
+        forever_event.set()
+        task_thread.join_task(1)
+        task_thread.join(1)
+
+    def test_execute_multiple_tasks(self):
+        task_thread = TaskThread(forever_function)
+        task_thread.start()
+        task_thread.run_task()
+        # Set the event so the task completes
+        forever_event.set()
+        task_thread.join_task(1)
+        forever_event.set()
+        task_thread.join_task(1)
+        task_thread.join(1)
+
+
+def my_func():
+    pass
+
+
+class TimerTaskTestCase(unittest.TestCase):
+
+    def test___int__(self):
+
+        task = TimerTask(my_func,
+                         delay=100)
+        self.assertEqual(my_func, task.execute_fcn)
+        self.assertEqual(100, task.delay)
+        self.assertIsNone(task.count_fcn)
+        self.assertIsNone(task.threshold)
+
+    def test___int__raises(self):
+        self.assertRaises(ValueError, TimerTask.__init__,
+                          TimerTask(None),
+                          my_func(),
+                          count_fcn=Mock())
+
+        self.assertRaises(ValueError, TimerTask.__init__,
+                          TimerTask(None),
+                          my_func(),
+                          threshold=Mock())
+
+    @patch('taskthread.TaskThread')
+    def test_start(self, TaskThreadMock):
+        task = TimerTask(my_func)
+        thread = TaskThreadMock.return_value
+
+        task.start()
+        self.assertTrue(task.running)
+        self.assertEqual(thread, task.thread)
+        thread.start.assert_called_once_with()
+        thread.run_task.assert_called_once_with()
+
+    @patch('taskthread.TaskThread')
+    def test_start_restarts(self, TaskThreadMock):
+        task = TimerTask(my_func, threshold=1, count_fcn=Mock())
+        thread = TaskThreadMock.return_value
+        task.last_count = 1
+        task.thread = thread
+
+        task.start()
+        self.assertEqual(0, task.last_count)
+        self.assertEqual(0, thread.start.called)
+        thread.run_task.assert_called_once_with()
+
+    @patch('taskthread.TaskThread')
+    def test_stop(self, TaskThreadMock):
+        running_lock = Mock()
+        running_lock.__enter__ = Mock()
+        running_lock.__exit__ = Mock()
+        task = TimerTask(my_func)
+        task.thread = TaskThreadMock.return_value
+        task.running = True
+        task.event = Mock()
+        task.running_lock = running_lock
+
+        task.stop()
+
+        self.assertEqual(False, task.running)
+        self.assertEqual(1, task.event.set.called)
+        running_lock.__enter__.assert_called_once_with()
+        running_lock.__exit__.assert_called_once_with(None, None, None)
+        task.thread.join_task.assert_called_once_with(2)
+
+    @patch('taskthread.TaskThread')
+    def test_stop_not_running(self, TaskThreadMock):
+        task = TimerTask(my_func)
+        task.thread = TaskThreadMock.return_value
+        task.running = False
+        task.event = Mock()
+
+        task.stop()
+
+        self.assertEqual(False, task.running)
+        self.assertEqual(0, task.event.set.called)
+        self.assertEqual(0, task.thread.join_task.called)
+
+    @patch('taskthread.TaskThread')
+    def test_shutdown(self, TaskThreadMock):
+        task = TimerTask(my_func)
+        task.thread = TaskThreadMock.return_value
+        task.running = False
+        task.shutdown()
+        task.thread.join.assert_called_once_with(2)
+
+    def test__exec_if_threshold_met(self):
+        self.called = False
+
+        def exec_fcn():
+            self.called = True
+
+        def count_fcn():
+            return 10
+
+        task = TimerTask(exec_fcn, count_fcn=count_fcn, threshold=1)
+        task.last_count = 9
+        task._exec_if_threshold_met()
+        self.assertTrue(self.called)
+        self.assertEqual(10, task.last_count)
+
+    def test__exec_if_threshold_met_not_met(self):
+
+        def exec_fcn():
+            raise Exception("This shouldn't happen!!")
+
+        def count_fcn():
+            return 10
+
+        task = TimerTask(exec_fcn, count_fcn=count_fcn, threshold=10)
+        task.last_count = 9
+        task._exec_if_threshold_met()
+        self.assertEqual(9, task.last_count)
+
+    def test__exec(self):
+        self.called = False
+
+        def exec_fcn():
+            self.called = True
+
+        task = TimerTask(exec_fcn)
+        task._exec()
+        self.assertTrue(self.called)
+
+    def test__exec_threshold(self):
+        self.called = False
+
+        def exec_fcn():
+            self.called = True
+
+        def count_fcn():
+            return 1
+
+        task = TimerTask(exec_fcn, count_fcn=count_fcn, threshold=1)
+        task._exec()
+        self.assertTrue(self.called)
+
+    @patch('threading.Event')
+    def test__wait(self, event_mock):
+        task = TimerTask(my_func)
+        event = event_mock.return_value
+
+        task._wait()
+        event.wait.assert_called_once_with(timeout=task.delay)
+        self.assertEqual(1, event.clear.called)
+
+    @patch('threading.RLock')
+    def test__exit_loop(self, mock_rlock):
+        task = TimerTask(my_func)
+        task.running = False
+        lock = mock_rlock.return_value
+        lock.__enter__ = Mock()
+        lock.__exit__ = Mock()
+        self.assertTrue(task._exit_loop())
+        self.assertEqual(1, lock.__enter__.called)
+        lock.__exit__.assert_called_once_with(None, None, None)
+
+    @patch('threading.RLock')
+    def test__exit_loop_running(self, mock_rlock):
+        lock = mock_rlock.return_value
+        lock.__enter__ = Mock()
+        lock.__exit__ = Mock()
+        task = TimerTask(my_func)
+        task.running = True
+        self.assertFalse(task._exit_loop())
+        self.assertEqual(1, lock.__enter__.called)
+        lock.__exit__.assert_called_once_with(None, None, None)
+
+    @patch('threading.RLock')
+    @patch('threading.Event')
+    def test__run_threshold_timer(self, event_mock, rlock_mock):
+        self.task = None
+        event = event_mock.return_value
+        lock = rlock_mock.return_value
+        lock.__enter__ = Mock()
+        lock.__exit__ = Mock()
+
+        def exec_fcn():
+            self.task.running = False
+
+        self.task = TimerTask(exec_fcn)
+        self.task._run_threshold_timer()
+
+        self.assertFalse(self.task.running)
+        self.assertEqual(2, event.wait.call_count)
diff --git a/test-requirements.txt b/test-requirements.txt
new file mode 100644 (file)
index 0000000..f63b9d7
--- /dev/null
@@ -0,0 +1,12 @@
+# Requirements
+argparse
+logutils
+
+# Documentation
+sphinx
+
+# Testing
+coverage
+mock
+pep8==1.2
+unittest2