From 28c92e3fa918cb3726da6a2c000a79c789aa7720 Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Mon, 17 Sep 2018 14:03:01 +0800 Subject: [PATCH 01/40] Add .gitignore --- .gitignore | 130 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 130 insertions(+) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c3aee25 --- /dev/null +++ b/.gitignore @@ -0,0 +1,130 @@ +# 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/ +*.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 +.hypothesis/ +.pytest_cache/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +.python-version + +# celery beat schedule file +celerybeat-schedule + +# 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 + +# User-specific stuff +.idea/**/workspace.xml +.idea/**/tasks.xml +.idea/**/usage.statistics.xml +.idea/**/dictionaries +.idea/**/shelf + +# Generated files +.idea/**/contentModel.xml + +# Sensitive or high-churn files +.idea/**/dataSources/ +.idea/**/dataSources.ids +.idea/**/dataSources.local.xml +.idea/**/sqlDataSources.xml +.idea/**/dynamic.xml +.idea/**/uiDesigner.xml +.idea/**/dbnavigator.xml From 56267aef66af2f8be9de2836734cbd74151b4ba1 Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Mon, 24 Sep 2018 14:05:06 +0800 Subject: [PATCH 02/40] Init --- .idea/aioserial.iml | 14 +++ .idea/inspectionProfiles/Project_Default.xml | 15 +++ .idea/misc.xml | 7 ++ .idea/modules.xml | 8 ++ .idea/vcs.xml | 6 + LICENSE.txt | 19 +++ Pipfile | 19 +++ Pipfile.lock | 41 +++++++ README.rst | 76 ++++++++++++ setup.py | 109 ++++++++++++++++++ src/aioserial/__init__.py | 8 ++ src/aioserial/aioserial.py | 115 +++++++++++++++++++ 12 files changed, 437 insertions(+) create mode 100644 .idea/aioserial.iml create mode 100644 .idea/inspectionProfiles/Project_Default.xml create mode 100644 .idea/misc.xml create mode 100644 .idea/modules.xml create mode 100644 .idea/vcs.xml create mode 100644 LICENSE.txt create mode 100644 Pipfile create mode 100644 Pipfile.lock create mode 100644 README.rst create mode 100644 setup.py create mode 100644 src/aioserial/__init__.py create mode 100644 src/aioserial/aioserial.py diff --git a/.idea/aioserial.iml b/.idea/aioserial.iml new file mode 100644 index 0000000..04f0e28 --- /dev/null +++ b/.idea/aioserial.iml @@ -0,0 +1,14 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml new file mode 100644 index 0000000..94bf861 --- /dev/null +++ b/.idea/inspectionProfiles/Project_Default.xml @@ -0,0 +1,15 @@ + + + + \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml new file mode 100644 index 0000000..ee04eea --- /dev/null +++ b/.idea/misc.xml @@ -0,0 +1,7 @@ + + + + + + \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml new file mode 100644 index 0000000..321150d --- /dev/null +++ b/.idea/modules.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..94a25f7 --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..d76cbab --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,19 @@ +Copyright (c) 2018 Henry Chang + +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/Pipfile b/Pipfile new file mode 100644 index 0000000..c84adc4 --- /dev/null +++ b/Pipfile @@ -0,0 +1,19 @@ +[[source]] + +url = "https://pypi.python.org/simple" +verify_ssl = true +name = "pypi" + + +[packages] + +pyserial = "*" + + +[dev-packages] + + + +[requires] + +python_version = "3.7" diff --git a/Pipfile.lock b/Pipfile.lock new file mode 100644 index 0000000..39afb52 --- /dev/null +++ b/Pipfile.lock @@ -0,0 +1,41 @@ +{ + "_meta": { + "hash": { + "sha256": "d75db13dc74fa9deff0950041bbb00232fadb5e528e5522eebbd12463e918346" + }, + "host-environment-markers": { + "implementation_name": "cpython", + "implementation_version": "3.7.0", + "os_name": "posix", + "platform_machine": "x86_64", + "platform_python_implementation": "CPython", + "platform_release": "17.7.0", + "platform_system": "Darwin", + "platform_version": "Darwin Kernel Version 17.7.0: Thu Jun 21 22:53:14 PDT 2018; root:xnu-4570.71.2~1/RELEASE_X86_64", + "python_full_version": "3.7.0", + "python_version": "3.7", + "sys_platform": "darwin" + }, + "pipfile-spec": 6, + "requires": { + "python_version": "3.7" + }, + "sources": [ + { + "name": "pypi", + "url": "https://pypi.python.org/simple", + "verify_ssl": true + } + ] + }, + "default": { + "pyserial": { + "hashes": [ + "sha256:e0770fadba80c31013896c7e6ef703f72e7834965954a78e71a3049488d4d7d8", + "sha256:6e2d401fdee0eab996cf734e67773a0143b932772ca8b42451440cfed942c627" + ], + "version": "==3.4" + } + }, + "develop": {} +} diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..6bbfb6d --- /dev/null +++ b/README.rst @@ -0,0 +1,76 @@ +========= +aioserial +========= + +Python asynchronous serial module for combining ``asyncio`` and ``pyserial``. + +Quick start +=========== + +Constructor +----------- + +.. code:: py + + import aioserial + + aioserial_instance: aioserial.AioSerial = aioserial.AioSerial( + SAME_WITH_PYSERIAL..., + loop=None) + +Asynchronously Read +------------------- + +read_async +`````````` + +.. code:: py + + bytes_read: bytes = \ + await aioserial_instance.read_async(size: Optional[int] = None) + +readline_async +`````````````` + +.. code:: py + + a_line_of_at_most_certain_size_of_bytes_read: bytes = \ + await aioserial_instance.readline_async(size: int = -1) + +readlines_async +``````````````` + +.. code:: py + + lines_of_at_most_certain_size_of_bytes_read: bytes = \ + await aioserial_instance.readlines_async(hint: int = -1) + +read_until_async +```````````````` + +.. code:: py + + import serial + + at_most_certain_size_of_bytes_read: bytes = \ + await aioserial_instance.read_until_async( + expected: bytes = serial.LF, size: Optional[int] = None) + +Asynchronously Write +-------------------- + +write_async +``````````` + +.. code:: py + + number_of_bytes_like_data_written: int = \ + await aioserial_instance.write_async(bytes_like_data) + +writelines_async +```````````````` + +.. code:: py + + number_of_bytes_like_data_in_the_given_list_written: int = \ + await aioserial_instance.writelines_async(list_of_bytes_like_data) diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..1ad2ca7 --- /dev/null +++ b/setup.py @@ -0,0 +1,109 @@ +""" +A setuptools based setup module. +See: +https://packaging.python.org/en/latest/distributing.html +https://github.com/pypa/sampleproject +""" + +import io +import os +import setuptools + + +here: str = os.path.abspath(os.path.dirname(__file__)) + +# Get the long description from the README file +f: io.TextIOWrapper +with open(os.path.join(here, 'README.rst'), encoding='utf-8') as f: + long_description = f.read() + +setuptools.setup( + name='aioserial', + + # Versions should comply with PEP440. For a discussion on single-sourcing + # the version across setup.py and the project code, see + # https://packaging.python.org/en/latest/single_source_version.html + version='1.0.0', + + description='An asynchronous serial port library of Python', + long_description=long_description, + + # The project's main homepage. + url='https://github.com/changyuheng/aioserial', + + # Author details + author='Henry Chang', + author_email='mr.changyuheng@gmail.com', + + # # Choose your license + # license='MIT', + + # See https://pypi.python.org/pypi?%3Aaction=list_classifiers + classifiers=[ + # How mature is this project? Common values are + # 3 - Alpha + # 4 - Beta + # 5 - Production/Stable + 'Development Status :: 5 - Production/Stable', + + # Indicate who your project is intended for + 'Intended Audience :: Developers', + 'Topic :: Software Development :: Libraries :: Python Modules', + + # Pick your license as you wish (should match "license" above) + 'License :: OSI Approved :: MIT License', + + # Specify the Python versions you support here. In particular, ensure + # that you indicate whether you support Python 2, Python 3 or both. + 'Programming Language :: Python :: 3.7', + ], + + # # What does your project relate to? + # keywords='sample setuptools development', + + # You can just specify the packages manually here if your project is + # simple. Or you can use find_packages(). + packages=setuptools.find_packages('src', exclude=['contrib', 'docs', 'tests']), + package_dir={'': 'src'}, + + # Alternatively, if you want to distribute just a my_module.py, uncomment + # this: + # py_modules=["my_module"], + + # List run-time dependencies here. These will be installed by pip when + # your project is installed. For an analysis of "install_requires" vs pip's + # requirements files see: + # https://packaging.python.org/en/latest/requirements.html + install_requires=[ + 'pyserial', + ], + + python_requires='>=3.7', + + # List additional groups of dependencies here (e.g. development + # dependencies). You can install these using the following syntax, + # for example: + # $ pip install -e .[dev,test] + extras_require={ + 'dev': [], + 'test': [], + }, + + # If there are data files included in your packages that need to be + # installed, specify them here. If using Python 2.6 or less, then these + # have to be included in MANIFEST.in as well. + package_data={ + }, + + # Although 'package_data' is the preferred approach, in some case you may + # need to place data files outside of your packages. See: + # http://docs.python.org/3.4/distutils/setupscript.html#installing-additional-files # noqa + # In this case, 'data_file' will be installed into '/my_data' + # data_files=[('my_data', ['data/data_file'])], + + # To provide executable scripts, use entry points in preference to the + # "scripts" keyword. Entry points provide cross-platform support and allow + # pip to create the appropriate form of executable for the target platform. + entry_points={ + }, +) diff --git a/src/aioserial/__init__.py b/src/aioserial/__init__.py new file mode 100644 index 0000000..c73fd00 --- /dev/null +++ b/src/aioserial/__init__.py @@ -0,0 +1,8 @@ +from typing import List + +from .aioserial import AioSerial + + +__all__: List[str] = [ + 'AioSerial', +] \ No newline at end of file diff --git a/src/aioserial/aioserial.py b/src/aioserial/aioserial.py new file mode 100644 index 0000000..9d35b40 --- /dev/null +++ b/src/aioserial/aioserial.py @@ -0,0 +1,115 @@ +import asyncio +from typing import List, Optional, Union + +import serial + + +class AioSerial(serial.Serial): + + def __init__( + self, + port: Optional[str] = None, + baudrate: int = 9600, + bytesize: int = serial.EIGHTBITS, + parity: str = serial.PARITY_NONE, + stopbits: Union[float, int] = serial.STOPBITS_ONE, + timeout: Optional[float] = None, + xonxoff: bool = False, + rtscts: bool = False, + write_timeout: Optional[float] = None, + dsrdtr: bool = False, + inter_byte_timeout: Optional[float] = None, + exclusive: Optional[bool] = None, + loop: Optional[asyncio.AbstractEventLoop] = None, + **kwargs): + super().__init__( + port=port, + baudrate=baudrate, + bytesize=bytesize, + parity=parity, + stopbits=stopbits, + timeout=timeout, + xonxoff=xonxoff, + rtscts=rtscts, + write_timeout=write_timeout, + dsrdtr=dsrdtr, + inter_byte_timeout=inter_byte_timeout, + exclusive=exclusive, + **kwargs) + self._loop: Optional[asyncio.AbstractEventLoop] = loop + + @property + def loop(self) -> Optional[asyncio.AbstractEventLoop]: + self.write(b'') + return self._loop if self._loop else asyncio.get_running_loop() + + @loop.setter + def loop(self, value: Optional[asyncio.AbstractEventLoop]): + self.loop = value + + async def read_async(self, size: Optional[int] = None) -> bytes: + res: bytes = b'' + + if size is None: + size = self.in_waiting + + while size > 0: + min_size: int = min(size, self.in_waiting) + res += self.read(min_size) + size -= min_size + if size > 0: + await asyncio.sleep(0.01, loop=self.loop) + + return res + + async def readline_async(self, size: int = -1) -> bytes: + return await self.read_until_async(expected=serial.LF, size=size) + + async def readlines_async(self, hint: int = -1) -> List[bytes]: + res: List[bytes] = [] + + if hint < 0: + hint = self.in_waiting + + while hint > 0: + res.append(await self.readline_async()) + hint -= len(res[-1]) + + return res + + async def read_until_async( + self, + expected: bytes = serial.LF, + size: Optional[int] = None) -> bytes: + res: bytes = b'' + + if size is None: + size = -1 + + while size != 0: + size -= 1 + res += await self.read_async(1) + if res.endswith(expected): + size = 0 + + return res + + async def write_async( + self, data: Union[bytearray, bytes, memoryview]) -> int: + res: int = 0 + data_length: int = len(data) + step: int = int(self.baudrate * 0.01) + + i: int + for i in range(0, data_length, step): + res += self.write(data[i:i+step]) + + if i + step < data_length: + await asyncio.sleep(0.01, loop=self.loop) + + return res + + async def writelines_async( + self, lines: List[Union[bytearray, bytes, memoryview]]) -> int: + line: Union[bytearray, bytes, memoryview] + return sum(await self.write_async(line) for line in lines) From ccf9885fa9dc735b8536346794ef3aa7bbdc9aec Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Tue, 25 Sep 2018 02:39:28 +0800 Subject: [PATCH 03/40] Fix performance issue --- README.rst | 38 ++++++++++++------- setup.py | 2 + src/aioserial/aioserial.py | 76 ++++++++++++-------------------------- 3 files changed, 50 insertions(+), 66 deletions(-) diff --git a/README.rst b/README.rst index 6bbfb6d..f428262 100644 --- a/README.rst +++ b/README.rst @@ -27,7 +27,28 @@ read_async .. code:: py bytes_read: bytes = \ - await aioserial_instance.read_async(size: Optional[int] = None) + await aioserial_instance.read_async(size: int = 1) + +read_until_async +```````````````` + +.. code:: py + + import serial + + at_most_certain_size_of_bytes_read: bytes = \ + await aioserial_instance.read_until_async( + expected: bytes = serial.LF, size: Optional[int] = None) + +readinto_async +`````````````` + +.. code:: py + + import array + + number_of_byte_read: int = \ + await aioserial_instance.readinto_async(b: Union[array.array, bytearray]) readline_async `````````````` @@ -45,17 +66,6 @@ readlines_async lines_of_at_most_certain_size_of_bytes_read: bytes = \ await aioserial_instance.readlines_async(hint: int = -1) -read_until_async -```````````````` - -.. code:: py - - import serial - - at_most_certain_size_of_bytes_read: bytes = \ - await aioserial_instance.read_until_async( - expected: bytes = serial.LF, size: Optional[int] = None) - Asynchronously Write -------------------- @@ -64,7 +74,7 @@ write_async .. code:: py - number_of_bytes_like_data_written: int = \ + number_of_byte_like_data_written: int = \ await aioserial_instance.write_async(bytes_like_data) writelines_async @@ -72,5 +82,5 @@ writelines_async .. code:: py - number_of_bytes_like_data_in_the_given_list_written: int = \ + number_of_byte_like_data_in_the_given_list_written: int = \ await aioserial_instance.writelines_async(list_of_bytes_like_data) diff --git a/setup.py b/setup.py index 1ad2ca7..b4879f4 100644 --- a/setup.py +++ b/setup.py @@ -48,7 +48,9 @@ # Indicate who your project is intended for 'Intended Audience :: Developers', + 'Topic :: Communications', 'Topic :: Software Development :: Libraries :: Python Modules', + 'Topic :: Terminals :: Serial', # Pick your license as you wish (should match "license" above) 'License :: OSI Approved :: MIT License', diff --git a/src/aioserial/aioserial.py b/src/aioserial/aioserial.py index 9d35b40..63e3efb 100644 --- a/src/aioserial/aioserial.py +++ b/src/aioserial/aioserial.py @@ -1,4 +1,6 @@ +import array import asyncio +import concurrent.futures from typing import List, Optional, Union import serial @@ -37,6 +39,10 @@ def __init__( exclusive=exclusive, **kwargs) self._loop: Optional[asyncio.AbstractEventLoop] = loop + self._read_executor = \ + concurrent.futures.ThreadPoolExecutor(max_workers=1) + self._write_executor = \ + concurrent.futures.ThreadPoolExecutor(max_workers=1) @property def loop(self) -> Optional[asyncio.AbstractEventLoop]: @@ -47,69 +53,35 @@ def loop(self) -> Optional[asyncio.AbstractEventLoop]: def loop(self, value: Optional[asyncio.AbstractEventLoop]): self.loop = value - async def read_async(self, size: Optional[int] = None) -> bytes: - res: bytes = b'' - - if size is None: - size = self.in_waiting - - while size > 0: - min_size: int = min(size, self.in_waiting) - res += self.read(min_size) - size -= min_size - if size > 0: - await asyncio.sleep(0.01, loop=self.loop) - - return res - - async def readline_async(self, size: int = -1) -> bytes: - return await self.read_until_async(expected=serial.LF, size=size) - - async def readlines_async(self, hint: int = -1) -> List[bytes]: - res: List[bytes] = [] - - if hint < 0: - hint = self.in_waiting - - while hint > 0: - res.append(await self.readline_async()) - hint -= len(res[-1]) - - return res + async def read_async(self, size: int = 1) -> bytes: + return await self.loop.run_in_executor( + self._read_executor, self.read, size) async def read_until_async( self, expected: bytes = serial.LF, size: Optional[int] = None) -> bytes: - res: bytes = b'' + return await self.loop.run_in_executor( + self._read_executor, self.read_until, expected, size) - if size is None: - size = -1 + async def readinto_async(self, b: Union[array.array, bytearray]): + return await self.loop.run_in_executor( + self._read_executor, self.readinto, b) - while size != 0: - size -= 1 - res += await self.read_async(1) - if res.endswith(expected): - size = 0 + async def readline_async(self, size: int = -1) -> bytes: + return await self.loop.run_in_executor( + self._read_executor, self.readline, size) - return res + async def readlines_async(self, hint: int = -1) -> List[bytes]: + return await self.loop.run_in_executor( + self._read_executor, self.readlines, hint) async def write_async( self, data: Union[bytearray, bytes, memoryview]) -> int: - res: int = 0 - data_length: int = len(data) - step: int = int(self.baudrate * 0.01) - - i: int - for i in range(0, data_length, step): - res += self.write(data[i:i+step]) - - if i + step < data_length: - await asyncio.sleep(0.01, loop=self.loop) - - return res + return await self.loop.run_in_executor( + self._write_executor, self.write, data) async def writelines_async( self, lines: List[Union[bytearray, bytes, memoryview]]) -> int: - line: Union[bytearray, bytes, memoryview] - return sum(await self.write_async(line) for line in lines) + return await self.loop.run_in_executor( + self._write_executor, self.writelines, lines) From 53ac7b45ec224fe433fe33edafb334c2445e212a Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Tue, 25 Sep 2018 02:40:09 +0800 Subject: [PATCH 04/40] Bump to version 1.0.1 --- Pipfile | 7 ------- README.rst | 7 ++++++- setup.py | 2 +- 3 files changed, 7 insertions(+), 9 deletions(-) diff --git a/Pipfile b/Pipfile index c84adc4..58e08a4 100644 --- a/Pipfile +++ b/Pipfile @@ -1,19 +1,12 @@ [[source]] - url = "https://pypi.python.org/simple" verify_ssl = true name = "pypi" - [packages] - pyserial = "*" - [dev-packages] - - [requires] - python_version = "3.7" diff --git a/README.rst b/README.rst index f428262..9f46a84 100644 --- a/README.rst +++ b/README.rst @@ -16,7 +16,7 @@ Constructor aioserial_instance: aioserial.AioSerial = aioserial.AioSerial( SAME_WITH_PYSERIAL..., - loop=None) + loop: Optional[asyncio.AbstractEventLoop] = None) Asynchronously Read ------------------- @@ -84,3 +84,8 @@ writelines_async number_of_byte_like_data_in_the_given_list_written: int = \ await aioserial_instance.writelines_async(list_of_bytes_like_data) + +Other APIs +---------- + +All the other APIs in `serial.Serial` are supported as original. diff --git a/setup.py b/setup.py index b4879f4..ca86e6c 100644 --- a/setup.py +++ b/setup.py @@ -23,7 +23,7 @@ # Versions should comply with PEP440. For a discussion on single-sourcing # the version across setup.py and the project code, see # https://packaging.python.org/en/latest/single_source_version.html - version='1.0.0', + version='1.0.1', description='An asynchronous serial port library of Python', long_description=long_description, From 70420e1a33e9ff3afc47b2d3a277337ea7a49d03 Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Sat, 29 Sep 2018 00:18:08 +0900 Subject: [PATCH 05/40] Update README --- README.rst | 47 ++++++++++++++++++++++++++--------------------- 1 file changed, 26 insertions(+), 21 deletions(-) diff --git a/README.rst b/README.rst index 9f46a84..4288fe1 100644 --- a/README.rst +++ b/README.rst @@ -7,22 +7,34 @@ Python asynchronous serial module for combining ``asyncio`` and ``pyserial``. Quick start =========== -Constructor ------------ +AioSerial +--------- .. code:: py import aioserial + import serial + + isinstance(aioserial.AioSerial(), serial.Serial) + True + + issubclass(aioserial.AioSerial, serial.Serial) + True + +Constructor +``````````` + +.. code:: py aioserial_instance: aioserial.AioSerial = aioserial.AioSerial( - SAME_WITH_PYSERIAL..., + # ... same with what can be passed to serial.Serial ..., loop: Optional[asyncio.AbstractEventLoop] = None) -Asynchronously Read -------------------- +Methods +``````` read_async -`````````` +:::::::::: .. code:: py @@ -30,28 +42,24 @@ read_async await aioserial_instance.read_async(size: int = 1) read_until_async -```````````````` +:::::::::::::::: .. code:: py - import serial - at_most_certain_size_of_bytes_read: bytes = \ await aioserial_instance.read_until_async( expected: bytes = serial.LF, size: Optional[int] = None) readinto_async -`````````````` +:::::::::::::: .. code:: py - import array - number_of_byte_read: int = \ await aioserial_instance.readinto_async(b: Union[array.array, bytearray]) readline_async -`````````````` +:::::::::::::: .. code:: py @@ -59,18 +67,15 @@ readline_async await aioserial_instance.readline_async(size: int = -1) readlines_async -``````````````` +::::::::::::::: .. code:: py lines_of_at_most_certain_size_of_bytes_read: bytes = \ await aioserial_instance.readlines_async(hint: int = -1) -Asynchronously Write --------------------- - write_async -``````````` +::::::::::: .. code:: py @@ -78,7 +83,7 @@ write_async await aioserial_instance.write_async(bytes_like_data) writelines_async -```````````````` +:::::::::::::::: .. code:: py @@ -86,6 +91,6 @@ writelines_async await aioserial_instance.writelines_async(list_of_bytes_like_data) Other APIs ----------- +`````````` -All the other APIs in `serial.Serial` are supported as original. +All the other APIs in ``serial.Serial`` are supported in aioserial.AioSerial as original. From 019b58c6856a58bf2fb32240ae2f1d5c4d8fba62 Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Sat, 29 Sep 2018 13:57:14 +0900 Subject: [PATCH 06/40] Add support to the original APIs in module serial --- src/aioserial/__init__.py | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/src/aioserial/__init__.py b/src/aioserial/__init__.py index c73fd00..a87a87c 100644 --- a/src/aioserial/__init__.py +++ b/src/aioserial/__init__.py @@ -1,8 +1,3 @@ -from typing import List +from serial import * from .aioserial import AioSerial - - -__all__: List[str] = [ - 'AioSerial', -] \ No newline at end of file From e6e277cda9188204992bf3c0f5698060403e2dfa Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Sat, 29 Sep 2018 14:03:58 +0900 Subject: [PATCH 07/40] Update README --- LICENSE.txt => LICENSE | 0 README.md | 100 +++++++++++++++++++++++++++++++++++++++++ README.rst | 96 --------------------------------------- setup.py | 7 +-- 4 files changed, 104 insertions(+), 99 deletions(-) rename LICENSE.txt => LICENSE (100%) create mode 100644 README.md delete mode 100644 README.rst diff --git a/LICENSE.txt b/LICENSE similarity index 100% rename from LICENSE.txt rename to LICENSE diff --git a/README.md b/README.md new file mode 100644 index 0000000..447216a --- /dev/null +++ b/README.md @@ -0,0 +1,100 @@ +# aioserial + +A Python package that combines [asyncio](https://docs.python.org/3/library/asyncio.html) and [pySerial](https://github.com/pyserial/pyserial). + +## API + +### aioserial vs. pySerial + +```py +>>> import aioserial +>>> import serial + +>>> aioserial.Serial is serial.Serial +True +``` + + +### AioSerial + +```py +>>> import aioserial +>>> import serial + +>>> isinstance(aioserial.AioSerial(), serial.Serial) +True + +>>> issubclass(aioserial.AioSerial, serial.Serial) +True +``` + +#### Constructor + +```py +aioserial_instance: aioserial.AioSerial = aioserial.AioSerial( + # ... same with what can be passed to serial.Serial ..., + loop: Optional[asyncio.AbstractEventLoop] = None) +``` + +#### Methods + + +##### read_async + +```py +bytes_read: bytes = \ + await aioserial_instance.read_async(size: int = 1) +``` + +##### read_until_async + +```py +at_most_certain_size_of_bytes_read: bytes = \ + await aioserial_instance.read_until_async( + expected: bytes = serial.LF, size: Optional[int] = None) +``` + +##### readinto_async + +```py +number_of_byte_read: int = \ + await aioserial_instance.readinto_async(b: Union[array.array, bytearray]) +``` + +##### readline_async + +```py +a_line_of_at_most_certain_size_of_bytes_read: bytes = \ + await aioserial_instance.readline_async(size: int = -1) +``` + +##### readlines_async + +```py +lines_of_at_most_certain_size_of_bytes_read: bytes = \ + await aioserial_instance.readlines_async(hint: int = -1) +``` + +##### write_async + +```py +number_of_byte_like_data_written: int = \ + await aioserial_instance.write_async(bytes_like_data) +``` + +##### writelines_async + +```py +number_of_byte_like_data_in_the_given_list_written: int = \ + await aioserial_instance.writelines_async(list_of_bytes_like_data) +``` + +### Other APIs + +All the other APIs in package [pySerial](https://github.com/pyserial/pyserial) are supported in [aioserial](https://github.com/changyuheng/aioserial) as [original](https://pyserial.readthedocs.io/). + +## Why aioserial + +* Want to use an asyncio-based but not (self-built) thread-based serial library. +* [pySerial-asyncio](https://github.com/pyserial/pyserial-asyncio) doesn't support Windows. +* APIs in all the packages ([pySerial-asyncio](https://github.com/pyserial/pyserial-asyncio), [asyncserial](https://github.com/xvzf/asyncserial-py)) that target the same goal are not designed in high level. You don't want to learn new APIs if you are already familiar with [pySerial](https://github.com/pyserial/pyserial). diff --git a/README.rst b/README.rst deleted file mode 100644 index 4288fe1..0000000 --- a/README.rst +++ /dev/null @@ -1,96 +0,0 @@ -========= -aioserial -========= - -Python asynchronous serial module for combining ``asyncio`` and ``pyserial``. - -Quick start -=========== - -AioSerial ---------- - -.. code:: py - - import aioserial - import serial - - isinstance(aioserial.AioSerial(), serial.Serial) - True - - issubclass(aioserial.AioSerial, serial.Serial) - True - -Constructor -``````````` - -.. code:: py - - aioserial_instance: aioserial.AioSerial = aioserial.AioSerial( - # ... same with what can be passed to serial.Serial ..., - loop: Optional[asyncio.AbstractEventLoop] = None) - -Methods -``````` - -read_async -:::::::::: - -.. code:: py - - bytes_read: bytes = \ - await aioserial_instance.read_async(size: int = 1) - -read_until_async -:::::::::::::::: - -.. code:: py - - at_most_certain_size_of_bytes_read: bytes = \ - await aioserial_instance.read_until_async( - expected: bytes = serial.LF, size: Optional[int] = None) - -readinto_async -:::::::::::::: - -.. code:: py - - number_of_byte_read: int = \ - await aioserial_instance.readinto_async(b: Union[array.array, bytearray]) - -readline_async -:::::::::::::: - -.. code:: py - - a_line_of_at_most_certain_size_of_bytes_read: bytes = \ - await aioserial_instance.readline_async(size: int = -1) - -readlines_async -::::::::::::::: - -.. code:: py - - lines_of_at_most_certain_size_of_bytes_read: bytes = \ - await aioserial_instance.readlines_async(hint: int = -1) - -write_async -::::::::::: - -.. code:: py - - number_of_byte_like_data_written: int = \ - await aioserial_instance.write_async(bytes_like_data) - -writelines_async -:::::::::::::::: - -.. code:: py - - number_of_byte_like_data_in_the_given_list_written: int = \ - await aioserial_instance.writelines_async(list_of_bytes_like_data) - -Other APIs -`````````` - -All the other APIs in ``serial.Serial`` are supported in aioserial.AioSerial as original. diff --git a/setup.py b/setup.py index ca86e6c..a7cfcc7 100644 --- a/setup.py +++ b/setup.py @@ -14,7 +14,7 @@ # Get the long description from the README file f: io.TextIOWrapper -with open(os.path.join(here, 'README.rst'), encoding='utf-8') as f: +with open(os.path.join(here, 'README.md'), encoding='utf-8') as f: long_description = f.read() setuptools.setup( @@ -27,6 +27,7 @@ description='An asynchronous serial port library of Python', long_description=long_description, + long_description_content_type='text/markdown', # The project's main homepage. url='https://github.com/changyuheng/aioserial', @@ -35,8 +36,8 @@ author='Henry Chang', author_email='mr.changyuheng@gmail.com', - # # Choose your license - # license='MIT', + # Choose your license + license='MIT', # See https://pypi.python.org/pypi?%3Aaction=list_classifiers classifiers=[ From 7bcfb63eaabd7eb743ab88df3c6ebdf74de63342 Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Sat, 29 Sep 2018 13:59:02 +0900 Subject: [PATCH 08/40] Bump to 1.0.2 --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index a7cfcc7..f6ae88b 100644 --- a/setup.py +++ b/setup.py @@ -23,7 +23,7 @@ # Versions should comply with PEP440. For a discussion on single-sourcing # the version across setup.py and the project code, see # https://packaging.python.org/en/latest/single_source_version.html - version='1.0.1', + version='1.0.2', description='An asynchronous serial port library of Python', long_description=long_description, From 6ba0da7b935bd0146e8a84b5d1edf78b7b2f2b7b Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Sat, 29 Sep 2018 15:03:31 +0900 Subject: [PATCH 09/40] Bump to 1.0.3 --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index f6ae88b..62accc6 100644 --- a/setup.py +++ b/setup.py @@ -23,7 +23,7 @@ # Versions should comply with PEP440. For a discussion on single-sourcing # the version across setup.py and the project code, see # https://packaging.python.org/en/latest/single_source_version.html - version='1.0.2', + version='1.0.3', description='An asynchronous serial port library of Python', long_description=long_description, From a2e370e2fccaaee7ccff424b62e066e7750b9eec Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Sat, 29 Sep 2018 15:53:59 +0900 Subject: [PATCH 10/40] Update README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 447216a..9684cdb 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ bytes_read: bytes = \ ```py at_most_certain_size_of_bytes_read: bytes = \ await aioserial_instance.read_until_async( - expected: bytes = serial.LF, size: Optional[int] = None) + expected: bytes = aioserial.LF, size: Optional[int] = None) ``` ##### readinto_async From 5d8468cf6c9ae659935932bfb4da71784801900f Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Sat, 29 Sep 2018 15:54:17 +0900 Subject: [PATCH 11/40] Bump to 1.0.4 --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 62accc6..322ec7b 100644 --- a/setup.py +++ b/setup.py @@ -23,7 +23,7 @@ # Versions should comply with PEP440. For a discussion on single-sourcing # the version across setup.py and the project code, see # https://packaging.python.org/en/latest/single_source_version.html - version='1.0.3', + version='1.0.4', description='An asynchronous serial port library of Python', long_description=long_description, From 12dcec08c2cf27199e09e5df8d657c08789d25ed Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Sun, 30 Sep 2018 11:21:14 +0900 Subject: [PATCH 12/40] Update README --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9684cdb..b4829bf 100644 --- a/README.md +++ b/README.md @@ -93,8 +93,8 @@ number_of_byte_like_data_in_the_given_list_written: int = \ All the other APIs in package [pySerial](https://github.com/pyserial/pyserial) are supported in [aioserial](https://github.com/changyuheng/aioserial) as [original](https://pyserial.readthedocs.io/). -## Why aioserial +## Why aioserial? -* Want to use an asyncio-based but not (self-built) thread-based serial library. -* [pySerial-asyncio](https://github.com/pyserial/pyserial-asyncio) doesn't support Windows. +* Want to use an asyncio-based but not a (self-built) thread-based serial library. +* [pySerial-asyncio](https://github.com/pyserial/pyserial-asyncio) does not support Windows. * APIs in all the packages ([pySerial-asyncio](https://github.com/pyserial/pyserial-asyncio), [asyncserial](https://github.com/xvzf/asyncserial-py)) that target the same goal are not designed in high level. You don't want to learn new APIs if you are already familiar with [pySerial](https://github.com/pyserial/pyserial). From 33364fb5ea45538ad1b08e9f26cf57486721d140 Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Sun, 30 Sep 2018 11:24:39 +0900 Subject: [PATCH 13/40] Update README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b4829bf..3f500a6 100644 --- a/README.md +++ b/README.md @@ -97,4 +97,4 @@ All the other APIs in package [pySerial](https://github.com/pyserial/pyserial) a * Want to use an asyncio-based but not a (self-built) thread-based serial library. * [pySerial-asyncio](https://github.com/pyserial/pyserial-asyncio) does not support Windows. -* APIs in all the packages ([pySerial-asyncio](https://github.com/pyserial/pyserial-asyncio), [asyncserial](https://github.com/xvzf/asyncserial-py)) that target the same goal are not designed in high level. You don't want to learn new APIs if you are already familiar with [pySerial](https://github.com/pyserial/pyserial). +* APIs in all the packages ([pySerial-asyncio](https://github.com/pyserial/pyserial-asyncio), [asyncserial](https://github.com/xvzf/asyncserial-py)) that target the same goal are not designed in high level. From 2d10eaa4c40a60be4370f61756aa173e4f6640a8 Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Mon, 1 Oct 2018 15:41:27 +0900 Subject: [PATCH 14/40] Add read example to README --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 3f500a6..4c8ef45 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,22 @@ A Python package that combines [asyncio](https://docs.python.org/3/library/asyncio.html) and [pySerial](https://github.com/pyserial/pyserial). +## Quick start + +A simple serial port reader: + +```py +import aioserial +import asyncio + + +async def read_and_print(aioserial_instance: aioserial.AioSerial): + while True: + print((await aioserial_instance.read_async()).decode(errors='ignore'), end='', flush=True) + +asyncio.run(read_and_print(aioserial.AioSerial(port='COM1'))) +``` + ## API ### aioserial vs. pySerial From 92fcf87938a447ea0c25cac6aa762b1c26e8c967 Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Mon, 1 Oct 2018 23:31:49 +0900 Subject: [PATCH 15/40] Remove a redundant function call --- src/aioserial/aioserial.py | 1 - 1 file changed, 1 deletion(-) diff --git a/src/aioserial/aioserial.py b/src/aioserial/aioserial.py index 63e3efb..087b8a0 100644 --- a/src/aioserial/aioserial.py +++ b/src/aioserial/aioserial.py @@ -46,7 +46,6 @@ def __init__( @property def loop(self) -> Optional[asyncio.AbstractEventLoop]: - self.write(b'') return self._loop if self._loop else asyncio.get_running_loop() @loop.setter From f23be390f08559063683c65cf95cd87901312e77 Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Mon, 1 Oct 2018 23:32:36 +0900 Subject: [PATCH 16/40] Bump to 1.0.5 --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 322ec7b..ff0ec82 100644 --- a/setup.py +++ b/setup.py @@ -23,7 +23,7 @@ # Versions should comply with PEP440. For a discussion on single-sourcing # the version across setup.py and the project code, see # https://packaging.python.org/en/latest/single_source_version.html - version='1.0.4', + version='1.0.5', description='An asynchronous serial port library of Python', long_description=long_description, From 501f3b1edfdd3775bf7fd50d34f5cf65e4c66579 Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Mon, 1 Oct 2018 23:34:05 +0900 Subject: [PATCH 17/40] Update README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4c8ef45..ef4e55a 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ A Python package that combines [asyncio](https://docs.python.org/3/library/async ## Quick start -A simple serial port reader: +### A simple serial port reader ```py import aioserial From 0256a962e2be18303d8afbea6a1f6d4bf208e04f Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Mon, 1 Oct 2018 23:34:18 +0900 Subject: [PATCH 18/40] Bump to 1.0.6 --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index ff0ec82..16a94c8 100644 --- a/setup.py +++ b/setup.py @@ -23,7 +23,7 @@ # Versions should comply with PEP440. For a discussion on single-sourcing # the version across setup.py and the project code, see # https://packaging.python.org/en/latest/single_source_version.html - version='1.0.5', + version='1.0.6', description='An asynchronous serial port library of Python', long_description=long_description, From e2b943f73fb16dfc94640a729ce1621d821ea5cd Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Mon, 1 Oct 2018 23:36:51 +0900 Subject: [PATCH 19/40] Update README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ef4e55a..f0379df 100644 --- a/README.md +++ b/README.md @@ -112,5 +112,5 @@ All the other APIs in package [pySerial](https://github.com/pyserial/pyserial) a ## Why aioserial? * Want to use an asyncio-based but not a (self-built) thread-based serial library. -* [pySerial-asyncio](https://github.com/pyserial/pyserial-asyncio) does not support Windows. +* [pySerial-asyncio](https://github.com/pyserial/pyserial-asyncio) does [not support Windows](https://github.com/pyserial/pyserial-asyncio/issues/3). * APIs in all the packages ([pySerial-asyncio](https://github.com/pyserial/pyserial-asyncio), [asyncserial](https://github.com/xvzf/asyncserial-py)) that target the same goal are not designed in high level. From 4ae71e74b957262f04b8879f30061dfc09aead00 Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Mon, 1 Oct 2018 23:37:12 +0900 Subject: [PATCH 20/40] Bump to 1.0.7 --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 16a94c8..f6c2fbc 100644 --- a/setup.py +++ b/setup.py @@ -23,7 +23,7 @@ # Versions should comply with PEP440. For a discussion on single-sourcing # the version across setup.py and the project code, see # https://packaging.python.org/en/latest/single_source_version.html - version='1.0.6', + version='1.0.7', description='An asynchronous serial port library of Python', long_description=long_description, From 9213410cfb437719f2d6ebceb9a2c9ef79fb04b5 Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Sat, 6 Oct 2018 10:19:12 +0800 Subject: [PATCH 21/40] Switch to Apache License Version 2.0 --- LICENSE | 221 +++++++++++++++++++++++++++++++++++++++++++++++++++----- NOTICE | 13 ++++ 2 files changed, 215 insertions(+), 19 deletions(-) create mode 100644 NOTICE diff --git a/LICENSE b/LICENSE index d76cbab..d645695 100644 --- a/LICENSE +++ b/LICENSE @@ -1,19 +1,202 @@ -Copyright (c) 2018 Henry Chang - -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. + + 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/NOTICE b/NOTICE new file mode 100644 index 0000000..4eb28a7 --- /dev/null +++ b/NOTICE @@ -0,0 +1,13 @@ +Copyright 2018 Henry Chang + +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. From 74f7ad540fcb3848cd438e0c08229a2583054d82 Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Sat, 6 Oct 2018 10:19:44 +0800 Subject: [PATCH 22/40] Bump to 1.0.8 --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index f6c2fbc..842910d 100644 --- a/setup.py +++ b/setup.py @@ -23,7 +23,7 @@ # Versions should comply with PEP440. For a discussion on single-sourcing # the version across setup.py and the project code, see # https://packaging.python.org/en/latest/single_source_version.html - version='1.0.7', + version='1.0.8', description='An asynchronous serial port library of Python', long_description=long_description, From cdbbf369f6811982622b643b2b054e13f51a0199 Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Mon, 8 Oct 2018 17:50:59 +0800 Subject: [PATCH 23/40] Switch to Mozilla Public License 2.0 (MPL-2.0) --- LICENSE | 573 ++++++++++++++++++++++++------------- NOTICE | 53 +++- src/aioserial/__init__.py | 6 + src/aioserial/aioserial.py | 6 + 4 files changed, 427 insertions(+), 211 deletions(-) diff --git a/LICENSE b/LICENSE index d645695..14e2f77 100644 --- a/LICENSE +++ b/LICENSE @@ -1,202 +1,373 @@ +Mozilla Public License Version 2.0 +================================== - 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. +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/NOTICE b/NOTICE index 4eb28a7..eecd29c 100644 --- a/NOTICE +++ b/NOTICE @@ -1,13 +1,46 @@ -Copyright 2018 Henry Chang +aioserial -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 +Copyright 2017-2018 Henry Chang - http://www.apache.org/licenses/LICENSE-2.0 +-- +pySerial -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. +Copyright (c) 2001-2016 Chris Liechti +All Rights Reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + + * Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials provided + with the distribution. + + * Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +--------------------------------------------------------------------------- +Note: +Individual files contain the following tag instead of the full license text. + + SPDX-License-Identifier: BSD-3-Clause + +This enables machine processing of license information based on the SPDX +License Identifiers that are here available: http://spdx.org/licenses/ diff --git a/src/aioserial/__init__.py b/src/aioserial/__init__.py index a87a87c..7df4ccd 100644 --- a/src/aioserial/__init__.py +++ b/src/aioserial/__init__.py @@ -1,3 +1,9 @@ +# Copyright 2018 Henry Chang +# +# This Source Code Form is subject to the terms of the Mozilla Public +# License, v. 2.0. If a copy of the MPL was not distributed with this +# file, You can obtain one at http://mozilla.org/MPL/2.0/. + from serial import * from .aioserial import AioSerial diff --git a/src/aioserial/aioserial.py b/src/aioserial/aioserial.py index 087b8a0..9c5a42a 100644 --- a/src/aioserial/aioserial.py +++ b/src/aioserial/aioserial.py @@ -1,3 +1,9 @@ +# Copyright 2018 Henry Chang +# +# This Source Code Form is subject to the terms of the Mozilla Public +# License, v. 2.0. If a copy of the MPL was not distributed with this +# file, You can obtain one at http://mozilla.org/MPL/2.0/. + import array import asyncio import concurrent.futures From 3c248d8ae4bf97353f6ff7b0ae96d302d5a0a30d Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Tue, 9 Oct 2018 01:05:17 +0800 Subject: [PATCH 24/40] Bump to 1.0.9 --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 842910d..e7b5f0b 100644 --- a/setup.py +++ b/setup.py @@ -23,7 +23,7 @@ # Versions should comply with PEP440. For a discussion on single-sourcing # the version across setup.py and the project code, see # https://packaging.python.org/en/latest/single_source_version.html - version='1.0.8', + version='1.0.9', description='An asynchronous serial port library of Python', long_description=long_description, From 5bf3e2c52f0f9aa7858279036d33f22185be10ff Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Tue, 9 Oct 2018 01:10:33 +0800 Subject: [PATCH 25/40] Fix license annotations --- setup.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/setup.py b/setup.py index e7b5f0b..21e621c 100644 --- a/setup.py +++ b/setup.py @@ -37,7 +37,7 @@ author_email='mr.changyuheng@gmail.com', # Choose your license - license='MIT', + license='MPL-2.0', # See https://pypi.python.org/pypi?%3Aaction=list_classifiers classifiers=[ @@ -54,7 +54,7 @@ 'Topic :: Terminals :: Serial', # Pick your license as you wish (should match "license" above) - 'License :: OSI Approved :: MIT License', + 'License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)', # Specify the Python versions you support here. In particular, ensure # that you indicate whether you support Python 2, Python 3 or both. From 582101c3e901a5548886b97c3100131dd6447a48 Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Tue, 9 Oct 2018 01:11:18 +0800 Subject: [PATCH 26/40] Bump to 1.0.10 --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 21e621c..d6500ce 100644 --- a/setup.py +++ b/setup.py @@ -23,7 +23,7 @@ # Versions should comply with PEP440. For a discussion on single-sourcing # the version across setup.py and the project code, see # https://packaging.python.org/en/latest/single_source_version.html - version='1.0.9', + version='1.0.10', description='An asynchronous serial port library of Python', long_description=long_description, From 71e31da498513e4caf6d2094d8aabc582b1e34ef Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Wed, 24 Oct 2018 10:17:43 +0800 Subject: [PATCH 27/40] Update README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f0379df..23b661c 100644 --- a/README.md +++ b/README.md @@ -113,4 +113,4 @@ All the other APIs in package [pySerial](https://github.com/pyserial/pyserial) a * Want to use an asyncio-based but not a (self-built) thread-based serial library. * [pySerial-asyncio](https://github.com/pyserial/pyserial-asyncio) does [not support Windows](https://github.com/pyserial/pyserial-asyncio/issues/3). -* APIs in all the packages ([pySerial-asyncio](https://github.com/pyserial/pyserial-asyncio), [asyncserial](https://github.com/xvzf/asyncserial-py)) that target the same goal are not designed in high level. +* APIs in all the other packages ([pySerial-asyncio](https://github.com/pyserial/pyserial-asyncio), [asyncserial](https://github.com/xvzf/asyncserial-py)) that target the same goal are not designed in high level. From 6574c03fec64d85976d902ea1f36482b90046252 Mon Sep 17 00:00:00 2001 From: Fernando Governatore Date: Tue, 30 Oct 2018 22:37:08 -0300 Subject: [PATCH 28/40] Now can be used with python >= 3.6 --- setup.py | 4 ++-- src/aioserial/aioserial.py | 8 ++++++++ 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/setup.py b/setup.py index d6500ce..e121847 100644 --- a/setup.py +++ b/setup.py @@ -58,7 +58,7 @@ # Specify the Python versions you support here. In particular, ensure # that you indicate whether you support Python 2, Python 3 or both. - 'Programming Language :: Python :: 3.7', + 'Programming Language :: Python :: 3.6', ], # # What does your project relate to? @@ -81,7 +81,7 @@ 'pyserial', ], - python_requires='>=3.7', + python_requires='>=3.6', # List additional groups of dependencies here (e.g. development # dependencies). You can install these using the following syntax, diff --git a/src/aioserial/aioserial.py b/src/aioserial/aioserial.py index 9c5a42a..b4aeda1 100644 --- a/src/aioserial/aioserial.py +++ b/src/aioserial/aioserial.py @@ -4,6 +4,7 @@ # License, v. 2.0. If a copy of the MPL was not distributed with this # file, You can obtain one at http://mozilla.org/MPL/2.0/. +import sys import array import asyncio import concurrent.futures @@ -44,6 +45,13 @@ def __init__( inter_byte_timeout=inter_byte_timeout, exclusive=exclusive, **kwargs) + + if not loop and sys.version_info < (3,7): + # If Python version < 3.7, loop is not optional because there is no + #asyncio.get_running_loop() to be used latter. + raise TypeError("{} missing 1 required argument: 'loop'".format( + self.__class__.__name__)) + self._loop: Optional[asyncio.AbstractEventLoop] = loop self._read_executor = \ concurrent.futures.ThreadPoolExecutor(max_workers=1) From 0bdb143350481e97ec2fc00e358f8ad142a87fa1 Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Tue, 13 Nov 2018 11:34:21 +0800 Subject: [PATCH 29/40] Refine the support of Python 3.6 --- src/aioserial/aioserial.py | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/src/aioserial/aioserial.py b/src/aioserial/aioserial.py index b4aeda1..1272a83 100644 --- a/src/aioserial/aioserial.py +++ b/src/aioserial/aioserial.py @@ -4,10 +4,10 @@ # License, v. 2.0. If a copy of the MPL was not distributed with this # file, You can obtain one at http://mozilla.org/MPL/2.0/. -import sys import array import asyncio import concurrent.futures +import sys from typing import List, Optional, Union import serial @@ -45,13 +45,6 @@ def __init__( inter_byte_timeout=inter_byte_timeout, exclusive=exclusive, **kwargs) - - if not loop and sys.version_info < (3,7): - # If Python version < 3.7, loop is not optional because there is no - #asyncio.get_running_loop() to be used latter. - raise TypeError("{} missing 1 required argument: 'loop'".format( - self.__class__.__name__)) - self._loop: Optional[asyncio.AbstractEventLoop] = loop self._read_executor = \ concurrent.futures.ThreadPoolExecutor(max_workers=1) @@ -60,7 +53,8 @@ def __init__( @property def loop(self) -> Optional[asyncio.AbstractEventLoop]: - return self._loop if self._loop else asyncio.get_running_loop() + return self._loop if self._loop else asyncio.get_running_loop() \ + if sys.version_info > (3, 6) else asyncio.get_event_loop() @loop.setter def loop(self, value: Optional[asyncio.AbstractEventLoop]): From 6c04653d43d9199492437794008644ca2a5db182 Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Tue, 13 Nov 2018 11:35:21 +0800 Subject: [PATCH 30/40] Bump to 1.1.0 --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index e121847..2a8c71c 100644 --- a/setup.py +++ b/setup.py @@ -23,7 +23,7 @@ # Versions should comply with PEP440. For a discussion on single-sourcing # the version across setup.py and the project code, see # https://packaging.python.org/en/latest/single_source_version.html - version='1.0.10', + version='1.1.0', description='An asynchronous serial port library of Python', long_description=long_description, From 8656281fd18bf17ad544fa04b9c6ce4dae244f72 Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Tue, 13 Nov 2018 14:48:24 +0800 Subject: [PATCH 31/40] Update README --- README.md | 14 +++----------- 1 file changed, 3 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 23b661c..5d22cb7 100644 --- a/README.md +++ b/README.md @@ -20,17 +20,6 @@ asyncio.run(read_and_print(aioserial.AioSerial(port='COM1'))) ## API -### aioserial vs. pySerial - -```py ->>> import aioserial ->>> import serial - ->>> aioserial.Serial is serial.Serial -True -``` - - ### AioSerial ```py @@ -42,6 +31,9 @@ True >>> issubclass(aioserial.AioSerial, serial.Serial) True + +>>> aioserial.Serial is serial.Serial +True ``` #### Constructor From ee2fc0e246c7e815c928e1d2d695f692e5ef9e9b Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Tue, 13 Nov 2018 14:49:34 +0800 Subject: [PATCH 32/40] Bump to 1.1.1 --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 2a8c71c..27d75eb 100644 --- a/setup.py +++ b/setup.py @@ -23,7 +23,7 @@ # Versions should comply with PEP440. For a discussion on single-sourcing # the version across setup.py and the project code, see # https://packaging.python.org/en/latest/single_source_version.html - version='1.1.0', + version='1.1.1', description='An asynchronous serial port library of Python', long_description=long_description, From 858b6c400560daa56c92f4f7ca4467b1d34ae6de Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Tue, 19 Feb 2019 22:56:51 +0800 Subject: [PATCH 33/40] Fix using get_running_loop method in 3.6 issue Fix #5 --- src/aioserial/aioserial.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/aioserial/aioserial.py b/src/aioserial/aioserial.py index 1272a83..6aa0156 100644 --- a/src/aioserial/aioserial.py +++ b/src/aioserial/aioserial.py @@ -54,7 +54,7 @@ def __init__( @property def loop(self) -> Optional[asyncio.AbstractEventLoop]: return self._loop if self._loop else asyncio.get_running_loop() \ - if sys.version_info > (3, 6) else asyncio.get_event_loop() + if sys.version_info >= (3, 7) else asyncio.get_event_loop() @loop.setter def loop(self, value: Optional[asyncio.AbstractEventLoop]): From d9b7a468236350613e4401a5a4889c048588d038 Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Tue, 19 Feb 2019 23:00:32 +0800 Subject: [PATCH 34/40] Bump to 1.1.2 --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 27d75eb..887e18c 100644 --- a/setup.py +++ b/setup.py @@ -23,7 +23,7 @@ # Versions should comply with PEP440. For a discussion on single-sourcing # the version across setup.py and the project code, see # https://packaging.python.org/en/latest/single_source_version.html - version='1.1.1', + version='1.1.2', description='An asynchronous serial port library of Python', long_description=long_description, From b12d71887e3d9e4ef3949cfef66b0c668312eb56 Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Tue, 2 Apr 2019 13:45:03 +0800 Subject: [PATCH 35/40] Add ToC to README --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 5d22cb7..8afe6ce 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,21 @@ # aioserial +* [Quick start](#quick-start) + + [A simple serial port reader](#a-simple-serial-port-reader) +* [API](#api) + + [AioSerial](#aioserial) + - [Constructor](#constructor) + - [Methods](#methods) + * [read_async](#read-async) + * [read_until_async](#read-until-async) + * [readinto_async](#readinto-async) + * [readline_async](#readline-async) + * [readlines_async](#readlines-async) + * [write_async](#write-async) + * [writelines_async](#writelines-async) + + [Other APIs](#other-apis) +* [Why aioserial?](#why-aioserial-) + A Python package that combines [asyncio](https://docs.python.org/3/library/asyncio.html) and [pySerial](https://github.com/pyserial/pyserial). ## Quick start From 5efb9df862d60fa1c4a4ea0e1c198e62ac10d111 Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Thu, 25 Apr 2019 14:42:10 +0800 Subject: [PATCH 36/40] Fix typo in loop assignment Fix #6 --- src/aioserial/aioserial.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/aioserial/aioserial.py b/src/aioserial/aioserial.py index 6aa0156..5c2280e 100644 --- a/src/aioserial/aioserial.py +++ b/src/aioserial/aioserial.py @@ -58,7 +58,7 @@ def loop(self) -> Optional[asyncio.AbstractEventLoop]: @loop.setter def loop(self, value: Optional[asyncio.AbstractEventLoop]): - self.loop = value + self._loop = value async def read_async(self, size: int = 1) -> bytes: return await self.loop.run_in_executor( From 0baf02743cb55074c91d148df7c7214d1d4bd024 Mon Sep 17 00:00:00 2001 From: Henry Chang Date: Thu, 25 Apr 2019 14:44:57 +0800 Subject: [PATCH 37/40] Bump to 1.1.3 --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 887e18c..3135a54 100644 --- a/setup.py +++ b/setup.py @@ -23,7 +23,7 @@ # Versions should comply with PEP440. For a discussion on single-sourcing # the version across setup.py and the project code, see # https://packaging.python.org/en/latest/single_source_version.html - version='1.1.2', + version='1.1.3', description='An asynchronous serial port library of Python', long_description=long_description, From 73e7b59c8d6bf25e4d5d99f70154deb3ea496e96 Mon Sep 17 00:00:00 2001 From: Fernando Governatore Date: Thu, 18 Jul 2019 19:37:21 -0300 Subject: [PATCH 38/40] Integrate with serial.serial_for_url("aioserial://", ...) --- src/aioserial/__init__.py | 2 ++ src/aioserial/protocol_aioserial.py | 18 ++++++++++++++++++ 2 files changed, 20 insertions(+) create mode 100644 src/aioserial/protocol_aioserial.py diff --git a/src/aioserial/__init__.py b/src/aioserial/__init__.py index 7df4ccd..c99c8cc 100644 --- a/src/aioserial/__init__.py +++ b/src/aioserial/__init__.py @@ -7,3 +7,5 @@ from serial import * from .aioserial import AioSerial + +protocol_handler_packages.append("aioserial") diff --git a/src/aioserial/protocol_aioserial.py b/src/aioserial/protocol_aioserial.py new file mode 100644 index 0000000..ff60815 --- /dev/null +++ b/src/aioserial/protocol_aioserial.py @@ -0,0 +1,18 @@ + +import aioserial + +try: + import urlparse +except ImportError: + import urllib.parse as urlparse + + +def serial_class_for_url(url): + """extract host and port from an URL string""" + parts = urlparse.urlsplit(url) + if parts.scheme != 'aioserial': + raise aioserial.SerialException( + 'expected a string in the form "aioserial://port": ' + 'not starting with aioserial:// ({!r})'.format(parts.scheme)) + + return ''.join([parts.netloc, parts.path]), aioserial.AioSerial From 8af48d7faee6c7dc66aeb6924ad6aae55c3295d4 Mon Sep 17 00:00:00 2001 From: Fernando Governatore Date: Thu, 18 Jul 2019 21:12:46 -0300 Subject: [PATCH 39/40] Supports any serial protocol supported by the serial module Usage: import aioserial import serial port = serial.serial_from_url("aioserial://test?handler=loop") port = serial.serial_from_url("aioserial://?handler=alt&class=") port = serial.serial_from_url("aioserial://:?handler=rfc2217") ... --- src/aioserial/aioserial.py | 73 ++++++++++++++++------------- src/aioserial/protocol_aioserial.py | 54 ++++++++++++++++++++- 2 files changed, 93 insertions(+), 34 deletions(-) diff --git a/src/aioserial/aioserial.py b/src/aioserial/aioserial.py index 5c2280e..9c6efc2 100644 --- a/src/aioserial/aioserial.py +++ b/src/aioserial/aioserial.py @@ -13,38 +13,12 @@ import serial -class AioSerial(serial.Serial): - - def __init__( - self, - port: Optional[str] = None, - baudrate: int = 9600, - bytesize: int = serial.EIGHTBITS, - parity: str = serial.PARITY_NONE, - stopbits: Union[float, int] = serial.STOPBITS_ONE, - timeout: Optional[float] = None, - xonxoff: bool = False, - rtscts: bool = False, - write_timeout: Optional[float] = None, - dsrdtr: bool = False, - inter_byte_timeout: Optional[float] = None, - exclusive: Optional[bool] = None, - loop: Optional[asyncio.AbstractEventLoop] = None, - **kwargs): - super().__init__( - port=port, - baudrate=baudrate, - bytesize=bytesize, - parity=parity, - stopbits=stopbits, - timeout=timeout, - xonxoff=xonxoff, - rtscts=rtscts, - write_timeout=write_timeout, - dsrdtr=dsrdtr, - inter_byte_timeout=inter_byte_timeout, - exclusive=exclusive, - **kwargs) +class _AioSerialMixin(serial.SerialBase): + def __init__(self, + *args, + loop: Optional[asyncio.AbstractEventLoop] = None, + **kwargs): + super().__init__(*args, **kwargs) self._loop: Optional[asyncio.AbstractEventLoop] = loop self._read_executor = \ concurrent.futures.ThreadPoolExecutor(max_workers=1) @@ -92,3 +66,38 @@ async def writelines_async( self, lines: List[Union[bytearray, bytes, memoryview]]) -> int: return await self.loop.run_in_executor( self._write_executor, self.writelines, lines) + + +class AioSerial(_AioSerialMixin, serial.Serial): + + def __init__( + self, + port: Optional[str] = None, + baudrate: int = 9600, + bytesize: int = serial.EIGHTBITS, + parity: str = serial.PARITY_NONE, + stopbits: Union[float, int] = serial.STOPBITS_ONE, + timeout: Optional[float] = None, + xonxoff: bool = False, + rtscts: bool = False, + write_timeout: Optional[float] = None, + dsrdtr: bool = False, + inter_byte_timeout: Optional[float] = None, + exclusive: Optional[bool] = None, + loop: Optional[asyncio.AbstractEventLoop] = None, + **kwargs): + super().__init__( + port=port, + baudrate=baudrate, + bytesize=bytesize, + parity=parity, + stopbits=stopbits, + timeout=timeout, + xonxoff=xonxoff, + rtscts=rtscts, + write_timeout=write_timeout, + dsrdtr=dsrdtr, + inter_byte_timeout=inter_byte_timeout, + exclusive=exclusive, + loop=loop, + **kwargs) diff --git a/src/aioserial/protocol_aioserial.py b/src/aioserial/protocol_aioserial.py index ff60815..3b56202 100644 --- a/src/aioserial/protocol_aioserial.py +++ b/src/aioserial/protocol_aioserial.py @@ -12,7 +12,57 @@ def serial_class_for_url(url): parts = urlparse.urlsplit(url) if parts.scheme != 'aioserial': raise aioserial.SerialException( - 'expected a string in the form "aioserial://port": ' + 'expected a string in the form "aioserial://port[?handler=value[&option=[value]]]": ' 'not starting with aioserial:// ({!r})'.format(parts.scheme)) - return ''.join([parts.netloc, parts.path]), aioserial.AioSerial + handler_cls_name = None + try: + for option, values in urlparse.parse_qs(parts.query, True).items(): + if option == 'handler': + handler_cls_name = values[0] + except ValueError as e: + raise aioserial.SerialException( + 'expected a string in the form ' + '"aioserial://port[?handler=value[&option=[value]]]": {!r}'.format(e)) + + if handler_cls_name: + import importlib + + # + # Copied (and modified) from serial.serial_for_url + # + # Unfortunately there is no API for getting the class, + # only an instance of a serial.Serial. + # + protocol = handler_cls_name + module_name = '.protocol_{}'.format(protocol) + for package_name in aioserial.protocol_handler_packages: + try: + importlib.import_module(package_name) + handler_module = importlib.import_module(module_name, + package_name) + except ImportError: + continue + else: + url = url.replace("aioserial://", protocol + "://"). \ + replace("handler=" + protocol, "") + + if hasattr(handler_module, 'serial_class_for_url'): + url, cls = handler_module.serial_class_for_url(url) + else: + cls = handler_module.Serial + break + else: + raise ValueError( + 'invalid URL, protocol {!r} not known'.format(protocol)) + + cls = type( + "AioSerial{}".format(handler_cls_name.capitalize()), + (aioserial.aioserial._AioSerialMixin, cls), + {} + ) + else: + cls = aioserial.AioSerial + url = ''.join([parts.netloc, parts.path]) + + return url, cls From 1890f88424ce4811c8becb48ae9e37f7d7e82d1d Mon Sep 17 00:00:00 2001 From: Fernando Governatore Date: Thu, 18 Jul 2019 21:55:25 -0300 Subject: [PATCH 40/40] Shutdown executors on close --- src/aioserial/aioserial.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/aioserial/aioserial.py b/src/aioserial/aioserial.py index 9c6efc2..f114aba 100644 --- a/src/aioserial/aioserial.py +++ b/src/aioserial/aioserial.py @@ -67,6 +67,11 @@ async def writelines_async( return await self.loop.run_in_executor( self._write_executor, self.writelines, lines) + def close(self) -> None: + self._read_executor.shutdown(wait=False) + self._write_executor.shutdown(wait=False) + super().close() + class AioSerial(_AioSerialMixin, serial.Serial):