Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commite87d3d7

Browse files
committed
Make comments more consistent and clarify license
This improves the consistency of top-of-module comments as follows:- All names of the current file are removed. Some included these while others didn't. In general, this can be useful information, which can remind readers and developers of what the file is and may even reduce mistakes. However, in GitPython, many modules inside git/ have the same name as other modules in other subdirectories of git/. So the presence of filenames would often be the same for multiple files, a condition that would be intensified if consistency were achieved by adding them everywhere. This instead removes them, which should (albeit slightly) decrease the risk of confusing modules that have the same name as each other.- All modules (.py files) inside git/ and test/, except for .py files that are entirely empty (without even comments) or are inside test/fixtures/, now have comments indicating the license and linking to it on opensource.org. Previously, some modules had this, while others did not.The comment about the license is short, and does not contain anexplicit copyright statement. No new explicit copyright statementsare added, but some top-of-modules already contained them, and thisdoes not remove (nor update or otherwise modify) them.Although explicit copyright statements are not touched, all thelicense comments are modified, including where they had previouslyappeared, to say "the 3-Clause BSD License" instead of"the BSD License", since there is no specific license known as the"BSD License" (and both the 2-clause and 3-clause BSD licenses arevery popular).This change should not be confused with#1662, which fixed anoriginally correct hyperlink that had come to redirect to a pageabout a different license. The change here does not change the linkagain. It makes the commented wording more specific, so that it isclear, even without looking at the link, which BSD license is beingreferred to.
1 parent340da6d commite87d3d7

File tree

69 files changed

+167
-119
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+167
-119
lines changed

‎git/__init__.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
# __init__.py
21
# Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors
32
#
4-
# This module is part of GitPython and is released under
5-
#the BSD License: https://opensource.org/license/bsd-3-clause/
3+
# This module is part of GitPython and is released under the
4+
#3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
65

76
# flake8: noqa
87
# @PydevCodeAnalysisIgnore

‎git/cmd.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
# cmd.py
21
# Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors
32
#
4-
# This module is part of GitPython and is released under
5-
#the BSD License: https://opensource.org/license/bsd-3-clause/
3+
# This module is part of GitPython and is released under the
4+
#3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
65

76
from __future__importannotations
87

‎git/compat.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
# compat.py
21
# Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors
32
#
4-
# This module is part of GitPython and is released under
5-
#the BSD License: https://opensource.org/license/bsd-3-clause/
3+
# This module is part of GitPython and is released under the
4+
#3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
65

76
"""Utilities to help provide compatibility with Python 3."""
87

‎git/config.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
# config.py
21
# Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors
32
#
4-
# This module is part of GitPython and is released under
5-
#the BSD License: https://opensource.org/license/bsd-3-clause/
3+
# This module is part of GitPython and is released under the
4+
#3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
65

76
"""Module containing module parser implementation able to properly read and write
87
configuration files."""

‎git/db.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# This module is part of GitPython and is released under the
2+
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
3+
14
"""Module with our own gitdb implementation - it uses the git command."""
25

36
fromgit.utilimportbin_to_hex,hex_to_bin

‎git/diff.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
# diff.py
21
# Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors
32
#
4-
# This module is part of GitPython and is released under
5-
#the BSD License: https://opensource.org/license/bsd-3-clause/
3+
# This module is part of GitPython and is released under the
4+
#3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
65

76
importre
87
fromgit.cmdimporthandle_process_output

‎git/exc.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
# exc.py
21
# Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors
32
#
4-
# This module is part of GitPython and is released under
5-
#the BSD License: https://opensource.org/license/bsd-3-clause/
3+
# This module is part of GitPython and is released under the
4+
#3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
65

76
"""Module containing all exceptions thrown throughout the git package."""
87

‎git/index/__init__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# This module is part of GitPython and is released under the
2+
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
3+
14
"""Initialize the index package."""
25

36
# flake8: noqa

‎git/index/base.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
# base.py
21
# Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors
32
#
4-
# This module is part of GitPython and is released under
5-
#the BSD License: https://opensource.org/license/bsd-3-clause/
3+
# This module is part of GitPython and is released under the
4+
#3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
65

76
fromcontextlibimportExitStack
87
importdatetime

