pytktable 0.1.0__tar.gz → 0.2.0__tar.gz

{pytktable-0.1.0 → pytktable-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytktable
-Version: 0.1.0
+Version: 0.2.0
 Summary: A spreadsheet-like table widget for tkinter, wrapping the Tcl/Tk Tktable extension.
 License-Expression: BSD-2-Clause
 License-File: LICENSE.md
@@ -27,6 +27,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: 3.15
+Classifier: Typing :: Typed
 Project-URL: Documentation, https://nbro.github.io/tktable/
 Project-URL: Repository, https://github.com/nbro/tktable
 Project-URL: changelog, https://github.com/nbro/tktable/blob/main/CHANGELOG.md
@@ -44,8 +45,33 @@ Description-Content-Type: text/markdown
 A spreadsheet-like table widget for tkinter, wrapping the Tcl/Tk
 [Tktable](https://wiki.tcl-lang.org/page/Tktable) extension.
 
+> ⚠️ **Important:** pytktable is only the Python wrapper. The table widget itself is
+> [Tktable](https://wiki.tcl-lang.org/page/Tktable), an extension for Tcl/Tk written in C, which
+> `pip install pytktable` does not install. Install Tktable first, following the
+> [installation instructions](https://nbro.github.io/tktable/installation/) for your OS, then run
+> `python -m tktable` to check that it works.
+
 The wrapper was originally written by [Guilherme Polo](https://github.com/gpip).
 
+![A window with a table of the 8 planets of the Solar System, made with pytktable](https://raw.githubusercontent.com/nbro/tktable/main/docs/images/planets.png)
+
+The [example](https://nbro.github.io/tktable/usage.html) above shows the planets of the Solar
+System, from NASA's Planetary Fact Sheet (screenshot taken on Windows 11).
+
+## Features
+
+- Spreadsheet-like tables with title rows and columns, editable cells, and keyboard navigation.
+- Cell values kept in an `ArrayVar` (a Tcl array), or computed on demand by a callback.
+- Styling with tags: colors, fonts, alignment and relief, for single cells, rows or columns.
+- Merged cells (spans), embedded widgets, and resizable rows and columns.
+- Cells that flash when their value changes, with a color of your choice.
+- Selection of cells, rows or columns; inserting and deleting rows and columns.
+- Callbacks when the active cell changes, to compute cell values, to validate edits, and to
+  format the selection when it is copied.
+- Works on Linux, macOS and Windows, with Python 3.11 or later and Tcl/Tk 8.6 or 9.0, once
+  Tcl/Tk (usually bundled with Python) and the Tktable extension are [installed](https://nbro.github.io/tktable/installation/).
+- `python -m tktable` checks that Tktable can be found and loaded.
+
 ## Installation
 
 ```sh

pytktable-0.2.0/README.md

@@ -0,0 +1,60 @@
+# pytktable
+
+[![PyPI](https://img.shields.io/pypi/v/pytktable)](https://pypi.org/project/pytktable/)
+[![Python](https://img.shields.io/pypi/pyversions/pytktable)](https://pypi.org/project/pytktable/)
+[![Tests](https://github.com/nbro/tktable/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/nbro/tktable/actions/workflows/tests.yml)
+[![Docs](https://github.com/nbro/tktable/actions/workflows/docs.yml/badge.svg?branch=main)](https://nbro.github.io/tktable/)
+[![License](https://img.shields.io/badge/license-BSD%202--Clause-orange.svg)](LICENSE.md)
+
+A spreadsheet-like table widget for tkinter, wrapping the Tcl/Tk
+[Tktable](https://wiki.tcl-lang.org/page/Tktable) extension.
+
+> ⚠️ **Important:** pytktable is only the Python wrapper. The table widget itself is
+> [Tktable](https://wiki.tcl-lang.org/page/Tktable), an extension for Tcl/Tk written in C, which
+> `pip install pytktable` does not install. Install Tktable first, following the
+> [installation instructions](https://nbro.github.io/tktable/installation/) for your OS, then run
+> `python -m tktable` to check that it works.
+
+The wrapper was originally written by [Guilherme Polo](https://github.com/gpip).
+
+![A window with a table of the 8 planets of the Solar System, made with pytktable](https://raw.githubusercontent.com/nbro/tktable/main/docs/images/planets.png)
+
+The [example](https://nbro.github.io/tktable/usage.html) above shows the planets of the Solar
+System, from NASA's Planetary Fact Sheet (screenshot taken on Windows 11).
+
+## Features
+
+- Spreadsheet-like tables with title rows and columns, editable cells, and keyboard navigation.
+- Cell values kept in an `ArrayVar` (a Tcl array), or computed on demand by a callback.
+- Styling with tags: colors, fonts, alignment and relief, for single cells, rows or columns.
+- Merged cells (spans), embedded widgets, and resizable rows and columns.
+- Cells that flash when their value changes, with a color of your choice.
+- Selection of cells, rows or columns; inserting and deleting rows and columns.
+- Callbacks when the active cell changes, to compute cell values, to validate edits, and to
+  format the selection when it is copied.
+- Works on Linux, macOS and Windows, with Python 3.11 or later and Tcl/Tk 8.6 or 9.0, once
+  Tcl/Tk (usually bundled with Python) and the Tktable extension are [installed](https://nbro.github.io/tktable/installation/).
+- `python -m tktable` checks that Tktable can be found and loaded.
+
+## Installation
+
+```sh
+pip install pytktable
+```
+
+It is imported as `tktable` (`from tktable import Table`). It also needs the Tktable extension,
+which `pip` does not install: see [Installation](https://nbro.github.io/tktable/installation/)
+for how to install it on your OS, and run `python -m tktable` to check that it works.
+
+## Documentation
+
+<https://nbro.github.io/tktable/>: usage, API reference, development and releasing.
+
+## License
+
+[BSD 2-Clause](LICENSE.md).
+
+Copyright (c) 2008, Guilherme Polo\
+Copyright (c) 2016-2026, nbro
+
+See the [changelog](CHANGELOG.md) for what changed in this fork.

{pytktable-0.1.0 → pytktable-0.2.0}/pyproject.toml

@@ -4,7 +4,7 @@
 
 [project]
 name = "pytktable"
-version = "0.1.0"
+version = "0.2.0"
 description = "A spreadsheet-like table widget for tkinter, wrapping the Tcl/Tk Tktable extension."
 readme = "README.md"
 requires-python = ">=3.11"
@@ -36,6 +36,7 @@ classifiers = [
     "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: 3.14",
     "Programming Language :: Python :: 3.15",
+    "Typing :: Typed",
 ]
 dependencies = []
 
@@ -84,6 +85,11 @@ line_length = 100
 [tool.mypy]
 python_version = "3.11"
 files = ["tktable"]
+# Every function in the library must have type hints (#21).
+disallow_untyped_defs = true
+disallow_incomplete_defs = true
+check_untyped_defs = true
+warn_return_any = false
 warn_unused_ignores = true
 warn_redundant_casts = true
 
@@ -119,6 +125,7 @@ check_lock = { cmd = "poetry check --lock", help = "Check that poetry.lock is co
 check_types = { cmd = "mypy", help = "Run type checks" }
 check_style = { cmd = "pylint tktable tests examples", help = "Run style checks" }
 build = { cmd = "poetry build", help = "Build the sdist and wheel into dist/" }
+update_example_data = { cmd = "python examples/data/update_planets.py", help = "Download the example's planets data from NASA again" }
 clean = { cmd = "git clean -fdX dist docs/_build .pytest_cache .mypy_cache .coverage tktable tests examples", help = "Remove build and test artifacts, including the built docs" }
 
 [tool.poe.tasks.format]

{pytktable-0.1.0 → pytktable-0.2.0}/tktable/__main__.py

@@ -32,7 +32,10 @@ def main() -> int:
     print(f"Tcl:       {interp.call('info', 'patchlevel')}")
     print(f"{TKTABLE_LIBRARY_ENV_VAR}: {os.environ.get(TKTABLE_LIBRARY_ENV_VAR, '(not set)')}")
     versions = find_tktable(interp)
-    print(f"auto_path: {interp.call('set', 'auto_path')}")
+    # One folder per line, as plain text (Tcl 9 returns them as "path objects").
+    print("auto_path:")
+    for folder in interp.tk.splitlist(interp.call("set", "auto_path")):
+        print(f"  {folder}")
     if not versions:
         print("Tktable:   NOT FOUND")
         print("See https://nbro.github.io/tktable/installation/")

pytktable-0.2.0/tktable/array_var.py

@@ -0,0 +1,63 @@
+"""ArrayVar, a tkinter variable for Tcl arrays, which a Table can store its cells in."""
+
+import tkinter
+from typing import Any
+
+from tktable.utils import _setup_master
+
+
+class ArrayVar(tkinter.Variable):
+    """A Tcl array, the usual store for a Table's cells (its variable option).
+
+    A Tcl array is an associative array, so this class supports some dict operations: cells are
+    keyed by "row,col" indices, e.g. ``cells["0,1"] = "Hello"``.
+    """
+
+    # Tkinter.Variable.__init__ is not called on purpose, so the array has no default value.
+    def __init__(  # pylint: disable=super-init-not-called
+        self, master: tkinter.Misc | None = None, name: str | None = None
+    ) -> None:
+        self._master = _setup_master(master)
+        self._tk = self._master.tk
+        self._name = name or f"PY_VAR{id(self)}"
+
+    def __del__(self) -> None:
+        if bool(self._tk.call("info", "exists", self._name)):
+            self._tk.globalunsetvar(self._name)
+
+    def __len__(self) -> int:
+        return int(self._tk.call("array", "size", str(self)))
+
+    def __getitem__(self, key: str) -> Any:
+        return self.get(key)
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.set(**{str(key): value})
+
+    def names(self) -> tuple[str, ...]:
+        """Return the keys (indices) of the array."""
+        return tuple(
+            str(name) for name in self._tk.splitlist(self._tk.call("array", "names", self._name))
+        )
+
+    def get(self, key: str | None = None) -> Any:
+        """Return the value at key, or all the array as a dict if key is None."""
+        if key is None:
+            # splitlist: tkinter may return the Tcl list as a Tcl_Obj, which can't be sliced.
+            flatten_pairs = self._tk.splitlist(self._tk.call("array", "get", str(self)))
+            return dict(zip(flatten_pairs[::2], flatten_pairs[1::2]))
+        return self._tk.globalgetvar(str(self), str(key))
+
+    # Unlike tkinter.Variable.set(value), this sets several keys at once.
+    def set(self, **kw: Any) -> None:  # type: ignore[override]  # pylint: disable=arguments-differ
+        """Set the values of the given keys, e.g. ``set(**{"0,0": "a", "0,1": "b"})``."""
+        flattened = tuple(item for pair in kw.items() for item in pair)
+        self._tk.call("array", "set", str(self), flattened)
+
+    def unset(self, pattern: str | None = None) -> None:
+        """Unsets all of the elements in the array. If pattern is given, only
+        the elements that match pattern are unset."""
+        if pattern is None:
+            self._tk.call("array", "unset", str(self))
+        else:
+            self._tk.call("array", "unset", str(self), pattern)