Interactive Utilities

InteractiveUtils モジュールは、コードのイントロスペクションやクリップボードへのアクセスなど、Juliaを対話的に使用するためのユーティリティを提供します。対話的な作業を目的としており、interactive mode では自動的に読み込まれます。

Base.Docs.apropos — Function
apropos([io::IO=stdout], pattern::Union{AbstractString,Regex})

利用可能なdocstringのうち、patternを含む項目を検索します。

patternが文字列の場合、大文字と小文字は区別されません。検索結果はioに出力されます。

aproposは、クエリを二重引用符で囲めば、REPLのヘルプモードから呼び出せます。

help?> "pattern"
Julia 1.11

Julia 1.11以降では、aproposを使う前に、REPL標準ライブラリを読み込む必要があります。

source
InteractiveUtils.varinfo — Function
varinfo(m::Module=Main, pattern::Regex=r""; all=false, imported=false, recursive=false, sortby::Symbol=:name, minsize::Int=0)

モジュール内の公開グローバル変数に関する情報を Markdown の表で返します。必要に応じて、pattern に一致するものだけに絞り込めます。

メモリ消費量の推定値は、オブジェクトの内部構造のサイズのおおよその下限です。

  • all : モジュール内で定義された非公開オブジェクト、非推奨のオブジェクト、コンパイラが生成したオブジェクトも一覧に含めます。
  • imported : 他のモジュールから明示的にインポートされたオブジェクトも一覧に含めます。
  • recursive : サブモジュール内のオブジェクトも再帰的に含めます。各サブモジュールにも同じ設定が適用されます。
  • sortby : 結果の並べ替えに使う列です。指定できる値は :name(デフォルト)、:size、:summary です。
  • minsize : サイズが minsize バイト以上のオブジェクトだけを含めます。デフォルトは 0 です。

varinfo の出力は、表示のみを目的としています。より汎用的な操作に適した、モジュール内で定義されたシンボルの配列を取得するには、names も参照してください。

source
InteractiveUtils.versioninfo — Function
versioninfo(io::IO=stdout; verbose::Bool=false)

使用中の Julia のバージョン情報を表示します。出力内容は、次のブール値キーワード引数で制御できます。

  • verbose: 追加情報をすべて表示します
Warning

この関数の出力には、機密情報が含まれる場合があります。出力を共有する前に内容を確認し、公開すべきでないデータを削除してください。

関連項目: VERSION。

source
InteractiveUtils.methodswith — Function
methodswith(typ[, module or function]; supertypes::Bool=false)

typ型の引数を持つメソッドの配列を返します。

省略可能な第2引数を指定すると、検索対象を特定のモジュールまたは関数に限定できます(デフォルトでは、すべてのトップレベルモジュールが対象です)。

キーワード引数supertypesがtrueの場合、親型がtypである引数も返します。ただし、型がAnyのものは除外されます。

関連項目: methods。

source
InteractiveUtils.subtypes — Function
subtypes(T::DataType)

DataType T の直接のサブタイプの一覧を返します。現在ロードされているサブタイプはすべて含まれ、現在のモジュールから見えないものも含まれます。

関連項目: supertype、supertypes、methodswith。

Examples

julia> subtypes(Integer)
3-element Vector{Any}:
 Bool
 Signed
 Unsigned
source
InteractiveUtils.supertypes — Function
supertypes(T::Type)

(T, ..., Any) を返します。これは、T と、そのすべてのスーパータイプを、supertype 関数を順次呼び出して求めたものです。<: の順に並び、Any で終わります。

subtypes も参照してください。

Examples

julia> supertypes(Int)
(Int64, Signed, Integer, Real, Number, Any)
source
InteractiveUtils.edit — Method
edit(path::AbstractString, line::Integer=0, column::Integer=0)

ファイルまたはディレクトリを編集します。ファイルを編集する場合は、行番号を指定することもできます。エディターを終了すると、julia プロンプトに戻ります。環境変数 JULIA_EDITOR、VISUAL、または EDITOR を設定すると、使用するエディターを変更できます。

Julia 1.9

column 引数を使用するには、Julia 1.9 以降が必要です。

