Skip to content

Commit

Permalink
Linting: Mark API imports as F401, Remove BBB code.
Browse files Browse the repository at this point in the history
  • Loading branch information
janjaapdriessen committed Jun 10, 2020
1 parent 76a89b4 commit ce6d2e6
Show file tree
Hide file tree
Showing 7 changed files with 145 additions and 188 deletions.
272 changes: 137 additions & 135 deletions src/grok/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,141 +13,143 @@
##############################################################################
"""Grok
"""
from zope.component import adapts

from martian import ClassGrokker, InstanceGrokker, GlobalGrokker
from martian import baseclass, ignore
from martian.error import GrokError, GrokImportError

from grokcore.component import Context
from grokcore.component import GlobalUtility
from grokcore.component import Adapter, MultiAdapter, GlobalUtility, Context
from grokcore.component import Subscription, MultiSubscription
from grokcore.component import querySubscriptions, queryMultiSubscriptions
from grokcore.component import queryOrderedSubscriptions
from grokcore.component import queryOrderedMultiSubscriptions

from grokcore.component.decorators import subscribe, adapter, implementer
from grokcore.component import implements

from grokcore.component.directive import context, name, title, description
from grokcore.component.directive import provides, direct
from grokcore.component.directive import global_utility, global_adapter

from grokcore.content import Model, Container, OrderedContainer

from grokcore.security import Permission, Role
from grokcore.security import Public
from grokcore.security import require
from grokcore.security import permissions

from grokcore.view import ContentProvider
from grokcore.view import PageTemplate
from grokcore.view import PageTemplateFile
from grokcore.view import DirectoryResource
from grokcore.view import layer
from grokcore.view import template
from grokcore.view import templatedir
from grokcore.view import skin
from grokcore.view import url
from grokcore.view import path

from grokcore.viewlet import Viewlet
from grokcore.viewlet import ViewletManager
from grokcore.viewlet import view
from grokcore.viewlet import viewletmanager
from grokcore.viewlet import order

from grokcore.formlib import action
from grokcore.formlib import AutoFields
from grokcore.formlib import Fields

from grokcore.layout.interfaces import ILayout
from grokcore.layout import UnauthorizedPage
from grokcore.layout import NotFoundPage
from grokcore.layout import ExceptionPage
from grokcore.layout import layout

from grokcore.annotation import Annotation
from grokcore.annotation import queryAnnotation
from grokcore.annotation import deleteAnnotation
from grokcore.annotation import LazyAnnotation
from grokcore.annotation import LazyAnnotationProperty

from grokcore.site import IApplication
from grokcore.site import IApplicationAddedEvent
from grokcore.site import Application
from grokcore.site import ApplicationAddedEvent
from grokcore.site import getApplication
from grokcore.site import getSite
from grokcore.site import local_utility
from grokcore.site import install_on
from grokcore.site import LocalUtility
from grokcore.site import site
from grokcore.site import Site
from grokcore.site.util import create_application

from zope.event import notify

from zope.lifecycleevent import IObjectCopiedEvent
from zope.lifecycleevent import IObjectCreatedEvent
from zope.lifecycleevent import ObjectCopiedEvent
from zope.lifecycleevent import ObjectCreatedEvent

from zope.app.publication.interfaces import IBeforeTraverseEvent

from zope.publisher.interfaces.browser import IBrowserRequest
from zope.publisher.interfaces.browser import IDefaultBrowserLayer

from zope.container.interfaces import IObjectAddedEvent
from zope.container.interfaces import IObjectMovedEvent
from zope.container.interfaces import IObjectRemovedEvent
from zope.container.contained import ObjectAddedEvent
from zope.container.contained import ObjectMovedEvent
from zope.container.contained import ObjectRemovedEvent

from grokcore.content import IObjectModifiedEvent
from grokcore.content import IContainerModifiedEvent
from grokcore.content import IObjectEditedEvent
from grokcore.content import ObjectModifiedEvent
from grokcore.content import ContainerModifiedEvent
from grokcore.content import ObjectEditedEvent

from grok.components import AddForm
from grok.components import AddFormPage
from grok.components import DisplayForm
from grok.components import DisplayFormPage
from grok.components import EditForm
from grok.components import EditFormPage
from grok.components import ExceptionView
from grok.components import Form
from grok.components import FormPage
from grok.components import Layout
from grok.components import NotFoundView
from grok.components import Page
from grok.components import UnauthorizedView
from grok.components import View

from grok.interfaces import IDatabaseCreatedEvent
from grok.events import DatabaseCreatedEvent

from grokcore.json import JSON
from grokcore.xmlrpc import XMLRPC

from grokcore.catalog import Indexes
from grokcore.catalog import index

from grokcore.traverser import Traverser
from grokcore.traverser import traversable

from grokcore.rest import IRESTLayer
from grokcore.rest import IRESTSkinType
from grokcore.rest import REST
from grokcore.rest import restskin

# BBB These two functions are meant for test fixtures and should be
# imported from grok.testing, not from grok.
from grok.testing import grok, grok_component
from zope.component import adapts # noqa: F401

