Merge pull request #437 from kairu-ms/ps-linker

Replace inflect library by pluralizer to singular name

Author: kairu-ms

requirements.txt

@@ -1,8 +1,8 @@
 schematics~=2.1.1
 pyyaml~=6.0.2
 fuzzywuzzy~=0.18.0
-inflect~=5.6.2
 azure-mgmt-core~=1.3.0
+pluralizer~=1.2.0
 lxml~=4.9.4
 flask~=3.0.3
 cachelib~=0.13.0

src/aaz_dev/command/model/configuration/_arg_builder.py

@@ -1,7 +1,6 @@
 import re
 
-import inflect
-from utils.case import to_camel_case
+from utils.case import to_camel_case, to_singular
 
 from ._arg import CMDArg, CMDArgBase, CMDArgumentHelp, CMDArgEnum, CMDArgDefault, CMDBooleanArgBase, \
     CMDArgBlank, CMDObjectArgAdditionalProperties, CMDResourceLocationArgBase, CMDClsArgBase, CMDPasswordArgPromptInput
@@ -14,7 +13,6 @@
 
 
 class CMDArgBuilder:
-    _inflect_engine = inflect.engine()
 
     @classmethod
     def new_builder(cls, schema, parent=None, var_prefix=None, ref_args=None, ref_arg=None, is_update_action=False):
@@ -364,15 +362,15 @@ def get_options(self):
             if name == "[Index]" or name == "{Key}":
                 assert self._arg_var.endswith(name)
                 prefix = self._arg_var[:-len(name)].split('.')[-1]
-                prefix = self._inflect_engine.singular_noun(prefix)
+                prefix = to_singular(prefix)
                 if name == "[Index]":
                     name = f'{prefix}-index'
                 elif name == "{Key}":
                     name = f'{prefix}-key'
             elif name.startswith('[].') or name.startswith('{}.'):
                 assert self._arg_var.endswith(name)
                 prefix = self._arg_var[:-len(name)].split('.')[-1]
-                prefix = self._inflect_engine.singular_noun(prefix)
+                prefix = to_singular(prefix)
                 name = prefix + name[2:]
             name = name.replace('.', '-')
             opt_name = self._build_option_name(name)  # some schema name may contain $
@@ -392,7 +390,7 @@ def get_singular_options(self):
         # Disable singular options by default
         # if isinstance(self.schema, CMDArraySchema):
         #     opt_name = self._build_option_name(self.schema.name.replace('$', ''))  # some schema name may contain $
-        #     singular_opt_name = self._inflect_engine.singular_noun(opt_name) or opt_name
+        #     singular_opt_name = to_singular(opt_name) or opt_name
         #     if singular_opt_name != opt_name:
         #         return [singular_opt_name, ]
         return None

src/aaz_dev/command/model/configuration/_xml.py

@@ -1,4 +1,3 @@
-import inflect
 import re
 
 from lxml.builder import ElementMaker
@@ -10,6 +9,7 @@
 from schematics.types.compound import PolyModelType
 from schematics.types.serializable import Serializable
 from ._fields import CMDPrimitiveField
+from utils.case import to_singular
 
 XML_ROOT = "CodeGen"
 
@@ -49,7 +49,7 @@ def build_xml(primitive, parent=None):
     if parent is None:
         parent = getattr(ElementMaker(), XML_ROOT)()
     # normalize element name
-    if elem_name := _inflect_engine.singular_noun(parent.tag):
+    if elem_name := to_singular(parent.tag):
         parent.tag = elem_name
     for field_name, data in primitive.items():
         primitive_to_xml(field_name, data, parent)
@@ -87,7 +87,7 @@ def build_model(model, primitive):
             # obtain suitable element name
             if serialized_name in primitive:
                 curr_name = serialized_name
-            elif (elem_name := _inflect_engine.singular_noun(serialized_name)) in primitive:
+            elif (elem_name := to_singular(serialized_name)) in primitive:
                 curr_name = elem_name
             else:
                 continue
