Filesystem

Base.read — Method
read(filename::AbstractString)

ファイルの内容全体をVector{UInt8}として読み込みます。

read(filename::AbstractString, String)

ファイルの内容全体を文字列として読み込みます。

read(filename::AbstractString, args...)

ファイルを開いて、その内容を読み込みます。argsはreadに渡されます。これはopen(io->read(io, args...), filename)と同等です。

source
Base.write — Method
write(filename::AbstractString, content)

content の正規バイナリ表現をファイルに書き込みます。ファイルが存在しない場合は新規作成し、存在する場合は上書きします。

ファイルに書き込んだバイト数を返します。

source
Base.Filesystem.pwd — Function
pwd()::String

現在の作業ディレクトリを取得します。

関連項目: cd、tempdir。

Examples

julia> pwd()
"/home/JuliaUser"

julia> cd("/home/JuliaUser/Projects/julia")

julia> pwd()
"/home/JuliaUser/Projects/julia"
source
Base.Filesystem.cd — Method
cd(dir::AbstractString=homedir())

現在の作業ディレクトリを設定します。

関連項目: pwd、mkdir、mkpath、mktempdir。

Examples

julia> cd("/home/JuliaUser/Projects/julia")

julia> pwd()
"/home/JuliaUser/Projects/julia"

julia> cd()

julia> pwd()
"/home/JuliaUser"
source
Base.Filesystem.cd — Method
cd(f::Function, dir::AbstractString=homedir())

現在の作業ディレクトリを一時的にdirに変更し、関数fを適用した後、元のディレクトリに戻ります。

Examples

julia> pwd()
"/home/JuliaUser"

julia> cd(readdir, "/home/JuliaUser/Projects/julia")
34-element Vector{String}:
 ".circleci"
 ".freebsdci.sh"
 ".git"
 ".gitattributes"
 ".github"
 ⋮
 "test"
 "ui"
 "usr"
 "usr-staging"

julia> pwd()
"/home/JuliaUser"
source
Base.Filesystem.readdir — Function
readdir(dir::AbstractString=pwd();
    join::Bool = false,
    sort::Bool = true,
)::Vector{String}

dir ディレクトリ内の名前を返します。ディレクトリが指定されていない場合は、現在の作業ディレクトリ内の名前を返します。join が false の場合、readdir はディレクトリ内の名前をそのまま返します。join が true の場合は、各 name に対して joinpath(dir, name) を返し、返される文字列はフルパスになります。絶対パスを取得するには、絶対パスのディレクトリを指定し、join を true にして readdir を呼び出します。

デフォルトでは、readdir は返す名前のリストをソートします。ソートを省略し、ファイルシステムが列挙する順序で名前を取得するには、readdir(dir, sort=false) を使ってソートを無効にします。

関連項目: walkdir。

Julia 1.4

join および sort キーワード引数を使用するには、Julia 1.4 以降が必要です。

Examples

julia> cd("/home/JuliaUser/dev/julia")

julia> readdir()
30-element Vector{String}:
 ".appveyor.yml"
 ".git"
 ".gitattributes"
 ⋮
 "ui"
 "usr"
 "usr-staging"

julia> readdir(join=true)
30-element Vector{String}:
 "/home/JuliaUser/dev/julia/.appveyor.yml"
 "/home/JuliaUser/dev/julia/.git"
 "/home/JuliaUser/dev/julia/.gitattributes"
 ⋮
 "/home/JuliaUser/dev/julia/ui"
 "/home/JuliaUser/dev/julia/usr"
 "/home/JuliaUser/dev/julia/usr-staging"

julia> readdir("base")
145-element Vector{String}:
 ".gitignore"
 "Base.jl"
 "Enums.jl"
 ⋮
 "version_git.sh"
 "views.jl"
 "weakkeydict.jl"

julia> readdir("base", join=true)
145-element Vector{String}:
 "base/.gitignore"
 "base/Base.jl"
 "base/Enums.jl"
 ⋮
 "base/version_git.sh"
 "base/views.jl"
 "base/weakkeydict.jl"

julia> readdir(abspath("base"), join=true)
145-element Vector{String}:
 "/home/JuliaUser/dev/julia/base/.gitignore"
 "/home/JuliaUser/dev/julia/base/Base.jl"
 "/home/JuliaUser/dev/julia/base/Enums.jl"
 ⋮
 "/home/JuliaUser/dev/julia/base/version_git.sh"
 "/home/JuliaUser/dev/julia/base/views.jl"
 "/home/JuliaUser/dev/julia/base/weakkeydict.jl"
