mirrors/Nim
1
0
Fork 0
mirror of https://github.com/nim-lang/Nim.git synced 2026-06-06 03:44:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add warnings about exec usage. (#23820)

Browse Source 
Related to https://github.com/nim-lang/Nim/issues/23819 and also found
in discord
https://discord.com/channels/371759389889003530/371759389889003532/1260845467147829372
Since nothing can be done, besides deprecating the function, a warning
is a better option.

---------

Co-authored-by: Juan Carlos <juancarlospaco@gmail.com>
This commit is contained in:
Antonis Geralis
2024-07-17 09:45:52 +03:00
committed by GitHub
parent fe48de4406
commit ad5b5e3ec0
1 changed files with 9 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
lib/system/nimscript.nim
View File

@@ -253,7 +253,8 @@ proc cpDir*(`from`, to: string) {.raises: [OSError].} =
proc exec*(command: string) {.
raises: [OSError], tags: [ExecIOEffect, WriteIOEffect].} =
## Executes an external process. If the external process terminates with
## a non-zero exit code, an OSError exception is raised.
## a non-zero exit code, an OSError exception is raised. The command is
## executed relative to the current source path.
##
## **Note:** If you need a version of `exec` that returns the exit code
## and text output of the command, you can use `system.gorgeEx
@@ -267,11 +268,17 @@ proc exec*(command: string, input: string, cache = "") {.
raises: [OSError], tags: [ExecIOEffect, WriteIOEffect].} =
## Executes an external process. If the external process terminates with
## a non-zero exit code, an OSError exception is raised.
##
## .. warning:: This version of `exec` is executed relative to the nimscript
## module path, which affects how the command resolves relative paths. Thus
## it is generally better to use `gorgeEx` directly when you need more
## control over the execution environment or when working with commands
## that deal with relative paths.
log "exec: " & command:
let (output, exitCode) = gorgeEx(command, input, cache)
echo output
if exitCode != 0:
raise newException(OSError, "FAILED: " & command)
echo output
proc selfExec*(command: string) {.
raises: [OSError], tags: [ExecIOEffect, WriteIOEffect].} =