Skip to content

Add @[Experimental] annotation to new Process API #16816

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
straight-shoota wants to merge 1 commit into
base: master
Choose a base branch
from
+10 −0
Open

Add @[Experimental] annotation to new Process API #16816

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/process.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,7 @@ class Process
# io.to_s # => "hello\n"
# status # => Process::Status[0]
# ```
@[Experimental]
def self.run(args : Enumerable(String), *, env : Env = nil, clear_env : Bool = false,
input : Stdio = Redirect::Close, output : Stdio = Redirect::Close, error : Stdio = Redirect::Close, chdir : Path | String? = nil) : Process::Status
new(args, env: env, clear_env: clear_env, input: input, output: output, error: error, chdir: chdir).wait
Expand Down Expand Up @@ -240,6 +241,7 @@ class Process
# Process.run?(["true"]) # => Process::Status[0]
# Process.run?(["nonexistent"]) # => nil
# ```
@[Experimental]
def self.run?(args : Enumerable(String), *,
env : Env = nil, clear_env : Bool = false,
input : Stdio = Redirect::Close, output : Stdio = Redirect::Close, error : Stdio = Redirect::Close,
Expand Down Expand Up @@ -269,6 +271,7 @@ class Process
# status # => Process::Status[0]
# result # => "hello\n"
# ```
@[Experimental]
def self.run(args : Enumerable(String), *, env : Env = nil, clear_env : Bool = false,
input : Stdio = Redirect::Pipe, output : Stdio = Redirect::Pipe, error : Stdio = Redirect::Pipe, chdir : Path | String? = nil, & : Process -> _)
process = new(args, env: env, clear_env: clear_env, input: input, output: output, error: error, chdir: chdir)
Expand Down Expand Up @@ -412,6 +415,7 @@ class Process
# * `Process.run` is a convenient short cut if you just want to run a command
# and wait for it to finish.
# * `Process.exec` replaces the current process.
@[Experimental]
def self.new(args : Enumerable(String), *, env : Env = nil, clear_env : Bool = false,
input : Stdio = Redirect::Close, output : Stdio = Redirect::Close, error : Stdio = Redirect::Close, chdir : Path | String? = nil)
new(args, env: env, clear_env: clear_env, input: input, output: output, error: error, chdir: chdir) do |error, command|
Expand Down
6 changes: 6 additions & 0 deletions src/process/capture.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
class Process
@[Experimental]
class ExitError < Exception
getter args : Enumerable(String)
getter result : Result
Expand All @@ -13,6 +14,7 @@ class Process
end
end

@[Experimental]
struct Process::Result
def initialize(@status : Status, @output : String?, @error : String?)
end
Expand Down Expand Up @@ -66,6 +68,7 @@ class Process
# Process.capture_result(%w[echo foo]).output # => "foo\n"
# Process.capture_result(%w[nonexist]) # raises Process::ExitError
# ```
@[Experimental]
def self.capture_result(args : Enumerable(String), *, env : Env = nil, clear_env : Bool = false,
input : Stdio = Redirect::Close, output : Stdio = Redirect::Pipe, error : Stdio = Redirect::Pipe, chdir : Path | String? = nil) : Result
capture_result_impl(output, error) do |error|
Expand All @@ -84,6 +87,7 @@ class Process
# Process.capture_result?(%w[echo foo]).try(&.output) # => "foo\n"
# Process.capture_result?(%w[nonexist]) # => nil
# ```
@[Experimental]
def self.capture_result?(args : Enumerable(String), *, env : Env = nil, clear_env : Bool = false,
input : Stdio = Redirect::Close, output : Stdio = Redirect::Pipe, error : Stdio = Redirect::Pipe, chdir : Path | String? = nil) : Result?
capture_result_impl(output, error) do |error|
Expand Down Expand Up @@ -120,6 +124,7 @@ class Process
# Process.capture(%w[echo foo]) # => "foo\n"
# Process.capture(%w[nonexist]) # raises Process::ExitError
# ```
@[Experimental]
def self.capture(args : Enumerable(String), *, env : Env = nil, clear_env : Bool = false,
input : Stdio = Redirect::Close, error : Stdio = Redirect::Pipe, chdir : Path | String? = nil) : String
result = capture_result(args, env: env, clear_env: clear_env, input: input, error: error, chdir: chdir)
Expand All @@ -142,6 +147,7 @@ class Process
# Process.capture(%w[echo foo]) # => "foo\n"
# Process.capture(%w[nonexist]) # => nil
# ```
@[Experimental]
def self.capture?(args : Enumerable(String), *, env : Env = nil, clear_env : Bool = false,
input : Stdio = Redirect::Close, error : Stdio = Redirect::Close, chdir : Path | String? = nil) : String?
result = capture_result(args, env: env, clear_env: clear_env, input: input, error: error, chdir: chdir)
Expand Down
Loading