| 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
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
- isTightBboxKey :: String
- isTransparentKey :: String
- data FigureSpec = FigureSpec {
- caption :: String
- withLinks :: Bool
- script :: PythonScript
- saveFormat :: SaveFormat
- directory :: FilePath
- dpi :: Int
- tightBbox :: Bool
- transparent :: Bool
- blockAttrs :: Attr
- data SaveFormat
- saveFormatFromString :: String -> Maybe SaveFormat
- toImage :: FigureSpec -> Block
- sourceCodePath :: FigureSpec -> FilePath
- figurePath :: FigureSpec -> FilePath
- addPlotCapture :: FigureSpec -> PythonScript
- parseFigureSpec :: Configuration -> Block -> IO (Maybe FigureSpec)
- extension :: SaveFormat -> String
- runTempPythonScript :: String -> [String] -> PythonScript -> IO ScriptResult
- runScriptIfNecessary :: Configuration -> FigureSpec -> IO ScriptResult
- directoryKey :: String
- captionKey :: String
- dpiKey :: String
- includePathKey :: String
- saveFormatKey :: String
- withLinksKey :: String
- isTightBboxKey :: String
- isTransparentKey :: String
- inclusionKeys :: [String]
- type PythonScript = Text
- data ScriptResult
- data CheckResult
- data PandocPyplotError
- data SaveFormat
- saveFormatFromString :: String -> Maybe SaveFormat
- extension :: SaveFormat -> String
- defaultPlatformInterpreter :: String
- data Configuration = Configuration {}
- data FigureSpec = FigureSpec {
- caption :: String
- withLinks :: Bool
- script :: PythonScript
- saveFormat :: SaveFormat
- directory :: FilePath
- dpi :: Int
- tightBbox :: Bool
- transparent :: Bool
- 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 that can be specified in source material.
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.
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.
isTightBboxKey :: String Source #
Keys that pandoc-pyplot will look for in code blocks. These are only exported for testing purposes.
isTransparentKey :: 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.
It is assumed that once a FigureSpec has been created, no configuration
can overload it; hence, a FigureSpec completely encodes a particular figure.
Constructors
| FigureSpec | |
Fields
| |
Instances
data SaveFormat Source #
Generated figure file format supported by pandoc-pyplot.
Instances
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.
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.
parseFigureSpec :: Configuration -> Block -> IO (Maybe FigureSpec) Source #
Determine inclusion specifications from Block attributes.
Note that the ".pyplot" class is required, but all other parameters are optional
extension :: SaveFormat -> String Source #
Save format file extension
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.
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.
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.
isTightBboxKey :: String Source #
Keys that pandoc-pyplot will look for in code blocks. These are only exported for testing purposes.
isTransparentKey :: String Source #
Keys that pandoc-pyplot will look for in code blocks. These are only exported for testing purposes.
inclusionKeys :: [String] Source #
list of all keys related to pandoc-pyplot that can be specified in source material.
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 # | |
Defined in Text.Pandoc.Filter.Pyplot.Types | |
| Semigroup CheckResult Source # | |
Defined in Text.Pandoc.Filter.Pyplot.Types Methods (<>) :: CheckResult -> CheckResult -> CheckResult # sconcat :: NonEmpty CheckResult -> CheckResult # stimes :: Integral b => b -> CheckResult -> CheckResult # | |
| Monoid CheckResult Source # | |
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 # | |
Defined in Text.Pandoc.Filter.Pyplot.Types Methods (==) :: PandocPyplotError -> PandocPyplotError -> Bool # (/=) :: PandocPyplotError -> PandocPyplotError -> Bool # | |
| Show PandocPyplotError Source # | |
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.
Instances
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
| Configuration | |
Fields
| |
Instances
| Eq Configuration Source # | |
Defined in Text.Pandoc.Filter.Pyplot.Types Methods (==) :: Configuration -> Configuration -> Bool # (/=) :: Configuration -> Configuration -> Bool # | |
| Show Configuration Source # | |
Defined in Text.Pandoc.Filter.Pyplot.Types Methods showsPrec :: Int -> Configuration -> ShowS # show :: Configuration -> String # showList :: [Configuration] -> ShowS # | |
| ToJSON Configuration Source # | |
Defined in Text.Pandoc.Filter.Pyplot.Types Methods toJSON :: Configuration -> Value # toEncoding :: Configuration -> Encoding # toJSONList :: [Configuration] -> Value # toEncodingList :: [Configuration] -> Encoding # | |
| Default Configuration Source # | |
Defined in Text.Pandoc.Filter.Pyplot.Types Methods def :: Configuration # | |
data FigureSpec Source #
Datatype containing all parameters required to run pandoc-pyplot.
It is assumed that once a FigureSpec has been created, no configuration
can overload it; hence, a FigureSpec completely encodes a particular figure.
Constructors
| FigureSpec | |
Fields
| |