123456789_123456789_123456789_123456789_123456789_

Class: Pathname

Overview

A Pathname object stores a string:

pn = Pathname('README.md') # => #<Pathname:README.md>
pn.to_s                    # => "README.md"

The string is usually an actual or potential path to an entry in the filesystem:

Pathname('lib')            # =>  #<Pathname:lib>        # Relative path.
Pathname('/usr/lib')       # => #<Pathname:/usr/lib>    # Absolute path.
Pathname('nosuch/foo')     # => #<Pathname:nosuch/foo>  # Need not exist.
Pathname('!@#$%^&*()')     # => #<Pathname:!@#$%^&*()>  # Need not be a valid path.

Through its many instance methods, the pathname object provides a consistent and convenient interface to numerous methods in other classes and modules:

  • Wraps almost all methods in class ::File and module ::FileTest.
  • Wraps some methods in class ::Dir and module FileUtils.

Advantages of using a pathname instead of these others:

  • You don't have to know which class or module has which methods.
  • You don't have to keep typing the class name and path variable.

Without pathnames:

filepath = 'README.md'
File.exist?(filepath)    # => true
File.file?(filepath)     # => true
File.writable?(filepath) # => true
dirpath = 'tempdir'
Dir.mkdir(dirpath)
Dir.rmdir(dirpath)

With pathnames:

pn = Pathname('README.md')
pn.exist?    # => true
pn.file?     # => true
pn.writable? # => true
pn = Pathname('tempdir')
pn.mkdir
pn.rmdir

In addition to its wrapper methods, Pathname has certain "core" methods that are not simple wrappers:

Of particular interest may be #cleanpath, which reduces a "noisy" path to a simpler form.

Some pathname methods return pathnames, which may be chained:

Pathname("/usr")
.join("local")
.join("bin")
.exist?
# => true

