From c875acc366d9a711e92569e322e6342f1d9058ee Mon Sep 17 00:00:00 2001 From: Maxence Date: Mon, 21 Mar 2016 10:15:22 +0100 Subject: [PATCH] Fixing django import into __init__ + flake8 --- docs/conf.py | 101 ++++++++++++++++++------------------- wkhtmltopdf/__init__.py | 9 ++-- wkhtmltopdf/subprocess.py | 2 +- wkhtmltopdf/tests/run.py | 2 + wkhtmltopdf/tests/tests.py | 30 ++++------- wkhtmltopdf/utils.py | 7 ++- wkhtmltopdf/views.py | 3 +- 7 files changed, 77 insertions(+), 77 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 21a748a..09ba1a9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -11,19 +11,17 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import sys, os - import wkhtmltopdf # 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. @@ -36,7 +34,7 @@ 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' @@ -56,37 +54,37 @@ # 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'] # 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' # A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] +# modindex_common_prefix = [] # -- Options for HTML output --------------------------------------------------- @@ -98,26 +96,26 @@ # 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 # " v 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, @@ -126,44 +124,44 @@ # 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 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 = 'django-wkhtmltopdfdoc' @@ -172,42 +170,41 @@ # -- Options for LaTeX output -------------------------------------------------- latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', -# Additional stuff for the LaTeX preamble. -#'preamble': '', + # 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', 'django-wkhtmltopdf.tex', u'django-wkhtmltopdf Documentation', - u'Incuna Ltd', 'manual'), + ('index', 'django-wkhtmltopdf.tex', u'django-wkhtmltopdf Documentation', u'Incuna Ltd', '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 -------------------------------------------- @@ -220,7 +217,7 @@ ] # If true, show URL addresses after external links. -#man_show_urls = False +# man_show_urls = False # -- Options for Texinfo output ------------------------------------------------ @@ -229,16 +226,16 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'django-wkhtmltopdf', u'django-wkhtmltopdf Documentation', - u'Incuna Ltd', 'django-wkhtmltopdf', 'One line description of project.', - 'Miscellaneous'), + ('index', 'django-wkhtmltopdf', u'django-wkhtmltopdf Documentation', + u'Incuna Ltd', 'django-wkhtmltopdf', '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' diff --git a/wkhtmltopdf/__init__.py b/wkhtmltopdf/__init__.py index 821ee36..f42d8b0 100644 --- a/wkhtmltopdf/__init__.py +++ b/wkhtmltopdf/__init__.py @@ -1,6 +1,9 @@ -import os -if 'DJANGO_SETTINGS_MODULE' in os.environ: - from .utils import * +try: + import os + if 'DJANGO_SETTINGS_MODULE' in os.environ: + from .utils import * # noqa +except: + pass __author__ = 'Incuna Ltd' __version__ = '3.0.0' diff --git a/wkhtmltopdf/subprocess.py b/wkhtmltopdf/subprocess.py index d0abacd..ceb4087 100644 --- a/wkhtmltopdf/subprocess.py +++ b/wkhtmltopdf/subprocess.py @@ -1,6 +1,6 @@ from __future__ import absolute_import -from subprocess import * +from subprocess import * # noqa # Provide Python 2.7's check_output() function. diff --git a/wkhtmltopdf/tests/run.py b/wkhtmltopdf/tests/run.py index e0021ab..8774198 100644 --- a/wkhtmltopdf/tests/run.py +++ b/wkhtmltopdf/tests/run.py @@ -18,6 +18,8 @@ } }, INSTALLED_APPS=( + 'django.contrib.auth', + 'django.contrib.contenttypes', 'wkhtmltopdf.tests', 'wkhtmltopdf', ), diff --git a/wkhtmltopdf/tests/tests.py b/wkhtmltopdf/tests/tests.py index 7b48421..d6f7984 100644 --- a/wkhtmltopdf/tests/tests.py +++ b/wkhtmltopdf/tests/tests.py @@ -6,7 +6,7 @@ import sys from django.conf import settings -from django.template import loader, RequestContext +from django.template import loader from django.test import TestCase from django.test.client import RequestFactory from django.utils import six @@ -126,8 +126,7 @@ def test_rendered_file_persists_on_debug(self): with self.settings(WKHTMLTOPDF_DEBUG=True): debug = getattr(settings, 'WKHTMLTOPDF_DEBUG', settings.DEBUG) - saved_content, filename = self._render_file(template=template, - context={'title': title}) + saved_content, filename = self._render_file(template=template, context={'title': title}) # First verify temp file was rendered correctly. self.assertTrue(title in saved_content) @@ -172,7 +171,7 @@ def test_pdf_response(self): 'attachment; filename="4\'5.pdf"') response = PDFResponse(content=content, filename=u"♥.pdf") try: - import unidecode + import unidecode # noqa except ImportError: filename = '?.pdf' else: @@ -181,22 +180,15 @@ def test_pdf_response(self): 'attachment; filename="{0}"'.format(filename)) # Content as a direct output - response = PDFResponse(content=content, filename="nospace.pdf", - show_content_in_browser=True) - self.assertEqual(response['Content-Disposition'], - 'inline; filename="nospace.pdf"') - response = PDFResponse(content=content, filename="one space.pdf", - show_content_in_browser=True) - self.assertEqual(response['Content-Disposition'], - 'inline; filename="one space.pdf"') - response = PDFResponse(content=content, filename="4'5\".pdf", - show_content_in_browser=True) - self.assertEqual(response['Content-Disposition'], - 'inline; filename="4\'5.pdf"') - response = PDFResponse(content=content, filename=u"♥.pdf", - show_content_in_browser=True) + response = PDFResponse(content=content, filename="nospace.pdf", show_content_in_browser=True) + self.assertEqual(response['Content-Disposition'], 'inline; filename="nospace.pdf"') + response = PDFResponse(content=content, filename="one space.pdf", show_content_in_browser=True) + self.assertEqual(response['Content-Disposition'], 'inline; filename="one space.pdf"') + response = PDFResponse(content=content, filename="4'5\".pdf", show_content_in_browser=True) + self.assertEqual(response['Content-Disposition'], 'inline; filename="4\'5.pdf"') + response = PDFResponse(content=content, filename=u"♥.pdf", show_content_in_browser=True) try: - import unidecode + import unidecode # noqa except ImportError: filename = '?.pdf' else: diff --git a/wkhtmltopdf/utils.py b/wkhtmltopdf/utils.py index c871bd0..2b7cb3b 100644 --- a/wkhtmltopdf/utils.py +++ b/wkhtmltopdf/utils.py @@ -101,7 +101,7 @@ def wkhtmltopdf(pages, output=None, **kwargs): ck_kwargs = {'env': env} # Handling of fileno() attr. based on https://github.com/GrahamDumpleton/mod_wsgi/issues/85 try: - i = sys.stderr.fileno() + sys.stderr.fileno() ck_kwargs['stderr'] = sys.stderr except (AttributeError, IOError): # can't call fileno() on mod_wsgi stderr object @@ -109,6 +109,7 @@ def wkhtmltopdf(pages, output=None, **kwargs): return check_output(ck_args, **ck_kwargs) + def convert_to_pdf(filename, header_filename=None, footer_filename=None, cmd_options=None): # Clobber header_html and footer_html only if filenames are # provided. These keys may be in self.cmd_options as hardcoded @@ -123,6 +124,7 @@ def convert_to_pdf(filename, header_filename=None, footer_filename=None, cmd_opt cmd_options['footer_html'] = footer_filename return wkhtmltopdf(pages=filename, **cmd_options) + class RenderedFile(object): """ Create a temporary file resource of the rendered template with context. @@ -148,6 +150,7 @@ def __del__(self): if self.temporary_file is not None: self.temporary_file.close() + def render_pdf_from_template(input_template, header_template, footer_template, context, request=None, cmd_options=None): # For basic usage. Performs all the actions necessary to create a single # page PDF from a single template and context. @@ -185,6 +188,7 @@ def render_pdf_from_template(input_template, header_template, footer_template, c footer_filename=footer_filename, cmd_options=cmd_options) + def content_disposition_filename(filename): """ Sanitize a file name to be used in the Content-Disposition HTTP @@ -256,6 +260,7 @@ def make_absolute_paths(content): return content + def render_to_temporary_file(template, context, request=None, mode='w+b', bufsize=-1, suffix='.html', prefix='tmp', dir=None, delete=True): diff --git a/wkhtmltopdf/views.py b/wkhtmltopdf/views.py index dff87b4..8480392 100644 --- a/wkhtmltopdf/views.py +++ b/wkhtmltopdf/views.py @@ -11,7 +11,7 @@ class PDFResponse(HttpResponse): """HttpResponse that sets the headers for PDF output.""" def __init__(self, content, status=200, content_type=None, - filename=None, show_content_in_browser=None, *args, **kwargs): + filename=None, show_content_in_browser=None, *args, **kwargs): if content_type is None: content_type = 'application/pdf' @@ -79,6 +79,7 @@ def rendered_content(self): cmd_options=cmd_options ) + class PDFTemplateView(TemplateView): """Class-based view for HTML templates rendered to PDF."""