ignore-python 0.1.0__cp38-none-win_amd64.whl

ignore/__init__.py

@@ -0,0 +1 @@
+from .ignore import *

ignore/__init__.pyi

@@ -0,0 +1,100 @@
+import pathlib
+from typing import Self
+
+from ignore.overrides import Override
+
+
+class Error(Exception):
+    """Represents an error that can occur during operations."""
+
+
+class IOError(Exception):
+    """
+    An error that occurs when doing I/O.
+
+    Currently, the only case where this error is used is for operating
+    system errors of type ENOENT.
+    """
+
+    errno: int
+    """A numeric error code from the C variable errno."""
+
+    filename: str
+    """The file system path involved."""
+
+
+class DirEntry:
+    """
+    A directory entry.
+
+    See https://docs.rs/ignore/latest/ignore/struct.DirEntry.html for
+    more information.
+    """
+
+    def path(self) -> pathlib.Path: ...
+
+    def depth(self) -> int: ...
+
+
+class WalkBuilder:
+    """
+    WalkBuilder builds a recursive directory iterator.
+
+    See https://docs.rs/ignore/latest/ignore/struct.WalkBuilder.html
+    for more information.
+    """
+
+    def __init__(self, path: pathlib.Path) -> None:
+        """Create a new builder for a recursive directory iterator for the directory given."""
+
+    def hidden(self, yes: bool) -> Self: ...
+
+    def ignore(self, yes: bool) -> Self: ...
+
+    def parents(self, yes: bool) -> Self: ...
+
+    def git_ignore(self, yes: bool) -> Self: ...
+
+    def git_global(self, yes: bool) -> Self: ...
+
+    def git_exclude(self, yes: bool) -> Self: ...
+
+    def require_git(self, yes: bool) -> Self: ...
+
+    def overrides(self, overrides: Override) -> Self: ...
+
+    def follow_links(self, yes: bool) -> Self: ...
+
+    def same_file_system(self, yes: bool) -> Self: ...
+
+    def max_depth(self, depth: int | None = None) -> Self: ...
+
+    def add_custom_ignore_filename(self, file_name: str) -> Self: ...
+
+    def add(self, path: pathlib.Path) -> Self: ...
+
+    def add_ignore(self, path: pathlib.Path) -> None: ...
+
+    def build(self) -> Walk: ...
+
+
+class Walk:
+    """
+    Walk is a recursive directory iterator over file paths in one or more directories.
+
+    See https://docs.rs/ignore/latest/ignore/struct.Walk.html for more
+    information.
+    """
+
+    def __init__(self, path: pathlib.Path) -> None:
+        """Creates a new recursive directory iterator for the file path given."""
+
+    def __iter__(self) -> Self: ...
+
+    def __next__(self) -> DirEntry:
+        """
+        Advances the iterator and returns the next value.
+
+        :raises IOError: Currently, only when a ENOENT error happens
+        (e.g. broken symlinks when following them)
+        """

ignore/overrides/__init__.pyi

@@ -0,0 +1,25 @@
+import pathlib
+from typing import Self
+
+
+class Override:
+    """
+    Manages a set of overrides provided explicitly by the end user.
+
+    See https://docs.rs/ignore/latest/ignore/overrides/struct.Override.html for more information.
+    """
+
+
+class OverrideBuilder:
+    """
+    Builds a matcher for a set of glob overrides.
+
+    See https://docs.rs/ignore/latest/ignore/overrides/struct.OverrideBuilder.html for more information.
+    """
+
+    def __init__(self, path: pathlib.Path) -> None:
+        """Create a new override builder."""
+
+    def build(self) -> Override: ...
+
+    def add(self, glob: str) -> Self: ...

ignore_python-0.1.0.dist-info/METADATA

@@ -0,0 +1,55 @@
+Metadata-Version: 2.3
+Name: ignore-python
+Version: 0.1.0
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+License-File: LICENSE.txt
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+
+# ignore in Python
+This is a Python library that binds to the Rust crate
+[ignore](https://github.com/BurntSushi/ripgrep/tree/master/crates/ignore).
+
+ignore's Python bindings can be used for building a fast recursive
+directory iterator that respects various filters such as globs, file
+types and `.gitignore` files.
+
+## Example
+This example shows the most basic usage of this package. This code
+will recursively traverse the current directory while automatically
+filtering out files and directories according to ignore globs found in
+files like `.ignore` and `.gitignore`:
+
+```python
+from ignore import Walk
+
+for entry in Walk("./"):
+	print(entry.path())
+```
+
+## Example: advanced
+By default, the recursive directory iterator will ignore hidden files and directories. This can be disabled by building the iterator with `WalkBuilder`:
+
+```python
+from ignore import WalkBuilder
+
+for entry in WalkBuilder("./").hidden(False).build():
+	print(entry.path())
+```
+
+Refer to the [API documentation](https://borsattoz.github.io/ignore-python) for more information.
+
+## How to install (from pip)
+```sh
+pip install ignore-python
+# or
+python -m pip install ignore-python
+```
+
+## How to develop
+This assumes that you have rust and cargo installed. I use the
+workflow recommended by [pyo3](https://github.com/PyO3/pyo3) and
+[maturin](https://github.com/PyO3/maturin).
+

ignore_python-0.1.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+ignore_python-0.1.0.dist-info/METADATA,sha256=nny4byFi0cUNnyqBomQVmLuuxrJ9VtG2DVEca7LMuPA,1754
+ignore_python-0.1.0.dist-info/WHEEL,sha256=-guPU4lo10KD1AzVI_4ZU9dzpXKpVXntHq12iPmG5yE,94
+ignore_python-0.1.0.dist-info/license_files/LICENSE.txt,sha256=jiHYUToyQDxHxfl1uJu46PFHYiv3jm1OPT--5qKSysY,1094
+ignore/overrides/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ignore/overrides/__init__.pyi,sha256=YCXFwT83pO-3qzSOzjH7vXZlhxV5bCLKxbPuNtWR-HY,641
+ignore/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ignore/__init__.py,sha256=M5KX00vnQSTlKos8XxRuiwKu0A5rzv2qRPMdcrjx4uY,23
+ignore/__init__.pyi,sha256=1GQlU3jDQX6wzI5TqVqcf0e6WM4A6_dOSQPclHwzemY,2559
+ignore/ignore.cp38-win_amd64.pyd,sha256=BpEX8SasramhP57AZD3MJ6A64KmFjsHNW7CqcuAWv6w,1840640
+ignore_python-0.1.0.dist-info/RECORD,,

ignore_python-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.7.0)
+Root-Is-Purelib: false
+Tag: cp38-none-win_amd64

ignore_python-0.1.0.dist-info/license_files/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Stefano Borsatto
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.