From cdcd446d8c685164eb48c672fdf1647fa2f16688 Mon Sep 17 00:00:00 2001 From: Lukasz Plonka Date: Mon, 28 Oct 2024 14:47:42 +0100 Subject: [PATCH 1/3] feat: allow setting model need_reload in constructors --- .../rest_handler/endpoint/__init__.py | 45 ++++++++++++++----- 1 file changed, 35 insertions(+), 10 deletions(-) diff --git a/splunktaucclib/rest_handler/endpoint/__init__.py b/splunktaucclib/rest_handler/endpoint/__init__.py index dc8e5dd..b4dfccc 100644 --- a/splunktaucclib/rest_handler/endpoint/__init__.py +++ b/splunktaucclib/rest_handler/endpoint/__init__.py @@ -49,7 +49,7 @@ class RestEndpoint: REST Endpoint. """ - def __init__(self, user="nobody", app=None, *args, **kwargs): + def __init__(self, user="nobody", app=None, need_reload=False, *args, **kwargs): """ :param user: @@ -63,7 +63,7 @@ def __init__(self, user="nobody", app=None, *args, **kwargs): self.kwargs = kwargs # If reload is needed while GET request - self.need_reload = False + self.need_reload = need_reload @property def internal_endpoint(self): @@ -110,7 +110,16 @@ class SingleModel(RestEndpoint): with same format into one conf file. """ - def __init__(self, conf_name, model, user="nobody", app=None, *args, **kwargs): + def __init__( + self, + conf_name, + model, + user="nobody", + app=None, + need_reload=True, + *args, + **kwargs, + ): """ :param conf_name: conf file name @@ -119,8 +128,7 @@ def __init__(self, conf_name, model, user="nobody", app=None, *args, **kwargs): :param args: :param kwargs: """ - super().__init__(user=user, app=app, *args, **kwargs) - self.need_reload = True + super().__init__(user=user, app=app, need_reload=need_reload, *args, **kwargs) self._model = model self.conf_name = conf_name @@ -140,7 +148,16 @@ class MultipleModel(RestEndpoint): stanzas with different formats into one conf file. """ - def __init__(self, conf_name, models, user="nobody", app=None, *args, **kwargs): + def __init__( + self, + conf_name, + models, + user="nobody", + app=None, + need_reload=True, + *args, + **kwargs, + ): """ :param conf_name: @@ -150,8 +167,7 @@ def __init__(self, conf_name, models, user="nobody", app=None, *args, **kwargs): :param args: :param kwargs: """ - super().__init__(user=user, app=app, *args, **kwargs) - self.need_reload = True + super().__init__(user=user, app=app, need_reload=need_reload, *args, **kwargs) self.conf_name = conf_name self.models = {model.name: model for model in models} @@ -172,8 +188,17 @@ class DataInputModel(RestEndpoint): REST Model for Data Input. """ - def __init__(self, input_type, model, user="nobody", app=None, *args, **kwargs): - super().__init__(user=user, app=app, *args, **kwargs) + def __init__( + self, + input_type, + model, + user="nobody", + app=None, + need_reload=False, + *args, + **kwargs, + ): + super().__init__(user=user, app=app, need_reload=need_reload, *args, **kwargs) self.input_type = input_type self._model = model From 3df462c52e1c9f8f0b730af5d8761272e142d785 Mon Sep 17 00:00:00 2001 From: Lukasz Plonka Date: Mon, 28 Oct 2024 14:52:15 +0100 Subject: [PATCH 2/3] chore: add annotations --- .../rest_handler/endpoint/__init__.py | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/splunktaucclib/rest_handler/endpoint/__init__.py b/splunktaucclib/rest_handler/endpoint/__init__.py index b4dfccc..58ecf0d 100644 --- a/splunktaucclib/rest_handler/endpoint/__init__.py +++ b/splunktaucclib/rest_handler/endpoint/__init__.py @@ -51,9 +51,9 @@ class RestEndpoint: def __init__(self, user="nobody", app=None, need_reload=False, *args, **kwargs): """ - :param user: :param app: if None, it will be base app name + :param need_reload: if reload is needed while GET request :param args: :param kwargs: """ @@ -62,7 +62,7 @@ def __init__(self, user="nobody", app=None, need_reload=False, *args, **kwargs): self.args = args self.kwargs = kwargs - # If reload is needed while GET request + # self.need_reload = need_reload @property @@ -121,10 +121,10 @@ def __init__( **kwargs, ): """ - :param conf_name: conf file name :param model: REST model :type model: RestModel + :param need_reload: if reload is needed while GET request :param args: :param kwargs: """ @@ -159,11 +159,11 @@ def __init__( **kwargs, ): """ - :param conf_name: :type conf_name: str :param models: list of RestModel :type models: list + :param need_reload: if reload is needed while GET request :param args: :param kwargs: """ @@ -198,6 +198,15 @@ def __init__( *args, **kwargs, ): + """ + :param input_type: + :param model: + :param user: + :param app: if None, it will be base app name + :param need_reload: if reload is needed while GET request + :param args: + :param kwargs: + """ super().__init__(user=user, app=app, need_reload=need_reload, *args, **kwargs) self.input_type = input_type From 9a167b4de02c3409461e7ccec9a4fe001833b0b4 Mon Sep 17 00:00:00 2001 From: Lukasz Plonka Date: Mon, 28 Oct 2024 14:56:44 +0100 Subject: [PATCH 3/3] chore: remove empty comment --- splunktaucclib/rest_handler/endpoint/__init__.py | 1 - 1 file changed, 1 deletion(-) diff --git a/splunktaucclib/rest_handler/endpoint/__init__.py b/splunktaucclib/rest_handler/endpoint/__init__.py index 58ecf0d..1ca3337 100644 --- a/splunktaucclib/rest_handler/endpoint/__init__.py +++ b/splunktaucclib/rest_handler/endpoint/__init__.py @@ -62,7 +62,6 @@ def __init__(self, user="nobody", app=None, need_reload=False, *args, **kwargs): self.args = args self.kwargs = kwargs - # self.need_reload = need_reload @property