Improve order of imports and __all__ in git.refs submodules

Author: EliahKagan

Diff for: git/refs/head.py

@@ -6,12 +6,14 @@
 Note the distinction between the :class:`HEAD` and :class:`Head` classes.
 """
 
+__all__ = ["HEAD", "Head"]
+
 from git.config import GitConfigParser, SectionConstraint
-from git.util import join_path
 from git.exc import GitCommandError
+from git.util import join_path
 
-from .symbolic import SymbolicReference
 from .reference import Reference
+from .symbolic import SymbolicReference
 
 # typing ---------------------------------------------------
 
@@ -26,8 +28,6 @@
 
 # -------------------------------------------------------------------
 
-__all__ = ["HEAD", "Head"]
-
 
 def strip_quotes(string: str) -> str:
     if string.startswith('"') and string.endswith('"'):
@@ -36,8 +36,8 @@ def strip_quotes(string: str) -> str:
 
 
 class HEAD(SymbolicReference):
-    """Special case of a SymbolicReference representing the repository's HEAD
-    reference."""
+    """Special case of a :class:`~git.refs.symbolic.SymbolicReference` representing the
+    repository's HEAD reference."""
 
     _HEAD_NAME = "HEAD"
     _ORIG_HEAD_NAME = "ORIG_HEAD"

Diff for: git/refs/log.py

@@ -1,44 +1,43 @@
 # This module is part of GitPython and is released under the
 # 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
 
+__all__ = ["RefLog", "RefLogEntry"]
+
 from mmap import mmap
+import os.path as osp
 import re
 import time as _time
 
 from git.compat import defenc
 from git.objects.util import (
-    parse_date,
     Serializable,
     altz_to_utctz_str,
+    parse_date,
 )
 from git.util import (
     Actor,
     LockedFD,
     LockFile,
     assure_directory_exists,
-    to_native_path,
     bin_to_hex,
     file_contents_ro_filepath,
+    to_native_path,
 )
 
-import os.path as osp
-
-
 # typing ------------------------------------------------------------------
 
-from typing import Iterator, List, Tuple, Union, TYPE_CHECKING
+from typing import Iterator, List, Tuple, TYPE_CHECKING, Union
 
 from git.types import PathLike
 
 if TYPE_CHECKING:
     from io import BytesIO
-    from git.refs import SymbolicReference
+
     from git.config import GitConfigParser, SectionConstraint
+    from git.refs import SymbolicReference
 
 # ------------------------------------------------------------------------------
 
-__all__ = ["RefLog", "RefLogEntry"]
-
 
 class RefLogEntry(Tuple[str, str, Actor, Tuple[int, int], str]):
     """Named tuple allowing easy access to the revlog data fields."""

Diff for: git/refs/reference.py

@@ -1,7 +1,10 @@
 # This module is part of GitPython and is released under the
 # 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
 
+__all__ = ["Reference"]
+
 from git.util import IterableObj, LazyMixin
+
 from .symbolic import SymbolicReference, T_References
 
 # typing ------------------------------------------------------------------
@@ -15,8 +18,6 @@
 
 # ------------------------------------------------------------------------------
 
-__all__ = ["Reference"]
-
 # { Utilities
 
 
@@ -34,7 +35,7 @@ def wrapper(self: T_References, *args: Any) -> _T:
     return wrapper
 
 
-# }END utilities
+# } END utilities
 
 
 class Reference(SymbolicReference, LazyMixin, IterableObj):
@@ -142,7 +143,7 @@ def iter_items(
         but will return non-detached references as well."""
         return cls._iter_items(repo, common_path)
 
-    # }END interface
+    # } END interface
 
     # { Remote Interface
 

Diff for: git/refs/remote.py

@@ -3,24 +3,23 @@
 
 """Module implementing a remote object allowing easy access to git remotes."""
 
+__all__ = ["RemoteReference"]
+
 import os
 
 from git.util import join_path
 
 from .head import Head
 
-
-__all__ = ["RemoteReference"]
-
 # typing ------------------------------------------------------------------
 
-from typing import Any, Iterator, NoReturn, Union, TYPE_CHECKING
-from git.types import PathLike
+from typing import Any, Iterator, NoReturn, TYPE_CHECKING, Union
 
+from git.types import PathLike
 
 if TYPE_CHECKING:
+    from git.remote import Remote
     from git.repo import Repo
-    from git import Remote
 
 # ------------------------------------------------------------------------------
 

Diff for: git/refs/symbolic.py

@@ -1,10 +1,14 @@
 # This module is part of GitPython and is released under the
 # 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
 
+__all__ = ["SymbolicReference"]
+
 import os
 
+from gitdb.exc import BadName, BadObject
+
 from git.compat import defenc
-from git.objects import Object
+from git.objects.base import Object
 from git.objects.commit import Commit
 from git.refs.log import RefLog
 from git.util import (
@@ -15,7 +19,6 @@
     join_path_native,
     to_native_path_linux,
 )
-from gitdb.exc import BadName, BadObject
 
 # typing ------------------------------------------------------------------
 
@@ -30,6 +33,7 @@
     Union,
     cast,
 )
+
 from git.types import AnyGitObject, PathLike
 
 if TYPE_CHECKING:
@@ -45,9 +49,6 @@
 # ------------------------------------------------------------------------------
 
 
-__all__ = ["SymbolicReference"]
-
-
 def _git_dir(repo: "Repo", path: Union[PathLike, None]) -> PathLike:
     """Find the git dir that is appropriate for the path."""
     name = f"{path}"

Diff for: git/refs/tag.py

@@ -8,23 +8,21 @@
 :mod:`git.objects.tag` module.
 """
 
-from .reference import Reference
-
 __all__ = ["TagReference", "Tag"]
 
+from .reference import Reference
+
 # typing ------------------------------------------------------------------
 
 from typing import Any, TYPE_CHECKING, Type, Union
 
 from git.types import AnyGitObject, PathLike
 
 if TYPE_CHECKING:
-    from git.objects import Commit
-    from git.objects import TagObject
+    from git.objects import Commit, TagObject
     from git.refs import SymbolicReference
     from git.repo import Repo
 
-
 # ------------------------------------------------------------------------------