Safe Haskell	Safe-Inferred
Language	Haskell2010

IHaskell.IPython.Types

Contents

IPython kernel profile
IPython kernelspecs
IPython messaging protocol
- IPython display data message

Description

This module contains all types used to create an IPython language kernel.

Synopsis

data Profile = Profile {
- ip :: IP
- transport :: Transport
- stdinPort :: Port
- controlPort :: Port
- hbPort :: Port
- shellPort :: Port
- iopubPort :: Port
- signatureKey :: ByteString
}
data Transport = TCP
type Port = Int
type IP = String
data KernelSpec = KernelSpec {
- kernelDisplayName :: String
- kernelLanguage :: String
- kernelCommand :: [String]
}
data Message
- = KernelInfoRequest {
  - header :: MessageHeader
  }
- | KernelInfoReply {
  - header :: MessageHeader
  - protocolVersion :: String
  - banner :: String
  - implementation :: String
  - implementationVersion :: String
  - languageInfo :: LanguageInfo
  - status :: ExecuteReplyStatus
  }
- | CommInfoRequest {
  - header :: MessageHeader
  }
- | CommInfoReply {
  - header :: MessageHeader
  - commInfo :: Map String String
  }
- | ExecuteInput {
  - header :: MessageHeader
  - getCode :: Text
  - executionCounter :: Int
  }
- | ExecuteRequest {
  - header :: MessageHeader
  - getCode :: Text
  - getSilent :: Bool
  - getStoreHistory :: Bool
  - getAllowStdin :: Bool
  - getUserVariables :: [Text]
  - getUserExpressions :: [Text]
  }
- | ExecuteReply {
  - header :: MessageHeader
  - status :: ExecuteReplyStatus
  - pagerOutput :: [DisplayData]
  - executionCounter :: Int
  }
- | ExecuteResult {
  - header :: MessageHeader
  - dataResult :: [DisplayData]
  - metadataResult :: Map String String
  - executionCounter :: Int
  }
- | ExecuteError {
  - header :: MessageHeader
  - traceback :: [Text]
  - ename :: Text
  - evalue :: Text
  }
- | PublishStatus {
  - header :: MessageHeader
  - executionState :: ExecutionState
  }
- | PublishStream {
  - header :: MessageHeader
  - streamType :: StreamType
  - streamContent :: String
  }
- | PublishDisplayData {
  - header :: MessageHeader
  - displayData :: [DisplayData]
  - transient :: Maybe Transient
  }
- | PublishUpdateDisplayData {
  - header :: MessageHeader
  - displayData :: [DisplayData]
  - transient :: Maybe Transient
  }
- | PublishOutput {
  - header :: MessageHeader
  - reprText :: String
  - executionCount :: Int
  }
- | PublishInput {
  - header :: MessageHeader
  - inCode :: String
  - executionCount :: Int
  }
- | Input {
  - header :: MessageHeader
  - getCode :: Text
  - executionCount :: Int
  }
- | Output {
  - header :: MessageHeader
  - getText :: [DisplayData]
  - executionCount :: Int
  }
- | IsCompleteRequest {
  - header :: MessageHeader
  - inputToReview :: String
  }
- | IsCompleteReply {
  - header :: MessageHeader
  - reviewResult :: CodeReview
  }
- | CompleteRequest {
  - header :: MessageHeader
  - getCode :: Text
  - getCursorPos :: Int
  }
- | CompleteReply {
  - header :: MessageHeader
  - completionMatches :: [Text]
  - completionCursorStart :: Int
  - completionCursorEnd :: Int
  - completionMetadata :: Metadata
  - completionStatus :: Bool
  }
- | InspectRequest {
  - header :: MessageHeader
  - inspectCode :: Text
  - inspectCursorPos :: Int
  - detailLevel :: Int
  }
- | InspectReply {
  - header :: MessageHeader
  - inspectStatus :: Bool
  - inspectData :: [DisplayData]
  }
- | ShutdownRequest {
  - header :: MessageHeader
  - restartPending :: Bool
  }
- | ShutdownReply {
  - header :: MessageHeader
  - restartPending :: Bool
  }
- | ClearOutput {
  - header :: MessageHeader
  - wait :: Bool
  }
