diff options
author | Jason Madden <jamadden@gmail.com> | 2018-09-26 15:56:28 -0500 |
---|---|---|
committer | Jason Madden <jamadden@gmail.com> | 2018-09-26 15:56:28 -0500 |
commit | 3d4272fb1dbbf6ce9f3e0d865bdfe4ec22e2f110 (patch) | |
tree | 199f646824c05e9a1ee1d20b0755d0b6eb120ecb | |
parent | 722d905d52436799f10e5781f56d2e2628703a63 (diff) | |
download | zope-configuration-issue38.tar.gz |
Add __all__ to all modules.issue38
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
-rw-r--r-- | src/zope/configuration/config.py | 31 | ||||
-rw-r--r-- | src/zope/configuration/docutils.py | 7 | ||||
-rw-r--r-- | src/zope/configuration/exceptions.py | 4 | ||||
-rw-r--r-- | src/zope/configuration/fields.py | 10 | ||||
-rw-r--r-- | src/zope/configuration/interfaces.py | 5 | ||||
-rw-r--r-- | src/zope/configuration/name.py | 6 | ||||
-rw-r--r-- | src/zope/configuration/xmlconfig.py | 19 | ||||
-rw-r--r-- | src/zope/configuration/zopeconfigure.py | 4 |
8 files changed, 84 insertions, 2 deletions
diff --git a/src/zope/configuration/config.py b/src/zope/configuration/config.py index 265a528..a768021 100644 --- a/src/zope/configuration/config.py +++ b/src/zope/configuration/config.py @@ -37,7 +37,36 @@ from zope.configuration._compat import reraise 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 index b6e54a7..c2386c2 100644 --- a/src/zope/configuration/docutils.py +++ b/src/zope/configuration/docutils.py @@ -17,6 +17,11 @@ __docformat__ = 'restructuredtext' 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 index 1ade42a..dce50a7 100644 --- 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 index 70527a5..5c90ed2 100644 --- a/src/zope/configuration/fields.py +++ b/src/zope/configuration/fields.py @@ -32,6 +32,16 @@ from zope.schema.interfaces import InvalidValue 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 index 573e929..45e5ac6 100644 --- a/src/zope/configuration/interfaces.py +++ b/src/zope/configuration/interfaces.py @@ -17,6 +17,11 @@ from zope.interface import Interface 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 index da041cc..a162ea1 100644 --- 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 index a91cbd6..18a2bbe 100644 --- a/src/zope/configuration/xmlconfig.py +++ b/src/zope/configuration/xmlconfig.py @@ -45,6 +45,25 @@ from zope.configuration.zopeconfigure import IZopeConfigure 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 index 0d5f77b..0f8077d 100644 --- a/src/zope/configuration/zopeconfigure.py +++ b/src/zope/configuration/zopeconfigure.py @@ -108,6 +108,10 @@ from zope.schema import BytesLine from zope.configuration.config import GroupingContextDecorator from zope.configuration.fields import GlobalObject +__all__ = [ + 'IZopeConfigure', + 'ZopeConfigure', +] class IZopeConfigure(Interface): """The ``zope:configure`` Directive |