Metadata-Version: 1.1
Name: tdir
Version: 0.9.1
Summary: Create and recursively fill a temporary directory
Home-page: https://github.com/rec/tdir
Author: Tom Ritchford
Author-email: tom@swirly.com
License: MIT
Description: 🗃 tdir - create and fill a temporary directory 🗃
        ======================================================
        
        A context manager that creates a temporary directory using
        tempfile.TemporaryDirectory and then populates it.
        
        Extremely useful for unit tests where you want a whole directory
        full of files really fast.
        
        EXAMPLE
        
        .. code-block:: python
        
            import tdir
        
            with tdir.tdir(
                'one', 'two', 'three',
                four='two\nlines',
                sub1={
                    'six': 'A short file',
                    'seven': 'blank lines\n\n\n\n',
                    'eight': ['a', 'b', 'c']
            }) as td:
                # Now the directory `td` has files `one`, `two` and `three`, each with
                # one line, file `four` with two lines, and then a subdirectory `sub/`
                # with more files.
        
        API
        ---
        
        ``tdir.tdir(*args, cwd=True, **kwargs)``
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        (`tdir.py, 39-71 <https://github.com/rec/tdir/blob/master/tdir.py#L39-L71>`_)
        
        A context that creates and fills a temporary directory
        
        ARGUMENTS
          args:
            A list of string file names.  Each file is created and filled
            with the string value of its name.
        
          cwd:
            If true, change the working directory to the temp dir at the start
            of the context and restore the original working directory at the end.
        
          kwargs:
            A dictionary mapping file or directory names to values.
            If the key's value is a string it is used to file a file of that name.
            If it's a dictionary, its contents are used to recursively create and
            fill a directory.
        
        ``tdir.fill(root, *args, **kwargs)``
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        (`tdir.py, 73-116 <https://github.com/rec/tdir/blob/master/tdir.py#L73-L116>`_)
        
        Fill a directory with files containing strings
        
        ARGUMENTS
          root:
            The root directory to fill
        
          args:
            A list of string file names.  Each file is created and filled
            with the string value of its name.
        
          kwargs:
            A dictionary mapping file or directory names to values.
            If the key's value is a string it is used to file a file of that name.
            If it's a dictionary, its contents are used to recursively create and
            fill a directory.
        
        (automatically generated by `doks <https://github.com/rec/doks/>`_ on 2020-06-22T19:52:19.175342)
        
Keywords: testing,modules
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
