Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Pasteboard exposes Python bindings for reading and writing macOS' AppKit NSPasteboard. This allows retrieving different formats (HTML/RTF fragments, PDF/PNG/TIFF) and efficient polling of the pasteboard.
Now with type hints!
Python 3.8+ is required. Obviously, this module will only compile on macOS:
pip install pasteboard
>>> import pasteboard
>>> pb = pasteboard.Pasteboard()
>>> pb.get_contents()
'pasteboard'
>>> pb.get_contents(diff=True)
>>>
Unsurprisingly, get_contents
gets the contents of the pasteboard. This method
takes two optional arguments:
type - The format to get. Defaults to pasteboard.String
, which corresponds
to NSPasteboardTypeString. See the pasteboard
module members for other
options such as HTML fragment, RTF, PDF, PNG, and TIFF. Not all formats of NSPasteboardType are implemented.
diff - Defaults to False
. When True
, only get and return the contents if it has changed since the last call. Otherwise, None
is returned. This can be used to efficiently monitor the pasteboard for changes, which must be done by polling (there is no option to subscribe to changes).
get_contents
will return the appropriate type, so str for string types,
and bytes for binary types. None
is returned when:
True
, and the contents has not changed since the last call>>> import pasteboard
>>> pb = pasteboard.Pasteboard()
>>> pb.set_contents('pasteboard')
True
>>>
Analogously, set_contents
sets the contents of the pasteboard. This method
takes two arguments:
data - str or bytes-like object, required. There is no type checking. So if type
indicates a string type and data
is bytes-like but not UTF-8 encoded, the behaviour is undefined.
type - The format to set. Defaults to pasteboard.String
, which corresponds to NSPasteboardTypeString. See the pasteboard
module members for other options such as HTML fragment, RTF, PDF, PNG, and TIFF. Not all formats of NSPasteboardType are implemented.
set_contents
will return True
if the pasteboard was successfully set; otherwise, False
. It may also throw RuntimeError if data
can't be converted to an AppKit type.
>>> import pasteboard
>>> pb = pasteboard.Pasteboard()
>>> pb.get_file_urls()
('/Users/<user>/Documents/foo.txt', '/Users/<user>/Documents/bar.txt')
Warning This API is new, and may change in future.
Returns a Tuple
of strings, or None
. Also supports the diff parameter analogue to get_contents
.
You don't need to know this if you're not changing pasteboard.m
code. There are some integration tests in tests.py
to check the module works as designed (using pytest and hypothesis).
This project uses pre-commit to run some linting hooks when committing. When you first clone the repo, please run:
pre-commit install
You may also run the hooks at any time:
pre-commit run --all-files
To install development dependencies, use:
python3 -m venv env
source env/bin/activate
pip install .[dev]
This will also install development dependencies (pytest
). To run the tests:
pytest tests.py --verbose
From version 0.3.0 and forwards, this library is licensed under the Mozilla Public License Version 2.0. For more information, see LICENSE
.
FAQs
Pasteboard - Python interface for reading from NSPasteboard (macOS clipboard)
We found that pasteboard demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.