Skip to main content

Quickly make files and directory structures.

Project description

treeshape allows you to quickly make file and directory structures on disk.

For example:

from treeshape import (
    CONTENT,
    make_tree,
    PERMISSIONS,
    )

make_tree('.', {
    'logs/': None,
    'README': {CONTENT: "A simple directory layout\n"},
    'data/input': {CONTENT: "All of our input data\n"},
    'bin/script': {CONTENT: "#!/bin/sh\necho 'Hello'\n", PERMISSIONS: 0755},
    })

Will create a directory structure that looks like this:

$ find .
.
./logs
./data
./data/input
./README
$ cat README
A simple directory layout
$ cat data/input
All of our input data

This is particularly useful for tests that touch the disk.

If being explicit isn’t really your thing, you can also create the same directory structure from a rough specification:

from treeshape import (
    from_rough_spec,
    make_tree,
    )

make_tree('.', from_rough_spec([
    'logs/',
    ('README', "A simple directory layout\n"),
    ('data/input', "All of our input data\n"),
    ('bin/script', "#!/bin/sh\necho 'Hello'\n", 0755),
    ]))

This is also provided as a Fixture (see python-fixtures). Thus, if you are using testtools, then you can also do this during your tests:

def test_a_thing(self):
    self.useFixture(FileTree(from_rough_spec([
        'logs/',
        ('README', "A simple directory layout\n"),
        ('data/input', "All of our input data\n"),
        ])))
    # your test here

Project details


Download files

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

Files for treeshape, version 0.2.1
Filename, size File type Python version Upload date Hashes
Filename, size treeshape-0.2.1.tar.gz (9.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page