Merge branch 'black-fmt'

.flake8

@@ -25,11 +25,14 @@ ignore = E265,E266,E731,E704,
          A,
          D,
          RST, RST3
-max-line-length = 120
 
 exclude = .tox,.venv,build,dist,doc,git/ext/,test
 
 rst-roles =  # for flake8-RST-docstrings
     attr,class,func,meth,mod,obj,ref,term,var  # used by sphinx
 
 min-python-version = 3.7.0
+
+# for `black` compatibility
+max-line-length = 120
+extend-ignore = E203,W503

doc/source/conf.py

@@ -20,100 +20,99 @@
 # If your extensions are in another directory, add it here. If the directory
 # is relative to the documentation root, use os.path.abspath to make it
 # absolute, like shown here.
-#sys.path.append(os.path.abspath('.'))
-sys.path.insert(0, os.path.abspath('../..'))
+# sys.path.append(os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath("../.."))
 
 # General configuration
 # ---------------------
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest']
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.doctest"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = []
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The encoding of source files.
-#source_encoding = 'utf-8'
+# source_encoding = 'utf-8'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = 'GitPython'
-copyright = 'Copyright (C) 2008, 2009 Michael Trier and contributors, 2010-2015 Sebastian Thiel'
+project = "GitPython"
+copyright = "Copyright (C) 2008, 2009 Michael Trier and contributors, 2010-2015 Sebastian Thiel"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-with open(os.path.join(os.path.dirname(__file__), "..", "..", 'VERSION')) as fd:
+with open(os.path.join(os.path.dirname(__file__), "..", "..", "VERSION")) as fd:
     VERSION = fd.readline().strip()
 version = VERSION
 # The full version, including alpha/beta/rc tags.
 release = VERSION
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
-#language = None
+# language = None
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-#today = ''
+# today = ''
 # Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+# today_fmt = '%B %d, %Y'
 
 # List of documents that shouldn't be included in the build.
-#unused_docs = []
+# unused_docs = []
 
 # List of directories, relative to source directory, that shouldn't be searched
 # for source files.
-exclude_trees = ['build']
+exclude_trees = ["build"]
 
 # The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
+# default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-#add_module_names = True
+# add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-#show_authors = False
+# show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 
 # Options for HTML output
 # -----------------------
 
-html_theme = 'sphinx_rtd_theme'
-html_theme_options = {
-}
+html_theme = "sphinx_rtd_theme"
+html_theme_options = {}
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
+# html_title = None
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
+# html_short_title = None
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+# html_logo = None
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+# html_favicon = None
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -122,72 +121,71 @@
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+# html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
-#html_additional_pages = {}
+# html_additional_pages = {}
 
 # If false, no module index is generated.
-#html_use_modindex = True
+# html_use_modindex = True
 
 # If false, no index is generated.
-#html_use_index = True
+# html_use_index = True
 
 # If true, the index is split into individual pages for each letter.
-#html_split_index = False
+# html_split_index = False
 
 # If true, the reST sources are included in the HTML build as _sources/<name>.
-#html_copy_source = True
+# html_copy_source = True
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''
 
 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = ''
+# html_file_suffix = ''
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'gitpythondoc'
+htmlhelp_basename = "gitpythondoc"
 
 
 # Options for LaTeX output
 # ------------------------
 
 # The paper size ('letter' or 'a4').
-#latex_paper_size = 'letter'
+# latex_paper_size = 'letter'
 
 # The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
