Merge lp:~elachuni/ubuntu-webcatalog/pep8-test into lp:ubuntu-webcatalog

[Anthony Lenton]

Added a test that checks code against PEP 8, and made it pass.

Overview
========
This branch adds a test that checks our code against PEP8, and makes it pass.

Details
=======
The test itself is copied over from sca/devportal.

[lp:~elachuni/ubuntu-webcatalog/pep8-test]

61. By Anthony Lenton on 2012-01-06

small doc fix.

[Danny Tamez (zematynnad)]

I always wondered how many PEP8 changes would have to be made when adding this test :)
Looks good

review: Approve

=== modified file 'setup.py'
--- setup.py	2011-11-17 16:02:20 +0000
+++ setup.py	2012-01-06 18:17:37 +0000
@@ -47,6 +47,7 @@
         'httplib2',
         'django-pgtools==0.1',
         'rnrclient==1.0',
+        'pep8',
         'PIL',
         'lazr.restfulclient',
         ],

=== modified file 'src/webcatalog/admin.py'
--- src/webcatalog/admin.py	2011-09-12 13:37:24 +0000
+++ src/webcatalog/admin.py	2012-01-06 18:17:37 +0000
@@ -42,6 +42,7 @@
     list_filter = ('distroseries', 'departments')
     exclude = ('for_purchase', 'archive_id')
 
+
 class MachineAdmin(admin.ModelAdmin):
     search_fields = ('owner__username', 'hostname', 'uuid')
     list_display = ('hostname', 'uuid', 'owner')

=== modified file 'src/webcatalog/api/forms.py'
--- src/webcatalog/api/forms.py	2011-09-12 13:37:24 +0000
+++ src/webcatalog/api/forms.py	2012-01-06 18:17:37 +0000
@@ -29,6 +29,7 @@
 
 from webcatalog.models import Machine
 
+
 class MachineCreateUpdateForm(forms.ModelForm):
     class Meta:
         model = Machine
@@ -37,6 +38,7 @@
             'logo_checksum',
             )
 
+
 class MachineUpdatePackagesForm(forms.ModelForm):
     class Meta:
         model = Machine

=== modified file 'src/webcatalog/api/handlers.py'
--- src/webcatalog/api/handlers.py	2011-09-12 13:37:24 +0000
+++ src/webcatalog/api/handlers.py	2012-01-06 18:17:37 +0000
@@ -37,12 +37,14 @@
 from webcatalog.models import Machine
 from .forms import MachineCreateUpdateForm, MachineUpdatePackagesForm
 
+
 class ServerStatusHandler(BaseHandler):
     allowed_methods = ('GET',)
 
     def read(self, request):
         return "ok"
 
+
 class ListMachinesHandler(BaseHandler):
     allowed_methods = ('GET',)
     model = Machine
@@ -52,6 +54,7 @@
         result = Machine.objects.filter(owner=request.user)
         return result.defer('package_list')
 
+
 class MachineHandler(BaseHandler):
     allowed_methods = ('GET', 'POST', 'DELETE')
     model = Machine
@@ -78,7 +81,7 @@
                           for (k, v) in form.errors.items())
             result = {'status': 'error', 'errors': errors}
             return result
-        
+
     def delete(self, request, uuid):
         instances = Machine.objects.filter(owner=request.user, uuid=uuid)
         if instances.count() > 0:
@@ -86,17 +89,18 @@
             return HttpResponse(status=204)
         else:
             return HttpResponseNotFound('Invalid machine UUID')
-            
+
 
 class PackagesHandler(BaseHandler):
-    allowed_methods = ('GET', 'POST',)  
+    allowed_methods = ('GET', 'POST',)
+
     def read(self, request, uuid):
         try:
             instance = Machine.objects.get(owner=request.user, uuid=uuid)
             return instance.package_list
         except Machine.DoesNotExist:
             return HttpResponseNotFound('Invalid machine UUID')
-        
+
     def create(self, request, uuid):
         try:
             instance = Machine.objects.get(owner=request.user, uuid=uuid)

