pyobs-fli 2.0.0.dev6__tar.gz → 2.0.0.dev9__tar.gz

pyobs_fli-2.0.0.dev9/.github/workflows/pypi.yml

@@ -0,0 +1,65 @@
+name: Publish package to PyPI
+on:
+  push:
+    tags:
+    - 'v*'
+jobs:
+  build-wheels:
+    name: Build wheels
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+
+      - name: Build wheels
+        uses: pypa/cibuildwheel@v4.2.0
+
+      - name: Upload wheels
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels
+          path: wheelhouse/*.whl
+
+  build-sdist:
+    name: Build sdist
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          python-version: "3.13"
+
+      - name: Build sdist
+        run: uv build --sdist
+
+      - name: Upload sdist
+        uses: actions/upload-artifact@v4
+        with:
+          name: sdist
+          path: dist/*.tar.gz
+
+  publish:
+    name: Publish to PyPI
+    needs: [build-wheels, build-sdist]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: dist
+          merge-multiple: true
+
+      - name: Set up Python
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          python-version: "3.13"
+
+      - name: Publish
+        env:
+          PYPI_TOKEN: ${{ secrets.pypi_password }}
+        run: uv publish --token $PYPI_TOKEN dist/*

{pyobs_fli-2.0.0.dev6 → pyobs_fli-2.0.0.dev9}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: pyobs-fli
-Version: 2.0.0.dev6
+Version: 2.0.0.dev9
 Summary: pyobs module for FLI cameras
 Author-Email: Tim-Oliver Husser <thusser@uni-goettingen.de>
 License-Expression: MIT
-Requires-Python: <3.14,>=3.11
+Requires-Python: >=3.11
 Requires-Dist: astropy<9,>=7.0.1
 Requires-Dist: numpy<3,>=2.2.5
 Requires-Dist: pyobs-core<3,>=2.0.0.dev48

{pyobs_fli-2.0.0.dev6 → pyobs_fli-2.0.0.dev9}/pyobs_fli/flicamera.py

@@ -8,7 +8,7 @@ from typing import Any
 import numpy as np
 from pyobs.images import Image
 from pyobs.interfaces import IAbortable, IBinning, ICamera, ICooling, ITemperatures, IWindow
-from pyobs.interfaces.IBinning import BinningCapabilities, BinningState
+from pyobs.interfaces.IBinning import Binning, BinningCapabilities, BinningState
 from pyobs.interfaces.ICooling import CoolingState
 from pyobs.interfaces.ITemperatures import SensorReading, TemperaturesState
 from pyobs.interfaces.IWindow import WindowCapabilities, WindowState
@@ -84,10 +84,10 @@ class FliCamera(FliBaseMixin, BaseCamera, ICamera, IWindow, IBinning, ICooling,
             IBinning,
             BinningCapabilities(
                 binnings=[
-                    BinningState(x=1, y=1),
-                    BinningState(x=2, y=2),
-                    BinningState(x=3, y=3),
-                    BinningState(x=4, y=4),
+                    Binning(x=1, y=1),
+                    Binning(x=2, y=2),
+                    Binning(x=3, y=3),
+                    Binning(x=4, y=4),
                 ]
             ),
         )
@@ -196,7 +196,7 @@ class FliCamera(FliBaseMixin, BaseCamera, ICamera, IWindow, IBinning, ICooling,
 
         def _wait() -> bool:
             while True:
-                if driver.is_exposing():
+                if driver.is_data_ready():
                     return not abort_event.is_set()
                 if abort_event.is_set():
                     return False

{pyobs_fli-2.0.0.dev6 → pyobs_fli-2.0.0.dev9}/pyobs_fli/flidriver.pyx

@@ -42,26 +42,38 @@ cdef class FliDriver:
         cdef flidomain_t domain
         cdef char filename[1024]
         cdef char name[1024]
+        cdef flidomain_t list_domain = FLIDOMAIN_USB | device_type.value
+        cdef long res
+        cdef bint have_first
 
         # create list of USB camera
-        if FLICreateList(FLIDOMAIN_USB | device_type.value) != 0:
+        with nogil:
+            res = FLICreateList(list_domain)
+        if res != 0:
             raise ValueError('Could not create list of FLI cameras.')
 
         # init list of devices
         devices = []
 
         # get first camera
-        if FLIListFirst(&domain, <char*>filename, 1024, <char*>name, 1024) == 0:
+        with nogil:
+            have_first = FLIListFirst(&domain, <char*>filename, 1024, <char*>name, 1024) == 0
+        if have_first:
             # store first device
             devices.append(DeviceInfo(domain=domain, filename=filename, name=name))
 
             # loop other devices
-            while FLIListNext(&domain, <char*>filename, 1024, <char*>name, 1024) == 0:
+            while True:
+                with nogil:
+                    res = FLIListNext(&domain, <char*>filename, 1024, <char*>name, 1024)
+                if res != 0:
+                    break
                 # store device
                 devices.append(DeviceInfo(domain=domain, filename=filename, name=name))
 
         # clean up and return
-        FLIDeleteList()
+        with nogil:
+            FLIDeleteList()
         return devices
 
     """Storage for the device info."""
@@ -84,7 +96,12 @@ cdef class FliDriver:
         Raises:
             ValueError: If opening failed.
         """
-        res = FLIOpen(&self._device, self._device_info.filename, self._device_info.domain)
+        cdef bytes filename_bytes = self._device_info.filename
+        cdef char* filename = filename_bytes
+        cdef flidomain_t domain = self._device_info.domain
+        cdef long res
+        with nogil:
+            res = FLIOpen(&self._device, filename, domain)
         if res != 0:
             raise ValueError('Could not open device.')
 
@@ -94,7 +111,9 @@ cdef class FliDriver:
         Raises:
             ValueError: If closing failed.
         """
-        res = FLIClose(self._device)
+        cdef long res
+        with nogil:
+            res = FLIClose(self._device)
         if res != 0:
             raise ValueError('Could not open device.')
 
@@ -115,9 +134,11 @@ cdef class FliDriver:
 
         # variables
         cdef long width, hoffset, hbin, height, voffset, vbin
-        
+        cdef long res
+
         # get dimensions
-        res = FLIGetReadoutDimensions(self._device, &width, &hoffset, &hbin, &height, &voffset, &vbin)
+        with nogil:
+            res = FLIGetReadoutDimensions(self._device, &width, &hoffset, &hbin, &height, &voffset, &vbin)
         if res != 0:
             raise ValueError('Could not query readout dimensions.')
 
@@ -136,9 +157,11 @@ cdef class FliDriver:
 
         # variables
         cdef long ul_x, ul_y, lr_x, lr_y
+        cdef long res
 
         # get area
-        res = FLIGetVisibleArea(self._device, &ul_x, &ul_y, &lr_x, &lr_y)
+        with nogil:
+            res = FLIGetVisibleArea(self._device, &ul_x, &ul_y, &lr_x, &lr_y)
         if res != 0:
             raise ValueError('Could not query visible area.')
 
@@ -157,9 +180,11 @@ cdef class FliDriver:
 
         # variables
         cdef long ul_x, ul_y, lr_x, lr_y
+        cdef long res
 
         # get area
-        res = FLIGetArrayArea(self._device, &ul_x, &ul_y, &lr_x, &lr_y)
+        with nogil:
+            res = FLIGetArrayArea(self._device, &ul_x, &ul_y, &lr_x, &lr_y)
         if res != 0:
             raise ValueError('Could not query total area.')
 
@@ -177,13 +202,19 @@ cdef class FliDriver:
             ValueError: If setting binning failed.
         """
 
+        cdef long x_c = x
+        cdef long y_c = y
+        cdef long res
+
         # set x binning
-        res = FLISetHBin(self._device, x)
+        with nogil:
+            res = FLISetHBin(self._device, x_c)
         if res != 0:
             raise ValueError('Could not set x binning.')
 
         # set y binning
-        res = FLISetVBin(self._device, y)
+        with nogil:
+            res = FLISetVBin(self._device, y_c)
         if res != 0:
             raise ValueError('Could not set y binning.')
 
@@ -200,8 +231,15 @@ cdef class FliDriver:
             ValueError: If setting the window failed.
         """
 
+        cdef long left_c = left
+        cdef long top_c = top
+        cdef long right_c = left + width
+        cdef long bottom_c = top + height
+        cdef long res
+
         # set window
-        res = FLISetImageArea(self._device, left, top, left + width, top + height)
+        with nogil:
+            res = FLISetImageArea(self._device, left_c, top_c, right_c, bottom_c)
         if res != 0:
             raise ValueError('Could not set window.')
 
@@ -215,13 +253,18 @@ cdef class FliDriver:
             ValueError: If initialization failed.
         """
 
+        cdef fliframe_t frame_type = FLI_FRAME_TYPE_NORMAL if open_shutter else FLI_FRAME_TYPE_DARK
+        cdef long res
+
         # set TDI
-        res = FLISetTDI(self._device, 0, 0)
+        with nogil:
+            res = FLISetTDI(self._device, 0, 0)
         if res != 0:
             raise ValueError('Could not set TDI.')
 
         # set frame type
-        res = FLISetFrameType(self._device, FLI_FRAME_TYPE_NORMAL if open_shutter else FLI_FRAME_TYPE_DARK)
+        with nogil:
+            res = FLISetFrameType(self._device, frame_type)
         if res != 0:
             raise ValueError('Could not set frame type.')
 
@@ -235,8 +278,12 @@ cdef class FliDriver:
             ValueError: If setting of exposure time failed.
         """
 
+        cdef long exptime_c = exptime
+        cdef long res
+
         # set exptime
-        res = FLISetExposureTime(self._device, exptime)
+        with nogil:
+            res = FLISetExposureTime(self._device, exptime_c)
         if res != 0:
             raise ValueError('Could not set exposure time.')
 
@@ -247,16 +294,19 @@ cdef class FliDriver:
             ValueError: If starting the exposure failed.
         """
 
+        cdef long res
+
         # expose
-        res = FLIExposeFrame(self._device)
+        with nogil:
+            res = FLIExposeFrame(self._device)
         if res != 0:
             raise ValueError('Could not start exposure.')
 
-    def is_exposing(self) -> bool:
-        """Checks, whether the camera is currently exposing
+    def is_data_ready(self) -> bool:
+        """Checks, whether the camera has finished exposing and the image data is ready to be read out.
 
         Returns:
-            bool: Whether camera is currently exposing.
+            bool: Whether data is ready.
 
         Raises:
             ValueError: If fetching device or exposure status failed.
@@ -264,12 +314,15 @@ cdef class FliDriver:
 
         # variables
         cdef long status, timeleft
+        cdef long res
 
         # get status
-        res = FLIGetDeviceStatus(self._device, &status)
+        with nogil:
+            res = FLIGetDeviceStatus(self._device, &status)
         if res != 0:
             raise ValueError('Could not fetch device status.')
-        res = FLIGetExposureStatus(self._device, &timeleft)
+        with nogil:
+            res = FLIGetExposureStatus(self._device, &timeleft)
         if res != 0:
             raise ValueError('Could not fetch remaining exposure time.')
 
@@ -292,9 +345,12 @@ cdef class FliDriver:
 
         # variables
         cdef double temp
+        cdef flichannel_t channel_c = channel.value
+        cdef long res
 
         # get it
-        res = FLIReadTemperature(self._device, channel.value, &temp)
+        with nogil:
+            res = FLIReadTemperature(self._device, channel_c, &temp)
         if res != 0:
             raise ValueError('Could not fetch temperature.')
 
@@ -313,9 +369,11 @@ cdef class FliDriver:
 
         # variables
         cdef double power
+        cdef long res
 
         # get it
-        res = FLIGetCoolerPower(self._device, &power)
+        with nogil:
+            res = FLIGetCoolerPower(self._device, &power)
         if res != 0:
             raise ValueError('Could not fetch cooler power.')
 
@@ -340,9 +398,12 @@ cdef class FliDriver:
 
         # get pointer to data
         cdef void* row_data = <void*> row.data
+        cdef size_t width_c = width
+        cdef long res
 
         # call library
-        res = FLIGrabRow(self._device, row_data, width)
+        with nogil:
+            res = FLIGrabRow(self._device, row_data, width_c)
         if res != 0:
             raise ValueError('Could not grab row from camera.')
 
@@ -356,7 +417,9 @@ cdef class FliDriver:
             ValueError: If canceling failed.
 
         """
-        res = FLICancelExposure(self._device)
+        cdef long res
+        with nogil:
+            res = FLICancelExposure(self._device)
         if res != 0:
             raise ValueError('Could not cancel exposure.')
 
@@ -369,7 +432,10 @@ cdef class FliDriver:
         Raises:
             ValueError: If setting temperature failed.
         """
-        res = FLISetTemperature(self._device, setpoint)
+        cdef double setpoint_c = setpoint
+        cdef long res
+        with nogil:
+            res = FLISetTemperature(self._device, setpoint_c)
         if res != 0:
             raise ValueError('Could not set temperature.')
 
@@ -383,9 +449,11 @@ cdef class FliDriver:
         # variables
         cdef char *model
         cdef size_t len
+        cdef long res
 
         # get it
-        res = FLIGetModel(self._device, model, len)
+        with nogil:
+            res = FLIGetModel(self._device, model, len)
         if res != 0:
             raise ValueError('Could not fetch model.')
 
@@ -397,9 +465,11 @@ cdef class FliDriver:
 
         # variables
         cdef char serial[1024]
+        cdef long res
 
         # get it
-        res = FLIGetSerialString(self._device, <char*>serial, 1024)
+        with nogil:
+            res = FLIGetSerialString(self._device, <char*>serial, 1024)
         if res != 0:
             raise ValueError('Could not fetch serial string.')
 
@@ -415,9 +485,11 @@ cdef class FliDriver:
 
         # variables
         cdef long pos
+        cdef long res
 
         # get it
-        res = FLIGetFilterPos(self._device, &pos)
+        with nogil:
+            res = FLIGetFilterPos(self._device, &pos)
         if res != 0:
             raise ValueError('Could not fetch filter position.')
 
@@ -431,8 +503,12 @@ cdef class FliDriver:
             pos: New filter position.
         """
 
+        cdef long pos_c = pos
+        cdef long res
+
         # set filter pos
-        res = FLISetFilterPos(self._device, pos)
+        with nogil:
+            res = FLISetFilterPos(self._device, pos_c)
         if res != 0:
             raise ValueError('Could not set filter position.')
 
@@ -443,8 +519,12 @@ cdef class FliDriver:
             wheel: Number of wheel to set active.
         """
 
+        cdef long wheel_c = wheel
+        cdef long res
+
         # set active filter wheel
-        res = FLISetActiveWheel(self._device, wheel)
+        with nogil:
+            res = FLISetActiveWheel(self._device, wheel_c)
         if res != 0:
             raise ValueError('Could not set active filter wheel.')
 
@@ -457,9 +537,11 @@ cdef class FliDriver:
 
         # variables
         cdef long wheel
+        cdef long res
 
         # get active filter wheel
-        res = FLIGetActiveWheel(self._device, &wheel)
+        with nogil:
+            res = FLIGetActiveWheel(self._device, &wheel)
         if res != 0:
             raise ValueError('Could not fetch active filter wheel.')
         return wheel
@@ -473,9 +555,11 @@ cdef class FliDriver:
 
         # variables
         cdef long count
+        cdef long res
 
         # get active filter wheel
-        res = FLIGetFilterCount(self._device, &count)
+        with nogil:
+            res = FLIGetFilterCount(self._device, &count)
         if res != 0:
             raise ValueError('Could not fetch filter count.')
         return count
@@ -491,9 +575,12 @@ cdef class FliDriver:
 
         # variables
         cdef char name[100]
+        cdef long pos_c = pos
+        cdef long res
 
         # get it
-        res = FLIGetFilterName(self._device, pos, <char*>name, 100)
+        with nogil:
+            res = FLIGetFilterName(self._device, pos_c, <char*>name, 100)
         if res != 0:
             raise ValueError('Could not fetch filter name.')
 

{pyobs_fli-2.0.0.dev6 → pyobs_fli-2.0.0.dev9}/pyobs_fli/libfli.pxd

@@ -1,4 +1,4 @@
-cdef extern from "../lib/libfli.h":
+cdef extern from "../lib/libfli.h" nogil:
     # An opaque handle used by library functions to refer to FLI
     # hardware.
     cdef int FLI_INVALID_DEVICE

{pyobs_fli-2.0.0.dev6 → pyobs_fli-2.0.0.dev9}/pyproject.toml

@@ -1,9 +1,9 @@
 [project]
 name = "pyobs-fli"
-version = "2.0.0.dev6"
+version = "2.0.0.dev9"
 description = "pyobs module for FLI cameras"
 authors = [{ name = "Tim-Oliver Husser", email = "thusser@uni-goettingen.de" }]
-requires-python = ">=3.11,<3.14"
+requires-python = ">=3.11"
 license = "MIT"
 dependencies = [
     "astropy>=7.0.1,<9",
@@ -22,6 +22,15 @@ dev = [
 [tool.scikit-build]
 wheel.packages = ["pyobs_fli"]
 
+[tool.cibuildwheel]
+build = "cp311-* cp312-* cp313-* cp314-*"
+skip = "*-musllinux_* *-manylinux_i686"
+archs = ["x86_64"]
+
+[tool.cibuildwheel.linux]
+manylinux-x86_64-image = "manylinux_2_28"
+before-all = "dnf install -y epel-release && dnf install -y cfitsio-devel"
+
 [build-system]
 requires = ["scikit_build_core>=0.12", "cython>=3.0", "cython-cmake", "numpy>=2.0"]
 build-backend = "scikit_build_core.build"

pyobs_fli-2.0.0.dev9/specs/plans/2026-08-16-nogil-fli-driver-calls.md

@@ -0,0 +1,106 @@
+# Plan: Release the GIL around libfli calls
+
+Status: implemented
+
+Tracks: https://github.com/pyobs/pyobs-fli/issues/75
+
+## Problem
+
+A hung FLI device freezes the whole module, including XMPP. `FliBaseMixin._run_blocking`
+(`pyobs_fli/flibase.py`) already runs every libfli call in a daemon thread bounded by
+`asyncio.wait_for(..., timeout=5.0)`, which is the fix that worked for the same blocking-call
+shape in `pyobs-aravis`/`pyobs-asi` (see `pyobs-core/specs/steering/
+blocking-sdk-calls-must-not-run-on-the-event-loop.md`). It doesn't work here, because
+`libfli.pxd` declares `FLIOpen`, `FLIGetReadoutDimensions`, etc. without `nogil`. Cython calls
+into a non-`nogil` C function while still holding the GIL, so when the call blocks (unresponsive
+USB device), the daemon thread holds the GIL for the entire hang. The event loop thread cannot
+run *anything* on that GIL, including the `asyncio.wait_for` timeout machinery meant to bound the
+call. The timeout never fires; the module goes fully unresponsive (observed: `fli230` stopped
+answering `disco#info`, every peer logged repeated capability-fetch timeouts).
+
+## Decision
+
+Mark the libfli C functions `nogil` in `libfli.pxd`, and wrap each call site in
+`flidriver.pyx` in `with nogil:` so the GIL is actually released while the call runs. This
+restores the daemon-thread timeout's ability to fire, since the event loop thread can run while
+the SDK call blocks.
+
+Considered and rejected: running FLI calls in a subprocess (the issue's "more robust, heavier"
+alternative). Rejected for this pass because it's a much larger change (IPC, serialization of
+buffers for `grab_row`, process lifecycle management) for the same practical outcome. Worth
+reconsidering only if a `with nogil:` call turns out to still wedge somehow (e.g. libfli itself
+deadlocks internally in a way that isn't a simple blocking wait).
+
+## Design
+
+### `libfli.pxd`
+
+Change the whole `cdef extern from "../lib/libfli.h":` block to
+`cdef extern from "../lib/libfli.h" nogil:`. This marks every declared function `nogil` at once,
+including ones not yet called from `flidriver.pyx`, so new call sites added later don't silently
+regress. Safe for the whole block: libfli is a pure hardware-I/O C library, none of its functions
+take a Python object or call back into the interpreter.
+
+### `flidriver.pyx`
+
+`nogil` only changes what's *allowed* inside `with nogil:` — it does not by itself move existing
+calls off the GIL. Every call site needs a `with nogil:` around the actual `FLI*(...)` call, and
+anything inside that block that isn't a C primitive has to move outside it first:
+
+- **Enum/typed-arg values** (`device_type.value`, `channel.value`, and `int`/`bool`-annotated
+  Python parameters like `pos`, `wheel`, `x`, `y`, `left`, `exptime`, `open_shutter`): read into a
+  local `cdef` C variable before the `with nogil:` block, since attribute access and Python->C
+  unboxing both touch the GIL.
+- **`self._device_info.filename` / `.domain`** (used in `open()`): same issue — read into local
+  `cdef` variables (`bytes` for filename, kept alive as a local so the underlying buffer stays
+  valid for the duration of the block; `flidomain_t` for domain) before entering `with nogil:`.
+- **`self._device`**: no change needed. It's a C-typed (`cdef flidev_t`) field of a `cdef class`,
+  so reading it inside `with nogil:` is a direct field access, not a Python attribute lookup.
+- **`list_devices()`**: the `while` loop currently interleaves a C call (`FLIListNext`) with a
+  Python-level `devices.append(...)`. Put just the C call in its own `with nogil:` per iteration
+  (accepted GIL-flip overhead — this runs at most a few times per `open()`, not in a hot loop);
+  the list bookkeeping stays under the GIL.
+- **`grab_row()`**: `row_data` is already computed (as a raw pointer) before the call — just wrap
+  the `FLIGrabRow` call itself; no reordering needed.
+
+Cython raises a compile-time error for any Python-object touch inside a `with nogil:` block, so
+this is self-checking: if an extraction is missed, `cython --cplus` on `flidriver.pyx` fails
+before any build/link step.
+
+### Verification
+
+No existing test suite exercises the Cython extension (`pyobs-fli` has no `tests/` at all — a
+hardware driver with no way to run libfli calls without real hardware). Verification is:
+
+1. `cython --cplus` compiles `flidriver.pyx` clean (catches any missed nogil extraction as a hard
+   error, not just a lint).
+2. Full `cmake`/`scikit-build-core` build succeeds and the resulting `.so` imports.
+3. Manual read-through confirming every `FLI*` call site in the diff is inside a `with nogil:`
+   block, and that nothing added to `libfli.pxd`'s `nogil` block passes a Python object by
+   reference to a C function that could retain/mutate it — none of the current API does.
+
+No hardware-in-the-loop test is possible from here; actual freeze recovery on a hung `fli230` can
+only be confirmed on-site.
+
+## Out of scope (flagged, not fixed here)
+
+- `get_model()` in `flidriver.pyx` (~line 320) passes `model` and `len` to `FLIGetModel`
+  uninitialized (`cdef char *model` / `cdef size_t len`, never assigned before the call) — this
+  writes through a garbage pointer with a garbage length. Pre-existing bug, unrelated to the GIL
+  issue. Should be filed and fixed separately (needs a real fixed-size buffer, same shape as
+  `get_serial_string()`/`get_filter_name()`).
+- `pyobs-flipro` has the structurally identical bug (no `_run_blocking` wrapper at all yet, let
+  alone `nogil`) — separate issue/PR in that repo, not touched here.
+
+## Implementation checklist
+
+- [x] `libfli.pxd`: add `nogil` to the `cdef extern from "../lib/libfli.h":` line.
+- [x] `flidriver.pyx`: wrap every `FLI*` call site in `with nogil:`, hoisting Python-object/typed-arg
+      reads above the block as described in Design.
+- [x] `cython --cplus pyobs_fli/flidriver.pyx -I pyobs_fli` compiles with no errors (only the
+      pre-existing, separately-flagged `get_model()` uninitialized-variable warning).
+- [x] Full build (`uv sync`) succeeds; `import pyobs_fli.flidriver` works and
+      `FliDriver.list_devices()` runs cleanly through the new `nogil` code path.
+- [x] Open a PR against `develop` (matches this repo's branch convention — dependabot/feature PRs
+      land on `develop`, which then gets version-bumped into `main`). Merged as #76.
+- [x] Update this doc's `Status:` to `implemented` once merged.