source
Base.Filesystem.walkdir — Function
walkdir(dir = pwd(); topdown=true, follow_symlinks=false, onerror=throw)

ディレクトリのディレクトリツリーをたどるイテレータを返します。

このイテレータは、(path, dirs, files)を含むタプルを返します。反復のたびに、pathはツリー内の次のディレクトリに変わります。その後、dirsとfilesは、現在のpathディレクトリ内のディレクトリとファイルを含むベクターになります。ディレクトリツリーは、トップダウンまたはボトムアップでたどれます。walkdirまたはstatでIOErrorが発生した場合、デフォルトではエラーが再スローされます。onerrorキーワード引数で、独自のエラー処理関数を指定できます。onerrorには、引数としてIOErrorが渡されます。返されるイテレータは状態を保持するため、繰り返しアクセスすると、Iterators.Statefulのように、前回の続きから再開します。

関連項目: readdir。

Julia 1.12

Julia 1.12で、pwd()がデフォルトのディレクトリとして追加されました。

Examples

for (path, dirs, files) in walkdir(".")
    println("Directories in $path")
    for dir in dirs
        println(joinpath(path, dir)) # path to directories
    end
    println("Files in $path")
    for file in files
        println(joinpath(path, file)) # path to files
    end
end
julia> mkpath("my/test/dir");

julia> itr = walkdir("my");

julia> (path, dirs, files) = first(itr)
("my", ["test"], String[])

julia> (path, dirs, files) = first(itr)
("my/test", ["dir"], String[])

julia> (path, dirs, files) = first(itr)
("my/test/dir", String[], String[])
source
Base.Filesystem.mkdir — Function
mkdir(path::AbstractString; mode::Unsigned = 0o777)

新しいディレクトリを、名前を path、パーミッションを mode として作成します。mode のデフォルト値は 0o777 で、現在のファイル作成マスクによって変更されます。この関数が作成するディレクトリは1つだけです。ディレクトリがすでに存在する場合、または途中のディレクトリが存在しない場合、この関数はエラーをスローします。必要な中間ディレクトリをすべて作成する関数については、mkpath を参照してください。path を返します。

Examples

julia> mkdir("testingdir")
"testingdir"

julia> cd("testingdir")

julia> pwd()
"/home/JuliaUser/testingdir"
source
Base.Filesystem.mkpath — Function
mkpath(path::AbstractString; mode::Unsigned = 0o777)

必要に応じて、path 内のすべての中間ディレクトリを作成します。ディレクトリは mode の権限で作成されます。この権限はデフォルトで 0o777 であり、現在のファイル作成マスクによって変更されます。mkdir とは異なり、mkpath は、path(またはその一部)がすでに存在していてもエラーになりません。ただし、path(またはその一部)が既存のファイルを指している場合は、エラーが発生します。path を返します。

path にファイル名が含まれている場合は、ファイル名を使ってディレクトリを作成しないよう、mkpath(dirname(path)) を使用するとよいでしょう。

Examples

julia> cd(mktempdir())

julia> mkpath("my/test/dir") # creates three directories
"my/test/dir"

julia> readdir()
1-element Vector{String}:
 "my"

julia> cd("my")

julia> readdir()
1-element Vector{String}:
 "test"

julia> readdir("test")
1-element Vector{String}:
 "dir"

julia> mkpath("intermediate_dir/actually_a_directory.txt") # creates two directories
"intermediate_dir/actually_a_directory.txt"

julia> isdir("intermediate_dir/actually_a_directory.txt")
true

julia> mkpath("my/test/dir/") # returns the original `path`
"my/test/dir/"
source
Base.Filesystem.hardlink — Function
hardlink(src::AbstractString, dst::AbstractString)

既存のソースファイル src へのハードリンクを、dst という名前で作成します。リンク先の dst は存在していてはなりません。

関連項目: symlink。

Julia 1.8

このメソッドは Julia 1.8 で追加されました。

source
Base.Filesystem.symlink — Function
symlink(target::AbstractString, link::AbstractString; dir_target = false)

targetへのシンボリックリンクを、linkという名前で作成します。

Windowsでは、シンボリックリンクがディレクトリを指すかどうかを明示する必要があります。targetがすでに存在する場合、デフォルトではlinkの種類が自動判定されます。ただし、targetが存在しない場合、この関数はデフォルトでファイルへのシンボリックリンクを作成します。ただし、dir_targetがtrueに設定されている場合は除きます。ユーザーがdir_targetを設定していても、targetが存在し、それがファイルである場合、ディレクトリへのシンボリックリンクが作成されますが、リンク先をたどるとエラーになります。これは、ディレクトリを作成する前にdir_targetをfalseに設定してsymlink()を呼び出し、ファイルへのシンボリックリンクを作成してから、そのリンクをたどってディレクトリにアクセスしようとした場合と同様です。