=== modified file 'src/webcatalog/api/urls.py'
--- src/webcatalog/api/urls.py	2011-09-19 19:54:15 +0000
+++ src/webcatalog/api/urls.py	2012-01-06 18:17:37 +0000
@@ -27,6 +27,7 @@
 
 auth = SSOOAuthAuthentication(realm="Ubuntu Software Center")
 
+
 class CSRFExemptResource(Resource):
     """A Custom Resource that is csrf exempt"""
     def __init__(self, handler, authentication=None):
@@ -34,9 +35,12 @@
         self.csrf_exempt = True
 
 server_status_resource = Resource(handler=ServerStatusHandler)
-list_machines_resource = Resource(handler=ListMachinesHandler, authentication=auth)
-machine_resource = CSRFExemptResource(handler=MachineHandler, authentication=auth)
-packages_resource = CSRFExemptResource(handler=PackagesHandler, authentication=auth)
+list_machines_resource = Resource(handler=ListMachinesHandler,
+    authentication=auth)
+machine_resource = CSRFExemptResource(handler=MachineHandler,
+    authentication=auth)
+packages_resource = CSRFExemptResource(handler=PackagesHandler,
+    authentication=auth)
 
 urlpatterns = patterns('',
     # get status of the service (usually just "ok", might be "read-only")

=== modified file 'src/webcatalog/auth.py'
--- src/webcatalog/auth.py	2011-09-19 20:01:32 +0000
+++ src/webcatalog/auth.py	2012-01-06 18:17:37 +0000
@@ -39,8 +39,9 @@
     full_claimed_id,
 )
 
-TOKEN_CACHE_EXPIRY = timedelta(hours=
-    getattr(settings, 'TOKEN_CACHE_EXPIRY_HOURS', 4))
+TOKEN_CACHE_EXPIRY = timedelta(hours=getattr(settings,
+    'TOKEN_CACHE_EXPIRY_HOURS', 4))
+
 
 class SSOOAuthAuthentication(OAuthAuthentication):
     """ This class is a Piston Authentication class.
@@ -65,7 +66,7 @@
         before the oauth mechanism asks us for them
         """
         http_auth = request.META.get('HTTP_AUTHORIZATION', '')
-        headers = {'Authorization' : http_auth}
+        headers = {'Authorization': http_auth}
         orequest = oauth.OAuthRequest.from_request(
             request.method, request.build_absolute_uri(), headers=headers,
             query_string=request.META['QUERY_STRING'])
