diff options
| author | Mike Bayer <mike_mp@zzzcomputing.com> | 2022-10-07 14:03:16 -0400 |
|---|---|---|
| committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2022-10-11 10:23:08 -0400 |
| commit | 4ef7bcf580844a431c5354896e954ca4ce1042ce (patch) | |
| tree | a57cbd80bc367ff2296bb8338188a364f9e0b66b /examples | |
| parent | 231897cf10d731c6bab4bca562374c60558a0177 (diff) | |
| download | sqlalchemy-4ef7bcf580844a431c5354896e954ca4ce1042ce.tar.gz | |
rename MappedCollection and related
For consistency with the prominent ORM concept :class:`_orm.Mapped`, the
names of the dictionary-oriented collections,
:func:`_orm.attribute_mapped_collection`,
:func:`_orm.column_mapped_collection`, and :class:`_orm.MappedCollection`,
are changed to :func:`_orm.attribute_keyed_dict`,
:func:`_orm.column_keyed_dict` and :class:`_orm.KeyFuncDict`, using the
phrase "dict" to minimize any confusion against the term "mapped". The old
names will remain indefinitely with no schedule for removal.
Docs here are also updated for typing as we can type
these collections as ``Mapped[dict[str, cls]]``, don't need
KeyFuncDict / MappedCollection for these
Fixes: #8608
Change-Id: Ib5cf63e0aef1c389e023a75e454bb21f9d779b54
Diffstat (limited to 'examples')
| -rw-r--r-- | examples/adjacency_list/adjacency_list.py | 4 | ||||
| -rw-r--r-- | examples/association/dict_of_sets_with_default.py | 4 | ||||
| -rw-r--r-- | examples/versioned_rows/versioned_map.py | 4 | ||||
| -rw-r--r-- | examples/vertical/dictlike-polymorphic.py | 4 | ||||
| -rw-r--r-- | examples/vertical/dictlike.py | 4 |
5 files changed, 10 insertions, 10 deletions
diff --git a/examples/adjacency_list/adjacency_list.py b/examples/adjacency_list/adjacency_list.py index fee0f413f..38503f9f3 100644 --- a/examples/adjacency_list/adjacency_list.py +++ b/examples/adjacency_list/adjacency_list.py @@ -8,7 +8,7 @@ from sqlalchemy.orm import backref from sqlalchemy.orm import joinedload from sqlalchemy.orm import relationship from sqlalchemy.orm import Session -from sqlalchemy.orm.collections import attribute_mapped_collection +from sqlalchemy.orm.collections import attribute_keyed_dict Base = declarative_base() @@ -30,7 +30,7 @@ class TreeNode(Base): backref=backref("parent", remote_side=id), # children will be represented as a dictionary # on the "name" attribute. - collection_class=attribute_mapped_collection("name"), + collection_class=attribute_keyed_dict("name"), ) def __init__(self, name, parent=None): diff --git a/examples/association/dict_of_sets_with_default.py b/examples/association/dict_of_sets_with_default.py index 14045b7f5..96e30c1e2 100644 --- a/examples/association/dict_of_sets_with_default.py +++ b/examples/association/dict_of_sets_with_default.py @@ -23,7 +23,7 @@ from sqlalchemy.ext.associationproxy import association_proxy from sqlalchemy.ext.declarative import declarative_base from sqlalchemy.orm import relationship from sqlalchemy.orm import Session -from sqlalchemy.orm.collections import MappedCollection +from sqlalchemy.orm.collections import KeyFuncDict class Base: @@ -33,7 +33,7 @@ class Base: Base = declarative_base(cls=Base) -class GenDefaultCollection(MappedCollection): +class GenDefaultCollection(KeyFuncDict): def __missing__(self, key): self[key] = b = B(key) return b diff --git a/examples/versioned_rows/versioned_map.py b/examples/versioned_rows/versioned_map.py index c2fa6c2a9..fd457946f 100644 --- a/examples/versioned_rows/versioned_map.py +++ b/examples/versioned_rows/versioned_map.py @@ -43,7 +43,7 @@ from sqlalchemy.orm import relationship from sqlalchemy.orm import Session from sqlalchemy.orm import sessionmaker from sqlalchemy.orm import validates -from sqlalchemy.orm.collections import attribute_mapped_collection +from sqlalchemy.orm.collections import attribute_keyed_dict @event.listens_for(Session, "before_flush") @@ -83,7 +83,7 @@ class ConfigData(Base): elements = relationship( "ConfigValueAssociation", - collection_class=attribute_mapped_collection("name"), + collection_class=attribute_keyed_dict("name"), backref=backref("config_data"), lazy="subquery", ) diff --git a/examples/vertical/dictlike-polymorphic.py b/examples/vertical/dictlike-polymorphic.py index 95b582a76..0343d53e1 100644 --- a/examples/vertical/dictlike-polymorphic.py +++ b/examples/vertical/dictlike-polymorphic.py @@ -132,7 +132,7 @@ if __name__ == "__main__": create_engine, ) from sqlalchemy.orm import relationship, Session - from sqlalchemy.orm.collections import attribute_mapped_collection + from sqlalchemy.orm.collections import attribute_keyed_dict from sqlalchemy.ext.declarative import declarative_base from sqlalchemy.ext.associationproxy import association_proxy @@ -162,7 +162,7 @@ if __name__ == "__main__": name = Column(Unicode(100)) facts = relationship( - "AnimalFact", collection_class=attribute_mapped_collection("key") + "AnimalFact", collection_class=attribute_keyed_dict("key") ) _proxied = association_proxy( diff --git a/examples/vertical/dictlike.py b/examples/vertical/dictlike.py index b74b31776..d0a952d7c 100644 --- a/examples/vertical/dictlike.py +++ b/examples/vertical/dictlike.py @@ -71,7 +71,7 @@ if __name__ == "__main__": create_engine, ) from sqlalchemy.orm import relationship, Session - from sqlalchemy.orm.collections import attribute_mapped_collection + from sqlalchemy.orm.collections import attribute_keyed_dict from sqlalchemy.ext.declarative import declarative_base from sqlalchemy.ext.associationproxy import association_proxy @@ -95,7 +95,7 @@ if __name__ == "__main__": name = Column(Unicode(100)) facts = relationship( - "AnimalFact", collection_class=attribute_mapped_collection("key") + "AnimalFact", collection_class=attribute_keyed_dict("key") ) _proxied = association_proxy( |
