From c7e685d2506a04ddd633909cfa732c3542c4c5ec Mon Sep 17 00:00:00 2001 From: asankov Date: Sat, 23 Nov 2019 16:23:15 +0200 Subject: [PATCH] Rename other RPC-related classes. Refs #682 - `XMLRPCCheckboxInput` -> `CheckboxInput` - `XMLRPCSerializer` -> `Serializer` --- tcms/core/models/__init__.py | 6 +++--- tcms/rpc/api/forms/testplan.py | 4 ++-- tcms/rpc/api/testexecution.py | 4 ++-- tcms/rpc/api/user.py | 4 ++-- tcms/rpc/forms.py | 2 +- tcms/rpc/serializer.py | 8 ++++---- tcms/rpc/tests/test_serializer.py | 4 ++-- 7 files changed, 16 insertions(+), 16 deletions(-) diff --git a/tcms/core/models/__init__.py b/tcms/core/models/__init__.py index 611d82e98f..d9539a76f9 100644 --- a/tcms/core/models/__init__.py +++ b/tcms/core/models/__init__.py @@ -4,7 +4,7 @@ from django.contrib.auth import get_user_model from tcms.core.models.base import UrlMixin -from tcms.rpc.serializer import XMLRPCSerializer +from tcms.rpc.serializer import Serializer get_user_model()._meta.ordering = ['username'] @@ -25,12 +25,12 @@ def to_xmlrpc(cls, query=None): """ if query is None: query = {} - serializer = XMLRPCSerializer(queryset=cls.objects.filter(**query)) + serializer = Serializer(queryset=cls.objects.filter(**query)) return serializer.serialize_queryset() def serialize(self): """ Convert the model for XMLPRC """ - serializer = XMLRPCSerializer(model=self) + serializer = Serializer(model=self) return serializer.serialize_model() diff --git a/tcms/rpc/api/forms/testplan.py b/tcms/rpc/api/forms/testplan.py index 7e4f7f46a4..d67c66d523 100644 --- a/tcms/rpc/api/forms/testplan.py +++ b/tcms/rpc/api/forms/testplan.py @@ -3,13 +3,13 @@ from tcms.management.models import Product, Version from tcms.testplans import forms as testplan_forms from tcms.testplans.models import PlanType -from tcms.rpc.forms import XMLRPCCheckboxInput +from tcms.rpc.forms import CheckboxInput class NewPlanForm(testplan_forms.NewPlanForm): is_active = BooleanField( required=False, - widget=XMLRPCCheckboxInput + widget=CheckboxInput ) diff --git a/tcms/rpc/api/testexecution.py b/tcms/rpc/api/testexecution.py index 968582505d..55ebdefc18 100644 --- a/tcms/rpc/api/testexecution.py +++ b/tcms/rpc/api/testexecution.py @@ -7,7 +7,7 @@ from tcms.core.utils import form_errors_to_list from tcms.core.contrib.linkreference.models import LinkReference from tcms.testruns.models import TestExecution -from tcms.rpc.serializer import XMLRPCSerializer +from tcms.rpc.serializer import Serializer from tcms.rpc.decorators import permissions_required from tcms.rpc.api.utils import tracker_from_url from tcms.issuetracker.kiwitcms import KiwiTCMS @@ -215,5 +215,5 @@ def get_links(query): objects """ links = LinkReference.objects.filter(**query) - serialier = XMLRPCSerializer(links) + serialier = Serializer(links) return serialier.serialize_queryset() diff --git a/tcms/rpc/api/user.py b/tcms/rpc/api/user.py index 7b01a7686c..978d5251b7 100644 --- a/tcms/rpc/api/user.py +++ b/tcms/rpc/api/user.py @@ -6,7 +6,7 @@ from modernrpc.core import rpc_method, REQUEST_KEY -from tcms.rpc.serializer import XMLRPCSerializer +from tcms.rpc.serializer import Serializer from tcms.rpc.utils import parse_bool_value from tcms.rpc.decorators import permissions_required @@ -22,7 +22,7 @@ def _get_user_dict(user): - user_dict = XMLRPCSerializer(model=user).serialize_model() + user_dict = Serializer(model=user).serialize_model() if 'password' in user_dict: del user_dict['password'] return user_dict diff --git a/tcms/rpc/forms.py b/tcms/rpc/forms.py index 552b16c370..1339f7e165 100644 --- a/tcms/rpc/forms.py +++ b/tcms/rpc/forms.py @@ -5,7 +5,7 @@ from tcms.rpc.utils import parse_bool_value -class XMLRPCCheckboxInput(CheckboxInput): +class CheckboxInput(CheckboxInput): def value_from_datadict(self, data, files, name): if name not in data: return False diff --git a/tcms/rpc/serializer.py b/tcms/rpc/serializer.py index d5515324af..979c48b1ea 100644 --- a/tcms/rpc/serializer.py +++ b/tcms/rpc/serializer.py @@ -47,7 +47,7 @@ def timedelta_to_str(value): # todo: start removing these classes in favor of tcms.core.serializer -class XMLRPCSerializer: +class Serializer: """ Django XMLRPC Serializer The goal is to process the datetime and timedelta data structure @@ -56,13 +56,13 @@ class XMLRPCSerializer: How to use it: # Model m = Model.objects.get(pk = 1) - s = XMLRPCSerializer(model = m) + s = Serializer(model = m) s.serialize() Or # QuerySet q = Model.objects.all() - s = XMLRPCSerializer(queryset = q) + s = Serializer(queryset = q) s.serialize() """ @@ -172,7 +172,7 @@ def _serialize_names(row, values_fields_mapping): return new_serialized_data -class QuerySetBasedXMLRPCSerializer(XMLRPCSerializer): +class QuerySetBasedXMLRPCSerializer(Serializer): """XMLRPC serializer specific for TestPlan To configure the serialization, developer can specify following class diff --git a/tcms/rpc/tests/test_serializer.py b/tcms/rpc/tests/test_serializer.py index 80a36d7f63..e2864c914f 100644 --- a/tcms/rpc/tests/test_serializer.py +++ b/tcms/rpc/tests/test_serializer.py @@ -8,7 +8,7 @@ from tcms.testcases.models import TestCase from tcms.testplans.models import TestPlan from tcms.rpc.serializer import QuerySetBasedXMLRPCSerializer -from tcms.rpc.serializer import XMLRPCSerializer +from tcms.rpc.serializer import Serializer from tcms.rpc.serializer import datetime_to_str from tcms.rpc.serializer import do_nothing from tcms.rpc.serializer import to_str @@ -30,7 +30,7 @@ def setUpTestData(cls): ComponentFactory()]) def test_serializer(self): - serializer = XMLRPCSerializer(model=self.testcase) + serializer = Serializer(model=self.testcase) result = serializer.serialize_model()