‎git/index/fun.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# This module is part of GitPython and is released under the
2+
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
3+
14
# Standalone functions to accompany the index implementation and make it more versatile.
25
# NOTE: Autodoc hates it if this is a docstring.
36

‎git/index/typ.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# This module is part of GitPython and is released under the
2+
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
3+
14
"""Module with additional types used by the index."""
25

36
frombinasciiimportb2a_hex

‎git/index/util.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# This module is part of GitPython and is released under the
2+
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
3+
14
"""Module containing index utilities."""
25

36
fromfunctoolsimportwraps

‎git/objects/__init__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# This module is part of GitPython and is released under the
2+
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
3+
14
"""Import all submodules' main classes into the package space."""
25

36
# flake8: noqa

‎git/objects/base.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
# base.py
21
# Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors
32
#
4-
# This module is part of GitPython and is released under
5-
#the BSD License: https://opensource.org/license/bsd-3-clause/
3+
# This module is part of GitPython and is released under the
4+
#3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
65

76
fromgit.excimportWorkTreeRepositoryUnsupported
87
fromgit.utilimportLazyMixin,join_path_native,stream_copy,bin_to_hex

‎git/objects/blob.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
# blob.py
21
# Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors
32
#
4-
# This module is part of GitPython and is released under
5-
#the BSD License: https://opensource.org/license/bsd-3-clause/
3+
# This module is part of GitPython and is released under the
4+
#3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
65

76
frommimetypesimportguess_type
87
from .importbase

‎git/objects/commit.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
# commit.py
21
# Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors
32
#
4-
# This module is part of GitPython and is released under
5-
#the BSD License: https://opensource.org/license/bsd-3-clause/
3+
# This module is part of GitPython and is released under the
4+
#3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
65

76
importdatetime
87
importre

‎git/objects/fun.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# This module is part of GitPython and is released under the
2+
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
3+
14
"""Module with functions which are supposed to be as fast as possible."""
25

36
fromstatimportS_ISDIR

‎git/objects/submodule/__init__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
1+
# This module is part of GitPython and is released under the
2+
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
3+
14
# NOTE: Cannot import anything here as the top-level __init__ has to handle
25
# our dependencies.

‎git/objects/submodule/base.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# This module is part of GitPython and is released under the
2+
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
3+
14
fromioimportBytesIO
25
importlogging
36
importos

‎git/objects/submodule/root.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# This module is part of GitPython and is released under the
2+
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
3+
14
from .baseimportSubmodule,UpdateProgress
25
from .utilimportfind_first_remote_branch
36
fromgit.excimportInvalidGitRepositoryError

‎git/objects/submodule/util.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# This module is part of GitPython and is released under the
2+
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
3+
14
importgit
25
fromgit.excimportInvalidGitRepositoryError
36
fromgit.configimportGitConfigParser

‎git/objects/tag.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
# tag.py
21
# Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors
32
#
4-
# This module is part of GitPython and is released under
5-
#the BSD License: https://opensource.org/license/bsd-3-clause/
3+
# This module is part of GitPython and is released under the
4+
#3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
65

76
"""Module containing all Object-based types."""
87

‎git/objects/tree.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
# tree.py
21
# Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors
32
#
4-
# This module is part of GitPython and is released under
5-
#the BSD License: https://opensource.org/license/bsd-3-clause/
3+
# This module is part of GitPython and is released under the
4+
#3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
65

76
fromgit.utilimportIterableList,join_path
87
importgit.diffasgit_diff

‎git/objects/util.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
# util.py
21
# Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors
32
#
4-
# This module is part of GitPython and is released under
5-
#the BSD License: https://opensource.org/license/bsd-3-clause/
3+
# This module is part of GitPython and is released under the
4+
#3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
65

76
"""Module for general utility functions."""
87

‎git/refs/__init__.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1+
# This module is part of GitPython and is released under the
2+
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
3+
14
# flake8: noqa
25
# Import all modules in order, fix the names they require.
6+
37
from .symbolicimport*
48
from .referenceimport*
59
from .headimport*

‎git/refs/head.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# This module is part of GitPython and is released under the
2+
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
3+
14
fromgit.configimportGitConfigParser,SectionConstraint
25
fromgit.utilimportjoin_path
36
fromgit.excimportGitCommandError

