add Event

gottadiveintopython · gottadiveintopython · commit 6b13998e5a13 · 2024-06-21T19:35:08.000+09:00
diff --git a/.gitattribute b/.gitattribute
@@ -0,0 +1,20 @@
+*.apk binary
+
+*.ogg binary
+*.mp3 binary
+*.wav binary
+
+*.png binary
+*.jpg binary
+*.gif binary
+
+*.mp4 binary
+*.avi binary
+*.webm binary
+
+*.ttf binary
+*.ttc binary
+*.otf binary
+
+*.zip binary
+*.7z binary
diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml
@@ -0,0 +1,30 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: "unittest"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  noname:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.10', '3.11', '3.12']
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install pytest "asyncgui>=0.6,<0.7"
+        python -m pip install .
+    - name: Test with pytest
+      run: make test
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,9 @@
+__pycache__/
+bin/
+*.pyc
+*.pyo
+/.venv/
+/.pytest_cache/
+/dist
+/docs/
+/src/asyncgui.py
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -0,0 +1,22 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "pytest",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "pytest",
+            "args": ["${file}"]
+        },
+        {
+            "name": "Python: Current File",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${file}",
+            "console": "integratedTerminal"
+        }
+    ]
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,3 @@
+{
+    "python.pythonPath": ".venv/bin/python"
+}
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,7 @@
+Copyright 2024 gottadiveintopython
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/Makefile b/Makefile
@@ -0,0 +1,8 @@
+test:
+	python -m pytest ./tests
+
+html:
+	sphinx-build -b html ./sphinx ./docs
+
+livehtml:
+	sphinx-autobuild -b html ./sphinx ./docs
diff --git a/README.md b/README.md
@@ -0,0 +1,18 @@
+# SyncTools
+
+Inter-task sychronization and communication.
+
+## Installation
+
+Pin the minor version.
+
+```
+poetry add asyncgui-ext-synctools@~0.1
+pip install "asyncgui-ext-synctools>=0.1,<0.2"
+```
+
+## Tested on
+
+- CPython 3.10
+- CPython 3.11
+- CPython 3.12
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,44 @@
+[tool.poetry]
+name = "asyncgui-ext-synctools"
+version = "0.1.0"
+description = "Inter-task sychronization and communication."
+authors = ["Nattōsai Mitō <flow4re2c@gmail.com>"]
+license = "MIT"
+readme = 'README.md'
+repository = 'https://github.com/asyncgui/asyncgui-ext-synctools'
+homepage = 'https://github.com/asyncgui/asyncgui-ext-synctools'
+keywords = ['async', ]
+classifiers=[
+    'Development Status :: 5 - Production/Stable',
+    'License :: OSI Approved :: MIT License',
+    'Intended Audience :: Developers',
+    'Programming Language :: Python',
+    'Programming Language :: Python :: 3.10',
+    'Programming Language :: Python :: 3.11',
+    'Programming Language :: Python :: 3.12',
+    'Topic :: Software Development :: Libraries',
+    'Operating System :: OS Independent',
+]
+packages = [
+    { include = "asyncgui_ext", from = "src" },
+]
+
+[tool.poetry.dependencies]
+python = "^3.10"
+asyncgui = "^0.6"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^8.0"
+
+[tool.poetry.group.doc.dependencies]
+sphinx = "^7.2.6"
+sphinx-autobuild = "^2021.3.14"
+furo = "^2023.9.10"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.pytest.ini_options]
+xfail_strict = true
+addopts = "--maxfail=4 --strict-markers"
diff --git a/sphinx/_static/dummy b/sphinx/_static/dummy
diff --git a/sphinx/conf.py b/sphinx/conf.py
@@ -0,0 +1,68 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+import importlib.metadata
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+project = 'asyncgui-ext-synctools'
+copyright = '2024, Mitō Nattōsai'
+author = 'Mitō Nattōsai'
+release = importlib.metadata.version(project)
+
+rst_epilog = """
+.. |ja| replace:: 🇯🇵
+"""
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.intersphinx',
+    # 'sphinx.ext.viewcode',
+    'sphinx.ext.githubpages',
+    # 'sphinx_tabs.tabs',
+
+]
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+language = 'en'
+add_module_names = False
+gettext_auto_build = False
+gettext_location = False
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+html_theme = "furo"
+html_static_path = ['_static']
+
+# -- Options for todo extension ----------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/extensions/todo.html#configuration
+todo_include_todos = True
+
+
+# -- Options for intersphinx extension ---------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#configuration
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3', None),
+    'asyncgui': ('https://asyncgui.github.io/asyncgui/', None),
+}
+
+
+# -- Options for autodoc extension ---------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#configuration
+# autodoc_mock_imports = ['pygame', ]
+autodoc_default_options = {
+#    'members': True,
+#    'undoc-members': True,
+   'no-show-inheritance': True,
+}
+
+
+# -- Options for tabs extension ---------------------------------------
+# https://sphinx-tabs.readthedocs.io/en/latest/
+sphinx_tabs_disable_tab_closing = True
+
diff --git a/sphinx/index.rst b/sphinx/index.rst
@@ -0,0 +1,10 @@
+=========
+SyncTools
+=========
+
+Inter-task sychronization and communication.
+
+.. toctree::
+   :hidden:
+
+   reference
diff --git a/sphinx/reference.rst b/sphinx/reference.rst
@@ -0,0 +1,9 @@
+=============
+API Reference
+=============
+
+
+.. autoclass:: asyncgui_ext.synctools.event.Event
+    :members:
+    :undoc-members:
+    :exclude-members:
diff --git a/src/asyncgui_ext/synctools/__init__.py b/src/asyncgui_ext/synctools/__init__.py
diff --git a/src/asyncgui_ext/synctools/all.py b/src/asyncgui_ext/synctools/all.py
@@ -0,0 +1,4 @@
+__all__ = (
+    'Event',
+)
+from .event import Event
diff --git a/src/asyncgui_ext/synctools/event.py b/src/asyncgui_ext/synctools/event.py
@@ -0,0 +1,64 @@
+__all__ = (
+    'Event',
+)
+import types
+import typing as T
+
+
+class Event:
+    '''
+    Similar to :class:`asyncio.Event`.
+    The differences are:
+
+    * :meth:`set` accepts any number of arguments but doesn't use them at all so it can be used as a callback function
+      in any library.
+    * :attr:`is_set` is a property not a function.
+
+    .. code-block::
+
+        e = Event()
+        any_library.register_callback(e.set)
+    '''
+
+    __slots__ = ('_flag', '_waiting_tasks', )
+
+    def __init__(self):
+        self._flag = False
+        self._waiting_tasks = []
+
+    @property
+    def is_set(self) -> bool:
+        return self._flag
+
+    def set(self, *args, **kwargs):
+        '''
+        Set the event.
+        Unlike asyncio's, all tasks waiting for this event to be set will be resumed *immediately*.
+        '''
+        if self._flag:
+            return
+        self._flag = True
+        tasks = self._waiting_tasks
+        self._waiting_tasks = []
+        for t in tasks:
+            if t is not None:
+                t._step()
+
+    def clear(self):
+        '''Unset the event.'''
+        self._flag = False
+
+    @types.coroutine
+    def wait(self) -> T.Awaitable:
+        '''
+        Wait for the event to be set.
+        Return *immediately* if it's already set.
+        '''
+        if self._flag:
+            return
+        try:
+            tasks = self._waiting_tasks
+            idx = len(tasks)
+            yield tasks.append
+        finally:
+            tasks[idx] = None
diff --git a/tests/test_event.py b/tests/test_event.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "python.pythonPath": ".venv/bin/python"`
	`3`	`+}`