Skip to content

Fix File.open/2 and variants specs to accept :directory option #15890

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
aiotter wants to merge 2 commits into
base: main
Choose a base branch
from
+11 −5
Open

Fix File.open/2 and variants specs to accept :directory option #15890

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc8ef45
Fix File.open/2 and variants specs to accept :directory option
aiotter Sep 12, 2026
cca8aaf
Add unit test for File.open/2 with :directory option
aiotter Sep 13, 2026
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
11 changes: 6 additions & 5 deletions lib/elixir/lib/file.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1818,7 +1818,7 @@ defmodule File do
cannot cope with the character range of the data, an error occurs and the
file will be closed.

* `:delayed_write`, `:raw`, `:ram`, `:read_ahead`, `:sync`, `{:encoding, ...}`,
* `:delayed_write`, `:directory`, `:raw`, `:ram`, `:read_ahead`, `:sync`, `{:encoding, ...}`,
`{:read_ahead, pos_integer}`, `{:delayed_write, non_neg_integer, non_neg_integer}` -
for more information about these options see `:file.open/2`.

Expand Down Expand Up @@ -1859,7 +1859,7 @@ defmodule File do
File.close(file)

"""
@spec open(Path.t(), [mode | :ram]) ::
@spec open(Path.t(), [mode | :ram | :directory]) ::
{:ok, io_device | file_descriptor} | {:error, posix | :badarg | :system_limit}
@spec open(Path.t(), (io_device | file_descriptor -> res)) ::
{:ok, res} | {:error, posix | :badarg | :system_limit}
Expand Down Expand Up @@ -1898,7 +1898,7 @@ defmodule File do
end)
#=> {:ok, "file content"}
"""
@spec open(Path.t(), [mode | :ram], (io_device | file_descriptor -> res)) ::
@spec open(Path.t(), [mode | :ram | :directory], (io_device | file_descriptor -> res)) ::
{:ok, res} | {:error, posix | :badarg | :system_limit}
when res: var
def open(path, modes, function) when is_list(modes) and is_function(function, 1) do
Expand Down Expand Up @@ -1928,7 +1928,7 @@ defmodule File do
end)
#=> "file content"
"""
@spec open!(Path.t(), [mode | :ram]) :: io_device | file_descriptor
@spec open!(Path.t(), [mode | :ram | :directory]) :: io_device | file_descriptor
@spec open!(Path.t(), (io_device | file_descriptor -> res)) :: res when res: var
def open!(path, modes_or_function \\ []) do
case open(path, modes_or_function) do
Expand All @@ -1955,7 +1955,8 @@ defmodule File do
end)
#=> "file content"
"""
@spec open!(Path.t(), [mode | :ram], (io_device | file_descriptor -> res)) :: res when res: var
@spec open!(Path.t(), [mode | :ram | :directory], (io_device | file_descriptor -> res)) :: res
when res: var
def open!(path, modes, function) do
case open(path, modes, function) do
{:ok, function_result} ->
Expand Down
5 changes: 5 additions & 0 deletions lib/elixir/test/elixir/file_test.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1044,6 +1044,11 @@ defmodule FileTest do
assert File.close(file) == :ok
end

test "open directory" do
{:ok, dir} = File.open(".", [:read, :directory])
assert File.close(dir) == :ok
end

test "open file with charlist" do
{:ok, file} = File.open(fixture_path("file.txt"), [:charlist])
assert IO.gets(file, "") == ~c"FOO\n"
Expand Down