また、Windowsでリンクを作成する方法には、シンボリックリンクとジャンクションポイントの2種類があります。ジャンクションポイントはやや効率的ですが、相対パスには対応していません。そのため、相対パスのディレクトリシンボリックリンクが要求された場合(isabspath(target)がfalseを返す場合)はシンボリックリンクが使われ、それ以外の場合はジャンクションポイントが使われます。Windowsでシンボリックリンクを作成する際は、参照先のファイルやディレクトリを作成してからリンクを作成するのがベストプラクティスです。

関連項目: hardlink。

Note

Windows XPなど、ソフトシンボリックリンクに対応していないオペレーティングシステムでは、この関数はエラーを発生させます。

Julia 1.6

dir_targetキーワード引数はJulia 1.6で追加されました。それ以前は、Windowsでは存在しないパスへのシンボリックリンクは常にファイルへのリンクとなり、ディレクトリへの相対シンボリックリンクには対応していませんでした。

source
Base.Filesystem.readlink — Function
readlink(path::AbstractString)::String

シンボリックリンク path が指す対象の場所を返します。

source
Base.Filesystem.chmod — Function
chmod(path::AbstractString, mode::Integer; recursive::Bool=false)

path のパーミッションモードを mode に変更します。現在サポートされているのは整数の mode(例: 0o777)のみです。recursive=true が指定され、パスがディレクトリの場合、そのディレクトリ内のすべてのパーミッションが再帰的に変更されます。path を返します。

Note

Julia 1.6 より前のバージョンでは、Windows のファイルシステム ACL を正しく操作できず、ファイルの読み取り専用ビットを設定するだけでした。現在は ACL を操作できます。

source
Base.Filesystem.chown — Function
chown(path::AbstractString, owner::Integer, group::Integer=-1)

path の所有者やグループを、owner や group に変更します。owner または group に入力した値が -1 の場合、対応する ID は変更されません。現在サポートされているのは、整数の owner と group のみです。path を返します。

source
Base.Libc.RawFD — Type
RawFD

OS のネイティブなファイルディスクリプターをラップするプリミティブ型です。RawFD は、基になるファイルの情報を取得する stat のようなメソッドに渡せます。また、ストリームを開く際にも使用でき、そのストリームの基盤となる OS ファイルを RawFD が表します。

source
Base.stat — Function
stat(path)
stat(path_elements...)

ファイルに関する情報を含む構造体を返します。引数が複数指定された場合は、joinpathで結合されます。

構造体のフィールドは次のとおりです。

名前型説明
descUnion{String, Base.OS_HANDLE}パスまたは OS のファイル記述子
sizeInt64ファイルのサイズ(バイト単位)
deviceUIntファイルを格納しているデバイスの ID
inodeUIntファイルの inode 番号
modeUIntファイルの保護モード
nlinkIntファイルへのハードリンク数
uidUIntファイル所有者のユーザー ID
gidUIntファイル所有者のグループ ID
rdevUIntファイルがデバイスを参照する場合、そのデバイスの ID
blksizeInt64ファイルシステムがファイルに推奨するブロックサイズ
blocksInt64割り当てられた 512 バイトブロックの数
mtimeFloat64ファイルが最後に変更された時刻の Unix タイムスタンプ
ctimeFloat64ファイルのメタデータが変更された時刻の Unix タイムスタンプ
source
Base.Filesystem.diskstat — Function
diskstat(path=pwd())

path が指すファイルまたはディレクトリを含むディスクの統計情報をバイト単位で返します。引数を指定しない場合は、現在の作業ディレクトリを含むディスクの統計情報を返します。

Julia 1.8

このメソッドは Julia 1.8 で追加されました。

source
Base.Filesystem.lstat — Function
lstat(path)
lstat(path_elements...)

statと似ていますが、シンボリックリンクの場合は、リンク先のファイルではなくリンク自体の情報を取得します。

この関数には、ファイルオブジェクトやファイル記述子ではなく、ファイルパスを渡す必要があります。

source
Base.Filesystem.ctime — Function
ctime(path)
ctime(path_elements...)
ctime(stat_struct)

path にあるファイルのメタデータが最後に変更された時刻、またはファイル記述子 stat_struct が示すメタデータの最終変更時刻を、Unix タイムスタンプで返します。

