yamldirs - create directories and files (incl. contents) from yaml spec.
Project description
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 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. # `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
a single file containing the text hello world:
foo.txt: | hello world
creating two (empty) files:
- foo.txt - bar.txt
two files with content:
- foo.txt: | hello - bar.txt: | world
directory with two (empty) files:
foo: - bar - baz
empty directory (must be the literal string empty:
foo: - empty
nested directories with files:
foo: - a.txt: | contents of the file named a.txt - bar: - b.txt: | contents of the file named b.txt
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()
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for yamldirs-1.0.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 457a1db0a5261b4f0123131c66e84d2096e4fcddc54c784d519cd39afa443bca |
|
MD5 | 049b3bf2fbc9bc726f8d88c047973986 |
|
BLAKE2b-256 | f1717a43b385d92a9628e30cadf5031f53c4b9f333e53993f30a0ad0bb92ac61 |