package path

import "path"

Package path 实现了用于操作以斜杠分隔的路径的实用例程。

path 包只应用于以正斜杠分隔的路径,例如 URL 中的路径。本包不处理 带盘符或反斜杠的 Windows 路径;要操作 操作系统路径,请使用 path/filepath 包。

Index

Examples

Variables

var ErrBadPattern = errors.New("syntax error in pattern")

ErrBadPattern 表示模式格式错误。

Functions

func Base

func Base(path string) string

Base 返回 path 的最后一个元素。 在提取最后一个元素之前会移除尾部斜杠。 如果 path 为空,Base 返回 "."。 如果 path 完全由斜杠组成,Base 返回 "/"。

Example
package main

import (
	"fmt"
	"path"
)

func main() {
	fmt.Println(path.Base("/a/b"))
	fmt.Println(path.Base("/"))
	fmt.Println(path.Base(""))
}

Output:

b
/
.

func Clean

func Clean(path string) string

Clean 通过纯粹的词法处理返回与 path 等价的最短路径名。 它迭代地应用以下规则,直到无法再做进一步处理:

  1. 将多个斜杠替换为单个斜杠。
  2. 消除每个 . 路径名元素(当前目录)。
  3. 消除每个内部的 .. 路径名元素(父目录) 以及位于它前面的非 .. 元素。
  4. 消除位于有根路径开头的 .. 元素: 即,将路径开头的 "/.." 替换为 "/"。

返回的路径只有在它是根 "/" 时才以斜杠结尾。

如果此过程的结果是空字符串,Clean 返回字符串 "."。

另见 Rob Pike, “Lexical File Names in Plan 9 or Getting Dot-Dot Right,” https://9p.io/sys/doc/lexnames.html

Example
package main

import (
	"fmt"
	"path"
)

func main() {
	paths := []string{
		"a/c",
		"a//c",
		"a/c/.",
		"a/c/b/..",
		"../a/c",
		"../a/b/../././/c",
		"/../a/c",
		"/../a/b/../././/c",
		"",
	}

	for _, p := range paths {
		fmt.Printf("Clean(%q) = %q\n", p, path.Clean(p))
	}

}

Output:

Clean("a/c") = "a/c"
Clean("a//c") = "a/c"
Clean("a/c/.") = "a/c"
Clean("a/c/b/..") = "a/c"
Clean("../a/c") = "../a/c"
Clean("../a/b/../././/c") = "../a/c"
Clean("/../a/c") = "/a/c"
Clean("/../a/b/../././/c") = "/a/c"
Clean("") = "."

func Dir

func Dir(path string) string

Dir 返回 path 中除最后一个元素外的所有部分,通常就是 path 的目录。 在使用 Split 去掉最后一个元素后,会对 path 进行 Clean 并移除尾部斜杠。 如果 path 为空,Dir 返回 "."。 如果 path 完全由斜杠后跟非斜杠字节组成,Dir 返回单个斜杠。在任何其他情况下,返回的路径都不以 斜杠结尾。

Example
package main

import (
	"fmt"
	"path"
)

func main() {
	fmt.Println(path.Dir("/a/b/c"))
	fmt.Println(path.Dir("a/b/c"))
	fmt.Println(path.Dir("/a/"))
	fmt.Println(path.Dir("a/"))
	fmt.Println(path.Dir("/"))
	fmt.Println(path.Dir(""))
}

Output:

/a/b
a/b
/a
a
/
.

func Ext

func Ext(path string) string

Ext 返回 path 所使用的文件名扩展名。 扩展名是从 path 中最后一个以斜杠分隔的元素里 最后一个点开始的后缀; 如果没有点,则为空。

Example
package main

import (
	"fmt"
	"path"
)

func main() {
	fmt.Println(path.Ext("/a/b/c/bar.css"))
	fmt.Println(path.Ext("/"))
	fmt.Println(path.Ext(""))
}

Output:

.css

func IsAbs

func IsAbs(path string) bool

IsAbs 报告 path 是否为绝对路径。

Example
package main

import (
	"fmt"
	"path"
)

func main() {
	fmt.Println(path.IsAbs("/dev/null"))
}

Output:

true

func Join

func Join(elem ...string) string

Join 将任意数量的路径元素连接为单个路径, 用斜杠分隔它们。空元素会被忽略。 结果会被 Clean。然而,如果参数列表为空 或其所有元素都为空,Join 返回 空字符串。

Example
package main

import (
	"fmt"
	"path"
)

func main() {
	fmt.Println(path.Join("a", "b", "c"))
	fmt.Println(path.Join("a", "b/c"))
	fmt.Println(path.Join("a/b", "c"))

	fmt.Println(path.Join("a/b", "../../../xyz"))

	fmt.Println(path.Join("", ""))
	fmt.Println(path.Join("a", ""))
	fmt.Println(path.Join("", "a"))

}

Output:

a/b/c
a/b/c
a/b/c
../xyz

a
a

func Match

func Match(pattern, name string) (matched bool, err error)

Match 报告 name 是否匹配 shell 模式。 模式语法为:

pattern:
	{ term }
term:
	'*'         匹配任意非 / 字符序列
	'?'         匹配任意单个非 / 字符
	'[' [ '^' ] { character-range } ']'
	            字符类(必须非空)
	c           匹配字符 c (c != '*', '?', '\\', '[')
	'\\' c      匹配字符 c

character-range:
	c           匹配字符 c (c != '\\', '-', ']')
	'\\' c      匹配字符 c
	lo '-' hi   对于 lo <= c <= hi 匹配字符 c

Match 要求 pattern 匹配整个 name,而不仅仅是子串。 唯一可能返回的错误是 ErrBadPattern,当 pattern 格式错误时。

Example
package main

import (
	"fmt"
	"path"
)

func main() {
	fmt.Println(path.Match("abc", "abc"))
	fmt.Println(path.Match("a*", "abc"))
	fmt.Println(path.Match("a*/b", "a/c/b"))
}

Output:

true <nil>
true <nil>
false <nil>

func Split

func Split(path string) (dir, file string)

Split 在最后一个斜杠之后立即拆分 path, 将其分为目录和文件名两部分。 如果 path 中没有斜杠,Split 返回空 dir, 并将 file 设为 path。 返回值具有 path = dir+file 的性质。

Example
package main

import (
	"fmt"
	"path"
)

func main() {
	split := func(s string) {
		dir, file := path.Split(s)
		fmt.Printf("path.Split(%q) = dir: %q, file: %q\n", s, dir, file)
	}
	split("static/myfile.css")
	split("myfile.css")
	split("")
}

Output:

path.Split("static/myfile.css") = dir: "static/", file: "myfile.css"
path.Split("myfile.css") = dir: "", file: "myfile.css"
path.Split("") = dir: "", file: ""

Directories

filepath Package filepath 实现了以与目标操作系统定义的文件路径 相兼容的方式操作文件名路径的实用例程。