pandoc-pyplot-2.1.3.0: A Pandoc filter to include figures generated from Python code blocks

Copyright	(c) Laurent P René de Cotret 2019
License	MIT
Maintainer	laurent.decotret@outlook.com
Stability	internal
Portability	portable
Safe Haskell	None
Language	Haskell2010

Text.Pandoc.Filter.Pyplot.Internal

Contents

For testing and internal purposes only

Description

This module re-exports internal pandoc-pyplot functionality.

Synopsis

configuration :: FilePath -> IO Configuration
writeConfig :: FilePath -> Configuration -> IO ()
inclusionKeys :: [String]
directoryKey :: String
captionKey :: String
dpiKey :: String
includePathKey :: String
saveFormatKey :: String
withLinksKey :: String
data FigureSpec = FigureSpec {
- caption :: String
- withLinks :: Bool
- script :: PythonScript
- saveFormat :: SaveFormat
- directory :: FilePath
- dpi :: Int
- blockAttrs :: Attr
}
data SaveFormat
- = PNG
- | PDF
- | SVG
- | JPG
- | EPS
- | GIF
- | TIF
saveFormatFromString :: String -> Maybe SaveFormat
toImage :: FigureSpec -> Block
sourceCodePath :: FigureSpec -> FilePath
figurePath :: FigureSpec -> FilePath
addPlotCapture :: FigureSpec -> PythonScript
extension :: SaveFormat -> String
runTempPythonScript :: String -> [String] -> PythonScript -> IO ScriptResult
runScriptIfNecessary :: Configuration -> FigureSpec -> IO ScriptResult
type PythonScript = Text
data ScriptResult
- = ScriptSuccess
- | ScriptChecksFailed String
- | ScriptFailure Int
data CheckResult
- = CheckPassed
- | CheckFailed String
data PandocPyplotError
- = ScriptError Int
- | ScriptChecksFailedError String
data SaveFormat
- = PNG
- | PDF
- | SVG
- | JPG
- | EPS
- | GIF
- | TIF
saveFormatFromString :: String -> Maybe SaveFormat
extension :: SaveFormat -> String
defaultPlatformInterpreter :: String
data Configuration = Configuration {
- defaultDirectory :: FilePath
- defaultIncludeScript :: PythonScript
- defaultWithLinks :: Bool
- defaultSaveFormat :: SaveFormat
- defaultDPI :: Int
- interpreter :: String
- flags :: [String]
}
data FigureSpec = FigureSpec {
- caption :: String
- withLinks :: Bool
- script :: PythonScript
- saveFormat :: SaveFormat
- directory :: FilePath
- dpi :: Int
- blockAttrs :: Attr
}

Documentation

configuration :: FilePath -> IO Configuration Source #

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

writeConfig :: FilePath -> Configuration -> IO () Source #

Write a configuration to file. An exception will be raised in case the file would be overwritten.

Since: 2.1.3.0

inclusionKeys :: [String] Source #

list of all keys related to pandoc-pyplot.

directoryKey :: String Source #

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

captionKey :: String Source #

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

dpiKey :: String Source #

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

includePathKey :: String Source #

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

saveFormatKey :: String Source #

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

withLinksKey :: String Source #

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

data FigureSpec Source #

Datatype containing all parameters required to run pandoc-pyplot

Constructors

FigureSpec
Fields caption :: String Figure caption. withLinks :: Bool Append links to source code and high-dpi figure to 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 Source #
Instance details Defined in Text.Pandoc.Filter.Pyplot.Types Methods hashWithSalt :: Int -> FigureSpec -> Int # hash :: FigureSpec -> Int #

data SaveFormat Source #

Generated figure file format supported by pandoc-pyplot.

Constructors

PNG
PDF
SVG
JPG
EPS
GIF
TIF

Instances

Bounded SaveFormat Source #
Instance details Defined in Text.Pandoc.Filter.Pyplot.Types Methods minBound :: SaveFormat # maxBound :: SaveFormat #
Enum SaveFormat Source #
Instance details Defined in Text.Pandoc.Filter.Pyplot.Types 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 Source #
Instance details Defined in Text.Pandoc.Filter.Pyplot.Types Methods (==) :: SaveFormat -> SaveFormat -> Bool # (/=) :: SaveFormat -> SaveFormat -> Bool #
Show SaveFormat Source #
Instance details Defined in Text.Pandoc.Filter.Pyplot.Types Methods showsPrec :: Int -> SaveFormat -> ShowS # show :: SaveFormat -> String # showList :: [SaveFormat] -> ShowS #

saveFormatFromString :: String -> Maybe SaveFormat Source #

Parse an image save format string

>>> saveFormatFromString ".png"
Just PNG

>>> saveFormatFromString "jpeg"
Just JPEG

>>> SaveFormatFromString "arbitrary"
Nothing

toImage :: FigureSpec -> Block Source #

Convert a FigureSpec to a Pandoc block component

sourceCodePath :: FigureSpec -> FilePath Source #

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

figurePath :: FigureSpec -> FilePath Source #

Determine the path a figure should have.

addPlotCapture Source #

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 Source #

Save format file extension

runTempPythonScript Source #

Arguments

