Путь

Этот модуль предоставляет удобные средства для работы с или получения путей к файлам.

Функции в этом модуле могут принимать данные в виде символов (т. е. строка или список символов / строка) в качестве аргумента и всегда возвращают строку (кодированную в UTF-8).

Большинство функций в этом модуле не взаимодействуют с файловой системой, за исключением нескольких функций, которые требуют этого (например, wildcard/2 и expand/1).

Обзор

Типы

t()

Функции

absname(path)

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

absname(path, relative_to)

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

basename(path)

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

basename(path, extension)

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

dirname(path)

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

expand(path)

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

expand(path, relative_to)

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

extname(path)

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

join(list)

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

join(left, right)

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

relative(name)

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

relative_to(path, from)

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

relative_to_cwd(path)

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

rootname(path)

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

rootname(path, extension)

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

split(path)

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

type(name)

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

wildcard(glob, opts \\ [])

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

Типы

t()

t() :: IO.chardata()

Функции

absname(path)

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"

absname(path, relative_to)

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"

basename(path)

basename(t()) :: binary()

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

Примеры

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

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

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

basename(path, extension)

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"

dirname(path)

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"

expand(path)

expand(t()) :: binary()

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

Примеры

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

expand(path, relative_to)

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"

extname(path)

extname(t()) :: binary()

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

Примеры

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

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

join(list)

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

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

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

Примеры

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

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

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

join(left, right)

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"

relative(name)

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"

relative_to(path, from)

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"

relative_to_cwd(path)

relative_to_cwd(t()) :: binary()

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

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

rootname(path)

rootname(t()) :: binary()

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

Примеры

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

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

rootname(path, extension)

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"

split(path)

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

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

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

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

Примеры

iex> Path.split("")
[]

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

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

type(name)

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

wildcard(glob, opts \\ [])

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

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

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

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

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

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

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

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

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

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

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

Параметры

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

Примеры

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

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

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

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