@@ -98,7 +99,8 @@
         if len(tokens) == 0 or (tokens[0].updated_at <
             datetime.now() - TOKEN_CACHE_EXPIRY):
             pieces = web_services.get_data_for_account(token=oauthtoken,
-                openid_identifier=consumer_key, signature=request.get_parameter('oauth_signature'))
+                openid_identifier=consumer_key,
+                signature=request.get_parameter('oauth_signature'))
             if not pieces:
                 return
             Consumer.objects.filter(key=consumer_key).exclude(
@@ -137,12 +139,13 @@
             raise OAuthError('initialize_server_request returned None')
         return oauth_server.verify_request(oauth_request)
 
+
 def initialize_server_request(request):
     """
     Shortcut for initialization.
     """
     headers = {
-        'Authorization' : request.META.get('HTTP_AUTHORIZATION', '')
+        'Authorization': request.META.get('HTTP_AUTHORIZATION', '')
     }
     oauth_request = oauth.OAuthRequest.from_request(
         request.method, request.build_absolute_uri(), headers=headers,
@@ -150,8 +153,10 @@
 
     if oauth_request:
         oauth_server = oauth.OAuthServer(oauth_datastore(oauth_request))
-        oauth_server.add_signature_method(oauth.OAuthSignatureMethod_PLAINTEXT())
-        oauth_server.add_signature_method(oauth.OAuthSignatureMethod_HMAC_SHA1())
+        oauth_server.add_signature_method(
+            oauth.OAuthSignatureMethod_PLAINTEXT())
+        oauth_server.add_signature_method(
+            oauth.OAuthSignatureMethod_HMAC_SHA1())
     else:
         oauth_server = None
 

=== modified file 'src/webcatalog/context_processors.py'
--- src/webcatalog/context_processors.py	2012-01-06 14:24:49 +0000
+++ src/webcatalog/context_processors.py	2012-01-06 18:17:37 +0000
@@ -19,6 +19,7 @@
 
 from django.conf import settings
 
+
 def google_analytics_id(request):
     """Adds the google analytics id to the context if it's present."""
     return {

=== modified file 'src/webcatalog/department_filters.py'
--- src/webcatalog/department_filters.py	2011-09-12 13:37:24 +0000
+++ src/webcatalog/department_filters.py	2012-01-06 18:17:37 +0000
@@ -38,12 +38,14 @@
         return bool(app.categories_set.intersection(categories_set))
     return filter_func
 
+
 def package_name_filter(name_regex):
     """Returns a filter func that checks if an app's name matches a regex"""
     def filter_func(app):
         return re.match(name_regex, app.package_name) is not None
     return filter_func
 
+
 def section_filter(sections):
     """Returns a filter that checks if an app is in certain sections."""
     def filter_func(app):

=== modified file 'src/webcatalog/forms.py'
--- src/webcatalog/forms.py	2011-09-12 13:37:24 +0000
+++ src/webcatalog/forms.py	2012-01-06 18:17:37 +0000
@@ -53,7 +53,7 @@
 
     class Meta:
         model = Application
-        exclude = ('distroseries','for_purchase', 'archive_id', 'price')
+        exclude = ('distroseries', 'for_purchase', 'archive_id', 'price')
 
     @classmethod
     def get_form_from_desktop_data(cls, str_data, distroseries):
@@ -61,7 +61,7 @@
         parser.readfp(StringIO(str_data))
         data = dict(parser.items('Desktop Entry'))
         for desktop_key, app_key in desktop_field_mappings.items():
-            if data.has_key(desktop_key):
+            if desktop_key in data:
                 data[app_key] = data[desktop_key]
                 del(data[desktop_key])
 
@@ -86,6 +86,7 @@
 
         return cleaned_data
 
+
 class ForPurchaseApplicationForm(forms.ModelForm):
     class Meta:
         model = Application

=== modified file 'src/webcatalog/management/commands/import_app_install_data.py'
--- src/webcatalog/management/commands/import_app_install_data.py	2011-09-12 13:37:24 +0000
+++ src/webcatalog/management/commands/import_app_install_data.py	2012-01-06 18:17:37 +0000
@@ -135,7 +135,8 @@
 
             # Extract and parse the deb archive.
             deb_file = DebFile(deb_location)
-            self.output("Processing application data to update database...\n", 1)
+            self.output("Processing application data to update database...\n",
+                1)
             deb_file.data.extractall(data_dir)
             matcher = data_dir + '/usr/share/app-install/desktop/*.desktop'
             icon_dir = data_dir + '/usr/share/app-install/icons/'

=== modified file 'src/webcatalog/management/commands/import_for_purchase_apps.py'
--- src/webcatalog/management/commands/import_for_purchase_apps.py	2011-09-15 08:58:19 +0000
+++ src/webcatalog/management/commands/import_for_purchase_apps.py	2012-01-06 18:17:37 +0000
@@ -15,7 +15,9 @@
 #   You should have received a copy of the GNU Affero General Public License
 #   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-"""Management command to import for purchase applications from Software Center."""
+"""Management command to import for purchase applications from Software
+   Center.
+"""
 
 from __future__ import (
     absolute_import,

=== modified file 'src/webcatalog/models/applications.py'
--- src/webcatalog/models/applications.py	2011-09-12 13:37:24 +0000
+++ src/webcatalog/models/applications.py	2012-01-06 18:17:37 +0000
@@ -175,7 +175,7 @@
         if distro is not None:
             args = [distro]
         args.append(self.id)
-        url =reverse('wc-department', args=args)
+        url = reverse('wc-department', args=args)
         crumbs.append({'name': self.name, 'url': url})
         return crumbs
 
@@ -186,6 +186,7 @@
 class ReviewStatsImport(models.Model):
     distroseries = models.ForeignKey(DistroSeries, unique=True)
     last_import = models.DateTimeField(default=datetime.utcnow)
+
     class Meta:
         app_label = 'webcatalog'
 
@@ -197,6 +198,7 @@
     packages_checksum = models.CharField(max_length=56)
     package_list = models.TextField()
     logo_checksum = models.CharField(max_length=56, blank=True)
+
     class Meta:
         app_label = 'webcatalog'
         unique_together = ('owner', 'uuid')

=== modified file 'src/webcatalog/models/oauthtoken.py'
--- src/webcatalog/models/oauthtoken.py	2011-09-12 13:37:24 +0000
+++ src/webcatalog/models/oauthtoken.py	2012-01-06 18:17:37 +0000
@@ -151,6 +151,7 @@
     class Meta:
         app_label = 'webcatalog'
 
+
 class DataStore(OAuthDataStore):
 
     def lookup_token(self, token_type, token_field):
@@ -186,7 +187,6 @@
         if consumer is not None:
             return consumer.oauth_consumer()
 
-
     def lookup_nonce(self, consumer, token, nonce):
         """
         :param consumer: OAuthConsumer object

=== modified file 'src/webcatalog/schema.py'
--- src/webcatalog/schema.py	2012-01-06 14:24:49 +0000
+++ src/webcatalog/schema.py	2012-01-06 18:17:37 +0000
@@ -76,7 +76,7 @@
     rnr = ConfigSection()
     rnr.rnr_service_root = StringConfigOption(
         default="http://reviews.ubuntu.com/reviews/api/1.0")
-    rnr.reviews_cache_timeout = IntConfigOption(default=60*15)
+    rnr.reviews_cache_timeout = IntConfigOption(default=60 * 15)
 
     sso_api = ConfigSection()
     sso_api.sso_api_service_root = StringConfigOption()

=== modified file 'src/webcatalog/templatetags/webcatalog.py'
--- src/webcatalog/templatetags/webcatalog.py	2011-09-15 10:53:40 +0000
+++ src/webcatalog/templatetags/webcatalog.py	2012-01-06 18:17:37 +0000
@@ -155,6 +155,7 @@
         old_indent_level = indent_level
     return norm_description.strip()
 
+
 @register.filter
 def htmlize_package_description(desc):
     html = ""

=== modified file 'src/webcatalog/tests/__init__.py'
--- src/webcatalog/tests/__init__.py	2012-01-06 14:24:49 +0000
+++ src/webcatalog/tests/__init__.py	2012-01-06 18:17:37 +0000
@@ -23,6 +23,7 @@
 from .test_forms import *
 from .test_handlers import *
 from .test_models import *
+from .test_pep8 import *
 from .test_templatetags import *
 from .test_utilities import *
 from .test_views import *

=== modified file 'src/webcatalog/tests/test_api.py'
--- src/webcatalog/tests/test_api.py	2011-09-12 13:37:24 +0000
+++ src/webcatalog/tests/test_api.py	2012-01-06 18:17:37 +0000
@@ -43,11 +43,13 @@
 from .factory import TestCaseWithFactory
 from webcatalog.models import Machine
 
+
 class ServerStatusTestCase(TestCase):
     def test_server_status(self):
         response = self.client.get('/cat/api/1.0/server-status/')
         self.assertEqual(response.content, '"ok"')
 
+
 class AuthenticatedAPITestCase(TestCaseWithFactory):
     def auth_header_for_user(self, url, user=None, realm='OAuth'):
         token, consumer = self.factory.make_oauth_token_and_consumer(user=user)
@@ -63,6 +65,7 @@
 
 class ListMachinesTestCase(AuthenticatedAPITestCase):
     url = '/cat/api/1.0/list-machines/'
+
     def test_no_auth_returns_401(self):
         response = self.client.get(self.url)
         self.assertEqual(401, response.status_code)

=== modified file 'src/webcatalog/tests/test_commands.py'
--- src/webcatalog/tests/test_commands.py	2011-09-15 10:53:40 +0000
+++ src/webcatalog/tests/test_commands.py	2012-01-06 18:17:37 +0000
@@ -89,9 +89,9 @@
         mock_cache = MagicMock()
         mock_apt_firefox = self.make_mock_apt_package('firefox',
             description="Firefox description")
-        mock_apt_scribus=self.make_mock_apt_package('scribus',
+        mock_apt_scribus = self.make_mock_apt_package('scribus',
             description="Scribus description")
-        mock_other_app=self.make_mock_apt_package('otherapp',
+        mock_other_app = self.make_mock_apt_package('otherapp',
             description="Otherapp description",
             summary="Otherapp the Internet\nA tagline for Otherapp")
         mock_app_install_data = self.make_mock_apt_package('app-install-data',
@@ -169,7 +169,8 @@
         with patch(get_uri_fn) as mock_get_uri:
             mock_get_uri.return_value = 'http://example.com/my.deb'
             with patch('urllib.urlretrieve') as mock_urlretrieve:
-                ImportAppInstallCommand().get_latest_app_data_for_series('natty', tmp_dir)
+                ImportAppInstallCommand().get_latest_app_data_for_series(
+                    'natty', tmp_dir)
         shutil.rmtree(tmp_dir)
 
         mock_urlretrieve.assert_called_with(
@@ -540,5 +541,3 @@
 
         # update_apps_with_stats returns None on success:
         self.assertIsNone(command.update_apps_with_stats(natty, stats))
-
-        

=== modified file 'src/webcatalog/tests/test_models.py'
--- src/webcatalog/tests/test_models.py	2011-09-12 13:37:24 +0000
+++ src/webcatalog/tests/test_models.py	2012-01-06 18:17:37 +0000
@@ -102,7 +102,7 @@
     def test_normalized_name(self):
         cases = {
             'Foo': 'Foo',
-            'Foo & Bar':  'FooBar',
+            'Foo & Bar': 'FooBar',
             '  Foo, Bar ': 'FooBar',
             ' && , ': '',
             '': ''

=== added file 'src/webcatalog/tests/test_pep8.py'
--- src/webcatalog/tests/test_pep8.py	1970-01-01 00:00:00 +0000
+++ src/webcatalog/tests/test_pep8.py	2012-01-06 18:17:37 +0000
@@ -0,0 +1,72 @@
+#   -*- coding: utf-8 -*-
+#   This file is part of the Apps Directory
+#   Copyright (C) 2011 Canonical Ltd.
+#
+#   This program is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU Affero General Public License as
+#   published by the Free Software Foundation, either version 3 of the
+#   License, or (at your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU Affero General Public License for more details.
+#
+#   You should have received a copy of the GNU Affero General Public License
+#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Apps Directory pep-8 compliance tests."""
+
+from __future__ import absolute_import
+
+__metaclass__ = type
+__all__ = [
+    'WebCatalogPep8TestCase',
+    ]
+
+import os
+import pep8
+from collections import defaultdict
+from unittest import TestCase
+
+import webcatalog
+
+
+class PackagePep8TestCase(TestCase):
+    maxDiff = None
+    packages = []
+    exclude = ['migrations']
+
+    def message(self, text):
+        self.errors.append(text)
+
+    def setUp(self):
+        self.errors = []
+
+        class Options(object):
+            exclude = self.exclude
+            filename = ['*.py']
+            testsuite = ''
+            doctest = ''
+            counters = defaultdict(int)
+            messages = {}
+            verbose = 0
+            quiet = 0
+            repeat = True
+            show_source = False
+            show_pep8 = False
+            select = []
+            ignore = []
+        pep8.options = Options()
+        pep8.message = self.message
+        Options.physical_checks = pep8.find_checks('physical_line')
+        Options.logical_checks = pep8.find_checks('logical_line')
+
+    def test_all_code(self):
+        for package in self.packages:
+            pep8.input_dir(os.path.dirname(package.__file__))
+        self.assertEqual([], self.errors)
+
+
+class WebCatalogPep8TestCase(PackagePep8TestCase):
+    packages = [webcatalog]

=== modified file 'src/webcatalog/tests/test_templatetags.py'
--- src/webcatalog/tests/test_templatetags.py	2011-09-15 10:53:40 +0000
+++ src/webcatalog/tests/test_templatetags.py	2012-01-06 18:17:37 +0000
@@ -182,7 +182,8 @@
 * Lha archives (.lzh)
 * Single files compressed with gzip (.gz), bzip (.bz), bzip2 (.bz2),
   compress (.Z), lzip (.lz), lzop (.lzo), lzma (.lzma) and xz (.xz)
-File-roller doesn't perform archive operations by itself, but relies on standard tools for this.
+File-roller doesn't perform archive operations by itself, but relies on \
+standard tools for this.
 """
 
 #drgeo
@@ -240,6 +241,7 @@
    * Extensible with plugins
 """
 
+
 class HtmlizePackageDescriptionTestCase(unittest.TestCase):
     def test_htmlize(self):
         for descr in [d1, d2, d3]:
@@ -275,13 +277,13 @@
 class VisiblePageRangeTestCase(unittest.TestCase):
     def test_visible_page_range(self):
         cases = [
-            ( 2, 1, [1, 2]),
+            (2, 1, [1, 2]),
             (20, 1, range(1, 11)),
-            ( 3, 2, [1, 2, 3]),
+            (3, 2, [1, 2, 3]),
             (20, 2, range(1, 11)),
-            ( 4, 4, [1, 2, 3, 4]),
+            (4, 4, [1, 2, 3, 4]),
             (20, 8, range(3, 13)),
-            ( 8, 8, range(3, 9)),
+            (8, 8, range(3, 9)),
             (20, 18, range(13, 21)),
             (400, 400, range(395, 401)),
         ]

=== modified file 'src/webcatalog/tests/test_utilities.py'
--- src/webcatalog/tests/test_utilities.py	2011-09-12 13:37:24 +0000
+++ src/webcatalog/tests/test_utilities.py	2012-01-06 18:17:37 +0000
@@ -22,12 +22,13 @@
 from webcatalog.tests.factory import TestCaseWithFactory
 from webcatalog.utilities import create_png_from_file
 
+
 class CreatePNGFromFileTestCase(TestCaseWithFactory):
     def test_file_conversion(self):
         filenames = [
-            self.factory.get_test_path('firefox.xpm'), # Regular xpm
-            self.factory.get_test_path('mini-gsmc.xpm'), # named colors
-            self.factory.get_test_path('access.svg'), # SVG file
+            self.factory.get_test_path('firefox.xpm'),  # Regular xpm
+            self.factory.get_test_path('mini-gsmc.xpm'),  # named colors
+            self.factory.get_test_path('access.svg'),  # SVG file
         ]
         pngpath = 'test_file_DELETEME.png'
         for f in filenames:

=== modified file 'src/webcatalog/utilities.py'
--- src/webcatalog/utilities.py	2011-09-15 13:40:53 +0000
+++ src/webcatalog/utilities.py	2012-01-06 18:17:37 +0000
@@ -102,7 +102,7 @@
         if cached_reviews is not None:
             return cached_reviews
 
-        fresh_reviews = self.rnr_api.get_reviews(packagename=package_name, 
+        fresh_reviews = self.rnr_api.get_reviews(packagename=package_name,
             distroseries=distroseries, page=page)
         cache.set(key, fresh_reviews, settings.REVIEWS_CACHE_TIMEOUT)
         return fresh_reviews

=== modified file 'src/webcatalog/views.py'
--- src/webcatalog/views.py	2011-09-16 09:43:11 +0000
+++ src/webcatalog/views.py	2012-01-06 18:17:37 +0000
@@ -182,7 +182,7 @@
     app = get_object_or_404(Application, package_name=package_name,
                             distroseries__code_name=distro)
     # XXX michaeln 2011-09-15 bug=851662 Better review language options.
-    reviews = WebServices().get_reviews_for_package(package_name, 
+    reviews = WebServices().get_reviews_for_package(package_name,
         distroseries=distro, page=page)
 
     context = dict(application=app, reviews=reviews)

=== modified file 'src/webcatalog/wsgi.py'
--- src/webcatalog/wsgi.py	2011-09-12 13:37:24 +0000
+++ src/webcatalog/wsgi.py	2012-01-06 18:17:37 +0000
@@ -25,8 +25,9 @@
 from django.core.handlers.wsgi import WSGIHandler
 from django.conf import settings
 
+
 def make_app():
-    """Encapsulate our webcatalog handler in an OOPS app for error reporting."""
+    """Encapsulate our webcatalog handler in an OOPS app."""
     default_id = ''.join(x for x in platform.node() if x.isalpha())
     appserver_id = getattr(settings, 'APPSERVER_ID', default_id)
     logging.config.fileConfig(settings.WEBAPP_LOGGING_CONFIG)