Add __all__ to all modules.

The value replicates what is currently documented by Sphinx, which turns out to be everything. It's not clear though if that's all really meant to be consumed publically. Fixes #38
zopefoundation · Sep 26, 2018 · 3d4272f · 3d4272f
1 parent 722d905
commit 3d4272f
Show file tree

Hide file tree

Showing 8 changed files with 84 additions and 2 deletions.
diff --git a/src/zope/configuration/config.py b/src/zope/configuration/config.py
@@ -37,7 +37,36 @@
 from zope.configuration._compat import string_types
 from zope.configuration._compat import text_type
 
-
+__all__ = [
+    'ConfigurationContext',
+    'ConfigurationAdapterRegistry',
+    'ConfigurationMachine',
+    'ConfigurationExecutionError',
+    'IStackItem',
+    'SimpleStackItem',
+    'RootStackItem',
+    'GroupingStackItem',
+    'ComplexStackItem',
+    'GroupingContextDecorator',
+    'DirectiveSchema',
+    'IDirectivesInfo',
+    'IDirectivesContext',
+    'DirectivesHandler',
+    'IDirectiveInfo',
+    'IFullInfo',
+    'IStandaloneDirectiveInfo',
+    'defineSimpleDirective',
+    'defineGroupingDirective',
+    'IComplexDirectiveContext',
+    'ComplexDirectiveDefinition',
+    'subdirective',
+    'IProvidesDirectiveInfo',
+    'provides',
+    'toargs',
+    'expand_action',
+    'resolveConflicts',
+    'ConfigurationConflictError',
+]
 
 zopens = 'http://namespaces.zope.org/zope'
 metans = 'http://namespaces.zope.org/meta'

diff --git a/src/zope/configuration/docutils.py b/src/zope/configuration/docutils.py
@@ -17,6 +17,11 @@
 
 import re
 
+__all__ = [
+    'wrap',
+    'makeDocStructures',
+]
+
 para_sep = re.compile('\n{2,}')
 whitespace = re.compile('[ \t\n\r]+')
 
@@ -27,7 +32,7 @@ def wrap(text, width=78, indent=0):
 
     new_paras = []
     for par in paras:
-        words= filter(None, whitespace.split(par))
+        words = filter(None, whitespace.split(par))
 
         lines = []
         line = []

diff --git a/src/zope/configuration/exceptions.py b/src/zope/configuration/exceptions.py
@@ -14,6 +14,10 @@
 """Standard configuration errors
 """
 
+__all__ = [
+    'ConfigurationError',
+]
+
 class ConfigurationError(Exception):
     """There was an error in a configuration
     """
diff --git a/src/zope/configuration/fields.py b/src/zope/configuration/fields.py
@@ -32,6 +32,16 @@
 from zope.configuration.exceptions import ConfigurationError
 from zope.configuration.interfaces import InvalidToken
 
+__all__ = [
+    'PythonIdentifier',
+    'GlobalObject',
+    'GlobalInterface',
+    'Tokens',
+    'Path',
+    'Bool',
+    'MessageID',
+]
+
 
 class PythonIdentifier(schema_PythonIdentifier):
     """

diff --git a/src/zope/configuration/interfaces.py b/src/zope/configuration/interfaces.py
@@ -17,6 +17,11 @@
 from zope.schema import BytesLine
 from zope.schema.interfaces import ValidationError
 
+__all__ = [
+    'InvalidToken',
+    'IConfigurationContext',
+    'IGroupingContext',
+]
 
 class InvalidToken(ValidationError):
     """Invaid token in list."""

diff --git a/src/zope/configuration/name.py b/src/zope/configuration/name.py
@@ -17,6 +17,12 @@
 import os
 from types import ModuleType
 
+__all__ = [
+    'resolve',
+    'getNormalizedName',
+    'path',
+]
+
 def resolve(name, package='zopeproducts', _silly=('__doc__',), _globals={}):
     name = name.strip()
 

diff --git a/src/zope/configuration/xmlconfig.py b/src/zope/configuration/xmlconfig.py
@@ -45,6 +45,25 @@
 from zope.configuration.zopeconfigure import ZopeConfigure
 from zope.configuration._compat import reraise
 
+__all__ = [
+    'ZopeXMLConfigurationError',
+    'ZopeSAXParseException',
+    'ParserInfo',
+    'ConfigurationHandler',
+    'processxmlfile',
+    'openInOrPlain',
+    'IInclude',
+    'include',
+    'exclude',
+    'includeOverrides',
+    'registerCommonDirectives',
+    'file',
+    'string',
+    'XMLConfig',
+    'xmlconfig',
+    'testxmlconfig',
+]
+
 logger = logging.getLogger("config")
 
 ZCML_NAMESPACE = "http://namespaces.zope.org/zcml"

diff --git a/src/zope/configuration/zopeconfigure.py b/src/zope/configuration/zopeconfigure.py
@@ -108,6 +108,10 @@
 from zope.configuration.config import GroupingContextDecorator
 from zope.configuration.fields import GlobalObject
 
+__all__ = [
+    'IZopeConfigure',
+    'ZopeConfigure',
+]
 
 class IZopeConfigure(Interface):
     """The ``zope:configure`` Directive