Skip to content

gitpython 3.1.46

Version history | Download JSON

  • PyPI https://pypi.org/project/gitpython/
    Repository https://github.com/gitpython-developers/GitPython

  • py.typed

  • Coverage

    %%{init: {"pie": {"textPosition": 0.85}, "theme": "neutral", "themeVariables": {"pieStrokeWidth": "1px"}}}%%
pie title
    "Typed" : 1331
    "Any" : 105
    "Untyped" : 120
    • 92.3% coverage
    • 85.5% coverage (strict)
    • 1556 typable
      • 1331 typed
      • 120 untyped
      • 105 Any

  • Typables

    %%{init: {"pie": {"textPosition": 0.85}, "theme": "neutral", "themeVariables": {"pieStrokeWidth": "1px"}}}%%
pie title
    "functions" : 120
    "classes" : 1270
    "other" : 17
    • 47 functions (+4 overloads)
      • 73 parameters
    • 68 classes
      • 422 methods (+7 overloads)
        • 759 parameters
      • 83 properties
    • 33 modules
      • 17 attrs

Modules

Module Coverage Coverage (strict) Typables Ignores
git 100.0% 100.0% 2 0
git.cmd 96.1% 80.3% 76 0
git.compat 90.0% 90.0% 10 0
git.config 96.0% 89.3% 75 4
git.db 100.0% 100.0% 9 0
git.diff 87.1% 85.7% 70 0
git.exc 76.3% 76.3% 38 0
git.index.base 98.2% 92.8% 111 0
git.index.fun 100.0% 100.0% 23 0
git.index.typ 96.0% 96.0% 25 0
git.index.util 92.9% 92.9% 14 0
git.objects.base 89.2% 83.8% 37 0
git.objects.blob 100.0% 100.0% 2 0
git.objects.commit 84.9% 79.5% 73 0
git.objects.fun 100.0% 100.0% 13 0
git.objects.submodule.base 96.4% 92.9% 112 1
git.objects.submodule.root 77.8% 77.8% 18 0
git.objects.submodule.util 100.0% 88.2% 17 1
git.objects.tag 72.2% 72.2% 18 0
git.objects.tree 98.4% 95.1% 61 0
git.objects.util 97.9% 77.1% 48 0
git.refs 0.0% 0.0% 0 0
git.refs.head 100.0% 89.3% 28 1
git.refs.log 97.8% 97.8% 45 0
git.refs.reference 100.0% 88.2% 17 0
git.refs.remote 100.0% 61.5% 13 1
git.refs.symbolic 98.9% 95.6% 91 0
git.refs.tag 100.0% 92.3% 13 3
git.remote 80.3% 70.1% 157 0
git.repo.base 95.7% 83.2% 184 0
git.repo.fun 100.0% 100.0% 22 0
git.types 100.0% 100.0% 13 0
git.util 83.5% 80.2% 121 2

Incomplete Annotations

git.cmd (3 missing, 12 any)

Symbol Typable Typed Any
meth Git.getattribute 2 2 1
meth Git.getattr 2 2 1
meth Git.set_persistent_git_options 2 2 1
meth Git.update_environment 2 2 1
meth Git.custom_environment 2 2 1
meth Git.transform_kwarg 4 4 1
meth Git.transform_kwargs 3 3 1
meth Git.call 2 2 1
meth Git._call_process 6 6 2
meth Git._get_persistent_cmd 5 5 2
attr Git.re_unsafe_protocol 1 0 0
attr Git.GIT_PYTHON_TRACE 1 0 0
attr Git._refresh_token 1 0 0

git.compat (1 missing, 0 any)

Symbol Typable Typed Any
attr defenc 1 0 0

git.config (3 missing, 5 any)

Symbol Typable Typed Any
meth GitConfigParser.exit 2 2 1
attr GitConfigParser.re_comment 1 0 0
attr GitConfigParser.OPTVALUEONLY 1 0 0
attr GitConfigParser.OPTCRE 1 0 0
meth SectionConstraint.getattr 2 2 1
meth SectionConstraint._call_config 4 4 3

git.diff (9 missing, 1 any)

Symbol Typable Typed Any
attr Diff.re_header 1 0 0
attr Diff.a_rawpath 1 0 0
attr Diff.b_rawpath 1 0 0
attr Diff.a_mode 1 0 0
attr Diff.b_mode 1 0 0
attr Diff.raw_rename_from 1 0 0
attr Diff.raw_rename_to 1 0 0
attr Diff.diff 1 0 0
attr Diff.score 1 0 0
meth Diffable.diff 5 5 1

git.exc (9 missing, 0 any)

