Perl 中的 PathTools 之 File::Spec 模块详解

程序员文章站 2024-02-09 18:05:54

...

File::Spec - portably perform operations on file names

<b> status: Completed </b>

有关Perl的学习、交流与分享，请关注专题：码神之路：Perl篇

简介

这个模块是按照一定的规范设计的，使得在不同的操作系统平台上可以使用统一规范的方式在文件上执行一般常见的操作。这里所说的文件指的是文件名，而不是文件的内容或是perl中文件的句柄。比如把一些目录名和一个文件名连接成一个路径，或是判断一个路径是不是根目录。

因为这些功能对于大多数操作系统来说是不同的,所以针对每个操作系统特定的例程在一个单独的模块中:

File::Spec::Unix
File::Spec::Mac
File::Spec::OS2 
File::Spec::Win32
File::Spec::VMS

这些模块会在自己适合的操作系统中被 File::Spec 模块自动加载。因为一些模块(如vm)只能工作在他所适合的特定操作系统,所以在所有的操作系统中加载所有模块。

因为 File::Spec 模块是面相对象的，所以不能直接以子程序的方式调用，像下面这样是错误的：

File::Spec::catfile('a','b');

而是以类方法的方式像下面这样调用：

File::Spec->catfile('a','b');

在 File::Spec::Functions 模块中可以简单的以函数的方式使用这个模块中的所有类方法。

方法

canonpath 方法

$cpath = File::Spec->canonpath( $path ) ;

不在文件系统中做物理文件是否存在的验证，仅在逻辑上对文件路径进行清理。他会清除掉多余的文件分隔符和 . ，但不会对 .. 父目录做处理。如 p/x/../y 不会被处理成 p/y ；并且符号链接也不会被处理。如果你想要这些操作可以使用 Cwd 模块中的 realpath 方法在系统中的物理磁盘上做检查从而得到真实路径。

catdir 方法

$path = File::Spec->catdir( @directories );

连接两个或两个以上的目录名,形成一个完整的目录路径。生成的目录路径的结尾处是没有文件路径分隔符的，因为在所有系统里这都是不必要的，并且在 OS/2 系统中这样做会出问题；当然了如果是根目录，这个分隔符是不会被去除的。

catfile 方法

$path = File::Spec->catfile( @directories, $filename );

连接一个或多个目录与一个文件名，形成一个完整的文件路径。

curdir 方法

$curdir = File::Spec->curdir();

返回当前目录的一个字符串表示。一般是返回 . 。

devnull 方法

$devnull = File::Spec->devnull();

返回一个 null device 的字符串表示

rootdir 方法

$rootdir = File::Spec->rootdir();

返回一个根目录的字符串表示，其实返回的是当前系统的“文件路径分隔符”。

tmpdir 方法

$tmpdir = File::Spec->tmpdir();

返回临时目录列表中第一个可写目录的字符串表示。如果没有可写的临时目录，则返回当前目录。临时目录的检查依赖于特定的平台。

updir 方法

$updir = File::Spec->updir();

返回父目录的字符串表示。一般情况下返回的是 ..

no_upwards 方法

@paths = File::Spec->no_upwards( @paths );

给定一个文件名列表,剔除那些引用父目录。 (不会对符号链接做处理,只有 . , ..和与之等价的其他引用会被剔除。)
如： File::Spec->no_upwards( "a",".","b","..","c","..","d",".","e" ) 将得到列表 ("a","b","c","d","e")

case_tolerant 大小写敏感？

$is_case_tolerant = File::Spec->case_tolerant();

如果在该操作系统中目录名是大小写敏感的则返回 false,否则返回 true。

file_name_is_absolute 方法

$is_absolute = File::Spec->file_name_is_absolute( $path );

参数是一个目录或文件的路径，如果是绝对路径则返回 true ,否则返回 false

path 方法

@PATH = File::Spec->path();