A Pathname object is immutable (except for method #freeze).

About the Examples

Many examples here use these variables:

English text with newlines.

text = <<~EOT First line Second line

Fourth line
Fifth line

EOT

Japanese text.

japanese = 'こんにちは'

Binary data.

data = "\u9990\u9991\u9992\u9993\u9994"

Text file.

File.write('t.txt', text)

::File with Japanese text.

File.write('t.ja', japanese)

::File with binary data.

f = File.new('t.dat', 'wb:UTF-16') f.write(data) f.close

What's Here

First, what's elsewhere. ::Class Pathname:

Here, class Pathname provides methods that are useful for:

Creating

  • .getwd (aliased as .pwd): Returns a new Pathname object containing the path to the current working directory.
  • .mktmpdir: Creates a Pathname object containing the path to a new temporary directory; returns it or passes it to the block.
  • .new: Returns a new Pathname object based on the given path.

Querying

  • .glob: Selects filesystem entries; creates a pathname for each; returns them or passes them to the block.
  • #absolute?: Returns whether self contains an absolute path.
  • #blockdev?: Returns whether the entry at the path in self is a block device. (i.e., a direct-access device).
  • #chardev?: Returns whether entry at the path in self is a character device. (i.e., a sequential-access device).
  • #directory?: Returns whether the entry at the path in self is a directory.
  • #empty?: Returns whether the entry at the path in self exists and is empty.
  • #entries: Returns an array of pathnames, one for each entry in the directory at the path in self.
  • #executable?: Returns whether the entry at the path in self is executable.
  • #executable_real?: Returns whether the entry at the path in self is executable by the real user and group id of the current process.
  • #exist?: Returns whether the entry at the path in self exists.
  • #extname: Returns the filename extension of self.
  • #file?: Returns whether the entry at the path in self exists and is a regular file.
  • #find: Performs a depth-first traversal of the path in self; calls the block with each found path.
  • #fnmatch: Returns whether the given pattern matches against the path in self.
  • #fnmatch?: Same as #fnmatch.
  • #ftype: Returns the string type of the entry at the path in self.
  • #glob: Finds entries and returns or yields pathnames.
  • #grpowned?: Returns whether the entry for the path in self exists, and the effective group id of the calling process is the owner of the entry.
  • #lstat: Returns a File::Stat entry for the path in self, but does not follow symbolic links, and therefore returns the stat object for the entry at the path in self.
  • #mountpoint?: Returns whether the entry at the path in self is a mountpoint.
  • #owned?: Returns whether the entry at the path in self exists and is owned by the user of the current process.
  • #parent: Returns a new pathname containing the path to the parent directory of the entry in self.
  • #pipe?: Returns whether the entry at the path in self is a pipe.
  • #readable?: Returns whether the entry at the path in self is readable by the owner and group of the current process.
  • #readable_real?: Like readable?, but checks against the real user and group ids instead of the effective ids.
  • #relative?: Returns whether self contains a relative path.
  • #root?: Returns whether the entry at the path in self is a root directory.
  • #setgid?: Returns whether the setgid bit is set in the permissions for the entry at the path in self.
  • #setuid?: Returns whether the setuid bit is set in the permissions for the entry at the path in self.
  • #size: Returns the size of the entry at the path in self.
  • #size?: Returns the size of the entry at the path in self if the entry exists and has non-zero size; nil otherwise.
  • #socket?: Returns whether the entry at the path in self is a socket.
  • #split: Returns a 2-element array containing the #dirname and #basename of the path in self.
  • #stat: Returns a File::Stat object for the entry at the path in self.
  • #sticky?: Returns whether the sticky bit is set for the entry at the path in self.
  • #symlink?: Returns whether the entry at the path in self is a symbolic link.
  • #world_readable?: If the entry at the path in self is readable by others, returns the integer permissions for the entry.
  • #world_writable?: If the entry at the path in self is writable by others, returns the integer permissions for the entry.
  • #writable?: Returns whether the file entry at the path in self is writable by the effective user and group id of this process.
  • #writable_real?: Like #writable?, but checks against the real user and group ids instead of the effective ids.
  • #zero?: Returns whether the entry at the path in self exists and has size zero.

Comparing

  • #<=>: Compares the contents of self and the given object as strings.
  • #== (aliased as #=== and #eql?): Returns whether the paths in self and the given object are equal.

Analyzing

  • #ascend: Yields self to the block, then yields a new pathname for each successive dirname in the path in self.
  • #basename: Returns all or part of the last component of the path in self.
  • #children: Returns an array of pathnames, each containing the path to a child of the entry at the path in self.
  • #descend: Yields to the block a new pathname for each successive dirname in the path in self.
  • #dirname: Returns all but the last component of the path in self.
  • #each_filename: Calls the block with each component of the path in self.

Converting

  • #+ (aliased as #/): Returns a new Pathname object based on the content of self and the given object.
  • #cleanpath: Returns a new pathname, “cleaned” of unnecessary separators, single-dot entries, and double-dot entries.
  • #expand_path: Returns a new pathname containing the absolute path for self.
  • #join: Joins the string-converted given objects to the string path in self; returns the joined string as a pathname.
  • #readlink: Returns a new pathname containing the path to the entry referenced by self.
  • #realdirpath: Returns a new pathname containing the real (absolute) path of the directory entry at the path in self.
  • #realpath: Returns a new pathname containing the real (absolute) path of the file entry at the path in self.
  • #relative_path_from: Returns a new pathname containing the relative path from the given directory path to the path in self.
  • #sub: Returns a new pathname whose path is the path in self, after specified substitutions.
  • #sub_ext: Returns a new pathname whose path is the path in self, after specified changes.
  • #to_s (aliased as #to_path): Returns a copy of the path in self.

Ownership and Permissions

  • #chmod: Changes the mode (i.e., permissions) of the entry at the path in self.
  • #chown: Changes the owner and group of an entry (directory or file).
  • #lchmod: Like #chmod, but does not follow symbolic links, and therefore changes the mode of the entry at the path in self.
  • #lchown: Like #chown, but does not follow symbolic links, and therefore changes the ownership of the entry at the path in self.

Reading and Writing

  • #binread: Behaves like #read, except that the file is opened in binary mode with ASCII-8BIT encoding.
  • #binwrite: Behaves like #write, except that the file is opened in binary mode with ASCII-8BIT encoding.
  • #make_link: Creates a new entry at the path in self for the existing entry at path using a hard link.
  • #make_symlink: Creates a symbolic link at the path in self to the entry at path.
  • #mkdir: Creates a directory entry at the path in self.
  • #mkpath: Creates a directory entry at the path in self; creates intermediate directories as needed.
  • #open: Opens the file at the entry in self for reading or writing.
  • #opendir: Creates and opens a Dir object for the directory at the path in self; either returns the Dir object or calls the block with it.
  • #read: Reads and returns some or all of the content of the file entry at the path in self.
  • #readlines: Returns an array of all lines read from file entry at the path in self.
  • #rename: Renames the entry at the path in self.
  • #rmdir: Deletes the directory entry at the path in self.
  • #rmtree: Deletes the entire filetree at the path in self.
  • #sysopen: Opens the file at the path in self; returns the integer file descriptor.
  • #truncate: Adjusts the size of file at the path in self to the given size.
  • #unlink (aliased as #delete): Removes the entry at the path in self.
  • #write: Opens the file at the entry at the path in self, writes given data to it, and closes the file.

Times

  • #atime: Returns the access time of the entry at the path in self.
  • #birthtime: Returns the birth time of the entry at the path in self.
  • #ctime: On Windows, returns the birthtime. On other systems, returns a new Time object containing the time of the most recent metadata change to the entry at the path in self.
  • #lutime: Like Pathname#utime, but does not follow symbolic links, and therefore changes the times of the entry at the path in self.
  • #mtime: Returns a Time object containing the time of the most recent modification to the entry at the path in self.
  • #utime: For the entry at the path in self, updates its access time and its modification time to the given times.

Iterating

  • #each_child: Calls the block with a new pathname for each child of the entry at the path in self.
  • #each_entry: Calls the block with a new pathname for each entry in the entry at the path in self.
  • #each_line: Calls the block with each line from the file at the path in self.

Other

  • #freeze: Freezes self, preventing further modifications.

Constant Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(path) ⇒ Pathname

Returns a new Pathname object based on the given #path, via File.path(path).dup. the #path may be a ::String, a ::File, a ::Dir, or another Pathname; see File.path:

Pathname.new('.')               # => #<Pathname:.>
Pathname.new('/usr/bin')        # => #<Pathname:/usr/bin>
Pathname.new(File.new('LEGAL')) # => #<Pathname:LEGAL>
Pathname.new(Dir.new('.'))      # => #<Pathname:.>
Pathname.new(Pathname.new('.')) # => #<Pathname:.>
[ GitHub ]

  
# File 'pathname_builtin.rb', line 385

def initialize(path)
  @path = File.path(path).dup
rescue TypeError => e
  raise e.class, "Pathname.new requires a String, #to_path or #to_str", cause: nil
end

Class Method Details

.pwd

[ GitHub ]

  
# File 'pathname_builtin.rb', line 2838

alias pwd getwd

Instance Attribute Details

#absolute? ⇒ Boolean (readonly)

Returns whether self contains an absolute path:

Pathname('/home').absolute? # => true
Pathname('lib').absolute?   # => false

The result is OS-dependent for some paths:

Pathname('C:/').absolute?   # => true   # On Windows.
Pathname('C:/').absolute?   # => false  # Elsewhere.
[ GitHub ]

  
# File 'pathname.c', line 245

static VALUE
path_absolute_p(VALUE self)
{
    VALUE path = get_strpath(self);
    const char *ptr = RSTRING_PTR(path);
    rb_len_t len = RSTRING_LEN(path);
    if (len < 1) return Qfalse;
    if (drive_letter) {
        if (len >= 2 && ISALPHA(ptr[0]) && (ptr[1] == ':')) return Qtrue;
    }
    return RBOOL(isdirsep(ptr[0]));
}

#empty? ⇒ Boolean (readonly)

Returns whether the entry represented by self exists and is empty:

dir_pn = Pathname('example_dir')
dir_pn.empty?  # => false  # Dir does not exist.
dir_pn.mkdir
dir_pn.empty?  # => true   # Dir exists and is empty.

file_pn = Pathname('example_dir/example.txt')
file_pn.empty? # => false  # File does not exist.
file_pn.write('')
file_pn.empty? # => true   # File exists and is empty.
dir_pn.empty?  # => false  # Dir exists and is not empty.
file_pn.write('foo')
file_pn.empty? # => false  # File exists and is not empty.

file_pn.delete
dir_pn.delete
[ GitHub ]

  
# File 'pathname_builtin.rb', line 2330

def empty?
  if FileTest.directory?(@path)
    Dir.empty?(@path)
  else
    File.empty?(@path)
  end
end

#mountpoint? ⇒ Boolean (readonly)

Returns whether entry at the path in self is a mountpoint:

Pathname('/').mountpoint?      # => true
Pathname('/etc').mountpoint?   # => false
Pathname('nosuch').mountpoint? # => false
[ GitHub ]

  
# File 'pathname_builtin.rb', line 725

def mountpoint?
  begin
    stat1 = self.lstat
    stat2 = self.parent.lstat
    stat1.dev != stat2.dev || stat1.ino == stat2.ino
  rescue Errno::ENOENT
    false
  end
end

#path (readonly, protected)

This method is for internal use only.
[ GitHub ]

  
# File 'pathname_builtin.rb', line 366

attr_reader :path

#relative? ⇒ Boolean (readonly)

Returns whether self contains a relative path:

Pathname('lib').relative?   # => true
Pathname('/home').relative? # => false

The result is OS-dependent for some paths:

Pathname('C:/').relative?   # => false # On Windows.
Pathname('C:/').relative?   # => true  # Elsewhere.
[ GitHub ]

  
# File 'pathname_builtin.rb', line 754

def relative?
  !absolute?
end

#root? ⇒ Boolean (readonly)

Returns whether the path in self points to a root directory.

On a non-Windows system, a root directory path is one whose name begins with one or more slash characters (`'/'):

Pathname('/').root?       # => true
Pathname('////').root?    # => true
Pathname('/usr').root?    # => false
Pathname('foo').root?     # => false

Does not resolve dot directories:

Pathname('/usr/.').root?  # => false
Pathname('/usr/..').root? # => false

On a Windows system, a root directory path is one whose name begins as above, or with a device letter followed by a colon character (':') and one or more slash characters (`'/'):

Pathname('/').root?      # => true
Pathname('////').root?   # => true
Pathname('C:/').root?    # => true
Pathname('C:////').root? # => true
Pathname('c:/').root?    # => true
Pathname('H:/').root?    # => true
Pathname('C:/m').root?   # => false
Pathname('C:').root?     # => false
[ GitHub ]

  
# File 'pathname.c', line 219

static VALUE
path_root_p(VALUE self)
{
    VALUE path = get_strpath(self);
    if (RSTRING_LEN(path) == 0) return Qfalse;
    const char *ptr = RSTRING_PTR(path), *end = RSTRING_END(path);
    rb_encoding *enc = rb_enc_get(path);
    const char *base = rb_enc_path_skip_prefix_root(ptr, end, enc);
    return RBOOL(base == end);
}

Instance Method Details

#+(other) ⇒ Pathname Also known as: #/

Returns a new Pathname object based on the content of self and other; argument other may be a ::String, a ::File, a ::Dir, or another Pathname:

pn = Pathname('foo')     # => #<Pathname:foo>
pn + 'bar'               # => #<Pathname:foo/bar>
pn + File.new('LEGAL')   # => #<Pathname:foo/LEGAL>
pn + Dir.new('lib')      # => #<Pathname:foo/lib>
pn + Pathname('bar')     # => #<Pathname:foo/bar>

When other specifies a relative path (see #relative?), it is combined with self to form a new pathname:

Pathname('/a/b') + 'c' # => #<Pathname:/a/b/c>

Extra component separators ('/') are removed:

Pathname('/a/b/') + 'c' # => #<Pathname:/a/b/c>

Extra current-directory components ('.') are removed:

Pathname('a') + '.' # => #<Pathname:a>
Pathname('.') + 'a' # => #<Pathname:a>
Pathname('.') + '.' # => #<Pathname:.>

Parent-directory components ('..') are:

  • Resolved, when possible:

    Pathname('a')      + '..'      # => #<Pathname:.>
    Pathname('a/b')    + '..'      # => #<Pathname:a>
    Pathname('/')      + '../a'    # => #<Pathname:/a>
    Pathname('a')      + '../b'    # => #<Pathname:b>
    Pathname('a/b')    + '../c'    # => #<Pathname:a/c>
    Pathname('a//b/c') + '../d//e' # => #<Pathname:a//b/d//e>
  • Removed, when not needed:

    Pathname('/') + '..' # => #<Pathname:/>
  • Retained, when needed:

    Pathname('..') + '..'   # => #<Pathname:../..>
    Pathname('..') + '../a' # => #<Pathname:../../a>

When other specifies an absolute path (see #absolute?), equivalent to Pathname(other.to_s):

Pathname('/a') + '/b/c' # => #<Pathname:/b/c>

Occurrences of '/', '.', and '..' are preserved:

Pathname('/a') + '//b//c/./../d' # => #<Pathname://b//c/./../d>

This method does not access the file system, so other need not represent an existing (or even a valid) file or directory path:

Pathname('/var') + 'nosuch:ever' # => #<Pathname:/var/nosuch:ever>
[ GitHub ]

  
# File 'pathname_builtin.rb', line 909

def +(other)
  other = Pathname.new(other) unless Pathname === other
  Pathname.new(plus(@path, other.path))
end

#/(other)

Alias for #+.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 913

alias / +

#<=>(other) ⇒ 1, ...

Compares the contents of self and other as strings; see String#<=>.

Returns:

  • -1 if self's string is smaller than other's string.
  • 0 if the two are equal.
  • 1 if self's string is larger than other's string.
  • nil if other is not a Pathname.

Examples:

Pathname('a')  <=> Pathname('b')  # => -1
Pathname('a')  <=> Pathname('ab') # => -1
Pathname('a')  <=> Pathname('a')  # => 0
Pathname('b')  <=> Pathname('a')  # => 1
Pathname('ab') <=> Pathname('a')  # => 1
Pathname('ab') <=> 'a'            # => nil

Two pathnames that are different may refer to the same entry in the filesystem:

Pathname('lib') <=> Pathname('./lib') # => 1
[ GitHub ]

  
# File 'pathname.c', line 68

static VALUE
path_cmp(VALUE self, VALUE other)
{
    VALUE s1, s2;
    char *p1, *p2;
    char *e1, *e2;
    if (!rb_obj_is_kind_of(other, rb_cPathname))
        return Qnil;
    s1 = get_strpath(self);
    s2 = get_strpath(other);
    p1 = RSTRING_PTR(s1);
    p2 = RSTRING_PTR(s2);
    e1 = p1 + RSTRING_LEN(s1);
    e2 = p2 + RSTRING_LEN(s2);
    while (p1 < e1 && p2 < e2) {
        int c1, c2;
        c1 = (unsigned char)*p1++;
        c2 = (unsigned char)*p2++;
        if (c1 == '/') c1 = '\0';
        if (c2 == '/') c2 = '\0';
        if (c1 != c2) {
            if (c1 < c2)
                return INT2FIX(-1);
            else
                return INT2FIX(1);
        }
    }
    if (p1 < e1)
        return INT2FIX(1);
    if (p2 < e2)
        return INT2FIX(-1);
    return INT2FIX(0);
}

#==(other) ⇒ Boolean Also known as: #===, #eql?

Returns whether the stored paths in self and other are equal:

pn = Pathname('lib')
pn == Pathname('lib')   # => true
pn == Pathname('./lib') # => false

Returns false if other is not a pathname:

pn == 'lib'             # => false
[ GitHub ]

  
# File 'pathname_builtin.rb', line 415

def ==(other)
  return false unless Pathname === other
  other.path == @path
end

#===(other)

Alias for #==.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 419

alias === ==

#add_trailing_separator(path) (private)

add_trailing_separator(path) -> path

[ GitHub ]

  
# File 'pathname.c', line 371

static VALUE
add_trailing_separator(VALUE self, VALUE path)
{
    if (RSTRING_LEN(check_strpath(path)) <= 0) return path;
    rb_encoding *enc = rb_enc_get(path);
    const char *name = RSTRING_PTR(path);
    const char *end = RSTRING_END(path);
    const char *top = rb_enc_path_skip_prefix(name, end, enc);
    if (top < end && isdirsep(end[-1])) {
        if (end[-1] == '/' || rb_enc_prev_char(top, end, end, enc) == end - 1)
            return path;
    }
    return rb_str_cat_cstr(rb_str_dup(path), "/");
}

#ascend {|entry| ... } ⇒ nil #ascend ⇒ Enumerator

With a block given, yields self, then a new pathname for each successive dirname in the stored path; see File.dirname:

Pathname('/path/to/some/file.rb').ascend {|dirname| p dirname}
#<Pathname:/path/to/some/file.rb>
#<Pathname:/path/to/some>
#<Pathname:/path/to>
#<Pathname:/path>
#<Pathname:/>

With no block given, returns a new ::Enumerator.

Yields:

  • (_self)

Yield Parameters:

  • _self (Pathname) —

    the object that the method was called on

[ GitHub ]

  
# File 'pathname_builtin.rb', line 837

def ascend
  return to_enum(__method__) unless block_given?
  path = @path
  yield self
  while r = chop_basename(path)
    path, = r
    break if path.empty?
    yield self.class.new(del_trailing_separator(path))
  end
end

#atime ⇒ Time

Returns a new ::Time object containing the access time of the entry at the path in self, as reported by the filesystem; see File System Access Time.

For a file, the access time is established when the file is created, and may be updated with the file content is read:

filepath = '/tmp/t.tmp'
pn = Pathname(filepath)
pn.atime        # Raises Errno::ENOENT: No such file or directory.
pn.write('foo') # Establishes access time.
pn.atime        # => 2026-10-04 15:15:10.628255551 -0500
pn.read         # Updates access time.
pn.atime        # => 2026-10-04 15:15:19.770249225 -0500
pn.delete       # Clean up.

For a directory, the access time is established when the directory is created, and may be updated when its entries are read:

dirpath = '/tmp/dir'
pn = Pathname(dirpath)
pn.atime   # Raises Errno::ENOENT: No such file or directory.
pn.mkdir   # Establishes access time.
pn.atime   # => 2026-10-04 15:19:49.957848452 -0500
pn.entries # Updates access time.
pn.atime   # => 2026-10-04 15:20:05.677814625 -0500
pn.delete  # Clean up.
[ GitHub ]

  
# File 'pathname_builtin.rb', line 1403

def atime() File.atime(@path) end

#basename(path, suffix = '') ⇒ Pathname

Returns a new Pathname object containing all or part of the last entry of the path represented by self. Entries are delimited by the value of constant File::SEPARATOR and, if non-nil, the value of constant File::ALT_SEPARATOR.

When suffix is the empty string '', returns all of the last entry:

Pathname.new('foo/bar/baz/bat.txt').basename # => #<Pathname:bat.txt>
Pathname.new('foo/bar/baz').basename         # => #<Pathname:baz>

File::SEPARATOR                              # => "/"
Pathname.new('foo/bar.txt////').basename     # => #<Pathname:bar.txt>
File::ALT_SEPARATOR # => "\\"                # On Windows.
Pathname.new('foo/bar.txt//\\\\//').basename # => #<Pathname:bar.txt>

When suffix is '.*', the last filename extension, if any, is removed:

Pathname.new('foo/bar.txt').basename('.*')     # => #<Pathname:bar>
Pathname.new('foo/bar.txt.old').basename('.*') # => #<Pathname:bar.txt>
Pathname.new('foo/bar').basename('.*')         # => #<Pathname:bar>

When suffix is any string other than '' or '.*', the matching trailing substring, if any, is removed:

Pathname.new('foo/bar.txt').basename('.txt') # => #<Pathname:bar>
Pathname.new('foo/bar.txt').basename('txt')  # => #<Pathname:bar.>
Pathname.new('foo/bar.txt').basename('*')    # => #<Pathname:bar.txt>
Pathname.new('foo/bar.txt').basename('.')    # => #<Pathname:bar.txt>
[ GitHub ]

  
# File 'pathname_builtin.rb', line 2086

def basename(...) self.class.new(File.basename(@path, ...)) end

#binread(length = nil, offset = 0) ⇒ String?

Behaves like #read, except that the file is opened in binary mode with ASCII-8BIT encoding.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1238

def binread(...) File.binread(@path, ...) end

#binwrite(string, offset = 0, **opts) ⇒ nonnegative_integer

Behaves like #write, except that the file is opened in binary mode with ASCII-8BIT encoding.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1364

def binwrite(...) File.binwrite(@path, ...) end

#birthtime ⇒ Time

Returns a new ::Time object containing the creation time of the entry at the path in self; seeFile System Timestamps:

filepath = '/tmp/t.tmp'
pn = Pathname(filepath)
pn.birthtime # Raises Errno::ENOENT: No such file or directory.
pn.write('foo')
pn.birthtime # => 2026-10-05 13:45:54.459480484 -0500
pn.delete    # Clean up.
[ GitHub ]

  
# File 'pathname_builtin.rb', line 1423

def birthtime() File.birthtime(@path) end

#blockdev? ⇒ Boolean

Returns whether the path in self points to a block device (i.e., a direct-access device):

Pathname('/dev/nvme0n1').blockdev? # => true
Pathname('/dev/loop0').blockdev?   # => true
Pathname('/dev/tty').blockdev?     # => false
Pathname('/dev/null').blockdev?    # => false
Pathname('nosuch').blockdev?       # => false
Pathname($stdin).blockdev?         # => false

The returned value is filesystem-dependent; returns false on Windows or MacOS.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 2283

def blockdev?() FileTest.blockdev?(@path) end

#chardev? ⇒ Boolean

Returns whether self represents a path to a character device (i.e., a sequential-access device):

Pathname('/dev/tty').chardev?     # => true
Pathname('/dev/null').chardev?    # => true
Pathname('/dev/nvme0n1').chardev? # => false
Pathname('/dev/loop0').chardev?   # => false
Pathname($stdin).chardev?         # => false
Pathname('nosuch').chardev?       # => false

The returned value is filesystem-dependent; on Windows, always false.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 2303

def chardev?() FileTest.chardev?(@path) end

#children(with_dirnames = true) ⇒ Pathname

Returns an array of pathnames; each represents a child of the entry represented by self, which must be an existing directory in the underlying file system.

With with_dirnames given as true (the default), each pathname contains the full entry:

Pathname('lib').children.size # => 72
Pathname('lib').children.take(3)
#### => [#<Pathname:lib/bundled_gems.rb>, #<Pathname:lib/bundler>, #<Pathname:lib/bundler.rb>]

With with_dirnames given as false, each pathname contains only the basename of the entry:

Pathname('lib').children(false).take(3)
#### => [#<Pathname:bundled_gems.rb>, #<Pathname:bundler>, #<Pathname:bundler.rb>]

Note that entries . and .. in directory are not actually children, and so are never included in the result.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1018

def children(with_directory=true)
  with_directory = false if @path == '.'
  result = Dir.children(@path)
  if with_directory
    result.map! {|e| self.class.new(File.join(@path, e))}
  else
    result.map! {|e| self.class.new(e)}
  end
  result
end

#chmod(mode) ⇒ 1

Changes the mode of the entry at the path in self; returns 1. See Filesystem Modes and especially Setting a Mode.

These examples use a helper method, mode, that displays a mode both in octal digits and in characters:

dirpath = 'doc/foo'
dir_pn = Pathname(dirpath)
dir_pn.mkdir         # Create directory.
mode(dirpath)        # => "040775 drwxrwxr-x"
filepath = File.join(dirpath, 't.tmp')
file_pn = Pathname(filepath)
file_pn.write('bar') # Create file.
mode(filepath)       # => "100664 -rw-rw-r--"
file_pn.chmod(0755)  # Change file mode.
mode(filepath)       # => "100755 -rwxr-xr-x"
dir_pn.chmod(0644)   # Change directory mode.
mode(dirpath)        # => "040644 drw-r--r--"
dir_pn.rmtree        # Clean up.
[ GitHub ]

  
# File 'pathname_builtin.rb', line 1527

def chmod(mode) File.chmod(mode, @path) end

#chop_basename(path) (private)

chop_basename(path) -> [pre-basename, basename] or nil

[ GitHub ]

  
# File 'pathname.c', line 316

static VALUE
chop_basename(VALUE self, VALUE path)
{
    rb_len_t baselen, alllen = RSTRING_LEN(check_strpath(path));
    if (alllen <= 0) return Qnil;
    rb_encoding *enc = rb_enc_get(path);
    const char *name = RSTRING_PTR(path);
    const char *base = ruby_enc_find_basename(name, &baselen, &alllen, enc);
    if (baselen < 1) return Qnil;
    if (baselen == 1 && isdirsep(*base)) return Qnil;
    RUBY_ASSERT(base >= name);
    RUBY_ASSERT(base <= RSTRING_END(path));
    VALUE dir = rb_str_subseq(path, 0, base - name);
    VALUE basename = rb_enc_str_new(base, alllen, enc);
    RB_GC_GUARD(path);
    return rb_assoc_new(dir, basename);
}

#chown(owner_id, group_id) ⇒ 0

Changes the owner and group of an entry (directory or file):

#### Super user; all privileges.
Process.uid                    # => 0
Process.gid                    # => 0

#### Pathname for a (non-existent) directory.
dir_pn = Pathname('doc/foo')   # => #<Pathname:doc/foo>
#### Create the directory; fetch original owner and group.
dir_pn.mkdir
dir_stat = dir_pn.stat
dir_stat.uid                   # => 0
dir_stat.gid                   # => 0
#### Change owner; fetch current owner and group.
dir_pn.chown(1000, 1000)
dir_stat = dir_pn.stat
dir_stat.uid                   # => 1000
dir_stat.gid                   # => 1000

Pathname for a (non-existent) file in the directory.
file_pn = dir_pn.join('t.tmp') # => #<Pathname:doc/foo/t.tmp>
#### Create the directory; fetch original owner and group.
file_pn.write('foo')
file_stat = file_pn.stat
file_stat.uid                  # => 0
file_stat.gid                  # => 0
#### Change owner; fetch current owner and group.
file_pn.chown(1000, 1000)
file_stat = file_pn.stat
file_stat.uid                  # => 1000
file_stat.gid                  # => 1000
#### Clean up.
file_pn.delete
dir_pn.rmdir

Notes:

  • On Windows, the owner and group are not changed.
  • Only a process with superuser privileges can change the owner of an entry.
  • The owner of an entry can change its group to any group to which the owner belongs.
  • A nil or -1 owner or group id is ignored.
  • The method follows symbolic links to the target entry.
[ GitHub ]

  
# File 'pathname_builtin.rb', line 1606

def chown(owner, group) File.chown(owner, group, @path) end

#cleanpath(symlinks = false) ⇒ Pathname

Returns a new Pathname object, "cleaned" of unnecessary separators, single-dot entries, and double-dot entries.

When self is empty, returns a pathname with a single-dot entry:

Pathname('').cleanpath # => {#<}Pathname:.>

Separators

A lone separator is preserved:

Pathname('/').cleanpath # => {#<}Pathname:/>

Multiple trailing separators are removed:

Pathname('foo/////').cleanpath # => {#<}Pathname:foo>
Pathname('foo/').cleanpath     # => {#<}Pathname:foo>

Multiple embedded separators are reduced to a single separator:

Pathname('foo///bar').cleanpath # => {#<}Pathname:foo/bar>

Multiple leading separators are reduced:

#### On Windows, where {File.dirname}('//') == '//'.
Pathname('/////foo').cleanpath # => {#<}Pathname://foo>
Pathname('/////').cleanpath    # => {#<}Pathname://>
#### Otherwise, where {File.dirname}('//') == '/'.
Pathname('/////foo').cleanpath # => {#<}Pathname:/foo>
Pathname('/////').cleanpath    # => {#<}Pathname:/>

Single-Dot Entries

A lone single-dot entry is preserved:

Pathname('.').cleanpath  # => {#<}Pathname:.>

A non-lone single-dot entry, regardless of its location, is removed:

Pathname('foo/././././bar').cleanpath  # => {#<}Pathname:foo/bar>
Pathname('./foo/./././bar').cleanpath  # => {#<}Pathname:foo/bar>
Pathname('foo/./././bar/./').cleanpath # => {#<}Pathname:foo/bar>

Double-Dot Entries

A lone double-dot entry is preserved:

Pathname('..').cleanpath # => {#<}Pathname:..>

When a non-lone double-dot entry is preceded by a named entry, both are removed:

Pathname('foo/..').cleanpath          # => {#<}Pathname:.>
Pathname('foo/../bar').cleanpath      # => {#<}Pathname:bar>
Pathname('foo/../bar/..').cleanpath   # => {#<}Pathname:.>
Pathname('foo/bar/./../..').cleanpath # => {#<}Pathname:.>

When a non-lone double-dot entry is not preceded by a named entry, it is preserved:

Pathname('../..').cleanpath # => {#<}Pathname:../..>

A non-lone meaningless double-dot entry is removed:

Pathname('/..').cleanpath    # => {#<}Pathname:/>
Pathname('/../..').cleanpath # => {#<}Pathname:/>

Symbolic Links

If the path may contain symbolic links, consider give optional argument symlinks as true; the method then uses a more conservative algorithm that avoids breaking symbolic links. This may preserve more double-dot entries than are absolutely necessary, but without accessing the filesystem, this can't be avoided.

Examples:

Pathname('a/').cleanpath           # => {#<}Pathname:a>
Pathname('a/').cleanpath(true)     # => {#<}Pathname:a/>

Pathname('a/.').cleanpath          # => {#<}Pathname:a>
Pathname('a/.').cleanpath(true)    # => {#<}Pathname:a/.>

Pathname('a/./').cleanpath         # => {#<}Pathname:a>
Pathname('a/./').cleanpath(true)   # => {#<}Pathname:a/.>

Pathname('a/b/.').cleanpath        # => {#<}Pathname:a/b>
Pathname('a/b/.').cleanpath(true)  # => {#<}Pathname:a/b/.>

Pathname('a/../.').cleanpath       # => {#<}Pathname:.>
Pathname('a/../.').cleanpath(true) # => {#<}Pathname:a/..>

Pathname('a/b/../../../../c/../d').cleanpath
#### => {#<}Pathname:../../d>
Pathname('a/b/../../../../c/../d').cleanpath(true)
#### => {#<}Pathname:a/b/../../../../c/../d>
[ GitHub ]

  
# File 'pathname_builtin.rb', line 629

def cleanpath(consider_symlink=false)
  if consider_symlink
    cleanpath_conservative
  else
    cleanpath_aggressive
  end
end

#cleanpath_aggressive (private)

This method is for internal use only.

Clean the path simply by resolving and removing excess . and .. entries. Nothing more, nothing less.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 641

def cleanpath_aggressive # :nodoc:
  path = @path
  names = []
  pre = path
  while r = chop_basename(pre)
    pre, base = r
    case base
    when '.'
    when '..'
      names.unshift base
    else
      if names[0] == '..'
        names.shift
      else
        names.unshift base
      end
    end
  end
  pre.tr!(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR
  if has_separator?(File.basename(pre))
    names.shift while names[0] == '..'
  end
  self.class.new(prepend_prefix(pre, File.join(*names)))
end

#cleanpath_conservative (private)

This method is for internal use only.
[ GitHub ]

  
# File 'pathname_builtin.rb', line 667

def cleanpath_conservative # :nodoc:
  path = @path
  names = []
  pre = path
  while r = chop_basename(pre)
    pre, base = r
    names.unshift base if base != '.'
  end
  pre.tr!(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR
  if has_separator?(File.basename(pre))
    names.shift while names[0] == '..'
  end
  if names.empty?
    self.class.new(File.dirname(pre))
  else
    if names.last != '..' && File.basename(path) == '.'
      names << '.'
    end
    result = prepend_prefix(pre, File.join(*names))
    if /\A(?:\.|\.\.)\z/ !~ names.last && has_trailing_separator?(path)
      self.class.new(add_trailing_separator(result))
    else
      self.class.new(result)
    end
  end
end

#ctime ⇒ Time

On Windows, returns the birthtime for the path in self.

On other systems, returns a new ::Time object containing the time of the most recent metadata change to the entry represented by self; seeFile System Timestamps:

#### A directory and its Pathname.
dir_path = '/tmp/dir'
dir_pn = Pathname(dir_path)
#### Create directory; establishes directory ctime.
dir_pn.mkdir
dir_pn.ctime                     # => 2026-10-05 16:36:52.738405306 -0500
#### A file therein and its Pathname.
file_path = dir_pn.join('t.tmp') # => #<Pathname:/tmp/dir/t.tmp>
file_pn = Pathname(file_path)
#### Create file; establishes file ctime; updates directory ctime.
file_pn.write('foo')
file_pn.ctime                    # => 2026-10-05 16:38:35.076588258 -0500
dir_pn.ctime                     # => 2026-10-05 16:38:35.076588258 -0500
#### Write file; updates file ctime; does not update directory ctime..
file_pn.write('bar')
file_pn.ctime                    # => 2026-10-05 16:39:57.842776244 -0500
dir_pn.ctime                     # => 2026-10-05 16:38:35.076588258 -0500
#### Read file; updates neither ctime.
file_pn.read
file_pn.ctime                    # => 2026-10-05 16:39:57.842776244 -0500
dir_pn.ctime                     # => 2026-10-05 16:38:35.076588258 -0500
dir_pn.rmtree                    # Clean up.
[ GitHub ]

  
# File 'pathname_builtin.rb', line 1462

def ctime() File.ctime(@path) end

#del_trailing_separator(path) (private)

This method is for internal use only.
[ GitHub ]

  
# File 'pathname.c', line 387

static VALUE
del_trailing_separator(VALUE self, VALUE path)
{
    rb_len_t len = RSTRING_LEN(check_strpath(path));
    if (len <= 0) return path;
    rb_encoding *enc = rb_enc_get(path);
    const char *name = RSTRING_PTR(path);
    const char *end = name + len, *tail = end;
    const char *top = rb_enc_path_skip_prefix(name, end, enc);
    if (tail > top && isdirsep(tail[-1])) {
        while (--tail > top && isdirsep(tail[-1]));
        if (tail > top &&
            tail[0] != '/' &&
            !rb_str_enc_fastpath(path) &&
            rb_enc_left_char_head(top, tail, end, enc) != tail) {
            /* trailing byte, not a directory separator */
            ++tail;
        }
        if (tail < end) {
            if (tail == name || (drive_letter && tail == top && top[-1] == ':')) {
                ++tail;
            }
        }
    }
    if (tail == end) return path;
    return rb_str_subseq(path, 0, tail - name);
}

#delete

Alias for #unlink.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 3000

alias delete unlink

#descend {|entry| ... } ⇒ nil #descend ⇒ Enumerator

With a block given, yields a new pathname for each successive dirname in the stored path; see File.dirname:

#### Absolute path.
Pathname('/path/to/some/file.rb').descend {|pn| p pn }
#### #<Pathname:/>
#### #<Pathname:/path>
#### #<Pathname:/path/to>
#### #<Pathname:/path/to/some>
#### #<Pathname:/path/to/some/file.rb>
#### Relative path.
Pathname('path/to/some/file.rb').descend {|pn| p pn }
#### #<Pathname:path>
#### #<Pathname:path/to>
#### #<Pathname:path/to/some>
#### #<Pathname:path/to/some/file.rb>

With no block given, returns a new Enumerator.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 813

def descend
  return to_enum(__method__) unless block_given?
  vs = []
  ascend {|v| vs << v }
  vs.reverse_each {|v| yield v }
  nil
end

#directory? ⇒ Boolean

Returns whether the entry represented by self is a directory:

Pathname('/etc').directory?        # => true
Pathname('/etc/passwd').directory? # => false
Pathname($stdin).directory?        # => false
Pathname('nosuch').directory?      # => false
[ GitHub ]

  
# File 'pathname_builtin.rb', line 2418

def directory?() FileTest.directory?(@path) end

#dirname ⇒ Pathname

Returns a new pathname whose path is all but the last component of the path in self:

Pathname('/usr/lib/linux').basename # => #<Pathname:linux>
Pathname('/usr').basename           # => #<Pathname:usr>
Pathname('/').basename              # => #<Pathname:/>
Pathname('lib/').basename           # => #<Pathname:lib>
Pathname('nosuch').basename         # => #<Pathname:nosuch>

Components are delimited by File::SEPARATOR and, if non-+nil+, File::ALT_SEPARATOR.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 2105

def dirname() self.class.new(File.dirname(@path)) end

#each_child(with_dirnames = true) {|entry| ... } ⇒ Pathname #each_child(with_dirnames = true) ⇒ Enumerator

With a block given and with_dirnames given as true (the default), yields a new pathname for each child of the entry represented by self; returns an array of those pathnames:

Pathname('include').each_child {|child| p child }
#### #<Pathname:include/ruby>
#### #<Pathname:include/ruby.h>
#### => [#<Pathname:include/ruby>, #<Pathname:include/ruby.h>]

With a block given and with_dirnames given as false, yields a new pathname for each child of the entry represented by self with its dirname omitted; returns an array of those pathnames:

Pathname('include').each_child(false) {|child| p child }
#### #<Pathname:ruby>
#### #<Pathname:ruby.h>
#### => [#<Pathname:ruby>, #<Pathname:ruby.h>]

Note that entries '.' and '..' are not children.

With no block given, returns a new Enumerator.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1062

def each_child(with_directory=true, &b)
  children(with_directory).each(&b)
end

#each_entry {|entry| ... } ⇒ nil #each_entry ⇒ Enumerator

With a block given, yields a new pathname for each entry in the entry represented by self; returns nil:

Pathname('include').each_entry {|entry| p entry }
#### #<Pathname:ruby>
#### #<Pathname:..>
#### #<Pathname:ruby.h>
#### #<Pathname:.>
#### => nil

With no block given, returns a new Enumerator.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 2882

def each_entry(&block) # :yield: pathname
  return to_enum(__method__) unless block_given?
  Dir.foreach(@path) {|f| yield self.class.new(f) }
end

#each_filename {|component| ... } ⇒ nil #each_filename ⇒ Enumerator

With a block given, yields each component of the string path:

Pathname('/foo/bar/baz').each_filename {|filename| p filename }
#=> nil

Output:

"foo"
"bar"
"baz"

With no block given, returns a new Enumerator.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 780

def each_filename # :yield: filename
  return to_enum(__method__) unless block_given?
  _, names = split_names(@path)
  names.each {|filename| yield filename }
  nil
end

#each_line(sep = $/, **opts) {|line| ... } ⇒ nil #each_line(limit, **opts) {|line| ... } ⇒ nil #each_line(sep, limit, **opts) {|line| ... } ⇒ nil #each_line(...) ⇒ Enumerator

With a block given, calls the block with each line from the file represented by self; returns nil:

lines = []
Pathname('COPYING').each_line {|line| lines << line }
lines.take(3)
#### =>
#### ["<a href='COPYING.ja'>日本語</a>\n",
####  "\n",
####  "Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.jp>.\n"]

The lines are read using IO.foreach, all arguments and options are passed to that method; see details at IO.foreach.

With no block given, returns a new Enumerator.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1169

def each_line(...) # :yield: line
  File.foreach(@path, ...)
end

#entries ⇒ Pathname

Returns an array of pathnames, one for each entry in the directory represented by self:

Pathname('.').entries.take(5)
#### =>
#### [#<Pathname:.>,
####  #<Pathname:..>,
####  #<Pathname:gc.rb>,
####  #<Pathname:yjit.rb>,
####  #<Pathname:iseq.h>]
[ GitHub ]

  
# File 'pathname_builtin.rb', line 2859

def entries() Dir.entries(@path).map {|f| self.class.new(f) } end

#eql?(other)

Alias for #==.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 420

alias eql? ==

#executable? ⇒ Boolean

Returns whether the entry represented by self exists and isexecutable by the effective owner/group of the current process.

Pathname('/bin/ruby').executable?   # => true
Pathname('/etc').executable?        # => true
Pathname('/etc/passwd').executable? # => false
Pathname('nosuch').executable?      # => false

Note that some filesystem settings may cause this method to return true even though the entry is not executable by the effective owner/group.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 2356

def executable?() FileTest.executable?(@path) end

#executable_real? ⇒ Boolean

Like #executable?, but checks against the real owner/group instead of the effective owner/group.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 2365

def executable_real?() FileTest.executable_real?(@path) end

#exist? ⇒ Boolean

Returns whether the entry represented by self exists:

Pathname('.').exist?         # => true
Pathname('README.md').exist? # => true
Pathname('nosuch').exist?    # => false
[ GitHub ]

  
# File 'pathname_builtin.rb', line 2380

def exist?() FileTest.exist?(@path) end

#expand_path(dirpath = '.') ⇒ Pathname

Returns a new pathname containing the absolute path for self.

Evaluates a relative path with respect to the directory given by dirpath:

Dir.chdir('/snap')
#### Default dirpath.
Pathname('README').expand_path                  # => #<Pathname:/snap/README>
Pathname('bin').expand_path                     # => #<Pathname:/snap/bin>
Pathname('bin/../var').expand_path              # => #<Pathname:/snap/var>  # Cleaned.
#### Other dirpath.
Pathname('../zip').expand_path('/usr/bin/ruby') # => #<Pathname:/usr/bin/zip>
Dir.chdir('/usr/bin')
Pathname('../../snap').expand_path(__FILE__)    # => #<Pathname:/usr/snap>

Evaluates an absolute path without respect to dirpath:

Pathname('/snap').expand_path                       # => #<Pathname:/snap>
Pathname('/snap').expand_path.expand_path('nosuch') # => #<Pathname:/snap>
Pathname('/snap/../snap').expand_path               # => #<Pathname:/snap>  # Cleaned.

More examples:

{Dir.chdir}('/usr/bin')
Pathname('../../snap').expand_path(__FILE__) # => {#<}Pathname:/usr/snap>
Pathname('../../snap').expand_path           # => {#<}Pathname:/snap>
[ GitHub ]

  
# File 'pathname_builtin.rb', line 2182

def expand_path(...) self.class.new(File.expand_path(@path, ...)) end

#extname ⇒ extension

Returns the filename extension of self -- usually the portion of the string path beginning from the last period:

Pathname('t.rb').extname               # => ".rb"
Pathname('foo.bar.t.rb').extname       # => ".rb"
Pathname('foo/bar/t.rb').extname       # => ".rb"
Pathname('nosuch.txt').extname         # => ".txt"  # Path need not exist.

Returns the entire string when there is no period:

Pathname('foo').extname # => ""

Returns an empty string when the only period is the first character:

Pathname('.irbrc').extname # => ""

Returns an empty string or '.' when #path ends with a period:

Pathname('foo.').extname    # => ""   # On Windows.
Pathname('foo.').extname    # => "."  # Elsewhere.
Pathname('foo....').extname # => ""   # On Windows.
Pathname('foo....').extname # => "."  # Elsewhere.
[ GitHub ]

  
# File 'pathname_builtin.rb', line 2143

def extname() File.extname(@path) end

#file? ⇒ Boolean

Returns whether the entry at the path in self exists and is a regular file; see #ftype:

Pathname('/etc/passwd').file? # => true
Pathname('/etc').file?        # => false
Pathname('nosuch').file?      # => false
[ GitHub ]

  
# File 'pathname_builtin.rb', line 2434

def file?() FileTest.file?(@path) end

#fnmatch(pattern, flags = 0) ⇒ Boolean

Returns whether string pattern matches against the string path in self, under the control of the given flags; seeFilename Matching.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1662

def fnmatch(pattern, ...) File.fnmatch(pattern, @path, ...) end

#fnmatch?(pattern, flags = 0) ⇒ Boolean

Same as #fnmatch.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1670

def fnmatch?(pattern, ...) File.fnmatch?(pattern, @path, ...) end

#freeze ⇒ self

Freezes self, preventing further modifications; see Frozen Objects.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 396

def freeze
  super
  @path.freeze
  self
end

#ftype ⇒ String

Returns the string type of the object at the path in self, one of:

  • 'file'.
  • 'directory'.
  • 'characterSpecial'.
  • 'blockSpecial'.
  • 'fifo'.
  • 'link'.
  • 'socket'.

Examples:

Pathname('/etc/passwd').ftype # => "file"
Pathname('/etc').ftype        # => "directory"
Pathname('/dev/null').ftype   # => "characterSpecial"
Pathname('/dev/loop0').ftype  # => "blockSpecial"

File.mkfifo('/tmp/pipe', 0o666)
Pathname('/tmp/pipe').ftype   # => "fifo"

File.symlink('/etc/passwd', '/tmp/link')
Pathname('/tmp/link').ftype   # => "link"

require 'socket'
UNIXServer.new('/tmp/socket')
Pathname('/tmp/socket').ftype # => "socket"

File.delete('/tmp/link', '/tmp/pipe', '/tmp/socket') # Clean up.

Returns 'unknown' if the type cannot be determined.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1709

def ftype() File.ftype(@path) end

#glob(*args, **kwargs)

Returns or yields Pathname objects.

Pathname("ruby-2.4.2").glob("R*.md") #=> [#Pathname:ruby-2.4.2/README.md, #Pathname:ruby-2.4.2/README.ja.md]

See Dir.glob. This method uses the base keyword argument of Dir.glob.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 2820

def glob(*args, **kwargs) # :yield: pathname
  if block_given?
    Dir.glob(*args, **kwargs, base: @path) {|f| yield self + f }
  else
    Dir.glob(*args, **kwargs, base: @path).map {|f| self + f }
  end
end

#grpowned? ⇒ Boolean

Returns false on Windows.

On other systems, returns whether the effective group id of the calling process is the owner of the entry at the path in self:

#### => "/tmp/t.tmp"
File.write(filepath, 'foo')
Pathname(filepath).grpowned?      # => true
Pathname('/etc').grpowned?        # => false
Pathname('/etc/passwd').grpowned? # => false
Pathname('nosuch').grpowned?      # => false
File.delete(filepath)             # Clean up.
[ GitHub ]

  
# File 'pathname_builtin.rb', line 2402

def grpowned?() FileTest.grpowned?(@path) end

#has_separator?(path) ⇒ Boolean (private)

This method is for internal use only.
[ GitHub ]

  
# File 'pathname.c', line 259

static VALUE
has_separator_p(VALUE self, VALUE path)
{
    const char *ptr = RSTRING_PTR(check_strpath(path));
    const char *end = RSTRING_END(path);
    if (alt_separator) {
        rb_encoding *enc = rb_enc_get(path);
        bool mb = !rb_str_enc_fastpath(path);
        while (ptr < end) {
            if (isdirsep(*ptr)) return Qtrue;
            ptr += (mb ? rb_enc_mbclen(ptr, end, enc) : 1);
        }
    }
    else {
        /* assume '/' will never be trailing bytes */
        if (memchr(ptr, '/', end - ptr)) return Qtrue;
    }
    return Qfalse;
}

#has_trailing_separator?(path) ⇒ Boolean (private)

has_trailing_separator?(path) -> bool

[ GitHub ]

  
# File 'pathname.c', line 356

static VALUE
has_trailing_separator(VALUE self, VALUE path)
{
    rb_len_t baselen, alllen = RSTRING_LEN(check_strpath(path));
    if (alllen <= 0) return Qfalse;
    rb_encoding *enc = rb_enc_get(path);
    const char *name = RSTRING_PTR(path);
    const char *base = ruby_enc_find_basename(name, &baselen, &alllen, enc);
    if (baselen < 1) return Qfalse;
    if (baselen == 1 && isdirsep(*base)) return Qfalse;
    return RBOOL(base + alllen < RSTRING_END(path));
}

#hash

This method is for internal use only.
[ GitHub ]

  
# File 'pathname_builtin.rb', line 422

def hash # :nodoc:
  @path.hash
end

#inspect

This method is for internal use only.
[ GitHub ]

  
# File 'pathname_builtin.rb', line 443

def inspect # :nodoc:
  "#<#{self.class}:#{@path}>"
end

#join(*components) ⇒ self, Pathname

With no arguments, returns self.

With arguments, joins the given components to the string path in self with character '/'; returns a new pathname containing the joined string:

pn = Pathname('foo')                      # => #<Pathname:foo>
#### String arguments.
pn.join('bar')                            # => #<Pathname:foo/bar>
pn.join(*%w[bar baz bat])                 # => #<Pathname:foo/bar/baz/bat>
#### Pathname arguments.
pn.join(Pathname('bar'), Pathname('baz')) # => #<Pathname:foo/bar/baz>
[ GitHub ]

  
# File 'pathname_builtin.rb', line 978

def join(*args)
  return self if args.empty?
  result = args.pop
  result = Pathname.new(result) unless Pathname === result
  return result if result.absolute?
  args.reverse_each {|arg|
    arg = Pathname.new(arg) unless Pathname === arg
    result = arg + result
    return result if result.absolute?
  }
  self + result
end

#lchmod(mode) ⇒ 1

Not supported on Linux or Windows (raises ::NotImplementedError).

When supported: like #chmod, but does not followsymbolic links, and therefore changes the mode of the entry specified by self:

file = Pathname('t.tmp')
file.write('')
File.symlink('t.tmp', 'link')
symlink = Pathname('link')
file.lstat.mode.to_s(8) # => "100644"
symlink.lstat.mode.to_s(8) # => "120755"
symlink.lchmod(0777)
file.lstat.mode.to_s(8) # => "100644"
symlink.lstat.mode.to_s(8) # => "120777"
file.delete
symlink.delete
[ GitHub ]

  
# File 'pathname_builtin.rb', line 1553

def lchmod(mode) File.lchmod(mode, @path) end

#lchown(uid, gid) ⇒ 1

Not supported on some platforms (raises exception).

Calling process must have superuser privileges.

When supported: like Pathname#chown, but does not followsymbolic links, and therefore changes the ownership of the entry at the path in self:

#### Super user; all privileges.
Process.uid # => 0
Process.gid # => 0
#### Create regular file and symbolic link to it.
File.write('t.tmp', '')
File.symlink('t.tmp', 'link')
#### Capture original statuses.
fstat0 = File.stat('t.tmp')  # Method ::stat; status of file.
lstat0 = File.lstat('link')  # Method ::lstat; status of link.
#### Original user ids and group ids.
fstat0.uid # => 0
fstat0.gid # => 0
lstat0.uid # => 0
lstat0.gid # => 0
#### Change ids for link.
Pathname('link').lchown(1000, 1000)
#### Capture new statuses.
fstat1 = File.stat('t.tmp')
lstat1 = File.lstat('link')
#### User id and group id for file not changed.
fstat1.uid # => 0
fstat1.gid # => 0
#### User id and group id for link changed.
p lstat1.uid # => 1000
p lstat1.gid # => 1000
#### Clean up.
File.delete('t.tmp')
File.delete('link')
[ GitHub ]

  
# File 'pathname_builtin.rb', line 1652

def lchown(owner, group) File.lchown(owner, group, @path) end

#lstat ⇒ stat

Returns a new ::File::Stat object for the entry at the path in self. Unlike #stat, _does not follow_symbolic links; therefore the returned object contains information for that entry, regardless of whether it is a symbolic link:

file_pn = Pathname('/etc/passwd')
link_pn = Pathname('/tmp/foo')
link_pn.make_symlink(file_pn)
# Method lstat does not follow the symlink, so the birthtimes are different.
file_pn.lstat.birthtime # => 2025-06-10 11:10:47.358999941 -0500
link_pn.lstat.birthtime # => 2026-09-23 14:12:00.978946471 -0500
# Method stat follows the symlink, so the birthtimes are the same.
file_pn.stat.birthtime  # => 2025-06-10 11:10:47.358999941 -0500
link_pn.stat.birthtime  # => 2025-06-10 11:10:47.358999941 -0500
link_pn.delete          # Clean up.
[ GitHub ]

  
# File 'pathname_builtin.rb', line 1906

def lstat() File.lstat(@path) end

#lutime(atime, mtime) ⇒ 1

Like #utime, but does not followsymbolic links, and therefore changes the times of the entry in self, regardless of whether it is a symbolic link:

#### Create a file and a link to it.
file_path = 't.tmp'
link_path = 'link'
File.write(file_path, '')
File.symlink(file_path, link_path)
#### Take snapshots of both.
file_stat = File.stat(file_path)
link_stat = File.lstat(link_path)
#### Fetch access times and modification times of both.
file_stat.atime # => 2026-06-15 11:03:29.600373255 -0500
file_stat.mtime # => 2026-06-15 11:03:22.247352211 -0500
link_stat.atime # => 2026-06-15 11:03:29.251372254 -0500
link_stat.mtime # => 2026-06-15 11:03:26.66436484 -0500
#### Update access time and modification time of the link.
pn = Pathname(link_path)
time = Time.now # => 2026-06-15 11:08:07.384287523 -0500
pn.lutime(time, time)
#### Take fresh snapshots of both.
file_stat = File.stat(file_path)
link_stat = File.lstat(link_path)
#### Fetch access time and modification time of file (not changed).
file_stat.atime # => 2026-06-15 11:03:29.600373255 -0500
file_stat.mtime # => 2026-06-15 11:03:22.247352211 -0500
#### Fetch access time and modification time of link (changed).
link_stat.atime # => 2026-06-15 11:08:29.847301399 -0500
link_stat.mtime # => 2026-06-15 11:08:07.384287523 -0500
#### Clean up.
File.delete(file_path)
File.delete(link_path)

Arguments #atime and #mtime may be Time objects (as above).

Either or both may be integers; when an integer i is passed, Time.new(i) is used.

Either or both may be nil, in which case Time.now is used.

See File System Timestamps.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 2050

def lutime(atime, mtime) File.lutime(atime, mtime, @path) end

#mkdir(permissions = 0755) ⇒ 0

Creates a directory in the underlying file system at the path in self, with the given permissions; see File Permissions:

Dir.mkdir('foo')
File.stat(Dir.new('foo')).mode.to_s(8) # => "40775"
Dir.mkdir('bar', 0644)
File.stat(Dir.new('bar')).mode.to_s(8) # => "40644"
Dir.rmdir('foo')
Dir.rmdir('bar')

Argument permissions is ignored on Windows.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 2906

def mkdir(...) Dir.mkdir(@path, ...) end

#mkpath(mode: nil) ⇒ self

Creates a directory at the path in self; creates intermediate directories as needed:

pn = Pathname('foo/bar/baz')
pn.directory? # => false
pn.mkpath     # Creates directories 'foo', 'foo/bar', 'foo/bar/baz'.
pn.directory? # => true
pn.rmtree     # Clean up.

When mode is given, directories are created with those permissions; see File Permissions. The permissions for already-existing directories are not changed.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 466

def mkpath(mode: nil)
  path = @path == '/' ? @path : @path.chomp('/')

  stack = []
  until File.directory?(path) || (parent = File.dirname(path)) == path
    stack.push path
    path = parent
  end

  stack.reverse_each do |dir|
    dir = dir == '/' ? dir : dir.chomp('/')
    if mode
      Dir.mkdir dir, mode
      File.chmod mode, dir
    else
      Dir.mkdir dir
    end
  rescue SystemCallError
    raise unless File.directory?(dir)
  end

  self
end

#mtime ⇒ Time

Returns a ::Time object containing the time of the most recent modification to the entry represented by self; see File System Timestamps:

#### A directory and its Pathname.
dir_path = 'doc/foo'
dir_pn = Pathname(dir_path)
#### Create directory; directory mtime established.
dir_pn.mkdir
dir_pn.mtime  # => 2026-06-28 16:38:02.675780521 -0500
#### A file therein and its Pathname.
file_path = dir_pn.join('t.tmp')
file_pn = Pathname(file_path)
#### Create file; file mtime established; directory mtime updated.
file_pn.write('foo')
dir_pn.mtime  # => 2026-06-28 16:41:23.107750483 -0500
file_pn.mtime # => 2026-06-28 16:41:23.107750483 -0500
#### Modify file; file mtime updated; directory mtime unchanged.
file_pn.write('bar')
dir_pn.mtime  # => 2026-06-28 16:41:23.107750483 -0500
file_pn.mtime # => 2026-06-28 16:42:48.869163049 -0500
#### Clean up.
dir_pn.rmtree
[ GitHub ]

  
# File 'pathname_builtin.rb', line 1495

def mtime() File.mtime(@path) end

#open(mode = 'r', permissions = 0666, **options) {|file| ... } ⇒ Object #open(mode = 'r', permissions = 0666, **options) ⇒ File

Creates a ::File object for the entry at the path in self and opens the file; see File.new for details.

With a block given, calls the block with the file; closes the file on block exit:

Pathname('README.md').open {|file| file.size } # => 3469

With no block given, returns the file:

file = Pathname('README.md').open # => #<File:README.md>
file.size                         # => 3469
file.close
[ GitHub ]

  
# File 'pathname_builtin.rb', line 1759

def open(...) # :yield: file
  File.open(@path, ...)
end

#opendir {|dir| ... } ⇒ Object #opendir ⇒ Dir

Creates a ::Dir object dir for the directory at the path represented by self; opens dir.

With a block given, calls the block with dir; on block exit, closes dir and returns the block's return value:

pn = Pathname('.')
pn.opendir {|dir| dir.entries.take(3) }
#### => ["README.md", "html", ".git"]

With no block given, returns the open directory dir:

dir = pn.opendir    # => #<Dir:.>
dir.entries.take(3) # => ["README.md", "html", ".git"]
dir.close
[ GitHub ]

  
# File 'pathname_builtin.rb', line 2953

def opendir(&block) # :yield: dir
  Dir.open(@path, &block)
end

#owned? ⇒ Boolean

Returns whether the entry at the path represented by self exists and is owned by the user of the current process:

pn = Pathname('doc/t.tmp')
pn.write('foo')
pn.owned?               # => true
pn.delete               # Clean up.
pn = Pathname('doc/tmp')
pn.mkdir
pn.owned?               # => true
pn.rmdir                # Clean up.
Pathname('/etc').owned? # => false
[ GitHub ]

  
# File 'pathname_builtin.rb', line 2503

def owned?() FileTest.owned?(@path) end

#parent ⇒ Pathname

Returns a new pathname representing the parent directory of the entry represented by self:

pn = Pathname('/etc/passwd') # => #<Pathname:/etc/passwd>
pn.parent                    # => #<Pathname:/etc>
[ GitHub ]

  
# File 'pathname_builtin.rb', line 708

def parent
  self + '..'
end

#pipe? ⇒ Boolean

Returns whether the entry at the path in self is a pipe:

Pathname('.').pipe? # => false
path = '/tmp/foo'
File.mkfifo(path)
pn = Pathname(path) # => #<Pathname:/tmp/foo>
pn.pipe?            # => true
pn.delete           # Clean up.
[ GitHub ]

  
# File 'pathname_builtin.rb', line 2452

def pipe?() FileTest.pipe?(@path) end

#plus(path1, path2) (private)

This method is for internal use only.

(path1, path2) -> path

[ GitHub ]

  
# File 'pathname_builtin.rb', line 916

def plus(path1, path2) # :nodoc:
  prefix2 = path2
  index_list2 = []
  basename_list2 = []
  while r2 = chop_basename(prefix2)
    prefix2, basename2 = r2
    index_list2.unshift prefix2.length
    basename_list2.unshift basename2
  end
  return path2 if prefix2 != ''
  prefix1 = path1
  while true
    while !basename_list2.empty? && basename_list2.first == '.'
      index_list2.shift
      basename_list2.shift
    end
    break unless r1 = chop_basename(prefix1)
    prefix1, basename1 = r1
    next if basename1 == '.'
    if basename1 == '..' || basename_list2.empty? || basename_list2.first != '..'
      prefix1 = prefix1 + basename1
      break
    end
    index_list2.shift
    basename_list2.shift
  end
  r1 = chop_basename(prefix1)
  if !r1 && (r1 = has_separator?(File.basename(prefix1)))
    while !basename_list2.empty? && basename_list2.first == '..'
      index_list2.shift
      basename_list2.shift
    end
  end
  if !basename_list2.empty?
    suffix2 = path2[index_list2.first..-1]
    r1 ? File.join(prefix1, suffix2) : prefix1 + suffix2
  else
    r1 ? prefix1 : File.dirname(prefix1)
  end
end

#prepend_prefix(prefix, relpath) (private)

This method is for internal use only.
[ GitHub ]

  
# File 'pathname_builtin.rb', line 490

def prepend_prefix(prefix, relpath) # :nodoc:
  if relpath.empty?
    File.dirname(prefix)
  elsif has_separator?(prefix)
    add_trailing_separator(File.dirname(prefix)) + relpath
  else
    prefix + relpath
  end
end

#read(length = nil, offset = 0, **opts) ⇒ String?

Reads and returns some or all of the content of the file whose path is self.to_s.

With no arguments given, reads in text mode and returns the entire content of the file:

Pathname.new('t.txt').read
# => "First line\nSecond line\n\nFourth line\nFifth line\n"
Pathname.new('t.ja').read
# => "こんにちは"
Pathname.new('t.dat').read
# => "\xFE\xFF\x99\x90\x99\x91\x99\x92\x99\x93\x99\x94"

On Windows, text mode can terminate reading and leave bytes in the file unread when encountering certain special bytes. Consider using #binread if all bytes in the file should be read.

With argument length given, returns length bytes if available:

Pathname.new('t.txt').read(7)
# => "First l"
Pathname.new('t.ja').read(7)
# => "\xE3\x81\x93\xE3\x82\x93\xE3"
Pathname.new('t.dat').read(7)
# => "\xFE\xFF\x99\x90\x99\x91\x99"

Returns all bytes if length is larger than the files size:

Pathname.new('t.txt').read(700)
# => "First line\r\nSecond line\r\n\r\nFourth line\r\nFifth line\r\n"
Pathname.new('t.ja').read(700)
# => "\xE3\x81\x93\xE3\x82\x93\xE3\x81\xAB\xE3\x81\xA1\xE3\x81\xAF"
Pathname.new('t.dat').read(700)
# => "\xFE\xFF\x99\x90\x99\x91\x99\x92\x99\x93\x99\x94"

With arguments length and offset given, returns length bytes if available, beginning at the given offset:

Pathname.new('t.txt').read(10, 2)
# => "rst line\r\n"
Pathname.new('t.ja').read(10, 2)
# => "\x93\xE3\x82\x93\xE3\x81\xAB\xE3\x81\xA1"
Pathname.new('t.dat').read(10, 2)
# => "\x99\x90\x99\x91\x99\x92\x99\x93\x99\x94"

Returns nil if offset is past the end of the file:

Pathname.new('t.txt').read(10, 200) # => nil

Optional keyword arguments opts specify:

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1230

def read(...) File.read(@path, ...) end

#readable? ⇒ Boolean

Returns whether the entry at the path in self exists and is readable by the owner and group of the current process; seePermissions:

pn = Pathname('/tmp/secret.txt')
pn.write('foo')
pn.readable?                 # => true
pn.chmod(0o000)
pn.readable?                 # => false
pn.delete                    # Clean up.
Pathname('nosuch').readable? # => false
[ GitHub ]

  
# File 'pathname_builtin.rb', line 2524

def readable?() FileTest.readable?(@path) end

#readable_real? ⇒ Boolean

Like #readable?, but checks against the real user and group ids instead of the effective ids.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 2556

def readable_real?() FileTest.readable_real?(@path) end

#readlines(sep = $/, **options) ⇒ Array #readlines(limit, **options) ⇒ Array #readlines(sep, limit, **options) ⇒ Array

Returns an array of all lines read from the source at the path in self, which must be the path to a file.

Examples here use a file defined atIO Example Files.

With no arguments given, parses lines from the file at the given path, as determined by the default line separator, and returns those lines in an array:

pn = Pathname('t.txt')
ppn.readlines
#### => ["First line\n", "Second line\n", "\n", "Fourth line\n", "Fifth line\n"]

With argument sep given, parses lines as determined by that line separator (seeIO Line Separator):

pn.readlines('li')
#### => ["First li", "ne\nSecond li", "ne\n\nFourth li", "ne\nFifth li", "ne\n"]
pn.readlines('')  # Special "paragraphs" separator value.
#### => ["First line\nSecond line\n\n", "Fourth line\nFifth line\n"]
pn.readlines(nil) # Special "slurp" separator value.
#### => ["First line\nSecond line\n\nFourth line\nFifth line\n"]

With argument limit given, parses lines as determined by the default line separator and the given line-length limit (seeIO Line Separator andIO Line Limit):

pn.readlines(7)
#### => ["First l", "ine\n", "Second ", "line\n", "\n", "Fourth ", "line\n", "Fifth l", "ine\n"]

With arguments sep and limit given, combines the two behaviors (seeIO Line Separator and Line Limit).

Optional keyword arguments options specify:

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1294

def readlines(...) File.readlines(@path, ...) end

#realdirpath ⇒ Pathname

Returns a new pathname containing the real (absolute) pathname of the path in self; the new path is the path in the actual filesystem, and does not contain useless dot-entries ('.' or '..') or symbolic links:

Pathname('/etc/./passwd/../../var').realdirpath
#### => #<Pathname:/var>

Only the last component of the new path may be nonexistent:

Pathname('/etc/./passwd/../../var/nosuch').realdirpath
#### => #<Pathname:/var/nosuch>
Pathname('/etc/./passwd/../../var/nosuch/nosuch').realdirpath
#### Raises Errno::ENOENT: No such file or directory.

Method #realpath is similar, but requires all components to exist.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 2259

def realdirpath(...) self.class.new(File.realdirpath(@path, ...)) end

#realpath ⇒ Pathname

Returns a new pathname containing the real (absolute) pathname of the path in self; the new path is the path in the actual filesystem, and does not contain useless dot-entries ('.' or '..') or symbolic links:

Pathname('/etc/./passwd/../../var').realpath
#### => #<Pathname:/var>

All components of the new path must exist:

Pathname('/etc/./passwd/../../var/nosuch').realpath
#### Raises Errno::ENOENT: No such file or directory.

Method #realdirpath is similar, but does not require the last component to exist.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 2230

def realpath(...) self.class.new(File.realpath(@path, ...)) end

#relative_path_from(source) ⇒ Pathname

Returns a pathname containing the relative filesystem path from the given source to the path in self; source must be a directory path or a pathname containing a directory path:

Pathname('.').relative_path_from('doc/language')   # => #<Pathname:../..>
Pathname('doc/language').relative_path_from('.')   # => #<Pathname:doc/language>
Pathname('doc').relative_path_from('doc/language') # => #<Pathname:..>

The paths need not exist:

Pathname('nosuch').relative_path_from('nosuch/foo/bar/baz')
#### => #<Pathname:../../..>

The two paths must be either both absolute or both relative:

Pathname('/var').relative_path_from('/etc') # => #<Pathname:../var>
Pathname('/var').relative_path_from('doc')  # Raises ArgumentError
Pathname('doc').relative_path_from('/etc')  # Raises ArgumentError

Raises an exception if there is no such relative path:

Pathname('foo').relative_path_from('..')    # Raises ArgumentError
[ GitHub ]

  
# File 'pathname_builtin.rb', line 1102

def relative_path_from(base_directory)
  base_directory = Pathname.new(base_directory) unless base_directory.is_a? Pathname
  dest_directory = self.cleanpath.path
  base_directory = base_directory.cleanpath.path
  dest_prefix = dest_directory
  dest_names = []
  while r = chop_basename(dest_prefix)
    dest_prefix, basename = r
    dest_names.unshift basename if basename != '.'
  end
  base_prefix = base_directory
  base_names = []
  while r = chop_basename(base_prefix)
    base_prefix, basename = r
    base_names.unshift basename if basename != '.'
  end
  unless same_paths?(dest_prefix, base_prefix)
    raise ArgumentError, "different prefix: #{dest_prefix.inspect} and #{base_directory.inspect}"
  end
  while !dest_names.empty? &&
        !base_names.empty? &&
        same_paths?(dest_names.first, base_names.first)
    dest_names.shift
    base_names.shift
  end
  if base_names.include? '..'
    raise ArgumentError, "base_directory has ..: #{base_directory.inspect}"
  end
  base_names.fill('..')
  relpath_names = base_names + dest_names
  if relpath_names.empty?
    Pathname.new('.')
  else
    Pathname.new(File.join(*relpath_names))
  end
end

#rename(new_path) ⇒ 0

Moves the entry at the path in self to the given new_path, which may be either a path or another pathname.

Does not followsymbolic links; if the entry is a symlink, the link itself is renamed.

The examples below use two temporary directories:

pn_srcdir = Pathname('/tmp/src/')  # => #<Pathname:/tmp/src/>
pn_dstdir = Pathname('/tmp/dst/')  # => #<Pathname:/tmp/dst/>
pn_srcdir.mkdir
pn_dstdir.mkdir

The entry to be renamed may be a file:

#### Create source pathname and file.
pn_srcfile = pn_srcdir.join('t.tmp') # => #<Pathname:/tmp/src/t.tmp>
pn_srcfile.write('foo')
#### Create destination file pathname.
pn_dstfile = pn_dstdir.join('u.tmp') # => #<Pathname:/tmp/dst/u.tmp>
#### Rename source file as destination file.
pn_srcfile.rename(pn_dstfile)
pn_srcfile.exist?                    # => false
pn_dstfile.exist?                    # => true
pn_srcfile                           # => #<Pathname:/tmp/src/t.tmp> # Not changed.
pn_dstfile.delete                    # Clean up.

The entry to be renames may be a symbolic link:

#### Create source pathname and file.
pn_srcfile = pn_srcdir.join('t.tmp') # => #<Pathname:/tmp/src/t.tmp>
pn_srcfile.write('foo')
#### Create link pathname and link.
pn_lnkfile = pn_dstdir.join('u.tmp') pn_lnkfile = pn_dstdir.join('u.tmp')
pn_lnkfile.make_symlink(pn_srcfile)
pn_lnkfile.readlink                  # => #<Pathname:/tmp/src/t.tmp>
pn_renamed = Pathname('lib/v.tmp')   # => #<Pathname:lib/v.tmp>
pn_lnkfile.rename(pn_renamed)        # Symlink not followed.
pn_renamed.symlink?                  # => true
pn_renamed.readlink                  # => #<Pathname:/tmp/src/t.tmp>
pn_lnkfile                           # => #<Pathname:/tmp/dst/u.tmp>  # Not changed.
#### Clean up.
pn_renamed.delete
pn_srcfile.delete

The entry to be renamed may be a directory:

pn_renamed = Pathname('/tmp/foo') # => #<Pathname:/tmp/foo>
pn_dstdir.rename(pn_renamed)

Clean up:

pn_renamed.rmtree                 # => #<Pathname:/tmp/foo>
pn_srcdir.rmtree                  # => #<Pathname:/tmp/src/>

Raises SystemCallError if the entry cannot be renamed.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1855

def rename(to) File.rename(@path, to) end

#rmdir ⇒ 0

Deletes the directory at the path in self; returns 0:

pn = Pathname('doc/foo')
pn.mkdir
pn.rmdir

Raises an exception if the entry at the path in self is not a directory, or if the directory is not empty.

Use method #rmtree to delete the entire filetree at the path.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 2925

def rmdir() Dir.rmdir(@path) end

#same_paths?(a, b) ⇒ Boolean (private)

This method is for internal use only.
[ GitHub ]

  
# File 'pathname.c', line 167

static VALUE
same_paths(VALUE self, VALUE a, VALUE b)
{
    check_strpath(a);
    check_strpath(b);
    if (CASEFOLD_FILESYSTEM)
        return RBOOL(rb_str_casecmp(a, b) == INT2FIX(0));
    else
        return rb_str_equal(a, b);
}

#setgid? ⇒ Boolean

Returns whether the setgid bit is set in thespecial bits for the entry at the path in self:

pn = Pathname('doc/t.tmp')
pn.write('foo')
mode = pn.stat.mode.to_s(8) # => "100664"
pn.setgid?                  # => false
pn.chmod(0o2644)            # Set the bit.
mode = pn.stat.mode.to_s(8) # => "102644"
pn.setgid?                  # => true
pn.delete                   # Clean up.

On Windows, the bit is never set; the method always returns false.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 2602

def setgid?() FileTest.setgid?(@path) end

#setuid? ⇒ Boolean

Returns whether the setuid bit is set in thespecial bits for the entry at the path in self:

pn = Pathname('doc/t.tmp')
pn.write('foo')
mode = pn.stat.mode.to_s(8) # => "100664"
pn.setuid?                  # => false
pn.chmod(0o4644)            # Set the bit.
mode = pn.stat.mode.to_s(8) # => "104644"
pn.setuid?                  # => true
pn.delete                   # Clean up.

On Windows, the bit is never set; the method always returns false.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 2579

def setuid?() FileTest.setuid?(@path) end

#size ⇒ Integer

Returns the size in bytes of the entry at the path in self:

Pathname('doc/maintainers.md').size # => 14900  # Regular file.
Pathname('doc/syntax/').size        # => 4096   # Directory.

Raises an exception if the entry does not exist.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 2618

def size() FileTest.size(@path) end

#size? ⇒ Boolean

Returns the size in bytes of the entry at the path in self if the entry exists and has non-zero size, nil otherwise:

#### Regular file.
pn = Pathname('/tmp/t.tmp')
pn.write('foo')
pn.size? # => 3     # Non-zero size.
pn.write('')
pn.size? # => nil   # Zero size.
pn.delete           # Clean up.
pn.size? # => nil   # Non-existent.
#### Directory.
pn = Pathname('/tmp/foo/')
pn.mkdir
pn.size? # => 4096  # Non-zero size.
pn.delete           # Clean up.
pn.size? # => nil   # Non-existent.
[ GitHub ]

  
# File 'pathname_builtin.rb', line 2645

def size?() FileTest.size?(@path) end

#socket? ⇒ Boolean

Returns whether entry at the path in self is a socket:

require 'socket'
sock_path = '/tmp/socket'
sock_pn = Pathname(sock_path)
sock_pn.exist?  # => false
sock_pn.socket? # => false
server = UNIXServer.new(sock_path)
sock_pn.exist?  # => true
sock_pn.socket? # => true
#### Clean up.
server.close
sock_pn.delete
file_path = '/etc/passwd'
file_pn = Pathname(file_path)
file_pn.file?   # => true
file_pn.socket? # => false

Returns false on Windows.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 2481

def socket?() FileTest.socket?(@path) end

#split ⇒ Pathname

Returns a 2-element array of pathnames containing the #dirname and #basename of the path in self:

Pathname('doc/maintainers.md').split # => [#<Pathname:doc>, #<Pathname:maintainers.md>]
Pathname('doc/').split               # => [#<Pathname:.>, #<Pathname:doc>]
Pathname('README.md').split          # => [#<Pathname:.>, #<Pathname:README.md>]
Pathname('/tmp/nosuch').split        # => [#<Pathname:/tmp>, #<Pathname:nosuch>]
Pathname('@@##$$/%%^^&&').split      # => [#<Pathname:@@##$$>, #<Pathname:%%^^&&>]

Raises:

[ GitHub ]

  
# File 'pathname_builtin.rb', line 2200

def split()
  array = File.split(@path)
  raise TypeError, 'wrong argument type nil (expected Array)' unless Array === array
  array.map {|f| self.class.new(f) }
end

#split_names(path) (private)

split_names(path) -> prefix, [name, ...]

[ GitHub ]

  
# File 'pathname.c', line 336

static VALUE
split_names(VALUE self, VALUE path)
{
    rb_encoding *enc = rb_enc_get(check_strpath(path));
    const char *beg = RSTRING_PTR(path), *ptr = beg;
    const char *end = RSTRING_END(path);
    const char *root = rb_enc_path_skip_prefix_root(ptr, end, enc);
    VALUE pre = rb_str_subseq(path, 0, root - ptr);
    VALUE names = rb_ary_new();
    while (ptr < end) {
        const char *next = rb_enc_path_next(ptr, end, enc);
        if (next > ptr) rb_ary_push(names, rb_str_subseq(path, ptr - beg, next - ptr));
        ptr = next;
        while (ptr < end && isdirsep(*ptr)) ++ptr;
    }
    return rb_assoc_new(pre, names);
}

#stat ⇒ stat

Returns a new ::File::Stat object for the entry at the path in self. Unlike #lstat, _does follow_symbolic links; therefore if the entry is a symbolic link, the returned object contains information for the target entry, not the symbolic link:

file_pn = Pathname('/etc/passwd')
link_pn = Pathname('/tmp/foo')
link_pn.make_symlink(file_pn)
#### Method stat follows the symlink, so the birthtimes are the same.
file_pn.stat.birthtime  # => 2025-06-10 11:10:47.358999941 -0500
link_pn.stat.birthtime  # => 2025-06-10 11:10:47.358999941 -0500
#### Method lstat does not follow the symlink, so the birthtimes are different.
file_pn.lstat.birthtime # => 2025-06-10 11:10:47.358999941 -0500
link_pn.lstat.birthtime # => 2026-09-23 14:12:00.978946471 -0500
link_pn.delete          # Clean up.
[ GitHub ]

  
# File 'pathname_builtin.rb', line 1880

def stat() File.stat(@path) end

#sticky? ⇒ Boolean

Returns whether the sticky bit is set in thespecial bits for the entry at the path in self:

pn = Pathname('/tmp/t.tmp')
pn.write('foo')
pn.stat.mode.to_s(8) # => "100664"
pn.sticky?           # => false
pn.chmod(01644)      # Set sticky bit.
pn.stat.mode.to_s(8) #  => "101644"
pn.sticky?           # => true
pn.delete # => 1     # Clean up.

Returns false on Windows.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 2667

def sticky?() FileTest.sticky?(@path) end

#sub(pattern, replacement) ⇒ Pathname #sub(pattern) {|match| ... } ⇒ Pathname

Returns a new pathname whose path is the path in self, after the specified substitutions.

Argument pattern may be a string or a Regexp; argument replacement may be a string or a hash.

Varying types for the argument values makes this method very versatile.

Below are some simple examples; for many more related examples (using strings, not pathnames), seeSubstitution Methods.

With arguments pattern and string replacement given, replaces the first matching substring with the given replacement string:

pn = Pathname('abracadabra.txt') # => #<Pathname:abracadabra.txt>
pn.sub('bra', 'xyzzy')           # => #<Pathname:axyzzycadabra.txt>
pn.sub(/bra/, 'xyzzy')           # => #<Pathname:axyzzycadabra.txt>
pn.sub('nope', 'xyzzy')          # => #<Pathname:abracadabra.txt>

With arguments pattern and hash replacement given, replaces the first matching substring with a value from the given replacement hash, or removes it:

h = {'a' => 'A', 'b' => 'B', 'c' => 'C'}
pn.sub('b', h) # => #<Pathname:aBracadabra.txt>
pn.sub(/b/, h) # => #<Pathname:aBracadabra.txt>
pn.sub(/d/, h) # => #<Pathname:abracaabra.txt>  # 'd' removed.

With argument pattern and a block given, calls the block with the first matching substring; replaces that substring with the block’s return value:

pn.sub('b') {|match| match.upcase } # => #<Pathname:aBracadabra.txt>
pn.sub(/X/) {|match| match.upcase } # => #<Pathname:abracadabra.txt>
[ GitHub ]

  
# File 'pathname.c', line 152

static VALUE
path_sub(int argc, VALUE *argv, VALUE self)
{
    VALUE str = get_strpath(self);

    if (rb_block_given_p()) {
        str = rb_block_call(str, id_sub, argc, argv, 0, 0);
    }
    else {
        str = rb_funcallv(str, id_sub, argc, argv);
    }
    return rb_class_new_instance(1, &str, rb_obj_class(self));
}

#sub_ext(replacement) ⇒ Pathname

Returns a new pathname whose path is the path in self, after specified changes:

Pathname('t.tmp').sub_ext('.txt') # => #<Pathname:t.txt>     # Extension replaced.
Pathname('temp').sub_ext('.txt')  # => #<Pathname:temp.txt>  # Extension added.
Pathname('t.tmp').sub_ext('')     # => #<Pathname:t>         # Extension removed.
[ GitHub ]

  
# File 'pathname.c', line 295

static VALUE
path_sub_ext(VALUE self, VALUE repl)
{
    VALUE path = get_strpath(self);
    rb_len_t len = RSTRING_LEN(path);
    const char *ptr = RSTRING_PTR(path);
    const char *ext = ruby_enc_find_extname(ptr, &len, rb_enc_get(path));
    if (len > 0) {
        RUBY_ASSERT(ext, "should point the last dot");
        path = rb_str_subseq(path, 0, ext - ptr);
    }
    else {
        /* no dot or dotted file */
        path = rb_str_dup(path);
    }
    path = rb_str_append(path, repl);
    return rb_class_new_instance(1, &path, rb_obj_class(self));
}

#symlink? ⇒ Boolean

Returns whether the entry at the path in self is asymbolic link:

file_pn = Pathname('/etc/passwd')
link_pn = Pathname('/tmp/foo')
link_pn.make_symlink(file_pn)
file_pn.symlink? # => false
link_pn.symlink? # => true
link_pn.delete   # Clean up.
[ GitHub ]

  
# File 'pathname_builtin.rb', line 2686

def symlink?() FileTest.symlink?(@path) end

#sysopen(mode = 'r', permissions = 0666) ⇒ Integer

Opens the file at the path in self with the given mode and permissions; returns the integer file descriptor.

If the file is to be readable, it must exist; if the file is to be writable and does not exist, it is created with the given permissions:

pn = Pathname('doc/t.tmp')
pn.write('foo')
fd = pn.sysopen             # => 5
IO.new(fd).close
fd = pn.sysopen('w')        # => 5
IO.new(fd).close
fd = pn.sysopen('r', 0o644) # => 5
IO.new(fd).close
pn.delete
[ GitHub ]

  
# File 'pathname_builtin.rb', line 1320

def sysopen(...) File.sysopen(@path, ...) end

#to_path

Alias for #to_s.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 441

alias to_path to_s

#to_s ⇒ String Also known as: #to_path

Returns a copy of the string path in self:

Pathname('nosuch/foo/bar').to_s # => "nosuch/foo/bar"
[ GitHub ]

  
# File 'pathname_builtin.rb', line 437

def to_s
  @path.dup
end

#truncate(size) ⇒ 0

Adjusts the size of file at the path in self to the given #size:

pn = Pathname('/tmp/t.tmp')
pn.write('0123456789')
pn.read   # => "0123456789"
pn.truncate(5)
pn.read   # => "01234"

Pads with null characters if necessary:

pn.truncate(10)
pn.read   # => "01234\u0000\u0000\u0000\u0000\u0000"
pn.delete # Clean up.
[ GitHub ]

  
# File 'pathname_builtin.rb', line 1965

def truncate(length) File.truncate(@path, length) end

#utime(atime, mtime) ⇒ 1

For the entry at the path in self, updates its access time to the given #atime and its modification time to the given #mtime; each given time may be a ::Time object, an integer representing a time, or nil (meaning Time.now):

pn = Pathname('/tmp/t.tmp')
pn.write('foo')
pn.atime  # => 2026-09-30 09:00:02.465505713 -0500
pn.mtime  # => 2026-09-30 09:00:02.465505713 -0500
time = Time.now
pn.utime(time, time)
pn.atime  # => 2026-09-30 09:00:23.848023883 -0500
pn.mtime  # => 2026-09-30 09:00:23.848023883 -0500
pn.utime(0, 0)
pn.atime  # => 1969-12-31 18:00:00 -0600
pn.mtime  # => 1969-12-31 18:00:00 -0600
pn.utime(nil, nil)
pn.atime  # => 2026-09-30 09:01:02.492202169 -0500
pn.mtime  # => 2026-09-30 09:01:02.492202169 -0500
pn.delete # Clean up.

Follows symbolic links; use #lutime to update the times for a symbolic link.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1997

def utime(atime, mtime) File.utime(atime, mtime, @path) end

#world_readable? ⇒ Boolean

If the entry at the path in self exists and is readable by others, returns the integerpermissions for the entry; otherwise, returns nil:

pn = Pathname('/tmp/t.tmp')
pn.world_readable?                    # => nil    # Does not exist.
pn.write('foo')                                   # Create file.
pn.world_readable?.to_s(8)            # => "664"  # World-readable.
pn.chmod(0o000)                                   # Change to unreadable.
pn.world_readable?                    # => nil    # Not readable.
pn.delete                                         # Clean up.
Pathname('.').world_readable?.to_s(8) # => "775"  # Directory.
[ GitHub ]

  
# File 'pathname_builtin.rb', line 2547

def world_readable?() File.world_readable?(@path) end

#world_writable? ⇒ Boolean

If the entry at the path in self exists and is writable by others, returns the integerpermissions for the entry; otherwise, returns nil:

pn = Pathname('/tmp/t.tmp')
pn.world_writable?                        # => nil    # Non-existent.
pn.write('foo')                                       # Create file.
pn.world_writable?                        # => nil    # Not world-writable.
pn.chmod(0o777)                                       # Make world-writable.
pn.world_writable?.to_s(8)                # => "511"  # World-writable.
pn.delete                                             # Clean up.
Pathname('/tmp').world_writable?.to_s(8)  # => "777"  # Directory.
[ GitHub ]

  
# File 'pathname_builtin.rb', line 2732

def world_writable?() File.world_writable?(@path) end

#writable? ⇒ Boolean

Returns whether entry at the path in self exists and is writable by the effective owner and group of the current process:

pn = Pathname('/tmp/secret.txt')
pn.writable?                # => false  # Non-existent.
pn.write('foo')                         # Create the file.
pn.writable?                # => true   # Writable.
pn.chmod(0o000)                         # Make non-writable.
pn.writable?                # => false  # Not writable.
pn.delete                               # Clean up.
Pathname('/etc/').writable? # => false  # Directory.

Note that filesystem security features may cause this method to return true even when the entry is not writable by the effective owner and group.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 2709

def writable?() FileTest.writable?(@path) end

#writable_real? ⇒ Boolean

Like #writable?, but checks against the real owner and group instead of the effective owner and group.

Note that filesystem security features may cause this method to return true even when the entry at the path in self is not writable by the real owner and group.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 2744

def writable_real?() FileTest.writable_real?(@path) end

#write(data, offset = 0, **opts) ⇒ nonnegative_integer

Opens the file at self.to_s, writes the given data to it, and closes the file; returns the number of bytes written.

With only argument data given, writes the given data to the file:

path = 't.tmp'
pn = Pathname.new(path)
pn.write('foo') # => 3
File.read(path) # => "foo"

If offset is zero (the default), the file is overwritten:

pn.write('bar')
File.read(path) # => "bar"

If offset in within the file content, the file is partly overwritten:

pn.write('foobarbaz')
pn.write('BAR', 3)
File.read(path) # => "fooBARbaz"

If offset is outside the file content, the file is padded with null characters "\u0000":

pn.write('bat', 12)
File.read(path) # => "fooBARbaz\u0000\u0000\u0000bat"

Optional keyword arguments opts specify:

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1357

def write(...) File.write(@path, ...) end

#zero? ⇒ Boolean

Returns whether the entry at the path in self exists and has size zero.

The entry may be a file:

pn = Pathname('/tmp/t.tmp')
pn.write('foo')
pn.zero?                # => false
pn.truncate(0) pn.zero? # => true
pn.delete               # Clean up.

The entry may be a directory:

dir_pn = Pathname('/tmp/foo')
dir_pn.mkdir
dir_pn.children.size       # => 0
#### Size is filesystem-dependent; may or may not be zero.
dir_pn.size                # => 4096
dir_pn.zero?               # => false
file_pn = dir_pn / 't.tmp' # => #<Pathname:/tmp/foo/t.tmp>
file_pn.write('foo')       # Add a file.
dir_pn.children.size       # => 1
dir_pn.size                # => 4096
dir_pn.zero?               # => false
dir_pn.rmtree

The entry may be neither of the above:

Pathname('nosuch').zero?   # => false
[ GitHub ]

  
# File 'pathname_builtin.rb', line 2786

def zero?() FileTest.zero?(@path) end