tmux-python · Dec 25, 2024 · Dec 27, 2024 · Dec 28, 2024 · Dec 31, 2024 · Jan 2, 2025
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -69,7 +69,7 @@ jobs:
           export PATH=$HOME/tmux-builds/tmux-${{ matrix.tmux-version }}/bin:$PATH
           ls $HOME/tmux-builds/tmux-${{ matrix.tmux-version }}/bin
           tmux -V
-          uv run py.test --cov=./ --cov-append --cov-report=xml -n auto
+          uv run py.test --cov=./ --cov-append --cov-report=xml -n auto --verbose
         env:
           COV_CORE_SOURCE: .
           COV_CORE_CONFIG: .coveragerc

diff --git a/.tool-versions b/.tool-versions
@@ -1,2 +1,2 @@
-uv 0.5.11
+uv 0.5.22
 python 3.13.1 3.12.8 3.11.11 3.10.16 3.9.21 3.8.20 3.7.17
diff --git a/CHANGES b/CHANGES
@@ -9,12 +9,35 @@ To install via [pip](https://pip.pypa.io/en/stable/), use:
 $ pip install --user --upgrade --pre libtmux
 ```
 
-## libtmux 0.41.x (Yet to be released)
+## libtmux 0.42.x (Yet to be released)
 
 - _Future release notes will be placed here_
 
 <!-- To maintainers and contributors: Please add notes for the forthcoming version above -->
 
+## libtmux 0.41.0 (2025-02-02)
+
+### Fixes
+
+- {meth}`Server.__repr__()`: Use {meth}`os.geteuid()` for default `socket_path`. Thank you @lazysegtree!
+  (#557, resolves #556)
+
+### Documentation
+
+- `Server`: Fix `colors` docstring to note it accepts `88` or `256`, Thank you
+  @TravisDart! (via #544)
+
+### Development
+
+#### chore: Implement PEP 563 deferred annotation resolution (#555)
+
+- Add `from __future__ import annotations` to defer annotation resolution and reduce unnecessary runtime computations during type checking.
+- Enable Ruff checks for PEP-compliant annotations:
+  - [non-pep585-annotation (UP006)](https://docs.astral.sh/ruff/rules/non-pep585-annotation/)
+  - [non-pep604-annotation (UP007)](https://docs.astral.sh/ruff/rules/non-pep604-annotation/)
+
+For more details on PEP 563, see: https://peps.python.org/pep-0563/
+
 ## libtmux 0.40.1 (2024-12-24)
 
 ### Bug fix

diff --git a/conftest.py b/conftest.py
@@ -8,7 +8,8 @@
 https://docs.pytest.org/en/stable/deprecations.html
 """
 
-import pathlib
+from __future__ import annotations
+
 import shutil
 import typing as t
 
@@ -21,6 +22,9 @@
 from libtmux.session import Session
 from libtmux.window import Window
 
+if t.TYPE_CHECKING:
+    import pathlib
+
 pytest_plugins = ["pytester"]
 
 

diff --git a/docs/about.md b/docs/about.md
@@ -95,7 +95,7 @@ have dashes (-) replaced with underscores (\_).
 
 ## Reference
 
-- tmux docs <http://www.openbsd.org/cgi-bin/man.cgi?query=tmux&sektion=1>
+- tmux docs <https://man.openbsd.org/tmux.1>
 - tmux source code <http://sourceforge.net/p/tmux/tmux-code/ci/master/tree/>
 
 [abstraction layer]: http://en.wikipedia.org/wiki/Abstraction_layer

diff --git a/docs/reference/common.md → docs/api/common.md b/docs/reference/common.md → docs/api/common.md
diff --git a/docs/reference/constants.md → docs/api/constants.md b/docs/reference/constants.md → docs/api/constants.md
diff --git a/docs/reference/exceptions.md → docs/api/exceptions.md b/docs/reference/exceptions.md → docs/api/exceptions.md
diff --git a/docs/reference/index.md → docs/api/index.md b/docs/reference/index.md → docs/api/index.md
diff --git a/docs/reference/panes.md → docs/api/panes.md b/docs/reference/panes.md → docs/api/panes.md
diff --git a/docs/reference/properties.md → docs/api/properties.md b/docs/reference/properties.md → docs/api/properties.md
diff --git a/docs/reference/servers.md → docs/api/servers.md b/docs/reference/servers.md → docs/api/servers.md
diff --git a/docs/reference/sessions.md → docs/api/sessions.md b/docs/reference/sessions.md → docs/api/sessions.md
diff --git a/docs/reference/windows.md → docs/api/windows.md b/docs/reference/windows.md → docs/api/windows.md
diff --git a/docs/conf.py b/docs/conf.py
@@ -1,6 +1,8 @@
 # flake8: NOQA: E501
 """Sphinx configuration for libtmux."""
 
+from __future__ import annotations
+
 import contextlib
 import inspect
 import pathlib
@@ -72,7 +74,7 @@
 html_extra_path = ["manifest.json"]
 html_theme = "furo"
 html_theme_path: list[str] = []
-html_theme_options: dict[str, t.Union[str, list[dict[str, str]]]] = {
+html_theme_options: dict[str, str | list[dict[str, str]]] = {
     "light_logo": "img/libtmux.svg",
     "dark_logo": "img/libtmux.svg",
     "footer_icons": [
@@ -90,7 +92,7 @@
     "source_repository": f"{about['__github__']}/",
     "source_branch": "master",
     "source_directory": "docs/",
-    "announcement": "<em>Friendly reminder:</em> 📌 Pin the package, libtmux is pre-1.0 and APIs will be <a href='/migration.html'>changing</a> throughout 2022-2024.",
+    "announcement": "<em>Friendly reminder:</em> 📌 Pin the package, libtmux is pre-1.0 and APIs will be <a href='/migration.html'>changing</a> throughout 2025.",
 }
 html_sidebars = {
     "**": [
@@ -104,7 +106,7 @@
 }
 
 # linkify_issues
-issue_url_tpl = f'{about["__github__"]}/issues/{{issue_id}}'
+issue_url_tpl = f"{about['__github__']}/issues/{{issue_id}}"
 
 # sphinx.ext.autodoc
 autoclass_content = "both"
@@ -138,7 +140,7 @@
 }
 
 
-def linkcode_resolve(domain: str, info: dict[str, str]) -> t.Union[None, str]:
+def linkcode_resolve(domain: str, info: dict[str, str]) -> None | str:
     """
     Determine the URL corresponding to Python object.
 
@@ -208,7 +210,7 @@ def linkcode_resolve(domain: str, info: dict[str, str]) -> t.Union[None, str]:
     )
 
 
-def remove_tabs_js(app: "Sphinx", exc: Exception) -> None:
+def remove_tabs_js(app: Sphinx, exc: Exception) -> None:
     """Remove tabs.js from _static after build."""
     # Fix for sphinx-inline-tabs#18
     if app.builder.format == "html" and not exc:
@@ -217,6 +219,6 @@ def remove_tabs_js(app: "Sphinx", exc: Exception) -> None:
             tabs_js.unlink()  # When python 3.7 deprecated, use missing_ok=True
 
 
-def setup(app: "Sphinx") -> None:
+def setup(app: Sphinx) -> None:
     """Configure Sphinx app hooks."""
     app.connect("build-finished", remove_tabs_js)
diff --git a/docs/index.md b/docs/index.md
@@ -18,7 +18,7 @@ hide-toc: true
 quickstart
 about
 topics/traversal
-reference/index
+api/index
 pytest-plugin/index
 ```
 

diff --git a/docs/redirects.txt b/docs/redirects.txt
@@ -6,3 +6,12 @@
 "sessions.md" "reference/sessions.md"
 "api.md" "reference/index.md"
 "pytest-plugin.md" "pytest-plugin/index.md"
+"reference/common.md" "api/common.md"
+"reference/constants.md" "api/constants.md"
+"reference/exceptions.md" "api/exceptions.md"
+"reference/index.md" "api/index.md"
+"reference/panes.md" "api/panes.md"
+"reference/properties.md" "api/properties.md"
+"reference/servers.md" "api/servers.md"
+"reference/sessions.md" "api/sessions.md"
+"reference/windows.md" "api/windows.md"
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = "libtmux"
-version = "0.40.1"
+version = "0.41.0"
 description = "Typed library that provides an ORM wrapper for tmux, a terminal multiplexer."
 requires-python = ">=3.9,<4.0"
 authors = [
@@ -145,6 +145,7 @@ exclude_lines = [
   "if TYPE_CHECKING:",
   "if t.TYPE_CHECKING:",
   "@overload( |$)",
+  "from __future__ import annotations",
 ]
 
 [tool.ruff]
@@ -168,16 +169,31 @@ select = [
   "PERF", # Perflint
   "RUF", # Ruff-specific rules
   "D", # pydocstyle
+  "FA100",  # future annotations
 ]
 ignore = [
   "COM812", # missing trailing comma, ruff format conflict
 ]
+extend-safe-fixes = [
+  "UP006",
+  "UP007",
+]
+pyupgrade.keep-runtime-typing = false
 
 [tool.ruff.lint.isort]
 known-first-party = [
   "libtmux",
 ]
 combine-as-imports = true
+required-imports = [
+  "from __future__ import annotations",
+]
+
+[tool.ruff.lint.flake8-builtins]
+builtins-allowed-modules = [
+  "dataclasses",
+  "types",
+]
 
 [tool.ruff.lint.pydocstyle]
 convention = "numpy"

diff --git a/src/libtmux/__about__.py b/src/libtmux/__about__.py
@@ -1,8 +1,10 @@
 """Metadata package for libtmux."""
 
+from __future__ import annotations
+
 __title__ = "libtmux"
 __package_name__ = "libtmux"
-__version__ = "0.40.1"
+__version__ = "0.41.0"
 __description__ = "Typed scripting library / ORM / API wrapper for tmux"
 __email__ = "tony@git-pull.com"
 __author__ = "Tony Narlock"

diff --git a/src/libtmux/__init__.py b/src/libtmux/__init__.py
@@ -1,5 +1,7 @@
 """libtmux, a typed, pythonic API wrapper for the tmux terminal multiplexer."""
 
+from __future__ import annotations
+
 from .__about__ import (
     __author__,
     __copyright__,

diff --git a/src/libtmux/_internal/dataclasses.py b/src/libtmux/_internal/dataclasses.py
@@ -5,6 +5,8 @@
 This is an internal API not covered by versioning policy.
 """
 
+from __future__ import annotations
+
 import dataclasses
 import typing as t
 from operator import attrgetter
@@ -78,7 +80,7 @@ class SkipDefaultFieldsReprMixin:
     ItemWithMixin(name=Test, unit_price=2.05)
     """
 
-    def __repr__(self: "DataclassInstance") -> str:
+    def __repr__(self: DataclassInstance) -> str:
         """Omit default fields in object representation."""
         nodef_f_vals = (
             (f.name, attrgetter(f.name)(self))