File: formatters.py

package info (click to toggle)
py-serializable 2.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 524 kB
  • sloc: python: 2,271; xml: 519; makefile: 12
file content (99 lines) | stat: -rw-r--r-- 3,409 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
# encoding: utf-8

# This file is part of py-serializable
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
# Copyright (c) Paul Horton. All Rights Reserved.

from abc import ABC, abstractmethod
from re import compile as re_compile
from typing import Type


class BaseNameFormatter(ABC):

    @classmethod
    @abstractmethod
    def encode(cls, property_name: str) -> str:
        pass

    @classmethod
    @abstractmethod
    def decode(cls, property_name: str) -> str:
        pass

    @classmethod
    def decode_as_class_name(cls, name: str) -> str:
        name = CamelCasePropertyNameFormatter.encode(cls.decode(property_name=name))
        return name[:1].upper() + name[1:]

    @classmethod
    def decode_handle_python_builtins_and_keywords(cls, name: str) -> str:
        return name

    @classmethod
    def encode_handle_python_builtins_and_keywords(cls, name: str) -> str:
        return name


class CamelCasePropertyNameFormatter(BaseNameFormatter):
    _ENCODE_PATTERN = re_compile(r'_([a-z])')
    _DECODE_PATTERN = re_compile(r'(?<!^)(?=[A-Z])')

    @classmethod
    def encode(cls, property_name: str) -> str:
        property_name = property_name[:1].lower() + property_name[1:]
        return cls.encode_handle_python_builtins_and_keywords(
            CamelCasePropertyNameFormatter._ENCODE_PATTERN.sub(lambda x: x.group(1).upper(), property_name)
        )

    @classmethod
    def decode(cls, property_name: str) -> str:
        return cls.decode_handle_python_builtins_and_keywords(
            CamelCasePropertyNameFormatter._DECODE_PATTERN.sub('_', property_name).lower()
        )


class KebabCasePropertyNameFormatter(BaseNameFormatter):
    _ENCODE_PATTERN = re_compile(r'(_)')

    @classmethod
    def encode(cls, property_name: str) -> str:
        property_name = cls.encode_handle_python_builtins_and_keywords(name=property_name)
        property_name = property_name[:1].lower() + property_name[1:]
        return KebabCasePropertyNameFormatter._ENCODE_PATTERN.sub(lambda x: '-', property_name)

    @classmethod
    def decode(cls, property_name: str) -> str:
        return cls.decode_handle_python_builtins_and_keywords(property_name.replace('-', '_'))


class SnakeCasePropertyNameFormatter(BaseNameFormatter):
    _ENCODE_PATTERN = re_compile(r'(.)([A-Z][a-z]+)')

    @classmethod
    def encode(cls, property_name: str) -> str:
        property_name = property_name[:1].lower() + property_name[1:]
        return cls.encode_handle_python_builtins_and_keywords(
            SnakeCasePropertyNameFormatter._ENCODE_PATTERN.sub(lambda x: x.group(1).upper(), property_name)
        )

    @classmethod
    def decode(cls, property_name: str) -> str:
        return cls.decode_handle_python_builtins_and_keywords(property_name)


class CurrentFormatter:
    formatter: Type['BaseNameFormatter'] = CamelCasePropertyNameFormatter