Skip to main content

yamldirs - create directories and files (incl. contents) from yaml spec.

Project description

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 most common usage scenario for testing will typically look like this:

from yamldirs import create_files

def test_relative_imports():
    files = """
        relimp:
            - __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.

    # `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
""")

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_root(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:
               if content:
                   fp.write(content)

if the backend has an efficient way of creating empty files you can also override::

   def make_empty_file(self, fname): ...

Project details


Download files

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

Source Distribution

yamldirs-1.0.0.zip (7.7 kB view hashes)

Uploaded Source

Built Distribution

yamldirs-1.0.0-py2.py3-none-any.whl (5.7 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page