Bluesky

====================

Changed
-------
* ``zict`` is no longer a default dependency. There is a breaking API change
between zict2 and zict3 that fixed a race condition between multiple threads
using the same instance but broke using multiple instances in the same
process or multiple processes sharing the same files. ``PersistentDict`` is
not being removed, but is strongly discouraged for new use. To get the old pinning use
pip install bluesky[old_persistentdict]`` or install ``zict<3``.

======================

Added
-----

* Adopt DiamondLightSource Copier Template by callumforrester in https://github.com/bluesky/bluesky/pull/1664
* Add `__main__.py` and entrypoint for checking version info by jwlodek in https://github.com/bluesky/bluesky/pull/1699
* Include Python3.12 Classifier by callumforrester in https://github.com/bluesky/bluesky/pull/1719
* Adopt pydata documentation theme by AlexanderWells-diamond in https://github.com/bluesky/bluesky/pull/1706
* Vendor a copy of Super State Machine by genematx in https://github.com/bluesky/bluesky/pull/1708
* Callback to write documents to Tiled by genematx in https://github.com/bluesky/bluesky/pull/1660
* Add class and decorator to warn users if plan is not iterated over by vshekar in https://github.com/bluesky/bluesky/pull/1709
* Add collect_while_completing plan stub and test by jsouter in https://github.com/bluesky/bluesky/pull/1720
* Create a simulated run engine for unit testing by rtuck99 in https://github.com/bluesky/bluesky/pull/1714
* Expand `TiledWriter` by genematx in https://github.com/bluesky/bluesky/pull/1746

Changed
-------

* Alter kickoff and complete plan stubs to take multiple flyables by abbiemery in https://github.com/bluesky/bluesky/pull/1663
* Remove `object_plans.py` and associated test by DominicOram in https://github.com/bluesky/bluesky/pull/1696
* Promotes `warn_if_msg` to a `UserWarning` by CoePaul in https://github.com/bluesky/bluesky/pull/1705
* Removes fuzz in toto by CoePaul in https://github.com/bluesky/bluesky/pull/1710
* Dont collect interactive tests by gilesknap in https://github.com/bluesky/bluesky/pull/1703
* Remove nose package from dev dependencies list by Villtord in https://github.com/bluesky/bluesky/pull/1704
* Pin `sphinx<7.3` by callumforrester in https://github.com/bluesky/bluesky/pull/1717
* Expose API to set title on `LiveGrid` plots by GDYendell in https://github.com/bluesky/bluesky/pull/1702
* Remove unused `pims` library stan-dot in https://github.com/bluesky/bluesky/pull/1722
* Include details on wrappers in tutorial docs by stan-dot in https://github.com/bluesky/bluesky/pull/1729
* Use `tmp_path` instead of `tmpdir` fixture by jwlodek in https://github.com/bluesky/bluesky/pull/1730
* Replace `KeyError` handling logic by CoePaul in https://github.com/bluesky/bluesky/pull/1718
* Update for Tiled API change. by danielballan in https://github.com/bluesky/bluesky/pull/1748
* Update test for revised `StreamResource`. by danielballan in https://github.com/bluesky/bluesky/pull/1749
* Return the results of `asyncio.wait` in `bps.wait_for` by evalott100 in https://github.com/bluesky/bluesky/pull/1758

Fixed
-----

* Fix ruff formatting of strings by callumforrester in https://github.com/bluesky/bluesky/pull/1675
* `numpy==2.0` compatibility by tacaswell in https://github.com/bluesky/bluesky/pull/1672 and https://github.com/bluesky/bluesky/pull/1732
* Fix tests failing in devcontainer by gilesknap in https://github.com/bluesky/bluesky/pull/1700
* Relax timing as 2s is failing on CI on py311 only by tacaswell in https://github.com/bluesky/bluesky/pull/1707
* MacOS fix for failing tests in the `test_zmq.py` by skarakuzu in https://github.com/bluesky/bluesky/pull/1725
* Fixed `TiledWriter` bug by genematx in https://github.com/bluesky/bluesky/pull/1744

**Full Changelog**: https://github.com/bluesky/bluesky/compare/v1.13.0a3...v1.13.0a4

======================

Added
-----

* Support for collecitng from multiple detectors in the run bundler

======================

Added
-----

* `RunEngine.md_normalizer`, parallel to `md_validator`, which can _modify_ the metadata as
well as validate it.

======================

Added
-----

* Added a new prepare command to RunEngine and bundler, as well as protocol.
This allows a step between ``stage`` and ``kickoff`` so flyers can prepare.
by rosesyrett in https://github.com/bluesky/bluesky/pull/1639
* Add delay to plan_args of count plan by DiamondJoseph in https://github.com/bluesky/bluesky/pull/1655

Fixed
-----

* typing_extensions needs NotRequired (new 4.0.0) by maffettone in https://github.com/bluesky/bluesky/pull/1635
* Fixed examples in debugging docs by DominicOram in https://github.com/bluesky/bluesky/pull/1500
* Remove empty complete method from RunBundler by rosesyrett in https://github.com/bluesky/bluesky/pull/1644
* Handle case of rewinding to before the beginning of a stream by tacaswell in https://github.com/bluesky/bluesky/pull/1648

====================

Added
-----
* The `~bluesky.plan_stubs.wait` plan accepts a new optional parameter,
``timeout``.
* Add an option to contingency_wrapper to not automatically re-raise if the
except plan returns a value rather than raising its own exception.
* Add support for new experimental document types, StreamResource and
StreamDatum.

Changed
-------

* In v0.11.0 bluesky implemented a new Msg to declare streams proactively,
rather than creating them implicitly while preparing to emit the first Event.
Built-in plans were updated to use this approach. It had unintended downstream
consequences. Specifically, some ophyd objects (notable AD) that were using
the trigger method to sort out what the keys will be. If you call describe
before trigger you get different answers so going all-in on this by default
is a bit too aggressive. Pre-declaring streams is now opt-in, using the
env var ``BLUESKY_PREDECLARE``.
* Changed `~bluesky.bundlers` to use event-model compose functions
* In the run stop document, 'num_events' will now include streams even if
they have no events associated with them.
* Events produced by monitors are now checked against their corresponding Descriptor document.
* In the run stop document, 'num_changes' will now contain descriptors even if
they have no events associated with them.
* Events produced by monitors are now checked against their corresponding Descriptor document.
* If a collect message results in no document being collected, a `RuntimeError`
was being raised. Now, no error is raised; this is considered a possibility
in normal successful operation.

Fixed
-----

* Fixed leak in registry used by ``RE.subscribe``, which would grow without bound
* Fixed a documentation-build issue, which moved the minimum version of matplotlib
required for documentation-building to 3.5.0 (Nov 2021).
* Fixed bug in exception handling in ``msg_mutator``.