Skip to content

Commit

Permalink
Rename other RPC-related classes. Refs kiwitcms#682
Browse files Browse the repository at this point in the history
- `XMLRPCCheckboxInput` -> `CheckboxInput`
- `XMLRPCSerializer` -> `Serializer`
  • Loading branch information
asankov committed Nov 23, 2019
1 parent 1342208 commit c7e685d
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 16 deletions.
6 changes: 3 additions & 3 deletions tcms/core/models/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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']

Expand All @@ -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()
4 changes: 2 additions & 2 deletions tcms/rpc/api/forms/testplan.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
)


Expand Down
4 changes: 2 additions & 2 deletions tcms/rpc/api/testexecution.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -215,5 +215,5 @@ def get_links(query):
objects
"""
links = LinkReference.objects.filter(**query)
serialier = XMLRPCSerializer(links)
serialier = Serializer(links)
return serialier.serialize_queryset()
4 changes: 2 additions & 2 deletions tcms/rpc/api/user.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion tcms/rpc/forms.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions tcms/rpc/serializer.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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()
"""

Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions tcms/rpc/tests/test_serializer.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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()

Expand Down

0 comments on commit c7e685d

Please sign in to comment.