Code analysis após pinagem.

Para atender plonegovbr/portalpadrao.release#11 preciso corrigir o code analysis de alguns arquivos.
plonegovbr · Oct 11, 2016 · 9c7b803 · 9c7b803
1 parent f4a613e
commit 9c7b803
Show file tree

Hide file tree

Showing 14 changed files with 189 additions and 131 deletions.
diff --git a/setup.py b/setup.py
@@ -42,6 +42,7 @@
       zip_safe=False,
       install_requires=[
           'Plone >=4.2',
+          'plone.api',
           'collective.z3cform.widgets',
           'raptus.autocompletewidget',
           'rdflib',

diff --git a/src/brasil/gov/vcge/at/extender.py b/src/brasil/gov/vcge/at/extender.py
@@ -6,8 +6,8 @@
 from Products.Archetypes import public as atapi
 from Products.Archetypes.interfaces import IBaseContent
 from raptus.autocompletewidget.widget import AutocompleteMultiSelectionWidget
-from zope.component import adapts
-from zope.interface import implements
+from zope.component import adapter
+from zope.interface import implementer
 
 AcMSW = AutocompleteMultiSelectionWidget
 
@@ -18,17 +18,15 @@ class ExtensionLinesField(ExtensionField, atapi.LinesField):
     """
 
 
+# Este adaptador sera aplicado a todos os tipos baseados em Archetypes
+@adapter(IBaseContent)
+# We use both orderable and browser layer aware sensitive properties
+@implementer(IBrowserLayerAwareExtender)
 class VCGEExtender(object):
     """ Adaptador que extende os tipos de conteudo base do Plone
         com o campo skos (representando o VCGE)
     """
 
-    # Este adaptador sera aplicado a todos os tipos baseados em Archetypes
-    adapts(IBaseContent)
-
-    # We use both orderable and browser layer aware sensitive properties
-    implements(IBrowserLayerAwareExtender)
-
     layer = IVCGEInstalado
 
     fields = [

diff --git a/src/brasil/gov/vcge/browser/viewlets.py b/src/brasil/gov/vcge/browser/viewlets.py
@@ -3,6 +3,7 @@
 from Acquisition import aq_base
 from Acquisition import aq_inner
 from plone.app.layout.viewlets import ViewletBase
+from Products.CMFPlone.utils import safe_hasattr
 from Products.Five.browser.pagetemplatefile import ViewPageTemplateFile
 from urllib import urlencode
 from zope.component import queryUtility
@@ -27,7 +28,7 @@ def skos(self):
         '''
         context = aq_base(aq_inner(self.context))
         uris = []
-        if hasattr(context, 'skos'):
+        if safe_hasattr(context, 'skos'):
             uris = self.context.skos or []
         name = 'brasil.gov.vcge'
         util = queryUtility(IVocabularyFactory, name)
@@ -38,8 +39,10 @@ def skos(self):
             params = urlencode({'skos:list': uri})
             skos.append({'id': uri,
                          'title': title,
-                         'url': '%s/@@search?%s' % (self.nav_root_url,
-                                                    params)})
+                         'url': '{0}/@@search?{1}'.format(
+                             self.nav_root_url,
+                             params
+                         )})
         return skos
 
     def rel(self):

diff --git a/src/brasil/gov/vcge/config.py b/src/brasil/gov/vcge/config.py
@@ -1,7 +1,7 @@
 # -*- coding:utf-8 -*-
 from Products.CMFPlone import interfaces as plone_interfaces
 from Products.CMFQuickInstallerTool import interfaces as qi_interfaces
-from zope.interface import implements
+from zope.interface import implementer
 
 PROJECTNAME = 'brasil.gov.vcge'
 
@@ -10,19 +10,19 @@
 NAMESPACE = 'http://www.w3.org/2004/02/skos/core#'
 
 
+@implementer(qi_interfaces.INonInstallable)
 class HiddenProducts(object):
     """ Oculta produtos do QuickInstaller """
-    implements(qi_interfaces.INonInstallable)
 
     def getNonInstallableProducts(self):
         return [
             'brasil.gov.vcge.upgrades.v2000',
         ]
 
 
+@implementer(plone_interfaces.INonInstallable)
 class HiddenProfiles(object):
     """ Oculta profiles da tela inicial de criacao do site """
-    implements(plone_interfaces.INonInstallable)
 
     def getNonInstallableProfiles(self):
         return [

diff --git a/src/brasil/gov/vcge/contentrules/action.py b/src/brasil/gov/vcge/contentrules/action.py
@@ -7,9 +7,9 @@
 from plone.app.contentrules.browser.formhelper import EditForm
 from plone.contentrules.rule.interfaces import IExecutable
 from plone.contentrules.rule.interfaces import IRuleElementData
-from zope.component import adapts
+from zope.component import adapter
 from zope.formlib import form
-from zope.interface import implements
+from zope.interface import implementer
 from zope.interface import Interface
 from zope.schema import Bool
 from zope.schema import Choice
@@ -41,10 +41,10 @@ class IVCGEAction(Interface):
                value_type=Choice(vocabulary=VOCAB))
 
 
+@implementer(IVCGEAction, IRuleElementData)
 class VCGEAction(SimpleItem):
     """ A implementacao persistente para a acao VCGE
     """
-    implements(IVCGEAction, IRuleElementData)
 
     element = 'brasil.gov.vcge.actions.VCGE'
     same_as_parent = False
@@ -62,12 +62,12 @@ def summary(self):
         return msg
 
 
+@adapter(Interface, IVCGEAction, Interface)
+@implementer(IExecutable)
 class VCGEActionExecutor(object):
     """ O executor para esta acao.
         Este codigo esta registrado como adaptador no configure.zcml
     """
-    implements(IExecutable)
-    adapts(Interface, IVCGEAction, Interface)
 
     def __init__(self, context, element, event):
         self.context = context

diff --git a/src/brasil/gov/vcge/contentrules/condition.py b/src/brasil/gov/vcge/contentrules/condition.py
@@ -7,9 +7,9 @@
 from plone.app.contentrules.browser.formhelper import EditForm
 from plone.contentrules.rule.interfaces import IExecutable
 from plone.contentrules.rule.interfaces import IRuleElementData
-from zope.component import adapts
+from zope.component import adapter
 from zope.formlib import form
-from zope.interface import implements
+from zope.interface import implementer
 from zope.interface import Interface
 from zope.schema import Choice
 from zope.schema import Set
@@ -37,10 +37,10 @@ class IVCGECondition(Interface):
                value_type=Choice(vocabulary=VOCAB))
 
 
+@implementer(IVCGECondition, IRuleElementData)
 class VCGECondition(SimpleItem):
     """ A implementacao persistente para a condicao VCGE
     """
-    implements(IVCGECondition, IRuleElementData)
 
     skos = []
     element = 'brasil.gov.vcge.conditions.VCGE'
@@ -56,12 +56,12 @@ def summary(self):
         return msg
 
 
+@adapter(Interface, IVCGECondition, Interface)
+@implementer(IExecutable)
 class VCGEConditionExecutor(object):
     """ O executor para esta condicao.
         Este codigo esta registrado como adaptador no configure.zcml
     """
-    implements(IExecutable)
-    adapts(Interface, IVCGECondition, Interface)
 
     def __init__(self, context, element, event):
         self.context = context

diff --git a/src/brasil/gov/vcge/contentrules/utils.py b/src/brasil/gov/vcge/contentrules/utils.py
@@ -1,20 +1,21 @@
 # -*- coding:utf-8 -*-
 from Acquisition import aq_base
+from Products.CMFPlone.utils import safe_hasattr
 
 
 def vcge_available(obj):
     """ Valida se o objeto tem o atributo de
         armazenamento do VCGE
     """
-    return hasattr(aq_base(obj), 'skos')
+    return safe_hasattr(aq_base(obj), 'skos')
 
 
 def vcge_for_object(obj):
     """ Retorna valores armazenados no atributo
         VCGE de um objeto
     """
     skos = []
-    if hasattr(aq_base(obj), 'skos'):
+    if safe_hasattr(aq_base(obj), 'skos'):
         skos = obj.skos
     return skos
 
@@ -23,6 +24,6 @@ def set_vcge(obj, skos):
     """ Armazena valores no atributo
         VCGE de um objeto
     """
-    if hasattr(aq_base(obj), 'skos'):
+    if safe_hasattr(aq_base(obj), 'skos'):
         obj.skos = skos
     return True
diff --git a/src/brasil/gov/vcge/dx/widget.py b/src/brasil/gov/vcge/dx/widget.py
@@ -26,56 +26,72 @@ class SkosWidget(widget.SequenceWidget):
     maxResults = 10
     mustMatch = False
     matchContains = True
+
+    # Não é necessário dar "escape" em "{" e "}" aqui uma vez que essas variáveis
+    # são usadas de forma literal como parâmetro do format: só precisamos dar
+    # "escape" quando é a string que será aplicada o format (como o js_template)
     formatItem = 'function(row, idx, count, value) { return row[1]; }'
     formatResult = 'function(row, idx, count) { return ''; }'
+    #
 
+    # Lembre-se de que para conseguir usar { e }  de forma literal nas aberturas
+    # e fechamento de funções do js, você precisa usar {{ e }} respectivamente.
+    # https://docs.python.org/3/library/string.html#formatstrings
     js_template = """\
-    (function($) {
-        $().ready(function() {
-            $('#formfield-form-widgets-IVCGE-skos #%(id)s').each(function() {
-                $('#formfield-form-widgets-IVCGE-skos').append('<input name="%(name)s-input" type="text" id="%(id)s-input" />');
+    (function($) {{
+        $().ready(function() {{
+            $('#formfield-form-widgets-IVCGE-skos #{id}').each(function() {{
+                $('#formfield-form-widgets-IVCGE-skos').append('<input name="{name}-input" type="text" id="{id}-input" />');
                 $(this).remove();
-                $('#formfield-form-widgets-IVCGE-skos #%(id)s-input').autocomplete('%(url)s/@@token-search?f=%(id)s', {
+                $('#formfield-form-widgets-IVCGE-skos #{id}-input').autocomplete('{url}/@@token-search?f={id}', {{
                     autoFill: false,
-                    minChars: %(minChars)d,
-                    max: %(maxResults)d,
-                    mustMatch: %(mustMatch)s,
-                    matchContains: %(matchContains)s,
-                    formatItem: %(formatItem)s,
-                    formatResult: %(formatResult)s
-                }).result(%(js_callback)s);
-            })
-        });
-    })(jQuery);
+                    minChars: {minChars},
+                    max: {maxResults},
+                    mustMatch: {mustMatch},
+                    matchContains: {matchContains},
+                    formatItem: {formatItem},
+                    formatResult: {formatResult}
+                }}).result({js_callback});
+            }})
+        }});
+    }})(jQuery);
     """
 
+    # Lembre-se de que para conseguir usar { e }  de forma literal nas aberturas
+    # e fechamento de funções do js, você precisa usar {{ e }} respectivamente.
+    # https://docs.python.org/3/library/string.html#formatstrings
     js_callback_template = """\
-    function(event, data, formatted) {
+    function(event, data, formatted) {{
         var field = $('#formfield-form-widgets-IVCGE-skos input[type="checkbox"][value="' + data[0] + '"]');
         if(field.length == 0)
-            $('#formfield-form-widgets-IVCGE-skos #%(id)s-input').before("<" + "label class='plain'><" + "input type='checkbox' name='%(name)s' checked='checked' value='" + data[0] + "' /> " + data[1] + "</label><br />");
+            $('#formfield-form-widgets-IVCGE-skos #{id}-input').before("<" + "label class='plain'><" + "input type='checkbox' name='{name}' checked='checked' value='" + data[0] + "' /> " + data[1] + "</label><br />");
         else
-            field.each(function() { this.checked = true });
+            field.each(function() {{ this.checked = true }});
         if(data[0])
-            $('#formfield-form-widgets-IVCGE-skos #%(id)s-input').val('');
-    }
+            $('#formfield-form-widgets-IVCGE-skos #{id}-input').val('');
+    }}
     """
 
     def js(self):
         context = self.context
         form_url = context.absolute_url()
-        js_callback = self.js_callback_template % dict(id=self.id, name=self.name)
-        return self.js_template % dict(
-            id=self.id,
-            name=self.name,
-            url=form_url,
-            minChars=self.minChars,
-            maxResults=self.maxResults,
-            mustMatch=str(self.mustMatch).lower(),
-            matchContains=str(self.matchContains).lower(),
-            formatItem=self.formatItem,
-            formatResult=self.formatResult,
-            js_callback=js_callback,)
+        js_callback = self.js_callback_template.format(
+            **dict(id=self.id, name=self.name)
+        )
+        return self.js_template.format(
+            **dict(
+                id=self.id,
+                name=self.name,
+                url=form_url,
+                minChars=self.minChars,
+                maxResults=self.maxResults,
+                mustMatch=str(self.mustMatch).lower(),
+                matchContains=str(self.matchContains).lower(),
+                formatItem=self.formatItem,
+                formatResult=self.formatResult,
+                js_callback=js_callback,
+            )
+        )
 
     def vocab(self):
         name = 'brasil.gov.vcge'
@@ -164,7 +180,7 @@ def __call__(self):
                    if query in i.title.lower()]
 
         results = sorted(results, key=lambda pair: len(pair[1]))
-        return '\n'.join(['%s|%s' % (value, title)
+        return '\n'.join(['{0}|{1}'.format(value, title)
                           for value, title in results])
 
 
@@ -175,5 +191,5 @@ def __call__(self):
         results = results.split('\n')
         query = self.request.get('q', '')
         for r in results:
-            if r.startswith(u'%s|' % safe_unicode(query)):
+            if r.startswith(u'{0}|'.format(safe_unicode(query))):
                 return r