toio-py-fork 1.1.0.post2.dev2__tar.gz → 1.1.0.post2.dev3__tar.gz

{toio_py_fork-1.1.0.post2.dev2 → toio_py_fork-1.1.0.post2.dev3}/CHANGELOG_FORK.ja.md

@@ -29,6 +29,8 @@
   - `best` / `quick` の scanner strategy 動作。
   - `CubeInfo` からの `ToioCoreCube` 初期化。
 - この fork 専用の changelog を追加しました。
+- `objc_util` のスタブを使う、Pythonista3 向け CoreBluetooth バックエンドの definition テストを追加しました。
+- scanner strategy と、`CubeInfo` からの `ToioCoreCube` 初期化の実機テストを追加しました。
 
 ### 変更
 
@@ -41,6 +43,8 @@
 - Bleak の requirement を `bleak>=3,<4` に更新しました。
 - development dependency group から Poetry 自体を削除しました。
 - uv ベースの project layout に合わせて tests と tooling metadata を更新しました。
+- Pythonista3 向け CoreBluetooth バックエンドを Bleak 3 に対応させました。service、characteristic、descriptor のラッパーと KVO の監視を削除し、Bleak 3 の接続、スキャナ、エラーの API に合わせています。
+- Pythonista3 用インストーラが `toio-py-fork` と Bleak 3.0.2 をインストールし、サンプルを `toio.py-fork` のドキュメントサイトから取得するようにしました。
 
 ### 修正
 
@@ -56,6 +60,11 @@
 - README sample の古い argument や末尾の不要な空行を修正しました。
 - definition-only test 実行時に、実機 cube の setup を skip するよう修正しました。
 - `_cubes.py` を生成する test helper command で、正しい script path を使い path を安全に quote するよう修正しました。
+- 削除済みの `_RawAdvData` を import していた WinRT の古い回避コードを削除し、Bleak 3 の Windows でスキャンできるよう修正しました。
+- `BleCube.connected` が常に `bool` を保持するよう修正しました。
+- `_cubes.py` を再生成する実機テストの実行で、前回ではなく再生成後のキューブ一覧を使うよう修正しました。
+- Windows での `_cubes.py` の生成を修正しました。
+- 通常の `pytest` の実行が同名モジュールで止まらないよう、対話型の savable configuration テストの名前を変更しました。
 
 ### ドキュメント
 

{toio_py_fork-1.1.0.post2.dev2 → toio_py_fork-1.1.0.post2.dev3}/CHANGELOG_FORK.md

@@ -28,6 +28,8 @@ For the upstream project changelog, see [CHANGELOG.md](./CHANGELOG.md).
   - Scanner strategy behavior for `best` and `quick`.
   - `ToioCoreCube` initialization from `CubeInfo`.
 - Added this fork-specific changelog.
+- Added definition-level tests for the Pythonista3 CoreBluetooth backend, using an `objc_util` stub.
+- Added real-cube tests for the scanner strategies and for `ToioCoreCube` initialization from `CubeInfo`.
 
 ### Changed
 
@@ -40,6 +42,8 @@ For the upstream project changelog, see [CHANGELOG.md](./CHANGELOG.md).
 - Updated the Bleak requirement to `bleak>=3,<4`.
 - Removed Poetry itself from the development dependency group.
 - Updated tests and tooling metadata for the uv-based project layout.
+- Updated the Pythonista3 CoreBluetooth backend for Bleak 3: removed its service, characteristic and descriptor wrappers and its KVO observer, and followed the Bleak 3 connection, scanner and error APIs.
+- Changed the Pythonista3 installer to install `toio-py-fork` and Bleak 3.0.2, and to download the examples from the `toio.py-fork` documentation site.
 
 ### Fixed
 
@@ -55,6 +59,11 @@ For the upstream project changelog, see [CHANGELOG.md](./CHANGELOG.md).
 - Fixed README sample cleanup issues, including outdated arguments and trailing blank lines.
 - Fixed definition-only test runs so they skip physical cube setup.
 - Fixed the test helper command that generates `_cubes.py` to use the correct script path and safely quote paths.
