Converting to Python 3

docs/source/conf.py

@@ -43,8 +43,8 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'Freeseer'
-copyright = u'© 2011-2014 Free and Open Source Software Learning Centre'
+project = 'Freeseer'
+copyright = '© 2011-2014 Free and Open Source Software Learning Centre'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -182,8 +182,8 @@
 latex_documents = [(
     'index',  # source start file
     'Freeseer.tex',  # target name
-    u'Freeseer Documentation',  # title
-    u'Free and Open Source Software Learning Centre',  # author
+    'Freeseer Documentation',  # title
+    'Free and Open Source Software Learning Centre',  # author
     'manual'  # documentclass [howto/manual]
 )]
 
@@ -216,6 +216,6 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'freeseer', u'Freeseer Documentation',
-     [u'Free and Open Source Software Learning Centre'], 1)
+    ('index', 'freeseer', 'Freeseer Documentation',
+     ['Free and Open Source Software Learning Centre'], 1)
 ]

docs/source/conf.py.bak

@@ -0,0 +1,221 @@
+# -*- coding: utf-8 -*-
+#
+# Freeseer documentation build configuration file, created by
+# sphinx-quickstart on Sun Sep  4 18:21:52 2011.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import os
+import sys
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here.
+sys.path.append('../src')  # Temporarily add freeseer/src to $PATH.
+
+# -- General configuration ----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#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.doctest',
+              'sphinx.ext.viewcode', 'sphinx.ext.todo']
+
+# If True, the todo and todolist directives will produce output.
+# http://sphinx.pocoo.org/ext/todo.html#module-sphinx.ext.todo
+todo_include_todos = True
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Freeseer'
+copyright = u'© 2011-2014 Free and Open Source Software Learning Centre'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '3.0'
+# The full version, including alpha/beta/rc tags.
+release = '3.0.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#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 = ['contribute/packaging.rst']
+
+# The reST default role (for text `like this`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#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
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+show_authors = True
+
+# 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 = []
+
+
+# -- Options for HTML output --------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'sphinx_rtd_theme'
+
+# 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 = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+html_theme_path = ['_themes', ]
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = 'freeseer_logo.png'
+
+# 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 = 'favicon.ico'
+
+# 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,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# 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'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+html_show_copyright = False
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Freeseerdoc'
+
+
+# -- Options for LaTeX output -------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. Takes a list of tuples.
+latex_documents = [(
+    'index',  # source start file
+    'Freeseer.tex',  # target name
+    u'Freeseer Documentation',  # title
+    u'Free and Open Source Software Learning Centre',  # author
+    'manual'  # documentclass [howto/manual]
+)]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output -------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'freeseer', u'Freeseer Documentation',
+     [u'Free and Open Source Software Learning Centre'], 1)
+]

src/freeseer/framework/config/core.py

@@ -31,11 +31,9 @@
 from freeseer.framework.config.exceptions import StorageNotSetError
 
 
-class Option(object):
+class Option(object, metaclass=abc.ABCMeta):
     """Represents a Config option."""
 
-    __metaclass__ = abc.ABCMeta
-
     class NotSpecified(object):
         pass
 
@@ -98,7 +96,7 @@ def __new__(meta, name, bases, class_attributes):
         class_attributes, options = meta.find_options(class_attributes)
         class_attributes['options'] = options
         cls = super(ConfigBase, meta).__new__(meta, name, bases, class_attributes)
-        for opt_name, option in options.iteritems():
+        for opt_name, option in options.items():
             opt_get = functools.partial(cls.get_value, name=opt_name, option=option, presentation=True)
             opt_set = functools.partial(cls._set_value, name=opt_name, option=option)
             setattr(cls, opt_name, property(opt_get, opt_set))
@@ -118,7 +116,7 @@ def find_options(class_attributes):
         return new_attributes, options
 
 
-class Config(object):
+class Config(object, metaclass=ConfigBase):
     """Base class for all custom configs.
 
     To be useful, its body must contain some number of Option instances.
@@ -128,8 +126,6 @@ class MyConfig(Config):
             test = StringOption('default_value')
     """
 
-    __metaclass__ = ConfigBase
-
     def __init__(self, storage=None, storage_args=None):
         """
         Params:
@@ -149,7 +145,7 @@ def _set_value(self, value, name, option):
 
     def set_defaults(self):
         """Sets the values of all options to their default value (if applicable)."""
-        for name, option in self.options.iteritems():
+        for name, option in self.options.items():
             if not option.is_required():
                 self.set_value(name, option, option.default)
 
@@ -210,7 +206,7 @@ def schema(cls):
             'properties': {},
         }
 
-        for name, instance in cls.options.iteritems():
+        for name, instance in cls.options.items():
             schema['properties'][name] = instance.schema()
             if instance.is_required():
                 required.append(name)
@@ -221,11 +217,9 @@ def schema(cls):
         return schema
 
 
-class ConfigStorage(object):
+class ConfigStorage(object, metaclass=abc.ABCMeta):
     """Defines an interface for loading and storing Config instances."""
 
-    __metaclass__ = abc.ABCMeta
-
     def __init__(self, filepath):
         """
         Params: