pgwidgets-python 0.4.0__tar.gz → 0.4.1__tar.gz

{pgwidgets_python-0.4.0 → pgwidgets_python-0.4.1}/.github/workflows/tests.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.12", "3.13"]
+        python-version: ["3.12", "3.13", "3.14"]
 
     steps:
       - uses: actions/checkout@v4

{pgwidgets_python-0.4.0 → pgwidgets_python-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pgwidgets-python
-Version: 0.4.0
+Version: 0.4.1
 Summary: Python bindings for the pgwidgets JavaScript widget library
 Author: PGWidgets Developers
 License-Expression: BSD-3-Clause
@@ -12,11 +12,12 @@ Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: User Interfaces
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
-Requires-Dist: pgwidgets-js>=0.4.0
+Requires-Dist: pgwidgets-js>=0.4.1
 Requires-Dist: websockets>=12
 Provides-Extra: dev
 Requires-Dist: sphinx; extra == "dev"

{pgwidgets_python-0.4.0 → pgwidgets_python-0.4.1}/docs/WhatsNew.rst

@@ -1,6 +1,29 @@
 What's New
 ==========
 
+Recent changes — since ``v0.4.0``
+---------------------------------
+
+TextSource: scroll alignment and caret styling
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+``scroll_to_ref(ref, align)`` and ``scroll_to_lineno(lineno, align)``
+take an alignment -- ``'nearest'`` (the default, as before),
+``'center'`` or ``'top'`` -- and pass it to the browser alongside the
+offset.  A search that scrolls to its match can now put the match in
+the middle of the view rather than merely bringing it into sight.
+
+``set_cursor_style(style, color)`` picks a ``'line'`` or ``'block'``
+caret in any colour, and ``get_cursor_style()`` reads the pair back.
+The choice is part of the model, replayed from
+``_reconstruct_model()``, so a browser that (re)connects gets the caret
+along with everything else.  It is styled through the browser's own
+``caret-color`` / ``caret-shape``, so it shows only while the editor
+has the focus.
+
+These need the matching methods in pgwidgets-js 0.4.1, which the
+dependency floor now requires.
+
 Recent changes — since ``v0.3.5``
 ---------------------------------
 
@@ -156,7 +179,7 @@ the 4th argument, so handlers that double-click a file can see
 which column they hit.  Existing handlers (3-arg) keep working.
 
 ``_resolve_kwargs``: skipped-positional kwargs
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The kwarg resolver used by every generated widget method now
 allows a caller to skip a positional argument and supply the

{pgwidgets_python-0.4.0 → pgwidgets_python-0.4.1}/docs/sync.rst

@@ -114,8 +114,8 @@ Bytes are served from ``/_pgwidgets/font/<id>`` by the built-in
 HTTP server with ``Cache-Control: immutable``; behind Flask /
 nginx the same route is served from the Python process.
 
-See also the JS-side write-up at :ref:`custom-fonts` in the
-pgwidgets-js documentation.
+See also the "Custom fonts" section of the pgwidgets-js
+documentation for the browser side of this.
 
 Opening a URL in the browser
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

{pgwidgets_python-0.4.0 → pgwidgets_python-0.4.1}/pgwidgets/sync/text_source.py

@@ -29,6 +29,13 @@ from pgwidgets.text_model import TextModel
 _GeneratedTextSource = build_widget_class("TextSource", WIDGETS["TextSource"])
 
 
+def _check_align(align):
+    if align not in ('nearest', 'center', 'top'):
+        raise ValueError("align should be one of 'nearest', 'center' "
+                         "or 'top'")
+    return align
+
+
 class _BrowserTextModel(TextModel):
     """A TextModel whose render hooks push offset-based operations to the
     browser via the owning widget.  When no browser is connected the calls
@@ -118,6 +125,8 @@ class TextSource(_GeneratedTextSource):
         text = self._state.get("text")
         self._model._text = "" if text is None else str(text)
         self._state.pop("text", None)
+        # caret appearance (see set_cursor_style); replayed on reconnect
+        self._cursor_style = ('line', None)
 
     def create_tag(self, name, attrs=None, **kwdargs):
         """Define a display tag locally and push its styling to the browser."""
@@ -126,18 +135,46 @@ class TextSource(_GeneratedTextSource):
         self._model.create_tag(name, merged)
         self._call("create_tag", name, merged)
 
-    def scroll_to_ref(self, ref):
-        """Scroll the view to a ref, addressed by its current offset."""
-        self._call("_scrollToOffset", self._model._offset_of(ref))
+    def scroll_to_ref(self, ref, align='nearest'):
+        """Scroll the view to a ref, addressed by its current offset.
 
-    def scroll_to_lineno(self, lineno):
-        """Scroll so that line ``lineno`` is visible."""
+        ``align`` says where the line should end up: 'nearest' scrolls the
+        least amount that brings it into view (the default), 'center' puts
+        it in the middle of the view and 'top' at the top.
+        """
+        self._call("_scrollToOffset", self._model._offset_of(ref),
+                   _check_align(align))
+
+    def scroll_to_lineno(self, lineno, align='nearest'):
+        """Scroll so that line ``lineno`` is visible; see
+        ``scroll_to_ref`` for ``align``."""
         self._call("_scrollToOffset",
-                   self._model._offset_of_line_start(lineno))
+                   self._model._offset_of_line_start(lineno),
+                   _check_align(align))
 
     def scroll_to_end(self):
         """Scroll to the end of the buffer."""
-        self._call("_scrollToOffset", self._model.get_length())
+        self._call("_scrollToOffset", self._model.get_length(), 'nearest')
+
+    def set_cursor_style(self, style='line', color=None):
+        """Set the appearance of the text caret.
+
+        ``style`` is 'line' (a thin vertical bar, the default) or 'block';
+        ``color`` is any CSS color, or None for the browser default.
+
+        NOTE: this styles the browser's own caret, so it is only drawn
+        while the editor has the keyboard focus, and the block shape needs
+        a browser that supports the CSS 'caret-shape' property (elsewhere
+        the caret keeps its color but stays a thin bar).
+        """
+        if style not in ('line', 'block'):
+            raise ValueError("style should be one of 'line' or 'block'")
+        self._cursor_style = (style, color)
+        self._call("set_cursor_style", style, color)
+
+    def get_cursor_style(self):
+        """Return the caret appearance as a ``(style, color)`` pair."""
+        return self._cursor_style
 
     def show_tooltip(self, text, x, y):
         """Show a hover tooltip (``text``) near viewport point (x, y), or
@@ -182,6 +219,8 @@ class TextSource(_GeneratedTextSource):
             self._call("_setSelectionOffsets", m._sel_start, m._sel_end)
         else:
             self._call("_setCursorOffset", m._cursor)
+        if self._cursor_style != ('line', None):
+            self._call("set_cursor_style", *self._cursor_style)
 
 
 def _install_delegators():

{pgwidgets_python-0.4.0 → pgwidgets_python-0.4.1}/pgwidgets_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pgwidgets-python
-Version: 0.4.0
+Version: 0.4.1
 Summary: Python bindings for the pgwidgets JavaScript widget library
 Author: PGWidgets Developers
 License-Expression: BSD-3-Clause
@@ -12,11 +12,12 @@ Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: User Interfaces
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
-Requires-Dist: pgwidgets-js>=0.4.0
+Requires-Dist: pgwidgets-js>=0.4.1
 Requires-Dist: websockets>=12
 Provides-Extra: dev
 Requires-Dist: sphinx; extra == "dev"

{pgwidgets_python-0.4.0 → pgwidgets_python-0.4.1}/pgwidgets_python.egg-info/requires.txt

@@ -1,4 +1,4 @@
-pgwidgets-js>=0.4.0
+pgwidgets-js>=0.4.1
 websockets>=12
 
 [dev]

pgwidgets_python-0.4.1/pgwidgets_python.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "0.4.1",
+  "distance": 0,
+  "node": "gba8f2928171144dd56a747a75fb45722db1bd4d7",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-08-22"
+}

