Skip to main content

gitignorefile

Black Linux OS X Windows PyPI

A spec-compliant .gitignore parser for Python.

Installation

pip3 install gitignorefile

Usage

gitignorefile.parse()

Parses single .gitignore file. Suppose /home/michael/project/.gitignore contains the following:

__pycache__/
*.py[cod]

Then:

import gitignorefile

matches = gitignorefile.parse("/home/michael/project/.gitignore")
matches("/home/michael/project/main.py") # False
matches("/home/michael/project/main.pyc") # True
matches("/home/michael/project/dir/main.pyc") # True
matches("/home/michael/project/__pycache__") # True

gitignorefile.ignore()

shutil.copytree() ignore function which checks if file is ignored by any .gitignore in the directory tree.

Example:

import shutil
import gitignorefile

shutil.copytree("/source", "/destination", ignore=gitignorefile.ignore())

gitignorefile.ignored()

Checks if file is ignored by any .gitignore in the directory tree.

import gitignorefile

gitignorefile.ignored("/home/michael/project/main.py") # False

gitignorefile.Cache

Caches .gitignore rules discovered in the directory tree.

import gitignorefile

matches = gitignorefile.Cache()
matches("/home/michael/project/main.py") # False
matches("/home/michael/project/main.pyc") # True
matches("/home/michael/project/dir/main.pyc") # True
matches("/home/michael/project/__pycache__") # True

Custom ignore file sources

You could override files, that will be used to fetch ignore rules. Default value is [".gitignore", ".git/info/exclude"].

import gitignorefile

matches = gitignorefile.Cache(ignore_names=[".mylovelytoolignore"])
matches("/home/michael/project/main.py") # False
matches("/home/michael/project/main.pyc") # True
matches("/home/michael/project/dir/main.pyc") # True
matches("/home/michael/project/__pycache__") # True

Credits

Metadata

Release files for gitignorefile 1.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gitignorefile 1.1.2
File Size Uploaded Provenance Actions
gitignorefile-1.1.2.tar.gz 12.2 kB Without provenance Details for gitignorefile-1.1.2.tar.gz

Release files / gitignorefile-1.1.2.tar.gz

Download URL gitignorefile-1.1.2.tar.gz
Size 12.2 kB
Tags Source
SHA-256 checksum
How to use checksums
ce1f6c97d46d7684d3dd3cf768185a3b252a715e026b6fc90103b64d826e4656
BLAKE2b-256 checksum
How to use checksums
91aed983db08d9c5f3dd593b46316d115b8988c25c554072293603a7bc7d52ed
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.8.10

Security for gitignorefile 1.1.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page