From 134f112697a2766235d2722b59387bf8715428de Mon Sep 17 00:00:00 2001 From: Konsta Vesterinen Date: Wed, 7 May 2014 14:55:07 +0300 Subject: [PATCH] Rename dependencies to dependent_objects --- docs/model_helpers.rst | 6 +++--- sqlalchemy_utils/__init__.py | 4 ++-- sqlalchemy_utils/functions/__init__.py | 3 ++- sqlalchemy_utils/functions/orm.py | 16 ++++++++-------- ...dependencies.py => test_dependent_objects.py} | 12 ++++++------ 5 files changed, 21 insertions(+), 20 deletions(-) rename tests/functions/{test_dependencies.py => test_dependent_objects.py} (92%) diff --git a/docs/model_helpers.rst b/docs/model_helpers.rst index 138dc29..253c1bc 100644 --- a/docs/model_helpers.rst +++ b/docs/model_helpers.rst @@ -4,10 +4,10 @@ Model helpers .. module:: sqlalchemy_utils.functions -dependencies -^^^^^^^^^^^^ +dependent_objects +^^^^^^^^^^^^^^^^^ -.. autofunction:: dependencies +.. autofunction:: dependent_objects escape_like diff --git a/sqlalchemy_utils/__init__.py b/sqlalchemy_utils/__init__.py index 2907d94..7f40d1a 100644 --- a/sqlalchemy_utils/__init__.py +++ b/sqlalchemy_utils/__init__.py @@ -8,7 +8,7 @@ from .functions import ( create_mock_engine, database_exists, defer_except, - dependencies, + dependent_objects, drop_database, escape_like, get_columns, @@ -75,7 +75,7 @@ __all__ = ( create_mock_engine, database_exists, defer_except, - dependencies, + dependent_objects, drop_database, escape_like, force_auto_coercion, diff --git a/sqlalchemy_utils/functions/__init__.py b/sqlalchemy_utils/functions/__init__.py index f68245f..5145e1b 100644 --- a/sqlalchemy_utils/functions/__init__.py +++ b/sqlalchemy_utils/functions/__init__.py @@ -12,7 +12,7 @@ from .database import ( non_indexed_foreign_keys, ) from .orm import ( - dependencies, + dependent_objects, get_columns, get_declarative_base, get_primary_keys, @@ -31,6 +31,7 @@ __all__ = ( 'create_mock_engine', 'database_exists', 'defer_except', + 'dependent_objects', 'drop_database', 'escape_like', 'get_columns', diff --git a/sqlalchemy_utils/functions/orm.py b/sqlalchemy_utils/functions/orm.py index cdb9574..ac92ff5 100644 --- a/sqlalchemy_utils/functions/orm.py +++ b/sqlalchemy_utils/functions/orm.py @@ -17,7 +17,7 @@ from sqlalchemy.orm.util import AliasedInsp from ..query_chain import QueryChain -def dependencies(obj, foreign_keys=None): +def dependent_objects(obj, foreign_keys=None): """ Return a QueryChain that iterates through all dependent objects for given SQLAlchemy object. @@ -27,17 +27,17 @@ def dependencies(obj, foreign_keys=None): :: - from sqlalchemy_utils import dependencies + from sqlalchemy_utils import dependent_objects - dependencies(user) + dependent_objects(user) - If you expect an object to have lots of dependencies it might be good to + If you expect an object to have lots of dependent_objects it might be good to limit the results:: - dependencies(user).limit(5) + dependent_objects(user).limit(5) The common use case is checking for all dependent objects before deleting @@ -46,7 +46,7 @@ def dependencies(obj, foreign_keys=None): it will lead to nasty IntegrityErrors being raised. In the following example we delete given user if it doesn't have any - foreign key restricted dependencies. + foreign key restricted dependent_objects. :: @@ -58,7 +58,7 @@ def dependencies(obj, foreign_keys=None): deps = list( - dependencies( + dependent_objects( user, ( fk for fk in get_referencing_foreign_keys(User) @@ -78,7 +78,7 @@ def dependencies(obj, foreign_keys=None): :param obj: SQLAlchemy declarative model object :param foreign_keys: - A sequence of foreign keys to use for searching the dependencies for + A sequence of foreign keys to use for searching the dependent_objects for given object. By default this is None, indicating that all foreign keys referencing the object will be used. diff --git a/tests/functions/test_dependencies.py b/tests/functions/test_dependent_objects.py similarity index 92% rename from tests/functions/test_dependencies.py rename to tests/functions/test_dependent_objects.py index 97ce67b..c57043e 100644 --- a/tests/functions/test_dependencies.py +++ b/tests/functions/test_dependent_objects.py @@ -1,9 +1,9 @@ import sqlalchemy as sa -from sqlalchemy_utils import dependencies, get_referencing_foreign_keys +from sqlalchemy_utils import dependent_objects, get_referencing_foreign_keys from tests import TestCase -class TestDependencies(TestCase): +class TestDependentObjects(TestCase): def create_models(self): class User(self.Base): __tablename__ = 'user' @@ -46,7 +46,7 @@ class TestDependencies(TestCase): self.session.add_all(articles) self.session.commit() - deps = list(dependencies(user)) + deps = list(dependent_objects(user)) assert len(deps) == 3 assert articles[0] in deps assert articles[2] in deps @@ -65,7 +65,7 @@ class TestDependencies(TestCase): self.session.commit() deps = list( - dependencies( + dependent_objects( user, ( fk for fk in get_referencing_foreign_keys(self.User) @@ -78,7 +78,7 @@ class TestDependencies(TestCase): assert objects[3] in deps -class TestDependenciesWithCompositeKeys(TestCase): +class TestDependentObjectsWithCompositeKeys(TestCase): def create_models(self): class User(self.Base): __tablename__ = 'user' @@ -113,7 +113,7 @@ class TestDependenciesWithCompositeKeys(TestCase): self.session.add_all(articles) self.session.commit() - deps = list(dependencies(user)) + deps = list(dependent_objects(user)) assert len(deps) == 2 assert articles[0] in deps assert articles[3] in deps