不需要传参，以列表的方式返回环境变量中 PATH 的值。

join 方法

内部是调用了 catfile 方法，请参考 catfile 方法。

splitpath 方法

把一个路径分割成“盘符”，“目录”，“文件”三部分，在没有“盘符”概念的系统中，用 "" 空字符串代替盘符。

($volume,$directories,$file) = File::Spec->splitpath( $path );
($volume,$directories,$file) = File::Spec->splitpath( $path, $no_file );

系统无法分辨参数给定的路径中最后一个路径名到底是目录还是文件名，所以除非出现以下情况，系统将把最后一个路径名默认当成文件名来处理：

以文件路径分隔符结尾
以 /. 或 /.. 结尾
参数 $no_file 传的值为 true返回值中 $directories 的结尾可能有文件路径分隔符也可能没有。

返回的结果可以通过调用 catpath() 得到原来的文件路径(通常情况下与参数 $path相同)

splitdir 方法

本方法是 catdir 的逆操作

@dirs = File::Spec->splitdir( $directories );

在有“盘符”概念或在语法上区分目录和文件的系统中，$directories 必须只能包含完整路径的目录部分。

这并不是仅仅的以文件路径分隔符来分隔路径，空目录名 "" 也必须被返回，因为这在一个操作系统中是非常重要的。(根目录)

catpath 方法

splitpath 的逆操作

$full_path = File::Spec->catpath( $volume, $directory, $file );

传三个参数，分别是“盘符”，“目录”，“文件”；返回一个完整的文件路径。在类 Unix 系统中“盘符”可以传空字符串，因为你无论传什么它都会被忽略。但在其他操作系统中这个是不会被忽略的，需要传正确的参数。

abs2rel 方法

$rel_path = File::Spec->abs2rel( $path ) ;
$rel_path = File::Spec->abs2rel( $path, $base ) ;

如果 $base 是当前路径或 ""(空目录),将会使用 Cwd::cwd 得到一个绝对路径。如果 $base 是相对路径，将会调用 rel2abs()得到一个绝对路径；也就是说这个路径也是相对于 Cwd::cwd的。

在有“盘符”概念的系统中，如果 $base 和 $path是基于两上不同的“盘符”的，我们不会尝试去解析，而是直接返回 $path。需要注意的是，在之前的版本中是会忽略 $base 中的“盘符”的，所以会返回错误的结果。

拥有文件名语法的系统中，请忽略 $base 中的文件名，因为所有的路径内容都被当成目录名看待。

如果 $base 是相对路径，将会调用 rel2abs()得到一个绝对路径；也就是说这个路径也是相对于 Cwd::cwd的。

这个方法不会去检查系统中的文件系统来验证路径的真实性。

rel2abs 方法

把一个相对路径转换成一个绝对路径

$abs_path = File::Spec->rel2abs( $path ) ;
$abs_path = File::Spec->rel2abs( $path, $base ) ;

有拥有文件名语法的系统中，请忽略 $base 中的文件名，因为所有的路径内容都被当成目录名看待。

如果 $base 是相对路径，将会调用 rel2abs()得到一个绝对路径；也就是说这个路径也是相对于 Cwd::cwd的。

如果 $path 是一个绝对路径，将会调用 canonpath 清理后返回。

这个方法不会去检查系统中的文件系统来验证路径的真实性。

Perl 中的 PathTools 之 File::Spec 模块详解

简介

方法

canonpath 方法

catdir 方法

catfile 方法

curdir 方法

devnull 方法

rootdir 方法

tmpdir 方法

updir 方法

no_upwards 方法

case_tolerant 大小写敏感？

file_name_is_absolute 方法

path 方法

join 方法

splitpath 方法

splitdir 方法

catpath 方法

abs2rel 方法

rel2abs 方法

相关文章推荐

Perl 中的 PathTools 之 File::Spec 模块详解

python中的时间处理模块(二)：datetime模块之time类详解