https://github.com/bagrat/pyerarchy

Access file system using objects
https://github.com/bagrat/pyerarchy

Last synced: 13 days ago
JSON representation

Access file system using objects

• Host: GitHub
• URL: https://github.com/bagrat/pyerarchy
• Owner: bagrat
• License: mit
• Created: 2015-01-09T23:12:48.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2015-07-09T09:34:07.000Z (over 9 years ago)
• Last Synced: 2024-10-19T11:28:42.472Z (25 days ago)
• Language: Python
• Homepage:
• Size: 199 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
Pyerarchy

=========

Pyerarchy is a Python package for easy file system surfing and manipulation. It enables to interact with the file system

directly as Python objects without making implicit calls to ``os`` package. Finally it makes the code much more readable

and nice.

Basic Usage

-----------

The central point of Pyerarchy is the Node. The basic usage starts by initializing an entry point Node and manipulating

it further::

    node = Node('entry/point/path')  # Initialize a new node

    children = node.ls()  # List all child entities of the node

    node.mkdir('newdir').mkdir('anotherdir')  # Create a new directory under node, and another one under the new one :)

    # Now access the newly created directories

    anotherdir = node/'newdir'/'anotherdir'  # This is the most common way to access nodes

    children = node.newdir.anotherdir.ls()  # This method can be used to invoke an operation on the result node

    # What about files?

    myfile = node.myfile

    # And even...

    myfile = node.myfile.open('w')

    # Or...

    contents = node.myfile.read()  # ...which handles everything

    # What if the filename contains a dot, dash, etc?

    # Well...

    myfile_node = node/'filename.with.dots-and-dashes'

    # And then do your stuff on myfile_node

    with myfile_node.open('r') as f:

        ...

    # Or again...

    contents = myfile_node.read()

    # And finally, just iterate...

    for child in node

        # The child is also a Node object

        ...

Another useful feature of Pyerarchy is very handy in Python modules to interact with static files included in the module::

    static_data_node = ThisModuleNode()/'path/to/the/static/data/relative/to/module'

    some_file_node = static_data_node/'some/static/text/file'

    contents = some_file_node.read()