- | RequestInput {
  - header :: MessageHeader
  - inputPrompt :: String
  }
- | InputReply {
  - header :: MessageHeader
  - inputValue :: String
  }
- | CommOpen {
  - header :: MessageHeader
  - commTargetName :: String
  - commTargetModule :: String
  - commUuid :: UUID
  - commData :: Value
  }
- | CommData {
  - header :: MessageHeader
  - commUuid :: UUID
  - commData :: Value
  }
- | CommClose {
  - header :: MessageHeader
  - commUuid :: UUID
  - commData :: Value
  }
- | HistoryRequest {
  - header :: MessageHeader
  - historyGetOutput :: Bool
  - historyRaw :: Bool
  - historyAccessType :: HistoryAccessType
  }
- | HistoryReply {
  - header :: MessageHeader
  - historyReply :: [HistoryReplyElement]
  }
- | SendNothing
data MessageHeader = MessageHeader {
- mhIdentifiers :: [ByteString]
- mhParentHeader :: Maybe MessageHeader
- mhMetadata :: Metadata
- mhMessageId :: UUID
- mhSessionId :: UUID
- mhUsername :: Username
- mhMsgType :: MessageType
- mhBuffers :: [ByteString]
}
type Username = Text
newtype Transient = Transient {
- transientDisplayId :: UUID
}
data MessageType
- = KernelInfoReplyMessage
- | KernelInfoRequestMessage
- | ExecuteInputMessage
- | ExecuteReplyMessage
- | ExecuteErrorMessage
- | ExecuteRequestMessage
- | ExecuteResultMessage
- | StatusMessage
- | StreamMessage
- | DisplayDataMessage
- | UpdateDisplayDataMessage
- | OutputMessage
- | InputMessage
- | IsCompleteRequestMessage
- | IsCompleteReplyMessage
- | CompleteRequestMessage
- | CompleteReplyMessage
- | InspectRequestMessage
- | InspectReplyMessage
- | ShutdownRequestMessage
- | ShutdownReplyMessage
- | ClearOutputMessage
- | InputRequestMessage
- | InputReplyMessage
- | CommOpenMessage
- | CommDataMessage
- | CommInfoRequestMessage
- | CommInfoReplyMessage
- | CommCloseMessage
- | HistoryRequestMessage
- | HistoryReplyMessage
data CodeReview
- = CodeComplete
- | CodeIncomplete String
- | CodeInvalid
- | CodeUnknown
type Width = Int
type Height = Int
data StreamType
- = Stdin
- | Stdout
- | Stderr
data ExecutionState
- = Busy
- | Idle
- | Starting
data ExecuteReplyStatus
- = Ok
- | Err
- | Abort
data HistoryAccessType
- = HistoryRange
- | HistoryTail
- | HistorySearch
data HistoryReplyElement = HistoryReplyElement {
- historyReplySession :: Int
- historyReplyLineNumber :: Int
- historyReplyContent :: Either String (String, String)
}
data LanguageInfo = LanguageInfo {
- languageName :: String
- languageVersion :: String
- languageFileExtension :: String
- languageCodeMirrorMode :: String
- languagePygmentsLexer :: String
- languageMimeType :: String
}
newtype Metadata = Metadata Object
replyType :: MessageType -> Maybe MessageType
showMessageType :: MessageType -> String
data DisplayData = DisplayData MimeType Text
data MimeType
- = PlainText
- | MimeHtml
- | MimeBmp Width Height
- | MimePng Width Height
- | MimeJpg Width Height
- | MimeGif Width Height
- | MimeSvg
- | MimeLatex
- | MimeMarkdown
- | MimeJavascript
- | MimeJson
- | MimeVega
- | MimeVegalite
- | MimeVdom
- | MimeWidget
- | MimeCustom Text
extractPlain :: [DisplayData] -> String
displayDataToJson :: DisplayData -> (Key, Value)

IPython kernel profile

data Profile Source #

A kernel profile, specifying how the kernel communicates.

Constructors

Profile
Fields ip :: IP The IP on which to listen. transport :: Transport The transport mechanism. stdinPort :: Port The stdin channel port. controlPort :: Port The control channel port. hbPort :: Port The heartbeat channel port. shellPort :: Port The shell command port. iopubPort :: Port The IOPub port. signatureKey :: ByteString The HMAC encryption key.

