-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Add pyperclip stubs #13502
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
srittau
merged 9 commits into
python:main
from
Xiddoc:add-pyperclip-and-clipboard-stubs
Feb 17, 2025
Merged
Add pyperclip stubs #13502
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
15a6124
Add types for pyperclip API
aad2a86
Explicitly type clipboard package as well (literal re-package of pype…
125339c
Add Protocol to represent DLL-imported low level functions for pyperclip
f62c887
Add dependency: clipboard package relies on pyperclip
6e1db2f
Both pyperclip and clipboard support all OSes
73fdc67
Pyperclip's main file is irrelevant
592ba1e
Fixed type for CheckedCall
321fdb5
Move clipboard stubs to new PR
b6b1490
Drop stubs for CheckedCall and added is_available
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| pyperclip.__main__ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| version = "1.9.*" | ||
| upstream_repository = "https://github.com/asweigart/pyperclip" | ||
|
|
||
| [tool.stubtest] | ||
| platforms = ["win32", "linux", "darwin"] | ||
| apt_dependencies = ["xclip"] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| __all__ = ["copy", "paste", "set_clipboard", "determine_clipboard"] | ||
|
|
||
| from collections.abc import Callable | ||
| from typing import Literal | ||
| from typing_extensions import TypeAlias | ||
|
|
||
| class PyperclipException(RuntimeError): ... | ||
|
|
||
| class PyperclipWindowsException(PyperclipException): | ||
| def __init__(self, message: str) -> None: ... | ||
|
|
||
| class PyperclipTimeoutException(PyperclipException): ... | ||
|
|
||
| _ClipboardMechanismName: TypeAlias = Literal[ | ||
| "pbcopy", "pyobjc", "qt", "xclip", "xsel", "wl-clipboard", "klipper", "windows", "no" | ||
| ] | ||
| _ClipboardCopyMechanism: TypeAlias = Callable[[str], None] | ||
| _ClipboardPasteMechanism: TypeAlias = Callable[[], str] | ||
|
|
||
| def copy(text: str) -> None: ... | ||
| def paste() -> str: ... | ||
| def set_clipboard(clipboard: _ClipboardMechanismName) -> None: ... | ||
| def determine_clipboard() -> tuple[_ClipboardCopyMechanism, _ClipboardPasteMechanism]: ... | ||
| def is_available() -> bool: ... | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is also
is_available(), and an example of using it in the module docstring:There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added!