From 5fda35c89d742a058b87418f7120f5688d1c53ac Mon Sep 17 00:00:00 2001 From: Chris Hill-Scott Date: Mon, 12 Sep 2016 12:14:57 +0100 Subject: [PATCH] Make it clear that client do not use `__init__` MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The clients never get passed useful values to their `__init__` methods. Rather the real values are passed through later using the `init_app` method. So it should be an error if the client is relying on the values that get passed to it’s init method. Easiest way to ensure this is by making the `__init__` method not expect any arguments and passing fake values to the `Super` call. --- app/notify_client/api_key_api_client.py | 6 ++---- app/notify_client/events_api_client.py | 6 ++---- app/notify_client/invite_api_client.py | 6 ++---- app/notify_client/job_api_client.py | 6 ++---- app/notify_client/notification_api_client.py | 6 ++---- app/notify_client/organisations_client.py | 8 ++------ app/notify_client/provider_client.py | 8 ++------ app/notify_client/service_api_client.py | 4 +--- app/notify_client/status_api_client.py | 6 ++---- app/notify_client/template_statistics_api_client.py | 6 ++---- app/notify_client/user_api_client.py | 6 ++---- 11 files changed, 21 insertions(+), 47 deletions(-) diff --git a/app/notify_client/api_key_api_client.py b/app/notify_client/api_key_api_client.py index a42ec633e..ba3d4e8e5 100644 --- a/app/notify_client/api_key_api_client.py +++ b/app/notify_client/api_key_api_client.py @@ -9,10 +9,8 @@ KEY_TYPE_TEST = 'test' class ApiKeyApiClient(BaseAPIClient): - def __init__(self, base_url=None, service_id=None, api_key=None): - super(self.__class__, self).__init__(base_url=base_url or 'base_url', - service_id=service_id or 'service_id', - api_key=api_key or 'api_key') + def __init__(self): + super(self.__class__, self).__init__("a", "b", "c") def init_app(self, app): self.base_url = app.config['API_HOST_NAME'] diff --git a/app/notify_client/events_api_client.py b/app/notify_client/events_api_client.py index 2a043ebc6..263b75ebf 100644 --- a/app/notify_client/events_api_client.py +++ b/app/notify_client/events_api_client.py @@ -2,10 +2,8 @@ from notifications_python_client.base import BaseAPIClient class EventsApiClient(BaseAPIClient): - def __init__(self, base_url=None, service_id=None, api_key=None): - super(self.__class__, self).__init__(base_url=base_url or 'base_url', - service_id=service_id or 'service_id', - api_key=api_key or 'api_key') + def __init__(self): + super(self.__class__, self).__init__("a", "b", "c") def init_app(self, app): self.base_url = app.config['API_HOST_NAME'] diff --git a/app/notify_client/invite_api_client.py b/app/notify_client/invite_api_client.py index 47f495d54..82d13f4c9 100644 --- a/app/notify_client/invite_api_client.py +++ b/app/notify_client/invite_api_client.py @@ -6,10 +6,8 @@ from app.notify_client.models import InvitedUser class InviteApiClient(BaseAPIClient): - def __init__(self, base_url=None, service_id=None, api_key=None): - super(self.__class__, self).__init__(base_url=base_url or 'base_url', - service_id=service_id or 'service_id', - api_key=api_key or 'api_key') + def __init__(self): + super(self.__class__, self).__init__("a", "b", "c") def init_app(self, app): self.base_url = app.config['API_HOST_NAME'] diff --git a/app/notify_client/job_api_client.py b/app/notify_client/job_api_client.py index 68d754a4f..3e239b9f3 100644 --- a/app/notify_client/job_api_client.py +++ b/app/notify_client/job_api_client.py @@ -5,10 +5,8 @@ from app.notify_client import _attach_current_user class JobApiClient(BaseAPIClient): - def __init__(self, base_url=None, service_id=None, api_key=None): - super(self.__class__, self).__init__(base_url=base_url or 'base_url', - service_id=service_id or 'service_id', - api_key=api_key or 'api_key') + def __init__(self): + super(self.__class__, self).__init__("a", "b", "c") def init_app(self, app): self.base_url = app.config['API_HOST_NAME'] diff --git a/app/notify_client/notification_api_client.py b/app/notify_client/notification_api_client.py index 3b42f10e3..c4a671b1e 100644 --- a/app/notify_client/notification_api_client.py +++ b/app/notify_client/notification_api_client.py @@ -2,10 +2,8 @@ from notifications_python_client.base import BaseAPIClient class NotificationApiClient(BaseAPIClient): - def __init__(self, base_url=None, service_id=None, api_key=None): - super(self.__class__, self).__init__(base_url=base_url or 'base_url', - service_id=service_id or 'service_id', - api_key=api_key or 'api_key') + def __init__(self): + super(self.__class__, self).__init__("a", "b", "c") def init_app(self, app): self.base_url = app.config['API_HOST_NAME'] diff --git a/app/notify_client/organisations_client.py b/app/notify_client/organisations_client.py index dbd075852..3c8bdddc0 100644 --- a/app/notify_client/organisations_client.py +++ b/app/notify_client/organisations_client.py @@ -3,12 +3,8 @@ from notifications_python_client.base import BaseAPIClient class OrganisationsClient(BaseAPIClient): - def __init__(self, base_url=None, service_id=None, api_key=None): - super(self.__class__, self).__init__( - base_url=base_url or 'base_url', - service_id=service_id or 'service_id', - api_key=api_key or 'api_key' - ) + def __init__(self): + super(self.__class__, self).__init__("a", "b", "c") def init_app(self, app): self.base_url = app.config['API_HOST_NAME'] diff --git a/app/notify_client/provider_client.py b/app/notify_client/provider_client.py index 09e9bae8c..6421f89c5 100644 --- a/app/notify_client/provider_client.py +++ b/app/notify_client/provider_client.py @@ -3,12 +3,8 @@ from app.notify_client import _attach_current_user class ProviderClient(BaseAPIClient): - def __init__(self, base_url=None, service_id=None, api_key=None): - super(self.__class__, self).__init__( - base_url=base_url or 'base_url', - service_id=service_id or 'service_id', - api_key=api_key or 'api_key' - ) + def __init__(self): + super(self.__class__, self).__init__("a", "b", "c") def init_app(self, app): self.base_url = app.config['API_HOST_NAME'] diff --git a/app/notify_client/service_api_client.py b/app/notify_client/service_api_client.py index 4da0a6872..99f5df982 100644 --- a/app/notify_client/service_api_client.py +++ b/app/notify_client/service_api_client.py @@ -9,9 +9,7 @@ class ServiceAPIClient(NotificationsAPIClient): # Fudge assert in the super __init__ so # we can set those variables later. def __init__(self): - super(ServiceAPIClient, self).__init__("api_url", - "client", - "api_key") + super(self.__class__, self).__init__("a", "b", "c") def init_app(self, application): self.base_url = application.config['API_HOST_NAME'] diff --git a/app/notify_client/status_api_client.py b/app/notify_client/status_api_client.py index de2ff428e..79ee90004 100644 --- a/app/notify_client/status_api_client.py +++ b/app/notify_client/status_api_client.py @@ -2,10 +2,8 @@ from notifications_python_client.base import BaseAPIClient class StatusApiClient(BaseAPIClient): - def __init__(self, base_url=None, service_id=None, api_key=None): - super(self.__class__, self).__init__(base_url=base_url or 'base_url', - service_id=service_id or 'service_id', - api_key=api_key or 'api_key') + def __init__(self): + super(self.__class__, self).__init__("a", "b", "c") def init_app(self, app): self.base_url = app.config['API_HOST_NAME'] diff --git a/app/notify_client/template_statistics_api_client.py b/app/notify_client/template_statistics_api_client.py index 153854e34..2b58571e8 100644 --- a/app/notify_client/template_statistics_api_client.py +++ b/app/notify_client/template_statistics_api_client.py @@ -2,10 +2,8 @@ from notifications_python_client.base import BaseAPIClient class TemplateStatisticsApiClient(BaseAPIClient): - def __init__(self, base_url=None, service_id=None, api_key=None): - super(self.__class__, self).__init__(base_url=base_url or 'base_url', - service_id=service_id or 'service_id', - api_key=api_key or 'api_key') + def __init__(self): + super(self.__class__, self).__init__("a", "b", "c") def init_app(self, app): self.base_url = app.config['API_HOST_NAME'] diff --git a/app/notify_client/user_api_client.py b/app/notify_client/user_api_client.py index 8b89f483f..ad176d3b3 100644 --- a/app/notify_client/user_api_client.py +++ b/app/notify_client/user_api_client.py @@ -5,10 +5,8 @@ from app.notify_client.models import User class UserApiClient(BaseAPIClient): - def __init__(self, base_url=None, service_id=None, api_key=None): - super(self.__class__, self).__init__(base_url=base_url or 'base_url', - service_id=service_id or 'service_id', - api_key=api_key or 'api_key') + def __init__(self): + super(self.__class__, self).__init__("a", "b", "c") def init_app(self, app): self.base_url = app.config['API_HOST_NAME']