setup: Vendor asyncudp

changes/1367.deps.md

@@ -0,0 +1 @@
+Vendor `asyncudp` as `ai.backend.vendor.asyncudp` to avoid packaging issues due to its missing precompiled wheel distribution

requirements.txt

@@ -15,7 +15,6 @@ appdirs~=1.4.4
 async_timeout~=4.0
 asyncpg>=0.27.0
 asynctest>=0.13.0
-asyncudp>=0.4
 attrs>=20.3
 boto3~=1.26
 cachetools~=5.2.0

src/ai/backend/common/sd_notify.py

@@ -35,7 +35,7 @@
 import os
 import socket
 
-import asyncudp
+from ai.backend.vendor import asyncudp
 
 
 class SystemdNotifier:

src/ai/backend/vendor/README.md

@@ -0,0 +1,49 @@
+# Backend.AI Vendored Libarires
+
+## Adding a new vendored library
+
+First, add a git subtree from the library's repository.
+You may change `main` to other branch names.
+
+```
+git remote add subtree-LIB https://github.com/OWNER/LIB
+# NOTE: --squash is to required to avoid CLA signing issues from the upstream contributors.
+git subtree add --prefix src/ai/backend/vendor/LIB subtree-LIB main --squash
+```
+
+Include it in our build chain by adding `BUILD` and `VERSION` files.
+
+```
+cp src/ai/backend/vendor/asyncudp/BUILD src/ai/backend/vendor/LIB/BUILD  # use as reference
+$EDITOR src/ai/backend/vendor/LIB/BUILD
+cd src/ai/backend/vendor/LIB
+ln -s ../../../../../VERSION
+git add src/ai/backend/vendor/LIB
+```
+
+Update all existing references (if applicable) to the library like:
+
+```diff
+- import LIB
++ from ai.backend.vendor import LIB
+```
+
+Remove it from `requirements.txt` and regenerate the lockfiles if necessary.
+
+```
+$EDITOR requirements.txt
+pants generate-lockfiles --resolve=python-default
+```
+
+
+## Updating an existing vendored libary
+
+It is recommended to create a new branch first before running the following commands:
+
+```
+# NOTE: --squash is to required to avoid CLA signing issues from the upstream contributors.
+git subtree pull --prefix src/ai/backend/vendor/LIB subtree-LIB main --squash
+git push
+```
+
+Then create a pull request to ensure CI checks.

src/ai/backend/vendor/asyncudp/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: eerimoq

src/ai/backend/vendor/asyncudp/.github/workflows/pythonpackage.yml

@@ -0,0 +1,50 @@
+name: Test
+
+on:
+  push:
+  pull_request:
+
+jobs:
+
+  linux:
+
+    runs-on: ubuntu-20.04
+    strategy:
+      max-parallel: 4
+      matrix:
+        python-version: [3.7, 3.8, 3.9]
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Test
+      run: |
+        python -m unittest
+
+  release:
+    needs: [linux]
+    runs-on: ubuntu-20.04
+    if: startsWith(github.ref, 'refs/tags')
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v1
+    - name: Set up Python 3.9
+      uses: actions/setup-python@v3
+      with:
+        python-version: 3.9
+    - name: Install pypa/build
+      run: |
+        python -m pip install build --user
+    - name: Build a source tarball
+      run: |
+        git clean -dfx
+        python -m build --sdist --outdir dist/ .
+    - name: Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@master
+      with:
+        skip_existing: true
+        password: ${{secrets.pypi_password}}

src/ai/backend/vendor/asyncudp/.gitignore

@@ -0,0 +1,72 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+# C extensions
+*.so
+*.o
+a.out
+
+# Distribution / packaging
+.Python
+env/
+venv/
+.venv/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# 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/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Vim IDE
+*~
+*.swp
+*.swo
+
+# IntelliJ IDEA
+.idea/
+
+# pyenv
+.python-version

src/ai/backend/vendor/asyncudp/BUILD

@@ -0,0 +1,29 @@
+python_sources(
+    name="src",
+    dependencies=[
+        ":version",
+    ],
+    # Since this is a vendored libary, we don't force our linters/checkers.
+    skip_black=True,
+    skip_flake8=True,
+    skip_isort=True,
+    skip_mypy=True,
+)
+
+python_distribution(
+    name="dist",
+    dependencies=[
+        ":src",
+        "!!stubs/trafaret:stubs",
+    ],
+    provides=python_artifact(
+        name="backend.ai-vendor-asyncudp",
+        description="asyncudp",
+        license="MIT",
+    ),
+    entry_points={},
+    generate_setup=True,
+    tags=["wheel"],
+)
+
+resource(name="version", source="VERSION")

src/ai/backend/vendor/asyncudp/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Erik Moqvist
+
+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.
+

src/ai/backend/vendor/asyncudp/MANIFEST.in

@@ -0,0 +1,2 @@
+include LICENSE
+recursive-include tests *.py

src/ai/backend/vendor/asyncudp/README.rst

@@ -0,0 +1,56 @@
+Asyncio high level UDP sockets
+==============================
+
+Asyncio high level UDP sockets.
+
+Project homepage: https://github.com/eerimoq/asyncudp
+
+Documentation: https://asyncudp.readthedocs.org/en/latest
+
+Installation
+============
+
+.. code-block:: python
+
+   $ pip install asyncudp
+
+Example client
+==============
+
+.. code-block:: python
+
+   import asyncio
+   import asyncudp
+
+   async def main():
+       sock = await asyncudp.create_socket(remote_addr=('127.0.0.1', 9999))
+       sock.sendto(b'Hello!')
+       print(await sock.recvfrom())
+       sock.close()
+
+   asyncio.run(main())
+
+Example server
+==============
+
+.. code-block:: python
+
+   import asyncio
+   import asyncudp
+
+   async def main():
+       sock = await asyncudp.create_socket(local_addr=('127.0.0.1', 9999))
+
+       while True:
+           data, addr = await sock.recvfrom()
+           print(data, addr)
+           sock.sendto(data, addr)
+
+   asyncio.run(main())
+
+Test
+====
+
+.. code-block::
+
+   $ python3 -m unittest

src/ai/backend/vendor/asyncudp/VERSION

@@ -0,0 +1 @@
+../../../../../VERSION