pywinpty 3.0.1__cp313-cp313-win_amd64.whl → 3.0.3__cp313-cp313-win_amd64.whl

pywinpty-3.0.3.dist-info/METADATA

@@ -0,0 +1,162 @@
+Metadata-Version: 2.4
+Name: pywinpty
+Version: 3.0.3
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python :: Free Threading
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Terminals
+Classifier: Topic :: Terminals :: Terminal Emulators/X Terminals
+Classifier: Programming Language :: Rust
+License-File: LICENSE.txt
+Summary: Pseudo terminal support for Windows from Python.
+Keywords: PTY,Windows,pseudo-terminal,PyO3
+Author: Edgar Margffoy
+Author-email: andfoy@gmail.com
+Maintainer-email: Edgar Margffoy <andfoy@gmail.com>
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Changelog, https://github.com/andfoy/pywinpty/blob/main/CHANGELOG.md
+Project-URL: Repository, https://github.com/andfoy/pywinpty
+
+# PyWinpty: Pseudoterminals for Windows in Python
+
+[![Project License - MIT](https://img.shields.io/pypi/l/pywinpty.svg)](./LICENSE.txt)
+[![pypi version](https://img.shields.io/pypi/v/pywinpty.svg)](https://pypi.org/project/pywinpty/)
+[![conda version](https://img.shields.io/conda/vn/conda-forge/pywinpty.svg)](https://www.anaconda.com/download/)
+[![download count](https://img.shields.io/conda/dn/conda-forge/pywinpty.svg)](https://www.anaconda.com/download/)
+[![Downloads](https://pepy.tech/badge/pywinpty)](https://pepy.tech/project/pywinpty)
+[![PyPI status](https://img.shields.io/pypi/status/pywinpty.svg)](https://github.com/spyder-ide/pywinpty)
+[![Windows tests](https://github.com/andfoy/pywinpty/actions/workflows/windows_build.yml/badge.svg)](https://github.com/andfoy/pywinpty/actions/workflows/windows_build.yml)
+
+*Copyright © 2017–2022 Spyder Project Contributors*
+*Copyright © 2022– Edgar Andrés Margffoy Tuay*
+
+
+## Overview
+
+PyWinpty allows creating and communicating with Windows processes that receive input and print outputs via console input and output pipes. PyWinpty supports both the native [ConPTY](https://devblogs.microsoft.com/commandline/windows-command-line-introducing-the-windows-pseudo-console-conpty/) interface and the previous, fallback [winpty](https://github.com/rprichard/winpty) library.
+
+
+## Dependencies
+To compile pywinpty sources, you must have [Rust](https://rustup.rs/) installed.
+Optionally, you can also have Winpty's C header and library files available on your include path.
+
+
+## Installation
+You can install this library by using conda or pip package managers, as it follows:
+
+Using conda (Recommended):
+```bash
+conda install pywinpty
+```
+
+Using pip:
+```bash
+pip install pywinpty
+```
+
+## Building from source
+
+To build from sources, you will require both a working stable or nightly Rust toolchain with
+target `x86_64-pc-windows-msvc`, which can be installed using [rustup](https://rustup.rs/).
+
+Optionally, this library can be linked against winpty library, which you can install using conda-forge:
+
+```batch
+conda install winpty -c conda-forge
+```
+
+If you don't want to use conda, you will need to have the winpty binaries and headers available on your PATH.
+
+Finally, pywinpty uses [Maturin](https://github.com/PyO3/maturin) as the build backend, which can be installed using `pip`:
+
+```batch
+pip install maturin
+```
+
+To test your compilation environment settings, you can build pywinpty sources locally, by
+executing:
+
+```bash
+maturin develop
+```
+
+This package depends on the following Rust crates:
+
+* [PyO3](https://github.com/PyO3/pyo3): Library used to produce Python bindings from Rust code.
+* [WinPTY-rs](https://github.com/andfoy/winpty-rs): Create and spawn processes inside a pseudoterminal in Windows from Rust.
+* [Maturin](https://github.com/PyO3/maturin): Build system to build and publish Rust-based Python packages.
+
+## Package usage
+Pywinpty offers a single python wrapper around winpty library functions.
+This implies that using a single object (``winpty.PTY``) it is possible to access to all functionality, as it follows:
+
+```python
+# High level usage using `spawn`
+from winpty import PtyProcess
+
+proc = PtyProcess.spawn('python')
+proc.write('print("hello, world!")\r\n')
+proc.write('exit()\r\n')
+while proc.isalive():
+	print(proc.readline())
+
+# Low level usage using the raw `PTY` object
+from winpty import PTY
+
+# Start a new winpty-agent process of size (cols, rows)
+cols, rows = 80, 25
+process = PTY(cols, rows)
+
+# Spawn a new console process, e.g., CMD
+process.spawn(br'C:\windows\system32\cmd.exe')
+
+# Read console output (Unicode)
+process.read()
+
+# Write input to console (Unicode)
+process.write(b'Text')
+
+# Resize console size
+new_cols, new_rows = 90, 30
+process.set_size(new_cols, new_rows)
+
+# Know if the process is alive
+alive = process.isalive()
+
+# End winpty-agent process
+del process
+```
+
+## Running tests
+We use pytest to run tests as it follows (after calling ``maturin develop``), the test suite depends
+on pytest-lazy-fixture, which can be installed via pip:
+
+```batch
+pip install pytest pytest-lazy-fixture flaky
+```
+
+All the tests can be executed using the following command
+
+```bash
+python runtests.py
+```
+
+
+## Changelog
+Visit our [CHANGELOG](CHANGELOG.md) file to learn more about our new features and improvements.
+
+
+## Contribution guidelines
+We follow PEP8 and PEP257 for pure python packages and Rust to compile extensions. We use MyPy type annotations for all functions and classes declared on this package. Feel free to send a PR or create an issue if you have any problem/question.
+
+
+## Security contact information
+
+To report a security vulnerability, please use the
+[Tidelift security contact](https://tidelift.com/security).
+Tidelift will coordinate the fix and disclosure.
+

pywinpty-3.0.3.dist-info/RECORD

@@ -0,0 +1,16 @@
+pywinpty-3.0.3.dist-info\METADATA,sha256=poyhYBPHwV2raTRVtLtL-_ogd-kuEP83l1cjQbN4bGA,5890
+pywinpty-3.0.3.dist-info\WHEEL,sha256=n_BmF69IyGtioVWE9c3M_zsEfe6-xMZy1v5HCL_6qE0,97
+pywinpty-3.0.3.dist-info\licenses\LICENSE.txt,sha256=-HjUdn-a0uQ9MIPvoAIBsADOk32e6GJuALpccqrJUeI,1088
+winpty\OpenConsole.exe,sha256=aykVqakcBzg0amxqez7it04mWCsMkrGxYGbnJXDd3Wg,1149472
+winpty\__init__.py,sha256=laTi9sLjCLycyaQYO3wMvhZNIK2vh_pOvGTJT2Od4Qs,402
+winpty\conpty.dll,sha256=H1_9Uv8Rjbl17rJbrABR9M7_PgUTE_oDpa__qede5QI,109600
+winpty\enums.py,sha256=KAm7XJFPk7nMWwUJxvYHlql92cr6y-Y24IHK3fc0JDU,1860
+winpty\ptyprocess.py,sha256=hucCVfBridHRc4IPiEFrEkdFhU-UKSQbyZUa97EceDc,12209
+winpty\tests\__init__.py,sha256=fzb9cDnPt2R3b_rWh6sqDgIbiQOZtBlfsV1aq-ULT2Q,53
+winpty\tests\test_pty.py,sha256=AXujQybXhKr0t0UKpNBSqeAfsm4fHoU_ognbiocBF5I,3947
+winpty\tests\test_ptyprocess.py,sha256=MeGp_P-zkseEp0iXciWh9Fa548hYGdvlcaHy_WNEwXo,6112
+winpty\winpty-agent.exe,sha256=REZ6g9hrYSe8e4duiy-zP6df3gnZuf8nx_jvhLqWmyk,2627338
+winpty\winpty.cp313-win_amd64.pyd,sha256=ULEH7BqTk6RkBxRZAj6Mb8Sw8jbpdzHDGnQdzVZSTfg,553472
+winpty\winpty.dll,sha256=UXfzIarC-oVDbdbsa_xtQUWdJfW1M6oDNJ71E0YbTHk,2509089
+winpty\winpty.pyi,sha256=-VenowCvy8tjIZUCvvb5VZw5R1c6ATXEUfsiEyIZwjE,1176
+pywinpty-3.0.3.dist-info\RECORD,,

{pywinpty-3.0.1.dist-info → pywinpty-3.0.3.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: maturin (1.9.4)
+Generator: maturin (1.11.5)
 Root-Is-Purelib: false
 Tag: cp313-cp313-win_amd64

winpty/ptyprocess.py

@@ -1,7 +1,6 @@
 # -*- coding: utf-8 -*-
 
 # Standard library imports
-import codecs
 import os
 import shlex
 import signal
@@ -351,7 +350,7 @@ def _read_in_thread(address, pty: PTY, blocking: bool):
 
     while 1:
         try:
-            data = pty.read(blocking=blocking) or b'0011Ignore'
+            data = pty.read(blocking=blocking) or '0011Ignore'
             try:
                 client.send(bytes(data, 'utf-8'))
             except socket.error:
@@ -363,8 +362,7 @@ def _read_in_thread(address, pty: PTY, blocking: bool):
                     client.send(b'')
                 except socket.error:
                     pass
-                finally:
-                    break
+                break
 
             call += 1
         except Exception as e:

winpty/tests/test_pty.py

@@ -51,14 +51,17 @@ def pty_fixture(request):
 
     backend = getattr(Backend, backend)
     def _pty_factory():
-        pty = PTY(80, 25, backend=backend)
+        try:
+            pty = PTY(80, 25, backend=backend)
+        except WinptyError:
+            pytest.skip()
+            return None
         assert pty.spawn(CMD)
         time.sleep(0.3)
         return pty
     return _pty_factory
 
 
-
 # @pytest.fixture(scope='function', params=[
 #     pytest.lazy_fixture('conpty_provider'),
 #     pytest.lazy_fixture('winpty_provider')])

winpty/tests/test_ptyprocess.py

@@ -14,6 +14,7 @@ import pytest
 from flaky import flaky
 
 # Local imports
+from winpty import WinptyError
 from winpty.enums import Backend
 from winpty.ptyprocess import PtyProcess, which
 
@@ -33,7 +34,11 @@ def pty_fixture(request):
     backend = getattr(Backend, backend)
     def _pty_factory(cmd=None, env=None):
         cmd = cmd or 'cmd'
-        pty = PtyProcess.spawn(cmd, env=env, backend=backend)
+        try:
+            pty = PtyProcess.spawn(cmd, env=env, backend=backend)
+        except WinptyError:
+            pytest.skip()
+            return None
         return pty
     # time.sleep(10)
     _pty_factory.backend = request.param

winpty/winpty.pyi

@@ -6,53 +6,37 @@
 from typing import Optional
 
 # Local imports
-from .enums import Backend, Encoding, MouseMode, AgentConfig
+from .enums import MouseMode, AgentConfig
 
 __version__: str
 
-class WinptyError(Exception):
-    ...
+class WinptyError(Exception): ...
 
 class PTY:
-    def __init__(self, cols: int, rows: int,
-                 backend: Optional[int] = None,
-                 encoding: Optional[str] = Encoding.UTF8,
-                 mouse_mode: int = MouseMode.WINPTY_MOUSE_MODE_NONE,
-                 timeout: int = 30000,
-                 agent_config: int = AgentConfig.WINPTY_FLAG_COLOR_ESCAPES):
-        ...
-
-    def spawn(self,
-              appname: str,
-              cmdline: Optional[str] = None,
-              cwd: Optional[str] = None,
-              env: Optional[str] = None) -> bool:
-        ...
-
+    def __init__(
+        self,
+        cols: int,
+        rows: int,
+        backend: Optional[int] = None,
+        mouse_mode: int = MouseMode.WINPTY_MOUSE_MODE_NONE,
+        timeout: int = 30000,
+        agent_config: int = AgentConfig.WINPTY_FLAG_COLOR_ESCAPES,
+    ): ...
+    def spawn(
+        self,
+        appname: str,
+        cmdline: Optional[str] = None,
+        cwd: Optional[str] = None,
+        env: Optional[str] = None,
+    ) -> bool: ...
     def set_size(self, cols: int, rows: int): ...
-
-    def read(self,
-             length: Optional[int] = 1000,
-             blocking: bool = False) -> str:
-        ...
-
-    def read_stderr(self,
-             length: Optional[int] = 1000,
-             blocking: bool = False) -> str:
-        ...
-
+    def read(self, blocking: bool = False) -> str: ...
     def write(self, to_write: str) -> int: ...
-
     def isalive(self) -> bool: ...
-
     def get_exitstatus(self) -> Optional[int]: ...
-
     def iseof(self) -> bool: ...
-
-    def cancel_io() -> bool: ...
-
+    def cancel_io(self) -> bool: ...
     @property
     def pid(self) -> Optional[int]: ...
-
     @property
     def fd(self) -> Optional[int]: ...

pywinpty-3.0.1.dist-info/METADATA

@@ -1,6 +0,0 @@
-Metadata-Version: 2.4
-Name: pywinpty
-Version: 3.0.1
-License-File: LICENSE.txt
-Summary: Pseudo terminal support for Windows from Python.
-Requires-Python: >=3.9

pywinpty-3.0.1.dist-info/RECORD

@@ -1,16 +0,0 @@
-pywinpty-3.0.1.dist-info/METADATA,sha256=uv-Z7g2o5rjRo8IsY9CRa-o5hsuAXJ7ahffynf82knM,159
-pywinpty-3.0.1.dist-info/WHEEL,sha256=K7foeVF-x_RZTycPKa1uE1HH2bAWe3AiJbihrXn5Hhc,96
-pywinpty-3.0.1.dist-info/licenses/LICENSE.txt,sha256=-HjUdn-a0uQ9MIPvoAIBsADOk32e6GJuALpccqrJUeI,1088
-winpty/OpenConsole.exe,sha256=6Dg0D2Gj8O-6rBrxtvgb31jYQDGM0fB2GQIlWrtWqmE,1148472
-winpty/__init__.py,sha256=laTi9sLjCLycyaQYO3wMvhZNIK2vh_pOvGTJT2Od4Qs,402
-winpty/conpty.dll,sha256=kliUMMhwG7vUzGvzCV_o8GdlaIh13W7EK6VKWwdHHoU,109624
-winpty/enums.py,sha256=KAm7XJFPk7nMWwUJxvYHlql92cr6y-Y24IHK3fc0JDU,1860
-winpty/ptyprocess.py,sha256=lub-1tL-LVUEY0e8s8J0VEbfWLsRdsx8gHyhagxdb28,12255
-winpty/tests/__init__.py,sha256=fzb9cDnPt2R3b_rWh6sqDgIbiQOZtBlfsV1aq-ULT2Q,53
-winpty/tests/test_pty.py,sha256=f6UKatWALTFM7jvcrqYWsRFCxosT-Aj0ChhvkN97ov4,3850
-winpty/tests/test_ptyprocess.py,sha256=QP0I-gufNV7OaZZFpRIC9J1XD4nq86NrR3oqi9s4OEI,5981
-winpty/winpty-agent.exe,sha256=REZ6g9hrYSe8e4duiy-zP6df3gnZuf8nx_jvhLqWmyk,2627338
-winpty/winpty.cp313-win_amd64.pyd,sha256=uz9tkIFqQgNENBjvtjNh56YfuvlGEaCJ3kxZiK5XIJo,581120
-winpty/winpty.dll,sha256=UXfzIarC-oVDbdbsa_xtQUWdJfW1M6oDNJ71E0YbTHk,2509089
-winpty/winpty.pyi,sha256=N8sy5oYzQGwtekPUSZ8Ai6Z9l3TcpNv-VOMjhRHByhs,1500
-pywinpty-3.0.1.dist-info/RECORD,,