関連項目: InteractiveUtils.define_editor。

source
InteractiveUtils.edit — Method
edit(function, [types])
edit(module)

関数の定義を編集します。必要に応じて型のタプルを指定すると、編集するメソッドを選択できます。モジュールの場合は、メインのソースファイルを開きます。まず、モジュールを using または import で読み込んでおく必要があります。

Julia 1.1

モジュールに対する edit の使用には、Julia 1.1 以降が必要です。

指定した行でファイルを開けるようにするには、事前に InteractiveUtils.define_editor を呼び出す必要がある場合があります。

source
InteractiveUtils.@edit — Macro
@edit

関数またはマクロ呼び出しの引数を評価して型を判定し、その結果得られた式に対してedit関数を呼び出します。

関連項目: @less、@which。

source
InteractiveUtils.define_editor — Function
define_editor(fn, pattern; wait=false)

patternに対応する新しいエディターを定義すると、fnを使って、ファイルを開けるようになります(行番号の指定も可能です)。

fn引数には、指定したエディターでファイルを開く方法を決める関数を指定します。この関数は、次の4つの引数を受け取ります。

  • cmd - エディターのベースとなるコマンドオブジェクト
  • path - 開くソースファイルのパス
  • line - エディターを開く行番号
  • column - エディターを開く列番号

コマンドで特定の行や列を指定して開けないエディターでは、line引数やcolumn引数を無視してもかまいません。fnコールバックは、ファイルを開くための適切なCmdオブジェクトを返すか、そのファイルを編集できないことを示すnothingを返す必要があります。このエディターが現在の環境に適さず、別のエディターを試すべき場合は、nothingを使ってください。外部コマンドを起動する必要のない、より汎用的な編集フックを追加するには、コールバックをベクターEDITOR_CALLBACKSに直接追加します。

pattern引数には、文字列、正規表現、または文字列と正規表現の配列を指定します。fnが呼び出されるには、パターンのいずれかがEDITOR、VISUAL、またはJULIA_EDITORの値に一致する必要があります。文字列の場合、エディターコマンドの先頭の単語から拡張子(あれば)を除いたものが、basenameと一致する必要があります。たとえば、"vi"は"vim -g"には一致しませんが、"/usr/bin/vi -m"には一致します。また、vi.exeにも一致します。patternが正規表現の場合は、シェルエスケープされた文字列としてのエディターコマンド全体に対して照合されます。配列パターンは、その要素のいずれかが一致すれば一致します。複数のエディターが一致する場合は、最後に追加されたエディターが使われます。

デフォルトでは、juliaはエディターが閉じるのを待たず、バックグラウンドで実行します。ただし、エディターがターミナルベースの場合は、wait=trueを設定すると、エディターが閉じるまでjuliaは待機してから処理を再開します。

エディター環境変数のいずれかが設定されていても、それに一致するエディター項目がない場合は、デフォルトのエディター項目が呼び出されます。

(cmd, path, line, column) -> `$cmd $path`

なお、多くのエディターはすでに定義されています。次のコマンドは、いずれもそのまま使えるはずです。

  • emacs
  • emacsclient
  • vim
  • nvim
  • nano
  • micro
  • kak
  • helix
  • textmate
  • mate
  • kate
  • subl
  • atom
  • notepad++
  • Visual Studio Code
  • open
  • pycharm
  • bbedit

Examples

以下は、ターミナルベースのemacsの使い方を定義しています。

define_editor(
    r"\bemacs\b.*\s(-nw|--no-window-system)\b", wait=true) do cmd, path, line
    `$cmd +$line $path`
end
Julia 1.4

define_editorはJulia 1.4で導入されました。

source
InteractiveUtils.less — Method
less(file::AbstractString, [line::Integer])

デフォルトのページャーでファイルを表示します。開始行番号を指定することもできます。ページャーを終了すると、julia プロンプトに戻ります。

source
InteractiveUtils.less — Method
less(function, [types])

デフォルトのページャーを使って関数の定義を表示します。必要に応じて型のタプルを指定し、表示するメソッドを選択できます。

source
InteractiveUtils.@which — Macro
@which

関数またはマクロの呼び出しに適用すると、指定された呼び出しの引数を評価し、その引数に対して呼び出されるメソッドの Method オブジェクトを返します。変数に適用すると、その変数が束縛されたモジュールを返します。which 関数を呼び出します。

関連項目: @less、@edit。

source
InteractiveUtils.@functionloc — Macro
@functionloc

関数またはマクロの呼び出しに適用すると、指定した呼び出しの引数を評価し、その引数に対して呼び出されるメソッドの場所を示すタプル (filename,line) を返します。functionloc 関数を呼び出します。

source
InteractiveUtils.code_warntype — Function
code_warntype([io::IO], f, types; debuginfo=:default)

指定されたジェネリック関数と型シグネチャに一致するメソッドについて、低レベル化されたASTと型推論後のASTを、io(デフォルトはstdout)に出力します。ASTには、パフォーマンス上問題となる可能性のある非具象型が目立つように注釈が付けられます(色を表示できる場合は赤色)。これにより、型が不安定である可能性を警告します。

非具象型がすべてパフォーマンス上の問題になるわけではありません。また、特定の型のパフォーマンス特性は、コンパイラの実装詳細です。code_warntypeは、パフォーマンス上の懸念となる可能性があれば型を赤色で表示する方針を取るため、実際にはパフォーマンスに影響しない型も赤色で表示されることがあります。具象型の小さなユニオンは通常問題にならないため、黄色で強調表示されます。

キーワード引数debuginfoには、コードコメントの詳細度を指定する:source、:none、:defaultのいずれかを指定できます。ユーザーがBase.IRShow.default_debuginfo[]を変更しない限り、:defaultは:sourceと同じです。

詳しくは、マニュアルの「パフォーマンスのヒント」ページにある@code_warntypeのセクションを参照してください。

関連項目:@code_warntype、code_typed、code_lowered、code_llvm、code_native。

source
InteractiveUtils.code_llvm — Function
code_llvm([io=stdout,], f, types; raw=false, dump_module=false, optimize=true, debuginfo=:default)

指定されたジェネリック関数と型シグネチャに一致するメソッドを実行するために生成された LLVM ビットコードを、io に出力します。

optimize キーワードが設定されていない場合、LLVM の最適化前のコードが表示されます。出力されるビットコードからは、すべてのメタデータと dbg.* 呼び出しが削除されます。完全な IR を表示するには、raw キーワードを true に設定します。関数を含むモジュール全体(宣言を含む)をダンプするには、dump_module キーワードを true に設定します。キーワード引数 debuginfo には、コードコメントの詳細度を指定するため、source(デフォルト)または none を指定できます。

関連項目: @code_llvm、code_warntype、code_typed、code_lowered、code_native。

source
InteractiveUtils.@code_llvm — Macro
@code_llvm

関数またはマクロ呼び出しの引数を評価して型を判定し、その結果の式に対して code_llvm を呼び出します。省略可能なキーワード引数 raw、dump_module、debuginfo、optimize は、次のように関数呼び出しの前に値とともに指定します。

@code_llvm raw=true dump_module=true debuginfo=:default f(x)
@code_llvm optimize=false f(x)

optimize は、インライン化などの追加の最適化も適用するかどうかを制御します。raw を指定すると、すべてのメタデータと dbg.* 呼び出しが表示されます。debuginfo には :source(デフォルト)または :none を指定でき、コードコメントの詳細度を設定します。dump_module は、関数を含むモジュール全体を出力します。

関連項目: code_llvm、@code_warntype、@code_typed、@code_lowered、@code_native。

source
InteractiveUtils.code_native — Function
code_native([io=stdout,], f, types; syntax=:intel, debuginfo=:default, binary=false, dump_module=true, raw=false)

指定されたジェネリック関数と型シグネチャに一致するメソッドを実行するために生成された、ネイティブのアセンブリ命令を io に出力します。

  • syntax を :intel(デフォルト)に設定すると Intel 構文に、:att に設定すると AT&T 構文になります。
  • debuginfo を :source(:default と同等)または :none に設定して、コードコメントの詳細度を指定します。
  • binary が true の場合、各命令のバイナリマシンコードも、短縮アドレスを先頭に付けて出力します。
  • dump_module が false の場合、rodata やディレクティブなどのメタデータは出力しません。
  • raw が false(デフォルト)の場合、セーフポイント関数のプロローグなど、重要でない命令は省略されます。

