From eb77abd77a25baa556de4df527404b907748d3c6 Mon Sep 17 00:00:00 2001 From: Dolph Mathews Date: Thu, 1 Oct 2015 16:56:33 +0000 Subject: [PATCH] Make __all__ immutable Using a mutable type implies that it's acceptable for the set of publicly-accessible attributes to be mutated at runtime, which defeats their intended purpose of documenting the public interface. Tuples are immutable. Change-Id: Ib3ab93224ba240040b08ece481ef5ba620c3f658 --- keystoneclient/__init__.py | 4 ++-- keystoneclient/apiclient/__init__.py | 4 ++-- keystoneclient/auth/__init__.py | 4 ++-- keystoneclient/auth/identity/__init__.py | 4 ++-- keystoneclient/auth/identity/generic/__init__.py | 4 ++-- keystoneclient/auth/identity/v3/__init__.py | 4 ++-- keystoneclient/auth/identity/v3/base.py | 2 +- keystoneclient/auth/identity/v3/federated.py | 2 +- keystoneclient/auth/identity/v3/password.py | 2 +- keystoneclient/auth/identity/v3/token.py | 2 +- keystoneclient/fixture/__init__.py | 4 ++-- keystoneclient/fixture/discovery.py | 4 ++-- keystoneclient/generic/__init__.py | 4 ++-- keystoneclient/v2_0/__init__.py | 4 ++-- keystoneclient/v3/__init__.py | 4 ++-- keystoneclient/v3/contrib/__init__.py | 3 +-- 16 files changed, 27 insertions(+), 28 deletions(-) diff --git a/keystoneclient/__init__.py b/keystoneclient/__init__.py index 96f32ab71..ee848db74 100644 --- a/keystoneclient/__init__.py +++ b/keystoneclient/__init__.py @@ -34,7 +34,7 @@ import pbr.version __version__ = pbr.version.VersionInfo('python-keystoneclient').version_string() -__all__ = [ +__all__ = ( # Modules 'generic', 'v2_0', @@ -46,7 +46,7 @@ __all__ = [ 'exceptions', 'httpclient', 'service_catalog', -] +) class _LazyImporter(object): diff --git a/keystoneclient/apiclient/__init__.py b/keystoneclient/apiclient/__init__.py index 29b9331ea..cda401aa2 100644 --- a/keystoneclient/apiclient/__init__.py +++ b/keystoneclient/apiclient/__init__.py @@ -36,6 +36,6 @@ removals.removed_module('keystoneclient.apiclient', version='0.7.1', removal_version='2.0') -__all__ = [ +__all__ = ( 'exceptions', -] +) diff --git a/keystoneclient/auth/__init__.py b/keystoneclient/auth/__init__.py index 3b761c29b..eeae768fa 100644 --- a/keystoneclient/auth/__init__.py +++ b/keystoneclient/auth/__init__.py @@ -16,7 +16,7 @@ from keystoneclient.auth.cli import * # noqa from keystoneclient.auth.conf import * # noqa -__all__ = [ +__all__ = ( # auth.base 'AUTH_INTERFACE', 'BaseAuthPlugin', @@ -35,4 +35,4 @@ __all__ = [ 'get_plugin_options', 'load_from_conf_options', 'register_conf_options', -] +) diff --git a/keystoneclient/auth/identity/__init__.py b/keystoneclient/auth/identity/__init__.py index d2aca8f9d..8146c1e58 100644 --- a/keystoneclient/auth/identity/__init__.py +++ b/keystoneclient/auth/identity/__init__.py @@ -28,10 +28,10 @@ Password = generic.Password Token = generic.Token -__all__ = ['BaseIdentityPlugin', +__all__ = ('BaseIdentityPlugin', 'Password', 'Token', 'V2Password', 'V2Token', 'V3Password', - 'V3Token'] + 'V3Token') diff --git a/keystoneclient/auth/identity/generic/__init__.py b/keystoneclient/auth/identity/generic/__init__.py index b24c3d642..a96fb9791 100644 --- a/keystoneclient/auth/identity/generic/__init__.py +++ b/keystoneclient/auth/identity/generic/__init__.py @@ -15,7 +15,7 @@ from keystoneclient.auth.identity.generic.password import Password # noqa from keystoneclient.auth.identity.generic.token import Token # noqa -__all__ = ['BaseGenericPlugin', +__all__ = ('BaseGenericPlugin', 'Password', 'Token', - ] + ) diff --git a/keystoneclient/auth/identity/v3/__init__.py b/keystoneclient/auth/identity/v3/__init__.py index a08f3eccc..f25bf5e22 100644 --- a/keystoneclient/auth/identity/v3/__init__.py +++ b/keystoneclient/auth/identity/v3/__init__.py @@ -16,7 +16,7 @@ from keystoneclient.auth.identity.v3.password import * # noqa from keystoneclient.auth.identity.v3.token import * # noqa -__all__ = ['Auth', +__all__ = ('Auth', 'AuthConstructor', 'AuthMethod', 'BaseAuth', @@ -27,4 +27,4 @@ __all__ = ['Auth', 'PasswordMethod', 'Token', - 'TokenMethod'] + 'TokenMethod') diff --git a/keystoneclient/auth/identity/v3/base.py b/keystoneclient/auth/identity/v3/base.py index 31cab8bc4..b8234a386 100644 --- a/keystoneclient/auth/identity/v3/base.py +++ b/keystoneclient/auth/identity/v3/base.py @@ -24,7 +24,7 @@ from keystoneclient import utils _logger = logging.getLogger(__name__) -__all__ = ['Auth', 'AuthMethod', 'AuthConstructor', 'BaseAuth'] +__all__ = ('Auth', 'AuthMethod', 'AuthConstructor', 'BaseAuth') @six.add_metaclass(abc.ABCMeta) diff --git a/keystoneclient/auth/identity/v3/federated.py b/keystoneclient/auth/identity/v3/federated.py index f6416eb87..18c6d6766 100644 --- a/keystoneclient/auth/identity/v3/federated.py +++ b/keystoneclient/auth/identity/v3/federated.py @@ -18,7 +18,7 @@ import six from keystoneclient.auth.identity.v3 import base from keystoneclient.auth.identity.v3 import token -__all__ = ['FederatedBaseAuth'] +__all__ = ('FederatedBaseAuth',) @six.add_metaclass(abc.ABCMeta) diff --git a/keystoneclient/auth/identity/v3/password.py b/keystoneclient/auth/identity/v3/password.py index d9cfa4a14..1184e802a 100644 --- a/keystoneclient/auth/identity/v3/password.py +++ b/keystoneclient/auth/identity/v3/password.py @@ -16,7 +16,7 @@ from keystoneclient.auth.identity.v3 import base from keystoneclient import utils -__all__ = ['PasswordMethod', 'Password'] +__all__ = ('PasswordMethod', 'Password') class PasswordMethod(base.AuthMethod): diff --git a/keystoneclient/auth/identity/v3/token.py b/keystoneclient/auth/identity/v3/token.py index d92d3fcce..396a11a20 100644 --- a/keystoneclient/auth/identity/v3/token.py +++ b/keystoneclient/auth/identity/v3/token.py @@ -15,7 +15,7 @@ from oslo_config import cfg from keystoneclient.auth.identity.v3 import base -__all__ = ['TokenMethod', 'Token'] +__all__ = ('TokenMethod', 'Token') class TokenMethod(base.AuthMethod): diff --git a/keystoneclient/fixture/__init__.py b/keystoneclient/fixture/__init__.py index 8ddb43acc..9e4de4b64 100644 --- a/keystoneclient/fixture/__init__.py +++ b/keystoneclient/fixture/__init__.py @@ -32,11 +32,11 @@ V2Token = v2.Token V3Token = v3.Token V3FederationToken = v3.V3FederationToken -__all__ = ['DiscoveryList', +__all__ = ('DiscoveryList', 'FixtureValidationError', 'V2Discovery', 'V3Discovery', 'V2Token', 'V3Token', 'V3FederationToken', - ] + ) diff --git a/keystoneclient/fixture/discovery.py b/keystoneclient/fixture/discovery.py index 50a6bce7f..d596e2dd4 100644 --- a/keystoneclient/fixture/discovery.py +++ b/keystoneclient/fixture/discovery.py @@ -16,10 +16,10 @@ from oslo_utils import timeutils from keystoneclient import utils -__all__ = ['DiscoveryList', +__all__ = ('DiscoveryList', 'V2Discovery', 'V3Discovery', - ] + ) _DEFAULT_DAYS_AGO = 30 diff --git a/keystoneclient/generic/__init__.py b/keystoneclient/generic/__init__.py index ed59d727c..745692105 100644 --- a/keystoneclient/generic/__init__.py +++ b/keystoneclient/generic/__init__.py @@ -1,4 +1,4 @@ -__all__ = [ +__all__ = ( 'client', -] +) diff --git a/keystoneclient/v2_0/__init__.py b/keystoneclient/v2_0/__init__.py index 30407e0c6..23382fea1 100644 --- a/keystoneclient/v2_0/__init__.py +++ b/keystoneclient/v2_0/__init__.py @@ -1,6 +1,6 @@ from keystoneclient.v2_0.client import Client # noqa -__all__ = [ +__all__ = ( 'client', -] +) diff --git a/keystoneclient/v3/__init__.py b/keystoneclient/v3/__init__.py index 56b26d3b4..fcb00e066 100644 --- a/keystoneclient/v3/__init__.py +++ b/keystoneclient/v3/__init__.py @@ -2,6 +2,6 @@ from keystoneclient.v3.client import Client # noqa -__all__ = [ +__all__ = ( 'client', -] +) diff --git a/keystoneclient/v3/contrib/__init__.py b/keystoneclient/v3/contrib/__init__.py index 79b89d1a0..576bd6218 100644 --- a/keystoneclient/v3/contrib/__init__.py +++ b/keystoneclient/v3/contrib/__init__.py @@ -1,3 +1,2 @@ -__all__ = [ -] +__all__ = tuple()