Safe Haskell	None
Language	Haskell2010

IHaskell.IPython.Types

Contents

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

Description

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

Synopsis

IPython kernel profile

data Profile #

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

Read Profile #
Methods readsPrec :: Int -> ReadS Profile # readList :: ReadS [Profile] # readPrec :: ReadPrec Profile # readListPrec :: ReadPrec [Profile] #
Show Profile #
Methods showsPrec :: Int -> Profile -> ShowS # show :: Profile -> String # showList :: [Profile] -> ShowS #
ToJSON Profile #
Methods toJSON :: Profile -> Value # toEncoding :: Profile -> Encoding # toJSONList :: [Profile] -> Value # toEncodingList :: [Profile] -> Encoding #
FromJSON Profile #
Methods parseJSON :: Value -> Parser Profile # parseJSONList :: Value -> Parser [Profile] #

data Transport #

The transport mechanism used to communicate with the IPython frontend.

Constructors

TCP	Default transport mechanism via TCP.

Instances

Read Transport #
Methods readsPrec :: Int -> ReadS Transport # readList :: ReadS [Transport] # readPrec :: ReadPrec Transport # readListPrec :: ReadPrec [Transport] #
Show Transport #
Methods showsPrec :: Int -> Transport -> ShowS # show :: Transport -> String # showList :: [Transport] -> ShowS #
ToJSON Transport #
Methods toJSON :: Transport -> Value # toEncoding :: Transport -> Encoding # toJSONList :: [Transport] -> Value # toEncodingList :: [Transport] -> Encoding #
FromJSON Transport #
Methods parseJSON :: Value -> Parser Transport # parseJSONList :: Value -> Parser [Transport] #

type Port = Int #

A TCP port.

type IP = String #

An IP address.

IPython kernelspecs

data KernelSpec #

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

Eq KernelSpec #
Methods (==) :: KernelSpec -> KernelSpec -> Bool # (/=) :: KernelSpec -> KernelSpec -> Bool #
Show KernelSpec #
Methods showsPrec :: Int -> KernelSpec -> ShowS # show :: KernelSpec -> String # showList :: [KernelSpec] -> ShowS #
ToJSON KernelSpec #
Methods toJSON :: KernelSpec -> Value # toEncoding :: KernelSpec -> Encoding # toJSONList :: [KernelSpec] -> Value # toEncodingList :: [KernelSpec] -> Encoding #

IPython messaging protocol

data Message #

A message used to communicate with the IPython frontend.

Constructors

KernelInfoRequest	A request from a frontend for information about the kernel.
Fields header :: MessageHeader
KernelInfoReply	A response to a KernelInfoRequest.
Fields header :: MessageHeader 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
CommInfoRequest	A request from a frontend for information about the comms.
Fields header :: MessageHeader
CommInfoReply	A response to a CommInfoRequest.
Fields header :: MessageHeader 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 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 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 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 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 pagerOutput :: [DisplayData] The mimebundles to display in the pager. traceback :: [Text] ename :: Text evalue :: Text
PublishStatus
Fields header :: MessageHeader executionState :: ExecutionState The execution state of the kernel.
PublishStream
Fields header :: MessageHeader streamType :: StreamType Which stream to publish to. streamContent :: String What to publish.
PublishDisplayData
Fields header :: MessageHeader source :: String The name of the data source. displayData :: [DisplayData] A list of data representations.
PublishOutput
Fields header :: MessageHeader reprText :: String Printed output text. executionCount :: Int Which output this is for.
PublishInput
Fields header :: MessageHeader inCode :: String Submitted input code. executionCount :: Int Which output this is for.
Input
Fields header :: MessageHeader getCode :: Text The code string. executionCount :: Int Which output this is for.
Output
Fields header :: MessageHeader getText :: [DisplayData] executionCount :: Int Which output this is for.
IsCompleteRequest
Fields header :: MessageHeader inputToReview :: String The code entered in the repl.
IsCompleteReply
Fields header :: MessageHeader reviewResult :: CodeReview The result of reviewing the code.
CompleteRequest
Fields header :: MessageHeader getCode :: Text The code string. getCursorPos :: Int Position of the cursor in unicode characters. json field `cursor_pos`
CompleteReply
Fields header :: MessageHeader completionMatches :: [Text] completionCursorStart :: Int completionCursorEnd :: Int completionMetadata :: Metadata completionStatus :: Bool
InspectRequest
Fields header :: MessageHeader 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 inspectStatus :: Bool whether the request succeeded or failed inspectData :: [DisplayData] `inspectData` can be empty if nothing is found
ShutdownRequest
Fields header :: MessageHeader restartPending :: Bool Whether this shutdown precedes a restart.
ShutdownReply
Fields header :: MessageHeader restartPending :: Bool Whether this shutdown precedes a restart.
ClearOutput
Fields header :: MessageHeader wait :: Bool Whether to wait to redraw until there is more output.
RequestInput
Fields header :: MessageHeader inputPrompt :: String
InputReply
Fields header :: MessageHeader inputValue :: String
CommOpen
Fields header :: MessageHeader commTargetName :: String commTargetModule :: String commUuid :: UUID commData :: Value
CommData
Fields header :: MessageHeader commUuid :: UUID commData :: Value
CommClose
Fields header :: MessageHeader commUuid :: UUID commData :: Value
HistoryRequest
Fields header :: MessageHeader 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 historyReply :: [HistoryReplyElement]
SendNothing

