def test_collect_gallery_files(tmpdir, gallery_conf): """Test that example files are collected properly.""" rel_filepaths = ['examples/file1.py', 'examples/test.rst', 'examples/README.txt', 'examples/folder1/file1.py', 'examples/folder1/file2.py', 'examples/folder2/file1.py', 'tutorials/folder1/subfolder/file1.py', 'tutorials/folder2/subfolder/subsubfolder/file1.py'] abs_paths = [tmpdir.join(rp) for rp in rel_filepaths] for ap in abs_paths: ap.ensure() examples_path = tmpdir.join('examples') dirs = [examples_path.strpath] collected_files = set(collect_gallery_files(dirs, gallery_conf)) expected_files = set( [ap.strpath for ap in abs_paths if re.search(r'examples.*\.py$', ap.strpath)]) assert collected_files == expected_files tutorials_path = tmpdir.join('tutorials') dirs = [examples_path.strpath, tutorials_path.strpath] collected_files = set(collect_gallery_files(dirs, gallery_conf)) expected_files = set( [ap.strpath for ap in abs_paths if re.search(r'.*\.py$', ap.strpath)]) assert collected_files == expected_files
def test_collect_gallery_files(sphinx_app_wrapper, tmpdir): """Test that example files are collected properly.""" rel_filepaths = ['examples/file1.py', 'examples/test.rst', 'examples/README.txt', 'examples/folder1/file1.py', 'examples/folder1/file2.py', 'examples/folder2/file1.py', 'tutorials/folder1/subfolder/file1.py', 'tutorials/folder2/subfolder/subsubfolder/file1.py'] abs_paths = [tmpdir.join(rp) for rp in rel_filepaths] for ap in abs_paths: ap.ensure() examples_path = tmpdir.join('examples') dirs = [examples_path.strpath] collected_files = set(collect_gallery_files(dirs)) expected_files = set( [ap.strpath for ap in abs_paths if re.search(r'examples.*\.py$', ap.strpath)]) assert collected_files == expected_files tutorials_path = tmpdir.join('tutorials') dirs = [examples_path.strpath, tutorials_path.strpath] collected_files = set(collect_gallery_files(dirs)) expected_files = set( [ap.strpath for ap in abs_paths if re.search(r'.*\.py$', ap.strpath)]) assert collected_files == expected_files
def test_collect_gallery_files_ignore_pattern(tmpdir, gallery_conf): """Test that ignore pattern example files are not collected.""" rel_filepaths = ['examples/file1.py', 'examples/folder1/fileone.py', 'examples/folder1/file2.py', 'examples/folder2/fileone.py'] abs_paths = [tmpdir.join(rp) for rp in rel_filepaths] for ap in abs_paths: ap.ensure() gallery_conf['ignore_pattern'] = r'one' examples_path = tmpdir.join('examples') dirs = [examples_path.strpath] collected_files = set(collect_gallery_files(dirs, gallery_conf)) expected_files = set( [ap.strpath for ap in abs_paths if re.search(r'one', os.path.basename(ap.strpath)) is None]) assert collected_files == expected_files