Merge pull request #8 from mutating/develop

0.0.8

Author: pomponchik

README.md

@@ -67,6 +67,12 @@ for file in crawler:
 
 > ↑ This recursively prints all files in the current directory, including files in nested directories. At each iteration, we get a new [`Path` object](https://docs.python.org/3/library/pathlib.html#basic-use).
 
+By default, crawlers iterate over files only. If you need every filesystem entity found under the base directory, pass `only_files=False`:
+
+```python
+crawler = Crawler('.', only_files=False)
+```
+
 
 ## Applying a Function to Each Path
 
@@ -98,6 +104,8 @@ To set the file extensions you are interested in, use the `extensions` parameter
 crawler = Crawler('.', extensions=['.txt'])  # Iterate only on .txt files.
 ```
 
+> ⓘ The `extensions` parameter is available only in the default file-only mode, so it cannot be combined with `only_files=False`. `PythonCrawler` is always file-only.
+
 Also, if you only need Python files, you can use a special class to bypass them only, without specifying extensions:
 
 ```python

dirstree/__init__.py

@@ -2,3 +2,6 @@
 from dirstree.crawlers.python_crawler import (
     PythonCrawler as PythonCrawler,
 )
+from dirstree.errors import (
+    IncompatibleCrawlerOptionsError as IncompatibleCrawlerOptionsError,
+)

dirstree/crawlers/crawler.py

@@ -7,6 +7,7 @@
 from sigmatch import PossibleCallMatcher
 
 from dirstree.crawlers.abstract import AbstractCrawler
+from dirstree.errors import IncompatibleCrawlerOptionsError
 
 
 # TODO: add typing tests
@@ -37,7 +38,14 @@ def __init__(
         exclude: Optional[List[str]] = None,
         filter: Optional[Callable[[Path], bool]] = None,  # noqa: A002
         token: AbstractToken = DefaultToken(),  # noqa: B008
+        only_files: bool = True,
     ) -> None:
+        if extensions is not None and not only_files:
+            raise IncompatibleCrawlerOptionsError(
+                'The "extensions" and "only_files=False" options are incompatible: '
+                'extensions can be applied only when the crawler yields files, '
+                'because non-file filesystem entities do not have meaningful file extensions.',
+            )
         if extensions is not None:
             for extension in extensions:
                 if not extension.startswith('.'):
@@ -52,6 +60,7 @@ def __init__(
         self.exclude = exclude if exclude is not None else []
         self.filter = filter
         self.token = token
+        self.only_files = only_files
 
         self.addictional_repr_filters: Dict[str, Callable[[Any], bool]] = {}
 
@@ -61,6 +70,7 @@ def __repr__(self) -> str:
             'exclude': lambda x: bool(x),
             'filter': not_none,
             'token': lambda x: not isinstance(x, DefaultToken),
+            'only_files': lambda x: x is False,
         }
         filters.update(self.addictional_repr_filters)
 
@@ -72,6 +82,7 @@ def __repr__(self) -> str:
                 'exclude': self.exclude,
                 'filter': self.filter,
                 'token': self.token,
+                'only_files': self.only_files,
             },
             filters=filters,  # type: ignore[arg-type]
         )
@@ -86,8 +97,11 @@ def go(self, token: AbstractToken = DefaultToken()) -> Generator[Path, None, Non
             if token:
                 for child_path in base_path.rglob('*'):
                     if (
-                        child_path.is_file()
-                        and not excludes_spec.match_file(child_path)
+                        (not self.only_files or child_path.is_file())
+                        and not (
+                            excludes_spec.match_file(child_path)
+                            or (child_path.is_dir() and excludes_spec.match_file(f'{child_path}/'))
+                        )
                         and (self.extensions is None or child_path.suffix in self.extensions)
                         and (self.filter is None or self.filter(child_path))
                     ):

dirstree/errors.py

@@ -0,0 +1,6 @@
+class DirstreeError(Exception):
+    pass
+
+
+class IncompatibleCrawlerOptionsError(DirstreeError):
+    pass

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "dirstree"
-version = "0.0.7"
+version = "0.0.8"
 authors = [{ name = "Evgeniy Blinov", email = "zheni-b@yandex.ru" }]
 description = 'Another library for iterating through the contents of a directory'
 readme = "README.md"

tests/conftest.py

@@ -12,3 +12,8 @@ def crawl_directory_path(request):
 @pytest.fixture(params=[str, Path])
 def second_crawl_directory_path(request):
     return request.param(os.path.join('tests', 'test_files', 'walk_it_2'))
+
+
+@pytest.fixture(params=[str, Path])
+def all_entities_directory_path(request):
+    return request.param(os.path.join('tests', 'test_files', 'all_entities'))