yamldirs

Create directories and files (including content) from yaml spec.

This module was created to rapidly create, and clean up, directory trees for testing purposes.

Installation:

pip install yamldirs

Usage

The YAML record syntax is:

fieldname: content
fieldname2: |
    multi
    line
    content
nested:
    record: content

yamldirs interprets a (possibly nested) yaml record structure and creates on-disk file structures that mirrors the yaml structure.

The most common usage scenario for testing will typically look like this:

from yamldirs import create_files

def test_relative_imports():
    files = """
        foodir:
            - __init__.py
            - a.py: |
                from . import b
            - b.py: |
                from . import c
            - c.py
    """
    with create_files(files) as workdir:
        # workdir is now created inside the os's temp folder, containing
        # 4 files, of which two are empty and two contain import
        # statements. Current directory is workdir.

    # `workdir` is automatically removed after the with statement.

If you don’t want the workdir to disappear (typically the case if a test fails and you want to inspect the directory tree) you’ll need to change the with-statement to:

with create_files(files, cleanup=False) as workdir:
    ...

yamldirs can of course be used outside of testing scenarios too:

from yamldirs import Filemaker

Filemaker('path/to/parent/directory', """
    foo.txt: |
        hello
    bar.txt: |
        world
""")

Syntax

The yaml syntax to create a single file:

foo.txt

Files with contents uses the YAML record (associative array) syntax with the field name (left of colon+space) is the file name, and the value is the file contents. Eg. a single file containing the text hello world:

foo.txt: hello world

for more text it is better to use a continuation line (| to keep line breaks and > to convert single newlines to spaces):

foo.txt: |
    Lorem ipsum dolor sit amet, vis no altera doctus sanctus,
    oratio euismod suscipiantur ne vix, no duo inimicus
    adversarium. Et amet errem vis. Aeterno accusamus sed ei,
    id eos inermis epicurei. Quo enim sonet iudico ea, usu
    et possit euismod.

To create empty files you can do:

foo.txt: ""
bar.txt: ""

but as a convenience you can also use yaml list syntax:

- foo.txt
- bar.txt

For even more convenience, files with content can be created using lists of records with only one field each:

- foo.txt: |
    hello
- bar.txt: |
    world

Note

This is equivalent to this json: [{"foo.txt": "hello"}, {"bar.txt": "world"}]

This is especially useful when you have a mix of empty and non-empty filess:

mymodule:
    - __init__.py
    - mymodule.py: |
        print "hello world"

directory with two (empty) files (YAML record field with list value):

foo:
    - bar
    - baz

an empty directory must use YAML’s inline list syntax:

foo: []

nested directories with files:

foo:
    - a.txt: |
        contents of the file named a.txt
    - bar:
        - b.txt: |
            contents of the file named b.txt

Note

(Json) YAML is a superset of json, so you can also use json syntax if that is more convenient.

Extending yamldirs

To extend yamldirs to work with other storage backends, you’ll need to inherit from yamldirs.filemaker.FilemakerBase and override the following methods:

class Filemaker(FilemakerBase):
    def goto_directory(self, dirname):
        os.chdir(dirname)

    def makedir(self, dirname, content):
        cwd = os.getcwd()
        os.mkdir(dirname)
        os.chdir(dirname)
        self.make_list(content)
        os.chdir(cwd)

    def make_file(self, filename, content):
        with open(filename, 'w') as fp:
            fp.write(content)

    def make_empty_file(self, fname):
        open(fname, 'w').close()

Developing yamldirs

Uploading to PyPI

• only source distribution:

  python setup.py sdist upload

• source and windows installer:

  python setup.py sdist bdist_wininst upload

• source, windows, and wheel installer:

  python setup.py sdist bdist_wininst bdist_wheel upload

• create a documentation bundle to upload to PyPi:

  python setup.py build_sphinx
  python setup.py upload_docs

Note

if you’re using this as a template for new projects, remember to python setup.py register <projectname> before you upload to PyPi.

Running tests

One of:

python setup.py test
py.test yamldirs

with coverage:

py.test --cov=yamldirs .

Building documentation

python setup.py build_sphinx

API documentation

class yamldirs.filemaker.Filemaker(root, fdef)

make_file(filename, content)

Create a new file with name filename and content content.

mkdir(dirname)

popd()

pushd(dirname)

class yamldirs.filemaker.FilemakerBase(root, fdef)

Override marked methods to do something useful. Base class serves as a dry-run step generator.

make_dict_item(dct)

make_file(filename, content)

Create a new file with name filename and content content. Must be overridden.

make_list_item(lst)

make_string_item(s)

mkdir(dirname)

popd()

pushd(dirname)

yamldirs.filemaker.create_files(*args, **kwds)

Contextmanager that creates a directory structure from a yaml descripttion.

Indices and tables

• Index
• Module Index
• Search Page