@spec absname(t()) :: binary()

Преобразует заданный путь в абсолютный.

В отличие от expand/1, не делается попыток разрешить .., ., или ~.

Примеры

Операционные системы семейства Unix

Path.absname("foo")
#=> "/usr/local/foo"

Path.absname("../x")
#=> "/usr/local/../x"

Windows

Path.absname("foo")
#=> "D:/usr/local/foo"

Path.absname("../x")
#=> "D:/usr/local/../x"

@spec absname(t(), t() | (-> t())) :: binary()

Строит путь от relative_to до path.

Если path уже является абсолютным путём, relative_to игнорируется. См. также relative_to/3. relative_to — это либо путь, либо анонимная функция, которая вызывается только по мере необходимости и возвращает путь.

В отличие от expand/2, не делается попыток разрешить .., . или ~.

Примеры

iex> Path.absname("foo", "bar")
"bar/foo"

iex> Path.absname("../x", "bar")
"bar/../x"

@spec basename(t()) :: binary()

Возвращает последнюю составляющую пути или сам путь, если он не содержит разделителей каталогов.

Примеры

iex> Path.basename("foo")
"foo"

iex> Path.basename("foo/bar")
"bar"

iex> Path.basename("lib/module/submodule.ex")
"submodule.ex"

iex> Path.basename("/")
""

@spec basename(t(), t()) :: binary()

Возвращает последнюю составляющую пути path с удалённым extension.

Эта функция должна использоваться для удаления специфичного расширения, которое может или не может присутствовать.

Примеры

iex> Path.basename("~/foo/bar.ex", ".ex")
"bar"

iex> Path.basename("~/foo/bar.exs", ".ex")
"bar.exs"

iex> Path.basename("~/foo/bar.old.ex", ".ex")
"bar.old"

@spec dirname(t()) :: binary()

Возвращает компонент каталога для path.

Примеры

iex> Path.dirname("/foo/bar.ex")
"/foo"

iex> Path.dirname("/foo/bar/baz.ex")
"/foo/bar"

iex> Path.dirname("/foo/bar/")
"/foo/bar"

iex> Path.dirname("bar.ex")
"."

@spec expand(t()) :: binary()

Преобразует путь в абсолютный, расширяя все . и .. компоненты и ведущий ~.

Примеры

Path.expand("/foo/bar/../baz")
#=> "/foo/baz"

@spec expand(t(), t()) :: binary()

Расширяет путь относительно пути, заданного во втором аргументе, расширяя символы . и ...

Если путь уже является абсолютным, relative_to игнорируется.

Обратите внимание, что эта функция рассматривает path с ведущим ~ как абсолютный.

Второй аргумент сначала расширяется до абсолютного пути.

Примеры

# Assuming that the absolute path to baz is /quux/baz
Path.expand("foo/bar/../bar", "baz")
#=> "/quux/baz/foo/bar"

Path.expand("foo/bar/../bar", "/baz")
#=> "/baz/foo/bar"

Path.expand("/foo/bar/../bar", "/baz")
#=> "/foo/bar"

@spec extname(t()) :: binary()

Возвращает расширение последней составляющей пути path.

Для имён файлов, начинающихся с точки и не имеющих расширения, возвращает пустую строку.

См. basename/1 и rootname/1 для функций, связанных с извлечением информации из путей.

Примеры

iex> Path.extname("foo.erl")
".erl"

iex> Path.extname("~/foo/bar")
""

iex> Path.extname(".gitignore")
""

@spec join([t(), ...]) :: binary()

Объединяет список путей.

Эта функция должна использоваться для преобразования списка путей в один путь. Обратите внимание, что любые завершающие слэши удаляются при объединении.

Вызывает ошибку, если заданный список путей пуст.

Примеры

iex> Path.join(["~", "foo"])
"~/foo"

iex> Path.join(["foo"])
"foo"

iex> Path.join(["/", "foo", "bar/"])
"/foo/bar"

@spec join(t(), t()) :: binary()

Объединяет два пути.

Правый путь всегда преобразуется в относительный формат, и любые завершающие слэши удаляются при объединении.

Примеры

iex> Path.join("foo", "bar")
"foo/bar"

iex> Path.join("/foo", "/bar/")
"/foo/bar"

Функции в этом модуле поддерживают chardata, поэтому передача списка будет обрабатывать его как единый объект:

iex> Path.join("foo", ["bar", "fiz"])
"foo/barfiz"

iex> Path.join(["foo", "bar"], "fiz")
"foobar/fiz"

Используйте join/1, если вам нужно объединить список путей.

@spec relative(t()) :: binary()

Принудительно преобразует путь в относительный.