+- Fixed scanning on Windows with Bleak 3 by removing the obsolete WinRT advertisement workaround, which imported the removed `_RawAdvData`.
+- Fixed `BleCube.connected` to always hold a `bool`.
+- Fixed hardware test runs that regenerate `_cubes.py` so that they use the regenerated cube list instead of the previous one.
+- Fixed the generation of `_cubes.py` on Windows.
+- Renamed the interactive savable configuration test so that a plain `pytest` run does not stop on a duplicate module name.
 
 ### Documentation
 

{toio_py_fork-1.1.0.post2.dev2 → toio_py_fork-1.1.0.post2.dev3}/CONTRIBUTING.md

@@ -7,7 +7,7 @@ Before contributing to toio.py, please read our [Code of Conduct](./CODE_OF_COND
 
 ### Setup
 
-1. [Install poetry](https://python-poetry.org/docs/#installing-with-the-official-installer)
+1. [Install uv](https://docs.astral.sh/uv/getting-started/installation/)
 
 2. Clone the toio.py repository
 
@@ -15,11 +15,11 @@ Before contributing to toio.py, please read our [Code of Conduct](./CODE_OF_COND
 git clone https://github.com/kaz399/toio.py-fork
 ```
 
-3. Run `poetry install` in toio.py repository
+3. Run `uv sync` in toio.py repository
 
 ```
 cd toio.py-fork
-poetry install
+uv sync
 ```
 
 ### Lint and format
@@ -29,8 +29,8 @@ poetry install
 [`black`](https://black.readthedocs.io/en/stable/) and [`isort`](https://pycqa.github.io/isort/) is used in this project.
 
 ```
-poetry run black
-poetry run isort
+uv run black
+uv run isort
 ```
 
 #### Optional:
@@ -38,11 +38,11 @@ poetry run isort
 Checking with [`flake8`](https://flake8.pycqa.org/en/latest/) or [`mypy`](https://www.mypy-lang.org/) is recommended.
 
 ```
-poetry run flake8
+uv run flake8
 ```
 
 ```
-poetry run mypy
+uv run mypy
 ```
 
 

{toio_py_fork-1.1.0.post2.dev2 → toio_py_fork-1.1.0.post2.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: toio-py-fork
-Version: 1.1.0.post2.dev2
+Version: 1.1.0.post2.dev3
 Summary: Unofficial maintained fork of toio.py for controlling toio Core Cube
 Project-URL: Homepage, https://github.com/kaz399/toio.py-fork
 Project-URL: Documentation, https://kaz399.github.io/toio.py-fork/

{toio_py_fork-1.1.0.post2.dev2 → toio_py_fork-1.1.0.post2.dev3}/TESTING.ja.md

@@ -79,9 +79,12 @@ uv run coverage report
 主な確認内容:
 
 - mock した Bleak client を使った BLE connection state handling。
-- collision detection threshold command を含む configuration command byte の生成。
-- `best` と `quick` の scanner strategy 動作。
+- collision detection threshold command を含む configuration および indicator command の
+  byte 生成と response の parse。
+- `best` と `quick` の scanner strategy 動作と、cube initializer が受け付ける
+  scanner のキーワード引数。
 - `CubeInfo` からの `ToioCoreCube` 初期化。
+- 姿勢角 notification の sensor payload dispatch。
 - BLE hardware なしで確認できる definition や import-level の挙動。
 
 CI やローカルでの regression check では、このテストグループを最初に実行するのが安全です。
@@ -106,6 +109,7 @@ CI やローカルでの regression check では、このテストグループ
 主な確認内容:
 
 - 複数 cube がある場合の scanner behavior。
+- `best` と `quick` の scan strategy とそのタイミング。
 - RSSI と local name による sort。
 - cube ID と BLE address による scan。
 - scan 結果からの `ToioCoreCube` instance 作成。
@@ -388,7 +392,8 @@ cube button を押さないでください。button press は中断扱いにな
 ### `tests/test_11_cube_off`
 
 特定の cube だけが電源 ON の状態での cube discovery behavior を確認する hardware test
-です。手動で cube の電源状態を操作する必要があります。
+です。remote power off command で片方の cube の電源を落とすため、開始時には 2 台の
+cube の電源を入れておく必要があります。
 
 ## Cube 設定ファイル
 

{toio_py_fork-1.1.0.post2.dev2 → toio_py_fork-1.1.0.post2.dev3}/TESTING.md

@@ -80,10 +80,12 @@ Definition-level tests that do not require physical cubes.
 Coverage includes:
 
 - BLE connection state handling with mocked Bleak clients.
-- Configuration command byte generation, including collision detection
-  threshold commands.
-- Scanner strategy behavior for `best` and `quick`.
+- Command byte generation and response parsing for the configuration and
+  indicator commands, including the collision detection threshold command.
+- Scanner strategy behavior for `best` and `quick`, and the scanner keyword
+  arguments accepted by the cube initializers.
 - `ToioCoreCube` initialization from `CubeInfo`.
+- Sensor payload dispatch for the posture angle notifications.
 - Definition and import-level behavior that can be checked without BLE
   hardware.
 
@@ -109,6 +111,7 @@ Two-cube hardware tests.
 Coverage includes:
 
 - Scanner behavior with multiple cubes.
+- Scan strategies `best` and `quick`, including their timing.
 - Sorting by RSSI and local name.
 - Scanning by cube ID and BLE address.
 - Creating one or more `ToioCoreCube` instances from scanned cube data.
@@ -422,7 +425,8 @@ connected.
 ### `tests/test_11_cube_off`
 
 Hardware tests for cube discovery behavior when only selected cubes are powered
-on. These tests require manual cube power-state control.
+on. The test powers one cube down through the remote power off command, so two
+powered-on cubes are needed at the start of the run.
 
 ## Cube Configuration File
 

{toio_py_fork-1.1.0.post2.dev2 → toio_py_fork-1.1.0.post2.dev3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "toio-py-fork"
-version = "1.1.0.post2.dev2"
+version = "1.1.0.post2.dev3"
 description = "Unofficial maintained fork of toio.py for controlling toio Core Cube"
 authors = [
     {name = "Sony Interactive Entertainment"},

{toio_py_fork-1.1.0.post2.dev2 → toio_py_fork-1.1.0.post2.dev3}/pythonista3/install_toio.py.in

@@ -13,10 +13,6 @@ import shutil
 import sys
 import zipfile
 
-import requests
-
-from packaging.version import Version, parse
-
 site_packages_dir = ""
 DEVELOPMENT_MODE = False
 
@@ -29,14 +25,20 @@ if sys.platform != "ios":
     else:
         exit(1)
 
+# Imported here so that an unsupported platform gets the message above, not an
+# ImportError.
+import requests
+
+from packaging.version import Version, parse
+
 
 def get_latest_toio_py(min="1.1.0a1", max="1.2.0"):
     min_ver = parse(min)
     max_ver = parse(max)
     latest = Version("0.0.0")
     found_specified_version = False
-    query = "https://pypi.org/pypi/toio-py/json"
-    # query = "https://test.pypi.org/pypi/toio-py/json"
+    query = "https://pypi.org/pypi/${TOIO_PY_PACKAGE}/json"
+    # query = "https://test.pypi.org/pypi/${TOIO_PY_PACKAGE}/json"
     result = requests.get(query).json()
     # search latest version
     releases = result["releases"]
@@ -59,17 +61,28 @@ def get_latest_toio_py(min="1.1.0a1", max="1.2.0"):
                 fetch_url = True
             if fetch_url and key == "url":
                 return value
+    print("wheel of toio.py %s is not found" % latest)
+    return None
+
+
+TOIO_PY_WHL = get_latest_toio_py()
+if TOIO_PY_WHL is None:
+    # Stop before the cleanup, which would remove the working installation.
+    print("installation is cancelled: nothing has been changed")
+    exit(1)
 
 REQUIRED_WHLS = (
     "https://files.pythonhosted.org/packages/01/f3/936e209267d6ef7510322191003885de524fc48d1b43269810cd589ceaf5/typing_extensions-4.11.0-py3-none-any.whl",
-    "https://files.pythonhosted.org/packages/ac/c8/576a25c20d5619576a82b6ec28df9f1d4c867e4fe801531f7d9bb9f49db7/bleak-0.22.1-py3-none-any.whl",
-    get_latest_toio_py()
+    "https://files.pythonhosted.org/packages/26/54/05aceb9cd80073805b3ed8522e3196e8cb22f70e741873fa51406c31f4e7/bleak-3.0.2-py3-none-any.whl",
+    TOIO_PY_WHL,
 )
 
 CLEANUP_TARGETS = (
     "typing_extensions",
     "bleak",
     "toio",
+    "toio_py",
+    "toio_py_fork",
 )
 
 EXAMPLES = (
@@ -81,6 +94,28 @@ ${EXAMPLE_SIMPLE_FILES}
 )
 
 
+
+def is_cleanup_target(filename):
+    # Compare the whole name: other packages may have "toio" in their names.
+    # "bleak-3.0.2.dist-info" and "typing_extensions.py" have the suffix removed.
+    return filename.split("-")[0].split(".")[0] in CLEANUP_TARGETS
+
+
+def install_examples(urls, directory, description):
+    os.makedirs(directory, exist_ok=True)
+    for url in urls:
+        filename = url.split("/")[-1]
+        path = os.path.join(directory, filename)
+        # An existing file is kept because the user may have edited it.
+        if os.path.exists(path):
+            print("SKIP: %s is already installed" % filename)
+            continue
+        print("install %s: %s" % (description, filename))
+        data = requests.get(url).content
+        with open(path, "wb") as wfh:
+            wfh.write(data)
+
+
 if not DEVELOPMENT_MODE:
     for p in sys.path:
         if p.endswith("site-packages"):
@@ -102,44 +137,24 @@ print("------------------------------------------------------------")
 os.makedirs(site_packages_dir, exist_ok=True)
 print("clean previous installation")
 for filename in os.listdir(site_packages_dir):
-    for cleanup in CLEANUP_TARGETS:
-        if cleanup in filename:
-            print("clean: %s" % filename)
-            remove_target = os.path.normpath(os.path.join(site_packages_dir, filename))
-            if os.path.isdir(remove_target):
-                shutil.rmtree(remove_target)
-            else:
-                os.remove(remove_target)
+    if is_cleanup_target(filename):
+        print("clean: %s" % filename)
+        remove_target = os.path.normpath(os.path.join(site_packages_dir, filename))
+        if os.path.isdir(remove_target):
+            shutil.rmtree(remove_target)
+        else:
+            os.remove(remove_target)
 print("------------------------------------------------------------")
 print("install packages")
 for whl in REQUIRED_WHLS:
-    if whl is not None:
-        print("install module: %s" % whl.split("/")[-1])
-        zipfile.ZipFile(io.BytesIO(requests.get(whl).content)).extractall(site_packages_dir)
+    print("install module: %s" % whl.split("/")[-1])
+    zipfile.ZipFile(io.BytesIO(requests.get(whl).content)).extractall(site_packages_dir)
 print("------------------------------------------------------------")
 print("install examples")
-if not os.path.isdir(examples_dir):
-    os.makedirs(examples_dir, exist_ok=True)
-    for example in EXAMPLES:
-        filename = example.split("/")[-1]
-        print("install toio.py example: %s" % filename)
-        data = requests.get(example).content
-        with open(os.path.join(examples_dir, filename), "wb") as wfh:
-            wfh.write(data)
-else:
-    print("SKIP: example files are already installed")
+install_examples(EXAMPLES, examples_dir, "toio.py example")
 print("------------------------------------------------------------")
 print("install examples-simple")
-if not os.path.isdir(examples_simple_dir):
-    os.makedirs(examples_simple_dir, exist_ok=True)
-    for example in EXAMPLES_SIMPLE:
-        filename = example.split("/")[-1]
-        print("install toio.py example (simple API): %s" % filename)
-        data = requests.get(example).content
-        with open(os.path.join(examples_simple_dir, filename), "wb") as wfh:
-            wfh.write(data)
-else:
-    print("SKIP: example files are already installed")
+install_examples(EXAMPLES_SIMPLE, examples_simple_dir, "toio.py example (simple API)")
 print("------------------------------------------------------------")
 print("install completed")
 print("")

toio_py_fork-1.1.0.post2.dev3/pythonista3/make_install_script.sh

@@ -0,0 +1,40 @@
+#!/bin/bash
+set -euo pipefail
+
+if [ "$#" -ne 1 ]; then
+    echo "usage: $0 <output file>" >&2
+    exit 1
+fi
+
+if ! command -v envsubst > /dev/null; then
+    echo "envsubst is required (it is included in gettext)" >&2
+    exit 1
+fi
+
+SCRIPT_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)
+REPO_TOP=$(git rev-parse --show-toplevel)
+
+TOIO_PY_PACKAGE="toio-py-fork"
+DOWNLOAD_BASE_URL="https://kaz399.github.io/toio.py-fork"
+DOWNLOAD_URL="${DOWNLOAD_BASE_URL}/examples"
+DOWNLOAD_URL_SIMPLE="${DOWNLOAD_BASE_URL}/examples-simple"
+EXAMPLES_DIR="${REPO_TOP}/docs/examples"
+EXAMPLES_SIMPLE_DIR="${REPO_TOP}/docs/examples-simple"
+
+function examples() {
+    local directory="${1}"
+    local url="${2}"
+    local pyfile
+    for pyfile in "${directory}"/*.py ; do
+        echo "   \"${url}/$(basename "${pyfile}")\","
+    done
+}
+
+EXAMPLE_FILES=$(examples "${EXAMPLES_DIR}" "${DOWNLOAD_URL}")
+EXAMPLE_SIMPLE_FILES=$(examples "${EXAMPLES_SIMPLE_DIR}" "${DOWNLOAD_URL_SIMPLE}")
+export TOIO_PY_PACKAGE EXAMPLE_FILES EXAMPLE_SIMPLE_FILES
+
+# Only these variables are replaced, so a "$" in the template stays as it is.
+# shellcheck disable=SC2016
+envsubst '${TOIO_PY_PACKAGE} ${EXAMPLE_FILES} ${EXAMPLE_SIMPLE_FILES}' \
+    < "${SCRIPT_DIR}/install_toio.py.in" > "${1}"

{toio_py_fork-1.1.0.post2.dev2 → toio_py_fork-1.1.0.post2.dev3}/tests/conftest.py

@@ -8,7 +8,9 @@
 # ************************************************************
 
 import os
-import shlex
+import runpy
+import subprocess
+import sys
 import time
 from pathlib import Path
 from logging import getLogger
@@ -18,6 +20,9 @@ from colorama import Back, Fore, Style, init
 
 logger = getLogger(__name__)
 
+DEFINITION_TEST_DIR = "test_50_definition"
+CUBE_FILE = os.path.join(os.path.dirname(__file__), "_cubes.py")
+
 
 @pytest.fixture(scope="function", autouse=True)
 def wait():
@@ -28,12 +33,12 @@ def wait():
 def setup(pytestconfig):
     init()
     capmanager = pytestconfig.pluginmanager.getplugin("capturemanager")
-    selected_paths = [
-        Path(arg)
-        for arg in pytestconfig.invocation_params.args
-        if not arg.startswith("-")
-    ]
-    if selected_paths and all("test_50_definition" in path.parts for path in selected_paths):
+    # config.args holds only the resolved test paths (or testpaths when the
+    # command line selects nothing). invocation_params.args cannot be used
+    # here because it also contains option values such as the
+    # "no:cacheprovider" of "-p no:cacheprovider".
+    selected = [Path(arg) for arg in pytestconfig.args]
+    if selected and all(DEFINITION_TEST_DIR in path.parts for path in selected):
         logger.info("** skip cube setup for definition-only tests")
         return
 
@@ -59,14 +64,11 @@ def setup(pytestconfig):
     capmanager.resume_global_capture()
     logger.info("%s", yn)
     test_dir = os.path.dirname(__file__)
-    cube_file = os.path.join(test_dir, "_cubes.py")
     make_cube_list = os.path.join(test_dir, "make_cube_list.py")
     if yn.lower() != "s":
         logger.info("** GENERATE _cubes.py")
-        result = os.system(
-            f"python {shlex.quote(make_cube_list)} {shlex.quote(cube_file)}"
-        )
-        if result:
+        result = subprocess.run([sys.executable, make_cube_list, CUBE_FILE])
+        if result.returncode:
             logger.info(
                 Fore.RED
                 + "** 2 cubes are not found. _cubes.py is not updated"
@@ -75,10 +77,18 @@ def setup(pytestconfig):
     else:
         logger.info(Fore.YELLOW + "** skip to generate _cubes.py" + Style.RESET_ALL)
     logger.info("** cubes used in this test:")
-    with open(cube_file, "r") as rf:
+    with open(CUBE_FILE, "r") as rf:
         logger.info("\n" + rf.read())
 
 
+@pytest.fixture(scope="session")
+def cubes(setup):
+    # Test modules must not import _cubes.py: they are imported during
+    # collection, before setup can regenerate the file, so they would keep
+    # the cubes of the previous run.
+    return runpy.run_path(CUBE_FILE)["CUBES"]
+
+
 @pytest.fixture(scope="function")
 def confirm(pytestconfig):
     capmanager = pytestconfig.pluginmanager.getplugin("capturemanager")

{toio_py_fork-1.1.0.post2.dev2 → toio_py_fork-1.1.0.post2.dev3}/tests/make_cube_list.py

@@ -28,9 +28,11 @@ async def main(argv):
     else:
         if len(argv) >= 2:
             wfh = open(argv[1], "w")
+            output_file = argv[1]
         else:
             wfh = sys.stdout
-        sys.stderr.write("generate cube list: '%s'\n" % argv[1])
+            output_file = "stdout"
+        sys.stderr.write("generate cube list: '%s'\n" % output_file)
         wfh.write("from typing import Dict, List\n")
         wfh.write("\n")
         wfh.write("CUBES: List[Dict[str, str]] = [\n")

{toio_py_fork-1.1.0.post2.dev2 → toio_py_fork-1.1.0.post2.dev3}/tests/test_10_two_cubes/test_2cubes_connect_v1_2.py

@@ -113,3 +113,24 @@ async def test_connect_7():
         logger.info("** DISCONNECT")
         await cube.disconnect()
     logger.info(warn[0].message)
+
+
+@pytest.mark.asyncio
+async def test_connect_cube_info():
+    device_list = await BLEScanner.scan(2)
+    assert len(device_list) == 2
+    cubes = [ToioCoreCube(cube_info) for cube_info in device_list]
+    assert [cube.name for cube in cubes] == [d.name for d in device_list]
+    logger.info("** CONNECTING...")
+    for cube in cubes:
+        await cube.connect()
+        assert cube.is_connect()
+    logger.info("** CONNECTED")
+    for i, cube in enumerate(cubes):
+        pos = await cube.api.id_information.read()
+        logger.info("cube[%d]: %s", i, str(pos))
+    logger.info("** DISCONNECTING")
+    for cube in cubes:
+        await cube.disconnect()
+        assert not cube.is_connect()
+    logger.info("** DISCONNECTED")