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`.

Documentation

data Notebook a

A Jupyter notebook.

Constructors

Notebook

Fields

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

Instances

Eq (Notebook a)

Defined in Data.Ipynb

Methods

(==) :: Notebook a -> Notebook a -> Bool

(/=) :: Notebook a -> Notebook a -> Bool

Show (Notebook a)

Defined in Data.Ipynb

Methods

showsPrec :: Int -> Notebook a -> ShowS

show :: Notebook a -> String

showList :: [Notebook a] -> ShowS

Generic (Notebook a)

Defined in Data.Ipynb

Associated Types

type Rep (Notebook a) :: Type -> Type

Methods

from :: Notebook a -> Rep (Notebook a) x

to :: Rep (Notebook a) x -> Notebook a

Semigroup (Notebook a)

Defined in Data.Ipynb

Methods

(<>) :: Notebook a -> Notebook a -> Notebook a

sconcat :: NonEmpty (Notebook a) -> Notebook a

stimes :: Integral b => b -> Notebook a -> Notebook a

Monoid (Notebook a)

Defined in Data.Ipynb

Methods

mempty :: Notebook a

mappend :: Notebook a -> Notebook a -> Notebook a

mconcat :: [Notebook a] -> Notebook a

ToJSON (Notebook NbV4)

Defined in Data.Ipynb

Methods

toJSON :: Notebook NbV4 -> Value

toEncoding :: Notebook NbV4 -> Encoding

toJSONList :: [Notebook NbV4] -> Value

toEncodingList :: [Notebook NbV4] -> Encoding

ToJSON (Notebook NbV3)

Defined in Data.Ipynb

Methods

toJSON :: Notebook NbV3 -> Value

toEncoding :: Notebook NbV3 -> Encoding

toJSONList :: [Notebook NbV3] -> Value

toEncodingList :: [Notebook NbV3] -> Encoding

FromJSON (Notebook NbV4)

Defined in Data.Ipynb

Methods

parseJSON :: Value -> Parser (Notebook NbV4)

parseJSONList :: Value -> Parser [Notebook NbV4]

FromJSON (Notebook NbV3)

Defined in Data.Ipynb

Methods

parseJSON :: Value -> Parser (Notebook NbV3)

parseJSONList :: Value -> Parser [Notebook NbV3]

type Rep (Notebook a)

Defined in Data.Ipynb

type Rep (Notebook a) = D1 (MetaData "Notebook" "Data.Ipynb" "ipynb-0.1.0.1-340DlaLihPdGTM9Vs2R3XB" 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]))))

data NbV3

Indexes Notebook for serialization as nbformat version 3.

Instances

ToJSON (Output NbV3)

Defined in Data.Ipynb

Methods

toJSON :: Output NbV3 -> Value

toEncoding :: Output NbV3 -> Encoding

toJSONList :: [Output NbV3] -> Value

toEncodingList :: [Output NbV3] -> Encoding

ToJSON (Cell NbV3)

Defined in Data.Ipynb

Methods

toJSON :: Cell NbV3 -> Value

toEncoding :: Cell NbV3 -> Encoding

toJSONList :: [Cell NbV3] -> Value

toEncodingList :: [Cell NbV3] -> Encoding

ToJSON (Notebook NbV3)

Defined in Data.Ipynb

Methods

toJSON :: Notebook NbV3 -> Value

toEncoding :: Notebook NbV3 -> Encoding

toJSONList :: [Notebook NbV3] -> Value

toEncodingList :: [Notebook NbV3] -> Encoding

FromJSON (Output NbV3)

Defined in Data.Ipynb

Methods

parseJSON :: Value -> Parser (Output NbV3)

parseJSONList :: Value -> Parser [Output NbV3]

FromJSON (Cell NbV3)

Defined in Data.Ipynb

Methods

parseJSON :: Value -> Parser (Cell NbV3)

parseJSONList :: Value -> Parser [Cell NbV3]

FromJSON (Notebook NbV3)

Defined in Data.Ipynb

Methods

parseJSON :: Value -> Parser (Notebook NbV3)

parseJSONList :: Value -> Parser [Notebook NbV3]

data NbV4

Indexes Notebook for serialization as nbformat version 4.

Instances

ToJSON (Output NbV4)

Defined in Data.Ipynb

Methods

toJSON :: Output NbV4 -> Value

toEncoding :: Output NbV4 -> Encoding

toJSONList :: [Output NbV4] -> Value

toEncodingList :: [Output NbV4] -> Encoding

ToJSON (Cell NbV4)

Defined in Data.Ipynb

Methods

toJSON :: Cell NbV4 -> Value

toEncoding :: Cell NbV4 -> Encoding

toJSONList :: [Cell NbV4] -> Value

toEncodingList :: [Cell NbV4] -> Encoding

ToJSON (Notebook NbV4)

Defined in Data.Ipynb

Methods

toJSON :: Notebook NbV4 -> Value

toEncoding :: Notebook NbV4 -> Encoding

toJSONList :: [Notebook NbV4] -> Value

toEncodingList :: [Notebook NbV4] -> Encoding

FromJSON (Output NbV4)

Defined in Data.Ipynb

Methods

parseJSON :: Value -> Parser (Output NbV4)

parseJSONList :: Value -> Parser [Output NbV4]

FromJSON (Cell NbV4)

Defined in Data.Ipynb

Methods

parseJSON :: Value -> Parser (Cell NbV4)

parseJSONList :: Value -> Parser [Cell NbV4]

FromJSON (Notebook NbV4)

Defined in Data.Ipynb

Methods

parseJSON :: Value -> Parser (Notebook NbV4)

parseJSONList :: Value -> Parser [Notebook NbV4]

type JSONMeta = Map Text Value

data Cell a

A Jupyter notebook cell.

Constructors

Cell

Fields

• cellType :: CellType a
• cellSource :: Source
• cellMetadata :: JSONMeta
• cellAttachments :: Maybe (Map Text MimeBundle)

Instances

Eq (Cell a)

Defined in Data.Ipynb

Methods

(==) :: Cell a -> Cell a -> Bool

(/=) :: Cell a -> Cell a -> Bool

Show (Cell a)

Defined in Data.Ipynb

Methods

showsPrec :: Int -> Cell a -> ShowS

show :: Cell a -> String

showList :: [Cell a] -> ShowS

Generic (Cell a)

Defined in Data.Ipynb

Associated Types

type Rep (Cell a) :: Type -> Type

Methods

from :: Cell a -> Rep (Cell a) x

to :: Rep (Cell a) x -> Cell a

ToJSON (Cell NbV4)

Defined in Data.Ipynb

Methods

toJSON :: Cell NbV4 -> Value

toEncoding :: Cell NbV4 -> Encoding

toJSONList :: [Cell NbV4] -> Value

toEncodingList :: [Cell NbV4] -> Encoding

ToJSON (Cell NbV3)

Defined in Data.Ipynb

Methods

toJSON :: Cell NbV3 -> Value

toEncoding :: Cell NbV3 -> Encoding

toJSONList :: [Cell NbV3] -> Value

toEncodingList :: [Cell NbV3] -> Encoding

FromJSON (Cell NbV4)

Defined in Data.Ipynb

Methods

parseJSON :: Value -> Parser (Cell NbV4)

parseJSONList :: Value -> Parser [Cell NbV4]

FromJSON (Cell NbV3)

Defined in Data.Ipynb

Methods

parseJSON :: Value -> Parser (Cell NbV3)

parseJSONList :: Value -> Parser [Cell NbV3]

type Rep (Cell a)

Defined in Data.Ipynb

type Rep (Cell a) = D1 (MetaData "Cell" "Data.Ipynb" "ipynb-0.1.0.1-340DlaLihPdGTM9Vs2R3XB" False) (C1 (MetaCons "Cell" PrefixI True) ((S1 (MetaSel (Just "cellType") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (CellType a)) :*: 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 (Map Text MimeBundle))))))

newtype 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

Fields

• unSource :: [Text]

Instances

Eq Source

Defined in Data.Ipynb

Methods

(==) :: Source -> Source -> Bool

(/=) :: Source -> Source -> Bool

Show Source

Defined in Data.Ipynb

Methods

showsPrec :: Int -> Source -> ShowS

show :: Source -> String

showList :: [Source] -> ShowS

Generic Source

Defined in Data.Ipynb

Associated Types

type Rep Source :: Type -> Type

Methods

from :: Source -> Rep Source x

to :: Rep Source x -> Source

Semigroup Source

Defined in Data.Ipynb

Methods

(<>) :: Source -> Source -> Source

sconcat :: NonEmpty Source -> Source

stimes :: Integral b => b -> Source -> Source

Monoid Source

Defined in Data.Ipynb

Methods

mempty :: Source

mappend :: Source -> Source -> Source

mconcat :: [Source] -> Source

ToJSON Source

Defined in Data.Ipynb

Methods

toJSON :: Source -> Value

toEncoding :: Source -> Encoding

toJSONList :: [Source] -> Value

toEncodingList :: [Source] -> Encoding

FromJSON Source

Defined in Data.Ipynb

Methods

parseJSON :: Value -> Parser Source

parseJSONList :: Value -> Parser [Source]

type Rep Source

Defined in Data.Ipynb

type Rep Source = D1 (MetaData "Source" "Data.Ipynb" "ipynb-0.1.0.1-340DlaLihPdGTM9Vs2R3XB" True) (C1 (MetaCons "Source" PrefixI True) (S1 (MetaSel (Just "unSource") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text])))

data 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

Fields

• headingLevel :: Int

Raw

Code

Fields

• codeExecutionCount :: Maybe Int
• codeOutputs :: [Output a]

Instances

Eq (CellType a)

Defined in Data.Ipynb

Methods

(==) :: CellType a -> CellType a -> Bool

(/=) :: CellType a -> CellType a -> Bool

Show (CellType a)

Defined in Data.Ipynb

Methods

showsPrec :: Int -> CellType a -> ShowS

show :: CellType a -> String

showList :: [CellType a] -> ShowS

Generic (CellType a)

Defined in Data.Ipynb

Associated Types

type Rep (CellType a) :: Type -> Type

Methods

from :: CellType a -> Rep (CellType a) x

to :: Rep (CellType a) x -> CellType a

type Rep (CellType a)

Defined in Data.Ipynb

type Rep (CellType a) = D1 (MetaData "CellType" "Data.Ipynb" "ipynb-0.1.0.1-340DlaLihPdGTM9Vs2R3XB" False) ((C1 (MetaCons "Markdown" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Heading" PrefixI True) (S1 (MetaSel (Just "headingLevel") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int))) :+: (C1 (MetaCons "Raw" PrefixI False) (U1 :: Type -> Type) :+: 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]))))

data Output a

Output from a Code cell.

Constructors

Stream

Fields

• streamName :: Text
• streamText :: Source

DisplayData

Fields

• displayData :: MimeBundle
• displayMetadata :: JSONMeta

ExecuteResult

Fields

• executeCount :: Int
• executeData :: MimeBundle
• executeMetadata :: JSONMeta

Err

Fields

• errName :: Text
• errValue :: Text
• errTraceback :: [Text]

Instances

Eq (Output a)

Defined in Data.Ipynb

Methods

(==) :: Output a -> Output a -> Bool

(/=) :: Output a -> Output a -> Bool

Show (Output a)

Defined in Data.Ipynb

Methods

showsPrec :: Int -> Output a -> ShowS

show :: Output a -> String

showList :: [Output a] -> ShowS

Generic (Output a)

Defined in Data.Ipynb

Associated Types

type Rep (Output a) :: Type -> Type

Methods

from :: Output a -> Rep (Output a) x

to :: Rep (Output a) x -> Output a

ToJSON (Output NbV4)

Defined in Data.Ipynb

Methods

toJSON :: Output NbV4 -> Value

toEncoding :: Output NbV4 -> Encoding

toJSONList :: [Output NbV4] -> Value

toEncodingList :: [Output NbV4] -> Encoding

ToJSON (Output NbV3)

Defined in Data.Ipynb

Methods

toJSON :: Output NbV3 -> Value

toEncoding :: Output NbV3 -> Encoding

toJSONList :: [Output NbV3] -> Value

toEncodingList :: [Output NbV3] -> Encoding

FromJSON (Output NbV4)

Defined in Data.Ipynb

Methods

parseJSON :: Value -> Parser (Output NbV4)

parseJSONList :: Value -> Parser [Output NbV4]

FromJSON (Output NbV3)

Defined in Data.Ipynb

Methods

parseJSON :: Value -> Parser (Output NbV3)

parseJSONList :: Value -> Parser [Output NbV3]

type Rep (Output a)

Defined in Data.Ipynb

type Rep (Output a) = D1 (MetaData "Output" "Data.Ipynb" "ipynb-0.1.0.1-340DlaLihPdGTM9Vs2R3XB" 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])))))

type MimeType = Text

data MimeData

Data in an execution result or display data cell.

Constructors

BinaryData ByteString

TextualData Text

JsonData Value

Instances

Eq MimeData

Defined in Data.Ipynb

Methods

(==) :: MimeData -> MimeData -> Bool

(/=) :: MimeData -> MimeData -> Bool

Show MimeData

Defined in Data.Ipynb

Methods

showsPrec :: Int -> MimeData -> ShowS

show :: MimeData -> String

showList :: [MimeData] -> ShowS

Generic MimeData

Defined in Data.Ipynb

Associated Types

type Rep MimeData :: Type -> Type

Methods

from :: MimeData -> Rep MimeData x

to :: Rep MimeData x -> MimeData

type Rep MimeData

Defined in Data.Ipynb

type Rep MimeData = D1 (MetaData "MimeData" "Data.Ipynb" "ipynb-0.1.0.1-340DlaLihPdGTM9Vs2R3XB" False) (C1 (MetaCons "BinaryData" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ByteString)) :+: (C1 (MetaCons "TextualData" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) :+: C1 (MetaCons "JsonData" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Value))))

newtype MimeBundle

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

Constructors

MimeBundle

Fields

• unMimeBundle :: Map MimeType MimeData

Instances

Eq MimeBundle

Defined in Data.Ipynb

Methods

(==) :: MimeBundle -> MimeBundle -> Bool

(/=) :: MimeBundle -> MimeBundle -> Bool

Show MimeBundle

Defined in Data.Ipynb

Methods

showsPrec :: Int -> MimeBundle -> ShowS

show :: MimeBundle -> String

showList :: [MimeBundle] -> ShowS

Generic MimeBundle

Defined in Data.Ipynb

Associated Types

type Rep MimeBundle :: Type -> Type

Methods

from :: MimeBundle -> Rep MimeBundle x

to :: Rep MimeBundle x -> MimeBundle

Semigroup MimeBundle

Defined in Data.Ipynb

Methods

(<>) :: MimeBundle -> MimeBundle -> MimeBundle

sconcat :: NonEmpty MimeBundle -> MimeBundle

stimes :: Integral b => b -> MimeBundle -> MimeBundle

Monoid MimeBundle

Defined in Data.Ipynb

Methods

mempty :: MimeBundle

mappend :: MimeBundle -> MimeBundle -> MimeBundle

mconcat :: [MimeBundle] -> MimeBundle

ToJSON MimeBundle

Defined in Data.Ipynb

Methods

toJSON :: MimeBundle -> Value

toEncoding :: MimeBundle -> Encoding

toJSONList :: [MimeBundle] -> Value

toEncodingList :: [MimeBundle] -> Encoding

FromJSON MimeBundle

Defined in Data.Ipynb

Methods

parseJSON :: Value -> Parser MimeBundle

parseJSONList :: Value -> Parser [MimeBundle]

type Rep MimeBundle

Defined in Data.Ipynb

type Rep MimeBundle = D1 (MetaData "MimeBundle" "Data.Ipynb" "ipynb-0.1.0.1-340DlaLihPdGTM9Vs2R3XB" True) (C1 (MetaCons "MimeBundle" PrefixI True) (S1 (MetaSel (Just "unMimeBundle") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map MimeType MimeData))))

breakLines :: Text -> [Text]

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