stat(path).ctime または stat_struct.ctime と同等です。

source
Base.Filesystem.mtime — Function
mtime(path)
mtime(path_elements...)
mtime(stat_struct)

path にあるファイルの最終更新時刻、またはファイル記述子 stat_struct が示す最終更新時刻を、Unixタイムスタンプで返します。

stat(path).mtime または stat_struct.mtime と同等です。

source
Base.Filesystem.filemode — Function
filemode(path)
filemode(path_elements...)
filemode(stat_struct)

path にあるファイルのモード、またはファイル記述子 stat_struct が示すモードを返します。

stat(path).mode または stat_struct.mode と同等です。

source
Base.filesize — Function
filesize(path)
filesize(path_elements...)
filesize(stat_struct)

path にあるファイルのサイズ、またはファイル記述子 stat_struct が示すファイルのサイズを返します。

stat(path).size または stat_struct.size と同等です。

source
Base.Filesystem.uperm — Function
uperm(path)
uperm(path_elements...)
uperm(stat_struct)

path またはファイル記述子 stat_struct が示すファイルについて、所有者の権限をビットフィールドとして返します。

値説明
01実行権限
02書き込み権限
04読み取り権限

ビットフィールドが返されるため、読み取りと書き込みの権限がある場合、ビットフィールドは「110」となり、10進数では 0+2+4=6 に相当します。このことは、返された UInt8 値の表示にも反映されます。

gperm および operm も参照してください。

julia> touch("dummy_file");  # Create test-file without contents

julia> uperm("dummy_file")
0x06

julia> bitstring(ans)
"00000110"

julia> has_read_permission(path) = uperm(path) & 0b00000100 != 0;  # Use bit mask to check specific bit

julia> has_read_permission("dummy_file")
true

julia> rm("dummy_file")     # Clean up test-file
source
Base.Filesystem.gperm — Function
gperm(path)
gperm(path_elements...)
gperm(stat_struct)

upermと同様ですが、ファイルを所有するグループの権限を取得します。

opermも参照してください。

source
Base.Filesystem.operm — Function
operm(path)
operm(path_elements...)
operm(stat_struct)

upermと同様ですが、ファイルの所有者でも、そのファイルを所有するグループのメンバーでもないユーザーの権限を取得します。

gpermも参照してください。

source
Base.Filesystem.cp — Function
cp(src::AbstractString, dst::AbstractString; force::Bool=false, follow_symlinks::Bool=false)

src から dst に、ファイル、リンク、またはディレクトリをコピーします。force=true は、既存の dst を最初に削除します。

follow_symlinks=false がシンボリックリンクであり、src もシンボリックリンクの場合、dst はシンボリックリンクとして作成されます。follow_symlinks=true がシンボリックリンクであり、src もシンボリックリンクの場合、dst は、src が指すファイルまたはディレクトリのコピーになります。dst を返します。

Note

cp 関数は、Unix コマンドの cp とは異なります。cp 関数は、dst がファイルであると常に仮定して動作します。一方、このコマンドは、dst がディレクトリかファイルかによって動作が異なります。dst がディレクトリの場合に force=true を使用すると、dst ディレクトリ内のすべての内容が失われ、代わりに dst は src の内容を持つファイルになります。

source
Base.download — Function
download(url::AbstractString, [path::AbstractString = tempname()]) -> path

指定された URL からファイルをダウンロードし、path で指定された場所に保存します。保存先が指定されていない場合は、一時パスに保存します。ダウンロードしたファイルのパスを返します。

Note

Julia 1.6 以降、この関数は非推奨であり、Downloads.download の薄いラッパーにすぎません。新しいコードでは、この関数を呼び出す代わりに、そちらの関数を直接使用してください。

source
Base.Filesystem.mv — Function
mv(src::AbstractString, dst::AbstractString; force::Bool=false)

ファイル、リンク、またはディレクトリを src から dst に移動します。force=true は、既存の dst を先に削除します。dst を返します。

Examples

julia> write("hello.txt", "world");

julia> mv("hello.txt", "goodbye.txt")
"goodbye.txt"

julia> "hello.txt" in readdir()
false

julia> readline("goodbye.txt")
"world"

julia> write("hello.txt", "world2");

julia> mv("hello.txt", "goodbye.txt")
ERROR: ArgumentError: 'goodbye.txt' exists. `force=true` is required to remove 'goodbye.txt' before moving.
Stacktrace:
 [1] #checkfor_mv_cp_cptree#10(::Bool, ::Function, ::String, ::String, ::String) at ./file.jl:293