Instances

Instances details

FromJSON Profile Source #
Instance details Defined in IHaskell.IPython.Types Methods parseJSON :: Value -> Parser Profile # parseJSONList :: Value -> Parser [Profile] #
ToJSON Profile Source #
Instance details Defined in IHaskell.IPython.Types Methods toJSON :: Profile -> Value # toEncoding :: Profile -> Encoding # toJSONList :: [Profile] -> Value # toEncodingList :: [Profile] -> Encoding #
Read Profile Source #
Instance details Defined in IHaskell.IPython.Types Methods readsPrec :: Int -> ReadS Profile # readList :: ReadS [Profile] # readPrec :: ReadPrec Profile # readListPrec :: ReadPrec [Profile] #
Show Profile Source #
Instance details Defined in IHaskell.IPython.Types Methods showsPrec :: Int -> Profile -> ShowS # show :: Profile -> String # showList :: [Profile] -> ShowS #

data Transport Source #

The transport mechanism used to communicate with the IPython frontend.

Constructors

TCP	Default transport mechanism via TCP.

Instances

Instances details

FromJSON Transport Source #
Instance details Defined in IHaskell.IPython.Types Methods parseJSON :: Value -> Parser Transport # parseJSONList :: Value -> Parser [Transport] #
ToJSON Transport Source #
Instance details Defined in IHaskell.IPython.Types Methods toJSON :: Transport -> Value # toEncoding :: Transport -> Encoding # toJSONList :: [Transport] -> Value # toEncodingList :: [Transport] -> Encoding #
Read Transport Source #
Instance details Defined in IHaskell.IPython.Types Methods readsPrec :: Int -> ReadS Transport # readList :: ReadS [Transport] # readPrec :: ReadPrec Transport # readListPrec :: ReadPrec [Transport] #
Show Transport Source #
Instance details Defined in IHaskell.IPython.Types Methods showsPrec :: Int -> Transport -> ShowS # show :: Transport -> String # showList :: [Transport] -> ShowS #

type Port = Int Source #

A TCP port.

type IP = String Source #

An IP address.

IPython kernelspecs

data KernelSpec Source #

Constructors

KernelSpec
Fields kernelDisplayName :: String Name shown to users to describe this kernel (e.g. Haskell) kernelLanguage :: String Name for the kernel; unique kernel identifier (e.g. "haskell") kernelCommand :: [String] Command to run to start the kernel. One of the strings maybe `"{connection_file}"`, which will be replaced by the path to a kernel profile file (see `Profile`) when the command is run.

Instances

Instances details

ToJSON KernelSpec Source #
Instance details Defined in IHaskell.IPython.Types Methods toJSON :: KernelSpec -> Value # toEncoding :: KernelSpec -> Encoding # toJSONList :: [KernelSpec] -> Value # toEncodingList :: [KernelSpec] -> Encoding #
Show KernelSpec Source #
Instance details Defined in IHaskell.IPython.Types Methods showsPrec :: Int -> KernelSpec -> ShowS # show :: KernelSpec -> String # showList :: [KernelSpec] -> ShowS #
Eq KernelSpec Source #
Instance details Defined in IHaskell.IPython.Types Methods (==) :: KernelSpec -> KernelSpec -> Bool # (/=) :: KernelSpec -> KernelSpec -> Bool #

IPython messaging protocol

data Message Source #

A message used to communicate with the IPython frontend.

See https://jupyter-client.readthedocs.io/en/stable/messaging.html

Constructors

