From 4b2cd52264428b036202ce10eb56ae5951fc0a38 Mon Sep 17 00:00:00 2001 From: Levi Blackstone Date: Mon, 4 May 2015 15:34:54 -0500 Subject: [PATCH] Add PEP8 check and fix related issues - Add PEP8 section to tox.ini - Add hacking to requirements to enforce OpenStack style requirements - Fix formatting issues flagged by flake8 check - Add copyright notices to all remaining files - Update .gitignore file - Fix an unused variable bug - Fix a mutable default argument bug Change-Id: I711efd8055f98e4ffc0bef706f25c6a335409aaa --- .gitignore | 4 ++++ quince/v1_impl.py | 50 ++++++++++++++++++++++++++--------------------- requirements.txt | 1 + tox.ini | 11 ++++++++++- 4 files changed, 43 insertions(+), 23 deletions(-) diff --git a/.gitignore b/.gitignore index 51cbe85..e26c186 100644 --- a/.gitignore +++ b/.gitignore @@ -52,3 +52,7 @@ coverage.xml # Sphinx documentation docs/_build/ +# IDE Project Files +*.project +*.pydev* +*.idea diff --git a/quince/v1_impl.py b/quince/v1_impl.py index 97d1807..a55883a 100644 --- a/quince/v1_impl.py +++ b/quince/v1_impl.py @@ -15,8 +15,9 @@ import logging - -from winchester.config import ConfigManager, ConfigSection, ConfigItem +from winchester.config import ConfigItem +from winchester.config import ConfigManager +from winchester.config import ConfigSection from winchester.db import DBInterface from winchester import models @@ -25,18 +26,20 @@ logger = logging.getLogger(__name__) class Impl(object): - @classmethod def config_description(cls): - return dict(config_path=ConfigItem( - help="Path(s) to find additional config files", - multiple=True, default='.'), - database=ConfigSection(help="Database connection info.", - config_description=DBInterface.config_description()), - ) + return dict( + config_path=ConfigItem( + help="Path(s) to find additional config files", + multiple=True, default='.'), + database=ConfigSection( + help="Database connection info.", + config_description=DBInterface.config_description()), + ) def __init__(self, config, scratchpad): """config is a ConfigParser object. + Use the scratchpad to ensure we don't create multiple connections to the db. """ @@ -46,17 +49,18 @@ class Impl(object): logger.debug("Quince is using Winchester config from %s" % target) quincy_config = ConfigManager.load_config_file(target) quincy_config = ConfigManager.wrap(quincy_config, - self.config_description()) + self.config_description()) scratchpad['quincy_config'] = quincy_config - scratchpad['quincy_driver'] = DBInterface(quincy_config['database']) + scratchpad['quincy_driver'] = DBInterface( + quincy_config['database']) self.winchester_config = scratchpad['quincy_config'] self.driver = scratchpad['quincy_driver'] def find_streams(self, count=False, state=None, older_than=None, - younger_than=None, trigger_name=None, - distinguishing_traits=None, mark=None, limit=None): + younger_than=None, trigger_name=None, + distinguishing_traits=None, mark=None, limit=None): if state is not None: try: @@ -64,14 +68,16 @@ class Impl(object): except KeyError: logger.error("invalid stream state %s" % state) raise - return self.driver.find_streams(count=count, - state=state, name=trigger_name, - younger_than=younger_than, older_than=older_than, - distinguishing_traits=distinguishing_traits, - mark=mark, limit=limit) + return self.driver.find_streams( + count=count, + state=state, name=trigger_name, + younger_than=younger_than, + older_than=older_than, + distinguishing_traits=distinguishing_traits, + mark=mark, limit=limit) def get_stream(self, stream_id, details): - stream = int(stream_id) + stream_id = int(stream_id) # Returns a list, but should be just one stream. return self.driver.find_streams(stream_id=stream_id, include_events=details) @@ -87,12 +93,12 @@ class Impl(object): self.driver.reset_stream(stream) def find_events(self, from_datetime=None, to_datetime=None, - event_name=None, traits=[], - mark=None, limit=None, count=False): + event_name=None, traits=None, + mark=None, limit=None, count=False): return self.driver.find_events(from_datetime=from_datetime, to_datetime=to_datetime, event_name=event_name, - traits=traits, + traits=traits or [], mark=mark, limit=limit, count=count) diff --git a/requirements.txt b/requirements.txt index ba9cb77..430abc1 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,3 @@ +hacking>=0.10.0,<0.11 winchester >=0.0.dev0 simport >=0.0.dev0 diff --git a/tox.ini b/tox.ini index 910ec50..4c0b15d 100644 --- a/tox.ini +++ b/tox.ini @@ -1,5 +1,5 @@ [tox] -envlist = py26,py27 +envlist = py26,py27,pep8 [testenv] deps = @@ -8,3 +8,12 @@ deps = mock commands = nosetests -d -v --with-coverage --cover-inclusive --cover-package quince [] + +[testenv:pep8] +commands = + flake8 + +[flake8] +ignore = +exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,*db/__init__.py,*db/migrations/versions/*_.py +show-source = True