Use the inflect library for better singularization of table names

agronholm · agronholm · commit 8fb87cdf2196 · 2013-05-25T10:40:24.000+03:00
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -4,14 +4,14 @@ Version history
 1.1.0
 -----
 
-* Revamped the API
-
 * Added automatic detection of joined-table inheritance
 
 * Fixed missing class name prefix in primary/secondary joins in relationships
 
 * Instead of wildcard imports, generate explicit imports dynamically (fixes #1)
 
+* Use the inflect library to produce better guesses for table to class name conversion
+
 * Automatically detect Boolean columns based on CheckConstraints
 
 * Skip redundant CheckConstraints for Enum and Boolean columns
diff --git a/setup.py b/setup.py
@@ -4,7 +4,13 @@
 from setuptools import setup, find_packages
 
 
-extra_requirements = ('argparse',) if sys.version_info < (2, 7) else ()
+extra_requirements = ()
+dependency_links = []
+if sys.version_info < (2, 7):
+    extra_requirements = ('argparse',)
+elif sys.version_info > (3,):
+    dependency_links = ['https://github.com/benthor/inflect.py/archive/master.zip#egg=inflect-0.2.3']
+
 here = os.path.dirname(__file__)
 readme_path = os.path.join(here, 'README.rst')
 readme = open(readme_path).read()
@@ -13,7 +19,7 @@
     name='sqlacodegen',
     description='Automatic model code generator for SQLAlchemy',
     long_description=readme,
-    version='1.1.0.pre2',
+    version='1.1.0.pre3',
     author='Alex Gronholm',
     author_email='sqlacodegen@nextday.fi',
     url='http://pypi.python.org/pypi/sqlacodegen/',
@@ -34,7 +40,9 @@
     packages=find_packages(exclude=['tests']),
     install_requires=(
         'sqlalchemy >= 0.6.0',
+        'inflect >= 0.2.0'
     ) + extra_requirements,
+    dependency_links=dependency_links,
     test_suite='nose.collector',
     tests_require=['nose'],
     zip_safe=False,
diff --git a/sqlacodegen/codegen.py b/sqlacodegen/codegen.py
@@ -11,6 +11,7 @@
 from sqlalchemy.util import OrderedDict
 from sqlalchemy.types import Boolean, String
 import sqlalchemy
+import inflect
 
 try:
     from sqlalchemy.sql.expression import TextClause
@@ -23,18 +24,11 @@
 _re_enum_check_constraint = re.compile(r"(?:(?:.*?)\.)?(.*?) IN \((.+)\)")
 _re_enum_item = re.compile(r"'(.*?)(?<!\\)'")
 
-
-def _singular(plural):
-    """A feeble attempt at converting plural English nouns into singular form."""
-    if plural.endswith('ies'):
-        return plural[:-3] + 'y'
-    if plural.endswith('s') and not plural.endswith('ss'):
-        return plural[:-1]
-    return plural
+inflect_engine = inflect.engine()
 
 
 def _tablename_to_classname(tablename):
-    return _singular(''.join(part.capitalize() for part in tablename.split('_')))
+    return inflect_engine.singular_noun(''.join(part.capitalize() for part in tablename.split('_')))
 
 
 def _get_compiled_expression(statement):
@@ -358,7 +352,7 @@ def __init__(self, source_cls, target_cls, constraint):
 
         colname = constraint.columns[0]
         tablename = constraint.elements[0].column.table.name
-        self.preferred_name = _singular(tablename) if not colname.endswith('_id') else colname[:-3]
+        self.preferred_name = inflect_engine.singular_noun(tablename) if not colname.endswith('_id') else colname[:-3]
 
         # Add uselist=False to One-to-One relationships
         if any(isinstance(c, (PrimaryKeyConstraint, UniqueConstraint)) and
diff --git a/test/test_codegen.py b/test/test_codegen.py
@@ -10,7 +10,7 @@
 from sqlalchemy.dialects.postgresql.base import BIGINT, DOUBLE_PRECISION, BOOLEAN, ENUM
 from sqlalchemy.dialects.mysql.base import TINYINT
 
-from sqlacodegen.codegen import CodeGenerator, _singular
+from sqlacodegen.codegen import CodeGenerator
 
 
 if sys.version_info < (3,):
@@ -22,14 +22,6 @@ def remove_unicode_prefixes(text):
     remove_unicode_prefixes = lambda text: text
 
 
-def test_singular_ies():
-    eq_(_singular('bunnies'), 'bunny')
-
-
-def test_singular_ss():
-    eq_(_singular('address'), 'address')
-
-
 class TestCodeGenerator(object):
     def setup(self):
         self.metadata = MetaData(create_engine('sqlite:///'))
diff --git a/tox.ini b/tox.ini
@@ -3,15 +3,18 @@ envlist = py26,py27,py32,py33,py26-sqla07,py26-sqla06
 
 [testenv]
 deps=nose
+    https://github.com/benthor/inflect.py/archive/master.zip#egg=inflect-0.2.3
 	sqlalchemy<=0.8.99
 commands=nosetests []
 
 [testenv:py26-sqla07]
 basepython=python2.6
 deps=nose
+    https://github.com/benthor/inflect.py/archive/master.zip#egg=inflect-0.2.3
     sqlalchemy<=0.7.99
     
 [testenv:py26-sqla06]
 basepython=python2.6
 deps=nose
+    https://github.com/benthor/inflect.py/archive/master.zip#egg=inflect-0.2.3
     sqlalchemy==0.6.0