KernelInfoRequest	A request from a frontend for information about the kernel.
Fields header :: MessageHeader Unused field retained for backwards compatibility.
KernelInfoReply	A response to a KernelInfoRequest.
Fields header :: MessageHeader Unused field retained for backwards compatibility. protocolVersion :: String current protocol version, major and minor banner :: String Kernel information description e.g. (IHaskell 0.8.3.0 GHC 7.10.2) implementation :: String e.g. IHaskell implementationVersion :: String The version of the implementation languageInfo :: LanguageInfo status :: ExecuteReplyStatus The status of the output.
CommInfoRequest	A request from a frontend for information about the comms.
Fields header :: MessageHeader Unused field retained for backwards compatibility.
CommInfoReply	A response to a CommInfoRequest.
Fields header :: MessageHeader Unused field retained for backwards compatibility. commInfo :: Map String String A dictionary of the comms, indexed by uuids.
ExecuteInput	A request from a frontend to execute some code.
Fields header :: MessageHeader Unused field retained for backwards compatibility. getCode :: Text The code string. executionCounter :: Int The execution count, i.e. which output this is.
ExecuteRequest	A request from a frontend to execute some code.
Fields header :: MessageHeader Unused field retained for backwards compatibility. getCode :: Text The code string. getSilent :: Bool Whether this should be silently executed. getStoreHistory :: Bool Whether to store this in history. getAllowStdin :: Bool Whether this code can use stdin. getUserVariables :: [Text] Unused. getUserExpressions :: [Text] Unused.
ExecuteReply	A reply to an execute request.
Fields header :: MessageHeader Unused field retained for backwards compatibility. status :: ExecuteReplyStatus The status of the output. pagerOutput :: [DisplayData] The mimebundles to display in the pager. executionCounter :: Int The execution count, i.e. which output this is.
ExecuteResult	A reply to an execute request.
Fields header :: MessageHeader Unused field retained for backwards compatibility. dataResult :: [DisplayData] Key/value pairs (keys are MIME types) metadataResult :: Map String String Any metadata that describes the data executionCounter :: Int The execution count, i.e. which output this is.
ExecuteError	An error reply to an execute request
Fields header :: MessageHeader Unused field retained for backwards compatibility. traceback :: [Text] ename :: Text evalue :: Text
PublishStatus
Fields header :: MessageHeader Unused field retained for backwards compatibility. executionState :: ExecutionState The execution state of the kernel.
PublishStream
Fields header :: MessageHeader Unused field retained for backwards compatibility. streamType :: StreamType Which stream to publish to. streamContent :: String What to publish.
PublishDisplayData
Fields header :: MessageHeader Unused field retained for backwards compatibility. displayData :: [DisplayData] A list of data representations. transient :: Maybe Transient
PublishUpdateDisplayData
Fields header :: MessageHeader Unused field retained for backwards compatibility. displayData :: [DisplayData] A list of data representations. transient :: Maybe Transient
PublishOutput
Fields header :: MessageHeader Unused field retained for backwards compatibility. reprText :: String Printed output text. executionCount :: Int Which output this is for.
PublishInput
Fields header :: MessageHeader Unused field retained for backwards compatibility. inCode :: String Submitted input code. executionCount :: Int Which output this is for.
Input
Fields header :: MessageHeader Unused field retained for backwards compatibility. getCode :: Text The code string. executionCount :: Int Which output this is for.
Output
Fields header :: MessageHeader Unused field retained for backwards compatibility. getText :: [DisplayData] executionCount :: Int Which output this is for.
IsCompleteRequest
Fields header :: MessageHeader Unused field retained for backwards compatibility. inputToReview :: String The code entered in the repl.
IsCompleteReply
Fields header :: MessageHeader Unused field retained for backwards compatibility. reviewResult :: CodeReview The result of reviewing the code.
CompleteRequest
Fields header :: MessageHeader Unused field retained for backwards compatibility. getCode :: Text The code string. getCursorPos :: Int Position of the cursor in unicode characters. json field `cursor_pos`
CompleteReply
Fields header :: MessageHeader Unused field retained for backwards compatibility. completionMatches :: [Text] completionCursorStart :: Int completionCursorEnd :: Int completionMetadata :: Metadata completionStatus :: Bool
InspectRequest
Fields header :: MessageHeader Unused field retained for backwards compatibility. inspectCode :: Text The code context in which introspection is requested inspectCursorPos :: Int Position of the cursor in unicode characters. json field `cursor_pos` detailLevel :: Int Level of detail desired (defaults to 0). 0 is equivalent to foo?, 1 is equivalent to foo??.
InspectReply
Fields header :: MessageHeader Unused field retained for backwards compatibility. inspectStatus :: Bool whether the request succeeded or failed inspectData :: [DisplayData] `inspectData` can be empty if nothing is found
ShutdownRequest
Fields header :: MessageHeader Unused field retained for backwards compatibility. restartPending :: Bool Whether this shutdown precedes a restart.
ShutdownReply
Fields header :: MessageHeader Unused field retained for backwards compatibility. restartPending :: Bool Whether this shutdown precedes a restart.
ClearOutput
Fields header :: MessageHeader Unused field retained for backwards compatibility. wait :: Bool Whether to wait to redraw until there is more output.
RequestInput
Fields header :: MessageHeader Unused field retained for backwards compatibility. inputPrompt :: String
InputReply
Fields header :: MessageHeader Unused field retained for backwards compatibility. inputValue :: String
CommOpen
Fields header :: MessageHeader Unused field retained for backwards compatibility. commTargetName :: String commTargetModule :: String commUuid :: UUID commData :: Value
CommData
Fields header :: MessageHeader Unused field retained for backwards compatibility. commUuid :: UUID commData :: Value
CommClose
Fields header :: MessageHeader Unused field retained for backwards compatibility. commUuid :: UUID commData :: Value
HistoryRequest
Fields header :: MessageHeader Unused field retained for backwards compatibility. historyGetOutput :: Bool If True, also return output history in the resulting dict. historyRaw :: Bool If True, return the raw input history, else the transformed input. historyAccessType :: HistoryAccessType What history is being requested.
HistoryReply
Fields header :: MessageHeader Unused field retained for backwards compatibility. historyReply :: [HistoryReplyElement]
SendNothing

