Moduleipynb-0.2Haskell2010

Data.Ipynb

Data structure and JSON serializers for ipynb (Jupyter notebook) format. Version 4 of the format is documented here: https://nbformat.readthedocs.io/en/latest/format_description.html.

The library supports both version 4 ('Notebook NbV4') and version 3 ('Notebook NbV3') of nbformat. Note that this is a phantom type: the NbV3 or NbV4 parameter only affects JSON serialization, not the data structure itself. So code that manipulates notebooks can be polymorphic, operating on `Notebook a`.

12 types
1 value

Packageipynb-0.2
Exports13
LanguageHaskell2010
LicenceBSD-3-Clause
SourceIpynb.hs

datadata Notebook a

A Jupyter notebook.

Constructors

Notebook
- notebookMetadata :: JSONMeta
- notebookFormat :: (Int, Int)
- notebookCells :: [Cell a]

Instances10Eq, Show, Generic, Semigroup, Monoid, FromJSON, …

Eq (Notebook a)Defined in ipynb-0.2 · Data.Ipynb
Show (Notebook a)Defined in ipynb-0.2 · Data.Ipynb
Generic (Notebook a)Defined in ipynb-0.2 · Data.Ipynb
Semigroup (Notebook a)Defined in ipynb-0.2 · Data.Ipynb
Monoid (Notebook a)Defined in ipynb-0.2 · Data.Ipynb
FromJSON (Notebook NbV3)Defined in ipynb-0.2 · Data.Ipynb
FromJSON (Notebook NbV4)Defined in ipynb-0.2 · Data.Ipynb
ToJSON (Notebook NbV3)Defined in ipynb-0.2 · Data.Ipynb
ToJSON (Notebook NbV4)Defined in ipynb-0.2 · Data.Ipynb
type Rep (Notebook a) = D1 ('MetaData "Notebook" "Data.Ipynb" "ipynb-0.2-FrkMsJRmmaO9wc85VgiqdK" 'False) (C1 ('MetaCons "Notebook" 'PrefixI 'True) (S1 ('MetaSel ('Just "notebookMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JSONMeta) :*: (S1 ('MetaSel ('Just "notebookFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Int, Int)) :*: S1 ('MetaSel ('Just "notebookCells") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Cell a]))))Defined in ipynb-0.2 · Data.Ipynb

datadata NbV3

Indexes Notebook for serialization as nbformat version 3.

Instances6FromJSON, ToJSON

FromJSON (Cell NbV3)Defined in ipynb-0.2 · Data.Ipynb
FromJSON (Notebook NbV3)Defined in ipynb-0.2 · Data.Ipynb
FromJSON (Output NbV3)Defined in ipynb-0.2 · Data.Ipynb
ToJSON (Cell NbV3)Defined in ipynb-0.2 · Data.Ipynb
ToJSON (Notebook NbV3)Defined in ipynb-0.2 · Data.Ipynb
ToJSON (Output NbV3)Defined in ipynb-0.2 · Data.Ipynb

datadata NbV4

Indexes Notebook for serialization as nbformat version 4.

Instances6FromJSON, ToJSON

FromJSON (Cell NbV4)Defined in ipynb-0.2 · Data.Ipynb
FromJSON (Notebook NbV4)Defined in ipynb-0.2 · Data.Ipynb
FromJSON (Output NbV4)Defined in ipynb-0.2 · Data.Ipynb
ToJSON (Cell NbV4)Defined in ipynb-0.2 · Data.Ipynb
ToJSON (Notebook NbV4)Defined in ipynb-0.2 · Data.Ipynb
ToJSON (Output NbV4)Defined in ipynb-0.2 · Data.Ipynb

newtypenewtype JSONMeta

Constructors

JSONMeta (Map Text Value)

Instances9Eq, Ord, Show, Generic, Semigroup, Monoid, …

Eq JSONMetaDefined in ipynb-0.2 · Data.Ipynb
Ord JSONMetaDefined in ipynb-0.2 · Data.Ipynb
Show JSONMetaDefined in ipynb-0.2 · Data.Ipynb
Generic JSONMetaDefined in ipynb-0.2 · Data.Ipynb
Semigroup JSONMetaDefined in ipynb-0.2 · Data.Ipynb
Monoid JSONMetaDefined in ipynb-0.2 · Data.Ipynb
FromJSON JSONMetaDefined in ipynb-0.2 · Data.Ipynb
ToJSON JSONMetaDefined in ipynb-0.2 · Data.Ipynb
type Rep JSONMeta = D1 ('MetaData "JSONMeta" "Data.Ipynb" "ipynb-0.2-FrkMsJRmmaO9wc85VgiqdK" 'True) (C1 ('MetaCons "JSONMeta" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Text Value))))Defined in ipynb-0.2 · Data.Ipynb

datadata Cell a

A Jupyter notebook cell.

Constructors

Cell
- cellType :: CellType a
- cellId :: Maybe Text
- cellSource :: Source
- cellMetadata :: JSONMeta
- cellAttachments :: Maybe MimeAttachments

Instances8Eq, Show, Generic, FromJSON, ToJSON, Rep, …

Eq (Cell a)Defined in ipynb-0.2 · Data.Ipynb
Show (Cell a)Defined in ipynb-0.2 · Data.Ipynb
Generic (Cell a)Defined in ipynb-0.2 · Data.Ipynb
FromJSON (Cell NbV3)Defined in ipynb-0.2 · Data.Ipynb
FromJSON (Cell NbV4)Defined in ipynb-0.2 · Data.Ipynb
ToJSON (Cell NbV3)Defined in ipynb-0.2 · Data.Ipynb
ToJSON (Cell NbV4)Defined in ipynb-0.2 · Data.Ipynb
type Rep (Cell a) = D1 ('MetaData "Cell" "Data.Ipynb" "ipynb-0.2-FrkMsJRmmaO9wc85VgiqdK" 'False) (C1 ('MetaCons "Cell" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cellType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (CellType a)) :*: S1 ('MetaSel ('Just "cellId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "cellSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Source) :*: (S1 ('MetaSel ('Just "cellMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JSONMeta) :*: S1 ('MetaSel ('Just "cellAttachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MimeAttachments))))))Defined in ipynb-0.2 · Data.Ipynb

newtypenewtype Source

A Source is a textual content which may be represented in JSON either as a single string or as a list of strings (which are concatenated).

Constructors

Source
- unSource :: [Text]

Instances8Eq, Show, Generic, Semigroup, Monoid, FromJSON, …

Eq SourceDefined in ipynb-0.2 · Data.Ipynb
Show SourceDefined in ipynb-0.2 · Data.Ipynb
Generic SourceDefined in ipynb-0.2 · Data.Ipynb
Semigroup SourceDefined in ipynb-0.2 · Data.Ipynb
Monoid SourceDefined in ipynb-0.2 · Data.Ipynb
FromJSON SourceDefined in ipynb-0.2 · Data.Ipynb
ToJSON SourceDefined in ipynb-0.2 · Data.Ipynb
type Rep Source = D1 ('MetaData "Source" "Data.Ipynb" "ipynb-0.2-FrkMsJRmmaO9wc85VgiqdK" 'True) (C1 ('MetaCons "Source" 'PrefixI 'True) (S1 ('MetaSel ('Just "unSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text])))Defined in ipynb-0.2 · Data.Ipynb

datadata CellType a

Information about the type of a notebook cell, plus data specific to that type. note that Heading is for v3 only; a Heading will be rendered as Markdown in v4.

Constructors

Markdown
Heading
- headingLevel :: Int
Raw
Code
- codeExecutionCount :: Maybe Int
- codeOutputs :: [Output a]

Instances4Eq, Show, Generic, Rep

Eq (CellType a)Defined in ipynb-0.2 · Data.Ipynb
Show (CellType a)Defined in ipynb-0.2 · Data.Ipynb
Generic (CellType a)Defined in ipynb-0.2 · Data.Ipynb
type Rep (CellType a) = D1 ('MetaData "CellType" "Data.Ipynb" "ipynb-0.2-FrkMsJRmmaO9wc85VgiqdK" 'False) ((C1 ('MetaCons "Markdown" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Heading" 'PrefixI 'True) (S1 ('MetaSel ('Just "headingLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))) :+: (C1 ('MetaCons "Raw" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Code" 'PrefixI 'True) (S1 ('MetaSel ('Just "codeExecutionCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "codeOutputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Output a]))))Defined in ipynb-0.2 · Data.Ipynb

datadata Output a

Output from a Code cell.

Constructors

Stream
- streamName :: Text
- streamText :: Source
DisplayData
- displayData :: MimeBundle
- displayMetadata :: JSONMeta
ExecuteResult
- executeCount :: Int
- executeData :: MimeBundle
- executeMetadata :: JSONMeta
Err
- errName :: Text
- errValue :: Text
- errTraceback :: [Text]

Instances8Eq, Show, Generic, FromJSON, ToJSON, Rep, …

Eq (Output a)Defined in ipynb-0.2 · Data.Ipynb
Show (Output a)Defined in ipynb-0.2 · Data.Ipynb
Generic (Output a)Defined in ipynb-0.2 · Data.Ipynb
FromJSON (Output NbV3)Defined in ipynb-0.2 · Data.Ipynb
FromJSON (Output NbV4)Defined in ipynb-0.2 · Data.Ipynb
ToJSON (Output NbV3)Defined in ipynb-0.2 · Data.Ipynb
ToJSON (Output NbV4)Defined in ipynb-0.2 · Data.Ipynb
type Rep (Output a) = D1 ('MetaData "Output" "Data.Ipynb" "ipynb-0.2-FrkMsJRmmaO9wc85VgiqdK" 'False) ((C1 ('MetaCons "Stream" 'PrefixI 'True) (S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "streamText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Source)) :+: C1 ('MetaCons "DisplayData" 'PrefixI 'True) (S1 ('MetaSel ('Just "displayData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MimeBundle) :*: S1 ('MetaSel ('Just "displayMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JSONMeta))) :+: (C1 ('MetaCons "ExecuteResult" 'PrefixI 'True) (S1 ('MetaSel ('Just "executeCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: (S1 ('MetaSel ('Just "executeData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MimeBundle) :*: S1 ('MetaSel ('Just "executeMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JSONMeta))) :+: C1 ('MetaCons "Err" 'PrefixI 'True) (S1 ('MetaSel ('Just "errName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "errValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "errTraceback") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text])))))Defined in ipynb-0.2 · Data.Ipynb

typetype MimeType = Text

datadata MimeData

Data in an execution result or display data cell.

Constructors

BinaryData ByteString
TextualData Text
JsonData Value

Instances6Eq, Ord, Show, Generic, ToJSON, Rep

Eq MimeDataDefined in ipynb-0.2 · Data.Ipynb
Ord MimeDataDefined in ipynb-0.2 · Data.Ipynb
Show MimeDataDefined in ipynb-0.2 · Data.Ipynb
Generic MimeDataDefined in ipynb-0.2 · Data.Ipynb
ToJSON MimeDataDefined in ipynb-0.2 · Data.Ipynb
type Rep MimeData = D1 ('MetaData "MimeData" "Data.Ipynb" "ipynb-0.2-FrkMsJRmmaO9wc85VgiqdK" 'False) (C1 ('MetaCons "BinaryData" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)) :+: (C1 ('MetaCons "TextualData" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "JsonData" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value))))Defined in ipynb-0.2 · Data.Ipynb

newtypenewtype MimeBundle

A MimeBundle wraps a map from mime types to mime data.

Constructors

MimeBundle
- unMimeBundle :: Map MimeType MimeData

Instances9Eq, Ord, Show, Generic, Semigroup, Monoid, …

Eq MimeBundleDefined in ipynb-0.2 · Data.Ipynb
Ord MimeBundleDefined in ipynb-0.2 · Data.Ipynb
Show MimeBundleDefined in ipynb-0.2 · Data.Ipynb
Generic MimeBundleDefined in ipynb-0.2 · Data.Ipynb
Semigroup MimeBundleDefined in ipynb-0.2 · Data.Ipynb
Monoid MimeBundleDefined in ipynb-0.2 · Data.Ipynb
FromJSON MimeBundleDefined in ipynb-0.2 · Data.Ipynb
ToJSON MimeBundleDefined in ipynb-0.2 · Data.Ipynb
type Rep MimeBundle = D1 ('MetaData "MimeBundle" "Data.Ipynb" "ipynb-0.2-FrkMsJRmmaO9wc85VgiqdK" 'True) (C1 ('MetaCons "MimeBundle" 'PrefixI 'True) (S1 ('MetaSel ('Just "unMimeBundle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map MimeType MimeData))))Defined in ipynb-0.2 · Data.Ipynb

newtypenewtype MimeAttachments

Constructors

MimeAttachments (Map Text MimeBundle)

Instances9Eq, Ord, Show, Generic, Semigroup, Monoid, …

Eq MimeAttachmentsDefined in ipynb-0.2 · Data.Ipynb
Ord MimeAttachmentsDefined in ipynb-0.2 · Data.Ipynb
Show MimeAttachmentsDefined in ipynb-0.2 · Data.Ipynb
Generic MimeAttachmentsDefined in ipynb-0.2 · Data.Ipynb
Semigroup MimeAttachmentsDefined in ipynb-0.2 · Data.Ipynb
Monoid MimeAttachmentsDefined in ipynb-0.2 · Data.Ipynb
FromJSON MimeAttachmentsDefined in ipynb-0.2 · Data.Ipynb
ToJSON MimeAttachmentsDefined in ipynb-0.2 · Data.Ipynb
type Rep MimeAttachments = D1 ('MetaData "MimeAttachments" "Data.Ipynb" "ipynb-0.2-FrkMsJRmmaO9wc85VgiqdK" 'True) (C1 ('MetaCons "MimeAttachments" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Text MimeBundle))))Defined in ipynb-0.2 · Data.Ipynb

valuebreakLines :: Text -> [Text]

Break up a string into a list of strings, each representing one line of the string (including trailing newline if any).