{pgwidgets_python-0.4.0 → pgwidgets_python-0.4.1}/pyproject.toml

@@ -14,14 +14,15 @@ authors = [
     {name = "PGWidgets Developers"},
 ]
 dependencies = [
-    # Tests and runtime expect the incremental TreeView/TableView updates
-    # and the "batch" / set_colors protocol messages — introduced in
-    # pgwidgets-js 0.4.0.  (Earlier requirements — the TextSource
-    # selection/tag-region and tooltip/scroll APIs, Separator,
-    # Button.set_hover, ButtonBox.min_button_width, Dialog.set_title
-    # date to 0.3.4; set_min_size/set_max_size, the dict-tree TreeView,
-    # the binary Image protocol, TopLevel window-control options to 0.2.0.)
-    "pgwidgets-js>=0.4.0",
+    # TextSource's scroll alignment and set_cursor_style() need the
+    # matching browser-side methods, introduced in pgwidgets-js 0.4.1.
+    # (Earlier requirements — the incremental TreeView/TableView updates
+    # and the "batch" / set_colors protocol messages date to 0.4.0; the
+    # TextSource selection/tag-region and tooltip/scroll APIs, Separator,
+    # Button.set_hover, ButtonBox.min_button_width, Dialog.set_title to
+    # 0.3.4; set_min_size/set_max_size, the dict-tree TreeView, the
+    # binary Image protocol, TopLevel window-control options to 0.2.0.)
+    "pgwidgets-js>=0.4.1",
     "websockets>=12",
 ]
 keywords = ["widgets", "ui", "gui", "websocket", "browser"]
