Use black to auto-format the codebase

Author: Hugo Osvaldo Barrera

.pre-commit-config.yaml

@@ -13,6 +13,10 @@ repos:
     hooks:
       - id: flake8
         additional_dependencies: [flake8-import-order, flake8-bugbear]
+  - repo: https://github.com/psf/black
+    rev: "21.5b0"
+    hooks:
+      - id: black
   - repo: https://github.com/asottile/reorder_python_imports
     rev: v2.5.0
     hooks:

docs/conf.py

@@ -3,90 +3,104 @@
 
 from pkg_resources import get_distribution
 
-extensions = ['sphinx.ext.autodoc']
+extensions = ["sphinx.ext.autodoc"]
 
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
-source_suffix = '.rst'
-master_doc = 'index'
+source_suffix = ".rst"
+master_doc = "index"
 
-project = 'vdirsyncer'
-copyright = ('2014-{}, Markus Unterwaditzer & contributors'
-             .format(datetime.date.today().strftime('%Y')))
+project = "vdirsyncer"
+copyright = "2014-{}, Markus Unterwaditzer & contributors".format(
+    datetime.date.today().strftime("%Y")
+)
 
-release = get_distribution('vdirsyncer').version
-version = '.'.join(release.split('.')[:2])  # The short X.Y version.
+release = get_distribution("vdirsyncer").version
+version = ".".join(release.split(".")[:2])  # The short X.Y version.
 
-rst_epilog = '.. |vdirsyncer_version| replace:: %s' % release
+rst_epilog = ".. |vdirsyncer_version| replace:: %s" % release
 
-exclude_patterns = ['_build']
+exclude_patterns = ["_build"]
 
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
-on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+on_rtd = os.environ.get("READTHEDOCS", None) == "True"
 
 try:
     import sphinx_rtd_theme
-    html_theme = 'sphinx_rtd_theme'
+
+    html_theme = "sphinx_rtd_theme"
     html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 except ImportError:
-    html_theme = 'default'
+    html_theme = "default"
     if not on_rtd:
-        print('-' * 74)
-        print('Warning: sphinx-rtd-theme not installed, building with default '
-              'theme.')
-        print('-' * 74)
+        print("-" * 74)
+        print(
+            "Warning: sphinx-rtd-theme not installed, building with default " "theme."
+        )
+        print("-" * 74)
 
-html_static_path = ['_static']
-htmlhelp_basename = 'vdirsyncerdoc'
+html_static_path = ["_static"]
+htmlhelp_basename = "vdirsyncerdoc"
 
 latex_elements = {}
 latex_documents = [
-    ('index', 'vdirsyncer.tex', 'vdirsyncer Documentation',
-     'Markus Unterwaditzer', 'manual'),
+    (
+        "index",
+        "vdirsyncer.tex",
+        "vdirsyncer Documentation",
+        "Markus Unterwaditzer",
+        "manual",
+    ),
 ]
 
 man_pages = [
-    ('index', 'vdirsyncer', 'vdirsyncer Documentation',
-     ['Markus Unterwaditzer'], 1)
+    ("index", "vdirsyncer", "vdirsyncer Documentation", ["Markus Unterwaditzer"], 1)
 ]
 
 texinfo_documents = [
-    ('index', 'vdirsyncer', 'vdirsyncer Documentation',
-     'Markus Unterwaditzer', 'vdirsyncer',
-     'Synchronize calendars and contacts.', 'Miscellaneous'),
+    (
+        "index",
+        "vdirsyncer",
+        "vdirsyncer Documentation",
+        "Markus Unterwaditzer",
+        "vdirsyncer",
+        "Synchronize calendars and contacts.",
+        "Miscellaneous",
+    ),
 ]
 
 
-def github_issue_role(name, rawtext, text, lineno, inliner,
-                      options=None, content=()):
+def github_issue_role(name, rawtext, text, lineno, inliner, options=None, content=()):
     options = options or {}
     try:
         issue_num = int(text)
         if issue_num <= 0:
             raise ValueError()
     except ValueError:
-        msg = inliner.reporter.error(f'Invalid GitHub issue: {text}',
-                                     line=lineno)
+        msg = inliner.reporter.error(f"Invalid GitHub issue: {text}", line=lineno)
         prb = inliner.problematic(rawtext, rawtext, msg)
         return [prb], [msg]
 
     from docutils import nodes
 
