dirlay 0.2.1

Directory layout object for testing and documentation

dirlay

Directory layout object for testing and documentation

Features

• Create and remove directory tree with files
• Chdir to layout subdirectories
• Display as rich tree for docs
• Syntactic sugar: mapping interface, context manager, append with | and |=
• Uses pathlib2 for Python 2

Installation

$ pip install dirlay[rich]

Usage

• TL;DR
• Create directory layout tree
• Chdir to subdirectory
• Print as tree

>>> from dirlay import DirectoryLayout, to_tree

TL;DR

>>> layout = DirLayout() | {'a': {'b/c.txt': 'ccc', 'd.txt': 'ddd'}}
>>> layout['a/b/c.txt']
PosixPath('a/b/c.txt')
>>> 'z.txt' in layout
False

Instantiate on the file system (in temporary directory by default) and remove when exiting the context.

>>> with layout:
...     layout.mktree()
...     str(layout['a/b/c.txt'].read_text())
'ccc'

Optionally, change current working directory to a layout subdir, and change back after context manager is exited.

>>> with layout:
...     layout.mktree()
...     layout.chdir('a/b')
...     str(Path('c.txt').read_text())
'ccc'

Create directory layout tree

Directory layout can be constructed from dict:

>>> layout = DirLayout({'a': {'b/c.txt': 'ccc', 'd.txt': 'ddd'}})
>>> layout.basedir is None
True
>>> layout.mktree()
>>> layout.basedir
PosixPath('/tmp/...')

And remove when not needed anymore:

>>> layout.rmtree()

Chdir to subdirectory

>>> import os
>>> os.chdir('/tmp')

When layout is instantiated, current directory remains unchanged:

>>> layout = DirLayout() | {'a': {'b/c.txt': 'ccc'}}
>>> layout.mktree()
>>> layout.getcwd()
PosixPath('/tmp')

On first chdir, initial working directory is stored internally, and will be restored on rmtree. Without argument, chdir sets current directory to layout.basedir.

>>> layout.basedir
PosixPath('/tmp/...')
>>> layout.chdir()
>>> layout.getcwd()
PosixPath('/tmp/...')

If chdir has argument, it must be a path relative to basedir.

>>> layout.chdir('a/b')
>>> layout.getcwd()
PosixPath('/tmp/.../a/b')

When directory is removed, current directory is restored:

>>> layout.rmtree()
>>> layout.getcwd()
PosixPath('/tmp')

Print as tree

>>> layout = DirLayout({'a': {'b/c.txt': 'ccc', 'd.txt': 'ddd'}})
>>> layout.print_tree()
📂 .
└── 📂 a
    ├── 📂 b
    │   └── 📄 c.txt
    └── 📄 d.txt

Display basedir path and file contents:

>>> layout.mktree()
>>> layout.print_tree(real_basedir=True, show_content=True)
📂 /tmp/...
└── 📂 a
    ├── 📂 b
    │   └── 📄 c.txt
    │       ╭─────╮
    │       │ ccc │
    │       ╰─────╯
    └── 📄 d.txt
        ╭─────╮
        │ ddd │
        ╰─────╯

Extra keyword aguments will be passed through to rich.tree.Tree:

>>> layout.print_tree(real_basedir=True, show_content=True, hide_root=True)
📂 a
├── 📂 b
│   └── 📄 c.txt
│       ╭─────╮
│       │ ccc │
│       ╰─────╯
└── 📄 d.txt
    ╭─────╮
    │ ddd │
    ╰─────╯

See also

• API Reference
• Project Documentation
• Project Changelog