@@ -135,6 +135,3 @@ def _unwrap(field):
         return field.model_class
     else:
         return field
-
-
-_inflect_engine = inflect.engine()

src/aaz_dev/swagger/controller/command_generator.py

@@ -1,7 +1,6 @@
 import logging
 import re
 
-import inflect
 from abc import abstractmethod, ABC
 
 from command.model.configuration import CMDCommandGroup, CMDCommand, CMDHttpOperation, CMDHttpRequest, \
@@ -19,14 +18,14 @@
 from utils.config import Config
 from utils.plane import PlaneEnum
 from utils.error_format import AAZErrorFormatEnum
+from utils.case import to_singular
+
 
 logger = logging.getLogger('backend')
 
 
 class _CommandGenerator(ABC):
 
-    _inflect_engine = inflect.engine()
-
     @staticmethod
     def generate_command_version(resource):
         return resource.version
@@ -161,7 +160,7 @@ def generate_command_group_name_by_resource(cls, resource_path, rp_name):
             part = re.sub(r"\{[^{}]*}", '', part)
             part = re.sub(r"[^a-zA-Z0-9\-._]", '', part)
             name = camel_case_to_snake_case(part, '-')
-            singular_name = cls._inflect_engine.singular_noun(name) or name
+            singular_name = to_singular(name) or name
             names.append(singular_name)
         return " ".join([name for name in names if name])
 

src/aaz_dev/swagger/model/specs/_resource.py

@@ -4,20 +4,19 @@
 import os
 import re
 
-import inflect
 from fuzzywuzzy import fuzz
 
 from command.model.configuration import CMDResource
 from ._utils import map_path_2_repo
-from utils.base64 import b64encode_str, b64decode_str
+from utils.base64 import b64encode_str
 from swagger.utils import exceptions
+from utils.case import to_singular
 
 logger = logging.getLogger('backend')
 
 
 class Resource:
     _CAMEL_CASE_PATTERN = re.compile(r"^([a-zA-Z][a-z0-9]+)(([A-Z][a-z0-9]*)+)$")
-    _inflect_engine = inflect.engine()
 
     def __init__(self, resource_id, path, version, file_path, resource_provider, body):
         self.path = path
@@ -98,22 +97,22 @@ def _parse_operation_group_name(self, op_id, method):
         words = []
         for part in self.id.split('?')[0].split('/'):
             if part == '{}' and len(words):
-                singular = self._inflect_engine.singular_noun(words[-1])
+                singular = to_singular(words[-1])
                 if singular:
                     words[-1] = singular
             else:
                 words.append(part.replace('_', ""))
-        op_group_singular = self._inflect_engine.singular_noun(op_group_name) or op_group_name
+        op_group_singular = to_singular(op_group_name) or op_group_name
         words.reverse()  # search from tail
         for word in words:
-            word_singular = self._inflect_engine.singular_noun(word) or word
+            word_singular = to_singular(word) or word
             if len(word_singular) > 1 and op_group_singular.lower().endswith(word_singular.lower()):
                 if word == word_singular:
                     # use singular
                     op_group_name = op_group_singular
                 elif word != word_singular:
                     # use plural
-                    op_group_plural = self._inflect_engine.plural_noun(op_group_singular)
+                    op_group_plural = to_singular(op_group_singular)
                     if op_group_plural is not False:
                         op_group_name = op_group_plural
                 break

src/aaz_dev/utils/case.py

@@ -1,5 +1,7 @@
 import re
+from pluralizer import Pluralizer
 
+_pluralizer = Pluralizer()
 
 def to_camel_case(name):
     assert isinstance(name, str)
@@ -13,3 +15,6 @@ def to_snake_case(name, separator='_'):
     name = re.sub('(.)([A-Z][a-z]+)', r'\1' + separator + r'\2', name)
     name = re.sub('([a-z0-9])([A-Z])', r'\1' + separator + r'\2', name).lower()
     return name.replace('-', separator).replace('_', separator)
+
+def to_singular(name):
+    return _pluralizer.singular(name)