[...]

julia> mv("hello.txt", "goodbye.txt", force=true)
"goodbye.txt"

julia> rm("goodbye.txt");
Note

mv 関数は、Unix コマンドの mv とは異なります。mv 関数は、dst が存在すると、デフォルトではエラーになります。一方、このコマンドはデフォルトで既存の dst ファイルを削除します。また、mv 関数は常に dst をファイルとして扱いますが、このコマンドは dst がディレクトリかファイルかによって動作が異なります。dst がディレクトリの場合に force=true を使うと、dst ディレクトリ内のすべての内容が失われ、代わりに src の内容を持つファイルが dst として作成されます。

source
Base.Filesystem.rename — Function
Base.rename(oldpath::AbstractString, newpath::AbstractString)

ファイルまたはディレクトリの名前を、oldpathからnewpathに変更します。newpathが既存のファイルまたは空のディレクトリである場合は、置き換えられることがあります。Unixのrename(2)と同等です。パスに「\0」が含まれている場合は、ArgumentErrorをスローします。それ以外のエラーが発生した場合は、IOErrorをスローします。newpathを返します。

これは、mvを実装するために使用される、低レベルのファイルシステム操作です。

oldpathとnewpathが異なるディレクトリにある場合、OS固有の制約が適用されることがあります。

Windowsでは現在、動作にいくつかの違いがあります。これらは将来のリリースで解消される可能性があります。具体的には、現在のWindowsでは次のとおりです。

  1. renameは、oldpathまたはnewpathが開かれたファイルの場合、失敗します。
  2. renameは、newpathが既存のディレクトリの場合、失敗します。
  3. renameは、newpathがファイルで、oldpathがディレクトリの場合、成功することがあります。
  4. renameは、oldpathがnewpathへのハードリンクである場合、これを削除することがあります。

関連項目: mv。

Julia 1.12

このメソッドはJulia 1.12で公開されました。

source
Base.Filesystem.rm — Function
rm(path::AbstractString; force::Bool=false, recursive::Bool=false)

指定されたパスにあるファイル、リンク、または空のディレクトリを削除します。force=trueが渡された場合、存在しないパスはエラーとして扱われません。recursive=trueが渡され、パスがディレクトリの場合は、その内容をすべて再帰的に削除します。

Examples

julia> mkpath("my/test/dir");

julia> rm("my", recursive=true)

julia> rm("this_file_does_not_exist", force=true)

julia> rm("this_file_does_not_exist")
ERROR: IOError: unlink("this_file_does_not_exist"): no such file or directory (ENOENT)
Stacktrace:
[...]
source
Base.Filesystem.touch — Function
Base.touch(::Pidfile.LockMonitor)

ロックのmtimeを更新して、まだ新しいことを示します。

mkpidlockコンストラクターのrefreshキーワードも参照してください。

source
touch(path::AbstractString)
touch(fd::File)

ファイルの最終更新日時を現在の時刻に更新します。

ファイルが存在しない場合は、新しいファイルが作成されます。

path を返します。

Examples

julia> write("my_little_file", 2);

julia> mtime("my_little_file")
1.5273815391135583e9

julia> touch("my_little_file");

julia> mtime("my_little_file")
1.527381559163435e9

mtime は touch によって変更されたことが確認できます。

source
Base.Filesystem.tempname — Function
tempname(parent=tempdir(); cleanup=true, suffix="")::String

一時ファイルのパスを生成します。この関数はパスを返すだけで、ファイルは作成しません。パスは一意である可能性が高いものの、tempnameを同時に呼び出した際、非常にまれに同じファイル名が生成される可能性があるため、一意性は保証されません。ただし、tempnameの呼び出し時点ですでに存在するすべてのファイルとは異なる名前が保証されます。

引数を指定せずに呼び出すと、一時パスとして、tempdir()で指定されるシステムの一時ディレクトリ内の絶対パスが返されます。parentディレクトリを引数に指定した場合は、そのディレクトリ内のパスが返されます。サフィックスを指定すると、一時ファイル名はそのサフィックスで終わり、そのサフィックスを付けた状態で一意性が確認されます。

cleanupオプションは、プロセス終了時に返されたパスを自動的に削除するかどうかを制御します。tempname関数は、返された場所にファイルやディレクトリを作成しないため、そこにファイルやディレクトリを作成しない限り、後片付けの対象はありません。作成した場合、cleanupがtrueであれば、プロセス終了時に削除されます。

Julia 1.4

parent引数とcleanup引数は、1.4で追加されました。Julia 1.4より前では、パスtempnameがプロセス終了時に削除されることはありませんでした。