関連項目: @code_native、code_warntype、code_typed、code_lowered、code_llvm。

source
InteractiveUtils.@code_native — Macro
@code_native

関数またはマクロ呼び出しの引数を評価して型を判定し、その結果の式に対してcode_nativeを呼び出します。

省略可能なキーワード引数syntax、debuginfo、binary、dump_moduleのいずれかを設定するには、次のように関数呼び出しの前に指定します。

@code_native syntax=:intel debuginfo=:default binary=true dump_module=false f(x)
  • アセンブリ構文を指定するには、syntaxを設定します。:intel(デフォルト)はIntel構文、:attはAT&T構文です。
  • コードコメントの詳細度を指定するには、debuginfoを:source(デフォルト)または:noneに設定します。
  • binaryがtrueの場合、各命令のバイナリ機械語コードも、短縮アドレスを先頭に付けて出力します。
  • dump_moduleがfalseの場合、rodataやディレクティブなどのメタデータは出力しません。

関連項目:code_native、@code_warntype、@code_typed、@code_lowered、@code_llvm。

source
Base.@time_imports — Macro
@time_imports

式を実行し、パッケージとその依存関係のインポートにかかった時間をレポートするマクロです。コンパイル時間は割合で表示され、再コンパイルがあった場合は、その時間も示されます。

パッケージまたはパッケージ拡張ごとに1行ずつ表示されます。表示される時間は、そのパッケージ自体のインポートにかかった時間であり、依存関係の読み込み時間は含まれません。

Julia 1.9以降では、package extensions は「親 → 拡張」と表示されます。

Note

読み込み処理では、パッケージは直接の依存関係だけでなく、すべての依存関係を順番にインポートします。

julia> @time_imports using CSV
     50.7 ms  Parsers 17.52% compilation time
      0.2 ms  DataValueInterfaces
      1.6 ms  DataAPI
      0.1 ms  IteratorInterfaceExtensions
      0.1 ms  TableTraits
     17.5 ms  Tables
     26.8 ms  PooledArrays
    193.7 ms  SentinelArrays 75.12% compilation time
      8.6 ms  InlineStrings
     20.3 ms  WeakRefStrings
      2.0 ms  TranscodingStreams
      1.4 ms  Zlib_jll
      1.8 ms  CodecZlib
      0.8 ms  Compat
     13.1 ms  FilePathsBase 28.39% compilation time
   1681.2 ms  CSV 92.40% compilation time
Julia 1.8

このマクロを使用するには、Julia 1.8以降が必要です。

source
Base.@trace_compile — Macro
@trace_compile

式を実行し、コンパイルされたメソッド(再コンパイルされたメソッドは黄色で表示)を表示するマクロです。julia の引数 --trace-compile=stderr --trace-compile-timing と同様ですが、特定の呼び出しを対象とします。

julia> @trace_compile rand(2,2) * rand(2,2)
#=   39.1 ms =# precompile(Tuple{typeof(Base.rand), Int64, Int64})
#=  102.0 ms =# precompile(Tuple{typeof(Base.:(*)), Array{Float64, 2}, Array{Float64, 2}})
2×2 Matrix{Float64}:
 0.421704  0.864841
 0.211262  0.444366
Julia 1.12

このマクロを使用するには、Julia 1.12 以降が必要です。

source
Base.@trace_dispatch — Macro
@trace_dispatch

式を実行し、動的ディスパッチによってコンパイルされたメソッドを報告するマクロです。Julia の引数 --trace-dispatch=stderr と同様ですが、特に呼び出しを対象とします。

Julia 1.12

このマクロを使用するには、Julia 1.12 以降が必要です。

source
InteractiveUtils.clipboard — Function
clipboard(x)

x の印刷版をオペレーティングシステムのクリップボードに送信します(「コピー」)。

source
clipboard()::String

オペレーティングシステムのクリップボードの内容(「貼り付け」)を文字列として返します。

source