~jml/treeshape/trunk.git

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
===========
 treeshape
===========

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

For example:

.. code:: python

    from treeshape import make_tree

    make_tree('.', [
        'logs/',
        ('README', "A simple directory layout\n"),
        ('data/input', "All of our input data\n"),
    ])

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. For example:

.. code:: python

    from testtools import TestCase
    from testtools.matchers import DirExists, FileContains, FileExists
    from treeshape import FileTree

    class MyTests(TestCase):

        def test_files(self):
            tree = self.useFixture(FileTree([
                'logs/',
                ('README', "A simple directory layout\n"),
                ('data/input', "All of our input data\n"),
            ])
            self.assertThat(
                os.path.join(tree.path, 'data/input'),
                FileContains("All of our input data\n"))
            self.assertThat(os.path.join(tree.path, 'logs'), DirExists())
            self.assertThat(os.path.join(tree.path, 'README'), FileExists())

The ``FileTree`` fixture can also be used as a context manager:

.. code:: python

    from treeshape import FileTree

    with FileTree([('directory/newfile', 'data')]) as tree:
        newfile_path = os.path.join(tree.path, 'directory/newfile')
        with open(newfile_path) as newfile:
            assert newfile.read() == 'data'