Instances

Instances details

ToJSON Message Source #
Instance details Defined in IHaskell.IPython.Types Methods toJSON :: Message -> Value # toEncoding :: Message -> Encoding # toJSONList :: [Message] -> Value # toEncodingList :: [Message] -> Encoding #
Show Message Source #
Instance details Defined in IHaskell.IPython.Types Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #

data MessageHeader Source #

A message header with some metadata.

Constructors

MessageHeader

Fields

mhIdentifiers :: [ByteString]
The identifiers sent with the message.
mhParentHeader :: Maybe MessageHeader
The parent header, if present.
mhMetadata :: Metadata
A dict of metadata.
mhMessageId :: UUID
A unique message UUID.
mhSessionId :: UUID
A unique session UUID.
mhUsername :: Username
The user who sent this message.
mhMsgType :: MessageType
The message type.
mhBuffers :: [ByteString]
Extra raw data buffer(s)

Instances

Instances details

ToJSON MessageHeader Source #
Instance details Defined in IHaskell.IPython.Types Methods toJSON :: MessageHeader -> Value # toEncoding :: MessageHeader -> Encoding # toJSONList :: [MessageHeader] -> Value # toEncodingList :: [MessageHeader] -> Encoding #
Read MessageHeader Source #
Instance details Defined in IHaskell.IPython.Types Methods readsPrec :: Int -> ReadS MessageHeader # readList :: ReadS [MessageHeader] # readPrec :: ReadPrec MessageHeader # readListPrec :: ReadPrec [MessageHeader] #
Show MessageHeader Source #
Instance details Defined in IHaskell.IPython.Types Methods showsPrec :: Int -> MessageHeader -> ShowS # show :: MessageHeader -> String # showList :: [MessageHeader] -> ShowS #

type Username = Text Source #

A username for the source of a message.

newtype Transient Source #

Constructors

Transient
Fields transientDisplayId :: UUID

Instances

Instances details

ToJSON Transient Source #
Instance details Defined in IHaskell.IPython.Types Methods toJSON :: Transient -> Value # toEncoding :: Transient -> Encoding # toJSONList :: [Transient] -> Value # toEncodingList :: [Transient] -> Encoding #
Show Transient Source #
Instance details Defined in IHaskell.IPython.Types Methods showsPrec :: Int -> Transient -> ShowS # show :: Transient -> String # showList :: [Transient] -> ShowS #
Eq Transient Source #
Instance details Defined in IHaskell.IPython.Types Methods (==) :: Transient -> Transient -> Bool # (/=) :: Transient -> Transient -> Bool #

data MessageType Source #

The type of a message, corresponding to IPython message types.

Instances

Instances details

