Extended Pathlib
Project description
Superpathlib
Maximize your productivity using minimal code!
Superpathlib enhances file operations, making them more intuitive and easy to implement. This library extends Python's standard library pathlib module, offering an expansive range of added features without compromising performance.
Usage
from superpathlib import Path
path = Path(filename)
1) Use properties to read & write path content in different formats
- text
- byte_content
- lines
- yaml
- json
- numpy
examples:
path.json = {key: value}
for line in path.lines:
if interesting(line):
process(line)
2) Use instance properties to get/set file metadata:
- get:
- size: filesize
- is_root: whether the owner of the file is a root user
- has_children: whether a path has children
- number_of_children: number of children in a folder
- filetype: content type of a file
- content_hash: a hash of the complete substructure found in a folder
- get & set:
- mtime: modified time
- tag: can be used for alternative ordering or metadata
examples:
path_new.mtime = path_old.mtime
if path.tag != skip_keyword and path.filetype == "video":
process(path)
3) Use class properties to access commonly used folders:
- docs
- assets
- ..
example:
names_path = Path.assets / 'names'
names = names_path.lines
4) Use additional functionality
- find(): recursively find all paths under a root that match a condition (extra options available for performance optimization)
- rmtree(): remove directory recursively
- copy_to(dest): copy content to dest
- copy_properties_to(dest): recursively copy path properties (mtime, tag) to all n-level children of dest
- tempfile(): create temporary file that can be used as context manager
- unpack(): extract archive(zip, tar, ..) file to desired folder
- pop_parent(): remove first parent from path in filesystem
- from_uri(uri): create path object from uri string
examples:
with Path.tempfile() as tmp:
do_work(logfile=tmp)
log = tmp.text
process(log)
is_git_root = lambda p: (p / '.git').exists()
for git_path in root.find(is_git_root):
process_git(git_path)
5) Enhance existing functionality
- Automatically create parents when writing files, creating new files, renaming files, ..
- Return default values when path does not exist (e.g. size = 0, lines=[])
- Support replacing folders instead files only if specified
6) Inherit from superpathlib Path to define your own additional functionality:
example:
import superpathlib
class Path(superpathlib.Path):
def count_children(self):
return sum(1 for _ in self.iterdir())
This only works if you inherit from superpathlib Path, not pathlib Path
Installation
pip install superpathlib
or
pip install superpathlib[full]
Install the packages corresponding with the properties you want to use:
- e.g. PyYaml for yaml property
- Packages listed in pyproject.toml
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
superpathlib-2.0.4.tar.gz
(16.5 kB
view hashes)
Built Distribution
Close
Hashes for superpathlib-2.0.4-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2f27fb6ef33ae3243b52e9a0ca2dd0c397be12f19ac1d6f50628d64f2aed8f58 |
|
| MD5 | 69f3f3f208e30314c8a3265ddb712c28 |
|
| BLAKE2b-256 | 71016e1877234f2c2ba7d1344e91ed8a5ee19874f77beec1c753c57a1943a4f1 |