Julia 1.12

suffixキーワード引数は、Julia 1.12で追加されました。

Warning

別のプロセスが同じファイル名を取得し、こちらがファイルを作成する前にそのファイルを作成すると、セキュリティ上の問題が発生するおそれがあります。これが懸念される場合は、JL_O_EXCLを使ってファイルを開いてください。代わりにmktemp()を使うことも推奨されます。

source
Base.Filesystem.tempdir — Function
tempdir()

一時ディレクトリのパスを取得します。Windows では、tempdir() は、次の順序で環境変数を検索し、最初に見つかったものを使用します:TMP、TEMP、USERPROFILE。その他のすべてのオペレーティングシステムでは、tempdir() は、次の順序で環境変数を検索し、最初に見つかったものを使用します:TMPDIR、TMP、TEMP、TEMPDIR。いずれも見つからない場合は、パス "/tmp" を使用します。

source
Base.Filesystem.mktemp — Method
mktemp(parent=tempdir(); cleanup=true) -> (path, io)

(path, io)を返します。pathはparent内に作成される新しい一時ファイルのパスで、ioはそのパスを指すオープン済みのファイルオブジェクトです。一時ファイルをプロセス終了時に自動削除するかどうかは、cleanupオプションで制御します。

Julia 1.3

cleanupキーワード引数はJulia 1.3で追加されました。また、1.3以降では、cleanupを明示的にfalseに設定しない限り、Juliaはプロセス終了時にmktempが作成した一時パスを削除します。

source
Base.Filesystem.mktempdir — Method
mktempdir(parent=tempdir(); prefix="jl_", cleanup=true) -> path

parent ディレクトリ内に、指定された prefix とランダムな接尾辞からなる名前の一時ディレクトリを作成し、そのパスを返します。また、一部のプラットフォームでは、prefix の末尾にある 'X' 文字がランダムな文字に置き換えられることがあります。parent が存在しない場合は、エラーをスローします。cleanup オプションは、プロセス終了時に一時ディレクトリを自動的に削除するかどうかを制御します。

Julia 1.2

prefix キーワード引数は Julia 1.2 で追加されました。

Julia 1.3

cleanup キーワード引数は Julia 1.3 で追加されました。関連して、1.3 以降では、cleanup が明示的に false に設定されていない限り、Julia プロセスの終了時に mktempdir が作成した一時パスが削除されます。

関連項目: mktemp、mkdir。

source
Base.Filesystem.mktempdir — Method
mktempdir(f::Function, parent=tempdir(); prefix="jl_")

mktempdir(parent; prefix) の結果に f 関数を適用し、完了後に一時ディレクトリとその内容をすべて削除します。

関連項目: mktemp、mkdir。

Julia 1.2

prefix キーワード引数は Julia 1.2 で追加されました。

source
Base.Filesystem.isblockdev — Function
isblockdev(path)::Bool
isblockdev(path_elements...)::Bool
isblockdev(stat_struct)::Bool

パス path またはファイル記述子 stat_struct がブロックデバイスを指している場合は true を返し、それ以外の場合は false を返します。

source
Base.Filesystem.ischardev — Function
ischardev(path)::Bool
ischardev(path_elements...)::Bool
ischardev(stat_struct)::Bool

パスpathまたはファイル記述子stat_structがキャラクタデバイスを指している場合はtrueを返し、そうでない場合はfalseを返します。

source
Base.Filesystem.isdir — Function
isdir(path)::Bool
isdir(path_elements...)::Bool

path がディレクトリを指している場合は true を返し、それ以外の場合は false を返します。

Examples

julia> isdir(homedir())
true

julia> isdir("not/a/directory")
false

isfile および ispath も参照してください。

source
Base.Filesystem.isfifo — Function
isfifo(path)::Bool
isfifo(path_elements...)::Bool
isfifo(stat_struct)::Bool

true を返します。ただし、path のファイルまたはファイル記述子 stat_struct が FIFO の場合は、false を返します。

source
Base.Filesystem.isfile — Function
isfile(path)::Bool
isfile(path_elements...)::Bool

pathが通常のファイルを指している場合はtrueを返し、そうでない場合はfalseを返します。

Examples

julia> isfile(homedir())
false

julia> filename = "test_file.txt";

julia> write(filename, "Hello world!");

julia> isfile(filename)
true

julia> rm(filename);

julia> isfile(filename)
false

isdirおよびispathも参照してください。

source
Base.Filesystem.islink — Function
islink(path)::Bool
islink(path_elements...)::Bool