from martian import ClassGrokker, InstanceGrokker, GlobalGrokker # noqa: F401
from martian import baseclass, ignore # noqa: F401
from martian.error import GrokError, GrokImportError # noqa: F401

from grokcore.component import Context # noqa: F401
from grokcore.component import GlobalUtility # noqa: F401
from grokcore.component import Adapter, MultiAdapter # noqa: F401
from grokcore.component import Subscription, MultiSubscription # noqa: F401
from grokcore.component import querySubscriptions # noqa: F401
from grokcore.component import queryMultiSubscriptions # noqa: F401
from grokcore.component import queryOrderedSubscriptions # noqa: F401
from grokcore.component import queryOrderedMultiSubscriptions # noqa: F401

from grokcore.component.decorators import subscribe # noqa: F401
from grokcore.component.decorators import adapter # noqa: F401
from grokcore.component.decorators import implementer # noqa: F401
from grokcore.component import implements # noqa: F401

from grokcore.component.directive import context, name # noqa: F401
from grokcore.component.directive import title, description # noqa: F401
from grokcore.component.directive import provides, direct # noqa: F401
from grokcore.component.directive import global_utility # noqa: F401
from grokcore.component.directive import global_adapter # noqa: F401

from grokcore.content import Model, Container, OrderedContainer # noqa: F401

from grokcore.security import Permission, Role # noqa: F401
from grokcore.security import Public # noqa: F401
from grokcore.security import require # noqa: F401
from grokcore.security import permissions # noqa: F401

from grokcore.view import ContentProvider # noqa: F401
from grokcore.view import PageTemplate # noqa: F401
from grokcore.view import PageTemplateFile # noqa: F401
from grokcore.view import DirectoryResource # noqa: F401
from grokcore.view import layer # noqa: F401
from grokcore.view import template # noqa: F401
from grokcore.view import templatedir # noqa: F401
from grokcore.view import skin # noqa: F401
from grokcore.view import url # noqa: F401
from grokcore.view import path # noqa: F401

from grokcore.viewlet import Viewlet # noqa: F401
from grokcore.viewlet import ViewletManager # noqa: F401
from grokcore.viewlet import view # noqa: F401
from grokcore.viewlet import viewletmanager # noqa: F401
from grokcore.viewlet import order # noqa: F401

from grokcore.formlib import action # noqa: F401
from grokcore.formlib import AutoFields # noqa: F401
from grokcore.formlib import Fields # noqa: F401

from grokcore.layout.interfaces import ILayout # noqa: F401
from grokcore.layout import UnauthorizedPage # noqa: F401
from grokcore.layout import NotFoundPage # noqa: F401
from grokcore.layout import ExceptionPage # noqa: F401
from grokcore.layout import layout # noqa: F401

from grokcore.annotation import Annotation # noqa: F401
from grokcore.annotation import queryAnnotation # noqa: F401
from grokcore.annotation import deleteAnnotation # noqa: F401
from grokcore.annotation import LazyAnnotation # noqa: F401
from grokcore.annotation import LazyAnnotationProperty # noqa: F401

from grokcore.site import IApplication # noqa: F401
from grokcore.site import IApplicationAddedEvent # noqa: F401
from grokcore.site import Application # noqa: F401
from grokcore.site import ApplicationAddedEvent # noqa: F401
from grokcore.site import getApplication # noqa: F401
from grokcore.site import getSite # noqa: F401
from grokcore.site import local_utility # noqa: F401
from grokcore.site import install_on # noqa: F401
from grokcore.site import LocalUtility # noqa: F401
from grokcore.site import site # noqa: F401
from grokcore.site import Site # noqa: F401
from grokcore.site.util import create_application # noqa: F401

from zope.event import notify # noqa: F401

from zope.lifecycleevent import IObjectCopiedEvent # noqa: F401
from zope.lifecycleevent import IObjectCreatedEvent # noqa: F401
from zope.lifecycleevent import ObjectCopiedEvent # noqa: F401
from zope.lifecycleevent import ObjectCreatedEvent # noqa: F401

from zope.app.publication.interfaces import IBeforeTraverseEvent # noqa: F401

from zope.publisher.interfaces.browser import IBrowserRequest # noqa: F401
from zope.publisher.interfaces.browser import \
IDefaultBrowserLayer # noqa: F401

from zope.container.interfaces import IObjectAddedEvent # noqa: F401
from zope.container.interfaces import IObjectMovedEvent # noqa: F401
from zope.container.interfaces import IObjectRemovedEvent # noqa: F401
from zope.container.contained import ObjectAddedEvent # noqa: F401
from zope.container.contained import ObjectMovedEvent # noqa: F401
from zope.container.contained import ObjectRemovedEvent # noqa: F401

from grokcore.content import IObjectModifiedEvent # noqa: F401
from grokcore.content import IContainerModifiedEvent # noqa: F401
from grokcore.content import IObjectEditedEvent # noqa: F401
from grokcore.content import ObjectModifiedEvent # noqa: F401
from grokcore.content import ContainerModifiedEvent # noqa: F401
from grokcore.content import ObjectEditedEvent # noqa: F401

