Путь
Этот модуль предоставляет удобства для манипулирования или получения путей к файлам в системе.
Функции в этом модуле могут принимать в качестве аргумента строку (т.е. строку или список символов / строк) и всегда возвращают строку (кодированную в UTF-8).
Большинство функций в этом модуле не взаимодействуют с файловой системой, за исключением нескольких функций, для которых это необходимо (например, wildcard/2 и expand/1).
Обзор
Типы
Функции
- 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()
Specs
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"
iex> Path.dirname("bar.ex")
"." 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- (булево) еслиfalse, специальные символы подстановки*и?не будут соответствовать файлам, начинающимся с точки (.). Еслиtrue, файлы, начинающиеся с.не будут обрабатываться особым образом. По умолчаниюfalse.
Примеры
Представьте, что у вас есть каталог под названием projects с тремя проектами Elixir внутри: elixir, ex_doc, и plug. Вы можете найти все .beam файлы внутри каталога ebin каждого проекта следующим образом:
Path.wildcard("projects/*/ebin/**/*.beam") Если вы хотите искать как .beam-, так и .app-файлы, вы можете сделать следующее:
Path.wildcard("projects/*/ebin/**/*.{beam,app}")
© 2012 Plataformatec
Licensed under the Apache License, Version 2.0.
https://hexdocs.pm/elixir/1.9.4/Path.html