Logic around interpreting(…encoder=None, display=['any/mimetype'])

[mpacer]

This is arising from some confusion I'm having around the current glue displaying api. I am likely to create a few issues like this… I'm guessing most of them will be closed without action.

scrapbook/scrapbook/api.py

Lines 82 to 84 in e06182f

	# TODO: default to 'display' encoder when encoder is None and object is a display object type?
	if display is None:
	display = encoder == "display"

The comment seems to say one thing is intended and then the behaviour is otherwise, where if the display is not None, and encoder is undefined, then it is assumed to not be display.

However, if I'm defining a display type (so display would be not None but also would not evaluate to False), it would seem to be reasonable to encode it as a display as well (without needing to declare it as the display encoder).

So should the logic earlier include something like

if encoder is None and display:
    encoder = "display"

?

[MSeal]

Ahh that comment should probably be up in

scrapbook/scrapbook/api.py

Lines 69 to 73 in e06182f

	# TODO: Implement the cool stuff. Remote storage indicators?!? Maybe remote media type?!?
	# TODO: Make this more modular
	# TODO: Use translators to determine best storage type
	# ...
	if not encoder:

as I was thinking that there maybe should be an encoder that can detect ipython display objects automatically to set the encoder to display.

Doing if encoder is None and display: below the encoder selector where will never trigger because the lines above will always assign json if nothing is found:

scrapbook/scrapbook/api.py

Lines 78 to 80 in e06182f

	else:
	# This may be more complex in the future
	encoder = "json"

. Are you thinking we should add the proposed line above the encoder selector block that's there today? I think that'd be a reasonable change.

I'm addressing many of the TODO's in the reference data PR I'm still working on, but hadn't tackled making a display encoder, maybe this solution you proposed would be more elegant and easy to read. Want to PR it?