PLEASE NOTE:

This library is currently still under development. The API will likely undergo significant changes that may break any code you write with it. The documentation will fall out of sync with the updates regularly until development slows down. Use it at your own risk.

Overview

Pathmagic implements two classes, File and Dir, to represent mapped file system obects in a manner similar to database ORMs like sqlalchemy. These objects have properties which perform file system operations when set, and implement many useful methods to abstract away nearly all file system I/O to a much higher degree than os.path or pathlib.

The Dir class

• Properties that perform rename and move operations when set (Dir.path, Dir.parent, Dir.name)
• Two accessor objects (Dir.files, Dir.dirs) which allow iteration over their respective collections, item access, membership tests, and more
• Two specialized accessor objects (Dir.d, Dir.f), which dynamically populate themselves with snake_cased attributes that represent the files/folders in their Dir, such that the filesystem tree can be traversed purely through attribute access
• Methods to create new files/dirs, copy/move self to another path/dir, delete self or content, and join self to a relative path
• Recursively walk the tree downwards, comparing own tree to a parallel filesystem tree
• Recursively seek files or dirs down the directory tree with inclusions/exclusions based on valid extensions and regex patterns matching name, path, and content.
• Compress self into a zipfile
• Visualize tree to arbitrary depth with an ascii representation
• Initialize from homepath, desktop, or package

The File class

• Properties that perform rename and move operations when set (File.path, File.dir, File.name, File.stem, File.extension)

• Methods to copy/move self to another path/dir or delete self

• Initialize from script entry point (in traditional interpreter), and from a package resource

• File.read() and File.write() methods (and associated File.content property) which invokes the FormatHandler class to determine how to read from/write to the file based on its extension. FormatHandler uses the factory design pattern and can be extended at runtime to enable File to handle types of files that are not supported by default.

• By default, recognized formats are the following:

  format	class accepted/returned	file extensions
  Pdf	PyPDF2	pdf
  Tabular	subtypes.Frame	xlsx, csv
  Word	docx.Document	docx
  Image	PIL.Image	png, jpf, jpeg
  Audio	pydub.AudioSegment	mp3, wav, ogg, flv
  Video	Moviepy.editor.edit	mp4, mkv, avi, gif
  Compressed	pathmagic.Dir	zip, tar
  Link	pathmagic.File or pathmagic.Dir	lnk
  Serialized	Any	pkl
  Json	Any	json
  MarkUp	subtypes.Markup	html, xml
  Default	subtypes.Str	everything else

Installation

To install use pip:

$ pip install pathmagic

Or clone the repo:

$ git clone https://github.com/matthewgdv/pathmagic.git
$ python setup.py install

Usage

Detailed usage examples coming soon.

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Report Bugs

Report bugs at https://github.com/matthewgdv/pathmagic/issues

If you are reporting a bug, please include:

• Your operating system name and version.
• Any details about your local setup that might be helpful in troubleshooting.
• Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement a fix for it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

Write Documentation

The repository could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/matthewgdv/pathmagic/issues.

If you are proposing a new feature:

• Explain in detail how it would work.
• Keep the scope as narrow as possible, to make it easier to implement.
• Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Before you submit a pull request, check that it meets these guidelines:

1. If the pull request adds functionality, it should include tests and the docs should be updated. Write docstrings for any functions that are part of the external API, and add the feature to the README.md.

2. If the pull request fixes a bug, tests should be added proving that the bug has been fixed. However, no update to the docs is necessary for bugfixes.

3. The pull request should work for the newest version of Python (currently 3.7). Older versions may incidentally work, but are not officially supported.

4. Inline type hints should be used, with an emphasis on ensuring that introspection and autocompletion tools such as Jedi are able to understand the code wherever possible.

5. PEP8 guidelines should be followed where possible, but deviations from it where it makes sense and improves legibility are encouraged. The following PEP8 error codes can be safely ignored: E121, E123, E126, E226, E24, E704, W503

6. This repository intentionally disallows the PEP8 79-character limit. Therefore, any contributions adhering to this convention will be rejected. As a rule of thumb you should endeavor to stay under 200 characters except where going over preserves alignment, or where the line is mostly non-algorythmic code, such as extremely long strings or function calls.