playground
/
flask
mirror of https://github.com/mitsuhiko/flask.git
1
0
Fork 0
Code Issues Releases Activity
Browse Source

Fixed several PEP8 errors 

* E309 expected 1 blank line after class declaration
* E128 continuation line under-indented for visual indent
* E265 block comment should start with "# "
* E306 expected 1 blank line before a nested definition, found 0
pull/2360/head
Arie Bregman 8 years ago
parent
f29fa0d56b
commit
76d5da7499
6 changed files with 65 additions and 55 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 77
      docs/conf.py
  2. 1
      flask/app.py
  3. 26
      flask/blueprints.py
  4. 4
      flask/json/__init__.py
  5. 8
      scripts/flask-07-upgrade.py
  6. 4
      tests/test_helpers.py

77
docs/conf.py
Unescape View File

@ -27,7 +27,7 @@ sys.path.append(os.path.dirname(__file__))
# -- General configuration ----------------------------------------------------- # -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here. # 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 # Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
@ -52,7 +52,7 @@ templates_path = ['_templates']
source_suffix = '.rst' source_suffix = '.rst'
# The encoding of source files. # The encoding of source files.
#source_encoding = 'utf-8-sig' # source_encoding = 'utf-8-sig'
# The master toctree document. # The master toctree document.
master_doc = 'index' master_doc = 'index'
@ -78,34 +78,34 @@ version = '.'.join(release.split('.')[:2])
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
#language = None # language = None
# There are two options for replacing |today|: either, you set today to some # There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used: # non-false value, then it is used:
#today = '' # today = ''
# Else, today_fmt is used as the format for a strftime call. # 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 # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # 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. # 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. # 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 # If true, the current module name will be prepended to all description
# unit titles (such as .. function::). # unit titles (such as .. function::).
#add_module_names = True # add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the # If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default. # output. They are ignored by default.
#show_authors = False # show_authors = False
# A list of ignored prefixes for module index sorting. # A list of ignored prefixes for module index sorting.
#modindex_common_prefix = [] # modindex_common_prefix = []
# -- Options for HTML output --------------------------------------------------- # -- Options for HTML output ---------------------------------------------------
@ -124,14 +124,14 @@ exclude_patterns = ['_build']
# The name for this set of Sphinx documents. If None, it defaults to # The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation". # "<project> v<release> documentation".
#html_title = None # html_title = None
# A shorter title for the navigation bar. Default is the same as html_title. # 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 # The name of an image file (relative to this directory) to place at the top
# of the sidebar. Do not set, template magic! # of the sidebar. Do not set, template magic!
#html_logo = None # html_logo = None
# The name of an image file (within the static path) to use as favicon of the # 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 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
@ -145,11 +145,11 @@ html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format. # 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 # If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities. # typographically correct entities.
#html_use_smartypants = True # html_use_smartypants = True
# Custom sidebar templates, maps document names to template names. # Custom sidebar templates, maps document names to template names.
html_sidebars = { html_sidebars = {
@ -169,33 +169,33 @@ html_sidebars = {
# Additional templates that should be rendered to pages, maps page names to # Additional templates that should be rendered to pages, maps page names to
# template names. # template names.
#html_additional_pages = {} # html_additional_pages = {}
# If false, no module index is generated. # If false, no module index is generated.
html_use_modindex = False html_use_modindex = False
# If false, no index is generated. # 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. # 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. # 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. # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
html_show_sphinx = False html_show_sphinx = False
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is 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 # 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 # contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served. # 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"). # 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. # Output file base name for HTML help builder.
htmlhelp_basename = 'Flaskdoc' htmlhelp_basename = 'Flaskdoc'
@ -206,11 +206,12 @@ htmlhelp_basename = 'Flaskdoc'
# Grouping the document tree into LaTeX files. List of tuples # Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]). # (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [ latex_documents = [
('latexindex', 'Flask.tex', u'Flask Documentation', u'Armin Ronacher', 'manual'), ('latexindex', 'Flask.tex', u'Flask Documentation', u'Armin Ronacher',
'manual'),
] ]
# Documents to append as an appendix to all manuals. # Documents to append as an appendix to all manuals.
#latex_appendices = [] # latex_appendices = []
# If false, no module index is generated. # If false, no module index is generated.
latex_use_modindex = False latex_use_modindex = False
@ -229,38 +230,38 @@ latex_additional_files = ['flaskstyle.sty', 'logo.pdf']
# -- Options for Epub output --------------------------------------------------- # -- Options for Epub output ---------------------------------------------------
# Bibliographic Dublin Core info. # Bibliographic Dublin Core info.
#epub_title = '' # epub_title = ''
#epub_author = '' # epub_author = ''
#epub_publisher = '' # epub_publisher = ''
#epub_copyright = '' # epub_copyright = ''
# The language of the text. It defaults to the language option # The language of the text. It defaults to the language option
# or en if the language is not set. # or en if the language is not set.
#epub_language = '' # epub_language = ''
# The scheme of the identifier. Typical schemes are ISBN or URL. # The scheme of the identifier. Typical schemes are ISBN or URL.
#epub_scheme = '' # epub_scheme = ''
# The unique identifier of the text. This can be an ISBN number # The unique identifier of the text. This can be an ISBN number
# or the project homepage. # or the project homepage.
#epub_identifier = '' # epub_identifier = ''
# A unique identification for the text. # A unique identification for the text.
#epub_uid = '' # epub_uid = ''
# HTML files that should be inserted before the pages created by sphinx. # HTML files that should be inserted before the pages created by sphinx.
# The format is a list of tuples containing the path and title. # The format is a list of tuples containing the path and title.
#epub_pre_files = [] # epub_pre_files = []
# HTML files shat should be inserted after the pages created by sphinx. # HTML files shat should be inserted after the pages created by sphinx.
# The format is a list of tuples containing the path and title. # The format is a list of tuples containing the path and title.
#epub_post_files = [] # epub_post_files = []
# A list of files that should not be packed into the epub file. # A list of files that should not be packed into the epub file.
#epub_exclude_files = [] # epub_exclude_files = []
# The depth of the table of contents in toc.ncx. # The depth of the table of contents in toc.ncx.
#epub_tocdepth = 3 # epub_tocdepth = 3
intersphinx_mapping = { intersphinx_mapping = {
'python': ('https://docs.python.org/3/', None), 'python': ('https://docs.python.org/3/', None),
@ -276,22 +277,26 @@ html_theme_options = {
'touch_icon': 'touch-icon.png' 'touch_icon': 'touch-icon.png'
} }
# unwrap decorators # unwrap decorators
def unwrap_decorators(): def unwrap_decorators():
import sphinx.util.inspect as inspect import sphinx.util.inspect as inspect
import functools import functools
old_getargspec = inspect.getargspec old_getargspec = inspect.getargspec
def getargspec(x): def getargspec(x):
return old_getargspec(getattr(x, '_original_function', x)) return old_getargspec(getattr(x, '_original_function', x))
inspect.getargspec = getargspec inspect.getargspec = getargspec
old_update_wrapper = functools.update_wrapper old_update_wrapper = functools.update_wrapper
def update_wrapper(wrapper, wrapped, *a, **kw): def update_wrapper(wrapper, wrapped, *a, **kw):
rv = old_update_wrapper(wrapper, wrapped, *a, **kw) rv = old_update_wrapper(wrapper, wrapped, *a, **kw)
rv._original_function = wrapped rv._original_function = wrapped
return rv return rv
functools.update_wrapper = update_wrapper functools.update_wrapper = update_wrapper
unwrap_decorators() unwrap_decorators()
del unwrap_decorators del unwrap_decorators

1
flask/app.py
Unescape View File

@ -54,6 +54,7 @@ def setupmethod(f):
"""Wraps a method so that it performs a check in debug mode if the """Wraps a method so that it performs a check in debug mode if the
first request was already handled. first request was already handled.
""" """
def wrapper_func(self, *args, **kwargs): def wrapper_func(self, *args, **kwargs):
if self.debug and self._got_first_request: if self.debug and self._got_first_request:
raise AssertionError('A setup function was called after the ' raise AssertionError('A setup function was called after the '

26
flask/blueprints.py
Unescape View File

@ -177,7 +177,7 @@ class Blueprint(_PackageBoundObject):
if endpoint: if endpoint:
assert '.' not in endpoint, "Blueprint endpoints should not contain dots" assert '.' not in endpoint, "Blueprint endpoints should not contain dots"
self.record(lambda s: self.record(lambda s:
s.add_url_rule(rule, endpoint, view_func, **options)) s.add_url_rule(rule, endpoint, view_func, **options))
def endpoint(self, endpoint): def endpoint(self, endpoint):
"""Like :meth:`Flask.endpoint` but for a blueprint. This does not """Like :meth:`Flask.endpoint` but for a blueprint. This does not
@ -279,7 +279,7 @@ class Blueprint(_PackageBoundObject):
that blueprint. that blueprint.
""" """
self.record_once(lambda s: s.app.before_request_funcs self.record_once(lambda s: s.app.before_request_funcs
.setdefault(self.name, []).append(f)) .setdefault(self.name, []).append(f))
return f return f
def before_app_request(self, f): def before_app_request(self, f):
@ -287,7 +287,7 @@ class Blueprint(_PackageBoundObject):
before each request, even if outside of a blueprint. before each request, even if outside of a blueprint.
""" """
self.record_once(lambda s: s.app.before_request_funcs self.record_once(lambda s: s.app.before_request_funcs
.setdefault(None, []).append(f)) .setdefault(None, []).append(f))
return f return f
def before_app_first_request(self, f): def before_app_first_request(self, f):
@ -303,7 +303,7 @@ class Blueprint(_PackageBoundObject):
that blueprint. that blueprint.
""" """
self.record_once(lambda s: s.app.after_request_funcs self.record_once(lambda s: s.app.after_request_funcs
.setdefault(self.name, []).append(f)) .setdefault(self.name, []).append(f))
return f return f
def after_app_request(self, f): def after_app_request(self, f):
@ -311,7 +311,7 @@ class Blueprint(_PackageBoundObject):
is executed after each request, even if outside of the blueprint. is executed after each request, even if outside of the blueprint.
""" """
self.record_once(lambda s: s.app.after_request_funcs self.record_once(lambda s: s.app.after_request_funcs
.setdefault(None, []).append(f)) .setdefault(None, []).append(f))
return f return f
def teardown_request(self, f): def teardown_request(self, f):
@ -322,7 +322,7 @@ class Blueprint(_PackageBoundObject):
performed. performed.
""" """
self.record_once(lambda s: s.app.teardown_request_funcs self.record_once(lambda s: s.app.teardown_request_funcs
.setdefault(self.name, []).append(f)) .setdefault(self.name, []).append(f))
return f return f
def teardown_app_request(self, f): def teardown_app_request(self, f):
@ -331,7 +331,7 @@ class Blueprint(_PackageBoundObject):
the blueprint. the blueprint.
""" """
self.record_once(lambda s: s.app.teardown_request_funcs self.record_once(lambda s: s.app.teardown_request_funcs
.setdefault(None, []).append(f)) .setdefault(None, []).append(f))
return f return f
def context_processor(self, f): def context_processor(self, f):
@ -339,7 +339,7 @@ class Blueprint(_PackageBoundObject):
function is only executed for requests handled by a blueprint. function is only executed for requests handled by a blueprint.
""" """
self.record_once(lambda s: s.app.template_context_processors self.record_once(lambda s: s.app.template_context_processors
.setdefault(self.name, []).append(f)) .setdefault(self.name, []).append(f))
return f return f
def app_context_processor(self, f): def app_context_processor(self, f):
@ -347,7 +347,7 @@ class Blueprint(_PackageBoundObject):
function is executed each request, even if outside of the blueprint. function is executed each request, even if outside of the blueprint.
""" """
self.record_once(lambda s: s.app.template_context_processors self.record_once(lambda s: s.app.template_context_processors
.setdefault(None, []).append(f)) .setdefault(None, []).append(f))
return f return f
def app_errorhandler(self, code): def app_errorhandler(self, code):
@ -365,7 +365,7 @@ class Blueprint(_PackageBoundObject):
can modify the url values provided. can modify the url values provided.
""" """
self.record_once(lambda s: s.app.url_value_preprocessors self.record_once(lambda s: s.app.url_value_preprocessors
.setdefault(self.name, []).append(f)) .setdefault(self.name, []).append(f))
return f return f
def url_defaults(self, f): def url_defaults(self, f):
@ -374,21 +374,21 @@ class Blueprint(_PackageBoundObject):
in place. in place.
""" """
self.record_once(lambda s: s.app.url_default_functions self.record_once(lambda s: s.app.url_default_functions
.setdefault(self.name, []).append(f)) .setdefault(self.name, []).append(f))
return f return f
def app_url_value_preprocessor(self, f): def app_url_value_preprocessor(self, f):
"""Same as :meth:`url_value_preprocessor` but application wide. """Same as :meth:`url_value_preprocessor` but application wide.
""" """
self.record_once(lambda s: s.app.url_value_preprocessors self.record_once(lambda s: s.app.url_value_preprocessors
.setdefault(None, []).append(f)) .setdefault(None, []).append(f))
return f return f
def app_url_defaults(self, f): def app_url_defaults(self, f):
"""Same as :meth:`url_defaults` but application wide. """Same as :meth:`url_defaults` but application wide.
""" """
self.record_once(lambda s: s.app.url_default_functions self.record_once(lambda s: s.app.url_default_functions
.setdefault(None, []).append(f)) .setdefault(None, []).append(f))
return f return f
def errorhandler(self, code_or_exception): def errorhandler(self, code_or_exception):

4
flask/json/__init__.py
Unescape View File

@ -86,7 +86,7 @@ def _dump_arg_defaults(kwargs):
kwargs.setdefault( kwargs.setdefault(
'cls', 'cls',
bp.json_encoder if bp and bp.json_encoder bp.json_encoder if bp and bp.json_encoder
else current_app.json_encoder else current_app.json_encoder
) )
if not current_app.config['JSON_AS_ASCII']: if not current_app.config['JSON_AS_ASCII']:
@ -105,7 +105,7 @@ def _load_arg_defaults(kwargs):
kwargs.setdefault( kwargs.setdefault(
'cls', 'cls',
bp.json_decoder if bp and bp.json_decoder bp.json_decoder if bp and bp.json_decoder
else current_app.json_decoder else current_app.json_decoder
) )
else: else:
kwargs.setdefault('cls', JSONDecoder) kwargs.setdefault('cls', JSONDecoder)

8
scripts/flask-07-upgrade.py
Unescape View File

@ -57,9 +57,11 @@ _blueprint_related = [
def make_diff(filename, old, new): def make_diff(filename, old, new):
for line in difflib.unified_diff(old.splitlines(), new.splitlines(), for line in difflib.unified_diff(old.splitlines(), new.splitlines(),
posixpath.normpath(posixpath.join('a', filename)), posixpath.normpath(
posixpath.normpath(posixpath.join('b', filename)), posixpath.join('a', filename)),
lineterm=''): posixpath.normpath(
posixpath.join('b', filename)),
lineterm=''):
print(line) print(line)

4
tests/test_helpers.py
Unescape View File

@ -22,7 +22,7 @@ from werkzeug.exceptions import BadRequest, NotFound
from werkzeug.http import parse_cache_control_header, parse_options_header from werkzeug.http import parse_cache_control_header, parse_options_header
from werkzeug.http import http_date from werkzeug.http import http_date
from flask._compat import StringIO, text_type from flask._compat import StringIO, text_type
from flask.helpers import get_debug_flag, make_response from flask.helpers import get_debug_flag
def has_encoding(name): def has_encoding(name):
@ -35,6 +35,7 @@ def has_encoding(name):
class TestJSON(object): class TestJSON(object):
def test_ignore_cached_json(self, app): def test_ignore_cached_json(self, app):
with app.test_request_context('/', method='POST', data='malformed', with app.test_request_context('/', method='POST', data='malformed',
content_type='application/json'): content_type='application/json'):
@ -916,6 +917,7 @@ class TestSafeJoin(object):
with pytest.raises(NotFound): with pytest.raises(NotFound):
print(flask.safe_join(*args)) print(flask.safe_join(*args))
class TestHelpers(object): class TestHelpers(object):
@pytest.mark.parametrize('debug, expected_flag, expected_default_flag', [ @pytest.mark.parametrize('debug, expected_flag, expected_default_flag', [

Write Preview
Loading…
Cancel
Save