Skip to main content

Wildcard/glob file name matcher.

Project description

Build Unix Build Status Windows Build Status Coverage PyPI Version License

Wildcard Match

Overview

Wildcard Match provides an enhanced fnmatch, glob and pathlib library in order to provide file matching and globbing that more closely follows the features found in Bash. In some ways these libraries are similar to Python's builtin libraries as they provide a similar interface to match, filter, and glob the file system. But they also include a number of features found in Bash's globbing such as backslash escaping, brace expansion, extended glob pattern groups, etc. They also add a number of new useful functions as well, such as globmatch which functions like fnmatch, but for paths. Paths that would normally be returned when providing glob a pattern should also be properly match in globmatch.

Wildcard Match uses Bash as a guide when making decisions on behavior in fnmatch and glob. Behavior may differ from Bash version to Bash version, but an attempt is made to keep Wildcard Match up with the latest relevant changes. With all of this said, there may be a few corner cases in which we've intentionally chosen to not exactly mirror Bash. If an issue is found where Wildcard Match seems to deviate in an illogical way, we'd love to hear about it in the issue tracker.

If all you are looking for is an alternative fnmatch and/or glob library that follows much more closely to Bash, or even a pathlib library that taps into a more advanced glob library, Wildcard Match has you covered, but Wildcard Match also adds a file search utility called wcmatch that is built on top of fnmatch and globmatch. It was originally written for Rummage, but split out into this project to be used by other projects that may find its approach useful.

Features

A quick overview of Wildcard Match's Features:

  • Provides an interface comparable to Python's builtin in fnamtch and glob.
  • Allows for a much more configurable experience when matching or globbing with many more features.
  • Adds support for ** in glob.
  • Adds support for escaping characters with \.
  • Add support for POSIX style character classes inside sequences: [[:alnum:]], etc. The C locale is used for byte strings and Unicode properties for Unicode strings.
  • Adds support for brace expansion: a{b,{c,d}} --> ab ac ad.
  • Adds support for extended match patterns: @(...), +(...), *(...), ?(...), and !(...).
  • Adds ability to match path names via the path centric globmatch.
  • Provides a pathlib variant that uses Wildcard Match's glob library instead of Python's default.
  • Provides an alternative file crawler called wcmatch.
  • And more...

Installation

Installation is easy with pip:

pip install wcmatch

Documentation

http://facelessuser.github.io/wcmatch/

License

The MIT License (MIT)

Copyright (c) 2018 - 2019 Isaac Muse

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wcmatch-5.0.1.tar.gz (78.7 kB view hashes)

Uploaded Source

Built Distribution

wcmatch-5.0.1-py2.py3-none-any.whl (33.8 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page