+# latex_font_size = '10pt'
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, document class [howto/manual]).
 latex_documents = [
-    ('index', 'GitPython.tex', r'GitPython Documentation',
-     r'Michael Trier', 'manual'),
+    ("index", "GitPython.tex", r"GitPython Documentation", r"Michael Trier", "manual"),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+# latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
-#latex_use_parts = False
+# latex_use_parts = False
 
 # Additional stuff for the LaTeX preamble.
-#latex_preamble = ''
+# latex_preamble = ''
 
 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
 
 # If false, no module index is generated.
-#latex_use_modindex = True
+# latex_use_modindex = True

git/__init__.py

@@ -4,8 +4,8 @@
 # This module is part of GitPython and is released under
 # the BSD License: http://www.opensource.org/licenses/bsd-license.php
 # flake8: noqa
-#@PydevCodeAnalysisIgnore
-from git.exc import *                       # @NoMove @IgnorePep8
+# @PydevCodeAnalysisIgnore
+from git.exc import *  # @NoMove @IgnorePep8
 import inspect
 import os
 import sys
@@ -14,57 +14,57 @@
 from typing import Optional
 from git.types import PathLike
 
-__version__ = 'git'
+__version__ = "git"
 
 
-#{ Initialization
+# { Initialization
 def _init_externals() -> None:
     """Initialize external projects by putting them into the path"""
-    if __version__ == 'git' and 'PYOXIDIZER' not in os.environ:
-        sys.path.insert(1, osp.join(osp.dirname(__file__), 'ext', 'gitdb'))
+    if __version__ == "git" and "PYOXIDIZER" not in os.environ:
+        sys.path.insert(1, osp.join(osp.dirname(__file__), "ext", "gitdb"))
 
     try:
         import gitdb
     except ImportError as e:
         raise ImportError("'gitdb' could not be found in your PYTHONPATH") from e
     # END verify import
 
-#} END initialization
+
+# } END initialization
 
 
 #################
 _init_externals()
 #################
 
-#{ Imports
+# { Imports
 
 try:
     from git.config import GitConfigParser  # @NoMove @IgnorePep8
-    from git.objects import *               # @NoMove @IgnorePep8
-    from git.refs import *                  # @NoMove @IgnorePep8
-    from git.diff import *                  # @NoMove @IgnorePep8
-    from git.db import *                    # @NoMove @IgnorePep8
-    from git.cmd import Git                 # @NoMove @IgnorePep8
-    from git.repo import Repo               # @NoMove @IgnorePep8
-    from git.remote import *                # @NoMove @IgnorePep8
-    from git.index import *                 # @NoMove @IgnorePep8
-    from git.util import (                  # @NoMove @IgnorePep8
+    from git.objects import *  # @NoMove @IgnorePep8
+    from git.refs import *  # @NoMove @IgnorePep8
+    from git.diff import *  # @NoMove @IgnorePep8
+    from git.db import *  # @NoMove @IgnorePep8
+    from git.cmd import Git  # @NoMove @IgnorePep8
+    from git.repo import Repo  # @NoMove @IgnorePep8
+    from git.remote import *  # @NoMove @IgnorePep8
+    from git.index import *  # @NoMove @IgnorePep8
+    from git.util import (  # @NoMove @IgnorePep8
         LockFile,
         BlockingLockFile,
         Stats,
         Actor,
         rmtree,
     )
 except GitError as exc:
-    raise ImportError('%s: %s' % (exc.__class__.__name__, exc)) from exc
+    raise ImportError("%s: %s" % (exc.__class__.__name__, exc)) from exc
 
-#} END imports
+# } END imports
 
-__all__ = [name for name, obj in locals().items()
-           if not (name.startswith('_') or inspect.ismodule(obj))]
+__all__ = [name for name, obj in locals().items() if not (name.startswith("_") or inspect.ismodule(obj))]
 
 
-#{ Initialize git executable path
+# { Initialize git executable path
 GIT_OK = None
 
 
@@ -79,12 +79,14 @@ def refresh(path: Optional[PathLike] = None) -> None:
         return
 
     GIT_OK = True
-#} END initialize git executable path
+
+
+# } END initialize git executable path
 
 
 #################
 try:
     refresh()
 except Exception as exc:
-    raise ImportError('Failed to initialize: {0}'.format(exc)) from exc
+    raise ImportError("Failed to initialize: {0}".format(exc)) from exc
 #################