summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/orm/state.py
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2022-06-13 11:46:28 -0400
committermike bayer <mike_mp@zzzcomputing.com>2022-06-21 16:32:10 +0000
commitf9f1e8b6c5890eb17b6ba055ff563087cac20d0e (patch)
treed75c859067cbae695ea9dae1d0f17b94c8eede75 /lib/sqlalchemy/orm/state.py
parent017fd9ae0645eaf2a0fbdd067d10c721505b018c (diff)
downloadsqlalchemy-f9f1e8b6c5890eb17b6ba055ff563087cac20d0e.tar.gz
rework ORM mapping docs
prepare docs for newly incoming mapper styles, including new dataclass mapping. move the existing dataclass/attrs docs all into their own section and try to improve organization and wording into the relatively recent "mapping styles" document. Change-Id: I0b5e2a5b6a70db65ab19b5bb0a2bb7df20e0b498
Diffstat (limited to 'lib/sqlalchemy/orm/state.py')
-rw-r--r--lib/sqlalchemy/orm/state.py4
1 files changed, 3 insertions, 1 deletions
diff --git a/lib/sqlalchemy/orm/state.py b/lib/sqlalchemy/orm/state.py
index af9f48706..db4263f03 100644
--- a/lib/sqlalchemy/orm/state.py
+++ b/lib/sqlalchemy/orm/state.py
@@ -118,10 +118,12 @@ class InstanceState(interfaces.InspectionAttrInfo, Generic[_O]):
>>> from sqlalchemy import inspect
>>> insp = inspect(some_mapped_object)
+ >>> insp.attrs.nickname.history
+ History(added=['new nickname'], unchanged=(), deleted=['nickname'])
.. seealso::
- :ref:`core_inspection_toplevel`
+ :ref:`orm_mapper_inspection_instancestate`
"""