from grok.components import AddForm # noqa: F401
from grok.components import AddFormPage # noqa: F401
from grok.components import DisplayForm # noqa: F401
from grok.components import DisplayFormPage # noqa: F401
from grok.components import EditForm # noqa: F401
from grok.components import EditFormPage # noqa: F401
from grok.components import ExceptionView # noqa: F401
from grok.components import Form # noqa: F401
from grok.components import FormPage # noqa: F401
from grok.components import Layout # noqa: F401
from grok.components import NotFoundView # noqa: F401
from grok.components import Page # noqa: F401
from grok.components import UnauthorizedView # noqa: F401
from grok.components import View # noqa: F401

from grok.interfaces import IDatabaseCreatedEvent # noqa: F401
from grok.events import DatabaseCreatedEvent # noqa: F401

from grokcore.json import JSON # noqa: F401
from grokcore.xmlrpc import XMLRPC # noqa: F401

from grokcore.catalog import Indexes # noqa: F401
from grokcore.catalog import index # noqa: F401

from grokcore.traverser import Traverser # noqa: F401
from grokcore.traverser import traversable # noqa: F401

from grokcore.rest import IRESTLayer # noqa: F401
from grokcore.rest import IRESTSkinType # noqa: F401
from grokcore.rest import REST # noqa: F401
from grokcore.rest import restskin # noqa: F401

# Our __init__ provides the grok API directly so using 'import grok' is enough.
from grok.interfaces import IGrokAPI
Expand Down
16 changes: 0 additions & 16 deletions src/grok/components.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,21 +22,13 @@
import zope.location
import zope.errorview.browser
import zope.component
from zope.container.interfaces import IReadContainer
from zope import component
from zope import interface
from zope.interface.common.interfaces import IException
from zope.publisher.browser import BrowserPage
from zope.publisher.defaultview import getDefaultViewName
from zope.publisher.interfaces.browser import IBrowserPublisher
from zope.publisher.interfaces.http import IHTTPRequest
from zope.publisher.interfaces import INotFound
from zope.publisher.interfaces import NotFound
from zope.publisher.publish import mapply
from zope.security.interfaces import IUnauthorized

import grok
import martian.util

import grokcore.view
import grokcore.site
Expand All @@ -45,14 +37,6 @@
import grokcore.layout.components
from grok import interfaces, util

# BBB this is for import backward compatibility.
from grokcore.xmlrpc import XMLRPC
from grokcore.rest import REST
from grokcore.json import JSON
from grokcore.content import Container
from grokcore.content import Model
from grokcore.content import OrderedContainer
from grokcore.site import Application
from grokcore.view.util import ASIS


Expand Down
1 change: 0 additions & 1 deletion src/grok/events.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
"""
from zope.interface import implementer
from zope.interface.interfaces import ObjectEvent
from grokcore.site.interfaces import ApplicationAddedEvent # BBB
from grok.interfaces import IDatabaseCreatedEvent


Expand Down
2 changes: 1 addition & 1 deletion src/grok/ftests/errorviews/errorviews.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
>>> class MyExceptionView(ExceptionView):
... def render(self):
... return u'This is my idea of an exception view.'
>>> from grok.testing import grok_component
>>> from grokcore.component.testing import grok_component
>>> grok_component('MyExceptionView', MyExceptionView)
True
Expand Down
33 changes: 3 additions & 30 deletions src/grok/interfaces.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,9 @@
from grokcore.component.interfaces import IContext
from grokcore.component.interfaces import IGrokErrors

from grokcore.rest.interfaces import IREST, IRESTSkinType, IRESTLayer
from grokcore.rest.interfaces import IREST # noqa: F401
from grokcore.rest.interfaces import IRESTSkinType # noqa: F401
from grokcore.rest.interfaces import IRESTLayer # noqa: F401


class IGrokBaseClasses(
Expand Down Expand Up @@ -132,35 +134,6 @@ class IGrokAPI(
IGrokErrors,
IGrokEvents):

# BBB this is deprecated
def grok(dotted_name):
"""Grok a module or package specified by ``dotted_name``.
NOTE: This function will be removed from the public Grok
public API. For tests and interpreter sessions, use
grok.testing.grok().
"""

# BBB this is deprecated
def grok_component(name, component, context=None, module_info=None,
templates=None):
"""Grok an arbitrary object. Can be useful during testing.
name - the name of the component (class name, or global instance name
as it would appear in a module).
component - the object (class, etc) to grok.
context - the context object (optional).
module_info - the module being grokked (optional).
templates - the templates registry (optional).
Note that context, module_info and templates might be required
for some grokkers which rely on them.
NOTE: This function will be removed from the public Grok
public API. For tests and interpreter sessions, use
grok.testing.grok_component().
"""

def notify(event):
"""Send ``event`` to event subscribers."""

Expand Down
2 changes: 0 additions & 2 deletions src/grok/testing.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@
import sys
from zope.configuration.config import ConfigurationMachine
from grokcore.component import zcml
# Provide this import here for BBB reasons:
from grokcore.component.testing import grok_component


def grok(module_name=None):
Expand Down
Loading

0 comments on commit ce6d2e6

Please sign in to comment.