diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..29c6762 --- /dev/null +++ b/.gitignore @@ -0,0 +1,162 @@ +# 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 + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm-project.org/#use-with-ide +.pdm.toml +.pdm-python +.pdm-build/ + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__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/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +.idea/ diff --git a/README.md b/README.md index 19ded18..58b7c0e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,27 @@ # magicoca A communication library for Python + +## 支持的通信方式 +- 进程通信 + +## 稀奇古怪的语法 + +```python +from magicoca.chan import Chan + +ch = Chan() + +# 发送消息 + +ch << "hello" + +# 接受消息 + +msg = str << ch + +# 通道关闭 + +ch.close() + +# 可跨进程通信 +``` \ No newline at end of file diff --git a/magicoca/__init__.py b/magicoca/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/magicoca/chan.py b/magicoca/chan.py new file mode 100644 index 0000000..f44bfec --- /dev/null +++ b/magicoca/chan.py @@ -0,0 +1,51 @@ +from multiprocessing import Pipe +from typing import TypeVar, Generic + +T = TypeVar("T") + + +class Chan(Generic[T]): + def __init__(self, buffer: int = 0): + self._buffer = buffer + self._send_conn, self._recv_conn = Pipe() + + def send(self, value: T): + self._send_conn.send(value) + + def recv(self) -> T: + return self._recv_conn.recv() + + def close(self): + self._send_conn.close() + self._recv_conn.close() + + def __iter__(self): + """ + + Returns: + """ + return self + + def __next__(self) -> T: + return self.recv() + + def __lshift__(self, other: T): + """ + chan << obj + Args: + other: + Returns: + + """ + self.send(other) + return self + + def __rlshift__(self, other) -> T: + """ + obj << chan + Args: + other: + Returns: + + """ + return self.recv() diff --git a/pdm.lock b/pdm.lock new file mode 100644 index 0000000..d7047a8 --- /dev/null +++ b/pdm.lock @@ -0,0 +1,99 @@ +# This file is @generated by PDM. +# It is not intended for manual editing. + +[metadata] +groups = ["default", "dev"] +strategy = ["inherit_metadata"] +lock_version = "4.5.0" +content_hash = "sha256:7448dc54658d779bbdd51b39ae72faf632280702d8719337a0fff377415332ba" + +[[metadata.targets]] +requires_python = ">=3.10" + +[[package]] +name = "colorama" +version = "0.4.6" +requires_python = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,>=2.7" +summary = "Cross-platform colored terminal text." +groups = ["dev"] +marker = "sys_platform == \"win32\"" +files = [ + {file = "colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6"}, + {file = "colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44"}, +] + +[[package]] +name = "exceptiongroup" +version = "1.2.2" +requires_python = ">=3.7" +summary = "Backport of PEP 654 (exception groups)" +groups = ["dev"] +marker = "python_version < \"3.11\"" +files = [ + {file = "exceptiongroup-1.2.2-py3-none-any.whl", hash = "sha256:3111b9d131c238bec2f8f516e123e14ba243563fb135d3fe885990585aa7795b"}, + {file = "exceptiongroup-1.2.2.tar.gz", hash = "sha256:47c2edf7c6738fafb49fd34290706d1a1a2f4d1c6df275526b62cbb4aa5393cc"}, +] + +[[package]] +name = "iniconfig" +version = "2.0.0" +requires_python = ">=3.7" +summary = "brain-dead simple config-ini parsing" +groups = ["dev"] +files = [ + {file = "iniconfig-2.0.0-py3-none-any.whl", hash = "sha256:b6a85871a79d2e3b22d2d1b94ac2824226a63c6b741c88f7ae975f18b6778374"}, + {file = "iniconfig-2.0.0.tar.gz", hash = "sha256:2d91e135bf72d31a410b17c16da610a82cb55f6b0477d1a902134b24a455b8b3"}, +] + +[[package]] +name = "packaging" +version = "24.1" +requires_python = ">=3.8" +summary = "Core utilities for Python packages" +groups = ["dev"] +files = [ + {file = "packaging-24.1-py3-none-any.whl", hash = "sha256:5b8f2217dbdbd2f7f384c41c628544e6d52f2d0f53c6d0c3ea61aa5d1d7ff124"}, + {file = "packaging-24.1.tar.gz", hash = "sha256:026ed72c8ed3fcce5bf8950572258698927fd1dbda10a5e981cdf0ac37f4f002"}, +] + +[[package]] +name = "pluggy" +version = "1.5.0" +requires_python = ">=3.8" +summary = "plugin and hook calling mechanisms for python" +groups = ["dev"] +files = [ + {file = "pluggy-1.5.0-py3-none-any.whl", hash = "sha256:44e1ad92c8ca002de6377e165f3e0f1be63266ab4d554740532335b9d75ea669"}, + {file = "pluggy-1.5.0.tar.gz", hash = "sha256:2cffa88e94fdc978c4c574f15f9e59b7f4201d439195c3715ca9e2486f1d0cf1"}, +] + +[[package]] +name = "pytest" +version = "8.3.3" +requires_python = ">=3.8" +summary = "pytest: simple powerful testing with Python" +groups = ["dev"] +dependencies = [ + "colorama; sys_platform == \"win32\"", + "exceptiongroup>=1.0.0rc8; python_version < \"3.11\"", + "iniconfig", + "packaging", + "pluggy<2,>=1.5", + "tomli>=1; python_version < \"3.11\"", +] +files = [ + {file = "pytest-8.3.3-py3-none-any.whl", hash = "sha256:a6853c7375b2663155079443d2e45de913a911a11d669df02a50814944db57b2"}, + {file = "pytest-8.3.3.tar.gz", hash = "sha256:70b98107bd648308a7952b06e6ca9a50bc660be218d53c257cc1fc94fda10181"}, +] + +[[package]] +name = "tomli" +version = "2.0.2" +requires_python = ">=3.8" +summary = "A lil' TOML parser" +groups = ["dev"] +marker = "python_version < \"3.11\"" +files = [ + {file = "tomli-2.0.2-py3-none-any.whl", hash = "sha256:2ebe24485c53d303f690b0ec092806a085f07af5a5aa1464f3931eec36caaa38"}, + {file = "tomli-2.0.2.tar.gz", hash = "sha256:d46d457a85337051c36524bc5349dd91b1877838e2979ac5ced3e710ed8a60ed"}, +] diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..71f47fc --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,28 @@ +[project] +name = "magicoca" +dynamic = ["version"] +description = "A communication library for Python" +authors = [ + { name = "snowykami", email = "snowykami@outlook.com" }, +] +dependencies = [] +requires-python = ">=3.10" +readme = "README.md" +license = { text = "MIT" } + +[build-system] +requires = ["pdm-backend"] +build-backend = "pdm.backend" + +[tool.pdm.version] +source = "scm" +tag_filter = "v*" +tag_regex = '^v(?:\D*)?(?P([1-9][0-9]*!)?(0|[1-9][0-9]*)(\.(0|[1-9][0-9]*))*((a|b|c|rc)(0|[1-9][0-9]*))?(\.post(0|[1-9][0-9]*))?(\.dev(0|[1-9][0-9]*))?$)$' + + +[tool.pdm.dev-dependencies] +dev = [ + "pytest>=8.3.3", +] +[tool.pdm] +distribution = true diff --git a/tests/test_chan.py b/tests/test_chan.py new file mode 100644 index 0000000..60e4a24 --- /dev/null +++ b/tests/test_chan.py @@ -0,0 +1,62 @@ +import time + +from magicoca.chan import Chan +from multiprocessing import Process + + +class TestChan: + def test_chan_shift(self): + ch = Chan[int]() + + def p1f(chan: Chan[int]): + for i in range(10): + time.sleep(1) + chan << i + chan << -1 + + def p2f(chan: Chan[int]): + recv_ans = [] + while True: + a = int << chan + print("Recv", a) + recv_ans.append(a) + if a == -1: + break + if recv_ans != list(range(10)) + [-1]: + raise ValueError("Chan Shift Test Failed") + + print("Test Chan Shift") + p1 = Process(target=p1f, args=(ch,)) + p2 = Process(target=p2f, args=(ch,)) + p1.start() + p2.start() + p1.join() + p2.join() + + def test_chan_sr(self): + ch = Chan[int]() + + def p1f(chan: Chan[int]): + for i in range(10): + time.sleep(1) + chan.send(i) + chan.send(-1) + + def p2f(chan: Chan[int]): + recv_ans = [] + while True: + a = chan.recv() + recv_ans.append(a) + print("Recv2", a) + if a == -1: + break + if recv_ans != list(range(10)) + [-1]: + raise ValueError("Chan SR Test Failed") + + print("Test Chan SR") + p1 = Process(target=p1f, args=(ch,)) + p2 = Process(target=p2f, args=(ch,)) + p1.start() + p2.start() + p1.join() + p2.join()