Merge pull request #512 from ZLLentz/v2.3.2-rel

DOC: write release notes for v2.3.2

conda-recipe/meta.yaml

@@ -33,8 +33,10 @@ requirements:
     - qtpy
     - timechart >=1.2.4
   run_constrained:
+    - happi >=1.14.0
     - jupyter_client <7.3.2
 
+
 about:
   home: https://github.com/pcdshub/typhos
   doc_url: https://pcdshub.github.io/typhos

dev-requirements.txt

@@ -3,6 +3,7 @@ doctr
 doctr-versions-menu
 flake8
 ipython>=7.16
+jinja2<3.1
 line_profiler
 pytest
 pytest-benchmark

docs/source/release_notes.rst

@@ -2,6 +2,39 @@
  Release History
 =================
 
+v2.3.2 (2022-07-28)
+===================
+
+Description
+-----------
+This is a bugfix and maintenance release.
+
+Fixes
+-----
+- Fix various instances of clipping in the positioner widget.
+- Show Python documentation when no web help is available.
+- Fix issues with suite sidebar width.
+- Lazy load all tools to improve performance.
+- Fix the profiler to also profile class methods.
+- Use cached paths for finding class templates.
+- Properly handle various deprecations and deprecation warnings.
+- Fix usage of deprecated methods in happi (optional dependency).
+
+Maintenance
+-----------
+- Log "unable to add device" without the traceback, which was previously unhelpful.
+- Pin pyqt at 5.12 for test suite incompatibility in newer versions.
+- Ensure that test.qss test suite artifact is cleaned up properly.
+- Fix the broken test suite.
+- Pin jinja2 at <3.1 in CI builds for sphinx <4.0.0 compatibility
+
+Contributors
+------------
+- anleslac
+- klauer
+- zllentz
+
+
 v2.3.1 (2022-05-02)
 ===================
 

typhos/plugins/happi.py

@@ -43,7 +43,7 @@ def add_listener(self, channel):
         else:
             device, child = self.address, None
         # Load the device from the Client
-        md = HappiClientState.client.find_device(name=device)
+        md = HappiClientState.client.find_item(name=device)
         obj = from_container(md)
         md = md.post()
         # If we have a child grab it

typhos/tests/happi.cfg

@@ -1,2 +1,2 @@
 [DEFAULT]
-path=typhos/tests/happi.json
+path=happi.json

typhos/tests/test_alarm.py

@@ -106,7 +106,7 @@ def fake_client():
 
 
 class FakeClient:
-    def find_device(self, *args, name, **kwargs):
+    def find_item(self, *args, name, **kwargs):
         return HappiItem(
             name=name,
             device_class='typhos.tests.test_alarm.SimpleDevice',
@@ -117,7 +117,7 @@ def find_device(self, *args, name, **kwargs):
 @pytest.mark.parametrize("metadata,response", alarm_cases)
 def test_one_alarm_happi_ch(alarm, qtbot, metadata, response, fake_client):
     name = 'happi_test_device_' + str(uuid4()).replace('-', '_')
-    item = fake_client.find_device(name=name)
+    item = fake_client.find_item(name=name)
     device = from_container(item)
 
     with qtbot.wait_signal(alarm.alarm_changed, timeout=1000):

typhos/tests/test_widgets.py

@@ -25,10 +25,9 @@ def widget_button(qtbot, monkeypatch):
     return button
 
 
-def test_sidebar_item(qtbot):
+def test_sidebar_item():
     param = SidebarParameter(name='test', embeddable=True)
     item = TyphosSidebarItem(param, 0)
-    qtbot.addWidget(item)
     assert len(item.toolbar.actions()) == 3
     assert item.open_action.isEnabled()
     assert item.embed_action.isEnabled()

typhos/utils.py

@@ -743,7 +743,7 @@ def code_from_device(device):
 import happi
 from happi.loader import from_container
 client = happi.Client.from_config()
-md = client.find_device(name="{happi_name}")
+md = client.find_item(name="{happi_name}")
 {device.name} = from_container(md)
 '''