ignore-python 0.3.0__tar.gz → 0.3.2__tar.gz

{ignore_python-0.3.0 → ignore_python-0.3.2}/.github/workflows/CI.yml

@@ -181,8 +181,6 @@ jobs:
     strategy:
       matrix:
         platform:
-          - runner: macos-13
-            target: x86_64
           - runner: macos-14
             target: aarch64
     steps:

{ignore_python-0.3.0 → ignore_python-0.3.2}/.github/workflows/docs.yml

@@ -23,7 +23,7 @@ jobs:
       - run: python3 -m venv .venv
       - run: source .venv/bin/activate && pip install maturin pdoc
       - run: source .venv/bin/activate && maturin dev
-      - run: source .venv/bin/activate && pdoc -o docs/ --no-show-source 'ignore' '!ignore.ignore'
+      - run: source .venv/bin/activate && pdoc -o docs/ --include-undocumented --no-show-source 'ignore' '!ignore.ignore'
 
       - uses: actions/upload-pages-artifact@v3
         with:

{ignore_python-0.3.0 → ignore_python-0.3.2}/.gitignore

@@ -1,4 +1,5 @@
 /target
+/docs
 
 # Byte-compiled / optimized / DLL files
 __pycache__/
@@ -239,7 +240,7 @@ target/
 
 # Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
 # More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
