pathlib

Module nustd.pathlib.

Nu surface for Python's pathlib module - pure path operations only.

Mirrors pathlib 1-1: Path is the class (a Form), backed by PurePath so only the lexical operations that never touch the filesystem are modeled. pathlib has no module-level functions, so there are just two layers: forms (the class) and interactions (the constructor and method atoms; property reads use core GetAttr, comparison uses the core atoms). Import it like the stdlib:

from nustd.pathlib import Path
import nustd.pathlib as pathlib    # pathlib.Path.of("a", "b"), ...

The leaves that hold these values in a Shape slot sit one submodule per fabric: nustd.pathlib.mem for nu.mem, loaded with this package, and nustd.pathlib.kv for nustd.kv, imported by its own path.

ScalarQuery

Path

pathlib path as a Form - the pure (no filesystem I/O) surface.

Path()

Path nustd.pathlib.Path. Kind ScalarQuery, sort scalar_query, cardinality scalar.

Named Path to mirror from pathlib import Path; backed by PurePath, so only the lexical operations are modeled. Build one with Path.of(...); read its components as properties; transform it with the method calls or the / operator.

Methods

Path.of()

Build a path from segments: PurePath(*segments).

Builds Path.

Undocumented: example.

Path.cwd()

The current working directory: Path.cwd().

Builds Path.

Undocumented: example.

Path.home()

The user's home directory: Path.home().

Builds Path.

Undocumented: example.

.name()

The final component (filename).

Builds Str.

Undocumented: example.

.stem()

The final component without its suffix.

Builds Str.

Undocumented: example.

.suffix()

The file extension of the final component (including the dot).

Builds Str.

Undocumented: example.

.suffixes()

All file extensions of the final component.

Builds List.

Undocumented: example.

.parts()

The path's components as a tuple.

Builds Tuple.

Undocumented: example.

.parent()

The logical parent of the path.

Builds Path.

Undocumented: example.

.root()

The root (e.g. / on POSIX).

Builds Str.

Undocumented: example.

.anchor()

The concatenation of drive and root.

Builds Str.

Undocumented: example.

.drive()

The drive (empty on POSIX).

Builds Str.

Undocumented: example.

.with_name(name)

A copy with the final component's name replaced.

Builds Path.

Arguments

Undocumented: example.

.with_stem(stem)

A copy with the final component's stem replaced.

Builds Path.

Arguments

Undocumented: example.

.with_suffix(suffix)

A copy with the final component's suffix replaced.

Builds Path.

Arguments

Undocumented: example.

.joinpath()

Join one or more components onto the path.

Builds Path.

Undocumented: example.

.relative_to(other)

The path relative to other.

Builds Path.

Arguments

Undocumented: example.

a / b

Join with /: Path.of("a") / "b".

Builds Path.

Arguments

Undocumented: example.

.as_posix()

The path as a string with forward slashes.

Builds Str.

Undocumented: example.

.as_uri()

The path as a file:// URI (requires an absolute path).

Builds Str.

Undocumented: example.

.match(pattern)

Whether the path matches a glob pattern.

Builds Bool.

Arguments

Undocumented: example.

.is_absolute()

Whether the path is absolute.

Builds Bool.

Undocumented: example.

.is_relative_to(other)

Whether the path is relative to other.

Builds Bool.

Arguments

Undocumented: example.

a > b

Builds Bool.

Arguments

Undocumented: summary, example.

a < b

Builds Bool.

Arguments

Undocumented: summary, example.

a >= b

Builds Bool.

Arguments

Undocumented: summary, example.

a <= b

Builds Bool.

Arguments

Undocumented: summary, example.

a == b

== builds the same term as eq: a value comparison, never identity.

Builds Bool.

Arguments

Undocumented: example.

a != b

!= builds the same term as ne: a value comparison, never identity.

Builds Bool.

Arguments

Undocumented: example.

.eq(other)

Whether two paths are equal.

Builds Bool.

Arguments

Undocumented: example.

.ne(other)

Whether two paths differ.

Builds Bool.

Arguments

Undocumented: example.

Inherited methods

From nu.lang.forms.Form:

Undocumented: example.