-    PROJECT_HOME = 'https://github.com/pimutils/vdirsyncer'
-    link = '{}/{}/{}'.format(PROJECT_HOME,
-                             'issues' if name == 'gh' else 'pull',
-                             issue_num)
-    linktext = ('issue #{}' if name == 'gh'
-                else 'pull request #{}').format(issue_num)
-    node = nodes.reference(rawtext, linktext, refuri=link,
-                           **options)
+    PROJECT_HOME = "https://github.com/pimutils/vdirsyncer"
+    link = "{}/{}/{}".format(
+        PROJECT_HOME, "issues" if name == "gh" else "pull", issue_num
+    )
+    linktext = ("issue #{}" if name == "gh" else "pull request #{}").format(issue_num)
+    node = nodes.reference(rawtext, linktext, refuri=link, **options)
     return [node], []
 
 
 def setup(app):
     from sphinx.domains.python import PyObject
-    app.add_object_type('storage', 'storage', 'pair: %s; storage',
-                        doc_field_types=PyObject.doc_field_types)
-    app.add_role('gh', github_issue_role)
-    app.add_role('ghpr', github_issue_role)
+
+    app.add_object_type(
+        "storage",
+        "storage",
+        "pair: %s; storage",
+        doc_field_types=PyObject.doc_field_types,
+    )
+    app.add_role("gh", github_issue_role)
+    app.add_role("ghpr", github_issue_role)

setup.py

@@ -1,35 +1,31 @@
-'''
+"""
 Vdirsyncer synchronizes calendars and contacts.
 
 Please refer to https://vdirsyncer.pimutils.org/en/stable/packaging.html for
 how to package vdirsyncer.
-'''
+"""
 from setuptools import Command
 from setuptools import find_packages
 from setuptools import setup
 
 
 requirements = [
     # https://github.com/mitsuhiko/click/issues/200
-    'click>=5.0',
-    'click-log>=0.3.0, <0.4.0',
-
+    "click>=5.0",
+    "click-log>=0.3.0, <0.4.0",
     # https://github.com/pimutils/vdirsyncer/issues/478
-    'click-threading>=0.2',
-
-    'requests >=2.20.0',
-
+    "click-threading>=0.2",
+    "requests >=2.20.0",
     # https://github.com/sigmavirus24/requests-toolbelt/pull/28
     # And https://github.com/sigmavirus24/requests-toolbelt/issues/54
-    'requests_toolbelt >=0.4.0',
-
+    "requests_toolbelt >=0.4.0",
     # https://github.com/untitaker/python-atomicwrites/commit/4d12f23227b6a944ab1d99c507a69fdbc7c9ed6d  # noqa
-    'atomicwrites>=0.1.7'
+    "atomicwrites>=0.1.7",
 ]
 
 
 class PrintRequirements(Command):
-    description = 'Prints minimal requirements'
+    description = "Prints minimal requirements"
     user_options = []
 
     def initialize_options(self):
@@ -43,54 +39,44 @@ def run(self):
             print(requirement.replace(">", "=").replace(" ", ""))
 
 
-with open('README.rst') as f:
+with open("README.rst") as f:
     long_description = f.read()
 
 
 setup(
     # General metadata
-    name='vdirsyncer',
-    author='Markus Unterwaditzer',
-    author_email='[email protected]',
-    url='https://github.com/pimutils/vdirsyncer',
-    description='Synchronize calendars and contacts',
-    license='BSD',
+    name="vdirsyncer",
+    author="Markus Unterwaditzer",
+    author_email="[email protected]",
+    url="https://github.com/pimutils/vdirsyncer",
+    description="Synchronize calendars and contacts",
+    license="BSD",
     long_description=long_description,
-
     # Runtime dependencies
     install_requires=requirements,
-
     # Optional dependencies
     extras_require={
-        'google': ['requests-oauthlib'],
-        'etesync': ['etesync==0.5.2', 'django<2.0']
+        "google": ["requests-oauthlib"],
+        "etesync": ["etesync==0.5.2", "django<2.0"],
     },
-
     # Build dependencies
-    setup_requires=['setuptools_scm != 1.12.0'],
-
+    setup_requires=["setuptools_scm != 1.12.0"],
     # Other
-    packages=find_packages(exclude=['tests.*', 'tests']),
+    packages=find_packages(exclude=["tests.*", "tests"]),
     include_package_data=True,
-    cmdclass={
-        'minimal_requirements': PrintRequirements
-    },
-    use_scm_version={
-        'write_to': 'vdirsyncer/version.py'
-    },
-    entry_points={
-        'console_scripts': ['vdirsyncer = vdirsyncer.cli:main']
-    },
+    cmdclass={"minimal_requirements": PrintRequirements},
+    use_scm_version={"write_to": "vdirsyncer/version.py"},
+    entry_points={"console_scripts": ["vdirsyncer = vdirsyncer.cli:main"]},
     classifiers=[
-        'Development Status :: 4 - Beta',
-        'Environment :: Console',
-        'License :: OSI Approved :: BSD License',
-        'Operating System :: POSIX',
-        'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.7',
-        'Programming Language :: Python :: 3.8',
-        'Programming Language :: Python :: 3.9',
-        'Topic :: Internet',
-        'Topic :: Utilities',
+        "Development Status :: 4 - Beta",
+        "Environment :: Console",
+        "License :: OSI Approved :: BSD License",
+        "Operating System :: POSIX",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Topic :: Internet",
+        "Topic :: Utilities",
     ],
 )

tests/__init__.py

@@ -1,6 +1,6 @@
-'''
+"""
 Test suite for vdirsyncer.