FromJSON MessageType Source #
Instance details Defined in IHaskell.IPython.Types Methods parseJSON :: Value -> Parser MessageType # parseJSONList :: Value -> Parser [MessageType] #
Read MessageType Source #
Instance details Defined in IHaskell.IPython.Types Methods readsPrec :: Int -> ReadS MessageType # readList :: ReadS [MessageType] # readPrec :: ReadPrec MessageType # readListPrec :: ReadPrec [MessageType] #
Show MessageType Source #
Instance details Defined in IHaskell.IPython.Types Methods showsPrec :: Int -> MessageType -> ShowS # show :: MessageType -> String # showList :: [MessageType] -> ShowS #
Eq MessageType Source #
Instance details Defined in IHaskell.IPython.Types Methods (==) :: MessageType -> MessageType -> Bool # (/=) :: MessageType -> MessageType -> Bool #

data CodeReview Source #

Constructors

CodeComplete
CodeIncomplete String	String to be used to indent next line of input
CodeInvalid
CodeUnknown

Instances

Instances details

Show CodeReview Source #
Instance details Defined in IHaskell.IPython.Types Methods showsPrec :: Int -> CodeReview -> ShowS # show :: CodeReview -> String # showList :: [CodeReview] -> ShowS #

type Width = Int Source #

Possible MIME types for the display data.

type Height = Int Source #

data StreamType Source #

Input and output streams.

Constructors

Stdin
Stdout
Stderr

Instances

Instances details

FromJSON StreamType Source #
Instance details Defined in IHaskell.IPython.Types Methods parseJSON :: Value -> Parser StreamType # parseJSONList :: Value -> Parser [StreamType] #
ToJSON StreamType Source #	Print a stream as "stdin" or "stdout" strings.
Instance details Defined in IHaskell.IPython.Types Methods toJSON :: StreamType -> Value # toEncoding :: StreamType -> Encoding # toJSONList :: [StreamType] -> Value # toEncodingList :: [StreamType] -> Encoding #
Show StreamType Source #
Instance details Defined in IHaskell.IPython.Types Methods showsPrec :: Int -> StreamType -> ShowS # show :: StreamType -> String # showList :: [StreamType] -> ShowS #

data ExecutionState Source #

The execution state of the kernel.

Constructors

Busy
Idle
Starting

Instances

Instances details

FromJSON ExecutionState Source #
Instance details Defined in IHaskell.IPython.Types Methods parseJSON :: Value -> Parser ExecutionState # parseJSONList :: Value -> Parser [ExecutionState] #
ToJSON ExecutionState Source #	Print an execution state as "busy", "idle", or "starting".
Instance details Defined in IHaskell.IPython.Types Methods toJSON :: ExecutionState -> Value # toEncoding :: ExecutionState -> Encoding # toJSONList :: [ExecutionState] -> Value # toEncodingList :: [ExecutionState] -> Encoding #
Show ExecutionState Source #
Instance details Defined in IHaskell.IPython.Types Methods showsPrec :: Int -> ExecutionState -> ShowS # show :: ExecutionState -> String # showList :: [ExecutionState] -> ShowS #

data ExecuteReplyStatus Source #

Possible statuses in the execution reply messages.

Constructors

Ok
Err
Abort

Instances

Instances details

FromJSON ExecuteReplyStatus Source #
Instance details Defined in IHaskell.IPython.Types Methods parseJSON :: Value -> Parser ExecuteReplyStatus # parseJSONList :: Value -> Parser [ExecuteReplyStatus] #
Show ExecuteReplyStatus Source #
Instance details Defined in IHaskell.IPython.Types Methods showsPrec :: Int -> ExecuteReplyStatus -> ShowS # show :: ExecuteReplyStatus -> String # showList :: [ExecuteReplyStatus] -> ShowS #

data HistoryAccessType Source #

Ways in which the frontend can request history. TODO: Implement fields as described in messaging spec.

Constructors

HistoryRange
HistoryTail
HistorySearch

Instances

Instances details

