openstack/nova
Code Issues Proposed changes

Merge "db: Synchronize function signatures"

Browse Source
This commit is contained in:
Zuul 2021-07-01 20:16:18 +00:00 committed by Gerrit Code Review
commit d03a600461
2 changed files with 52 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
nova/db/api.py
View File

@ -74,7 +74,7 @@ def not_equal(*values):
return IMPL.not_equal(*values) return IMPL.not_equal(*values)
def create_context_manager(connection): def create_context_manager(connection=None):
"""Create a database context manager object for a cell database connection. """Create a database context manager object for a cell database connection.
:param connection: The database connection string :param connection: The database connection string
@ -117,9 +117,9 @@ def service_get_by_uuid(context, service_uuid):
return IMPL.service_get_by_uuid(context, service_uuid) return IMPL.service_get_by_uuid(context, service_uuid)
def service_get_minimum_version(context, binary): def service_get_minimum_version(context, binaries):
"""Get the minimum service version in the database.""" """Get the minimum service version in the database."""
return IMPL.service_get_minimum_version(context, binary) return IMPL.service_get_minimum_version(context, binaries)
def service_get_by_host_and_topic(context, host, topic): def service_get_by_host_and_topic(context, host, topic):
@ -395,9 +395,9 @@ def certificate_get_all_by_user_and_project(context, user_id, project_id):
#################### ####################
def migration_update(context, id, values): def migration_update(context, migration_id, values):
"""Update a migration instance.""" """Update a migration instance."""
return IMPL.migration_update(context, id, values) return IMPL.migration_update(context, migration_id, values)
def migration_create(context, values): def migration_create(context, values):
@ -522,31 +522,31 @@ def virtual_interface_get_by_uuid(context, vif_uuid):
return IMPL.virtual_interface_get_by_uuid(context, vif_uuid) return IMPL.virtual_interface_get_by_uuid(context, vif_uuid)
def virtual_interface_get_by_instance(context, instance_id): def virtual_interface_get_by_instance(context, instance_uuid):
"""Gets all virtual interfaces for instance. """Gets all virtual interfaces for instance.
:param instance_uuid: UUID of the instance to filter on. :param instance_uuid: UUID of the instance to filter on.
""" """
return IMPL.virtual_interface_get_by_instance(context, instance_id) return IMPL.virtual_interface_get_by_instance(context, instance_uuid)
def virtual_interface_get_by_instance_and_network( def virtual_interface_get_by_instance_and_network(
context, instance_id, network_id, context, instance_uuid, network_id,
): ):
"""Get all virtual interface for instance that's associated with """Get all virtual interface for instance that's associated with
network. network.
""" """
return IMPL.virtual_interface_get_by_instance_and_network(context, return IMPL.virtual_interface_get_by_instance_and_network(
instance_id, context, instance_uuid, network_id,
network_id) )
def virtual_interface_delete_by_instance(context, instance_id): def virtual_interface_delete_by_instance(context, instance_uuid):
"""Delete virtual interface records associated with instance. """Delete virtual interface records associated with instance.
:param instance_uuid: UUID of the instance to filter on. :param instance_uuid: UUID of the instance to filter on.
""" """
return IMPL.virtual_interface_delete_by_instance(context, instance_id) return IMPL.virtual_interface_delete_by_instance(context, instance_uuid)
def virtual_interface_delete(context, id): def virtual_interface_delete(context, id):
@ -786,16 +786,18 @@ def instance_update_and_get_original(context, instance_uuid, values,
return rv return rv
def instance_add_security_group(context, instance_id, security_group_id): def instance_add_security_group(context, instance_uuid, security_group_id):
"""Associate the given security group with the given instance.""" """Associate the given security group with the given instance."""
return IMPL.instance_add_security_group(context, instance_id, return IMPL.instance_add_security_group(
security_group_id) context, instance_uuid, security_group_id,
)
def instance_remove_security_group(context, instance_id, security_group_id): def instance_remove_security_group(context, instance_uuid, security_group_id):
"""Disassociate the given security group from the given instance.""" """Disassociate the given security group from the given instance."""
return IMPL.instance_remove_security_group(context, instance_id, return IMPL.instance_remove_security_group(
security_group_id) context, instance_uuid, security_group_id,
)
#################### ####################
@ -1126,9 +1128,9 @@ def pci_device_destroy(context, node_id, address):
return IMPL.pci_device_destroy(context, node_id, address) return IMPL.pci_device_destroy(context, node_id, address)
def pci_device_update(context, node_id, address, value): def pci_device_update(context, node_id, address, values):
"""Update a pci device.""" """Update a pci device."""
return IMPL.pci_device_update(context, node_id, address, value) return IMPL.pci_device_update(context, node_id, address, values)
#################### ####################
@ -1265,9 +1267,9 @@ def actions_get(context, instance_uuid, limit=None, marker=None,
return IMPL.actions_get(context, instance_uuid, limit, marker, filters) return IMPL.actions_get(context, instance_uuid, limit, marker, filters)
def action_get_by_request_id(context, uuid, request_id): def action_get_by_request_id(context, instance_uuid, request_id):
"""Get the action by request_id and given instance.""" """Get the action by request_id and given instance."""
return IMPL.action_get_by_request_id(context, uuid, request_id) return IMPL.action_get_by_request_id(context, instance_uuid, request_id)
def action_event_start(context, values): def action_event_start(context, values):

47
nova/db/sqlalchemy/api.py
View File

@ -174,6 +174,7 @@ def require_context(f):
def wrapper(*args, **kwargs): def wrapper(*args, **kwargs):
nova.context.require_context(args[0]) nova.context.require_context(args[0])
return f(*args, **kwargs) return f(*args, **kwargs)
wrapper.__signature__ = inspect.signature(f)
return wrapper return wrapper
@ -202,6 +203,7 @@ def select_db_reader_mode(f):
with reader_mode.using(context): with reader_mode.using(context):
return f(*args, **kwargs) return f(*args, **kwargs)
wrapper.__signature__ = inspect.signature(f)
return wrapper return wrapper
@ -213,11 +215,12 @@ def pick_context_manager_writer(f):
Wrapped function must have a RequestContext in the arguments. Wrapped function must have a RequestContext in the arguments.
""" """
@functools.wraps(f) @functools.wraps(f)
def wrapped(context, *args, **kwargs): def wrapper(context, *args, **kwargs):
ctxt_mgr = get_context_manager(context) ctxt_mgr = get_context_manager(context)
with ctxt_mgr.writer.using(context): with ctxt_mgr.writer.using(context):
return f(context, *args, **kwargs) return f(context, *args, **kwargs)
return wrapped wrapper.__signature__ = inspect.signature(f)
return wrapper
def pick_context_manager_reader(f): def pick_context_manager_reader(f):
@ -228,11 +231,12 @@ def pick_context_manager_reader(f):
Wrapped function must have a RequestContext in the arguments. Wrapped function must have a RequestContext in the arguments.
""" """
@functools.wraps(f) @functools.wraps(f)
def wrapped(context, *args, **kwargs): def wrapper(context, *args, **kwargs):
ctxt_mgr = get_context_manager(context) ctxt_mgr = get_context_manager(context)
with ctxt_mgr.reader.using(context): with ctxt_mgr.reader.using(context):
return f(context, *args, **kwargs) return f(context, *args, **kwargs)
return wrapped wrapper.__signature__ = inspect.signature(f)
return wrapper
def pick_context_manager_reader_allow_async(f): def pick_context_manager_reader_allow_async(f):
@ -243,11 +247,12 @@ def pick_context_manager_reader_allow_async(f):
Wrapped function must have a RequestContext in the arguments. Wrapped function must have a RequestContext in the arguments.
""" """
@functools.wraps(f) @functools.wraps(f)
def wrapped(context, *args, **kwargs): def wrapper(context, *args, **kwargs):
ctxt_mgr = get_context_manager(context) ctxt_mgr = get_context_manager(context)
with ctxt_mgr.reader.allow_async.using(context): with ctxt_mgr.reader.allow_async.using(context):
return f(context, *args, **kwargs) return f(context, *args, **kwargs)
return wrapped wrapper.__signature__ = inspect.signature(f)
return wrapper
def model_query( def model_query(
@ -1539,8 +1544,10 @@ def instance_get_all(context, columns_to_join=None):
@require_context @require_context
@pick_context_manager_reader_allow_async @pick_context_manager_reader_allow_async
def instance_get_all_by_filters(context, filters, sort_key, sort_dir, def instance_get_all_by_filters(
limit=None, marker=None, columns_to_join=None): context, filters, sort_key='created_at', sort_dir='desc', limit=None,
marker=None, columns_to_join=None,
):
"""Get all instances matching all filters sorted by the primary key. """Get all instances matching all filters sorted by the primary key.
See instance_get_all_by_filters_sort for more information. See instance_get_all_by_filters_sort for more information.
@ -2541,7 +2548,7 @@ def _instance_extra_create(context, values):
@pick_context_manager_writer @pick_context_manager_writer
def instance_extra_update_by_uuid(context, instance_uuid, values): def instance_extra_update_by_uuid(context, instance_uuid, updates):
"""Update the instance extra record by instance uuid """Update the instance extra record by instance uuid
:param instance_uuid: UUID of the instance tied to the record :param instance_uuid: UUID of the instance tied to the record
@ -2549,10 +2556,10 @@ def instance_extra_update_by_uuid(context, instance_uuid, values):
""" """
rows_updated = model_query(context, models.InstanceExtra).\ rows_updated = model_query(context, models.InstanceExtra).\
filter_by(instance_uuid=instance_uuid).\ filter_by(instance_uuid=instance_uuid).\
update(values) update(updates)
if not rows_updated: if not rows_updated:
LOG.debug("Created instance_extra for %s", instance_uuid) LOG.debug("Created instance_extra for %s", instance_uuid)
create_values = copy.copy(values) create_values = copy.copy(updates)
create_values["instance_uuid"] = instance_uuid create_values["instance_uuid"] = instance_uuid
_instance_extra_create(context, create_values) _instance_extra_create(context, create_values)
rows_updated = 1 rows_updated = 1
@ -3305,23 +3312,23 @@ def migration_create(context, values):
@oslo_db_api.wrap_db_retry(max_retries=5, retry_on_deadlock=True) @oslo_db_api.wrap_db_retry(max_retries=5, retry_on_deadlock=True)
@pick_context_manager_writer @pick_context_manager_writer
def migration_update(context, id, values): def migration_update(context, migration_id, values):
"""Update a migration instance.""" """Update a migration instance."""
migration = migration_get(context, id) migration = migration_get(context, migration_id)
migration.update(values) migration.update(values)
return migration return migration
@pick_context_manager_reader @pick_context_manager_reader
def migration_get(context, id): def migration_get(context, migration_id):
"""Finds a migration by the ID.""" """Finds a migration by the ID."""
result = model_query(context, models.Migration, read_deleted="yes").\ result = model_query(context, models.Migration, read_deleted="yes").\
filter_by(id=id).\ filter_by(id=migration_id).\
first() first()
if not result: if not result:
raise exception.MigrationNotFound(migration_id=id) raise exception.MigrationNotFound(migration_id=migration_id)
return result return result
@ -3340,16 +3347,16 @@ def migration_get_by_uuid(context, migration_uuid):
@pick_context_manager_reader @pick_context_manager_reader
def migration_get_by_id_and_instance(context, id, instance_uuid): def migration_get_by_id_and_instance(context, migration_id, instance_uuid):
"""Finds a migration by the migration ID and the instance UUID.""" """Finds a migration by the migration ID and the instance UUID."""
result = model_query(context, models.Migration).\ result = model_query(context, models.Migration).\
filter_by(id=id).\ filter_by(id=migration_id).\
filter_by(instance_uuid=instance_uuid).\ filter_by(instance_uuid=instance_uuid).\
first() first()
if not result: if not result:
raise exception.MigrationNotFoundForInstance(migration_id=id, raise exception.MigrationNotFoundForInstance(
instance_id=instance_uuid) migration_id=migration_id, instance_id=instance_uuid)
return result return result