Если задан абсолютный путь, его корневой компонент удаляется.

Примеры

Операционные системы семейства Unix

Path.relative("/usr/local/bin")   #=> "usr/local/bin"
Path.relative("usr/local/bin")    #=> "usr/local/bin"
Path.relative("../usr/local/bin") #=> "../usr/local/bin"

Windows

Path.relative("D:/usr/local/bin") #=> "usr/local/bin"
Path.relative("usr/local/bin")    #=> "usr/local/bin"
Path.relative("D:bar.ex")         #=> "bar.ex"
Path.relative("/bar/foo.ex")      #=> "bar/foo.ex"

@spec relative_to(t(), t(), keyword()) :: binary()

Возвращает относительный путь от path по отношению к cwd.

Другими словами, эта функция пытается вернуть путь такой, что Path.expand(result, cwd) указывает на path. Эта функция стремится вернуть относительный путь, когда это возможно, но это не гарантируется:

• Если оба пути относительные, всегда возвращается относительный путь

• Если оба пути абсолютные, может быть возвращён относительный путь, если у них есть общий префикс. Можно передать опцию :force для принудительного прохода вверх, но даже тогда относительный путь не гарантируется (например, если абсолютные пути относятся к различным дискам в Windows)

• Если даны смешанные пути, результат всегда соответствует заданному path (первый аргумент)

Эта функция расширяет . и .. записи без обхода файловой системы, поэтому она предполагает отсутствие символических ссылок между путями. См. safe_relative_to/2 для более безопасной альтернативы.

Параметры

• :force - (логическое значение с версии v1.16.0) если true принудительно заставляет возвращать относительный путь, проходя вверх по пути. За исключением случаев, когда пути находятся на разных томах в Windows. По умолчанию false.

Примеры

С относительным cwd

Если оба пути относительные, вычисляется минимальный путь:

Path.relative_to("tmp/foo/bar", "tmp")      #=> "foo/bar"
Path.relative_to("tmp/foo/bar", "tmp/foo")  #=> "bar"
Path.relative_to("tmp/foo/bar", "tmp/bat")  #=> "../foo/bar"

Если абсолютный путь задан с относительным cwd, он возвращается как:

Path.relative_to("/usr/foo/bar", "tmp/bat")  #=> "/usr/foo/bar"

С абсолютным cwd

Если оба пути абсолютные, вычисляется относительный путь, если возможно, без прохода вверх:

Path.relative_to("/usr/local/foo", "/usr/local")      #=> "foo"
Path.relative_to("/usr/local/foo", "/")               #=> "usr/local/foo"
Path.relative_to("/usr/local/foo", "/etc")            #=> "/usr/local/foo"
Path.relative_to("/usr/local/foo", "/usr/local/foo")  #=> "."
Path.relative_to("/usr/local/../foo", "/usr/foo")     #=> "."
Path.relative_to("/usr/local/../foo/bar", "/usr/foo") #=> "bar"

Если :force установлено в true пути просматриваются вверх:

Path.relative_to("/usr", "/usr/local", force: true)          #=> ".."
Path.relative_to("/usr/foo", "/usr/local", force: true)      #=> "../foo"
Path.relative_to("/usr/../foo/bar", "/etc/foo", force: true) #=> "../../foo/bar"

Если задан относительный путь, он предполагается относительным к заданному пути, поэтому путь возвращается с расширенными "." и "..":

Path.relative_to(".", "/usr/local")          #=> "."
Path.relative_to("foo", "/usr/local")        #=> "foo"
Path.relative_to("foo/../bar", "/usr/local") #=> "bar"
Path.relative_to("foo/..", "/usr/local")     #=> "."
Path.relative_to("../foo", "/usr/local")     #=> "../foo"

@spec relative_to_cwd(
  t(),
  keyword()
) :: binary()

Удобная функция для получения пути, относительного к текущей рабочей директории.

Если по какой-либо причине текущая рабочая директория не может быть получена, эта функция возвращает заданный path.

См. relative_to/3 для поддерживаемых параметров.

@spec rootname(t()) :: binary()

Возвращает path с удалённым extension.

Примеры

iex> Path.rootname("/foo/bar")
"/foo/bar"

iex> Path.rootname("/foo/bar.ex")
"/foo/bar"

@spec rootname(t(), t()) :: binary()

Возвращает path с удалённым extension.

Эта функция должна использоваться для удаления определённого расширения, которое может быть, а может и отсутствовать.

Примеры

iex> Path.rootname("/foo/bar.erl", ".erl")
"/foo/bar"

iex> Path.rootname("/foo/bar.erl", ".ex")
"/foo/bar.erl"

@spec safe_relative(t(), t()) :: {:ok, binary()} | :error