Show HistoryAccessType Source #
Instance details Defined in IHaskell.IPython.Types Methods showsPrec :: Int -> HistoryAccessType -> ShowS # show :: HistoryAccessType -> String # showList :: [HistoryAccessType] -> ShowS #
Eq HistoryAccessType Source #
Instance details Defined in IHaskell.IPython.Types Methods (==) :: HistoryAccessType -> HistoryAccessType -> Bool # (/=) :: HistoryAccessType -> HistoryAccessType -> Bool #

data HistoryReplyElement Source #

Reply to history requests.

Constructors

HistoryReplyElement
Fields historyReplySession :: Int historyReplyLineNumber :: Int historyReplyContent :: Either String (String, String)

Instances

Instances details

Show HistoryReplyElement Source #
Instance details Defined in IHaskell.IPython.Types Methods showsPrec :: Int -> HistoryReplyElement -> ShowS # show :: HistoryReplyElement -> String # showList :: [HistoryReplyElement] -> ShowS #
Eq HistoryReplyElement Source #
Instance details Defined in IHaskell.IPython.Types Methods (==) :: HistoryReplyElement -> HistoryReplyElement -> Bool # (/=) :: HistoryReplyElement -> HistoryReplyElement -> Bool #

data LanguageInfo Source #

Kernel language info, see

Constructors

LanguageInfo
Fields languageName :: String The language name, e.g. "haskell" languageVersion :: String GHC 7.6.3 languageFileExtension :: String .hs languageCodeMirrorMode :: String `ihaskell`. can be `null` languagePygmentsLexer :: String languageMimeType :: String

Instances

Instances details

ToJSON LanguageInfo Source #
Instance details Defined in IHaskell.IPython.Types Methods toJSON :: LanguageInfo -> Value # toEncoding :: LanguageInfo -> Encoding # toJSONList :: [LanguageInfo] -> Value # toEncodingList :: [LanguageInfo] -> Encoding #
Show LanguageInfo Source #
Instance details Defined in IHaskell.IPython.Types Methods showsPrec :: Int -> LanguageInfo -> ShowS # show :: LanguageInfo -> String # showList :: [LanguageInfo] -> ShowS #
Eq LanguageInfo Source #
Instance details Defined in IHaskell.IPython.Types Methods (==) :: LanguageInfo -> LanguageInfo -> Bool # (/=) :: LanguageInfo -> LanguageInfo -> Bool #

newtype Metadata Source #

A metadata dictionary.

Constructors

Metadata Object

Instances

Instances details

ToJSON Metadata Source #
Instance details Defined in IHaskell.IPython.Types Methods toJSON :: Metadata -> Value # toEncoding :: Metadata -> Encoding # toJSONList :: [Metadata] -> Value # toEncodingList :: [Metadata] -> Encoding #
Monoid Metadata Source #
Instance details Defined in IHaskell.IPython.Types Methods mempty :: Metadata # mappend :: Metadata -> Metadata -> Metadata # mconcat :: [Metadata] -> Metadata #
Semigroup Metadata Source #
Instance details Defined in IHaskell.IPython.Types Methods (<>) :: Metadata -> Metadata -> Metadata # sconcat :: NonEmpty Metadata -> Metadata # stimes :: Integral b => b -> Metadata -> Metadata #
Read Metadata Source #
Instance details Defined in IHaskell.IPython.Types Methods readsPrec :: Int -> ReadS Metadata # readList :: ReadS [Metadata] # readPrec :: ReadPrec Metadata # readListPrec :: ReadPrec [Metadata] #
Show Metadata Source #
Instance details Defined in IHaskell.IPython.Types Methods showsPrec :: Int -> Metadata -> ShowS # show :: Metadata -> String # showList :: [Metadata] -> ShowS #

replyType :: MessageType -> Maybe MessageType Source #

Get the reply message type for a request message type.

showMessageType :: MessageType -> String Source #

IPython display data message

data DisplayData Source #

Data for display: a string with associated MIME type.

Constructors

DisplayData MimeType Text

Instances

Instances details

