Merge pull request #56 from maxmind/greg/black

Format with black instead of yapf

Author: rafl

.pylintrc

@@ -1,5 +1,5 @@
 [MESSAGES CONTROL]
-disable=R0201,R0205,W0105
+disable=C0330,R0201,R0205,W0105
 
 [BASIC]
 

.travis-yapf.sh .travis-black.sh.travis-yapf.sh renamed to .travis-black.sh

@@ -1,9 +1,11 @@
 #!/bin/bash
 
-diff=$(yapf -rd maxminddb tests)
+set -eux
+
+diff=$(black --check .)
 
 if [[ $? != 0 ]]; then
-    echo "yapf failed to run."
+    echo "black failed to run."
     echo "$diff"
     exit $?
 elif [[ $diff ]]; then

.travis.yml

@@ -31,7 +31,7 @@ before_install:
   - sudo ldconfig
   - cd ..
   - pip install coverage coveralls
-  - if [[ $RUN_LINTER ]]; then pip install pylint yapf; fi
+  - if [[ $RUN_LINTER ]]; then pip install pylint black; fi
   - |
     if [[ $RUN_SNYK && $SNYK_TOKEN ]]; then
       sudo apt-get install -y nodejs;
@@ -43,7 +43,7 @@ script:
   - CFLAGS="-Werror -Wall -Wextra" coverage run --source maxminddb setup.py test
   - if [[ $RUN_SNYK && $SNYK_TOKEN ]]; then snyk test --org=maxmind --file=requirements.txt; fi
   - if [[ $RUN_LINTER ]]; then pylint --rcfile .pylintrc maxminddb/*.py; fi
-  - if [[ $RUN_LINTER ]]; then ./.travis-yapf.sh; fi
+  - if [[ $RUN_LINTER ]]; then ./.travis-black.sh; fi
 
 after_success:
   - coveralls

docs/conf.py

@@ -15,43 +15,45 @@
 import sys
 import os
 
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath(".."))
 import maxminddb
 
 __version__ = maxminddb.__version__
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath(".."))
 
 # -- General configuration -----------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+# needs_sphinx = '1.0'
 
 # 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', 'sphinx.ext.intersphinx',
-    'sphinx.ext.coverage'
+    "sphinx.ext.autodoc",
+    "sphinx.ext.doctest",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.coverage",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The encoding of source files.
-#source_encoding = 'utf-8-sig'
+# source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = 'maxminddb'
-copyright = '2013-2019, MaxMind, Inc.'
+project = "maxminddb"
+copyright = "2013-2019, MaxMind, Inc."
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -64,185 +66,188 @@
 
 # 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 patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+exclude_patterns = ["_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"
 
 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
 
 # -- Options for HTML output ---------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'sphinxdoc'
+html_theme = "sphinxdoc"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#html_theme_options = {}
+# html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+# html_theme_path = []
 
 # 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,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 # 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_domain_indices = True
+# html_domain_indices = 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, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+# html_show_sourcelink = True
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+# html_show_sphinx = True
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+# html_show_copyright = 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 = ''
 
 # This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'maxminddbdoc'
+htmlhelp_basename = "maxminddbdoc"
 
 # -- Options for LaTeX output --------------------------------------------
 
 latex_elements = {
     # The paper size ('letterpaper' or 'a4paper').
     #'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     #'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     #'preamble': '',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-    ('index', 'maxminddb.tex', 'maxminddb Documentation', 'Gregory Oschwald',
-     'manual'),
+    ("index", "maxminddb.tex", "maxminddb Documentation", "Gregory Oschwald", "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
 
 # If true, show page references after internal links.
-#latex_show_pagerefs = False
+# latex_show_pagerefs = False
 
 # If true, show URL addresses after external links.
-#latex_show_urls = False
+# latex_show_urls = False
 
 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
 
 # If false, no module index is generated.
-#latex_domain_indices = True
+# latex_domain_indices = True
 
 # -- Options for manual page output --------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [('index', 'maxminddb', 'maxminddb Documentation',
-              ['Gregory Oschwald'], 1)]
+man_pages = [("index", "maxminddb", "maxminddb Documentation", ["Gregory Oschwald"], 1)]
 
 # If true, show URL addresses after external links.
-#man_show_urls = False
+# man_show_urls = False
 
 # -- Options for Texinfo output ------------------------------------------
 
 # Grouping the document tree into Texinfo files. List of tuples
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    ('index', 'maxminddb', 'maxminddb Documentation', 'Gregory Oschwald',
-     'maxminddb', 'MaxMind DB Reader', 'Miscellaneous'),
+    (
+        "index",
+        "maxminddb",
+        "maxminddb Documentation",
+        "Gregory Oschwald",
+        "maxminddb",
+        "MaxMind DB Reader",
+        "Miscellaneous",
+    ),
 ]
 
 # Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
+# texinfo_appendices = []
 
 # If false, no module index is generated.
-#texinfo_domain_indices = True
+# texinfo_domain_indices = True
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
+# texinfo_show_urls = 'footnote'
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'http://docs.python.org/': None}
+intersphinx_mapping = {"http://docs.python.org/": None}

examples/benchmark.py

@@ -10,15 +10,10 @@
 import struct
 import timeit
 
-parser = argparse.ArgumentParser(description='Benchmark maxminddb.')
-parser.add_argument('--count',
-                    default=250000,
-                    type=int,
-                    help='number of lookups')
-parser.add_argument('--mode', default=0, type=int, help='reader mode to use')
-parser.add_argument('--file',
-                    default='GeoIP2-City.mmdb',
-                    help='path to mmdb file')
+parser = argparse.ArgumentParser(description="Benchmark maxminddb.")
+parser.add_argument("--count", default=250000, type=int, help="number of lookups")
+parser.add_argument("--mode", default=0, type=int, help="reader mode to use")
+parser.add_argument("--file", default="GeoIP2-City.mmdb", help="path to mmdb file")
 
 args = parser.parse_args()
 
@@ -27,12 +22,14 @@
 
 
 def lookup_ip_address():
-    ip = socket.inet_ntoa(struct.pack('!L', random.getrandbits(32)))
+    ip = socket.inet_ntoa(struct.pack("!L", random.getrandbits(32)))
     record = reader.get(str(ip))
 
 
-elapsed = timeit.timeit('lookup_ip_address()',
-                        setup='from __main__ import lookup_ip_address',
-                        number=args.count)
+elapsed = timeit.timeit(
+    "lookup_ip_address()",
+    setup="from __main__ import lookup_ip_address",
+    number=args.count,
+)
 
-print(args.count / elapsed, 'lookups per second')
+print(args.count / elapsed, "lookups per second")