@@ -31,6 +32,7 @@ classifiers = [
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
     "Topic :: Software Development :: User Interfaces",
 ]
 

{pgwidgets_python-0.4.0 → pgwidgets_python-0.4.1}/tests/test_text_source.py

@@ -5,6 +5,8 @@ replayed on connect), which is exactly the case that used to crash callers
 that queried refs during construction.
 """
 
+import pytest
+
 from pgwidgets.sync.Widgets import TextSource
 from pgwidgets.text_model import TextBufferRef
 
@@ -159,3 +161,56 @@ def test_reconstruct_pushes_full_state():
     assert sess.sent[0][1][0] == "abcdef"
     assert "create_tag" in methods
     assert "_restoreTagIntervals" in methods
+
+
+def test_scroll_alignment_rides_along_with_the_offset():
+    """A caller can ask for the target line to be centered rather than
+    merely brought into view."""
+    tw = _ts()
+    tw.insert_text(tw.get_ref_end(), "l0\nl1\nl2")
+    sess = tw._session
+    sess.sent.clear()
+
+    tw.scroll_to_lineno(2, align='center')
+    tw.scroll_to_ref(tw.get_ref_line_start(1), align='top')
+    tw.scroll_to_lineno(0)
+
+    calls = [m[1] for m in sess.sent if m[0] == "_scrollToOffset"]
+    assert calls == [[6, 'center'], [3, 'top'], [0, 'nearest']]
+
+
+def test_an_unknown_alignment_is_rejected():
+    tw = _ts()
+    with pytest.raises(ValueError):
+        tw.scroll_to_lineno(0, align='middle')
+
+
+def test_cursor_style_is_pushed_and_remembered():
+    tw = _ts()
+    sess = tw._session
+    assert tw.get_cursor_style() == ('line', None)
+    sess.sent.clear()
+
+    tw.set_cursor_style('block', color='indianred')
+
+    assert ("set_cursor_style", ['block', 'indianred']) in [
+        (m[0], m[1]) for m in sess.sent]
+    assert tw.get_cursor_style() == ('block', 'indianred')
+
+
+def test_cursor_style_is_replayed_to_a_reconnecting_browser():
+    tw = _ts()
+    tw.set_cursor_style('block', color='indianred')
+    sess = tw._session
+    sess.sent.clear()
+
+    tw._reconstruct_model()
+
+    assert ("set_cursor_style", ['block', 'indianred']) in [
+        (m[0], m[1]) for m in sess.sent]
+
+
+def test_an_unknown_cursor_style_is_rejected():
+    tw = _ts()
+    with pytest.raises(ValueError):
+        tw.set_cursor_style('underline')

pgwidgets_python-0.4.0/pgwidgets_python.egg-info/scm_version.json

@@ -1,8 +0,0 @@
-{
-  "tag": "0.4.0",
-  "distance": 0,
-  "node": "g5481e84d4ee1d988cdd6d7afbf05f4072640d67f",
-  "dirty": false,
-  "branch": "main",
-  "node_date": "2026-08-17"
-}