Merge pull request #195 from plone/plone-base-overhaul

Plone base overhaul

docs/source/conf.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 #
 # plone.app.discussion documentation build configuration file, created by
 # sphinx-quickstart on Thu Mar 18 10:17:15 2010.
@@ -24,184 +23,190 @@
 
 # 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.intersphinx',
-              'sphinx.ext.todo',
-              'sphinx.ext.coverage',
-              'repoze.sphinx.autointerface'
-              ]
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.doctest",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.todo",
+    "sphinx.ext.coverage",
+    "repoze.sphinx.autointerface",
+]
 
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix of source filenames.
-source_suffix = '.txt'
+source_suffix = ".txt"
 
 # The encoding of source files.
-#source_encoding = 'utf-8'
+# source_encoding = 'utf-8'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = u'plone.app.discussion'
-copyright = u'2010, Timo Stollenwerk - Plone Foundation'
+project = "plone.app.discussion"
+copyright = "2010, Timo Stollenwerk - Plone Foundation"
 
 # 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 = '2.0'
+version = "2.0"
 # The full version, including alpha/beta/rc tags.
-release = '2.0'
+release = "2.0"
 
 # 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 documents that shouldn't be included in the build.
-#unused_docs = []
+# unused_docs = []
 
 # List of directories, relative to source directory, that shouldn't be searched
 # for source files.
 exclude_trees = []
 
 # The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
+# 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'
+pygments_style = "sphinx"
 
 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
 
 
 # -- Options for HTML output ---------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  Major themes that come with
 # Sphinx are currently 'default' and 'sphinxdoc'.
-#html_theme = 'plone'
+# html_theme = 'plone'
 
 # 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 = ['_themes']
+html_theme_path = ["_themes"]
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> 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.
-#html_logo = None
+# html_logo = None
 
 # 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,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+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'
+# 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_use_modindex = True
+# html_use_modindex = 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, 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 = ''
+# html_use_opensearch = ''
 
 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = ''
+# html_file_suffix = ''
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'ploneappdiscussiondoc'
+htmlhelp_basename = "ploneappdiscussiondoc"
 
 
 # -- Options for LaTeX output --------------------------------------------
 
 # The paper size ('letter' or 'a4').
-#latex_paper_size = 'letter'
+# latex_paper_size = 'letter'
 
 # The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
+# latex_font_size = '10pt'
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-    ('index', 'ploneappdiscussion.tex', u'plone.app.discussion Documentation',
-     u'Timo Stollenwerk', 'manual'),
+    (
+        "index",
+        "ploneappdiscussion.tex",
+        "plone.app.discussion Documentation",
+        "Timo Stollenwerk",
+        "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
 
 # Additional stuff for the LaTeX preamble.
-#latex_preamble = ''
+# latex_preamble = ''
 
 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
 
 # If false, no module index is generated.
-#latex_use_modindex = True
+# latex_use_modindex = True
 
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'http://docs.python.org/': None}
+intersphinx_mapping = {"http://docs.python.org/": None}

docs/source/howtos/howto_extend_the_comment_form.txt

@@ -58,13 +58,13 @@ comment form with the "website" field::
 
     # Interface to define the fields we want to add to the comment form.
     class ICommentExtenderFields(Interface):
-        website = schema.TextLine(title=u"Website", required=False)
+        website = schema.TextLine(title="Website", required=False)
 
     # Persistent class that implements the ICommentExtenderFields interface
     @adapter(Comment)
     class CommentExtenderFields(Persistent):
         interface.implements(ICommentExtenderFields)
-        website = u""
+        website = ""
 
     # CommentExtenderFields factory
     CommentExtenderFactory = factory(CommentExtenderFields)

docs/source/howtos/howto_make_pad_work_with_a_dexterity_content_type.txt

@@ -20,8 +20,8 @@ configure.zcml::
 Define an interface IMyDexterityContentType groked schema, I added::
 
         allowDiscussion  = schema.Bool(
-            title=_(u"Allow Users to Comment"),
-            description=_(u"Allow users to commemt on you.  Comments
+            title=_("Allow Users to Comment"),
+            description=_("Allow users to comment on you.  Comments
 are shown at the end of each page"),
             required=True,
             default=True,

news/195.breaking

@@ -0,0 +1,2 @@
+Code style black & isort. Remove six usage. Use plone.base and move annotation key over to here.
+[jensens]

plone/__init__.py

@@ -1,2 +1 @@
-# -*- coding: utf-8 -*-
-__import__('pkg_resources').declare_namespace(__name__)
+__import__("pkg_resources").declare_namespace(__name__)

plone/app/__init__.py

@@ -1,2 +1 @@
-# -*- coding: utf-8 -*-
-__import__('pkg_resources').declare_namespace(__name__)
+__import__("pkg_resources").declare_namespace(__name__)

plone/app/discussion/__init__.py

@@ -1,5 +1,4 @@
-# -*- coding: utf-8 -*-
 from zope.i18nmessageid import MessageFactory
 
 
-_ = MessageFactory('plone')
+_ = MessageFactory("plone")

plone/app/discussion/browser/captcha.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Captcha validator, see captcha.txt for design notes.
 from persistent import Persistent
 from plone.app.discussion.browser.comments import CommentForm
@@ -21,9 +20,9 @@
 @adapter(Comment)
 @interface.implementer(ICaptcha)
 class Captcha(Persistent):
-    """Captcha input field.
-    """
-    captcha = u''
+    """Captcha input field."""
+
+    captcha = ""
 
 
 Captcha = factory(Captcha)
@@ -47,22 +46,24 @@ def __init__(self, context, request, form):
         registry = queryUtility(IRegistry)
         settings = registry.forInterface(IDiscussionSettings, check=False)
         self.captcha = settings.captcha
-        portal_membership = getToolByName(self.context, 'portal_membership')
+        portal_membership = getToolByName(self.context, "portal_membership")
         self.isAnon = portal_membership.isAnonymousUser()
 
     def update(self):
-        if self.captcha != 'disabled' and self.isAnon:
+        if self.captcha != "disabled" and self.isAnon:
             # Add a captcha field if captcha is enabled in the registry
-            self.add(ICaptcha, prefix='')
-            if self.captcha == 'captcha':
+            self.add(ICaptcha, prefix="")
+            if self.captcha == "captcha":
                 from plone.formwidget.captcha import CaptchaFieldWidget
-                self.form.fields['captcha'].widgetFactory = CaptchaFieldWidget
-            elif self.captcha == 'recaptcha':
+
+                self.form.fields["captcha"].widgetFactory = CaptchaFieldWidget
+            elif self.captcha == "recaptcha":
                 from plone.formwidget.recaptcha import ReCaptchaFieldWidget
-                self.form.fields['captcha'].widgetFactory = \
-                    ReCaptchaFieldWidget
-            elif self.captcha == 'norobots':
+
+                self.form.fields["captcha"].widgetFactory = ReCaptchaFieldWidget
+            elif self.captcha == "norobots":
                 from collective.z3cform.norobots import NorobotsFieldWidget
-                self.form.fields['captcha'].widgetFactory = NorobotsFieldWidget
+
+                self.form.fields["captcha"].widgetFactory = NorobotsFieldWidget
             else:
-                self.form.fields['captcha'].mode = interfaces.HIDDEN_MODE
+                self.form.fields["captcha"].mode = interfaces.HIDDEN_MODE