path がシンボリックリンクを指している場合は true を返し、そうでない場合は false を返します。

source
Base.Filesystem.ismount — Function
ismount(path)::Bool
ismount(path_elements...)::Bool

true がマウントポイントの場合は path を、そうでない場合は false を返します。

source
Base.Filesystem.ispath — Function
ispath(path)::Bool
ispath(path_elements...)::Bool

true を返します。path に有効なファイルシステムエンティティが存在する場合はそうし、存在しない場合は false を返します。

これは isfile、isdir などを一般化したものです。

source
Base.Filesystem.issetgid — Function
issetgid(path)::Bool
issetgid(path_elements...)::Bool
issetgid(stat_struct)::Bool

true を返します。path のファイルまたは stat_struct のファイル記述子に setgid フラグが設定されている場合は false を返します。

source
Base.Filesystem.issetuid — Function
issetuid(path)::Bool
issetuid(path_elements...)::Bool
issetuid(stat_struct)::Bool

true を返します。ただし、path のファイルまたはファイル記述子 stat_struct に setuid フラグが設定されている場合に限ります。設定されていない場合は false を返します。

source
Base.Filesystem.issocket — Function
issocket(path)::Bool
issocket(path_elements...)::Bool

true を返します。path がソケットを指している場合はそうし、それ以外の場合は false を返します。

source
Base.Filesystem.issticky — Function
issticky(path)::Bool
issticky(path_elements...)::Bool
issticky(stat_struct)::Bool

pathのファイルまたはファイル記述子stat_structにスティッキービットが設定されている場合は、trueを返します。そうでない場合は、falseを返します。

source
Base.Filesystem.homedir — Function
homedir()::String

現在のユーザーのホームディレクトリを返します。

Note

homedir は、libuv の uv_os_homedir によってホームディレクトリを決定します。詳細(環境変数を使ってホームディレクトリを指定する方法など)については、uv_os_homedir documentation を参照してください。

Sys.username も参照してください。

source
Base.Filesystem.dirname — Function
dirname(path::AbstractString)::String