‎git/refs/log.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# This module is part of GitPython and is released under the
2+
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
3+
14
frommmapimportmmap
25
importre
36
importtimeas_time

‎git/refs/reference.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# This module is part of GitPython and is released under the
2+
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
3+
14
fromgit.utilimport (
25
LazyMixin,
36
IterableObj,

‎git/refs/remote.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# This module is part of GitPython and is released under the
2+
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
3+
14
importos
25

36
fromgit.utilimportjoin_path

‎git/refs/symbolic.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# This module is part of GitPython and is released under the
2+
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
3+
14
fromgit.typesimportPathLike
25
importos
36

‎git/refs/tag.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# This module is part of GitPython and is released under the
2+
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
3+
14
from .referenceimportReference
25

36
__all__= ["TagReference","Tag"]

‎git/remote.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
# remote.py
21
# Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors
32
#
4-
# This module is part of GitPython and is released under
5-
#the BSD License: https://opensource.org/license/bsd-3-clause/
3+
# This module is part of GitPython and is released under the
4+
#3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
65

76
"""Module implementing a remote object allowing easy access to git remotes."""
87

‎git/repo/__init__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# This module is part of GitPython and is released under the
2+
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
3+
14
"""Initialize the Repo package."""
25

36
# flake8: noqa

‎git/repo/base.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
# base.py
21
# Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors
32
#
4-
# This module is part of GitPython and is released under
5-
#the BSD License: https://opensource.org/license/bsd-3-clause/
3+
# This module is part of GitPython and is released under the
4+
#3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
65

76
from __future__importannotations
87

‎git/repo/fun.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# This module is part of GitPython and is released under the
2+
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
3+
14
"""Module with general repository-related functions."""
25

36
from __future__importannotations

‎git/types.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# This module is part of GitPython and is released under
2-
#the BSD License: https://opensource.org/license/bsd-3-clause/
1+
# This module is part of GitPython and is released under the
2+
#3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
33

44
# flake8: noqa
55

‎git/util.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
# util.py
21
# Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors
32
#
4-
# This module is part of GitPython and is released under
5-
#the BSD License: https://opensource.org/license/bsd-3-clause/
3+
# This module is part of GitPython and is released under the
4+
#3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
65

76
fromabcimportabstractmethod
87
importcontextlib

‎test/__init__.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
# __init__.py
21
# Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors
32
#
4-
# This module is part of GitPython and is released under
5-
#the BSD License: https://opensource.org/license/bsd-3-clause/
3+
# This module is part of GitPython and is released under the
4+
#3-Clause BSD License: https://opensource.org/license/bsd-3-clause/

‎test/lib/__init__.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
# __init__.py
21
# Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors
32
#
4-
# This module is part of GitPython and is released under
5-
#the BSD License: https://opensource.org/license/bsd-3-clause/
3+
# This module is part of GitPython and is released under the
4+
#3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
65

76
# flake8: noqa
87
importinspect

‎test/lib/helper.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
# helper.py
21
# Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors
32
#
4-
# This module is part of GitPython and is released under
5-
#the BSD License: https://opensource.org/license/bsd-3-clause/
3+
# This module is part of GitPython and is released under the
4+
#3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
65

76
importcontextlib
87
fromfunctoolsimportwraps

‎test/performance/lib.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# This module is part of GitPython and is released under the
2+
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
3+
14
"""Support library for tests."""
25

36
importlogging

‎test/performance/test_commit.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors
22
#
3-
# This module is part of GitPython and is released under
4-
#the BSD License: https://opensource.org/license/bsd-3-clause/
3+
# This module is part of GitPython and is released under the
4+
#3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
55

66
"""Performance tests for commits (iteration, traversal, and serialization)."""
77

‎test/performance/test_odb.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# This module is part of GitPython and is released under the
2+
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
3+
14
"""Performance tests for object store."""
25

36
importsys

‎test/performance/test_streams.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# This module is part of GitPython and is released under the
2+
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
3+
14
"""Performance tests for data streaming."""
25

36
importos

‎test/test_actor.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
# test_actor.py
21
# Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors
32
#
4-
# This module is part of GitPython and is released under
5-
#the BSD License: https://opensource.org/license/bsd-3-clause/
3+
# This module is part of GitPython and is released under the
4+
#3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
65

76
fromtest.libimportTestBase
87
fromgitimportActor

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp