Skip to main content

Extends the standard library pathlib.Path class.

Project description

pathier

Extends the standard library pathlib.Path class.

Installation

Install with:

pip install pathier

Usage

Functions the same as pathlib.Path, but with added functions and some altered default arguments.

Navigation

New paths can be obtained by:

  • naming the parent with moveup()
  • subtracting a number of levels from the current path
  • naming the parent of the path you actually want with move_under()
  • separating a relative path at a named parent with separate()
  • set current working directory to path
>>> from pathier import Pathier
>>> path = Pathier("C:/some/directory/to/some/file/on/the/system")
>>> path.moveup("directory")
WindowsPath('C:/some/directory')
>>> path - 3
WindowsPath('C:/some/directory/to/some/file')
>>> path.move_under("directory")
WindowsPath('C:/some/directory/to')
>>> path.separate("file")
WindowsPath('on/the/system')
>>> path.separate("file", True)
WindowsPath('file/on/the/system')
>>> path.mkcwd()
>>> Pathier.cwd()
WindowsPath('C:/some/directory/to/some/file/on/the/system')

Environment PATH Variable

Pathier objects can be added and removed from sys.path:
(The path will only be added if it isn't already in sys.path)

>>> from pathier import Pathier
>>> path = Pathier.cwd()
>>> path.in_PATH
False
>>> path.add_to_PATH(0)
>>> path.in_PATH
True
>>> path.remove_from_PATH()
>>> path.in_PATH
False
>>> path.append_to_PATH()
>>> path.in_PATH
True

Read and Write

Can dump and load toml and json files without needed to explicityly import and call functions from the respective libraries:

from pathier import Pathier
path = Pathier("some_file.toml")
content = path.loads()
path.with_suffix(".json").dumps(content, indent=2)

Pathier().mkdir() creates parent directories and doesn't throw an error if the path already exists by default.

Pathier().write_text() and Pathier().write_bytes() will create parent directories by default if they won't exist.

Pathier().write_text() will also try to cast the data to be written to a string if a TypeError is thrown.

Pathier().delete() will delete a file or directory, event if that directory isn't empty.

Pathier().copy() will copy a file or a directory tree to a new destination and return a Pathier object for the new path
By default, files in the destination will not be overwritten.

Pathier().backup() will create a copy of the path with _backup appended to the stem. If the optional parameter, timestamp, is True, a datetime string will be added after _backup to prevent overwriting previous backup files.

Pathier().replace() takes a list of string pairs and will read the file the instance points to, replace the first of each pair with the second of each pair, and then write it back to the file.
Essentially just condenses reading the file, using str.replace(), and then writing the new content into one function call.

Pathier().execute() wraps calling os.system() on the path pointed to be the Pathier instance.
Optional strings that should come before and after the path string can be specified with the command and args params, respectively.
Pathier("file.py").execute("py", "--iterations 10") is equivalent to os.system("py file.py --iterations 10")

Pathier().append() will append the given string to the file pointed at by the instance.

Pathier().join(data) is equivalent to calling Pathier().write_text("\n".join(data)).
The joining string can be specified with the sep parameter.

Pathier().split() is equivalent to calling Pathier().read_text().splitlines().
Optionally, line endings can be kept with Pathier().split(keepends=True).

Stats and Comparisons

>>> from pathier import Pathier
>>> p = Pathier.cwd() / "pathier.py"
>>> i = p.parent / "__init__.py"
>>> p.dob
datetime.datetime(2023, 3, 31, 18, 43, 12, 360000)
>>> p.age
8846.024934
>>> p.mod_date
datetime.datetime(2023, 3, 31, 21, 7, 30)
>>> p.mod_delta
207.488857
>>> p.size
10744
>>> p.format_bytes(p.size)
'10.74 kb'
>>> p.formatted_size
'10.74 kb'
>>> p.is_larger(i)
True
>>> p.is_older(i)
False
>>> p.modified_more_recently(i)
True

CLI Scripts

Execute sizeup from a terminal to get a grid of sub-directories and their sizes.

P:\python\projects\pathier>sizeup
Sizing up 7 directories...
Scanning 'dist' [____________________________________________________________________________________________________________________________________________]-100.00%
+---------------+-----------+
| Dir           | Size      |
+===============+===========+
| docs          | 362.74 kb |
+---------------+-----------+
| tests         | 63.69 kb  |
+---------------+-----------+
| dist          | 61.78 kb  |
+---------------+-----------+
| src           | 50.91 kb  |
+---------------+-----------+
| .git          | 24.25 kb  |
+---------------+-----------+
| .pytest_cache | 540 bytes |
+---------------+-----------+
| .vscode       | 197 bytes |
+---------------+-----------+
Total size of 'P:\python\projects\pathier': 564.11 kb
sizeup average execution time: 37ms 895us

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pathier-1.2.0.tar.gz (54.8 kB view details)

Uploaded Source

Built Distribution

pathier-1.2.0-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

Details for the file pathier-1.2.0.tar.gz.

File metadata

  • Download URL: pathier-1.2.0.tar.gz
  • Upload date:
  • Size: 54.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for pathier-1.2.0.tar.gz
Algorithm Hash digest
SHA256 c609ca55cc2aa8d9c3764db7894e2b1642192e2c5f7edb0b1de3daecc4afe34d
MD5 8d25da83d8a4b505b684608777434b7b
BLAKE2b-256 a63c1ce946190615c8b8374be1b7d1ff46aca04d1e24b3a6a5d19dc2d12385dc

See more details on using hashes here.

Provenance

File details

Details for the file pathier-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: pathier-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 9.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for pathier-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 35e8b45c078aaaab0895327fd9c75905457d3821f8df8871d704d876c545eabd
MD5 ae7dd1b55da62e507309847df67d65df
BLAKE2b-256 bafbc23be0cf1f2ae12e7abb9c3f78e87181fc435dc68dd29c6820f6d368f5ec

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page