]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commit
apply underscores to ORM class and def names
authorMike Bayer <mike_mp@zzzcomputing.com>
Mon, 18 Nov 2024 18:43:08 +0000 (13:43 -0500)
committerMike Bayer <mike_mp@zzzcomputing.com>
Mon, 18 Nov 2024 19:56:07 +0000 (14:56 -0500)
commitf7e2b1a6e5a2188ecc6937a565b93937581a2d97
tree336cc34da8c271b1d2c15e39c529e3141640b81a
parent1b40521f5fb1628dfc6beec73fddda6855f6c77f
apply underscores to ORM class and def names

criteria used here is:

* The class or def should definitely not be used directly by
  a third party
* The class would never be the subject of an `isinstance()` check
* The class is not exposed as the type of a return value for a public
  function

A sweep through class and function names in the ORM renames many classes
and functions that have no intent of public visibility to be underscored.
This is to reduce ambiguity as to which APIs are intended to be targeted by
third party applications and extensions.  Third parties are encouraged to
propose new public APIs in Discussions to the extent they are needed to
replace those that have been clarified as private.

Fixes: #10497
Change-Id: I9900e759be8510e01bba2c25984b9f30dc1fa9c0
49 files changed:
doc/build/changelog/unreleased_21/10497.rst [new file with mode: 0644]
lib/sqlalchemy/ext/horizontal_shard.py
lib/sqlalchemy/ext/hybrid.py
lib/sqlalchemy/ext/instrumentation.py
lib/sqlalchemy/orm/_typing.py
lib/sqlalchemy/orm/attributes.py
lib/sqlalchemy/orm/bulk_persistence.py
lib/sqlalchemy/orm/clsregistry.py
lib/sqlalchemy/orm/collections.py
lib/sqlalchemy/orm/context.py
lib/sqlalchemy/orm/decl_api.py
lib/sqlalchemy/orm/decl_base.py
lib/sqlalchemy/orm/dependency.py
lib/sqlalchemy/orm/descriptor_props.py
lib/sqlalchemy/orm/dynamic.py
lib/sqlalchemy/orm/identity.py
lib/sqlalchemy/orm/instrumentation.py
lib/sqlalchemy/orm/interfaces.py
lib/sqlalchemy/orm/loading.py
lib/sqlalchemy/orm/mapper.py
lib/sqlalchemy/orm/path_registry.py
lib/sqlalchemy/orm/persistence.py
lib/sqlalchemy/orm/properties.py
lib/sqlalchemy/orm/query.py
lib/sqlalchemy/orm/relationships.py
lib/sqlalchemy/orm/session.py
lib/sqlalchemy/orm/state.py
lib/sqlalchemy/orm/strategies.py
lib/sqlalchemy/orm/strategy_options.py
lib/sqlalchemy/orm/sync.py
lib/sqlalchemy/orm/unitofwork.py
lib/sqlalchemy/orm/util.py
lib/sqlalchemy/orm/writeonly.py
test/ext/test_extendedattr.py
test/orm/declarative/test_clsregistry.py
test/orm/declarative/test_tm_future_annotations_sync.py
test/orm/declarative/test_typed_mapping.py
test/orm/test_attributes.py
test/orm/test_bind.py
test/orm/test_collection.py
test/orm/test_deprecations.py
test/orm/test_expire.py
test/orm/test_froms.py
test/orm/test_instrumentation.py
test/orm/test_mapper.py
test/orm/test_rel_fn.py
test/orm/test_selectin_relations.py
test/orm/test_session.py
test/orm/test_sync.py