Package: igittigitt
igittigittVersion v2.1.4 as of 2023-07-14 seeChangelogA spec-compliant gitignore parser for Python.IgittIgitt provides methods to intentionally ignore files and directories (usually to copy or distribute them).The patterns to define what should be ignored, are stored in “ignore” files, which are compatible withgit.Limitationsat the current stage the parser is ok, as long as You dont use negations (ignore globs, which starts with “!”)precedence levels are not supported correctlyaccording to the manual,  more nested ignore files have a higher precedence than less nested ignore files - this is currently
neither checked, nor supported correctly.sizelimit, hidden directories and other features might behave different from gitsome features are not implementedthe limitations are somehow a result of the incomplete documentation atgit-scm.comluckily there is a good explanation atWalkBuilder, so You can expect things
will get better over timeis it still useful ?yesif You dont need negation rules, and dont rely on correct precedence of nested rule files, it will work just fineIgnore rules - correct handling (currently not)There are many rules that influence whether a particular file or directory is skipped.
Those rules are documented here. Note that the rules assume a default configuration.glob overrides are checked. If a path matches a glob override, then matching stops.The path is then only skipped if the glob that matched the path is an ignore glob.
(An override glob is a whitelist glob unless it starts with a !, in which case it is an ignore glob.)ignore files are checked.Ignore files currently only come from git ignore files
(.gitignore, .git/info/exclude and the configured global gitignore file),
plain .ignore files, which have the same format as gitignore files, or explicitly added ignore files.The precedence order is: .ignore, .gitignore, .git/info/exclude, global gitignore and finally
explicitly added ignore files.Note that precedence between different types of ignore files is not impacted by the directory hierarchy;
any .ignore file overrides all .gitignore files.Within each precedence level, more nested ignore files have a higher precedence than less nested
ignore files. (really ? check !)if the previous step yields an ignore match, then all matching is stopped and the path is skipped.if it yields a whitelist match, then matching continues, a whitelist match can be overridden by a later matcher.unless the path is a directory, the file type matcher is run on the path.as above, if it yields an ignore match, then all matching is stopped and the path is skipped.if it yields a whitelist match, then matching continues.if the path has not been whitelisted and it is hidden, then the path is skipped.unless the path is a directory, the size of the file is compared against the max filesize limit.
If it exceeds the limit, it is skipped.Ignore rules - current handling (not spec compliant)no precedence levels are supported, rules are just sorted by length (which is terribly wrong if negation rules are used)all other points from above are not implementedAfter reading (nesting supported) the.gitignorefile, You can match files against the parsers match function. If the file should be ignored, it matches.
We also provide an ignore function forshutil.treecopyso it is easy just to copy a directory tree without the files which should be ignored.
Amatchindicates, that the file should be ignored.Suppose/home/bitranox/project/.gitignorecontains the following:# /home/bitranox/project/.gitignore__pycache__/*.py[cod]Then:>>>importigittigitt>>>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)Default PatternsPatterns which a user wants Git to ignore in all situations (e.g., backup or temporary files generated by
the user’s editor of choice) can be put in a file, which location is configured via environment variables :POSIX :
Its default value is $XDG_CONFIG_HOME/git/ignore. If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore is used instead.WINDOWS :
Its default value is %XDG_CONFIG_HOME%/git/ignore. If %XDG_CONFIG_HOME% is either not set or empty, %HOME%/.config/git/ignore is used instead.
If %HOME% is either not set or empty, %USERPROFILE%/git/ignore is used instead.The Usage of the default Pattern can be disabled by settingconf_igittigitt.add_default_patterns=FalseMotivationI 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 byhttps://github.com/mherrmann/gitignore_parserbut in fact I needed to
throw away almost everything, because of serious matching bugs and unmaintainable spaghetti code.igittigittmeaning (german):often perceived as an exaggeration exclamation of rejection, rejection full of disgust, disgust (mostly used by young children)synonyms:ugh, brr, ugh devil, yuckoriginprobably covering for: o God, ogottogottautomated tests, Github Actions, Documentation, Badges, etc. are managed withPizzaCutter(cookiecutter on steroids)Python version required: 3.8.0 or newertested on recent linux with python 3.8, 3.9, 3.10, 3.11, 3.12-dev, pypy-3.9, pypy-3.10 - architectures: amd64100% code coverage, flake8 style checking ,mypy static type checking ,tested underLinux, macOS, Windows, automatic daily builds and monitoringTry it OnlineUsageUsage from CommandlineInstallation and UpgradeRequirementsAcknowledgementsContributeReport IssuesPull RequestCode of ConductLicenseChangelogTry it OnlineYou might try it right away in Jupyter Notebook by using the “launch binder” badge, or clickhereUsageinit the Ignore ParserclassIgnoreParser(object):def__init__(self)->None:"""
        init the igittigitt parser.
        """>>># init as normal Instance>>>parser=igittigitt.IgnoreParser()>>>print(parser)<...IgnoreParserobjectat...>>>># init with context manager>>>withigittigitt.IgnoreParser()asparser:...print(parser)<...IgnoreParserobjectat...>add rules by rule files (the default method)defparse_rule_files(self,base_dir:PathLikeOrString,filename:str=".gitignore",add_default_patterns:bool=conf_igittigitt.add_default_patterns)->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'
    add_default_patterns
        if to add the default ignore patterns from user home directory. Those default patterns may reside at :

        LINUX : $XDG_CONFIG_HOME/git/ignore, if not set or empty
                $HOME/.config/git/ignore

        WINDOWS : %XDG_CONFIG_HOME%/git/ignore, if not set or empty
                  %HOME%/.config/git/ignore,  if not set or empty
                  %USERDATA%/git/ignore

    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 stringdefadd_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 filedefmatch(self,file_path:PathLikeOrString)->bool:"""
    returns True if the path matches the rules

    >>> # Setup
    >>> base_path = pathlib.Path(__file__).parent.parent.resolve() / 'tests/example_negation'

    >>> # Test
    >>> gitignore = IgnoreParser()
    >>> gitignore.add_rule("/*", base_path)
    >>> gitignore.add_rule("!/foo", base_path)
    >>> gitignore.add_rule("/foo/*", base_path)
    >>> gitignore.add_rule("!/foo/bar", base_path)
    >>> assert gitignore.match(base_path / "foo/bar/file.txt") == False
    >>> # assert gitignore.match(base_path / "foo/other/file.txt") == True  # this fails - because everything is wrong
    >>> # see : https://docs.rs/ignore/0.4.18/ignore/struct.WalkBuilder.html

    """shutil ignore functiondefshutil_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 CommandlineUsage: 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 informationsInstallation and UpgradeBefore You start, its highly recommended to update pip and setup tools:python -m pip --upgrade pip
