1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
{-# LANGUAGE OverloadedStrings #-}
{-|
Module : Text.Pandoc.Filter.Pyplot.Scripting
Copyright : (c) Laurent P René de Cotret, 2019
License : MIT
Maintainer : laurent.decotret@outlook.com
Stability : internal
Portability : portable
This module defines types and functions that help
with running Python scripts.
-}
module Text.Pandoc.Filter.Pyplot.Scripting
( runTempPythonScript
, runScriptIfNecessary
) where
import Data.Hashable (hash)
import Data.List (intersperse)
import Data.Monoid (Any(..), (<>))
import qualified Data.Text as T
import qualified Data.Text.IO as T
import System.Directory (createDirectoryIfMissing,
doesFileExist)
import System.Exit (ExitCode (..))
import System.FilePath ((</>), takeDirectory)
import System.IO.Temp (getCanonicalTemporaryDirectory)
import System.Process.Typed (runProcess, shell)
import Text.Pandoc.Filter.Pyplot.Types
import Text.Pandoc.Filter.Pyplot.FigureSpec
-- | Detect the presence of a blocking show call, for example "plt.show()"
checkBlockingShowCall :: PythonScript -> CheckResult
checkBlockingShowCall script' =
if hasShowCall
then CheckFailed "The script has a blocking call to `matplotlib.pyplot.show`. "
else CheckPassed
where
scriptLines = T.lines script'
hasShowCall = getAny $ mconcat $ Any <$>
[ "plt.show()" `elem` scriptLines
, "pyplot.show()" `elem` scriptLines
, "matplotlib.pyplot.show()" `elem` scriptLines
]
-- | List of all script checks
-- This might be overkill right now but extension to other languages will be easier
scriptChecks :: [PythonScript -> CheckResult]
scriptChecks = [checkBlockingShowCall]
-- | Take a python script in string form, write it in a temporary directory,
-- then execute it.
runTempPythonScript :: String -- ^ Interpreter (e.g. "python" or "python35")
-> [String] -- ^ Command-line flags
-> PythonScript -- ^ Content of the script
-> IO ScriptResult -- ^ Result.
runTempPythonScript interpreter' flags' script' = case checkResult of
CheckFailed msg -> return $ ScriptChecksFailed msg
CheckPassed -> do
-- We involve the script hash as a temporary filename
-- so that there is never any collision
scriptPath <- (</> hashedPath) <$> getCanonicalTemporaryDirectory
T.writeFile scriptPath script'
let command = mconcat . intersperse " " $ [interpreter'] <> flags' <> [show scriptPath]
ec <- runProcess . shell $ command
case ec of
ExitSuccess -> return ScriptSuccess
ExitFailure code -> return $ ScriptFailure code
where
checkResult = mconcat $ scriptChecks <*> [script']
hashedPath = show . hash $ script'
-- | Run the Python script. In case the file already exists, we can safely assume
-- there is no need to re-run it.
runScriptIfNecessary :: Configuration -> FigureSpec -> IO ScriptResult
runScriptIfNecessary config spec = do
createDirectoryIfMissing True . takeDirectory $ figurePath spec
fileAlreadyExists <- doesFileExist $ figurePath spec
result <- if fileAlreadyExists
then return ScriptSuccess
else runTempPythonScript (interpreter config) (flags config) scriptWithCapture
case result of
ScriptSuccess -> T.writeFile (sourceCodePath spec) (script spec) >> return ScriptSuccess
ScriptFailure code -> return $ ScriptFailure code
ScriptChecksFailed msg -> return $ ScriptChecksFailed msg
where
scriptWithCapture = addPlotCapture spec
|
