Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/katyukha/thepath
Yet another attempt to implement high-level object-oriented interface to manage path and files in D.
https://github.com/katyukha/thepath
Last synced: about 2 months ago
JSON representation
Yet another attempt to implement high-level object-oriented interface to manage path and files in D.
- Host: GitHub
- URL: https://github.com/katyukha/thepath
- Owner: katyukha
- License: mpl-2.0
- Created: 2022-09-25T16:49:36.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-09-10T20:10:19.000Z (4 months ago)
- Last Synced: 2024-10-13T11:30:06.351Z (3 months ago)
- Language: D
- Size: 102 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# The Path
Yet another attempt to implement high-level object-oriented interface
to manage path and files in D.
Inspired by [Python's pathlib](https://docs.python.org/3/library/pathlib.html)
and [D port of pathlib](https://code.dlang.org/packages/pathlib) but
implementing it in different way.
---
[](https://github.com/katyukha/thepath/actions/workflows/tests.yml?branch=master)
[](https://codecov.io/gh/katyukha/thepath)
[](https://code.dlang.org/packages/thepath)
---
Following ideas used in design of this lib:
- Implement struct `Path` that have to represent
single path to file or directory.
- Avoid implicit modification of created path as much as reasonably possible.
Any operation on path have to create new instance of `Path`,
instead of modifying original.
- Simplify naming for frequent operations
(introducing new type for this allows to do it without name collisions).
- Automatic tilde (`~`) expansion when needed
(for example before file operations),
thus allowing to easily work with path like `~/my/path`,
that will be resolved implicitly, without any special work needed.
- Make this lib as convenient as possible.
- Do not touch other paths (like URL), except filesystem path.
Easy construction of path from segments and easy conversion of path
to segments (that is array of strings) could help to deal with coversion
to and from other paths (URL).
- It is designed to work with file system paths of OS it is compiled for.
Thus, there is no sense to work with windows-style paths under the linux, etc.
- This lib have to be well tested.
## Features
- automatic expansion of `~` when needed (before passing path to std.file or std.stdio funcs)
- single method to copy path (file or directory) to dest path
- single method to remove path (file or directory)
- simple method to `walk` through the path
- `foreach(p; Path.current.walk) writeln(p.toString);`
- `foreach(p; Path("/tmp").walk) writeln(p.toString);`
- simple construction of paths from parts:
- `Path("a", "b", "c")`
- `Path("a").join("b", "c")`
- simple deconstruction of paths
- `Path("a/b/c/d").segments == ["a", "b", "c", "d"]`
- `Path("a", "b", "c", "d").segments == ["a", "b", "c", "d"]`
- overriden comparison operators for paths.
- `Path("a", "b") == Path("a", "b")`
- `Path("a", "b") != Path("a", "c")`
- `Path("a", "b") < Path("a", "c")`
- `hasAttributes` / `getAttributes` / `setAttributes` methods to work with file attrs
- file operations as methods:
- `Path("my-path").writeFile("Hello world")`
- `Path("my-path").readFile()`
- support search by glob-pattern
- `foreach(path; Path.current.glob("*.py")) writeln(p.toString);`
- easy access to some standard directories via Path's static methods:
- `Path.current` - returns path to current working directory
- `Path.tempDir` - returns path to default temporary directory
## To Do
- Any other features needed?
## Examples
```d
import thepath;
Path app_dir = Path("~/.local/my-app");
Path catalog_dir = app_dir.join("catalog");
void init() {
// Note, that automatic '~' expansion will be done before checking the
// existense of directory
if (!app_dir.exists) {
app_dir.mkdir(true); // create recursive
}
if (!catalog_dir.exists) {
catalog_dir.mkdir(true);
}
}
void list_dir() {
// Easily print content of the catalog directory
foreach(Path p; catalog_dir.walkBreadth) {
writeln(p.toAbsolute().toString());
}
}
// Print all python files in current directory
void find_python_files() {
foreach(path; Path.current.glob("*.py", SpanMode.breadth))
// Print paths relative to current directory
writeln(p.relativeTo(Path.current).toString);
}
Path findConfig() {
// Search for "my-project.conf" in current directories and in
// its parent directories
auto config = Path.current.searchFileUp("my-project.conf");
enforce(!config.isNull);
return config.get;
}
```
For more examples, check the documentation and unittests.
## License
This library is licensed under MPL-2.0 license