-Cargo.lock
+#Cargo.lock
 
 # These are backup files generated by rustfmt
 **/*.rs.bk

{ignore_python-0.3.0 → ignore_python-0.3.2}/Cargo.lock

@@ -4,9 +4,9 @@ version = 4
 
 [[package]]
 name = "aho-corasick"
-version = "1.1.3"
+version = "1.1.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8e60d3430d3a69478ad0993f19238d2df97c507009a52b3c10addcd7f6bcb916"
+checksum = "ddd31a130427c27518df266943a5308ed92d4b226cc639f5a8f1002816174301"
 dependencies = [
  "memchr",
 ]
@@ -19,9 +19,9 @@ checksum = "c08606f8c3cbf4ce6ec8e28fb0014a2c086708fe954eaa885384a6165172e7e8"
 
 [[package]]
 name = "bstr"
-version = "1.12.0"
+version = "1.12.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "234113d19d0d7d613b40e86fb654acf958910802bcceab913a4f9e7cda03b1a4"
+checksum = "63044e1ae8e69f3b5a92c736ca6269b8d12fa7efe39bf34ddb06d102cf0e2cab"
 dependencies = [
  "memchr",
  "serde",
@@ -54,9 +54,9 @@ checksum = "d0a5c400df2834b80a4c3327b3aad3a4c4cd4de0629063962b03235697506a28"
 
 [[package]]
 name = "globset"
-version = "0.4.16"
+version = "0.4.18"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "54a1028dfc5f5df5da8a56a73e6c153c9a9708ec57232470703592a3f18e49f5"
+checksum = "52dfc19153a48bde0cbd630453615c8151bce3a5adfac7a0aebfbf0a1e1f57e3"
 dependencies = [
  "aho-corasick",
  "bstr",
@@ -73,9 +73,9 @@ checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
 
 [[package]]
 name = "ignore"
-version = "0.4.23"
+version = "0.4.25"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6d89fd380afde86567dfba715db065673989d6253f42b88179abd3eae47bda4b"
+checksum = "d3d782a365a015e0f5c04902246139249abf769125006fbe7649e2ee88169b4a"
 dependencies = [
  "crossbeam-deque",
  "globset",
@@ -89,7 +89,7 @@ dependencies = [
 
 [[package]]
 name = "ignore-python"
-version = "0.3.0"
+version = "0.3.2"
 dependencies = [
  "ignore",
  "pyo3",
@@ -97,27 +97,30 @@ dependencies = [
 
 [[package]]
 name = "indoc"
-version = "2.0.6"
+version = "2.0.7"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f4c7245a08504955605670dbf141fceab975f15ca21570696aebe9d2e71576bd"
+checksum = "79cf5c93f93228cf8efb3ba362535fb11199ac548a09ce117c9b1adc3030d706"
+dependencies = [
+ "rustversion",
+]
 
 [[package]]
 name = "libc"
-version = "0.2.174"
+version = "0.2.180"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1171693293099992e19cddea4e8b849964e9846f4acee11b3948bcc337be8776"
+checksum = "bcc35a38544a891a5f7c865aca548a982ccb3b8650a5b06d0fd33a10283c56fc"
 
 [[package]]
 name = "log"
-version = "0.4.27"
+version = "0.4.29"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "13dc2df351e3202783a1fe0d44375f7295ffb4049267b0f3018346dc122a1d94"
+checksum = "5e5032e24019045c762d3c0f28f5b6b8bbf38563a65908389bf7978758920897"
 
 [[package]]
 name = "memchr"
-version = "2.7.5"
+version = "2.8.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "32a282da65faaf38286cf3be983213fcf1d2e2a58700e808f83f4ea9a4804bc0"
+checksum = "f8ca58f447f06ed17d5fc4043ce1b10dd205e060fb3ce5b979b8ed8e59ff3f79"
 
 [[package]]
 name = "memoffset"
@@ -136,15 +139,15 @@ checksum = "42f5e15c9953c5e4ccceeb2e7382a716482c34515315f7b03532b8b4e8393d2d"
 
 [[package]]
 name = "portable-atomic"
-version = "1.11.1"
+version = "1.13.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f84267b20a16ea918e43c6a88433c2d54fa145c92a811b5b047ccbe153674483"
+checksum = "c33a9471896f1c69cecef8d20cbe2f7accd12527ce60845ff44c153bb2a21b49"
 
 [[package]]
 name = "proc-macro2"
-version = "1.0.95"
+version = "1.0.106"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "02b3e5e68a3a1a02aad3ec490a98007cbc13c37cbe84a3cd7b8e406d76e7f778"
+checksum = "8fd00f0bb2e90d81d1044c2b32617f68fcb9fa3bb7640c23e9c748e53fb30934"
 dependencies = [
  "unicode-ident",
 ]
@@ -213,18 +216,18 @@ dependencies = [
 
 [[package]]
 name = "quote"
-version = "1.0.40"
+version = "1.0.44"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1885c039570dc00dcb4ff087a89e185fd56bae234ddc7f056a945bf36467248d"
+checksum = "21b2ebcf727b7760c461f091f9f0f539b77b8e87f2fd88131e7f1b433b3cece4"
 dependencies = [
  "proc-macro2",
 ]
 
 [[package]]
 name = "regex-automata"
-version = "0.4.9"
+version = "0.4.14"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "809e8dc61f6de73b46c85f4c96486310fe304c434cfa43669d7b40f711150908"
+checksum = "6e1dd4122fc1595e8162618945476892eefca7b88c52820e74af6262213cae8f"
 dependencies = [
  "aho-corasick",
  "memchr",
@@ -233,9 +236,15 @@ dependencies = [
 
 [[package]]
 name = "regex-syntax"
-version = "0.8.5"
+version = "0.8.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a96887878f22d7bad8a3b6dc5b7440e0ada9a245242924394987b21cf2210a4c"
+
+[[package]]
+name = "rustversion"
+version = "1.0.22"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "2b15c43186be67a4fd63bee50d0303afffcef381492ebe2c5d87f324e1b8815c"
+checksum = "b39cdef0fa800fc44525c84ccb54a029961a8215f9619753635a9c0d2538d46d"
 
 [[package]]
 name = "same-file"
@@ -248,18 +257,27 @@ dependencies = [
 
 [[package]]
 name = "serde"
-version = "1.0.219"
+version = "1.0.228"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9a8e94ea7f378bd32cbbd37198a4a91436180c5bb472411e48b5ec2e2124ae9e"
+dependencies = [
+ "serde_core",
+]
+
+[[package]]
+name = "serde_core"
+version = "1.0.228"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5f0e2c6ed6606019b4e29e69dbaba95b11854410e5347d525002456dbbb786b6"
+checksum = "41d385c7d4ca58e59fc732af25c3983b67ac852c1a25000afe1175de458b67ad"
 dependencies = [
  "serde_derive",
 ]
 
 [[package]]
 name = "serde_derive"
-version = "1.0.219"
+version = "1.0.228"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5b0276cf7f2c73365f7157c8123c21cd9a50fbbd844757af28ca1f5925fc2a00"
+checksum = "d540f220d3187173da220f885ab66608367b6574e925011a9353e4badda91d79"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -268,9 +286,9 @@ dependencies = [
 
 [[package]]
 name = "syn"
-version = "2.0.104"
+version = "2.0.114"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "17b6f705963418cdb9927482fa304bc562ece2fdd4f616084c50b7023b435a40"
+checksum = "d4d107df263a3013ef9b1879b0df87d706ff80f65a86ea879bd9c31f9b307c2a"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -279,15 +297,15 @@ dependencies = [
 
 [[package]]
 name = "target-lexicon"
-version = "0.13.2"
+version = "0.13.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e502f78cdbb8ba4718f566c418c52bc729126ffd16baee5baa718cf25dd5a69a"
+checksum = "b1dd07eb858a2067e2f3c7155d54e929265c264e6f37efe3ee7a8d1b5a1dd0ba"
 
 [[package]]
 name = "unicode-ident"
-version = "1.0.18"
+version = "1.0.22"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5a5f39404a5da50712a4c1eecf25e90dd62b613502b7e925fd4e4d19b5c96512"
+checksum = "9312f7c4f6ff9069b165498234ce8be658059c6728633667c526e27dc2cf1df5"
 
 [[package]]
 name = "unindent"
@@ -307,82 +325,24 @@ dependencies = [
 
 [[package]]
 name = "winapi-util"
-version = "0.1.9"
+version = "0.1.11"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "cf221c93e13a30d793f7645a0e7762c55d169dbb0a49671918a2319d289b10bb"
+checksum = "c2a7b1c03c876122aa43f3020e6c3c3ee5c05081c9a00739faf7503aeba10d22"
 dependencies = [
  "windows-sys",
 ]
 
 [[package]]
-name = "windows-sys"
-version = "0.59.0"
+name = "windows-link"
+version = "0.2.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1e38bc4d79ed67fd075bcc251a1c39b32a1776bbe92e5bef1f0bf1f8c531853b"
-dependencies = [
- "windows-targets",
-]
+checksum = "f0805222e57f7521d6a62e36fa9163bc891acd422f971defe97d64e70d0a4fe5"
 
 [[package]]
-name = "windows-targets"
-version = "0.52.6"
+name = "windows-sys"
+version = "0.61.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "9b724f72796e036ab90c1021d4780d4d3d648aca59e491e6b98e725b84e99973"
+checksum = "ae137229bcbd6cdf0f7b80a31df61766145077ddf49416a728b02cb3921ff3fc"
 dependencies = [
- "windows_aarch64_gnullvm",
- "windows_aarch64_msvc",
- "windows_i686_gnu",
- "windows_i686_gnullvm",
- "windows_i686_msvc",
- "windows_x86_64_gnu",
- "windows_x86_64_gnullvm",
- "windows_x86_64_msvc",
+ "windows-link",
 ]
-
-[[package]]
-name = "windows_aarch64_gnullvm"
-version = "0.52.6"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "32a4622180e7a0ec044bb555404c800bc9fd9ec262ec147edd5989ccd0c02cd3"
-
-[[package]]
-name = "windows_aarch64_msvc"
-version = "0.52.6"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "09ec2a7bb152e2252b53fa7803150007879548bc709c039df7627cabbd05d469"
-
-[[package]]
-name = "windows_i686_gnu"
-version = "0.52.6"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8e9b5ad5ab802e97eb8e295ac6720e509ee4c243f69d781394014ebfe8bbfa0b"
-
-[[package]]
-name = "windows_i686_gnullvm"
-version = "0.52.6"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0eee52d38c090b3caa76c563b86c3a4bd71ef1a819287c19d586d7334ae8ed66"
-
-[[package]]
-name = "windows_i686_msvc"
-version = "0.52.6"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "240948bc05c5e7c6dabba28bf89d89ffce3e303022809e73deaefe4f6ec56c66"
-
-[[package]]
-name = "windows_x86_64_gnu"
-version = "0.52.6"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "147a5c80aabfbf0c7d901cb5895d1de30ef2907eb21fbbab29ca94c5b08b1a78"
-
-[[package]]
-name = "windows_x86_64_gnullvm"
-version = "0.52.6"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "24d5b23dc417412679681396f2b49f3de8c1473deb516bd34410872eff51ed0d"
-
-[[package]]
-name = "windows_x86_64_msvc"
-version = "0.52.6"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec"

{ignore_python-0.3.0 → ignore_python-0.3.2}/Cargo.toml

@@ -1,7 +1,8 @@
 [package]
 name = "ignore-python"
-version = "0.3.0"
+version = "0.3.2"
 edition = "2021"
+readme = "README.md"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 [lib]
@@ -10,4 +11,4 @@ crate-type = ["cdylib"]
 
 [dependencies]
 pyo3 = "0.25.1"
-ignore-rust = { version = "0.4.23", package = "ignore" }
+ignore-rust = { version = "0.4.25", package = "ignore" }

{ignore_python-0.3.0 → ignore_python-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ignore-python
-Version: 0.3.0
+Version: 0.3.2
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy

{ignore_python-0.3.0 → ignore_python-0.3.2}/ignore/__init__.pyi

@@ -5,47 +5,40 @@ from ignore.overrides import Override
 
 
 class Error(Exception):
-    """Represents an error that can occur during operations."""
-
+   """
+   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.
+    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.
+    def __init__(self, errno: int, strerror: str, filename: str) -> None: ...
 
-    See https://docs.rs/ignore/latest/ignore/struct.DirEntry.html for
-    more information.
-    """
 
+class DirEntry:
     def path(self) -> pathlib.Path: ...
 
     def depth(self) -> int: ...
 
 
-class WalkBuilder:
-    """
-    WalkBuilder builds a recursive directory iterator.
+class Walk:
+    def __init__(self, path: pathlib.Path) -> None: ...
 
-    See https://docs.rs/ignore/latest/ignore/struct.WalkBuilder.html
-    for more information.
-    """
+    def __iter__(self) -> Self: ...
+
+    def __next__(self) -> DirEntry: ...
 
-    def __init__(self, path: pathlib.Path) -> None:
-        """Create a new builder for a recursive directory iterator for the directory given."""
+
+class WalkBuilder:
+    def __init__(self, path: pathlib.Path) -> None: ...
 
     def hidden(self, yes: bool) -> Self: ...
 
@@ -79,24 +72,3 @@ class WalkBuilder:
 
     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_python-0.3.2/ignore/overrides/__init__.pyi

@@ -0,0 +1,13 @@
+import pathlib
+from typing import Self
+
+
+class Override: ...
+
+
+class OverrideBuilder:
+    def __init__(self, path: pathlib.Path) -> None: ...
+
+    def build(self) -> Override: ...
+
+    def add(self, glob: str) -> Self: ...

{ignore_python-0.3.0 → ignore_python-0.3.2}/src/lib.rs

@@ -73,7 +73,12 @@ impl<'py> IntoPyObject<'py> for Path<'_> {
     }
 }
 
-create_exception!(ignore, Error, pyo3::exceptions::PyException);
+create_exception!(
+    ignore,
+    Error,
+    pyo3::exceptions::PyException,
+    "Represents an error that can occur during operations."
+);
 
 #[pymodule]
 mod ignore {
@@ -83,13 +88,19 @@ mod ignore {
 
     struct ErrorWrapper(ignore_rust::Error);
 
+    /// 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`.
     #[pyclass(extends=pyo3::exceptions::PyException)]
     struct IOError {
+        /// A numeric error code from the C variable errno.
         #[pyo3(get)]
         errno: u32,
 
         strerror: String,
 
+        /// The file system path involved.
         #[pyo3(get)]
         filename: String,
     }
@@ -165,12 +176,16 @@ mod ignore {
         overrides.add_class::<overrides::Override>()
     }
 
+    /// A directory entry.
+    ///
+    /// See https://docs.rs/ignore/0.4.25/ignore/struct.DirEntry.html for
+    /// more information.
     #[pyclass]
     struct DirEntry(ignore_rust::DirEntry);
 
     #[pymethods]
     impl DirEntry {
-        fn path(&self) -> Path {
+        fn path(&self) -> Path<'_> {
             Path(self.0.path())
         }
 
@@ -179,6 +194,10 @@ mod ignore {
         }
     }
 
+    /// WalkBuilder builds a recursive directory iterator for the directory given.
+    ///
+    /// See https://docs.rs/ignore/0.4.25/ignore/struct.WalkBuilder.html
+    /// for more information.
     #[pyclass]
     struct WalkBuilder(ignore_rust::WalkBuilder);
 
@@ -292,6 +311,13 @@ mod ignore {
         }
     }
 
+    /// Walk is a recursive directory iterator over file paths in one or more directories.
+    ///
+    /// Currently, `__next__` raises `IOError` only when a `ENOENT` error happens (e.g. broken
+    /// symlinks when following them).
+    ///
+    /// See https://docs.rs/ignore/0.4.25/ignore/struct.Walk.html for more
+    /// information.
     #[pyclass]
     struct Walk(ignore_rust::Walk);
 
@@ -316,10 +342,16 @@ mod ignore {
     mod overrides {
         use super::*;
 
+        /// Manages a set of overrides provided explicitly by the end user.
+        ///
+        /// See https://docs.rs/ignore/0.4.25/ignore/overrides/struct.Override.html for more information.
         #[pyclass]
         #[derive(Clone)]
         pub struct Override(pub ignore_rust::overrides::Override);
 
+        /// Builds a matcher for a set of glob overrides.
+        ///
+        /// See https://docs.rs/ignore/0.4.25/ignore/overrides/struct.OverrideBuilder.html for more information.
         #[pyclass]
         pub struct OverrideBuilder(ignore_rust::overrides::OverrideBuilder);
 

ignore_python-0.3.0/ignore/overrides/__init__.pyi

@@ -1,25 +0,0 @@
-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: ...