Skip to content

add support for shareImage #457

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.

Sign up for GitHub

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

Open
typemytype wants to merge 9 commits into
base: master
Choose a base branch
from
Open

add support for shareImage #457

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
25140f1
add shareImage
typemytype Nov 30, 2021
0dca9f3
Merge branch 'master' into shareImage
typemytype Dec 6, 2021
fd2b524
use the context to generate the image and not the top level api insid…
typemytype Dec 7, 2021
d0ebc7a
mocking shareImage
typemytype Dec 7, 2021
ef8fc0c
silly me, rename the download code file name
typemytype Dec 7, 2021
34e29f1
adding test image
typemytype Dec 7, 2021
956531b
adding a delegate
typemytype Dec 24, 2021
736b932
simply wait a sec before removing the path
typemytype Dec 26, 2021
a6e452e
test incoming service and only pop up when saveImage is succes full
typemytype Dec 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions drawBot/drawBotDrawingTools.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

import math
import os
import tempfile
import random
from collections import namedtuple

Expand Down Expand Up @@ -462,6 +463,39 @@ def pdfImage(self):
self._drawInContext(context)
return context.getNSPDFDocument()

def shareImage(self, format="pdf", service="airdrop", **kwargs):
"""
Share the canvas to a service with a specified format.

As default the `format` is `pdf`, any suffix drawBot supports is possible.

`service` options are `airdrop`, `mail` or `message`.

.. downloadcode:: shareImage.py

# set A4 page size
newPage(200, 200)
# draw something
text("Foo, bar", (10, 10))
# share it over airdrop
shareImage('pdf', service="airdrop")
"""
path = tempfile.mkstemp(suffix=f".{format}")[1]
Copy link
Copy Markdown
Collaborator

@justvanrossum justvanrossum Dec 7, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Like I commented earlier, can we do this without a temp file? It's not being cleaned up, and I don't see how it could be. It's also not necessary as far as I can see: the sharing API works with all kinds of object, such as NSImage. Perhaps in-memory PDF data can be shared, too.

Copy link
Copy Markdown
Owner Author

@typemytype typemytype Dec 7, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A pdfDocument has no paste board support which is a requirement to send objects over.

The NSSharingService class is used to provide a consistent user experience when sharing items—NSURL objects, NSString objects, NSImage objects, video (through file URLs), or any object that implements the NSPasteboardWriting protocol—in macOS.

--> https://developer.apple.com/documentation/appkit/nssharingservice?language=objc

gif or mp4 has also no paste board support

its indeed not cleaned up, as it needs to be available during the sharing process

I could add a NSSharingServiceDelegate where a callback is received when the sharing is done

https://developer.apple.com/documentation/appkit/nssharingservicedelegate?language=objc

Copy link
Copy Markdown
Collaborator

@justvanrossum justvanrossum Dec 7, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then it indeed needs to be cleaned up with a delegate.

Copy link
Copy Markdown
Owner Author

@typemytype typemytype Dec 7, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is silly: the delegate removes the assets to fast and fe mail can not find it anymore...

see https://gist.github.com/typemytype/ea02152e754a5b0225df2df23976afd5


context = getContextForFileExt("pdf")
Copy link
Copy Markdown
Collaborator

@justvanrossum justvanrossum Dec 7, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Btw. why does this go via the pdf context and not via the regular saveImage()? Would this work for anything but pdf?

Copy link
Copy Markdown
Owner Author

@typemytype typemytype Dec 7, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cause it needs to be format this is wrong of me :)

Copy link
Copy Markdown
Collaborator

@justvanrossum justvanrossum Dec 7, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question still stands: why not plain saveImage()?

Copy link
Copy Markdown
Owner Author

@typemytype typemytype Dec 7, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

must be self.saveImage(..) indeed

context.saveImage(path, **kwargs)

serviceMap = dict(
airdrop=AppKit.NSSharingServiceNameSendViaAirDrop,
mail=AppKit.NSSharingServiceNameComposeEmail,
message=AppKit.NSSharingServiceNameComposeMessage,
)

sharingService = AppKit.NSSharingService.sharingServiceNamed_(serviceMap[service])
sharingService.performWithItems_([
AppKit.NSURL.fileURLWithPath_(path)
])

# graphics state

def save(self):
Expand Down
Binary file added tests/data/example_shareImage.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions tests/testExamples.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,9 @@ def mockVariable(definitions, namespace):
def mockPrintImage(pdf=None):
pass

def mockShareImage(path, **kwargs):
pass

def mockInstallFont(path):
return "Helvetica"

Expand Down Expand Up @@ -139,6 +142,7 @@ def mockSaveImage(path, **options):
namespace["imagePixelColor"] = mockImagePixelColor
namespace["Variable"] = mockVariable
namespace["printImage"] = mockPrintImage
namespace["shareImage"] = mockShareImage
namespace["installFont"] = mockInstallFont
namespace["uninstallFont"] = mockUninstallFont
namespace["randint"] = mockRandInt
Expand Down