Symbol Typable Typed Any
attr RepositoryDirtyError.repo 1 0 0
attr RepositoryDirtyError.message 1 0 0
attr CommandError.command 1 0 0
attr CommandError.status 1 0 0
attr CommandError.stdout 1 0 0
attr CommandError.stderr 1 0 0
attr CheckoutError.failed_files 1 0 0
attr CheckoutError.failed_reasons 1 0 0
attr CheckoutError.valid_files 1 0 0

git.index.base (2 missing, 6 any)

Symbol Typable Typed Any
meth IndexFile.from_tree 4 4 1
meth IndexFile.remove 4 4 1
meth IndexFile.move 4 4 1
meth IndexFile.checkout 5 5 1
meth IndexFile.reset 6 6 1
meth IndexFile.diff 5 5 1
attr IndexFile.repo 1 0 0
attr IndexFile.version 1 0 0

git.index.typ (1 missing, 0 any)

Symbol Typable Typed Any
attr BlobFilter.paths 1 0 0

git.index.util (1 missing, 0 any)

Symbol Typable Typed Any
attr TemporaryFileSwap.file_path 1 0 0

git.objects.base (4 missing, 2 any)

Symbol Typable Typed Any
meth Object.eq 2 2 1
meth Object.ne 2 2 1
attr Object.repo 1 0 0
attr Object.binsha 1 0 0
attr IndexObject.mode 1 0 0
attr IndexObject.path 1 0 0

git.objects.commit (11 missing, 4 any)

Symbol Typable Typed Any
meth Commit.replace 2 2 1
meth Commit.count 3 3 1
meth Commit.iter_items 5 5 1
meth Commit.iter_parents 3 3 1
attr Commit.binsha 1 0 0
attr Commit.tree 1 0 0
attr Commit.author 1 0 0
attr Commit.authored_date 1 0 0
attr Commit.author_tz_offset 1 0 0
attr Commit.committer 1 0 0
attr Commit.committed_date 1 0 0
attr Commit.committer_tz_offset 1 0 0
attr Commit.message 1 0 0
attr Commit.encoding 1 0 0
attr Commit.gpgsig 1 0 0

git.objects.submodule.base (4 missing, 4 any)

Symbol Typable Typed Any
attr UpdateProgress.CLONE 1 0 0
attr UpdateProgress.FETCH 1 0 0
attr UpdateProgress.UPDWKTREE 1 0 0
meth Submodule.eq 2 2 1
meth Submodule._clone_repo 8 8 1
meth Submodule.iter_items 5 5 2
attr Submodule.size 1 0 0

git.objects.submodule.root (4 missing, 0 any)

Symbol Typable Typed Any
attr RootUpdateProgress.REMOVE 1 0 0
attr RootUpdateProgress.PATHCHANGE 1 0 0
attr RootUpdateProgress.BRANCHCHANGE 1 0 0
attr RootUpdateProgress.URLCHANGE 1 0 0

git.objects.submodule.util (0 missing, 2 any)

Symbol Typable Typed Any
meth SubmoduleConfigParser.init 3 3 2

git.objects.tag (5 missing, 0 any)

Symbol Typable Typed Any
attr TagObject.tag 1 0 0
attr TagObject.tagger 1 0 0
attr TagObject.tagged_date 1 0 0
attr TagObject.tagger_tz_offset 1 0 0
attr TagObject.message 1 0 0

git.objects.tree (1 missing, 2 any)

Symbol Typable Typed Any
meth Tree.init 5 4 0
meth Tree.list_traverse 3 3 2

git.objects.util (1 missing, 10 any)

Symbol Typable Typed Any
meth ProcessStreamAdapter.getattr 2 2 1
meth Traversable._get_intermediate_items 2 2 1
meth Traversable.list_traverse 3 3 3
meth Traversable._list_traverse 4 4 2
meth Traversable.traverse 3 3 3
attr utc 1 0 0

git.refs.head (0 missing, 3 any)

Symbol Typable Typed Any
meth Head.delete 5 5 1
meth Head.checkout 3 3 1
meth HEAD.reset 6 6 1

git.refs.log (1 missing, 0 any)

Symbol Typable Typed Any
attr RefLogEntry._re_hexsha_only 1 0 0

git.refs.reference (0 missing, 2 any)

Symbol Typable Typed Any
meth Reference.iter_items 5 5 2

git.refs.remote (0 missing, 5 any)

Symbol Typable Typed Any
meth RemoteReference.iter_items 6 6 2
meth RemoteReference.delete 4 4 1
meth RemoteReference.create 3 3 2

git.refs.symbolic (1 missing, 3 any)

Symbol Typable Typed Any
meth SymbolicReference.create 7 7 1
meth SymbolicReference.iter_items 5 5 2
attr SymbolicReference.repo 1 0 0

git.refs.tag (0 missing, 1 any)

Symbol Typable Typed Any
meth TagReference.create 7 7 1

git.remote (31 missing, 16 any)

