First commit

Author: writeson

.gitignore

@@ -0,0 +1,193 @@
+# File created using '.gitignore Generator' for Visual Studio Code: https://bit.ly/vscode-gig
+
+# Created by https://www.toptal.com/developers/gitignore/api/visualstudiocode,macos,python
+# Edit at https://www.toptal.com/developers/gitignore?templates=visualstudiocode,macos,python
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+*.code-workspace
+
+# Local History for Visual Studio Code
+.history/
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide
+
+# End of https://www.toptal.com/developers/gitignore/api/visualstudiocode,macos,python
+
+# Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option)
+

.python-version

@@ -0,0 +1 @@
+3.9.5

example_1.py

@@ -0,0 +1,71 @@
+"""This program demonstrates a synchronous approach 
+to accomplishing tasks. The worker can't delegate
+any tasks and completes them all one after another.
+"""
+from time import sleep
+from queue import Queue
+from codetiming import Timer
+
+
+def task(delay: float=0):
+    """This is a little task that takes some time to complete
+
+    Args:
+        delay (int): The delay the task takes
+    """
+    with Timer(text="Task elapsed time: {:.2f} seconds"):
+        sleep(delay)
+        return delay
+
+
+def worker(name: str, task_queue: Queue):
+    """This is our worker that pulls tasks from
+    the queue and performs them
+
+    Args:
+        name (str): The string name of the task
+        work_queue (Queue): The queue the tasks are pulled from
+    """
+    # pull tasks from the queue until the queue is empty
+    print(f"Worker {name} starting to run tasks")
+    while not task_queue.empty():
+        fn, kwargs = task_queue.get()
+        result = fn(**kwargs)
+        print(f"Worker {name} completed task: result = {result}\n")
+
+    print(f"Worker {name} finished as there are no more tasks\n")
+
+
+def main():
+    """
+    This is the main entry point for the program
+    """
+    # Create the queue for tasks
+    task_queue = Queue()
+
+    # Put some tasks in the queue
+    list(map(task_queue.put, [
+        (task, {"delay": 4.0}), 
+        (task, {"delay": 3.0}), 
+        (task, {"delay": 2.0}),
+        (task, {"delay": 1.0}),
+    ]))
+
+    # Create a single worker
+    workers = [
+        (worker, "One", task_queue)
+    ]
+
+    # Run the workers
+    with Timer(text="Total elapsed time: {:.2f}"):
+        while len(workers):
+            for worker_ in workers:
+                worker_fn, name, queue = worker_
+                worker_fn(name, queue)
+                workers.remove(worker_)
+
+
+if __name__ == "__main__":
+    print()
+    main()
+    print()

example_2.py

@@ -0,0 +1,75 @@
+"""This program demonstrates a synchronous approach 
+to accomplishing tasks. The worker can't delegate
+any tasks and completes them all one after another.
+In this version there is a second worker created,
+but the two workers aren't cooperating with each
+other.
+"""
+from time import sleep
+from queue import Queue
+from codetiming import Timer
+
+
+def task(delay: float=0):
+    """This is a little task that takes some time to complete
+
+    Args:
+        delay (int): The delay the task takes
+    """
+    with Timer(text="Task elapsed time: {:.2f} seconds"):
+        sleep(delay)
+        return delay
+
+
+def worker(name: str, task_queue: Queue):
+    """This is our worker that pulls tasks from
+    the queue and performs them
+
+    Args:
+        name (str): The string name of the task
+        work_queue (Queue): The queue the tasks are pulled from
+    """
+    # pull tasks from the queue until the queue is empty
+    print(f"Worker {name} starting to run tasks")
+    while not task_queue.empty():
+        fn, kwargs = task_queue.get()
+        result = fn(**kwargs)
+        print(f"Worker {name} completed task: result = {result}\n")
+
+    print(f"Worker {name} finished as there are no more tasks\n")
+
+
+def main():
+    """
+    This is the main entry point for the program
+    """
+    # Create the queue for tasks
+    task_queue = Queue()
+
+    # Put some tasks in the queue
+    list(map(task_queue.put, [
+        (task, {"delay": 4.0}), 
+        (task, {"delay": 3.0}), 
+        (task, {"delay": 2.0}),
+        (task, {"delay": 1.0}),
+    ]))
+
+    # Create two workers
+    workers = [
+        (worker, "One", task_queue),
+        (worker, "Two", task_queue)
+    ]
+
+    # Run the workers
+    with Timer(text="Total elapsed time: {:.2f}"):
+        while len(workers):
+            for worker_ in workers:
+                worker_fn, name, queue = worker_
+                worker_fn(name, queue)
+                workers.remove(worker_)
+
+
+if __name__ == "__main__":
+    print()
+    main()
+    print()