pytktable 0.1.0__tar.gz

pytktable-0.1.0/LICENSE.md

@@ -0,0 +1,19 @@
+# [The BSD 2-Clause License](https://opensource.org/licenses/BSD-2-Clause)
+
+Copyright (c) 2008, Guilherme Polo
+
+Copyright (c) 2016-2026, nbro
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+ * Redistributions of source code must retain the above copyright notice,
+   this list of conditions and the following disclaimer.
+
+ * Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+> THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

pytktable-0.1.0/PKG-INFO

@@ -0,0 +1,71 @@
+Metadata-Version: 2.4
+Name: pytktable
+Version: 0.1.0
+Summary: A spreadsheet-like table widget for tkinter, wrapping the Tcl/Tk Tktable extension.
+License-Expression: BSD-2-Clause
+License-File: LICENSE.md
+Keywords: tkinter,tk,tcl,table,tktable,widget,gui
+Author: Guilherme Polo
+Author-email: ggpolo@gmail.com
+Maintainer: nbro
+Maintainer-email: nbrosoftware@outlook.com
+Requires-Python: >=3.11
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: X11 Applications
+Classifier: Environment :: MacOS X
+Classifier: Environment :: Win32 (MS Windows)
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: User Interfaces
+Classifier: Topic :: Software Development :: Libraries :: Tcl Extensions
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+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
+Project-URL: issues, https://github.com/nbro/tktable/issues
+Description-Content-Type: text/markdown
+
+# 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.
+
+The wrapper was originally written by [Guilherme Polo](https://github.com/gpip).
+
+## 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/README.md

@@ -0,0 +1,35 @@
+# 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.
+
+The wrapper was originally written by [Guilherme Polo](https://github.com/gpip).
+
+## 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/pyproject.toml

@@ -0,0 +1,172 @@
+# ---------------------------------------------------------------------------------------------
+# Project metadata (PEP 621)
+# ---------------------------------------------------------------------------------------------
+
+[project]
+name = "pytktable"
+version = "0.1.0"
+description = "A spreadsheet-like table widget for tkinter, wrapping the Tcl/Tk Tktable extension."
+readme = "README.md"
+requires-python = ">=3.11"
+license = "BSD-2-Clause"
+license-files = ["LICENSE.md"]
+authors = [
+    { name = "Guilherme Polo", email = "ggpolo@gmail.com" },
+    { name = "nbro", email = "nbrosoftware@outlook.com" },
+]
+maintainers = [
+    { name = "nbro", email = "nbrosoftware@outlook.com" },
+]
+keywords = ["tkinter", "tk", "tcl", "table", "tktable", "widget", "gui"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: X11 Applications",
+    "Environment :: MacOS X",
+    "Environment :: Win32 (MS Windows)",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: User Interfaces",
+    "Topic :: Software Development :: Libraries :: Tcl Extensions",
+    "Operating System :: MacOS",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: POSIX :: Linux",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
+]
+dependencies = []
+
+[project.urls]
+documentation = "https://nbro.github.io/tktable/"
+repository = "https://github.com/nbro/tktable"
+changelog = "https://github.com/nbro/tktable/blob/main/CHANGELOG.md"
+issues = "https://github.com/nbro/tktable/issues"
+
+# ---------------------------------------------------------------------------------------------
+# Poetry: packaging and dependencies
+# ---------------------------------------------------------------------------------------------
+
+[tool.poetry]
+packages = [{ include = "tktable" }]
+
+[tool.poetry.group.dev.dependencies]
+black = "^26.10.1"
+isort = "^9.0.2"
+pylint = "^4.1.3"
+mypy = "^2.4.1"
+pytest = "^9.2.0"
+coverage = "^7.17.1"
+pre-commit = "^4.7.0"
+poethepoet = "^0.49.0"
+
+[tool.poetry.group.docs.dependencies]
+# Only for Python >= 3.13, which Sphinx 9.2 requires; CI builds the docs with 3.13.
+sphinx = { version = "^9.2.0", python = ">=3.13" }
+myst-parser = { version = "^5.1.0", python = ">=3.13" }
+furo = { version = "^2025.12.19", python = ">=3.13" }
+sphinx-copybutton = { version = "^0.5.2", python = ">=3.13" }
+
+# ---------------------------------------------------------------------------------------------
+# Tools: formatting, linting, type checking, testing, security
+# ---------------------------------------------------------------------------------------------
+
+[tool.black]
+line-length = 100
+target-version = ["py311"]
+
+[tool.isort]
+profile = "black"
+line_length = 100
+
+[tool.mypy]
+python_version = "3.11"
+files = ["tktable"]
+warn_unused_ignores = true
+warn_redundant_casts = true
+
+[tool.pylint.main]
+py-version = "3.11"
+
+[tool.pylint.format]
+max-line-length = 100
+
+[tool.pylint."messages control"]
+disable = ["fixme", "invalid-name"]
+enable = ["useless-suppression"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+markers = ["tktable: needs the Tktable Tcl/Tk extension"]
+
+[tool.coverage]
+run.source = ["tktable"]
+report.show_missing = true
+report.skip_covered = true
+
+[tool.bandit]
+exclude_dirs = ["tests"]
+
+# ---------------------------------------------------------------------------------------------
+# Poe the Poet: development commands. Run `poetry run poe` to list them.
+# ---------------------------------------------------------------------------------------------
+
+[tool.poe.tasks]
+check_tktable = { cmd = "python -m tktable", help = "Diagnose whether Tktable can be found and loaded" }
+check_lock = { cmd = "poetry check --lock", help = "Check that poetry.lock is consistent with pyproject.toml" }
+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/" }
+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]
+help = "Format Python (isort, black)"
+sequence = [{ cmd = "isort tktable tests examples" }, { cmd = "black tktable tests examples" }]
+
+[tool.poe.tasks.check_format]
+help = "Check that the code is formatted"
+sequence = [{ cmd = "isort --check --diff tktable tests examples" }, { cmd = "black --check --diff tktable tests examples" }]
+
+[tool.poe.tasks.check]
+help = "Run the quality checks: lock file, formatting, types, style"
+sequence = ["check_lock", "check_format", "check_types", "check_style"]
+
+[tool.poe.tasks.test]
+help = "Run the tests (on Linux without a display: xvfb-run -a poetry run poe test)"
+sequence = [{ cmd = "coverage run -m pytest -v -rs" }, { cmd = "coverage report" }]
+
+[tool.poe.tasks.docs]
+help = "Build the docs into docs/_build/html (warnings are errors) and print the link to open them"
+sequence = [
+    { cmd = "sphinx-build -W --keep-going -b html docs docs/_build/html" },
+    { cmd = '''python -c "import pathlib; print('Docs:', pathlib.Path('docs/_build/html/index.html').resolve().as_uri())"''' },
+]
+
+[tool.poe.tasks.upgrade_dev_deps]
+help = "Upgrade the dev and docs dependencies to their latest versions"
+sequence = [
+    { cmd = "poetry add --group dev black@latest isort@latest pylint@latest mypy@latest pytest@latest coverage@latest pre-commit@latest poethepoet@latest" },
+    { cmd = "poetry add --group docs --python >=3.13 sphinx@latest myst-parser@latest furo@latest sphinx-copybutton@latest" },
+]
+
+[tool.poe.tasks.docker_test]
+help = "Run the tests in Debian and Ubuntu containers"
+sequence = ["docker_debian", "docker_ubuntu"]
+
+[tool.poe.tasks.docker_debian]
+help = "Run the tests in a Debian container"
+sequence = [{ cmd = "docker build -f docker/Dockerfile.debian -t tktable-test:debian ." }, { cmd = "docker run --rm tktable-test:debian" }]
+
+[tool.poe.tasks.docker_ubuntu]
+help = "Run the tests in an Ubuntu container"
+sequence = [{ cmd = "docker build -f docker/Dockerfile.ubuntu -t tktable-test:ubuntu ." }, { cmd = "docker run --rm tktable-test:ubuntu" }]
+
+# ---------------------------------------------------------------------------------------------
+# Build system
+# ---------------------------------------------------------------------------------------------
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"

pytktable-0.1.0/tktable/__init__.py

@@ -0,0 +1,36 @@
+"""A spreadsheet-like table widget for tkinter, wrapping the Tcl/Tk Tktable extension.
+
+Why the public classes are imported lazily
+------------------------------------------
+``python -m tktable`` (the diagnostic in ``__main__.py``) always imports this file first.
+``ArrayVar`` and ``Table`` import ``tkinter`` at module level, so importing them here
+eagerly would make the diagnostic crash with ``ModuleNotFoundError`` exactly when it is
+most needed: when tkinter is not installed.
+
+Instead, the module-level ``__getattr__`` below (PEP 562) imports them on first access, so
+``from tktable import Table`` works as usual, while ``python -m tktable`` never imports
+tkinter until it checks for it. The ``TYPE_CHECKING`` block is never executed, but lets
+type checkers, linters and IDEs see ``tktable.Table`` and ``tktable.ArrayVar``.
+"""
+
+from typing import TYPE_CHECKING, Any
+
+__all__ = ["ArrayVar", "Table"]
+
+if TYPE_CHECKING:
+    from tktable.array_var import ArrayVar
+    from tktable.table import Table
+
+
+def __getattr__(name: str) -> Any:
+    # Called only for attributes not yet defined in this module (see the module docstring).
+    # pylint: disable=import-outside-toplevel
+    if name == "ArrayVar":
+        from tktable.array_var import ArrayVar
+
+        return ArrayVar
+    if name == "Table":
+        from tktable.table import Table
+
+        return Table
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")

pytktable-0.1.0/tktable/__main__.py

@@ -0,0 +1,62 @@
+"""Diagnose whether Tktable can be used: ``python -m tktable``.
+
+Exits with status 0 if Tktable can be found (and loaded, when a display is available),
+and 1 otherwise.
+"""
+
+import os
+import platform
+import sys
+
+
+def main() -> int:
+    """Print diagnostic information and return the exit status."""
+    print(f"Python:    {sys.version.split()[0]} ({platform.platform()})")
+
+    try:
+        import tkinter  # pylint: disable=import-outside-toplevel
+    except ImportError as exc:
+        print(f"tkinter:   NOT AVAILABLE ({exc})")
+        print("Install tkinter for your Python (e.g. `sudo apt install python3-tk`).")
+        return 1
+
+    # pylint: disable-next=import-outside-toplevel
+    from tktable.utils import TKTABLE_LIBRARY_ENV_VAR, find_tktable, load_tktable
+
+    try:
+        interp = tkinter.Tcl()  # Tcl only: no window, so no display needed.
+    except tkinter.TclError as exc:
+        print(f"Tcl:       NOT AVAILABLE ({exc})")
+        return 1
+
+    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')}")
+    if not versions:
+        print("Tktable:   NOT FOUND")
+        print("See https://nbro.github.io/tktable/installation/")
+        return 1
+    print(f"Tktable:   found version(s) {', '.join(versions)}")
+
+    try:
+        root = tkinter.Tk()
+    except tkinter.TclError as exc:
+        print(f"Tk:        cannot start ({exc}); skipped loading Tktable")
+        return 0
+
+    try:
+        root.withdraw()
+        print(f"Tk:        {root.call('info', 'patchlevel')}")
+        print(f"Tktable:   loaded version {load_tktable(root)}")
+    except tkinter.TclError as exc:
+        print(f"Tktable:   FOUND BUT FAILED TO LOAD ({exc})")
+        print("It may have been built for a different Tcl/Tk version than your Python uses.")
+        return 1
+    finally:
+        root.destroy()
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())

pytktable-0.1.0/tktable/array_var.py

@@ -0,0 +1,64 @@
+# pylint: disable=missing-function-docstring, protected-access
+
+"""
+A module that contains a class for using Tcl arrays,
+which are, in some instances, required by tktable.
+"""
+
+import tkinter
+
+from tktable.utils import _setup_master
+
+
+class ArrayVar(tkinter.Variable):
+    """Class for handling Tcl arrays.
+
+    An array is actually an associative array in Tcl, so this class supports
+    some dict operations.
+    """
+
+    # pylint: disable=super-init-not-called  # TODO: can this be solve more properly?
+    def __init__(self, master=None, name=None):
+        # Tkinter.Variable.__init__ is not called on purpose! I don't wanna
+        # see an ugly _default value in the pretty array.
+        self._master = _setup_master(master)
+        self._tk = self._master.tk
+        if name:
+            self._name = name
+        else:
+            self._name = f"PY_VAR{id(self)}"
+
+    def __del__(self):
+        if bool(self._tk.call("info", "exists", self._name)):
+            self._tk.globalunsetvar(self._name)
+
+    def __len__(self):
+        return int(self._tk.call("array", "size", str(self)))
+
+    def __getitem__(self, key):
+        return self.get(key)
+
+    def __setitem__(self, key, value):
+        self.set(**{str(key): value})
+
+    def names(self):
+        return self._tk.splitlist(self._tk.call("array", "names", self._name))
+
+    def get(self, key=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(list(zip(flatten_pairs[::2], flatten_pairs[1::2])))
+        return self._tk.globalgetvar(str(self), str(key))
+
+    # pylint: disable=arguments-differ  # TODO: maybe consider calling this method differently?
+    def set(self, **kw):
+        self._tk.call("array", "set", str(self), tkinter._flatten(list(kw.items())))
+
+    def unset(self, pattern=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)

pytktable-0.1.0/tktable/table.py

@@ -0,0 +1,486 @@
+# pylint: disable=missing-function-docstring, protected-access, inconsistent-return-statements
+
+
+"""
+A module that contains a Python wrapper class for the Tcl/tk tktable widget.
+"""
+
+import logging
+import tkinter
+
+from tktable.utils import _setup_master, load_tktable
+
+logger = logging.getLogger(__name__)
+
+# TODO: consider solving the inconsistent-return-statements in more appropriate ways,
+#  e.g. split a method into 2, etc.
+
+
+class CannotUseError(RuntimeError):
+    """
+    The exception raised when you cannot use the Table because of missing dependencies.
+    """
+
+
+# pylint: disable=too-many-public-methods
+class Table(tkinter.Widget):
+    """Create and manipulate tables."""
+
+    _switches = (
+        "holddimensions",
+        "holdselection",
+        "holdtags",
+        "holdwindows",
+        "keeptitles",
+        "-",
+    )
+    _tabsubst_format = ("%c", "%C", "%i", "%r", "%s", "%S", "%W")
+    _tabsubst_commands = (
+        "browsecommand",
+        "browsecmd",
+        "command",
+        "selectioncommand",
+        "selcmd",
+        "validatecommand",
+        "valcmd",
+    )
+
+    def __init__(self, master=None, **kw):
+        master = _setup_master(master)
+
+        try:
+            load_tktable(master)
+            tkinter.Widget.__init__(self, master, "table", kw)
+        except tkinter.TclError as exc:
+            raise CannotUseError(
+                f"You cannot instantiate {self.__class__.__name__} because the Tcl/Tk "
+                "extension Tktable could not be loaded by your Tcl/Tk installation.\n"
+                "Run `python -m tktable` to diagnose the problem, and see "
+                "https://nbro.github.io/tktable/installation/ for how to install Tktable "
+                "or point the TKTABLE_LIBRARY environment variable to it."
+            ) from exc
+
+    def _options(self, cnf, kw=None):
+        if kw:
+            cnf = tkinter._cnfmerge((cnf, kw))
+        else:
+            cnf = tkinter._cnfmerge(cnf)
+        res = ()
+        for k, v in cnf.items():
+            if callable(v):
+                if k in self._tabsubst_commands:
+                    v = f"{self._register(v, self._tabsubst)} {' '.join(self._tabsubst_format)}"
+                else:
+                    v = self._register(v)
+            res += (f"-{k}", v)
+        return res
+
+    def _tabsubst(self, *args):
+        if len(args) != len(self._tabsubst_format):
+            return args
+        tk = self.tk
+        c, C, i, r, s, S, W = args  # pylint: disable=unused-variable
+        e = tkinter.Event()
+        e.widget = self
+        e.c = tk.getint(c)
+        e.i = tk.getint(i)
+        e.r = tk.getint(r)
+        e.C = f"{e.r:d},{e.c:d}"
+        e.s = s
+        e.S = S
+        try:
+            e.W = self._nametowidget(W)
+        except KeyError:
+            e.W = None
+        return (e,)
+
+    def _handle_switches(self, args):
+        args = args or ()
+        return tuple(f"-{x}" for x in args if x in self._switches)
+
+    def activate(self, index):
+        """Set the active cell to the one indicated by index."""
+        self.tk.call(self._w, "activate", index)
+
+    def bbox(self, first, last=None):
+        """Return the bounding box for the specified cell (range) as a
+        4-tuple of x, y, width and height in pixels. It clips the box to
+        the visible portion, if any, otherwise an empty tuple is returned."""
+        return self._getints(self.tk.call(self._w, "bbox", first, last)) or ()
+
+    def clear(self, option, first=None, last=None):
+        """This is a convenience routine to clear certain state information
+        managed by the table. first and last represent valid table indices.
+        If neither are specified, then the command operates on the whole
+        table."""
+        self.tk.call(self._w, "clear", option, first, last)
+
+    def clear_cache(self, first=None, last=None):
+        """Clear the specified section of the cache, if the table has been
+        keeping one."""
+        self.clear("cache", first, last)
+
+    def clear_sizes(self, first=None, last=None):
+        """Clear the specified row and column areas of specific height/width
+        dimensions. When just one index is specified, for example 2,0, that
+        is interpreted as row 2 and column 0."""
+        self.clear("sizes", first, last)
+
+    def clear_tags(self, first=None, last=None):
+        """Clear the specified area of tags (all row, column and cell tags)."""
+        self.clear("tags", first, last)
+
+    def clear_all(self, first=None, last=None):
+        """Perform all of the above clear functions on the specified area."""
+        self.clear("all", first, last)
+
+    def curselection(self, value=None):
+        """With no arguments, it returns the sorted indices of the currently
+        selected cells. Otherwise it sets all the selected cells to the given
+        value if there is an associated ArrayVar and the state is not
+        disabled."""
+        result = self.tk.call(self._w, "curselection", value)
+        if value is None:
+            return result
+
+    def curvalue(self, value=None):
+        """If no value is given, the value of the cell being edited (indexed
+        by active) is returned, else it is set to the given value."""
+        return self.tk.call(self._w, "curvalue", value)
+
+    def delete_active(self, index1, index2=None):
+        """Deletes text from the active cell. If only one index is given,
+        it deletes the character after that index, otherwise it deletes from
+        the first index to the second. index can be a number, insert or end."""
+        self.tk.call(self._w, "delete", "active", index1, index2)
+
+    def delete_cols(self, index, count=None, switches=None):
+        args = self._handle_switches(switches) + (index, count)
+        self.tk.call(self._w, "delete", "cols", *args)
+
+    def delete_rows(self, index, count=None, switches=None):
+        args = self._handle_switches(switches) + (index, count)
+        self.tk.call(self._w, "delete", "rows", *args)
+
+    def get(self, first, last=None):
+        """Returns the value of the cells specified by the table indices
+        first and (optionally) last."""
+        return self.tk.call(self._w, "get", first, last)
+
+    def height(self, row=None, **kwargs):
+        """If row and kwargs are not given, a list describing all rows for
+        which a width has been set is returned.
+        If row is given, the height of that row is returned.
+        If kwargs is given, then it sets the key/value pairs, where key is a
+        row and value represents the height for the row."""
+        if row is None and not kwargs:
+            pairs = self.tk.splitlist(self.tk.call(self._w, "height"))
+            return dict(pair.split() for pair in pairs)
+        if row is not None:
+            return int(self.tk.call(self._w, "height", str(row)))
+        args = tkinter._flatten(list(kwargs.items()))
+        self.tk.call(self._w, "height", *args)
+
+    def hidden(self, *args):
+        """When called without args, it returns all the hidden cells (those
+        cells covered by a spanning cell). If one index is specified, it
+        returns the spanning cell covering that index, if any. If multiple
+        indices are specified, it returns 1 if all indices are hidden cells,
+        0 otherwise."""
+        return self.tk.call(self._w, "hidden", *args)
+
+    def icursor(self, arg=None):
+        """If arg is not specified, return the location of the insertion
+        cursor in the active cell. Otherwise, set the cursor to that point in
+        the string.
+
+        0 is before the first character, you can also use insert or end for
+        the current insertion point or the end of the text. If there is no
+        active cell, or the cell or table is disabled, this will return -1."""
+        return self.tk.call(self._w, "icursor", arg)
+
+    def index(self, index, rc=None):
+        """Return the integer cell coordinate that corresponds to index in the
+        form row, col. If rc is specified, it must be either 'row' or 'col' so
+        only the row or column index is returned."""
+        res = self.tk.call(self._w, "index", index, rc)
+        if rc is None:
+            return res
+        return int(res)
+
+    def insert_active(self, index, value):
+        """The value is a text string which is inserted at the index position
+        of the active cell. The cursor is then positioned after the new text.
+        index can be a number, insert or end."""
+        self.tk.call(self._w, "insert", "active", index, value)
+
+    def insert_cols(self, index, count=None, switches=None):
+        args = self._handle_switches(switches) + (index, count)
+        self.tk.call(self._w, "insert", "cols", *args)
+
+    def insert_rows(self, index, count=None, switches=None):
+        args = self._handle_switches(switches) + (index, count)
+        self.tk.call(self._w, "insert", "rows", *args)
+
+    # def postscript(self, **kwargs):
+    #    """Skip this command if you are under Windows.
+    #
+    #    Accepted options:
+    #        colormap, colormode, file, channel, first, fontmap, height,
+    #        last, pageanchor, pageheight, pagewidth, pagex, pagey, rotate,
+    #        width, x, y
+    #    """
+    #    args = ()
+    #    for key, val in kwargs.iteritems():
+    #        args += ('-%s' % key, val)
+    #
+    #    return self.tk.call(self._w, 'postscript', *args)
+
+    def reread(self):
+        """Rereads the old contents of the cell back into the editing buffer.
+        Useful for a key binding when <Escape> is pressed to abort the edit
+        (a default binding)."""
+        self.tk.call(self._w, "reread")
+
+    def scan_mark(self, x, y):
+        self.tk.call(self._w, "scan", "mark", x, y)
+
+    def scan_dragto(self, x, y):
+        self.tk.call(self._w, "scan", "dragto", x, y)
+
+    def see(self, index):
+        self.tk.call(self._w, "see", index)
+
+    def selection_anchor(self, index):
+        self.tk.call(self._w, "selection", "anchor", index)
+
+    # pylint: disable=arguments-differ  # TODO: maybe consider calling this method differently?
+    def selection_clear(self, first, last=None):
+        self.tk.call(self._w, "selection", "clear", first, last)
+
+    def selection_includes(self, index):
+        return self.getboolean(self.tk.call(self._w, "selection", "includes", index))
+
+    def selection_set(self, first, last=None):
+        self.tk.call(self._w, "selection", "set", first, last)
+
+    def set(self, *args, rc=None, index=None, **kwargs):
+        """If rc is specified (either 'row' or 'col') then it is assumes that
+        args (if given) represents values which will be set into the
+        subsequent columns (if row is specified) or rows (for col).
+        If index is not None and args is not given, then it will return the
+        value(s) for the cell(s) specified.
+
+        If kwargs is given, assumes that each key in kwargs is a index in this
+        table and sets the specified index to the associated value. Table
+        validation will not be triggered via this method.
+
+        Note that the table must have an associated array (defined through the
+        variable option) in order to this work."""
+        if not args and index is not None:
+            if rc:
+                args = (rc, index)
+            else:
+                args = (index,)
+            return self.tk.call(self._w, "set", *args)
+        if rc is None:
+            args = tkinter._flatten(list(kwargs.items()))
+            self.tk.call(self._w, "set", *args)
+        else:
+            self.tk.call(self._w, "set", rc, index, args)
+
+    def spans(self, index=None, **kwargs):
+        """Manipulate row/col spans.
+
+        When called with no arguments, all known spans are returned as a dict.
+        When called with only the index, the span for that index only is
+        returned, if any. Otherwise kwargs is assumed to contain keys/values
+        pairs used to set spans. A span starts at the row,col defined by a key
+        and continues for the specified number of rows,cols specified by
+        its value. A span of 0,0 unsets any span on that cell."""
+        if kwargs:
+            args = tkinter._flatten(list(kwargs.items()))
+            self.tk.call(self._w, "spans", *args)
+        else:
+            return self.tk.call(self._w, "spans", index)
+
+    def tag_cell(self, tagname, *args):
+        return self.tk.call(self._w, "tag", "cell", tagname, *args)
+
+    def tag_cget(self, tagname, option):
+        return self.tk.call(self._w, "tag", "cget", tagname, f"-{option}")
+
+    def tag_col(self, tagname, *args):
+        return self.tk.call(self._w, "tag", "col", tagname, *args)
+
+    def tag_configure(self, tagname, option=None, **kwargs):
+        """Query or modify options associated with the tag given by tagname.
+
+        If no option is specified, a dict describing all of the available
+        options for tagname is returned. If option is specified, then the
+        command returns a list describing the one named option. Lastly, if
+        kwargs is given then it corresponds to option-value pairs that should
+        be modified."""
+        if option is None and not kwargs:
+            split1 = self.tk.splitlist(self.tk.call(self._w, "tag", "configure", tagname))
+            result = {}
+            for item in split1:
+                res = self.tk.splitlist(item)
+                result[res[0]] = res[1:]
+            return result
+        if option:
+            return self.tk.call(self._w, "tag", "configure", tagname, f"-{option}")
+        args = ()
+        for key, val in kwargs.items():
+            args += (f"-{key}", val)
+        self.tk.call(self._w, "tag", "configure", tagname, *args)
+
+    def tag_delete(self, tagname):
+        self.tk.call(self._w, "tag", "delete", tagname)
+
+    def tag_exists(self, tagname):
+        return self.getboolean(self.tk.call(self._w, "tag", "exists", tagname))
+
+    def tag_includes(self, tagname, index):
+        return self.getboolean(self.tk.call(self._w, "tag", "includes", tagname, index))
+
+    def tag_lower(self, tagname, belowthis=None):
+        self.tk.call(self._w, "tag", "lower", tagname, belowthis)
+
+    def tag_names(self, pattern=None):
+        return self.tk.call(self._w, "tag", "names", pattern)
+
+    def tag_raise(self, tagname, abovethis=None):
+        self.tk.call(self._w, "tag", "raise", tagname, abovethis)
+
+    def tag_row(self, tagname, *args):
+        return self.tk.call(self._w, "tag", "row", tagname, *args)
+
+    def validate(self, index):
+        """Explicitly validates the specified index based on the current
+        callback set for the validatecommand option. Return 0 or 1 based on
+        whether the cell was validated."""
+        return self.tk.call(self._w, "validate", index)
+
+    @property
+    def version(self):
+        """Return tktable's package version."""
+        return self.tk.call(self._w, "version")
+
+    def width(self, column=None, **kwargs):
+        """If column and kwargs are not given, a dict describing all columns
+        for which a width has been set is returned.
+        If column is given, the width of that column is returned.
+        If kwargs is given, then it sets the key/value pairs, where key is a
+        column and value represents the width for the column."""
+        if column is None and not kwargs:
+            pairs = self.tk.splitlist(self.tk.call(self._w, "width"))
+            return dict(pair.split() for pair in pairs)
+        if column is not None:
+            return int(self.tk.call(self._w, "width", str(column)))
+        args = tkinter._flatten(list(kwargs.items()))
+        self.tk.call(self._w, "width", *args)
+
+    def window_cget(self, index, option):
+        return self.tk.call(self._w, "window", "cget", index, option)
+
+    def window_configure(self, index, option=None, **kwargs):
+        """Query or modify options associated with the embedded window given
+        by index. This should also be used to add a new embedded window into
+        the table.
+
+        If no option is specified, a dict describing all of the available
+        options for index is returned. If option is specified, then the
+        command returns a list describing the one named option. Lastly, if
+        kwargs is given then it corresponds to option-value pairs that should
+        be modified."""
+        if option is None and not kwargs:
+            return self.tk.call(self._w, "window", "configure", index)
+        if option:
+            return self.tk.call(self._w, "window", "configure", index, f"-{option}")
+        args = ()
+        for key, val in kwargs.items():
+            args += (f"-{key}", val)
+        self.tk.call(self._w, "window", "configure", index, *args)
+
+    def window_delete(self, *indexes):
+        self.tk.call(self._w, "window", "delete", *indexes)
+
+    def window_move(self, index_from, index_to):
+        self.tk.call(self._w, "window", "move", index_from, index_to)
+
+    def window_names(self, pattern=None):
+        return self.tk.call(self._w, "window", "names", pattern)
+
+    def xview(self, index=None):
+        """If index is not given a tuple containing two fractions is returned,
+        each fraction is between 0 and 1. Together they describe the
+        horizontal span that is visible in the window.
+
+        If index is given the view in the window is adjusted so that the
+        column given by index is displayed at the left edge of the window."""
+        res = self.tk.call(self._w, "xview", index)
+        if index is None:
+            return self._getdoubles(res)
+
+    def xview_moveto(self, fraction):
+        """Adjusts the view in the window so that fraction of the total width
+        of the table text is off-screen to the left. The fraction parameter
+        must be a fraction between 0 and 1."""
+        self.tk.call(self._w, "xview", "moveto", fraction)
+
+    def xview_scroll(self, *L):
+        # change by frank gao for attach scrollbar 11/11/2010
+        """Shift the view in the window left or right according to number and
+        what. The 'number' parameter must be an integer. The 'what' parameter
+        must be either units or pages or an abbreviation of one of these.
+
+        If 'what' is units, the view adjusts left or right by number cells on
+        the display; if it is pages then the view adjusts by number screenfuls.
+        If 'number' is negative then cells farther to the left become visible;
+        if it is positive then cells farther to the right become visible."""
+        # self.tk.call(self._w, 'xview', 'scroll', number, what)
+        op, howMany = L[0], L[1]
+        if op == "scroll":
+            units = L[2]
+            self.tk.call(self._w, "xview", "scroll", howMany, units)
+        elif op == "moveto":
+            self.tk.call(self._w, "xview", "moveto", howMany)
+
+    def yview(self, index=None):
+        """If index is not given a tuple containing two fractions is returned,
+        each fraction is between 0 and 1. The first element gives the position
+        of the table element at the top of the window, relative to the table
+        as a whole. The second element gives the position of the table element
+        just after the last one in the window, relative to the table as a
+        whole.
+
+        If index is given the view in the window is adjusted so that the
+        row given by index is displayed at the top of the window."""
+        res = self.tk.call(self._w, "yview", index)
+        if index is None:
+            return self._getdoubles(res)
+
+    def yview_moveto(self, fraction):
+        """Adjusts the view in the window so that the element given by
+        fraction appears at the top of the window. The fraction parameter
+        must be a fraction between 0 and 1."""
+        self.tk.call(self._w, "yview", "moveto", fraction)
+
+    def yview_scroll(self, *L):
+        # change by frank gao for attach scrollbar 11/11/2010
+        """Adjust the view in the window up or down according to number and
+        what. The 'number' parameter must be an integer. The 'what' parameter
+        must be either units or pages or an abbreviation of one of these.
+
+        If 'what' is units, the view adjusts up or down by number cells; if it
+        is pages then the view adjusts by number screenfuls.
+        If 'number' is negative then earlier elements become visible; if it
+        is positive then later elements become visible."""
+        # self.tk.call(self._w, 'yview', 'scroll', number, what)
+        op, howMany = L[0], L[1]
+        if op == "scroll":
+            units = L[2]
+            self.tk.call(self._w, "yview", "scroll", howMany, units)
+        elif op == "moveto":
+            self.tk.call(self._w, "yview", "moveto", howMany)

pytktable-0.1.0/tktable/utils.py

@@ -0,0 +1,56 @@
+# pylint: disable=protected-access
+
+"""Internal helpers shared by the modules of this package."""
+
+import logging
+import os
+import tkinter
+
+logger = logging.getLogger(__name__)
+
+#: Environment variable that can point to the directory containing Tktable's pkgIndex.tcl.
+TKTABLE_LIBRARY_ENV_VAR = "TKTABLE_LIBRARY"
+
+
+def _setup_master(master: tkinter.Misc | None) -> tkinter.Misc:
+    if master is None:
+        if tkinter._support_default_root:  # type: ignore[attr-defined]
+            master = tkinter._default_root or tkinter.Tk()  # type: ignore[attr-defined]
+        else:
+            raise RuntimeError(
+                "No master specified and Tkinter is configured to not support default master"
+            )
+    return master
+
+
+def extend_auto_path(interp: tkinter.Misc) -> None:
+    """Append ``$TKTABLE_LIBRARY`` (if set) to Tcl's ``auto_path`` of ``interp``."""
+    library = os.environ.get(TKTABLE_LIBRARY_ENV_VAR)
+    if library:
+        logger.debug("Add %s to auto_path", library)
+        interp.tk.call("lappend", "auto_path", library)
+    else:
+        logger.debug("The environment variable %s is not defined.", TKTABLE_LIBRARY_ENV_VAR)
+
+
+def find_tktable(interp: tkinter.Misc) -> list[str]:
+    """Return the versions of Tktable that Tcl can find, without loading it.
+
+    This does not need Tk (or a display), so it works in headless environments.
+    """
+    extend_auto_path(interp)
+    # Requiring a non-existent package makes Tcl scan auto_path for every pkgIndex.tcl.
+    interp.tk.eval("catch {package require __tktable_probe__}")
+    return [str(v) for v in interp.tk.splitlist(interp.tk.call("package", "versions", "Tktable"))]
+
+
+def load_tktable(master: tkinter.Misc) -> str:
+    """Load the Tcl/Tk extension Tktable into the Tk interpreter of ``master``.
+
+    :return: the version of Tktable that was loaded.
+    :raise tkinter.TclError: if Tktable cannot be found or loaded.
+    """
+    extend_auto_path(master)
+    # https://wiki.tcl-lang.org/page/package+require
+    logger.debug("Require the Tcl/Tk extension Tktable.")
+    return str(master.tk.call("package", "require", "Tktable"))