The Julia REPL
Julia поставляется с полнофункциональным интерактивным командным REPL (цикл чтения-вычисления-вывода), встроенным в исполняемый файл julia
. В дополнение к быстрому и простому выполнению операторов Julia, он имеет историю с возможностью поиска, автозаполнение, множество полезных сочетаний клавиш и специальные режимы помощи и оболочки. REPL можно запустить, просто вызвав julia
без аргументов или дважды щелкнув на исполняемом файле:
$ julia
_
_ _ _(_)_ | Documentation: https://docs.julialang.org
(_) | (_) (_) |
_ _ _| |_ __ _ | Type "?" for help, "]?" for Pkg help.
| | | | | | |/ _` | |
| | |_| | | | (_| | | Version 1.11.5 (2025-04-14)
_/ |\__'_|_|_|\__'_| | HEAD/760b2e5* (fork: 1 commits, 81 days)
|__/ |
julia>
Чтобы выйти из интерактивной сессии, введите ^D
– клавишу управления вместе с клавишей d
на пустой строке – или введите exit()
, а затем нажмите клавишу возврата или ввода. REPL приветствует вас баннером и приглашением julia>
.
The different prompt modes
The Julian mode
REPL имеет пять основных режимов работы. Первый и самый распространенный - это приглашение Julia. Это режим работы по умолчанию; каждая новая строка изначально начинается с julia>
. Здесь вы можете вводить выражения Julia. Нажатие клавиши возврата или ввода после завершения выражения оценит ввод и покажет результат последнего выражения.
julia> string(1 + 2)
"3"
Существует ряд полезных функций, уникальных для интерактивной работы. В дополнение к отображению результата, REPL также связывает результат с переменной ans
. Точка с запятой в конце строки может использоваться как флаг для подавления отображения результата.
julia> string(3 * 4);
julia> ans
"12"
В режиме Julia REPL поддерживает так называемое вставка подсказок. Это активируется, когда вставляется текст, начинающийся с julia>
, в REPL. В этом случае парсятся только выражения, начинающиеся с julia>
(а также другие подсказки режима REPL: shell>
, help?>
, pkg>
), в то время как остальные удаляются. Это позволяет вставлять фрагмент текста, скопированного из сессии REPL, не очищая подсказки и выводы. Эта функция включена по умолчанию, но может быть отключена или включена по желанию с помощью REPL.enable_promptpaste(::Bool)
. Если она включена, вы можете попробовать вставить блок кода выше этого абзаца прямо в REPL. Эта функция не работает в стандартной командной строке Windows из-за ее ограничений в определении момента вставки.
Объекты выводятся в REPL с помощью функции show
с определенной IOContext
. В частности, атрибут :limit
установлен в true
. Другие атрибуты могут получать в определенных методах show
значение по умолчанию, если оно еще не установлено, например, :compact
. Возможно, как экспериментальная функция, указать атрибуты, используемые REPL, через словарь Base.active_repl.options.iocontext
(связывая значения с атрибутами). Например:
julia> rand(2, 2)
2×2 Array{Float64,2}:
0.8833 0.329197
0.719708 0.59114
julia> show(IOContext(stdout, :compact => false), "text/plain", rand(2, 2))
0.43540323669187075 0.15759787870609387
0.2540832269192739 0.4597637838786053
julia> Base.active_repl.options.iocontext[:compact] = false;
julia> rand(2, 2)
2×2 Array{Float64,2}:
0.2083967319174056 0.13330606013126012
0.6244375177790158 0.9777957560761545
Чтобы автоматически определить значения этого словаря во время запуска, можно использовать функцию atreplinit
в файле ~/.julia/config/startup.jl
, например:
atreplinit() do repl
repl.options.iocontext[:compact] = false
end
Help mode
Когда курсор находится в начале строки, подсказку можно изменить на режим помощи, набрав ?
. Julia попытается вывести справку или документацию для всего, что введено в режиме помощи:
julia> ? # upon typing ?, the prompt changes (in place) to: help?>
help?> string
search: string String Cstring Cwstring RevString randstring bytestring SubString
string(xs...)
Create a string from any values using the print function.
Макросы, типы и переменные также могут быть запрошены:
help?> @time
@time
A macro to execute an expression, printing the time it took to execute, the number of allocations,
and the total number of bytes its execution caused to be allocated, before returning the value of the
expression.
See also @timev, @timed, @elapsed, and @allocated.
help?> Int32
search: Int32 UInt32
Int32 <: Signed
32-bit signed integer type.
Строка или литерал регулярного выражения ищет все строки документации, используя apropos
:
help?> "aprop"
REPL.stripmd
Base.Docs.apropos
help?> r"ap..p"
Base.:∘
Base.shell_escape_posixly
Distributed.CachingPool
REPL.stripmd
Base.Docs.apropos
Еще одной особенностью режима помощи является возможность доступа к расширенным строкам документации. Вы можете сделать это, набрав что-то вроде ??Print
, а не ?Print
, что отобразит раздел # Расширенная помощь
из документации исходного кода.
Режим помощи можно выйти, нажав клавишу backspace в начале строки.
Shell mode
Так же, как режим помощи полезен для быстрого доступа к документации, еще одной распространенной задачей является использование системной оболочки для выполнения системных команд. Так же, как ?
вводит режим помощи, когда находится в начале строки, точка с запятой (;
) войдет в режим оболочки. И из него можно выйти, нажав клавишу backspace в начале строки.
julia> ; # upon typing ;, the prompt changes (in place) to: shell>
shell> echo hello
hello
Для пользователей Windows режим оболочки Julia не предоставляет команды оболочки Windows. Следовательно, это приведет к ошибке:
julia> ; # upon typing ;, the prompt changes (in place) to: shell>
shell> dir
ERROR: IOError: could not spawn `dir`: no such file or directory (ENOENT)
Stacktrace!
.......
Однако вы можете получить доступ к PowerShell
вот так:
julia> ; # upon typing ;, the prompt changes (in place) to: shell>
shell> powershell
Windows PowerShell
Copyright (C) Microsoft Corporation. All rights reserved.
PS C:\Users\elm>
... и в cmd.exe
так (см. команду dir
):
julia> ; # upon typing ;, the prompt changes (in place) to: shell>
shell> cmd
Microsoft Windows [version 10.0.17763.973]
(c) 2018 Microsoft Corporation. All rights reserved.
C:\Users\elm>dir
Volume in drive C has no label
Volume Serial Number is 1643-0CD7
Directory of C:\Users\elm
29/01/2020 22:15 <DIR> .
29/01/2020 22:15 <DIR> ..
02/02/2020 08:06 <DIR> .atom
Pkg mode
Режим менеджера пакетов принимает специализированные команды для загрузки и обновления пакетов. В него можно войти, нажав клавишу ]
на приглашении REPL Julian, и выйти, нажав CTRL-C или клавишу backspace в начале строки. Подсказка для этого режима - pkg>
. Он поддерживает собственный режим помощи, который активируется нажатием ?
в начале строки приглашения pkg>
. Режим менеджера пакетов документирован в руководстве Pkg, доступном по адресу https://julialang.github.io/Pkg.jl/v1/.
Search modes
Во всех вышеперечисленных режимах выполненные строки сохраняются в файл истории, который можно искать. Чтобы начать инкрементальный поиск по предыдущей истории, введите ^R
– клавишу управления вместе с клавишей r
. Подсказка изменится на (reverse-i-search)`':
, и по мере ввода поискового запроса он будет появляться в кавычках. Самый последний результат, соответствующий запросу, будет динамически обновляться справа от двоеточия по мере ввода. Чтобы найти более старый результат с тем же запросом, просто снова введите ^R
.
Так же как ^R
является обратным поиском, ^S
является прямым поиском, с подсказкой (i-search)`':
. Оба могут использоваться вместе для перемещения по предыдущим или следующим совпадающим результатам соответственно.
Все выполненные команды в Julia REPL записываются в ~/.julia/logs/repl_history.jl
вместе с временной меткой, когда они были выполнены, и текущим режимом REPL, в котором вы находились. Режим поиска запрашивает этот файл журнала, чтобы найти команды, которые вы ранее выполняли. Это можно отключить при запуске, передав флаг --history-file=no
в Julia.
Key bindings
REPL Julia делает отличное использование сочетаний клавиш. Несколько сочетаний клавиш с контролем уже были представлены выше (^D
для выхода, ^R
и ^S
для поиска), но есть и много других. В дополнение к сочетаниям клавиш с контролем, также существуют сочетания клавиш с мета-клавишами. Они больше варьируются в зависимости от платформы, но большинство терминалов по умолчанию используют удерживание alt- или option- вместе с клавишей для отправки мета-клавиши (или могут быть настроены на это), или нажатие Esc, а затем клавиши.
Keybinding | Description |
---|---|
Program control | |
^D | Exit (when buffer is empty) |
^C | Interrupt or cancel |
^L | Clear console screen |
Return/Enter, ^J | New line, executing if it is complete |
meta-Return/Enter | Insert new line without executing it |
? or ; | Enter help or shell mode (when at start of a line) |
^R , ^S | Incremental history search, described above |
Cursor movement | |
Right arrow, ^F | Move right one character |
Left arrow, ^B | Move left one character |
ctrl-Right, meta-F | Move right one word |
ctrl-Left, meta-B | Move left one word |
Home, ^A | Move to beginning of line |
End, ^E | Move to end of line |
Up arrow, ^P | Move up one line (or change to the previous history entry that matches the text before the cursor) |
Down arrow, ^N | Move down one line (or change to the next history entry that matches the text before the cursor) |
Shift-Arrow Key | Move cursor according to the direction of the Arrow key, while activating the region ("shift selection") |
Page-up, meta-P | Change to the previous history entry |
Page-down, meta-N | Change to the next history entry |
meta-< | Change to the first history entry (of the current session if it is before the current position in history) |
meta-> | Change to the last history entry |
^-Space | Set the "mark" in the editing region (and de-activate the region if it's active) |
^-Space ^-Space | Set the "mark" in the editing region and make the region "active", i.e. highlighted |
^G | De-activate the region (i.e. make it not highlighted) |
^X^X | Exchange the current position with the mark |
Editing | |
Backspace, ^H | Delete the previous character, or the whole region when it's active |
Delete, ^D | Forward delete one character (when buffer has text) |
meta-Backspace | Delete the previous word |
meta-d | Forward delete the next word |
^W | Delete previous text up to the nearest whitespace |
meta-w | Copy the current region in the kill ring |
meta-W | "Kill" the current region, placing the text in the kill ring |
^U | "Kill" to beginning of line, 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-y | Replace a previously yanked text with an older entry from the kill ring |
^T | Transpose the characters about the cursor |
meta-Up arrow | Transpose current line with line above |
meta-Down arrow | Transpose current line with line below |
meta-u | Change the next word to uppercase |
meta-c | Change the next word to titlecase |
meta-l | Change the next word to lowercase |
^/ , ^_ | Undo previous editing action |
^Q | Write a number in REPL and press ^Q to open editor at corresponding stackframe or method |
meta-Left Arrow | Indent the current line on the left |
meta-Right Arrow | Indent the current line on the right |
meta-. | Insert last word from previous history entry |
meta-e | Edit the current input in an editor |
Customizing keybindings
Клавиши управления в REPL Julia могут быть полностью настроены в соответствии с предпочтениями пользователя, передав словарь в REPL.setup_interface
. Ключи этого словаря могут быть символами или строками. Ключ '*'
относится к действию по умолчанию. Связки клавиш Control плюс символ x
обозначаются как "^x"
. Meta плюс x
можно записать как "\\M-x"
или "\ex"
, а Control плюс x
можно записать как "\\C-x"
или "^x"
. Значения пользовательской клавиатурной карты должны быть nothing
(что указывает на то, что ввод должен быть проигнорирован) или функциями, которые принимают сигнатуру (PromptState, AbstractREPL, Char)
. Функция REPL.setup_interface
должна быть вызвана до инициализации REPL, зарегистрировав операцию с atreplinit
. Например, чтобы привязать клавиши стрелок вверх и вниз для перемещения по истории без поиска по префиксу, можно поместить следующий код в ~/.julia/config/startup.jl
:
import REPL
import REPL.LineEdit
const mykeys = Dict{Any,Any}(
# Up Arrow
"\e[A" => (s,o...)->(LineEdit.edit_move_up(s) || LineEdit.history_prev(s, LineEdit.mode(s).hist)),
# Down Arrow
"\e[B" => (s,o...)->(LineEdit.edit_move_down(s) || LineEdit.history_next(s, LineEdit.mode(s).hist))
)
function customize_keys(repl)
repl.interface = REPL.setup_interface(repl; extra_repl_keymap = mykeys)
end
atreplinit(customize_keys)
Пользователи должны обратиться к LineEdit.jl
, чтобы узнать доступные действия при вводе с клавиатуры.
Tab completion
В режимах Julian, pkg и help REPL можно ввести первые несколько символов функции или типа, а затем нажать клавишу Tab, чтобы получить список всех совпадений:
julia> x[TAB]
julia> xor
В некоторых случаях он завершает только часть имени, до следующей неоднозначности:
julia> mapf[TAB]
julia> mapfold
Если вы снова нажмете таб, то получите список вещей, которые могут это завершить:
julia> mapfold[TAB]
mapfoldl mapfoldr
Когда в конце строки ввода доступен один полный результат автозавершения и было введено 2 или более символов, подсказка о завершении будет отображаться светлее. Это можно отключить с помощью Base.active_repl.options.hint_tab_completes = false
или добавив
atreplinit() do repl
if VERSION >= v"1.11.0-0"
repl.options.hint_tab_completes = false
end
end
в ваш ~/.julia/config/startup.jl
.
Подсказки автозаполнения с помощью табуляции были добавлены в Julia 1.11
Как и другие компоненты REPL, поиск чувствителен к регистру:
julia> stri[TAB]
stride strides string strip
julia> Stri[TAB]
StridedArray StridedMatrix StridedVecOrMat StridedVector String
Клавишу Tab также можно использовать для замены математических символов LaTeX на их эквиваленты в Unicode и получения списка совпадений LaTeX:
julia> \pi[TAB]
julia> π
π = 3.1415926535897...
julia> e\_1[TAB] = [1,0]
julia> e₁ = [1,0]
2-element Array{Int64,1}:
1
0
julia> e\^1[TAB] = [1 0]
julia> e¹ = [1 0]
1×2 Array{Int64,2}:
1 0
julia> \sqrt[TAB]2 # √ is equivalent to the sqrt function
julia> √2
1.4142135623730951
julia> \hbar[TAB](h) = h / 2\pi[TAB]
julia> ħ(h) = h / 2π
ħ (generic function with 1 method)
julia> \h[TAB]
\hat \hermitconjmatrix \hkswarow \hrectangle
\hatapprox \hexagon \hookleftarrow \hrectangleblack
\hbar \hexagonblack \hookrightarrow \hslash
\heartsuit \hksearow \house \hspace
julia> α="\alpha[TAB]" # LaTeX completion also works in strings
julia> α="α"
Полный список автозаполнений можно найти в разделе Unicode Input руководства.
Завершение путей работает для строк и режима оболочки Julia:
julia> path="/[TAB]"
.dockerenv .juliabox/ boot/ etc/ lib/ media/ opt/ root/ sbin/ sys/ usr/
.dockerinit bin/ dev/ home/ lib64/ mnt/ proc/ run/ srv/ tmp/ var/
shell> /[TAB]
.dockerenv .juliabox/ boot/ etc/ lib/ media/ opt/ root/ sbin/ sys/ usr/
.dockerinit bin/ dev/ home/ lib64/ mnt/ proc/ run/ srv/ tmp/ var/
Ключи словаря также могут быть завершены с помощью табуляции:
julia> foo = Dict("qwer1"=>1, "qwer2"=>2, "asdf"=>3)
Dict{String,Int64} with 3 entries:
"qwer2" => 2
"asdf" => 3
"qwer1" => 1
julia> foo["q[TAB]
"qwer1" "qwer2"
julia> foo["qwer
Автозаполнение также может помочь в заполнении полей:
julia> x = 3 + 4im;
julia> x.[TAB][TAB]
im re
julia> import UUIDs
julia> UUIDs.uuid[TAB][TAB]
uuid1 uuid4 uuid5 uuid_version
Поля для вывода из функций также могут быть заполнены:
julia> split("","")[1].[TAB]
lastindex offset string
Заполнение полей для вывода из функций использует вывод типов, и оно может предлагать поля только в том случае, если функция является типобезопасной.
Автозавершение может помочь в исследовании доступных методов, соответствующих входным аргументам:
julia> max([TAB] # All methods are displayed, not shown here due to size of the list
julia> max([1, 2], [TAB] # All methods where `Vector{Int}` matches as first argument
max(x, y) in Base at operators.jl:215
max(a, b, c, xs...) in Base at operators.jl:281
julia> max([1, 2], max(1, 2), [TAB] # All methods matching the arguments.
max(x, y) in Base at operators.jl:215
max(a, b, c, xs...) in Base at operators.jl:281
Ключевые слова также отображаются в предлагаемых методах после ;
, см. строку ниже, где limit
и keepempty
являются аргументами ключевых слов:
julia> split("1 1 1", [TAB]
split(str::AbstractString; limit, keepempty) in Base at strings/util.jl:302
split(str::T, splitter; limit, keepempty) where T<:AbstractString in Base at strings/util.jl:277
Завершение методов использует вывод типов и, следовательно, может определить, соответствуют ли аргументы, даже если аргументы являются результатом функций. Функция должна быть типостабильной, чтобы завершение могло удалить несоответствующие методы.
Если вы хотите узнать, какие методы можно использовать с определенными типами аргументов, используйте ?
в качестве имени функции. Это показывает пример поиска функций в InteractiveUtils, которые принимают одну строку:
julia> InteractiveUtils.?("somefile")[TAB]
edit(path::AbstractString) in InteractiveUtils at InteractiveUtils/src/editless.jl:197
less(file::AbstractString) in InteractiveUtils at InteractiveUtils/src/editless.jl:266
Этот список методов в модуле InteractiveUtils
, которые можно вызывать на строке. По умолчанию это исключает методы, где все аргументы имеют тип Any
, но вы также можете увидеть их, удерживая SHIFT-TAB вместо TAB:
julia> InteractiveUtils.?("somefile")[SHIFT-TAB]
apropos(string) in REPL at REPL/src/docview.jl:796
clipboard(x) in InteractiveUtils at InteractiveUtils/src/clipboard.jl:64
code_llvm(f) in InteractiveUtils at InteractiveUtils/src/codeview.jl:221
code_native(f) in InteractiveUtils at InteractiveUtils/src/codeview.jl:243
edit(path::AbstractString) in InteractiveUtils at InteractiveUtils/src/editless.jl:197
edit(f) in InteractiveUtils at InteractiveUtils/src/editless.jl:225
eval(x) in InteractiveUtils at InteractiveUtils/src/InteractiveUtils.jl:3
include(x) in InteractiveUtils at InteractiveUtils/src/InteractiveUtils.jl:3
less(file::AbstractString) in InteractiveUtils at InteractiveUtils/src/editless.jl:266
less(f) in InteractiveUtils at InteractiveUtils/src/editless.jl:274
report_bug(kind) in InteractiveUtils at InteractiveUtils/src/InteractiveUtils.jl:391
separate_kwargs(args...; kwargs...) in InteractiveUtils at InteractiveUtils/src/macros.jl:7
Вы также можете использовать ?("somefile")[TAB]
и просмотреть все модули, но списки методов могут быть длинными.
Пропуская закрывающую скобку, вы можете включать функции, которые могут требовать дополнительных аргументов:
julia> using Mmap
help?> Mmap.?("file",[TAB]
Mmap.Anonymous(name::String, readonly::Bool, create::Bool) in Mmap at Mmap/src/Mmap.jl:16
mmap(file::AbstractString) in Mmap at Mmap/src/Mmap.jl:245
mmap(file::AbstractString, ::Type{T}) where T<:Array in Mmap at Mmap/src/Mmap.jl:245
mmap(file::AbstractString, ::Type{T}, dims::Tuple{Vararg{Integer, N}}) where {T<:Array, N} in Mmap at Mmap/src/Mmap.jl:245
mmap(file::AbstractString, ::Type{T}, dims::Tuple{Vararg{Integer, N}}, offset::Integer; grow, shared) where {T<:Array, N} in Mmap at Mmap/src/Mmap.jl:245
mmap(file::AbstractString, ::Type{T}, len::Integer) where T<:Array in Mmap at Mmap/src/Mmap.jl:251
mmap(file::AbstractString, ::Type{T}, len::Integer, offset::Integer; grow, shared) where T<:Array in Mmap at Mmap/src/Mmap.jl:251
mmap(file::AbstractString, ::Type{T}, dims::Tuple{Vararg{Integer, N}}) where {T<:BitArray, N} in Mmap at Mmap/src/Mmap.jl:316
mmap(file::AbstractString, ::Type{T}, dims::Tuple{Vararg{Integer, N}}, offset::Integer; grow, shared) where {T<:BitArray, N} in Mmap at Mmap/src/Mmap.jl:316
mmap(file::AbstractString, ::Type{T}, len::Integer) where T<:BitArray in Mmap at Mmap/src/Mmap.jl:322
mmap(file::AbstractString, ::Type{T}, len::Integer, offset::Integer; grow, shared) where T<:BitArray in Mmap at Mmap/src/Mmap.jl:322
Customizing Colors
Цвета, используемые Julia и REPL, также можно настроить. Чтобы изменить цвет подсказки Julia, вы можете добавить что-то вроде следующего в ваш ~/.julia/config/startup.jl
файл, который должен находиться в вашей домашней директории:
function customize_colors(repl)
repl.prompt_color = Base.text_colors[:cyan]
end
atreplinit(customize_colors)
Доступные цветовые ключи можно увидеть, введя Base.text_colors
в режиме помощи REPL. Кроме того, целые числа от 0 до 255 могут использоваться в качестве цветовых ключей для терминалов с поддержкой 256 цветов.
Вы также можете изменить цвета для подсказок помощи и оболочки, а также для текста ввода и ответа, установив соответствующее поле repl
в функции customize_colors
выше (соответственно, help_color
, shell_color
, input_color
и answer_color
). Для последних двух убедитесь, что поле envcolors
также установлено в false.
Также возможно применить форматирование жирным шрифтом, используя Base.text_colors[:bold]
в качестве цвета. Например, чтобы напечатать ответы жирным шрифтом, можно использовать следующее в ~/.julia/config/startup.jl
:
function customize_colors(repl)
repl.envcolors = false
repl.answer_color = Base.text_colors[:bold]
end
atreplinit(customize_colors)
Вы также можете настроить цвет, используемый для отображения предупреждающих и информационных сообщений, установив соответствующие переменные окружения. Например, чтобы отображать сообщения об ошибках, предупреждениях и информационные сообщения соответственно в мадженте, желтом и циане, вы можете добавить следующее в ваш ~/.julia/config/startup.jl
файл:
ENV["JULIA_ERROR_COLOR"] = :magenta
ENV["JULIA_WARN_COLOR"] = :yellow
ENV["JULIA_INFO_COLOR"] = :cyan
Changing the contextual module which is active at the REPL
При вводе выражений в REPL они по умолчанию оцениваются в модуле Main
;
julia> @__MODULE__
Main
Можно изменить этот контекстный модуль с помощью функции REPL.activate(m)
, где m
— это Module
, или введя модуль в REPL и нажав сочетание клавиш Alt-m, когда курсор находится на имени модуля (Esc-m на MacOS). Нажатие сочетания клавиш в пустом приглашении переключает контекст между ранее активным не-Main
модулем и Main
. Активный модуль отображается в приглашении (если это не Main
):
julia> using REPL
julia> REPL.activate(Base)
(Base) julia> @__MODULE__
Base
(Base) julia> using REPL # Need to load REPL into Base module to use it
(Base) julia> REPL.activate(Main)
julia>
julia> Core<Alt-m> # using the keybinding to change module
(Core) julia>
(Core) julia> <Alt-m> # going back to Main via keybinding
julia>
julia> <Alt-m> # going back to previously-active Core via keybinding
(Core) julia>
Функции, которые принимают необязательный аргумент модуля, часто по умолчанию используют модуль контекста REPL. Например, вызов varinfo()
покажет переменные текущего активного модуля:
julia> module CustomMod
export var, f
var = 1
f(x) = x^2
end;
julia> REPL.activate(CustomMod)
(Main.CustomMod) julia> varinfo()
name size summary
––––––––– ––––––– ––––––––––––––––––––––––––––––––––
CustomMod Module
f 0 bytes f (generic function with 1 method)
var 8 bytes Int64
Numbered prompt
Возможно получить интерфейс, который похож на IPython REPL и блокнот Mathematica с пронумерованными подсказками ввода и префиксами вывода. Это делается с помощью вызова REPL.numbered_prompt!()
. Если вы хотите, чтобы это было включено при запуске, добавьте
atreplinit() do repl
@eval import REPL
if !isdefined(repl, :interface)
repl.interface = REPL.setup_interface(repl)
end
REPL.numbered_prompt!(repl)
end
в ваш файл startup.jl
. В пронумерованном запросе переменная Out[n]
(где n
— целое число) может быть использована для ссылки на предыдущие результаты:
In [1]: 5 + 3
Out[1]: 8
In [2]: Out[1] + 5
Out[2]: 13
In [3]: Out
Out[3]: Dict{Int64, Any} with 2 entries:
2 => 13
1 => 8
Поскольку все выводы из предыдущих оценок REPL сохраняются в переменной Out
, следует быть осторожным, если вы возвращаете много больших объектов в памяти, таких как массивы, так как они будут защищены от сборки мусора, пока существует ссылка на них в Out
. Если вам нужно удалить ссылки на объекты в Out
, вы можете очистить всю историю, которую она хранит, с помощью empty!(Out)
, или очистить отдельную запись с помощью Out[n] = nothing
.
TerminalMenus
TerminalMenus является подсистемой Julia REPL и позволяет создавать небольшие, ненавязчивые интерактивные меню в терминале.
Examples
import REPL
using REPL.TerminalMenus
options = ["apple", "orange", "grape", "strawberry",
"blueberry", "peach", "lemon", "lime"]
RadioMenu
RadioMenu позволяет пользователю выбрать один вариант из списка. Функция request
отображает интерактивное меню и возвращает индекс выбранного варианта. Если пользователь нажимает 'q' или ctrl-c
, request
вернет -1
.
# `pagesize` is the number of items to be displayed at a time.
# The UI will scroll if the number of options is greater
# than the `pagesize`
menu = RadioMenu(options, pagesize=4)
# `request` displays the menu and returns the index after the
# user has selected a choice
choice = request("Choose your favorite fruit:", menu)
if choice != -1
println("Your favorite fruit is ", options[choice], "!")
else
println("Menu canceled.")
end
Пожалуйста, вставьте текст или содержимое Markdown, которое вы хотите перевести.
Choose your favorite fruit:
^ grape
strawberry
> blueberry
v peach
Your favorite fruit is blueberry!
MultiSelectMenu
MultiSelectMenu позволяет пользователям выбирать несколько вариантов из списка.
# here we use the default `pagesize` 10
menu = MultiSelectMenu(options)
# `request` returns a `Set` of selected indices
# if the menu us canceled (ctrl-c or q), return an empty set
choices = request("Select the fruits you like:", menu)
if length(choices) > 0
println("You like the following fruits:")
for i in choices
println(" - ", options[i])
end
else
println("Menu canceled.")
end
Пожалуйста, вставьте текст или содержимое Markdown, которое вы хотите перевести.
Select the fruits you like:
[press: Enter=toggle, a=all, n=none, d=done, q=abort]
[ ] apple
> [X] orange
[X] grape
[ ] strawberry
[ ] blueberry
[X] peach
[ ] lemon
[ ] lime
You like the following fruits:
- orange
- grape
- peach
Customization / Configuration
ConfiguredMenu subtypes
Начиная с Julia 1.6, рекомендуемый способ настройки меню — это использование конструктора. Например, меню с множественным выбором по умолчанию
julia> menu = MultiSelectMenu(options, pagesize=5);
julia> request(menu) # ASCII is used by default
[press: Enter=toggle, a=all, n=none, d=done, q=abort]
[ ] apple
[X] orange
[ ] grape
> [X] strawberry
v [ ] blueberry
может быть отображен с помощью символов выбора и навигации Unicode с
julia> menu = MultiSelectMenu(options, pagesize=5, charset=:unicode);
julia> request(menu)
[press: Enter=toggle, a=all, n=none, d=done, q=abort]
⬚ apple
✓ orange
⬚ grape
→ ✓ strawberry
↓ ⬚ blueberry
Также возможна более детальная настройка:
julia> menu = MultiSelectMenu(options, pagesize=5, charset=:unicode, checked="YEP!", unchecked="NOPE", cursor='⧐');
julia> request(menu)
julia> request(menu)
[press: Enter=toggle, a=all, n=none, d=done, q=abort]
NOPE apple
YEP! orange
NOPE grape
⧐ YEP! strawberry
↓ NOPE blueberry
Помимо общей опции charset
, для RadioMenu
настраиваемые опции следующие:
cursor::Char='>'|'→'
: символ, который использовать для курсораup_arrow::Char='^'|'↑'
: символ, который используется для стрелки вверхdown_arrow::Char='v'|'↓'
: символ, который используется для стрелки внизupdown_arrow::Char='I'|'↕'
: символ, который используется для стрелки вверх/вниз на одностраничном сайтеscroll_wrap::Bool=false
: опционально обернуть в начале/конце менюctrl_c_interrupt::Bool=true
: Еслиfalse
, вернуть пустое при ^C, еслиtrue
, выбросить InterruptException() при ^C
MultiSelectMenu
добавляет:
checked::String="[X]"|"✓"
: строка для использования для отмеченногоunchecked::String="[ ]"|"⬚")
: строка для использования для неотмеченных
Вы можете создавать новые типы меню на свой вкус. Типы, производные от TerminalMenus.ConfiguredMenu
, настраивают параметры меню во время его создания.
Legacy interface
Перед Julia 1.6, и все еще поддерживаемый на протяжении Julia 1.x, можно также настраивать меню, вызывая TerminalMenus.config()
.
References
REPL
Base.atreplinit
— Functionatreplinit(f)
Зарегистрируйте функцию с одним аргументом, которая будет вызываться перед инициализацией интерфейса REPL в интерактивных сессиях; это полезно для настройки интерфейса. Аргументом f
является объект REPL. Эта функция должна вызываться из файла инициализации .julia/config/startup.jl
.
TerminalMenus
Menus
REPL.TerminalMenus.RadioMenu
— TypeRadioMenu
Меню, которое позволяет пользователю выбрать один вариант из списка.
Пример вывода
julia> request(RadioMenu(options, pagesize=4))
Выберите свой любимый фрукт:
^ виноград
клубника
> черника
v персик
Ваш любимый фрукт - черника!
REPL.TerminalMenus.MultiSelectMenu
— TypeMultiSelectMenu
Меню, которое позволяет пользователю выбирать несколько вариантов из списка.
Пример вывода
julia> request(MultiSelectMenu(options))
Выберите фрукты, которые вам нравятся:
[нажмите: Enter=переключить, a=все, n=ничего, d=готово, q=отменить]
[ ] яблоко
> [X] апельсин
[X] виноград
[ ] клубника
[ ] черника
[X] персик
[ ] лимон
[ ] лайм
Вам нравятся следующие фрукты:
- апельсин
- виноград
- персик
Configuration
REPL.TerminalMenus.Config
— TypeConfig(; scroll_wrap=false, ctrl_c_interrupt=true, charset=:ascii, cursor::Char, up_arrow::Char, down_arrow::Char)
Настройте поведение для меню выбора с помощью аргументов ключевых слов:
scroll_wrap
, еслиtrue
, заставляет меню оборачиваться, когда прокручивается выше первой или ниже последней записиctrl_c_interrupt
, еслиtrue
, вызываетInterruptException
, если пользователь нажимает Ctrl-C во время выбора меню. Еслиfalse
,TerminalMenus.request
вернет значение по умолчанию изTerminalMenus.selected
.charset
влияет на значения по умолчанию дляcursor
,up_arrow
иdown_arrow
, и может быть:ascii
или:unicode
cursor
— это символ, который печатается, чтобы указать на вариант, который будет выбран нажатием "Enter". Значения по умолчанию — '>' или '→', в зависимости отcharset
.up_arrow
— это символ, который печатается, когда отображение не включает первую запись. Значения по умолчанию — '^' или '↑', в зависимости отcharset
.down_arrow
— это символ, который печатается, когда отображение не включает последнюю запись. Значения по умолчанию — 'v' или '↓', в зависимости отcharset
.
Подтипы ConfiguredMenu
будут автоматически печатать cursor
, up_arrow
и down_arrow
по мере необходимости, ваш метод writeline
не должен их печатать.
Config
доступен начиная с Julia 1.6. В более старых версиях используйте глобальный CONFIG
.
REPL.TerminalMenus.MultiSelectConfig
— TypeMultiSelectConfig(; charset=:ascii, checked::String, unchecked::String, kwargs...)
Настройте поведение для меню множественного выбора с помощью именованных аргументов:
checked
— это строка, которая будет напечатана, когда опция выбрана. Значения по умолчанию — "[X]" или "✓", в зависимости отcharset
.unchecked
— это строка, которая будет напечатана, когда опция не выбрана. Значения по умолчанию — "[ ]" или "⬚", в зависимости отcharset
.
Все остальные именованные аргументы описаны для TerminalMenus.Config
. checked
и unchecked
не печатаются автоматически и должны быть напечатаны вашим методом writeline
.
MultiSelectConfig
доступен начиная с Julia 1.6. В более старых версиях используйте глобальный CONFIG
.
REPL.TerminalMenus.config
— Functionconfig( <see arguments> )
Функция только с ключевыми словами для настройки глобальных параметров меню
Аргументы
charset::Symbol=:na
: символы интерфейса для использования (:ascii
или:unicode
); переопределяется другими аргументамиcursor::Char='>'|'→'
: символ, используемый для курсораup_arrow::Char='^'|'↑'
: символ, используемый для стрелки вверхdown_arrow::Char='v'|'↓'
: символ, используемый для стрелки внизchecked::String="[X]"|"✓"
: строка, используемая для отмеченногоunchecked::String="[ ]"|"⬚")
: строка, используемая для неотмеченногоscroll::Symbol=:nowrap
: Если:wrap
, курсор оборачивается сверху и снизу, если:nowrap
, курсор не оборачиваетсяsupress_output::Bool=false
: Игнорируемый устаревший аргумент, передавайтеsuppress_output
как аргумент ключевого слова вrequest
.ctrl_c_interrupt::Bool=true
: Еслиfalse
, возвращает пустое значение при ^C, еслиtrue
, выбрасывает InterruptException() при ^C
Начиная с Julia 1.6, config
устарел. Используйте Config
или MultiSelectConfig
вместо.
User interaction
REPL.TerminalMenus.request
— Functionrequest(m::AbstractMenu; cursor=1)
Отобразите меню и войдите в интерактивный режим. cursor
указывает номер элемента, используемого для начального положения курсора. cursor
может быть либо Int
, либо RefValue{Int}
. Последний полезен для наблюдения и управления положением курсора снаружи.
Возвращает selected(m)
.
Аргумент cursor
требует Julia 1.6 или более поздней версии.
request([term,] msg::AbstractString, m::AbstractMenu)
Сокращение для println(msg); request(m)
.
AbstractMenu extension interface
Любой подтип AbstractMenu
должен быть изменяемым и должен содержать поля pagesize::Int
и pageoffset::Int
. Любой подтип также должен реализовать следующие функции:
REPL.TerminalMenus.pick
— Functionpick(m::AbstractMenu, cursor::Int)
Определяет, что происходит, когда пользователь нажимает клавишу Enter, пока меню открыто. Если возвращается true
, request()
завершится. cursor
индексирует позицию выбора.
REPL.TerminalMenus.cancel
— Functioncancel(m::AbstractMenu)
Определите, что происходит, когда пользователь отменяет меню ('q' или ctrl-c). request()
всегда завершится после вызова этой функции.
REPL.TerminalMenus.writeline
— Functionwriteline(buf::IO, m::AbstractMenu, idx::Int, iscursor::Bool)
Запишите опцию по индексу idx
в buf
. iscursor
, если true
, указывает на то, что этот элемент находится в текущей позиции курсора (той, которая будет выбрана при нажатии "Enter").
Если m
является ConfiguredMenu
, TerminalMenus
выведет индикатор курсора. В противном случае ожидается, что вызывающая сторона обработает такую печать.
writeline
требует Julia 1.6 или выше.
В более старых версиях Julia это было writeLine(buf::IO, m::AbstractMenu, idx, iscursor::Bool)
, и предполагается, что m
не настроен. Индикаторы выбора и курсора можно получить из TerminalMenus.CONFIG
.
Эта старая функция поддерживается во всех версиях Julia 1.x, но будет удалена в Julia 2.0.
Он также должен реализовывать либо options
, либо numoptions
:
REPL.TerminalMenus.options
— Functionoptions(m::AbstractMenu)
Вернуть список строк, которые будут отображаться как варианты на текущей странице.
В качестве альтернативы, реализуйте numoptions
, в этом случае options
не требуется.
REPL.TerminalMenus.numoptions
— Functionnumoptions(m::AbstractMenu) -> Int
Возвращает количество опций в меню m
. По умолчанию равно length(options(m))
.
Эта функция требует Julia 1.6 или более поздней версии.
Если подтип не имеет поля с именем selected
, он также должен реализовать
REPL.TerminalMenus.selected
— Functionselected(m::AbstractMenu)
Возвращает информацию о выбранном пользователем варианте. По умолчанию возвращает m.selected
.
Следующие элементы являются необязательными, но могут позволить дополнительную настройку:
REPL.TerminalMenus.header
— Functionheader(m::AbstractMenu) -> String
Возвращает строку заголовка, которая будет напечатана над меню. По умолчанию "".
REPL.TerminalMenus.keypress
— Functionkeypress(m::AbstractMenu, i::UInt32) -> Bool
Обрабатывает любое нестандартное событие нажатия клавиши. Если возвращается true
, TerminalMenus.request
завершится. По умолчанию false
.