Julia REPL

Julia 附带了一个全功能的交互式命令行 REPL（read-eval-print loop），其内置于 julia 可执行文件中。它除了允许快速简便地执行 Julia 语句外，还具有可搜索的历史记录，tab 补全，许多有用的按键绑定以及专用的 help 和 shell 模式。只需不附带任何参数地调用 julia 或双击可执行文件即可启动 REPL：

  1. $ julia
  2.                _
  3.    _       _ _(_)_     |  A fresh approach to technical computing
  4.   (_)     | (_) (_)    |  Documentation: https://docs.julialang.org
  5.    _ _   _| |_  __ _   |  Type "?help" for help.
  6.   | | | | | | |/ _` |  |
  7.   | | |_| | | | (_| |  |  Version 0.6.0-dev.2493 (2017-01-31 18:53 UTC)
  8.  _/ |\__'_|_|_|\__'_|  |  Commit c99e12c* (0 days old master)
  9. |__/                   |  x86_64-linux-gnu
  11. julia>

要退出交互式会话，在空白行上键入 ^D——control 键和 d 键，或者先键入 quit()，然后键入 return 或 enter 键。REPL 用横幅和 julia> 提示符欢迎你。

不同的提示符模式

Julian 模式

REPL 有四种主要的操作模式。第一个也是最常见的是 Julian 提示符。这是默认的操作模式；每个新行最初都以 julia> 开头。就在这里，你可以输入 Julia 表达式。在输入完整表达式后按下 return 或 enter 将执行该表达式，并显示最后一个表达式的结果。

  1. julia> string(1 + 2)
  2. "3"

交互式运行有许多独特的实用功能。除了显示结果外，REPL 还将结果绑定到变量 ans 上。一行的尾随分号可用作禁止显示结果的标志。

  1. julia> string(3 * 4);
  3. julia> ans
  4. "12"

Julia 模式中，REPL 支持称为 prompt pasting 的功能。当粘贴以 julia> 文本到 REPL 中时才会激活此功能。在这种情况下，只有以 julia> 开头的表达式才被解析，其它的表达式则被删除。这使得可以粘贴从 REPL 会话中复制的一大块代码，而无需擦除提示和输出。默认情况下启用此功能，但可以使用Base.REPL.enable_promptpaste(::Bool) 任意禁用或启用此功能。如果它已启用，您可以通过将本段上方的代码块直接粘贴到 REPL 中来尝试。此功能在标准的 Windows 命令提示符下不起作用，由于它在检测粘贴何时发生上的限制。

帮助模式

当光标在行首时，提示符可以通过键入 ? 改变为帮助模式。Julia 将尝试打印在帮助模式中输入的任何内容的帮助或文档：

  1. julia> ? # upon typing ?, the prompt changes (in place) to: help?>
  3. help?> string
  4. search: string String Cstring Cwstring RevString randstring bytestring SubString
  6.   string(xs...)
  8.   Create a string from any values using the print function.

还可以查询宏，类型和变量：

  1. help?> @time
  2.   @time
  4.   A macro to execute an expression, printing the time it took to execute, the number of allocations,
  5.   and the total number of bytes its execution caused to be allocated, before returning the value of the
  6.   expression.
  8.   See also @timev, @timed, @elapsed, and @allocated.
  10. help?> Int32
  11. search: Int32 UInt32
  13.   Int32 <: Signed
  15.   32-bit signed integer type.

通过在行的开头按退格键可以退出帮助模式。

Shell 模式

正如帮助模式对快速访问文档很有用，另一个常见任务是使用系统 shell 执行系统命令。就像 ? 进入帮助模式，在行的开头，分号（;）将进入 shell 模式。并且通过在行的开头按退格键可以退出 shell 模式。

  1. julia> ; # upon typing ;, the prompt changes (in place) to: shell>
  3. shell> echo hello
  4. hello

搜索模式

在所有上述模式中，执行过的行被保存到历史文件中，该文件可以被搜索。要通过之前的历史记录启动增量搜索，请键入 ^R——control 键和 r 键。提示符会变为 (reverse-i-search)`':，搜索查询在你输入时出现在引号中。匹配查询的最近结果会在输入更多内容时动态更新到冒号右侧。要使用相同的查询查找更旧的结果，只需再次键入 ^R。

