A spec-compliant gitignore parser for Python
Project description
igittigitt
Version v2.0.4 as of 2020-11-15 see Changelog
A spec-compliant gitignore parser for Python
after reading (nesting supported) the .gitignore file, You can match files against the parsers match function. If the file should be ignored, it matches.
We also provide an ignore function for shutil.treecopy so it is easy just to copy a directory tree without the files which should be ignored.
Suppose /home/bitranox/project/.gitignore contains the following:
# /home/bitranox/project/.gitignore
__pycache__/
*.py[cod]
Then:
>>> import igittigitt
>>> parser = igittigitt.IgnoreParser()
>>> parser.parse_rule_file(pathlib.Path('/home/bitranox/project/.gitignore'))
>>> parser.match(pathlib.Path('/home/bitranox/project/main.py'))
False
>>> parser.match(pathlib.Path('/home/bitranox/project/main.pyc'))
True
>>> parser.match(pathlib.Path('/home/bitranox/project/dir/main.pyc'))
True
>>> parser.match(pathlib.Path('/home/bitranox/project/__pycache__'))
True
# copy the tree without the files which should be ignored by .gitignore
>>> shutil.copytree('/home/bitranox/project', '/home/bitranox/project2', ignore=parser.shutil_ignore)
Motivation
I couldn’t find a good library for doing the above on PyPI. There are several other libraries, but they don’t seem to support all features, be it the square brackets in *.py[cod] or top-level paths /….
inspired by https://github.com/mherrmann/gitignore_parser but in fact I needed to throw away almost everything, because of serious matching bugs and unmaintainable spaghetti code.
igittigitt
- meaning (german):
often perceived as an exaggeration exclamation of rejection, rejection full of disgust, disgust (mostly used by young children)
- synonyms:
ugh, brr, ugh devil, yuck
- origin
probably covering for: o God, ogottogott
automated tests, Travis Matrix, Documentation, Badges, etc. are managed with PizzaCutter (cookiecutter on steroids)
Python version required: 3.6.0 or newer
tested on linux “bionic” with python 3.6, 3.7, 3.8, 3.9-dev, pypy3 - architectures: amd64, ppc64le, s390x, arm64
100% code coverage, flake8 style checking ,mypy static type checking ,tested under Linux, macOS, Windows, automatic daily builds and monitoring
Try it Online
You might try it right away in Jupyter Notebook by using the “launch binder” badge, or click here
Usage
init the Ignore Parser
class IgnoreParser(object):
def __init__(self) -> None:
"""
init the igittigitt parser.
"""
>>> # init as normal Instance
>>> parser = igittigitt.IgnoreParser()
>>> print(parser)
<...IgnoreParser object at ...>
>>> # init with context manager
>>> with igittigitt.IgnoreParser() as parser:
... print(parser)
<...IgnoreParser object at ...>
add rules by rule files (the default method)
def parse_rule_files(
self, base_dir: PathLikeOrString, filename: str = ".gitignore"
) -> None:
"""
get all the rule files (default = '.gitignore') from the base_dir
all subdirectories will be searched for <filename> and the rules will be appended
Parameter
---------
path_base_dir
the base directory - all subdirectories will be searched for <filename>
filename
the rule filename, default = '.gitignore'
Examples
--------
>>> # test empty rule file
>>> path_test_dir = pathlib.Path(__file__).parent.parent.resolve() / 'tests'
>>> path_source_dir = path_test_dir / 'example'
>>> # parse existing file with rules
>>> ignore_parser=IgnoreParser()
>>> ignore_parser.parse_rule_files(path_test_dir, '.test_gitignore')
>>> # parse existing file without rules
>>> ignore_parser=IgnoreParser()
>>> ignore_parser.parse_rule_files(path_test_dir, '.test_gitignore_empty')
>>> # parse none existing file
>>> ignore_parser=IgnoreParser()
>>> ignore_parser.parse_rule_files(path_test_dir, '.test_not_existing')
"""
>>> # import all .gitignore recursively from base directory
>>> ignore_parser.parse_rule_files(base_dir=path_source_dir)
>>> # import all .gitignore recursively from base directory
>>> # use another rule filename
>>> ignore_parser.parse_rule_files(base_dir=path_source_dir, filename='my_ignore_rules')
add a rule by string
def add_rule(self, pattern: str, base_path: PathLikeOrString) -> None:
"""
add a rule as a string
Parameter
---------
pattern
the pattern
base_path
since gitignore patterns are relative to a base
directory, that needs to be provided here
"""
>>> parser = igittigitt.IgnoreParser()
>>> parser.add_rule('*.py[cod]', base_path='/home/bitranox')
match a file
def match(self, file_path: PathLikeOrString) -> bool:
"""
returns True if the path matches the rules
"""
shutil ignore function
def shutil_ignore(self, base_dir: str, file_names: List[str]) -> Set[str]:
"""
Ignore function for shutil.copy_tree
"""
>>> path_source_dir = path_test_dir / "example"
>>> path_target_dir = path_test_dir / "target"
>>> ignore_parser = igittigitt.IgnoreParser()
>>> ignore_parser.parse_rule_files(base_dir=path_source_dir, filename=".test_gitignore")
>>> discard = shutil.copytree(path_source_dir, path_target_dir, ignore=ignore_parser.shutil_ignore)
Usage from Commandline
Usage: igittigitt [OPTIONS] COMMAND [ARGS]...
A spec-compliant gitignore parser for Python
Options:
--version Show the version and exit.
--traceback / --no-traceback return traceback information on cli
-h, --help Show this message and exit.
Commands:
info get program informations
Installation and Upgrade
Before You start, its highly recommended to update pip and setup tools:
python -m pip --upgrade pip
python -m pip --upgrade setuptools
to install the latest release from PyPi via pip (recommended):
python -m pip install --upgrade igittigitt
to install the latest version from github via pip:
python -m pip install --upgrade git+https://github.com/bitranox/igittigitt.git
include it into Your requirements.txt:
# Insert following line in Your requirements.txt:
# for the latest Release on pypi:
igittigitt
# for the latest development version :
igittigitt @ git+https://github.com/bitranox/igittigitt.git
# to install and upgrade all modules mentioned in requirements.txt:
python -m pip install --upgrade -r /<path>/requirements.txt
to install the latest development version from source code:
# cd ~
$ git clone https://github.com/bitranox/igittigitt.git
$ cd igittigitt
python setup.py install
via makefile: makefiles are a very convenient way to install. Here we can do much more, like installing virtual environments, clean caches and so on.
# from Your shell's homedirectory:
$ git clone https://github.com/bitranox/igittigitt.git
$ cd igittigitt
# to run the tests:
$ make test
# to install the package
$ make install
# to clean the package
$ make clean
# uninstall the package
$ make uninstall
Requirements
following modules will be automatically installed :
## Project Requirements
attrs
click
cli_exit_tools
wcmatch
Acknowledgements
special thanks to “uncle bob” Robert C. Martin, especially for his books on “clean code” and “clean architecture”
Contribute
I would love for you to fork and send me pull request for this project. - please Contribute
License
This software is licensed under the MIT license
—
Changelog
new MAJOR version for incompatible API changes,
new MINOR version for added functionality in a backwards compatible manner
new PATCH version for backwards compatible bug fixes
- TODO:
code coverage
add nested .gitignore files
documentation
v2.0.4
- 2020-11-15: patch release
Issue 16, support following symlinks
v2.0.3
- 2020-10-09: service release
update travis build matrix for linux 3.9-dev
update travis build matrix (paths) for windows 3.9 / 3.10
bump up coverage
v2.0.2
- 2020-09-20:
(again) correcting matching bug in subdirectories, added tests for that
use slotted class for rules, make it hashable and sortable
avoid creating duplicate rules for better performance
v2.0.1
- 2020-09-18:
correct matching bug in subdirectories
avoid redundant patterns when match subdirectories
v2.0.0
- 2020-08-14:
complete redesign
get rid of regexp matching
more tests
now correct matching in subdirs, directory names, filenames, etc …
v1.0.6
- 2020-08-14:
get rid of the named tuple
implement attrs
full typing, PEP561 package
add blacked badge
v1.0.5
2020-08-14: fix Windows and MacOs tests
v1.0.4
2020-08-13: handle trailing spaces
v1.0.3
2020-08-13: handle comments
v1.0.2
2020-08-13: handle directories
v1.0.1
2020-08-13: fix negation handling
v1.0.0
- 2020-08-13: change the API interface
put parser in a class to keep rules there
change tests to pytest
start type annotations
implement black codestyle
v0.0.1
- 2020-08-12: initial release
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for igittigitt-2.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 67e6486f0f22e8d1d2a3774cf03931dd4eecba67b6a56b3f27b73f538cc9ecdf |
|
MD5 | ba2f2e74da6ff4ad1f6173770df811ee |
|
BLAKE2b-256 | 2f4fa9922c73356cf5864c3ec90b30c30b51deee4f7742229e38f0d46bfffa66 |