Text.Pandoc.Filter.Pyplot.Internal

This module re-exports internal pandoc-pyplot functionality.

Documentation

data Configuration

Configuration of pandoc-pyplot, describing the default behavior of the filter.

A Configuration is useful when dealing with lots of figures; it avoids repeating the same values.sta

Since: 2.1.0.0

Constructors

Configuration

Fields

• defaultDirectory :: FilePath

  The default directory where figures will be saved.

• defaultIncludeScript :: PythonScript

  The default script to run before other instructions.

• defaultSaveFormat :: SaveFormat

  The default save format of generated figures.

• defaultDPI :: Int

  The default dots-per-inch value for generated figures.

• interpreter :: String

  The name of the interpreter to use to render figures.

Instances

Eq Configuration

Defined in Text.Pandoc.Filter.Pyplot.Configuration

Methods

(==) :: Configuration -> Configuration -> Bool

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

Show Configuration

Defined in Text.Pandoc.Filter.Pyplot.Configuration

Methods

showsPrec :: Int -> Configuration -> ShowS

show :: Configuration -> String

showList :: [Configuration] -> ShowS

Default Configuration

Defined in Text.Pandoc.Filter.Pyplot.Configuration

Methods

def :: Configuration

configuration :: FilePath -> IO Configuration

Building configuration from a YAML file. The keys are exactly the same as for Markdown code blocks.

If a key is either not present or unreadable, its value will be set to the default value.

Since: 2.1.0.0

For testing and internal purposes only

inclusionKeys :: [String]

list of all keys related to pandoc-pyplot.

directoryKey :: String

Keys that pandoc-pyplot will look for in code blocks. These are only exported for testing purposes.

captionKey :: String

Keys that pandoc-pyplot will look for in code blocks. These are only exported for testing purposes.

dpiKey :: String

Keys that pandoc-pyplot will look for in code blocks. These are only exported for testing purposes.

includePathKey :: String

Keys that pandoc-pyplot will look for in code blocks. These are only exported for testing purposes.

saveFormatKey :: String

Keys that pandoc-pyplot will look for in code blocks. These are only exported for testing purposes.

data FigureSpec

Datatype containing all parameters required to run pandoc-pyplot

Constructors

FigureSpec

Fields

• caption :: String

  Figure caption.

• script :: PythonScript

  Source code for the figure.

• saveFormat :: SaveFormat

  Save format of the figure

• directory :: FilePath

  Directory where to save the file

• dpi :: Int

  Dots-per-inch of figure

• blockAttrs :: Attr

  Attributes not related to pandoc-pyplot will be propagated.

Instances

Hashable FigureSpec

Defined in Text.Pandoc.Filter.Pyplot.FigureSpec

Methods

hashWithSalt :: Int -> FigureSpec -> Int

hash :: FigureSpec -> Int

data SaveFormat

Generated figure file format supported by pandoc-pyplot.

Constructors

PNG

PDF

SVG

JPG

EPS

GIF

TIF

Instances

Bounded SaveFormat

Defined in Text.Pandoc.Filter.Pyplot.FigureSpec

Methods

minBound :: SaveFormat

maxBound :: SaveFormat

Enum SaveFormat

Defined in Text.Pandoc.Filter.Pyplot.FigureSpec

Methods

succ :: SaveFormat -> SaveFormat

pred :: SaveFormat -> SaveFormat

toEnum :: Int -> SaveFormat

fromEnum :: SaveFormat -> Int

enumFrom :: SaveFormat -> [SaveFormat]

enumFromThen :: SaveFormat -> SaveFormat -> [SaveFormat]

enumFromTo :: SaveFormat -> SaveFormat -> [SaveFormat]

enumFromThenTo :: SaveFormat -> SaveFormat -> SaveFormat -> [SaveFormat]

Eq SaveFormat

Defined in Text.Pandoc.Filter.Pyplot.FigureSpec

Methods

(==) :: SaveFormat -> SaveFormat -> Bool

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

Show SaveFormat

Defined in Text.Pandoc.Filter.Pyplot.FigureSpec

Methods

showsPrec :: Int -> SaveFormat -> ShowS

show :: SaveFormat -> String

showList :: [SaveFormat] -> ShowS

saveFormatFromString :: String -> Maybe SaveFormat

Parse an image save format string

>>> saveFormatFromString ".png"
Just PNG

>>> saveFormatFromString "jpeg"
Just JPEG

>>> SaveFormatFromString "arbitrary"
Nothing

toImage :: FigureSpec -> Block

Convert a FigureSpec to a Pandoc block component

sourceCodePath :: FigureSpec -> FilePath

Determine the path to the source code that generated the figure.

figurePath :: FigureSpec -> FilePath

Determine the path a figure should have.

addPlotCapture

Arguments

:: FigureSpec

Path where to save the figure

-> PythonScript

Code block with added capture

Modify a Python plotting script to save the figure to a filename. An additional file will also be captured.

extension :: SaveFormat -> String

Save format file extension

runTempPythonScript

Arguments

:: String

Interpreter (e.g. "python" or "python35")

-> PythonScript

Content of the script

-> IO ScriptResult

Result with exit code.

Take a python script in string form, write it in a temporary directory, then execute it.

hasBlockingShowCall :: PythonScript -> Bool

Detect the presence of a blocking show call, for example "plt.show()"

type PythonScript = Text

String representation of a Python script

data ScriptResult

Possible result of running a Python script

Constructors

ScriptSuccess

ScriptFailure Int