:: String	Interpreter (e.g. "python" or "python35")
-> [String]	Command-line flags
-> PythonScript	Content of the script
-> IO ScriptResult	Result.

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

runScriptIfNecessary :: Configuration -> FigureSpec -> IO ScriptResult Source #

Run the Python script. In case the file already exists, we can safely assume there is no need to re-run it.

type PythonScript = Text Source #

String representation of a Python script

data ScriptResult Source #

Possible result of running a Python script

Constructors

ScriptSuccess
ScriptChecksFailed String
ScriptFailure Int

data CheckResult Source #

Result of checking scripts for problems

Constructors

CheckPassed
CheckFailed String

Instances

Eq CheckResult Source #
Instance details Defined in Text.Pandoc.Filter.Pyplot.Types Methods (==) :: CheckResult -> CheckResult -> Bool # (/=) :: CheckResult -> CheckResult -> Bool #
Semigroup CheckResult Source #
Instance details Defined in Text.Pandoc.Filter.Pyplot.Types Methods (<>) :: CheckResult -> CheckResult -> CheckResult # sconcat :: NonEmpty CheckResult -> CheckResult # stimes :: Integral b => b -> CheckResult -> CheckResult #
Monoid CheckResult Source #
Instance details Defined in Text.Pandoc.Filter.Pyplot.Types Methods mempty :: CheckResult # mappend :: CheckResult -> CheckResult -> CheckResult # mconcat :: [CheckResult] -> CheckResult #

data PandocPyplotError Source #

Possible errors returned by the filter

Constructors

ScriptError Int	Running Python script has yielded an error
ScriptChecksFailedError String	Python script did not pass all checks

Instances

Eq PandocPyplotError Source #
Instance details Defined in Text.Pandoc.Filter.Pyplot.Types Methods (==) :: PandocPyplotError -> PandocPyplotError -> Bool # (/=) :: PandocPyplotError -> PandocPyplotError -> Bool #
Show PandocPyplotError Source #
Instance details Defined in Text.Pandoc.Filter.Pyplot.Types Methods showsPrec :: Int -> PandocPyplotError -> ShowS # show :: PandocPyplotError -> String # showList :: [PandocPyplotError] -> ShowS #

data SaveFormat Source #

Generated figure file format supported by pandoc-pyplot.

Constructors

PNG
PDF
SVG
JPG
EPS
GIF
TIF

Instances

Bounded SaveFormat Source #
Instance details Defined in Text.Pandoc.Filter.Pyplot.Types Methods minBound :: SaveFormat # maxBound :: SaveFormat #
Enum SaveFormat Source #
Instance details Defined in Text.Pandoc.Filter.Pyplot.Types 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 Source #
Instance details Defined in Text.Pandoc.Filter.Pyplot.Types Methods (==) :: SaveFormat -> SaveFormat -> Bool # (/=) :: SaveFormat -> SaveFormat -> Bool #
Show SaveFormat Source #
Instance details Defined in Text.Pandoc.Filter.Pyplot.Types Methods showsPrec :: Int -> SaveFormat -> ShowS # show :: SaveFormat -> String # showList :: [SaveFormat] -> ShowS #

saveFormatFromString :: String -> Maybe SaveFormat Source #

Parse an image save format string

>>> saveFormatFromString ".png"
Just PNG

>>> saveFormatFromString "jpeg"
Just JPEG

>>> SaveFormatFromString "arbitrary"
Nothing

extension :: SaveFormat -> String Source #

Save format file extension

defaultPlatformInterpreter :: String Source #

Default interpreter should be Python 3, which has a different name on Windows ("python") vs Unix ("python3")

Since: 2.1.2.0

data Configuration Source #

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

Fields

defaultDirectory :: FilePath
The default directory where figures will be saved.
defaultIncludeScript :: PythonScript
The default script to run before other instructions.
defaultWithLinks :: Bool
The default behavior of whether or not to include links to source code and high-res
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.
flags :: [String]
Command-line flags to be passed to the Python interpreger, e.g. ["-O", "-Wignore"]

Instances

Eq Configuration Source #
Instance details Defined in Text.Pandoc.Filter.Pyplot.Types Methods (==) :: Configuration -> Configuration -> Bool # (/=) :: Configuration -> Configuration -> Bool #
Show Configuration Source #
Instance details Defined in Text.Pandoc.Filter.Pyplot.Types Methods showsPrec :: Int -> Configuration -> ShowS # show :: Configuration -> String # showList :: [Configuration] -> ShowS #
ToJSON Configuration Source #
Instance details Defined in Text.Pandoc.Filter.Pyplot.Types Methods toJSON :: Configuration -> Value # toEncoding :: Configuration -> Encoding # toJSONList :: [Configuration] -> Value # toEncodingList :: [Configuration] -> Encoding #
Default Configuration Source #
Instance details Defined in Text.Pandoc.Filter.Pyplot.Types Methods def :: Configuration #

data FigureSpec Source #

Datatype containing all parameters required to run pandoc-pyplot

Constructors

FigureSpec
Fields caption :: String Figure caption. withLinks :: Bool Append links to source code and high-dpi figure to 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 Source #
Instance details Defined in Text.Pandoc.Filter.Pyplot.Types Methods hashWithSalt :: Int -> FigureSpec -> Int # hash :: FigureSpec -> Int #