python -m pip --upgrade setuptoolsto install the latest release from PyPi via pip (recommended):python -m pip install --upgrade igittigittto install the latest release from PyPi via pip, including test dependencies:python -m pip install --upgrade igittigitt[test]to install the latest version from github via pip:python -m pip install --upgrade git+https://github.com/bitranox/igittigitt.gitinclude 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.txtto install the latest development version, including test dependencies from source code:# cd ~
$ git clone https://github.com/bitranox/igittigitt.git
$ cd igittigitt
python -m pip install -e .[test]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:$gitclonehttps://github.com/bitranox/igittigitt.git$cdigittigitt# to run the tests:$maketest# to install the package$makeinstall# to clean the package$makeclean# uninstall the package$makeuninstallRequirementsfollowing modules will be automatically installed :## Project Requirementsattrsclickcli_exit_toolslib_detect_testenvwcmatchAcknowledgementsspecial thanks to “uncle bob” Robert C. Martin, especially for his books on “clean code” and “clean architecture”ContributeI would love for you to fork and send me pull request for this project.
-please ContributeLicenseThis software is licensed under theMIT license—Changelognew MAJOR version for incompatible API changes,new MINOR version for added functionality in a backwards compatible mannernew PATCH version for backwards compatible bug fixesv2.1.42023-07-14:add codeql badgemove 3rd_party_stubs outside the src directory to./.3rd_party_stubsadd pypy 3.10 testsadd python 3.12-dev testsv2.1.32023-07-13:require minimum python 3.8remove python 3.7 testsintroduce PEP517 packaging standardintroduce pyproject.toml build-systemremove setup.cfgremove setup.pyupdate black configclean ./tests/test_cli.pyupdate black configremove travis configremove bettercodehub configdo not upload .egg files to pypi.orgupdate github actions :checkout@v3andsetup-python@v4remove “better code” badgesremove python 3.6 testsadding python 3.11 testsupdate pypy tests to 3.9v2.1.22022-06-25:set __all__ accordinglypoint out limitations in Readmeintegrate github actionsadjusting tests: patterns ending with a point can not match on windowsremoving invalid escape sequencesmatch on paths with symlinks in their componentsv2.1.02021-11-18: minor releaseissue 21, support default ignore filesv2.0.52021-11-16: patch releaseIssue 18, 22, support following symlinksv2.0.42020-11-15: patch releaseIssue 16, support following symlinksv2.0.32020-10-09: service releaseupdate travis build matrix for linux 3.9-devupdate travis build matrix (paths) for windows 3.9 / 3.10bump up coveragev2.0.22020-09-20:(again) correcting matching bug in subdirectories, added tests for thatuse slotted class for rules, make it hashable and sortableavoid creating duplicate rules for better performancev2.0.12020-09-18:correct matching bug in subdirectoriesavoid redundant patterns when match subdirectoriesv2.0.02020-08-14:complete redesignget rid of regexp matchingmore testsnow correct matching in subdirs, directory names,
filenames, etc …v1.0.62020-08-14:get rid of the named tupleimplement attrsfull typing, PEP561 packageadd blacked badgev1.0.52020-08-14: fix Windows and MacOs testsv1.0.42020-08-13: handle trailing spacesv1.0.32020-08-13: handle commentsv1.0.22020-08-13: handle directoriesv1.0.12020-08-13: fix negation handlingv1.0.02020-08-13: change the API interfaceput parser in a class to keep rules therechange tests to pyteststart type annotationsimplement black codestylev0.0.12020-08-12: initial releasefork fromhttps://github.com/mherrmann/gitignore_parser