Instances

Show Message #
Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #

data MessageHeader #

A message header with some metadata.

Constructors

MessageHeader
Fields identifiers :: [ByteString] The identifiers sent with the message. parentHeader :: Maybe MessageHeader The parent header, if present. metadata :: Metadata A dict of metadata. messageId :: UUID A unique message UUID. sessionId :: UUID A unique session UUID. username :: Username The user who sent this message. msgType :: MessageType The message type.

Instances

Read MessageHeader #
Methods readsPrec :: Int -> ReadS MessageHeader # readList :: ReadS [MessageHeader] # readPrec :: ReadPrec MessageHeader # readListPrec :: ReadPrec [MessageHeader] #
Show MessageHeader #
Methods showsPrec :: Int -> MessageHeader -> ShowS # show :: MessageHeader -> String # showList :: [MessageHeader] -> ShowS #
ToJSON MessageHeader #
Methods toJSON :: MessageHeader -> Value # toEncoding :: MessageHeader -> Encoding # toJSONList :: [MessageHeader] -> Value # toEncodingList :: [MessageHeader] -> Encoding #

type Username = Text #

A username for the source of a message.

type Metadata = Map Text Text #

A metadata dictionary.

data MessageType #

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

Instances

Eq MessageType #
Methods (==) :: MessageType -> MessageType -> Bool # (/=) :: MessageType -> MessageType -> Bool #
Read MessageType #
Methods readsPrec :: Int -> ReadS MessageType # readList :: ReadS [MessageType] # readPrec :: ReadPrec MessageType # readListPrec :: ReadPrec [MessageType] #
Show MessageType #
Methods showsPrec :: Int -> MessageType -> ShowS # show :: MessageType -> String # showList :: [MessageType] -> ShowS #
FromJSON MessageType #
Methods parseJSON :: Value -> Parser MessageType # parseJSONList :: Value -> Parser [MessageType] #

data CodeReview #

Constructors

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

Instances

Show CodeReview #
Methods showsPrec :: Int -> CodeReview -> ShowS # show :: CodeReview -> String # showList :: [CodeReview] -> ShowS #

type Width = Int #

Possible MIME types for the display data.

type Height = Int #

data StreamType #

Input and output streams.

Constructors

Stdin
Stdout
Stderr

Instances

Show StreamType #
Methods showsPrec :: Int -> StreamType -> ShowS # show :: StreamType -> String # showList :: [StreamType] -> ShowS #
FromJSON StreamType #
Methods parseJSON :: Value -> Parser StreamType # parseJSONList :: Value -> Parser [StreamType] #

data ExecutionState #

The execution state of the kernel.

Constructors

Busy
Idle
Starting

Instances

Show ExecutionState #
Methods showsPrec :: Int -> ExecutionState -> ShowS # show :: ExecutionState -> String # showList :: [ExecutionState] -> ShowS #
FromJSON ExecutionState #
Methods parseJSON :: Value -> Parser ExecutionState # parseJSONList :: Value -> Parser [ExecutionState] #

data ExecuteReplyStatus #

Possible statuses in the execution reply messages.

Constructors

Ok
Err
Abort

Instances

Show ExecuteReplyStatus #
Methods showsPrec :: Int -> ExecuteReplyStatus -> ShowS # show :: ExecuteReplyStatus -> String # showList :: [ExecuteReplyStatus] -> ShowS #
FromJSON ExecuteReplyStatus #
Methods parseJSON :: Value -> Parser ExecuteReplyStatus # parseJSONList :: Value -> Parser [ExecuteReplyStatus] #