Возвращает относительный путь, защищённый от атак перехода каталогов.

Указанный относительный путь очищается путём удаления .. и . компонентов.

Эта функция проверяет, что после расширения этих компонентов путь всё ещё является «безопасным». Пути считаются небезопасными, если выполняется хотя бы одно из следующих условий:

• Путь не относительный, например, "/foo/bar".

• Компонент .. привёл бы к тому, что путь переместился бы выше корня relative_to.

• Символическая ссылка в пути указывает на элемент выше корня cwd.

Примеры

iex> Path.safe_relative("foo")
{:ok, "foo"}

iex> Path.safe_relative("deps/my_dep/app.beam")
{:ok, "deps/my_dep/app.beam"}

iex> Path.safe_relative("deps/my_dep/./build/../app.beam", File.cwd!())
{:ok, "deps/my_dep/app.beam"}

iex> Path.safe_relative("my_dep/../..")
:error

iex> Path.safe_relative("/usr/local", File.cwd!())
:error

@spec safe_relative_to(t(), t()) :: {:ok, binary()} | :error

Возвращает относительный путь, защищённый от атак перехода каталогов.

См. safe_relative/2 для не устаревшей версии этого API.

@spec split(t()) :: [binary()]

Разделяет путь на список по разделителю пути.

Если передана пустая строка, возвращает пустой список.

В Windows путь разделяется как по "\", так и по "/" разделителям, а буква диска, если она есть, всегда возвращается в нижнем регистре.

Примеры

iex> Path.split("")
[]

iex> Path.split("foo")
["foo"]

iex> Path.split("/foo/bar")
["/", "foo", "bar"]

@spec type(t()) :: :absolute | :relative | :volumerelative

Возвращает тип пути.

Примеры

Операционные системы Unix-подобного типа

Path.type("/")                #=> :absolute
Path.type("/usr/local/bin")   #=> :absolute
Path.type("usr/local/bin")    #=> :relative
Path.type("../usr/local/bin") #=> :relative
Path.type("~/file")           #=> :relative

Windows

Path.type("D:/usr/local/bin") #=> :absolute
Path.type("usr/local/bin")    #=> :relative
Path.type("D:bar.ex")         #=> :volumerelative
Path.type("/bar/foo.ex")      #=> :volumerelative

@spec wildcard(
  t(),
  keyword()
) :: [binary()]

Проходит по путям в соответствии с заданным glob выражением и возвращает список совпадений.

Маска похожа на обычный путь, за исключением того, что следующие "символы-маски" интерпретируются особым образом:

• ? - соответствует одному символу.

• * - соответствует любому числу символов до конца имени файла, следующей точки или следующего слэша.

• ** - два смежных * в качестве одного шаблона будут соответствовать всем файлам и нулю или более каталогов и подкаталогов.

• [char1,char2,...] - соответствует одному из перечисленных символов; два символа, разделенные дефисом, будут соответствовать диапазону символов. Не добавляйте пробелы перед и после запятой, так как иначе он будет соответствовать путям, содержащим сам пробел.

• {item1,item2,...} - соответствует одному из альтернатив. Не добавляйте пробелы перед и после запятой, так как иначе он будет соответствовать путям, содержащим сам пробел.

Другие символы представляют собой сами себя. Только пути, имеющие точно такой же символ в том же положении, будут соответствовать. Обратите внимание, что соответствие регистрозависимо: "a" не будет соответствовать "A".

Разделители каталогов должны всегда записываться как /, даже в Windows. Вы можете вызвать Path.expand/1 для нормализации пути перед вызовом этой функции.

Символ, предшествуемый \\, теряет своё специальное значение. Обратите внимание, что \\ должен быть записан как \\\\ в строковой литерале. Например, "\\\\?*" будет соответствовать любому имени файла, начинающемуся с ?..

По умолчанию шаблоны * и ? не соответствуют файлам, начинающимся с точки .. См. параметр :match_dot в разделе «Параметры» ниже.

Параметры

• :match_dot - (логическое значение) если false, специальные символы-маски * и ? не будут соответствовать файлам, начинающимся с точки (.). Если true, файлы, начинающиеся с . не будут обрабатываться особо. По умолчанию false.

Примеры

Представьте, что у вас есть каталог, называемый projects с тремя проектами Elixir внутри: elixir, ex_doc, и plug. Вы можете найти все .beam файлы внутри каталога ebin каждого проекта следующим образом:

Path.wildcard("projects/*/ebin/**/*.beam")

Если вы хотите искать как .beam, так и .app файлы, вы можете сделать так:

Path.wildcard("projects/*/ebin/**/*.{beam,app}")