パスのディレクトリ部分を取得します。パス末尾の文字('/' または '\')は、パスの一部として扱われます。

Examples

julia> dirname("/home/myuser")
"/home"

julia> dirname("/home/myuser/")
"/home/myuser"

basename も参照してください。

source
Base.Filesystem.basename — Function
basename(path::AbstractString)::String

パスからファイル名部分を取得します。

Note

この関数の動作は Unix の basename プログラムとは少し異なります。Unix では末尾のスラッシュが無視されるため、$ basename /foo/bar/ は bar を返します。一方、Julia の basename は空文字列 "" を返します。

Examples

julia> basename("/home/myuser/example.jl")
"example.jl"

julia> basename("/home/myuser/")
""

dirname.

source
Base.Filesystem.isabspath — Function
isabspath(path::AbstractString)::Bool

パスが絶対パス(ルートディレクトリから始まるパス)かどうかを判定します。

Examples

julia> isabspath("/home")
true

julia> isabspath("home")
false
source
Base.Filesystem.isdirpath — Function
isdirpath(path::AbstractString)::Bool

パスがディレクトリを指しているかどうかを判定します(たとえば、パス区切り文字で終わっている場合)。

Examples

julia> isdirpath("/home")
false

julia> isdirpath("/home/")
true
source
Base.Filesystem.joinpath — Function
joinpath(parts::AbstractString...)::String
joinpath(parts::Vector{AbstractString})::String
joinpath(parts::Tuple{AbstractString})::String

パスの各要素を結合して、完全なパスを作成します。引数のいずれかが絶対パスである場合、または(Windows で)それ以前のパスを結合して算出したドライブと異なるドライブ指定を含む場合、それより前の要素は破棄されます。

Windows ではドライブごとにカレントディレクトリがあるため、joinpath("c:", "foo")はドライブ「c:」のカレントディレクトリからの相対パスを表します。したがって、これは「c:\foo」ではなく「c:foo」と同じです。さらに、joinpathはこれを絶対パスではないものとして扱い、ドライブ文字の大文字・小文字を区別しません。そのため、joinpath("C:\\A","c:b") = "C:\\A\\b"となります。

Examples

julia> joinpath("/home/myuser", "example.jl")
"/home/myuser/example.jl"
julia> joinpath(["/home/myuser", "example.jl"])
"/home/myuser/example.jl"
source
Base.Filesystem.abspath — Function
abspath(path::AbstractString, paths::AbstractString...)::String

複数のパスを結合し、必要に応じてカレントディレクトリを追加して、絶対パスに変換します。abspath(joinpath(path, paths...)) と同等です。

source
abspath(path::AbstractString)::String

必要に応じて現在のディレクトリを追加し、パスを絶対パスに変換します。また、normpathと同様にパスを正規化します。

Examples

JuliaExampleというディレクトリにいて、使用するデータがJuliaExampleディレクトリから見て2階層上にある場合は、次のように記述できます。

abspath("../../data")

この場合、パスは"/home/JuliaUser/data/"のようになります。

joinpath、pwd、expanduserも参照してください。

source
Base.Filesystem.normpath — Function
normpath(path::AbstractString, paths::AbstractString...)::String

複数のパスを結合し、「.」および「..」の要素を取り除いて、正規化されたパスに変換します。normpath(joinpath(path, paths...)) と同等です。

source
normpath(path::AbstractString)::String

パスを正規化し、「.」と「..」の要素を取り除いて、「/」をシステムの標準パス区切り文字に置き換えます。

Examples

julia> normpath("/home/myuser/../example.jl")
"/home/example.jl"

julia> normpath("Documents/Julia") == joinpath("Documents", "Julia")
true
source
Base.Filesystem.realpath — Function
realpath(path::AbstractString)::String

シンボリックリンクを展開し、「.」および「..」の要素を取り除いて、パスを正規化します。大文字と小文字を区別せず、その表記は保持するファイルシステム(通常は Mac と Windows)では、ファイルシステムに保存されているパスの大文字・小文字の表記が返されます。

(path がファイルシステムに存在しない場合、この関数は例外をスローします。)

source
Base.Filesystem.relpath — Function
relpath(path::AbstractString, startpath::AbstractString = ".")::String

現在のディレクトリ、または省略可能な開始ディレクトリからpathへの相対ファイルパスを返します。これはパスの計算であり、ファイルシステムにアクセスしてpathまたはstartpathの存在や種類を確認することはありません。

Windowsでは、ドライブ文字を除くパスのすべての部分で大文字と小文字が区別されます。pathとstartpathが異なるドライブを指す場合は、pathの絶対パスが返されます。

source
Base.Filesystem.expanduser — Function
expanduser(path::AbstractString)::AbstractString

Unix システムでは、パスの先頭にあるチルダ文字を、現在のユーザーのホームディレクトリに置き換えます。

関連項目: contractuser。

source
Base.Filesystem.contractuser — Function
contractuser(path::AbstractString)::AbstractString

Unix システムでは、パスが homedir() で始まる場合、チルダ文字に置き換えます。

関連項目: expanduser。

source
Base.Filesystem.samefile — Function
samefile(path_a, path_b)

path_a と path_b のパスが、同じ既存のファイルまたはディレクトリを指しているか確認します。

source
Base.Filesystem.splitdir — Function
splitdir(path::AbstractString) -> (dir::AbstractString, file::AbstractString)

パスをディレクトリ名とファイル名のタプルに分割します。

Examples

julia> splitdir("/home/myuser")
("/home", "myuser")
source
Base.Filesystem.splitdrive — Function
splitdrive(path::AbstractString) -> (drive::AbstractString, path::AbstractString)

Windowsでは、パスをドライブ文字部分とパス部分に分割します。Unixシステムでは、最初の要素は常に空文字列です。

source
Base.Filesystem.splitext — Function
splitext(path::AbstractString) -> (path_without_extension::String, extension::String)

パスの最後の要素にドットが1つ以上含まれている場合は、最後のドットより前の部分と、最後のドットを含むそれ以降の部分に分割します。そうでない場合は、引数を変更せずに空文字列と組み合わせたタプルを返します。「splitext」は「split extension」の略です。

Examples

julia> splitext("/home/myuser/example.jl")
("/home/myuser/example", ".jl")

julia> splitext("/home/myuser/example.tar.gz")
("/home/myuser/example.tar", ".gz")

julia> splitext("/home/my.user/example")
("/home/my.user/example", "")
source
Base.Filesystem.splitpath — Function
splitpath(path::AbstractString)::Vector{String}

ファイルパスをすべてのパス構成要素に分割します。これはjoinpathの逆の操作です。パス内の各ディレクトリまたはファイルに対応する部分文字列を配列として返します。ルートディレクトリが含まれている場合は、それも含まれます。

Julia 1.1

この関数を使用するには、Julia 1.1 以降が必要です。

Examples

julia> splitpath("/home/myuser/example.jl")
4-element Vector{String}:
 "/"
 "home"
 "myuser"
 "example.jl"
source