正如 ^R 是反向搜索，^S 是前向搜索，带有提示符 (i-search)`':。这两者可以彼此结合使用以分别移动至前一个或下一个匹配结果。

按键绑定

Julia REPL 充分利用了按键绑定。上面已经介绍了几个 control 键绑定（^D 退出，^R 和 ^S用于搜索），但还有更多按键绑定。除 control 键之外，还有 meta 键绑定。这些因平台而异，但大多数终端默认使用按住 alt- 或 option- 和一个键发送 meta 键（或者可以配置为执行此操作）。

按键绑定描述
程序控制
^D退出（当缓冲区为空）
^C中断或取消
^L清空控制台屏幕
Return/Enter, ^J插入新行，如果行是完整的则执行之
meta-Return/Enter插入新行而不执行它
? 或 ;进入帮助或 shell 模式（当在行首时）
^R, ^S增量历史搜索，如上所述
光标移动
Right arrow, ^F向右移动一个字符
Left arrow, ^B向左移动一个字符
ctrl-Right, meta-F向右移动一个单词
ctrl-Left, meta-B向左移动一个单词
Home, ^A移动至行首
End, ^E移动至行尾
Up arrow, ^P向上移动一行（或更改为与光标前文本相匹配的上一条历史记录）
Down arrow, ^N向下移动一行（或更改为与光标前文本相匹配的下一条历史记录）
Shift-Arrow KeyMove cursor according to the direction of the Arrow key, while activating the region ("shift selection")
Page-up, meta-P更改为上一条历史记录
Page-down, meta-N更改为下一条历史记录
meta-<更改为（当前会话的）第一条历史记录（如果其在历史记录中位于当前位置之前）
meta->更改为最后一条历史记录
^-SpaceSet the "mark" in the editing region (and de-activate the region if it's active)
^-Space ^-SpaceSet the "mark" in the editing region and make the region "active", i.e. highlighted
^GDe-activate the region (i.e. make it not highlighted)
^X^XExchange the current position with the mark
编辑
Backspace, ^HDelete the previous character, or the whole region when it's active
Delete, ^D删除下一个字符（当缓冲区还有文本）
meta-Backspace删除上一个单词
meta-d删除下一个单词
^W删除前一段文本直到最近的空格
meta-wCopy the current region in the kill ring
meta-W"Kill" the current region, placing the text in the kill ring
^K"Kill" to end of line, placing the text in the kill ring
^Y"Yank" insert the text from the kill ring
meta-yReplace a previously yanked text with an older entry from the kill ring
^T颠倒光标左右两侧的字符
meta-Up arrow颠倒当前行和上一行
meta-Down arrow颠倒当前行和下一行
meta-u将下一个单词更改为大写
meta-c将下一个单词更改为首字母大写
meta-l将下一个单词更改为小写
^/, ^_撤消上一个编辑操作
^QWrite a number in REPL and press ^Q to open editor at corresponding stackframe or method
meta-Left Arrowindent the current line on the left
meta-Right Arrowindent the current line on the right

自定义按键绑定

通过将字典传递给 REPL.setup_interface，Julia 的 REPL 按键绑定可以完全根据用户的喜好进行自定义。该字典的键可以是字符或字符串。键 '*' 表示默认操作。Control 键加字符 x 的绑定用 "^x" 表示。Meta 加 x 可以写成 "\Mx"。自定义按键映射必须为 nothing（表示输入应被忽略）或接受签名的函数 (PromptState, AbstractREPL, Char)。必须在 REPL 初始化前调用 REPL.setup_interface 函数，方法是通过 atreplinit 注册操作。例如，要绑定上和下方向键在没有前缀搜索的情况下浏览历史记录，可以将以下代码放在 ~/.julia/config/startup.jl 中：

  1. import REPL
  2. import REPL.LineEdit
  4. const mykeys = Dict{Any,Any}(
  5.     # Up Arrow
  6.     "\e[A" => (s,o...)->(LineEdit.edit_move_up(s) || LineEdit.history_prev(s, LineEdit.mode(s).hist)),
  7.     # Down Arrow
  8.     "\e[B" => (s,o...)->(LineEdit.edit_move_up(s) || LineEdit.history_next(s, LineEdit.mode(s).hist))
  9. )
  11. function customize_keys(repl)
  12.     repl.interface = REPL.setup_interface(repl; extra_repl_keymap = mykeys)
  13. end
  15. atreplinit(customize_keys)

用户应该参考 LineEdit.jl 来发现输入按键的可用操作。

Tab 补全

在 REPL 的 Julian 和帮助模式中，可以先输入函数或类型的前几个字符，接着按 tab 键来获取所有匹配的列表：

  1. julia> stri[TAB]
  2. stride     strides     string      strip
  4. julia> Stri[TAB]
  5. StridedArray    StridedMatrix    StridedVecOrMat  StridedVector    String

Tab 键也可用于将 LaTeX 数学符号替换为其 Unicode 等价字符，也可用于获取 LaTeX 匹配的列表：

  1. julia> \pi[TAB]
  2. julia> π
  3. π = 3.1415926535897...
  5. julia> e\_1[TAB] = [1,0]
  6. julia> e₁ = [1,0]
  7. 2-element Array{Int64,1}:
  8.  1
  9.  0
  11. julia> e\^1[TAB] = [1 0]
  12. julia> e¹ = [1 0]
  13. 1×2 Array{Int64,2}:
  14.  1  0
  16. julia> \sqrt[TAB]2     # √ is equivalent to the sqrt function
  17. julia> √2
  18. 1.4142135623730951
  20. julia> \hbar[TAB](h) = h / 2\pi[TAB]
  21. julia> ħ(h) = h / 2π
  22. ħ (generic function with 1 method)
  24. julia> \h[TAB]
  25. \hat              \hermitconjmatrix  \hkswarow          \hrectangle
  26. \hatapprox        \hexagon           \hookleftarrow     \hrectangleblack
  27. \hbar             \hexagonblack      \hookrightarrow    \hslash
  28. \heartsuit        \hksearow          \house             \hspace
  30. julia> α="\alpha[TAB]"   # LaTeX completion also works in strings
  31. julia> α="α"

Tab 补全的完整列表可以在手册的 Unicode 输入表章节中找到。

路径补全适用于字符串和 julia 的 shell 模式：

  1. julia> path="/[TAB]"
  2. .dockerenv  .juliabox/   boot/        etc/         lib/         media/       opt/         root/        sbin/        sys/         usr/
  3. .dockerinit bin/         dev/         home/        lib64/       mnt/         proc/        run/         srv/         tmp/         var/
  4. shell> /[TAB]
  5. .dockerenv  .juliabox/   boot/        etc/         lib/         media/       opt/         root/        sbin/        sys/         usr/
  6. .dockerinit bin/         dev/         home/        lib64/       mnt/         proc/        run/         srv/         tmp/         var/

Tab 补全可以帮助查找与输入参数相匹配的可用方法：

  1. julia> max([TAB] # All methods are displayed, not shown here due to size of the list
  3. julia> max([1, 2], [TAB] # All methods where `Vector{Int}` matches as first argument
  4. max(x, y) in Base at operators.jl:215
  5. max(a, b, c, xs...) in Base at operators.jl:281
  7. julia> max([1, 2], max(1, 2), [TAB] # All methods matching the arguments.
  8. max(x, y) in Base at operators.jl:215
  9. max(a, b, c, xs...) in Base at operators.jl:281

关键字也会在建议的方法中显示在 ; 之后，请看下面，其中 limit 和 keepempty 是关键字参数：

  1. julia> split("1 1 1", [TAB]
  2. split(str::AbstractString; limit, keepempty) in Base at strings/util.jl:302
  3. split(str::T, splitter; limit, keepempty) where T<:AbstractString in Base at strings/util.jl:277

方法的补全使用类型推断，因此即使参数是函数的输出，也可以查看参数是否匹配。函数需要是类型稳定的，这样补全才能删除不匹配的方法。

Tab 补全也可以帮助补全字段：

  1. julia> import UUIDs
  3. julia> UUIDs.uuid[TAB]
  4. uuid1        uuid4         uuid_version

函数输出的字段也可以补全：

  1. julia> split("","")[1].[TAB]
  2. lastindex  offset  string

函数输出的字段补全使用类型推断，它只能在函数是类型稳定时建议字段。

自定义配色

Julia 和 REPL 使用的配色也可以被自定义。为了修改 Julia 提示符的颜色，你可以在你的 ~/.julia/config/startup.jl 文件中添加以下内容，该文件在你的家目录中：

  1. function customize_colors(repl)
  2.     repl.prompt_color = Base.text_colors[:cyan]
  3. end
  5. atreplinit(customize_colors)

可用的颜色键通过在 REPL 的帮助模式中输入 Base.text_colors 可以看到。此外，从 0 到 255 的整数可用作具有 256 色支持的终端的颜色键。

你也可以改变帮助、shell 提示符、输入和输出的文本颜色，这通过在上面的 customize_colors 函数中设置 repl 的相应字段（分别为 help_color、shell_color、input_color 和 answer_color）。对于后两个字段，请确定 envcolors 字段也设置为 false。

通过将 Base.text_colors[:bold] 用作颜色，也可以使用粗体格式。例如，要以粗体字体打印输出，可以将以下内容作为 ~/.julia/config/startup.jl：

  1. function customize_colors(repl)
  2.     repl.envcolors = false
  3.     repl.answer_color = Base.text_colors[:bold]
  4. end
  6. atreplinit(customize_colors)

你还可以自定义用于呈现 warning 和 informational 消息的颜色，这通过设置相应的环境变量。例如，要分别以 magenta、yellow 和 cyan 呈现 error、warning 和 informational 消息，你可以在你的 ~/.julia/config/startup.jl 文件中添加以下内容：

  1. ENV["JULIA_ERROR_COLOR"] = :magenta
  2. ENV["JULIA_WARN_COLOR"] = :yellow
  3. ENV["JULIA_INFO_COLOR"] = :cyan

TerminalMenus

TerminalMenus is a submodule of the Julia REPL and enables small, low-profile interactive menus in the terminal.

Examples

  1. import REPL
  2. using REPL.TerminalMenus
  4. options = ["apple", "orange", "grape", "strawberry",
  5.             "blueberry", "peach", "lemon", "lime"]

RadioMenu

The RadioMenu allows the user to select one option from the list. The request function displays the interactive menu and returns the index of the selected choice. If a user presses 'q' or ctrl-c, request will return a -1.

  1. # `pagesize` is the number of items to be displayed at a time.
  2. #  The UI will scroll if the number of options is greater
  3. #   than the `pagesize`
  4. menu = RadioMenu(options, pagesize=4)
  6. # `request` displays the menu and returns the index after the
  7. #   user has selected a choice
  8. choice = request("Choose your favorite fruit:", menu)
  10. if choice != -1
  11.     println("Your favorite fruit is ", options[choice], "!")
  12. else
  13.     println("Menu canceled.")
  14. end

Output:

  1. Choose your favorite fruit:
  2. ^  grape
  3.    strawberry
  4.  > blueberry
  5. v  peach
  6. Your favorite fruit is blueberry!

MultiSelectMenu

The MultiSelectMenu allows users to select many choices from a list.

  1. # here we use the default `pagesize` 10
  2. menu = MultiSelectMenu(options)
  4. # `request` returns a `Set` of selected indices
  5. # if the menu us canceled (ctrl-c or q), return an empty set
  6. choices = request("Select the fruits you like:", menu)
  8. if length(choices) > 0
  9.     println("You like the following fruits:")
  10.     for i in choices
  11.         println("  - ", options[i])
  12.     end
  13. else
  14.     println("Menu canceled.")
  15. end

Output:

  1. Select the fruits you like:
  2. [press: d=done, a=all, n=none]
  3.    [ ] apple
  4.  > [X] orange
  5.    [X] grape
  6.    [ ] strawberry
  7.    [ ] blueberry
  8.    [X] peach
  9.    [ ] lemon
  10.    [ ] lime
  11. You like the following fruits:
  12.   - orange
  13.   - grape
  14.   - peach

Customization / Configuration

All interface customization is done through the keyword only TerminalMenus.config() function.

Arguments

  • charset::Symbol=:na: ui characters to use (:ascii or :unicode); overridden by other arguments
  • cursor::Char='>'|'→': character to use for cursor
  • up_arrow::Char='^'|'↑': character to use for up arrow
  • down_arrow::Char='v'|'↓': character to use for down arrow
  • checked::String="[X]"|"✓": string to use for checked
  • unchecked::String="[ ]"|"⬚"): string to use for unchecked
  • scroll::Symbol=:na: If :wrap then wrap the cursor around top and bottom, if :nowrap do not wrap cursor
  • supress_output::Bool=false: For testing. If true, menu will not be printed to console.
  • ctrl_c_interrupt::Bool=true: If false, return empty on ^C, if true throw InterruptException() on ^C

Examples

  1. julia> menu = MultiSelectMenu(options, pagesize=5);
  3. julia> request(menu) # ASCII is used by default
  4. [press: d=done, a=all, n=none]
  5.    [ ] apple
  6.    [X] orange
  7.    [ ] grape
  8.  > [X] strawberry
  9. v  [ ] blueberry
  10. Set([4, 2])
  12. julia> TerminalMenus.config(charset=:unicode)
  14. julia> request(menu)
  15. [press: d=done, a=all, n=none]
  16.    ⬚ apple
  17.    ✓ orange
  18.    ⬚ grape
  19.  → ✓ strawberry
  20. ↓  ⬚ blueberry
  21. Set([4, 2])
  23. julia> TerminalMenus.config(checked="YEP!", unchecked="NOPE", cursor='⧐')
  25. julia> request(menu)
  26. [press: d=done, a=all, n=none]
  27.    NOPE apple
  28.    YEP! orange
  29.    NOPE grape
  30.  ⧐ YEP! strawberry
  31. ↓  NOPE blueberry
  32. Set([4, 2])

References

Base.atreplinit — Function.

  1. atreplinit(f)

Register a one-argument function to be called before the REPL interface is initialized in interactive sessions; this is useful to customize the interface. The argument of f is the REPL object. This function should be called from within the .julia/config/startup.jl initialization file.

source