Add and test PEP 263 source file encoding specifications.

PEP 263 describes how to specify the encoding of a Python source file.
This commit adds UTF-8 encoding specifications to all CKAN Python source
files. It also adds a test which verifies that each source file does
indeed have a UTF-8 encoding specification.

Author: torfsen

ckan/__init__.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 __version__ = '2.6.0a'
 
 __description__ = 'CKAN Software'

ckan/authz.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import sys
 import re
 from logging import getLogger

ckan/ckan_nose_plugin.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 from nose.plugins import Plugin
 from inspect import isclass
 import hashlib

ckan/common.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 # This file contains commonly used parts of external libraries. The idea is
 # to help in removing helpers from being used as a dependency by many files
 # but at the same time making it easy to change for example the json lib

ckan/config/environment.py

@@ -1,4 +1,5 @@
-# -*- coding: utf-8 -*-
+# encoding: utf-8
+
 """Pylons environment configuration"""
 import os
 import logging

ckan/config/install.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import re
 
 from pylons.util import PylonsInstaller

ckan/config/middleware.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 """Pylons middleware initialization"""
 import urllib
 import urllib2

ckan/config/routing.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 """Routes configuration
 
 The more specific and detailed routes should be defined first so they

ckan/controllers/admin.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 from pylons import config
 
 import ckan.lib.base as base

ckan/controllers/api.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import os.path
 import logging
 import cgi

ckan/controllers/error.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import cgi
 
 from paste.urlparser import PkgResourcesParser

ckan/controllers/feed.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 """
 The feed controller produces Atom feeds of datasets.
 

ckan/controllers/group.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import logging
 import datetime
 from urllib import urlencode

ckan/controllers/home.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 from pylons import config, cache
 import sqlalchemy.exc
 

ckan/controllers/organization.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import re
 
 import ckan.controllers.group as group

ckan/controllers/package.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import logging
 from urllib import urlencode
 import datetime

ckan/controllers/partyline.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 from pylons.controllers import WSGIController
 from pylons import config
 

ckan/controllers/revision.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 from datetime import datetime, timedelta
 
 from pylons.i18n import get_lang

ckan/controllers/storage.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 '''
 
 Note: This is the old file store controller for CKAN < 2.2.

ckan/controllers/template.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import ckan.lib.base as base
 import ckan.lib.render
 

ckan/controllers/user.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import logging
 from urllib import quote
 

ckan/controllers/util.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import re
 
 import ckan.lib.base as base

ckan/exceptions.py

@@ -1,4 +1,6 @@
-# -*- coding: utf-8 -*-
+# encoding: utf-8
+
+
 class CkanException(Exception):
     pass
 

ckan/i18n/__init__.py

@@ -1 +1,3 @@
+# encoding: utf-8
+
 # Need some content here to avoid the packaging stripping it out

ckan/i18n/check_po_files.py

@@ -1,4 +1,6 @@
 #!/usr/bin/env python
+# encoding: utf-8
+
 '''Script for checking for common translation mistakes in po files, see:
 
     paster check-po-files --help

ckan/lib/activity_streams.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import re
 
 from webhelpers.html import literal

ckan/lib/activity_streams_session_extension.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 from pylons import config
 from sqlalchemy.orm.session import SessionExtension
 from paste.deploy.converters import asbool

ckan/lib/alphabet_paginate.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 '''
 Based on webhelpers.paginator, but:
  * each page is for items beginning with a particular letter

ckan/lib/app_globals.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 ''' The application's Globals object '''
 
 import logging

ckan/lib/auth_tkt.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import math
 import os
 

ckan/lib/authenticator.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import logging
 
 from zope.interface import implements

ckan/lib/base.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 """The base Controller API
 
 Provides the BaseController class for subclassing.

ckan/lib/captcha.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 from pylons import config
 
 import urllib

ckan/lib/celery_app.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import ConfigParser
 import os
 import logging

ckan/lib/cli.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import collections
 import csv
 import multiprocessing as mp

ckan/lib/config_tool.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import re
 
 INSERT_NEW_SECTIONS_BEFORE_SECTION = 'app:main'

ckan/lib/create_test_data.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import logging
 from collections import defaultdict
 import datetime

ckan/lib/datapreview.py

@@ -1,4 +1,4 @@
-# coding=UTF-8
+# encoding: utf-8
 
 """Data previewer functions
 

ckan/lib/dictization/__init__.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import datetime
 from sqlalchemy.orm import class_mapper
 import sqlalchemy

ckan/lib/dictization/model_dictize.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 '''
 These dictize functions generally take a domain object (such as Package) and
 convert it to a dictionary, including related objects (e.g. for Package it

ckan/lib/dictization/model_save.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import datetime
 import uuid
 import logging

ckan/lib/email_notifications.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 '''
 Code for generating email notifications for users (e.g. email notifications for
 new activities in your dashboard activity stream) and emailing them to the

ckan/lib/extract.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import re
 from jinja2.ext import babel_extract as extract_jinja2
 import lib.jinja_extensions

ckan/lib/fanstatic_extensions.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import fanstatic.core as core
 
 

ckan/lib/fanstatic_resources.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import os.path
 import sys
 import logging

ckan/lib/formatters.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import datetime
 import pytz
 from babel import numbers

ckan/lib/hash.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import hmac
 import hashlib
 

ckan/lib/helpers.py

@@ -1,4 +1,4 @@
-# coding=UTF-8
+# encoding: utf-8
 
 '''Helper functions
 

ckan/lib/i18n.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import os
 
 from babel import Locale, localedata

ckan/lib/jinja_extensions.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import re
 from os import path
 import logging

ckan/lib/jsonp.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import decorator
 
 from ckan.common import json, request, response

ckan/lib/mailer.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import smtplib
 import logging
 import uuid

ckan/lib/maintain.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 ''' This module contains code that helps in maintaining the Ckan codebase. '''
 
 import inspect

ckan/lib/munge.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 # Note these functions are similar to, but separate from name/title mungers
 # found in the ckanext importer. That one needs to be stable to prevent
 # packages changing name on reimport, but these ones can be changed and

ckan/lib/navl/__init__.py

@@ -1 +1,3 @@
+# encoding: utf-8
+
 __license__ = 'MIT'

ckan/lib/navl/dictization_functions.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import copy
 import formencode as fe
 import inspect

ckan/lib/navl/validators.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import ckan.lib.navl.dictization_functions as df
 
 from ckan.common import _

ckan/lib/plugins.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import logging
 import os
 import sys

ckan/lib/render.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import os
 import re
 import logging

ckan/lib/search/__init__.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import logging
 import sys
 import cgitb

ckan/lib/search/common.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import datetime
 import logging
 import re

ckan/lib/search/index.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import socket
 import string
 import logging

ckan/lib/search/query.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import re
 import logging
 

ckan/lib/search/sql.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 from sqlalchemy import or_
 from ckan.lib.search.query import SearchQuery
 import ckan.model as model

ckan/lib/uploader.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 import os
 import cgi
 import pylons

ckan/lib/util.py

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 '''Shared utility functions for any Python code to use.
 
 Unlike :py:mod:`ckan.lib.helpers`, the functions in this module are not