Skip to content

Commit

Permalink
Format entire codebase with Black
Browse files Browse the repository at this point in the history
  • Loading branch information
evansd committed Sep 16, 2019
1 parent 2e8ef77 commit 895f9ac
Show file tree
Hide file tree
Showing 24 changed files with 684 additions and 623 deletions.
158 changes: 80 additions & 78 deletions docs/conf.py
Expand Up @@ -17,42 +17,43 @@
# 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('.'))


def get_version():
import ast, os, re
filename = os.path.join(
os.path.dirname(__file__),
'../whitenoise/__init__.py')
with open(filename, 'rb') as f:
contents = f.read().decode('utf-8')
version_string = re.search(r'__version__\s+=\s+(.*)', contents).group(1)

filename = os.path.join(os.path.dirname(__file__), "../whitenoise/__init__.py")
with open(filename, "rb") as f:
contents = f.read().decode("utf-8")
version_string = re.search(r"__version__\s+=\s+(.*)", contents).group(1)
return str(ast.literal_eval(version_string))


# -- 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.extlinks']
extensions = ["sphinx.ext.extlinks"]

# 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 = u'WhiteNoise'
copyright = u'2013-{}, David Evans'.format(datetime.datetime.today().year)
project = u"WhiteNoise"
copyright = u"2013-{}, David Evans".format(datetime.datetime.today().year)

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand All @@ -65,177 +66,172 @@ def get_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 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.

if os.environ.get('READTHEDOCS', None) == 'True':
html_theme = 'default'
if os.environ.get("READTHEDOCS", None) == "True":
html_theme = "default"
else:
import sphinx_rtd_theme
html_theme = 'sphinx_rtd_theme'

html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

# 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 = 'WhiteNoisedoc'
htmlhelp_basename = "WhiteNoisedoc"


# -- 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': '',
# 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', 'WhiteNoise.tex', u'WhiteNoise Documentation',
u'David Evans', 'manual'),
("index", "WhiteNoise.tex", u"WhiteNoise Documentation", u"David Evans", "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', 'whitenoise', u'WhiteNoise Documentation',
[u'David Evans'], 1)
]
man_pages = [("index", "whitenoise", u"WhiteNoise Documentation", [u"David Evans"], 1)]

# If true, show URL addresses after external links.
#man_show_urls = False
# man_show_urls = False


# -- Options for Texinfo output ------------------------------------------------
Expand All @@ -244,20 +240,26 @@ def get_version():
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'WhiteNoise', u'WhiteNoise Documentation',
u'David Evans', 'WhiteNoise', 'One line description of project.',
'Miscellaneous'),
(
"index",
"WhiteNoise",
u"WhiteNoise Documentation",
u"David Evans",
"WhiteNoise",
"One line description of project.",
"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'

git_tag = 'v{}'.format(version) if version != 'development' else 'master'
github_base_url = 'https://github.com/evansd/whitenoise/blob/{}/'.format(git_tag)
extlinks = {'file': (github_base_url + '%s', '')}
git_tag = "v{}".format(version) if version != "development" else "master"
github_base_url = "https://github.com/evansd/whitenoise/blob/{}/".format(git_tag)
extlinks = {"file": (github_base_url + "%s", "")}
26 changes: 12 additions & 14 deletions scripts/generate_default_media_types.py
Expand Up @@ -5,9 +5,9 @@


EXTRA_MIMETYPES = {
'apple-app-site-association': 'application/pkc7-mime',
'.woff': 'application/font-woff',
'.woff2': 'font/woff2'
"apple-app-site-association": "application/pkc7-mime",
".woff": "application/font-woff",
".woff2": "font/woff2",
}


Expand All @@ -26,37 +26,35 @@ def default_types():
""".lstrip()


NGINX_CONFIG_FILE = '/etc/nginx/mime.types'
NGINX_CONFIG_FILE = "/etc/nginx/mime.types"


def get_default_types_function():
types_map = get_types_map()
types_map_str = pprint.pformat(types_map, indent=8).strip('{} ')
return FUNCTION_TEMPLATE.format(
triple_quote='"""',
types_map=types_map_str)
types_map_str = pprint.pformat(types_map, indent=8).strip("{} ")
return FUNCTION_TEMPLATE.format(triple_quote='"""', types_map=types_map_str)


def get_types_map():
types_map = {}
with open(NGINX_CONFIG_FILE, 'r') as f:
with open(NGINX_CONFIG_FILE, "r") as f:
for line in f:
line = line.strip()
if not line.endswith(';'):
if not line.endswith(";"):
continue
line = line.rstrip(';')
line = line.rstrip(";")
bits = line.split()
media_type = bits[0]
# This is the default media type anyway, no point specifying
# it explicitly
if media_type == 'application/octet-stream':
if media_type == "application/octet-stream":
continue
extensions = bits[1:]
for extension in extensions:
types_map['.'+extension] = media_type
types_map["." + extension] = media_type
types_map.update(EXTRA_MIMETYPES)
return types_map


if __name__ == '__main__':
if __name__ == "__main__":
print(get_default_types_function())
2 changes: 2 additions & 0 deletions setup.cfg
Expand Up @@ -3,3 +3,5 @@ universal = 1

[flake8]
max-line-length = 100
# See https://github.com/PyCQA/pycodestyle/issues/373
ignore = E203

0 comments on commit 895f9ac

Please sign in to comment.