Symbol Typable Typed Any
meth PushInfo.iter_items 4 4 2
attr PushInfo.NEW_TAG 1 0 0
attr PushInfo.NEW_HEAD 1 0 0
attr PushInfo.NO_MATCH 1 0 0
attr PushInfo.REJECTED 1 0 0
attr PushInfo.REMOTE_REJECTED 1 0 0
attr PushInfo.REMOTE_FAILURE 1 0 0
attr PushInfo.DELETED 1 0 0
attr PushInfo.FORCED_UPDATE 1 0 0
attr PushInfo.FAST_FORWARD 1 0 0
attr PushInfo.UP_TO_DATE 1 0 0
attr PushInfo.ERROR 1 0 0
attr PushInfo.flags 1 0 0
attr PushInfo.local_ref 1 0 0
attr PushInfo.remote_ref_string 1 0 0
attr PushInfo.summary 1 0 0
meth Remote.getattr 2 2 1
meth Remote.iter_items 4 4 2
meth Remote.set_url 5 5 1
meth Remote.add_url 4 4 1
meth Remote.delete_url 3 3 1
meth Remote.create 6 6 1
meth Remote.add 5 5 1
meth Remote.update 2 2 1
meth Remote.fetch 8 8 1
meth Remote.pull 7 7 1
meth Remote.push 7 7 1
attr Remote.repo 1 0 0
attr Remote.name 1 0 0
meth FetchInfo.iter_items 4 4 2
attr FetchInfo.NEW_TAG 1 0 0
attr FetchInfo.NEW_HEAD 1 0 0
attr FetchInfo.HEAD_UPTODATE 1 0 0
attr FetchInfo.TAG_UPDATE 1 0 0
attr FetchInfo.REJECTED 1 0 0
attr FetchInfo.FORCED_UPDATE 1 0 0
attr FetchInfo.FAST_FORWARD 1 0 0
attr FetchInfo.ERROR 1 0 0
attr FetchInfo._re_fetch_result 1 0 0
attr FetchInfo.ref 1 0 0
attr FetchInfo.flags 1 0 0
attr FetchInfo.note 1 0 0
attr FetchInfo.old_commit 1 0 0
attr FetchInfo.remote_ref_path 1 0 0

git.repo.base (8 missing, 23 any)

Symbol Typable Typed Any
meth Repo.exit 2 2 1
meth Repo.create_submodule 3 3 2
meth Repo.iter_submodules 3 3 2
meth Repo.submodule_update 3 3 2
meth Repo.delete_head 3 3 1
meth Repo.create_tag 6 6 1
meth Repo.create_remote 4 4 1
meth Repo.iter_trees 3 3 2
meth Repo.iter_commits 4 4 1
meth Repo.merge_base 3 3 1
meth Repo._get_untracked_files 3 3 2
meth Repo.blame_incremental 4 4 1
meth Repo.blame 6 6 1
meth Repo.init 6 6 1
meth Repo._clone 10 10 1
meth Repo.clone 7 7 1
meth Repo.clone_from 9 9 1
meth Repo.archive 5 5 1
attr Repo.git 1 0 0
attr Repo.re_whitespace 1 0 0
attr Repo.re_hexsha_only 1 0 0
attr Repo.re_hexsha_shortened 1 0 0
attr Repo.re_envvars 1 0 0
attr Repo.re_author_committer_start 1 0 0
attr Repo.re_tab_full_line 1 0 0
attr Repo.odb 1 0 0

git.util (20 missing, 4 any)

Symbol Typable Typed Any
attr RemoteProgress.BEGIN 1 0 0
attr RemoteProgress.END 1 0 0
attr RemoteProgress.COUNTING 1 0 0
attr RemoteProgress.COMPRESSING 1 0 0
attr RemoteProgress.WRITING 1 0 0
attr RemoteProgress.RECEIVING 1 0 0
attr RemoteProgress.RESOLVING 1 0 0
attr RemoteProgress.FINDING_SOURCES 1 0 0
attr RemoteProgress.CHECKING_OUT 1 0 0
attr RemoteProgress.re_op_absolute 1 0 0
attr RemoteProgress.re_op_relative 1 0 0
attr Stats.total 1 0 0
attr Stats.files 1 0 0
meth Actor.eq 2 2 1
meth Actor.ne 2 2 1
attr Actor.name_only_regex 1 0 0
attr Actor.name_email_regex 1 0 0
attr Actor.name 1 0 0
attr Actor.email 1 0 0
meth CallableRemoteProgress.update 3 3 2
attr HIDE_WINDOWS_KNOWN_ERRORS 1 0 0
attr IndexFileSHA1Writer.f 1 0 0
attr IndexFileSHA1Writer.sha1 1 0 0

Type-Ignore Comments

Flavor Count
type: ignore[override] 8
type: ignore[misc] 2
type: ignore[assignment, misc] 1
type: ignore[assignment] 1
type: ignore[type-var] 1