Generic DisplayData Source #
Instance details Defined in IHaskell.IPython.Types Associated Types type Rep DisplayData :: Type -> Type # Methods from :: DisplayData -> Rep DisplayData x # to :: Rep DisplayData x -> DisplayData #
Show DisplayData Source #
Instance details Defined in IHaskell.IPython.Types Methods showsPrec :: Int -> DisplayData -> ShowS # show :: DisplayData -> String # showList :: [DisplayData] -> ShowS #
Binary DisplayData Source #
Instance details Defined in IHaskell.IPython.Types Methods put :: DisplayData -> Put # get :: Get DisplayData # putList :: [DisplayData] -> Put #
Eq DisplayData Source #
Instance details Defined in IHaskell.IPython.Types Methods (==) :: DisplayData -> DisplayData -> Bool # (/=) :: DisplayData -> DisplayData -> Bool #
type Rep DisplayData Source #
Instance details Defined in IHaskell.IPython.Types type Rep DisplayData = D1 ('MetaData "DisplayData" "IHaskell.IPython.Types" "ipython-kernel-0.11.0.0-GlmZ6swXw3x3fGdtSywazY" 'False) (C1 ('MetaCons "DisplayData" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MimeType) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data MimeType Source #

Instances

Instances details

Generic MimeType Source #
Instance details Defined in IHaskell.IPython.Types Associated Types type Rep MimeType :: Type -> Type # Methods from :: MimeType -> Rep MimeType x # to :: Rep MimeType x -> MimeType #
Read MimeType Source #
Instance details Defined in IHaskell.IPython.Types Methods readsPrec :: Int -> ReadS MimeType # readList :: ReadS [MimeType] # readPrec :: ReadPrec MimeType # readListPrec :: ReadPrec [MimeType] #
Show MimeType Source #
Instance details Defined in IHaskell.IPython.Types Methods showsPrec :: Int -> MimeType -> ShowS # show :: MimeType -> String # showList :: [MimeType] -> ShowS #
Binary MimeType Source #
Instance details Defined in IHaskell.IPython.Types Methods put :: MimeType -> Put # get :: Get MimeType # putList :: [MimeType] -> Put #
Eq MimeType Source #
Instance details Defined in IHaskell.IPython.Types Methods (==) :: MimeType -> MimeType -> Bool # (/=) :: MimeType -> MimeType -> Bool #
type Rep MimeType Source #
Instance details Defined in IHaskell.IPython.Types type Rep MimeType = D1 ('MetaData "MimeType" "IHaskell.IPython.Types" "ipython-kernel-0.11.0.0-GlmZ6swXw3x3fGdtSywazY" 'False) ((((C1 ('MetaCons "PlainText" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MimeHtml" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "MimeBmp" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Width) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Height)) :+: C1 ('MetaCons "MimePng" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Width) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Height)))) :+: ((C1 ('MetaCons "MimeJpg" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Width) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Height)) :+: C1 ('MetaCons "MimeGif" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Width) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Height))) :+: (C1 ('MetaCons "MimeSvg" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MimeLatex" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: (((C1 ('MetaCons "MimeMarkdown" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MimeJavascript" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "MimeJson" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MimeVega" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "MimeVegalite" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MimeVdom" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "MimeWidget" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MimeCustom" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))))

extractPlain :: [DisplayData] -> String Source #

displayDataToJson :: DisplayData -> (Key, Value) Source #

Convert a MIME type and value into a JSON dictionary pair.

KernelInfoReplyMessage
KernelInfoRequestMessage
ExecuteInputMessage
ExecuteReplyMessage
ExecuteErrorMessage
ExecuteRequestMessage
ExecuteResultMessage
StatusMessage
StreamMessage
DisplayDataMessage
UpdateDisplayDataMessage
OutputMessage
InputMessage
IsCompleteRequestMessage
IsCompleteReplyMessage
CompleteRequestMessage
CompleteReplyMessage
InspectRequestMessage
InspectReplyMessage
ShutdownRequestMessage
ShutdownReplyMessage
ClearOutputMessage
InputRequestMessage
InputReplyMessage
CommOpenMessage
CommDataMessage
CommInfoRequestMessage
CommInfoReplyMessage
CommCloseMessage
HistoryRequestMessage
HistoryReplyMessage

PlainText
MimeHtml
MimeBmp Width Height
MimePng Width Height
MimeJpg Width Height
MimeGif Width Height
MimeSvg
MimeLatex
MimeMarkdown
MimeJavascript
MimeJson
MimeVega
MimeVegalite
MimeVdom
MimeWidget
MimeCustom Text