Expand description
Python bindings module
This module contains all Python-facing bindings organized into submodules:
terminal: PyTerminal struct and its implementationpty: PyPtyTerminal struct and its implementation (PTY support)types: Data types (PyAttributes, PyScreenSnapshot, PyShellIntegration, PyGraphic)enums: Enum types (PyCursorStyle, PyUnderlineStyle)conversions: Type conversions and parsing utilitiescolor_utils: Color utility functions for contrast adjustment
Re-exports§
pub use color_utils::py_adjust_contrast_rgb;pub use color_utils::py_adjust_hue;pub use color_utils::py_adjust_saturation;pub use color_utils::py_char_width;pub use color_utils::py_char_width_cjk;pub use color_utils::py_color_luminance;pub use color_utils::py_complementary_color;pub use color_utils::py_contrast_ratio;pub use color_utils::py_darken_rgb;pub use color_utils::py_hex_to_rgb;pub use color_utils::py_hsl_to_rgb;pub use color_utils::py_is_dark_color;pub use color_utils::py_is_east_asian_ambiguous;pub use color_utils::py_lighten_rgb;pub use color_utils::py_meets_wcag_aa;pub use color_utils::py_meets_wcag_aaa;pub use color_utils::py_mix_colors;pub use color_utils::py_perceived_brightness_rgb;pub use color_utils::py_rgb_to_ansi_256;pub use color_utils::py_rgb_to_hex;pub use color_utils::py_rgb_to_hsl;pub use color_utils::py_str_width;pub use color_utils::py_str_width_cjk;pub use enums::PyAmbiguousWidth;pub use enums::PyCursorStyle;pub use enums::PyMouseEncoding;pub use enums::PyNormalizationForm;pub use enums::PyProgressState;pub use enums::PyUnderlineStyle;pub use enums::PyUnicodeVersion;pub use enums::PyWidthConfig;pub use pty::PyPtyTerminal;pub use streaming::decode_client_message;pub use streaming::decode_server_message;pub use streaming::encode_client_message;pub use streaming::encode_server_message;pub use streaming::PyStreamingConfig;pub use streaming::PyStreamingServer;pub use terminal::PyTerminal;pub use types::PyAttributes;pub use types::PyBenchmarkResult;pub use types::PyBenchmarkSuite;pub use types::PyBookmark;pub use types::PyClipboardEntry;pub use types::PyClipboardHistoryEntry;pub use types::PyClipboardSyncEvent;pub use types::PyColorHSL;pub use types::PyColorHSV;pub use types::PyColorPalette;pub use types::PyCommandExecution;pub use types::PyComplianceReport;pub use types::PyComplianceTest;pub use types::PyCoprocessConfig;pub use types::PyCwdChange;pub use types::PyDamageRegion;pub use types::PyDetectedItem;pub use types::PyEscapeSequenceProfile;pub use types::PyFrameTiming;pub use types::PyGraphic;pub use types::PyImageDimension;pub use types::PyImageFormat;pub use types::PyImagePlacement;pub use types::PyImageProtocol;pub use types::PyInlineImage;pub use types::PyJoinedLines;pub use types::PyLineDiff;pub use types::PyMacro;pub use types::PyMacroEvent;pub use types::PyMouseEvent;pub use types::PyMousePosition;pub use types::PyNotificationConfig;pub use types::PyNotificationEvent;pub use types::PyPaneState;pub use types::PyPerformanceMetrics;pub use types::PyProfilingData;pub use types::PyProgressBar;pub use types::PyRecordingEvent;pub use types::PyRecordingSession;pub use types::PyRegexMatch;pub use types::PyRenderingHint;pub use types::PyScreenSnapshot;pub use types::PyScrollbackStats;pub use types::PySearchMatch;pub use types::PySelection;pub use types::PySelectionMode;pub use types::PySessionState;pub use types::PyShellIntegration;pub use types::PyShellIntegrationStats;pub use types::PySnapshotDiff;pub use types::PyTmuxNotification;pub use types::PyTrigger;pub use types::PyTriggerAction;pub use types::PyTriggerMatch;pub use types::PyWindowLayout;
Modules§
- color_
utils - Python bindings for color utility functions
- conversions
- Python conversion utilities
- enums
- Python enums for cursor and underline styles
- observer
- Python observer bindings for push-based event delivery
- pty
- Python wrapper for PtySession - terminal with PTY support
- streaming
- Python bindings for terminal streaming
- terminal
- Python bindings for the Terminal emulator
- types
- Python data types and structures for the terminal API