data HistoryAccessType #

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

Constructors

HistoryRange
HistoryTail
HistorySearch

Instances

Eq HistoryAccessType #
Methods (==) :: HistoryAccessType -> HistoryAccessType -> Bool # (/=) :: HistoryAccessType -> HistoryAccessType -> Bool #
Show HistoryAccessType #
Methods showsPrec :: Int -> HistoryAccessType -> ShowS # show :: HistoryAccessType -> String # showList :: [HistoryAccessType] -> ShowS #

data HistoryReplyElement #

Reply to history requests.

Constructors

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

Instances

Eq HistoryReplyElement #
Methods (==) :: HistoryReplyElement -> HistoryReplyElement -> Bool # (/=) :: HistoryReplyElement -> HistoryReplyElement -> Bool #
Show HistoryReplyElement #
Methods showsPrec :: Int -> HistoryReplyElement -> ShowS # show :: HistoryReplyElement -> String # showList :: [HistoryReplyElement] -> ShowS #

data LanguageInfo #

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`

Instances

Eq LanguageInfo #
Methods (==) :: LanguageInfo -> LanguageInfo -> Bool # (/=) :: LanguageInfo -> LanguageInfo -> Bool #
Show LanguageInfo #
Methods showsPrec :: Int -> LanguageInfo -> ShowS # show :: LanguageInfo -> String # showList :: [LanguageInfo] -> ShowS #

replyType :: MessageType -> Maybe MessageType #

Get the reply message type for a request message type.

showMessageType :: MessageType -> String #

IPython display data message

data DisplayData #

Data for display: a string with associated MIME type.

Constructors

DisplayData MimeType Text

Instances

Show DisplayData #
Methods showsPrec :: Int -> DisplayData -> ShowS # show :: DisplayData -> String # showList :: [DisplayData] -> ShowS #
Generic DisplayData #
Associated Types type Rep DisplayData :: * -> * # Methods from :: DisplayData -> Rep DisplayData x # to :: Rep DisplayData x -> DisplayData #
Serialize DisplayData #
Methods put :: Putter DisplayData # get :: Get DisplayData #
type Rep DisplayData #
type Rep DisplayData = D1 * (MetaData "DisplayData" "IHaskell.IPython.Types" "ipython-kernel-0.9.0.2-52MXm08O50kFmbiZ9TTOj1" False) (C1 * (MetaCons "DisplayData" PrefixI False) ((::) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * MimeType)) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text))))

data MimeType #

Constructors

PlainText
MimeHtml
MimePng Width Height
MimeJpg Width Height
MimeSvg
MimeLatex
MimeJavascript

Instances

Eq MimeType #
Methods (==) :: MimeType -> MimeType -> Bool # (/=) :: MimeType -> MimeType -> Bool #
Read MimeType #
Methods readsPrec :: Int -> ReadS MimeType # readList :: ReadS [MimeType] # readPrec :: ReadPrec MimeType # readListPrec :: ReadPrec [MimeType] #
Show MimeType #
Methods showsPrec :: Int -> MimeType -> ShowS # show :: MimeType -> String # showList :: [MimeType] -> ShowS #
Generic MimeType #
Associated Types type Rep MimeType :: * -> * # Methods from :: MimeType -> Rep MimeType x # to :: Rep MimeType x -> MimeType #
Serialize MimeType #
Methods put :: Putter MimeType # get :: Get MimeType #
type Rep MimeType #
type Rep MimeType = D1 * (MetaData "MimeType" "IHaskell.IPython.Types" "ipython-kernel-0.9.0.2-52MXm08O50kFmbiZ9TTOj1" False) ((:+:) * ((:+:) * (C1 * (MetaCons "PlainText" PrefixI False) (U1 )) ((:+:) (C1 * (MetaCons "MimeHtml" PrefixI False) (U1 )) (C1 (MetaCons "MimePng" PrefixI False) ((::) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Width)) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Height)))))) ((:+:) * ((:+:) * (C1 * (MetaCons "MimeJpg" PrefixI False) ((::) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Width)) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Height)))) (C1 * (MetaCons "MimeSvg" PrefixI False) (U1 ))) ((:+:) (C1 * (MetaCons "MimeLatex" PrefixI False) (U1 )) (C1 (MetaCons "MimeJavascript" PrefixI False) (U1 *)))))

extractPlain :: [DisplayData] -> String #

Orphan instances

Serialize Text #
Methods put :: Putter Text # get :: Get Text #

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