From 5532420488628845d809bdf68bf3a6e2365ba9bb Mon Sep 17 00:00:00 2001 From: Umang Arora Date: Thu, 19 Jun 2014 02:03:49 +0530 Subject: [PATCH] Added coveralls and flake8ified #4507 --- .coveragerc | 5 ++ .travis.yml | 14 ++++- README.rst | 4 +- docs/conf.py | 132 +++++++++++++++++++++------------------- setup.py | 22 +++---- tests/__init__.py | 1 + tornadobabel/extract.py | 18 +++--- tornadobabel/locale.py | 13 ++-- 8 files changed, 116 insertions(+), 93 deletions(-) create mode 100644 .coveragerc diff --git a/.coveragerc b/.coveragerc new file mode 100644 index 0000000..9e1de22 --- /dev/null +++ b/.coveragerc @@ -0,0 +1,5 @@ +[run] +source = tornadobabel + +[report] +omit = */tests/*, */fabfile.py diff --git a/.travis.yml b/.travis.yml index 8cfdb8c..6e56151 100644 --- a/.travis.yml +++ b/.travis.yml @@ -2,5 +2,15 @@ language: python python: - "2.6" - "2.7" -install: python setup.py install -script: python setup.py test +install: + - pip install flake8 + - python setup.py install + - pip install coveralls +script: + - coverage run setup.py test + - flake8 . +after_success: + coveralls +notifications: + email: + - ci-notify@openlabs.co.in diff --git a/README.rst b/README.rst index 3c7267f..8cd2d19 100644 --- a/README.rst +++ b/README.rst @@ -1,8 +1,10 @@ Tornado-Babel ============= -.. image:: https://secure.travis-ci.org/openlabs/tornado-babel.png?branch=master +.. image:: https://secure.travis-ci.org/openlabs/tornado-babel.png?branch=develop :target: http://travis-ci.org/#!/openlabs/tornado-babel +.. image:: https://coveralls.io/repos/openlabs/tornado-babel/badge.png?branch=develop + :target: https://coveralls.io/r/openlabs/tornado-babel Tornado-Babel adds i18n and l10n support to tornado with the help of babel and speaklater. It has builtin support for date diff --git a/docs/conf.py b/docs/conf.py index b410aca..e57992d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -3,7 +3,8 @@ # Tornado-Babel documentation build configuration file, created by # sphinx-quickstart on Thu Jul 12 16:34:09 2012. # -# This file is execfile()d with the current directory set to its containing dir. +# This file is execfile()d with the current directory set to its +# containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. @@ -11,21 +12,24 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import sys, os +import sys +import os # 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('../')) -# -- General configuration ----------------------------------------------------- +# -- 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.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.viewcode'] +# 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.intersphinx', + 'sphinx.ext.todo', 'sphinx.ext.viewcode'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -34,7 +38,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' @@ -54,40 +58,40 @@ # 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 = [] -# The reST default role (used for this markup: `text`) to use for all documents. -#default_role = None +# The reST default role (used for this markup: `text`) to use for all documents +# 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 --------------------------------------------------- +# -- Options for HTML output -------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. @@ -96,17 +100,17 @@ # 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. @@ -115,7 +119,7 @@ # 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, @@ -124,91 +128,91 @@ # 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 = 'Tornado-Babeldoc' -# -- Options for LaTeX output -------------------------------------------------- +# -- 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', 'Tornado-Babel.tex', u'Tornado-Babel Documentation', - u'Openlabs Technologies \\& Consulting (P) Limited', 'manual'), -] +# (source start file, target name, title, author, documentclass [howto/manual]) +latex_documents = [( + 'index', 'Tornado-Babel.tex', u'Tornado-Babel Documentation', + u'Openlabs Technologies \\& Consulting (P) Limited', '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 -------------------------------------------- +# -- Options for manual page output ------------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). @@ -218,28 +222,28 @@ ] # If true, show URL addresses after external links. -#man_show_urls = False +# man_show_urls = False -# -- Options for Texinfo output ------------------------------------------------ +# -- 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', 'Tornado-Babel', u'Tornado-Babel Documentation', - u'Openlabs Technologies & Consulting (P) Limited', 'Tornado-Babel', 'One line description of project.', - 'Miscellaneous'), -] +texinfo_documents = [( + 'index', 'Tornado-Babel', u'Tornado-Babel Documentation', + u'Openlabs Technologies & Consulting (P) Limited', 'Tornado-Babel', + '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' # Example configuration for intersphinx: refer to the Python standard library. diff --git a/setup.py b/setup.py index 91dcee2..f339386 100644 --- a/setup.py +++ b/setup.py @@ -9,23 +9,23 @@ from setuptools import setup, find_packages setup( - name = "Tornado-Babel", - version = "0.3dev", - packages = find_packages(), + name="Tornado-Babel", + version="0.3dev", + packages=find_packages(), - install_requires = [ + install_requires=[ "tornado", "babel", "speaklater", ], - author = "Openlabs Technologies & Consulting (P) Limited", - author_email = "info@openlabs.co.in", - description = "Babel localisation support for Torando", - license = "BSD", - keywords = "tornado locale babel localisation", - url = "https://github.com/openlabs/tornado-babel", - test_suite = "tests.test_all", + author="Openlabs Technologies & Consulting (P) Limited", + author_email="info@openlabs.co.in", + description="Babel localisation support for Torando", + license="BSD", + keywords="tornado locale babel localisation", + url="https://github.com/openlabs/tornado-babel", + test_suite="tests.test_all", entry_points=""" [babel.extractors] diff --git a/tests/__init__.py b/tests/__init__.py index 3b76008..38b54a1 100644 --- a/tests/__init__.py +++ b/tests/__init__.py @@ -15,6 +15,7 @@ from test_extract import TestExtract from test_merge import TestMerge + def test_all(): loader = TestLoader() suite = TestSuite() diff --git a/tornadobabel/extract.py b/tornadobabel/extract.py index e30f7ee..ecc3b28 100644 --- a/tornadobabel/extract.py +++ b/tornadobabel/extract.py @@ -10,8 +10,8 @@ import ast from tornado import escape -from tornado.template import (_UNSET, _DEFAULT_AUTOESCAPE, _TemplateReader, - _parse, _File, _Expression) +from tornado.template import ( + _UNSET, _DEFAULT_AUTOESCAPE, _TemplateReader, _parse, _File, _Expression) GETTEXT_FUNCTIONS = ('_', '_N', 'gettext', 'ngettext') @@ -66,12 +66,12 @@ def extract_from_node(expression, gettext_functions=None): gettext_functions = GETTEXT_FUNCTIONS for node in ast.walk(ast.parse(expression.expression)): - # Recursively walk through all descendant nodes + # Recursively walk through all descendant nodes if isinstance(node, ast.Call): # If the type is a function call if not ( - isinstance(node.func, ast.Name) and \ - node.func.id in gettext_functions): + isinstance(node.func, ast.Name) and ( + node.func.id) in gettext_functions): continue strings = [] @@ -101,11 +101,11 @@ def extract_tornado(fileobj, keywords, comment_tags, options): :param fileobj: the seekable, file-like object the messages should be - extracted from + extracted from :param keywords: a list of keywords (i.e. function names) that should be - recognized as translation functions + recognized as translation functions :param comment_tags: a list of translator tags to search for and include - in the results. (Not implemented yet) + in the results. (Not implemented yet) :param options: a dictionary of additional options (optional) :return: an iterator over ``(lineno, funcname, message, comments)`` tuples :rtype: ``iterator`` @@ -118,6 +118,6 @@ def extract_tornado(fileobj, keywords, comment_tags, options): for node in walk(template.file): if isinstance(node, _Expression): for lineno, func, message in extract_from_node(node): - # TODO: Implement the comment feature, right now an empty + # TODO: Implement the comment feature, right now an empty # iterable is returned yield lineno, func, message, [] diff --git a/tornadobabel/locale.py b/tornadobabel/locale.py index 86ab055..06ff03b 100644 --- a/tornadobabel/locale.py +++ b/tornadobabel/locale.py @@ -4,7 +4,7 @@ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The locale support of tornado as such is pretty basic and does not offer - support for merging translation catalogs and several other features most + support for merging translation catalogs and several other features most multi language applications require. This module tries to retain the same API as that of tornado.locale while @@ -19,7 +19,7 @@ :changes: 12/11/23 - E. PASCUAL (Centre Scientifique et Technique du Batiment): - fixed implementation of translations merge process in + fixed implementation of translations merge process in load_gettext_translations """ import gettext @@ -28,7 +28,7 @@ from babel.support import Translations from babel.core import Locale as BabelCoreLocale -from babel import dates, numbers +from babel import dates _default_locale = "en_US" _translations = {} @@ -80,7 +80,7 @@ def load_gettext_translations(directory, domain): _translations[lang].merge(translation) else: _translations[lang] = translation - + except Exception, e: logging.error("Cannot load translation for '%s': %s", lang, str(e)) continue @@ -179,8 +179,9 @@ def format_time(self, time=None, format='medium', tzinfo=None): """ return dates.format_time(time, format, tzinfo, self) - def format_timedelta(self, delta, granularity='second', - threshold=0.84999999999999998): + def format_timedelta( + self, delta, granularity='second', threshold=0.84999999999999998 + ): """ Return a time delta according to the rules of the given locale.