Path

@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()) :: binary()

Создаёт путь от relative_to до path.

Если path уже является абсолютным путём, relative_to игнорируется. См. также relative_to/2.

В отличие от 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()) :: binary()

Возвращает прямой относительный путь от path относительно from.

Другими словами, эта функция пытается удалить префикс from из path.

Эта функция не обращается к файловой системе, поэтому предполагает отсутствие символических ссылок между путями.

В случае, если прямой относительный путь не найден, возвращает исходный путь.

Примеры

iex> Path.relative_to("/usr/local/foo", "/usr/local")
"foo"

iex> Path.relative_to("/usr/local/foo", "/")
"usr/local/foo"

iex> Path.relative_to("/usr/local/foo", "/etc")
"/usr/local/foo"

iex> Path.relative_to("/usr/local/foo", "/usr/local/foo")
"."

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

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

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

@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()) :: {:ok, binary()} | :error

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

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

Примеры

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

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

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

iex> Path.safe_relative("/usr/local")
:error

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

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

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

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

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

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

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

Примеры

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

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

iex> Path.safe_relative_to("my_dep/../..", "deps")
:error

iex> Path.safe_relative_to("/usr/local", ".")
:error

@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}")