-'''
+"""
 import hypothesis.strategies as st
 import urllib3.exceptions
 
@@ -10,14 +10,14 @@
 
 
 def blow_up(*a, **kw):
-    raise AssertionError('Did not expect to be called.')
+    raise AssertionError("Did not expect to be called.")
 
 
 def assert_item_equals(a, b):
     assert normalize_item(a) == normalize_item(b)
 
 
-VCARD_TEMPLATE = '''BEGIN:VCARD
+VCARD_TEMPLATE = """BEGIN:VCARD
 VERSION:3.0
 FN:Cyrus Daboo
 N:Daboo;Cyrus;;;
@@ -31,9 +31,9 @@ def assert_item_equals(a, b):
 URL;VALUE=URI:http://www.example.com
 X-SOMETHING:{r}
 UID:{uid}
-END:VCARD'''
+END:VCARD"""
 
-TASK_TEMPLATE = '''BEGIN:VCALENDAR
+TASK_TEMPLATE = """BEGIN:VCALENDAR
 VERSION:2.0
 PRODID:-//dmfs.org//mimedir.icalendar//EN
 BEGIN:VTODO
@@ -45,25 +45,30 @@ def assert_item_equals(a, b):
 X-SOMETHING:{r}
 UID:{uid}
 END:VTODO
-END:VCALENDAR'''
+END:VCALENDAR"""
 
 
-BARE_EVENT_TEMPLATE = '''BEGIN:VEVENT
+BARE_EVENT_TEMPLATE = """BEGIN:VEVENT
 DTSTART:19970714T170000Z
 DTEND:19970715T035959Z
 SUMMARY:Bastille Day Party
 X-SOMETHING:{r}
 UID:{uid}
-END:VEVENT'''
+END:VEVENT"""
 
 
-EVENT_TEMPLATE = '''BEGIN:VCALENDAR
+EVENT_TEMPLATE = (
+    """BEGIN:VCALENDAR
 VERSION:2.0
 PRODID:-//hacksw/handcal//NONSGML v1.0//EN
-''' + BARE_EVENT_TEMPLATE + '''
-END:VCALENDAR'''
+"""
+    + BARE_EVENT_TEMPLATE
+    + """
+END:VCALENDAR"""
+)
 
-EVENT_WITH_TIMEZONE_TEMPLATE = '''BEGIN:VCALENDAR
+EVENT_WITH_TIMEZONE_TEMPLATE = (
+    """BEGIN:VCALENDAR
 BEGIN:VTIMEZONE
 TZID:Europe/Rome
 X-LIC-LOCATION:Europe/Rome
@@ -82,26 +87,23 @@ def assert_item_equals(a, b):
 RRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=10
 END:STANDARD
 END:VTIMEZONE
-''' + BARE_EVENT_TEMPLATE + '''
-END:VCALENDAR'''
+"""
+    + BARE_EVENT_TEMPLATE
+    + """
+END:VCALENDAR"""
+)
 
 
-SIMPLE_TEMPLATE = '''BEGIN:FOO
+SIMPLE_TEMPLATE = """BEGIN:FOO
 UID:{uid}
 X-SOMETHING:{r}
 HAHA:YES
-END:FOO'''
+END:FOO"""
 
 printable_characters_strategy = st.text(
-    st.characters(blacklist_categories=(
-        'Cc', 'Cs'
-    ))
+    st.characters(blacklist_categories=("Cc", "Cs"))
 )
 
 uid_strategy = st.text(
-    st.characters(blacklist_categories=(
-        'Zs', 'Zl', 'Zp',
-        'Cc', 'Cs'
-    )),
-    min_size=1
+    st.characters(blacklist_categories=("Zs", "Zl", "Zp", "Cc", "Cs")), min_size=1
 ).filter(lambda x: x.strip() == x)