From 87c253c03f4c931e01d2c26e531902e4f8f89401 Mon Sep 17 00:00:00 2001 From: Brian Curtin Date: Wed, 15 Feb 2017 13:25:33 -0500 Subject: [PATCH] Privatize session instance on Proxy subclasses MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Each Proxy subclass has a session, but it's currently a public name, and as such is accessible. Making it accessible is sort of a low risk thing, but isn't really necessary—if someone needs a session instance they will perhaps be creating their own which they pass into a Connection, or they would be more likely to get the session off of a Connection instance (which is fine being public there, I think). This came up in the proxy doc work I'm doing, where every proxy has a warning for not documenting the `session` name. At the proxy level it really should just be a private name and a part of the implementation. This change basically does a s/self.session/self._session/ Change-Id: Iccb423aad801115d593a6ad5ead408f48054c5d4 --- openstack/cluster/v1/_proxy.py | 30 ++++---- openstack/compute/v2/_proxy.py | 77 ++++++++++--------- openstack/image/v2/_proxy.py | 12 +-- openstack/message/v1/_proxy.py | 6 +- openstack/message/v2/_proxy.py | 2 +- openstack/network/v2/_proxy.py | 28 +++---- openstack/object_store/v1/_proxy.py | 16 ++-- openstack/orchestration/v1/_proxy.py | 4 +- openstack/proxy.py | 22 +++--- openstack/proxy2.py | 20 ++--- .../tests/unit/orchestration/v1/test_proxy.py | 6 +- 11 files changed, 112 insertions(+), 111 deletions(-) diff --git a/openstack/cluster/v1/_proxy.py b/openstack/cluster/v1/_proxy.py index f0415b3b..9a517aeb 100644 --- a/openstack/cluster/v1/_proxy.py +++ b/openstack/cluster/v1/_proxy.py @@ -300,7 +300,7 @@ class Proxy(proxy2.BaseProxy): obj = cluster else: obj = self._find(_cluster.Cluster, cluster, ignore_missing=False) - return obj.add_nodes(self.session, nodes) + return obj.add_nodes(self._session, nodes) @utils.deprecated(deprecated_in="0.9.14", removed_in="1.0", details="Use remove_nodes_from_cluster instead") @@ -336,7 +336,7 @@ class Proxy(proxy2.BaseProxy): obj = cluster else: obj = self._find(_cluster.Cluster, cluster, ignore_missing=False) - return obj.del_nodes(self.session, nodes, **params) + return obj.del_nodes(self._session, nodes, **params) @utils.deprecated(deprecated_in="0.9.14", removed_in="1.0", details="Use replace_nodes_in_cluster instead") @@ -362,7 +362,7 @@ class Proxy(proxy2.BaseProxy): obj = cluster else: obj = self._find(_cluster.Cluster, cluster, ignore_missing=False) - return obj.replace_nodes(self.session, nodes) + return obj.replace_nodes(self._session, nodes) @utils.deprecated(deprecated_in="0.9.14", removed_in="1.0", details="Use scale_out_cluster instead") @@ -390,7 +390,7 @@ class Proxy(proxy2.BaseProxy): obj = cluster else: obj = self._find(_cluster.Cluster, cluster, ignore_missing=False) - return obj.scale_out(self.session, count) + return obj.scale_out(self._session, count) @utils.deprecated(deprecated_in="0.9.14", removed_in="1.0", details="Use scale_in_cluster instead") @@ -418,7 +418,7 @@ class Proxy(proxy2.BaseProxy): obj = cluster else: obj = self._find(_cluster.Cluster, cluster, ignore_missing=False) - return obj.scale_in(self.session, count) + return obj.scale_in(self._session, count) @utils.deprecated(deprecated_in="0.9.14", removed_in="1.0", details="Use resize_cluster instead") @@ -446,7 +446,7 @@ class Proxy(proxy2.BaseProxy): obj = cluster else: obj = self._find(_cluster.Cluster, cluster, ignore_missing=False) - return obj.resize(self.session, **params) + return obj.resize(self._session, **params) @utils.deprecated(deprecated_in="0.9.14", removed_in="1.0", details="Use attach_policy_to_cluster instead") @@ -476,7 +476,7 @@ class Proxy(proxy2.BaseProxy): obj = cluster else: obj = self._find(_cluster.Cluster, cluster, ignore_missing=False) - return obj.policy_attach(self.session, policy, **params) + return obj.policy_attach(self._session, policy, **params) @utils.deprecated(deprecated_in="0.9.14", removed_in="1.0", details="Use detach_policy_from_cluster instead") @@ -502,7 +502,7 @@ class Proxy(proxy2.BaseProxy): obj = cluster else: obj = self._find(_cluster.Cluster, cluster, ignore_missing=False) - return obj.policy_detach(self.session, policy) + return obj.policy_detach(self._session, policy) @utils.deprecated(deprecated_in="0.9.14", removed_in="1.0", details="Use update_cluster_policy instead") @@ -532,7 +532,7 @@ class Proxy(proxy2.BaseProxy): obj = cluster else: obj = self._find(_cluster.Cluster, cluster, ignore_missing=False) - return obj.policy_update(self.session, policy, **params) + return obj.policy_update(self._session, policy, **params) def collect_cluster_attrs(self, cluster, path): """Collect attribute values across a cluster. @@ -557,7 +557,7 @@ class Proxy(proxy2.BaseProxy): :returns: A dictionary containing the action ID. """ obj = self._get_resource(_cluster.Cluster, cluster) - return obj.check(self.session, **params) + return obj.check(self._session, **params) def recover_cluster(self, cluster, **params): """recover a cluster. @@ -570,7 +570,7 @@ class Proxy(proxy2.BaseProxy): :returns: A dictionary containing the action ID. """ obj = self._get_resource(_cluster.Cluster, cluster) - return obj.recover(self.session, **params) + return obj.recover(self._session, **params) @utils.deprecated(deprecated_in="0.9.14", removed_in="1.0", details="Use perform_operation_on_cluster instead") @@ -599,7 +599,7 @@ class Proxy(proxy2.BaseProxy): :returns: A dictionary containing the action ID. """ obj = self._get_resource(_cluster.Cluster, cluster) - return obj.op(self.session, operation, **params) + return obj.op(self._session, operation, **params) def create_node(self, **attrs): """Create a new node from attributes. @@ -707,7 +707,7 @@ class Proxy(proxy2.BaseProxy): :returns: A dictionary containing the action ID. """ obj = self._get_resource(_node.Node, node) - return obj.check(self.session, **params) + return obj.check(self._session, **params) def recover_node(self, node, **params): """Recover the specified node into healthy status. @@ -719,7 +719,7 @@ class Proxy(proxy2.BaseProxy): :returns: A dictionary containing the action ID. """ obj = self._get_resource(_node.Node, node) - return obj.recover(self.session, **params) + return obj.recover(self._session, **params) @utils.deprecated(deprecated_in="0.9.14", removed_in="1.0", details="Use perform_operation_on_node instead") @@ -748,7 +748,7 @@ class Proxy(proxy2.BaseProxy): :returns: A dictionary containing the action ID. """ obj = self._get_resource(_node.Node, node) - return obj.op(self.session, operation, **params) + return obj.op(self._session, operation, **params) def create_policy(self, **attrs): """Create a new policy from attributes. diff --git a/openstack/compute/v2/_proxy.py b/openstack/compute/v2/_proxy.py index d20af42d..1fd9bf24 100644 --- a/openstack/compute/v2/_proxy.py +++ b/openstack/compute/v2/_proxy.py @@ -197,7 +197,7 @@ class Proxy(proxy2.BaseProxy): :rtype: :class:`~openstack.compute.v2.image.Image` """ res = self._get_base_resource(image, _image.Image) - metadata = res.get_metadata(self.session) + metadata = res.get_metadata(self._session) result = _image.Image.existing(id=res.id, metadata=metadata) return result @@ -218,7 +218,7 @@ class Proxy(proxy2.BaseProxy): :rtype: :class:`~openstack.compute.v2.image.Image` """ res = self._get_base_resource(image, _image.Image) - metadata = res.set_metadata(self.session, **metadata) + metadata = res.set_metadata(self._session, **metadata) result = _image.Image.existing(id=res.id, metadata=metadata) return result @@ -236,7 +236,7 @@ class Proxy(proxy2.BaseProxy): :rtype: ``None`` """ res = self._get_base_resource(image, _image.Image) - return res.delete_metadata(self.session, keys) + return res.delete_metadata(self._session, keys) def create_keypair(self, **attrs): """Create a new keypair from attributes @@ -340,7 +340,7 @@ class Proxy(proxy2.BaseProxy): """ if force: server = self._get_resource(_server.Server, server) - server.force_delete(self.session) + server.force_delete(self._session) else: self._delete(_server.Server, server, ignore_missing=ignore_missing) @@ -433,7 +433,7 @@ class Proxy(proxy2.BaseProxy): :returns: None """ server = self._get_resource(_server.Server, server) - server.change_password(self.session, new_password) + server.change_password(self._session, new_password) def reset_server_state(self, server, state): """Reset the state of server @@ -446,7 +446,7 @@ class Proxy(proxy2.BaseProxy): :returns: None """ res = self._get_base_resource(server, _server.Server) - res.reset_state(self.session, state) + res.reset_state(self._session, state) def reboot_server(self, server, reboot_type): """Reboot a server @@ -459,7 +459,7 @@ class Proxy(proxy2.BaseProxy): :returns: None """ server = self._get_resource(_server.Server, server) - server.reboot(self.session, reboot_type) + server.reboot(self._session, reboot_type) def rebuild_server(self, server, name, admin_password, **attrs): """Rebuild a server @@ -487,7 +487,7 @@ class Proxy(proxy2.BaseProxy): instance. """ server = self._get_resource(_server.Server, server) - return server.rebuild(self.session, name, admin_password, **attrs) + return server.rebuild(self._session, name, admin_password, **attrs) def resize_server(self, server, flavor): """Resize a server @@ -501,7 +501,7 @@ class Proxy(proxy2.BaseProxy): """ server = self._get_resource(_server.Server, server) flavor_id = resource2.Resource._get_id(flavor) - server.resize(self.session, flavor_id) + server.resize(self._session, flavor_id) def confirm_server_resize(self, server): """Confirm a server resize @@ -512,7 +512,7 @@ class Proxy(proxy2.BaseProxy): :returns: None """ server = self._get_resource(_server.Server, server) - server.confirm_resize(self.session) + server.confirm_resize(self._session) def revert_server_resize(self, server): """Revert a server resize @@ -523,7 +523,7 @@ class Proxy(proxy2.BaseProxy): :returns: None """ server = self._get_resource(_server.Server, server) - server.revert_resize(self.session) + server.revert_resize(self._session) def create_server_image(self, server, name, metadata=None): """Create an image from a server @@ -536,7 +536,7 @@ class Proxy(proxy2.BaseProxy): :returns: None """ server = self._get_resource(_server.Server, server) - server.create_image(self.session, name, metadata) + server.create_image(self._session, name, metadata) def add_security_group_to_server(self, server, security_group): """Add a security group to a server @@ -551,7 +551,7 @@ class Proxy(proxy2.BaseProxy): """ server = self._get_resource(_server.Server, server) security_group_id = resource2.Resource._get_id(security_group) - server.add_security_group(self.session, security_group_id) + server.add_security_group(self._session, security_group_id) def remove_security_group_from_server(self, server, security_group): """Add a security group to a server @@ -566,7 +566,7 @@ class Proxy(proxy2.BaseProxy): """ server = self._get_resource(_server.Server, server) security_group_id = resource2.Resource._get_id(security_group) - server.remove_security_group(self.session, security_group_id) + server.remove_security_group(self._session, security_group_id) def add_fixed_ip_to_server(self, server, network_id): """Adds a fixed IP address to a server instance. @@ -578,7 +578,7 @@ class Proxy(proxy2.BaseProxy): :returns: None """ server = self._get_resource(_server.Server, server) - server.add_fixed_ip(self.session, network_id) + server.add_fixed_ip(self._session, network_id) def remove_fixed_ip_from_server(self, server, address): """Removes a fixed IP address from a server instance. @@ -590,7 +590,7 @@ class Proxy(proxy2.BaseProxy): :returns: None """ server = self._get_resource(_server.Server, server) - server.remove_fixed_ip(self.session, address) + server.remove_fixed_ip(self._session, address) def add_floating_ip_to_server(self, server, address, fixed_address=None): """Adds a floating IP address to a server instance. @@ -604,7 +604,7 @@ class Proxy(proxy2.BaseProxy): :returns: None """ server = self._get_resource(_server.Server, server) - server.add_floating_ip(self.session, address, + server.add_floating_ip(self._session, address, fixed_address=fixed_address) def remove_floating_ip_from_server(self, server, address): @@ -617,7 +617,7 @@ class Proxy(proxy2.BaseProxy): :returns: None """ server = self._get_resource(_server.Server, server) - server.remove_floating_ip(self.session, address) + server.remove_floating_ip(self._session, address) def pause_server(self, server): """Pauses a server and changes its status to ``PAUSED``. @@ -627,7 +627,7 @@ class Proxy(proxy2.BaseProxy): :returns: None """ server = self._get_resource(_server.Server, server) - server.pause(self.session) + server.pause(self._session) def unpause_server(self, server): """Unpauses a paused server and changes its status to ``ACTIVE``. @@ -637,7 +637,7 @@ class Proxy(proxy2.BaseProxy): :returns: None """ server = self._get_resource(_server.Server, server) - server.unpause(self.session) + server.unpause(self._session) def suspend_server(self, server): """Suspends a server and changes its status to ``SUSPENDED``. @@ -647,7 +647,7 @@ class Proxy(proxy2.BaseProxy): :returns: None """ server = self._get_resource(_server.Server, server) - server.suspend(self.session) + server.suspend(self._session) def resume_server(self, server): """Resumes a suspended server and changes its status to ``ACTIVE``. @@ -657,7 +657,7 @@ class Proxy(proxy2.BaseProxy): :returns: None """ server = self._get_resource(_server.Server, server) - server.resume(self.session) + server.resume(self._session) def lock_server(self, server): """Locks a server. @@ -667,7 +667,7 @@ class Proxy(proxy2.BaseProxy): :returns: None """ server = self._get_resource(_server.Server, server) - server.lock(self.session) + server.lock(self._session) def unlock_server(self, server): """Unlocks a locked server. @@ -677,7 +677,7 @@ class Proxy(proxy2.BaseProxy): :returns: None """ server = self._get_resource(_server.Server, server) - server.unlock(self.session) + server.unlock(self._session) def rescue_server(self, server, admin_pass=None, image_ref=None): """Puts a server in rescue mode and changes it status to ``RESCUE``. @@ -694,7 +694,8 @@ class Proxy(proxy2.BaseProxy): :returns: None """ server = self._get_resource(_server.Server, server) - server.rescue(self.session, admin_pass=admin_pass, image_ref=image_ref) + server.rescue(self._session, admin_pass=admin_pass, + image_ref=image_ref) def unrescue_server(self, server): """Unrescues a server and changes its status to ``ACTIVE``. @@ -704,7 +705,7 @@ class Proxy(proxy2.BaseProxy): :returns: None """ server = self._get_resource(_server.Server, server) - server.unrescue(self.session) + server.unrescue(self._session) def evacuate_server(self, server, host=None, admin_pass=None, force=None): """Evacuates a server from a failed host to a new host. @@ -721,7 +722,7 @@ class Proxy(proxy2.BaseProxy): :returns: None """ server = self._get_resource(_server.Server, server) - server.evacuate(self.session, host=host, admin_pass=admin_pass, + server.evacuate(self._session, host=host, admin_pass=admin_pass, force=force) def start_server(self, server): @@ -732,7 +733,7 @@ class Proxy(proxy2.BaseProxy): :returns: None """ server = self._get_resource(_server.Server, server) - server.start(self.session) + server.start(self._session) def stop_server(self, server): """Stops a running server and changes its state to ``SHUTOFF``. @@ -742,7 +743,7 @@ class Proxy(proxy2.BaseProxy): :returns: None """ server = self._get_resource(_server.Server, server) - server.stop(self.session) + server.stop(self._session) def shelve_server(self, server): """Shelves a server. @@ -757,7 +758,7 @@ class Proxy(proxy2.BaseProxy): :returns: None """ server = self._get_resource(_server.Server, server) - server.shelve(self.session) + server.shelve(self._session) def unshelve_server(self, server): """Unselves or restores a shelved server. @@ -771,11 +772,11 @@ class Proxy(proxy2.BaseProxy): :returns: None """ server = self._get_resource(_server.Server, server) - server.unshelve(self.session) + server.unshelve(self._session) def wait_for_server(self, server, status='ACTIVE', failures=['ERROR'], interval=2, wait=120): - return resource2.wait_for_status(self.session, server, status, + return resource2.wait_for_status(self._session, server, status, failures, interval, wait) def create_server_interface(self, server, **attrs): @@ -907,7 +908,7 @@ class Proxy(proxy2.BaseProxy): :rtype: :class:`~openstack.compute.v2.server.Server` """ res = self._get_base_resource(server, _server.Server) - metadata = res.get_metadata(self.session) + metadata = res.get_metadata(self._session) result = _server.Server.existing(id=res.id, metadata=metadata) return result @@ -928,7 +929,7 @@ class Proxy(proxy2.BaseProxy): :rtype: :class:`~openstack.compute.v2.server.Server` """ res = self._get_base_resource(server, _server.Server) - metadata = res.set_metadata(self.session, **metadata) + metadata = res.set_metadata(self._session, **metadata) result = _server.Server.existing(id=res.id, metadata=metadata) return result @@ -946,7 +947,7 @@ class Proxy(proxy2.BaseProxy): :rtype: ``None`` """ res = self._get_base_resource(server, _server.Server) - return res.delete_metadata(self.session, keys) + return res.delete_metadata(self._session, keys) def create_server_group(self, **attrs): """Create a new server group from attributes @@ -1079,7 +1080,7 @@ class Proxy(proxy2.BaseProxy): :returns: None """ service = self._get_resource(_service.Service, service) - service.force_down(self.session, host, binary) + service.force_down(self._session, host, binary) def disable_service(self, service, host, binary, disabled_reason=None): """Disable a service @@ -1093,7 +1094,7 @@ class Proxy(proxy2.BaseProxy): :returns: None """ service = self._get_resource(_service.Service, service) - service.disable(self.session, + service.disable(self._session, host, binary, disabled_reason) @@ -1109,7 +1110,7 @@ class Proxy(proxy2.BaseProxy): :returns: None """ service = self._get_resource(_service.Service, service) - service.enable(self.session, host, binary) + service.enable(self._session, host, binary) def services(self): """Return a generator of service diff --git a/openstack/image/v2/_proxy.py b/openstack/image/v2/_proxy.py index 8d6ab679..410d2f13 100644 --- a/openstack/image/v2/_proxy.py +++ b/openstack/image/v2/_proxy.py @@ -56,7 +56,7 @@ class Proxy(proxy2.BaseProxy): # return anything anyway. Otherwise this blocks while uploading # significant amounts of image data. img.data = data - img.upload(self.session) + img.upload(self._session) return img @@ -69,7 +69,7 @@ class Proxy(proxy2.BaseProxy): :returns: The bytes comprising the given Image. """ image = self._get_resource(_image.Image, image) - return image.download(self.session) + return image.download(self._session) def delete_image(self, image, ignore_missing=True): """Delete an image @@ -145,7 +145,7 @@ class Proxy(proxy2.BaseProxy): :returns: None """ image = self._get_resource(_image.Image, image) - image.deactivate(self.session) + image.deactivate(self._session) def reactivate_image(self, image): """Deactivate an image @@ -156,7 +156,7 @@ class Proxy(proxy2.BaseProxy): :returns: None """ image = self._get_resource(_image.Image, image) - image.reactivate(self.session) + image.reactivate(self._session) def add_tag(self, image, tag): """Add a tag to an image @@ -169,7 +169,7 @@ class Proxy(proxy2.BaseProxy): :returns: None """ image = self._get_resource(_image.Image, image) - image.add_tag(self.session, tag) + image.add_tag(self._session, tag) def remove_tag(self, image, tag): """Remove a tag to an image @@ -182,7 +182,7 @@ class Proxy(proxy2.BaseProxy): :returns: None """ image = self._get_resource(_image.Image, image) - image.remove_tag(self.session, tag) + image.remove_tag(self._session, tag) def add_member(self, image, **attrs): """Create a new member from attributes diff --git a/openstack/message/v1/_proxy.py b/openstack/message/v1/_proxy.py index ea6c205e..bc034d3d 100644 --- a/openstack/message/v1/_proxy.py +++ b/openstack/message/v1/_proxy.py @@ -55,7 +55,7 @@ class Proxy(proxy.BaseProxy): :rtype: list messages: The list of :class:`~openstack.message.v1.message.Message`s created. """ - return message.Message.create_messages(self.session, values) + return message.Message.create_messages(self._session, values) def claim_messages(self, value): """Claims a set of messages. @@ -67,7 +67,7 @@ class Proxy(proxy.BaseProxy): :rtype: list messages: The list of :class:`~openstack.message.v1.message.Message`s claimed. """ - return claim.Claim.claim_messages(self.session, value) + return claim.Claim.claim_messages(self._session, value) def delete_message(self, value): """Delete a message @@ -77,4 +77,4 @@ class Proxy(proxy.BaseProxy): :returns: ``None`` """ - message.Message.delete_by_id(self.session, value) + message.Message.delete_by_id(self._session, value) diff --git a/openstack/message/v2/_proxy.py b/openstack/message/v2/_proxy.py index 66aaee12..3fbe75bd 100644 --- a/openstack/message/v2/_proxy.py +++ b/openstack/message/v2/_proxy.py @@ -86,7 +86,7 @@ class Proxy(proxy2.BaseProxy): """ message = self._get_resource(_message.Message, None, queue_name=queue_name) - return message.post(self.session, messages) + return message.post(self._session, messages) def messages(self, queue_name, **query): """Retrieve a generator of messages diff --git a/openstack/network/v2/_proxy.py b/openstack/network/v2/_proxy.py index aaea030b..a06db9db 100644 --- a/openstack/network/v2/_proxy.py +++ b/openstack/network/v2/_proxy.py @@ -226,7 +226,7 @@ class Proxy(proxy2.BaseProxy): """ network = self._get_resource(_network.Network, network) agent = self._get_resource(_agent.Agent, agent) - return agent.add_agent_to_network(self.session, network.id) + return agent.add_agent_to_network(self._session, network.id) def remove_dhcp_agent_from_network(self, agent, network): """Remove a DHCP Agent from a network @@ -238,7 +238,7 @@ class Proxy(proxy2.BaseProxy): """ network = self._get_resource(_network.Network, network) agent = self._get_resource(_agent.Agent, agent) - return agent.remove_agent_from_network(self.session, network.id) + return agent.remove_agent_from_network(self._session, network.id) def network_hosting_dhcp_agents(self, network, **query): """A generator of DHCP agents hosted on a network. @@ -266,7 +266,7 @@ class Proxy(proxy2.BaseProxy): # If project option is not given, grab project id from session if project is None: - project = self.session.get_project_id() + project = self._session.get_project_id() return self._get(_auto_allocated_topology.AutoAllocatedTopology, project) @@ -287,7 +287,7 @@ class Proxy(proxy2.BaseProxy): # If project option is not given, grab project id from session if project is None: - project = self.session.get_project_id() + project = self._session.get_project_id() self._delete(_auto_allocated_topology.AutoAllocatedTopology, project, ignore_missing=ignore_missing) @@ -304,7 +304,7 @@ class Proxy(proxy2.BaseProxy): # If project option is not given, grab project id from session if project is None: - project = self.session.get_project_id() + project = self._session.get_project_id() return self._get(_auto_allocated_topology.ValidateTopology, project=project) @@ -471,7 +471,7 @@ class Proxy(proxy2.BaseProxy): :returns: One :class:`~openstack.network.v2.floating_ip.FloatingIP` or None """ - return _floating_ip.FloatingIP.find_available(self.session) + return _floating_ip.FloatingIP.find_available(self._session) def find_ip(self, name_or_id, ignore_missing=True): """Find a single IP @@ -1468,11 +1468,11 @@ class Proxy(proxy2.BaseProxy): def add_ip_to_port(self, port, ip): ip['port_id'] = port.id - return ip.update(self.session) + return ip.update(self._session) def remove_ip_from_port(self, ip): ip['port_id'] = None - return ip.update(self.session) + return ip.update(self._session) def get_subnet_ports(self, subnet_id): result = [] @@ -2211,7 +2211,7 @@ class Proxy(proxy2.BaseProxy): body = {'port_id': port_id} else: body = {'subnet_id': subnet_id} - return router.add_interface(self.session, **body) + return router.add_interface(self._session, **body) def remove_interface_from_router(self, router, subnet_id=None, port_id=None): @@ -2230,7 +2230,7 @@ class Proxy(proxy2.BaseProxy): body = {'port_id': port_id} else: body = {'subnet_id': subnet_id} - return router.remove_interface(self.session, **body) + return router.remove_interface(self._session, **body) def add_gateway_to_router(self, router, **body): """Add Gateway to a router @@ -2241,7 +2241,7 @@ class Proxy(proxy2.BaseProxy): :returns: Router with updated interface :rtype: :class: `~openstack.network.v2.router.Router` """ - return router.add_gateway(self.session, **body) + return router.add_gateway(self._session, **body) def remove_gateway_from_router(self, router, **body): """Remove Gateway from a router @@ -2252,7 +2252,7 @@ class Proxy(proxy2.BaseProxy): :returns: Router with updated interface :rtype: :class: `~openstack.network.v2.router.Router` """ - return router.remove_gateway(self.session, **body) + return router.remove_gateway(self._session, **body) def routers_hosting_l3_agents(self, router, **query): """Return a generator of L3 agent hosting a router @@ -2295,7 +2295,7 @@ class Proxy(proxy2.BaseProxy): """ agent = self._get_resource(_agent.Agent, agent) router = self._get_resource(_router.Router, router) - return agent.add_router_to_agent(self.session, router.id) + return agent.add_router_to_agent(self._session, router.id) def remove_router_from_agent(self, agent, router): """Remove router from L3 agent @@ -2308,7 +2308,7 @@ class Proxy(proxy2.BaseProxy): """ agent = self._get_resource(_agent.Agent, agent) router = self._get_resource(_router.Router, router) - return agent.remove_router_from_agent(self.session, router.id) + return agent.remove_router_from_agent(self._session, router.id) def create_security_group(self, **attrs): """Create a new security group from attributes diff --git a/openstack/object_store/v1/_proxy.py b/openstack/object_store/v1/_proxy.py index a38171fc..78a48902 100644 --- a/openstack/object_store/v1/_proxy.py +++ b/openstack/object_store/v1/_proxy.py @@ -35,7 +35,7 @@ class Proxy(proxy.BaseProxy): by the user. """ account = self._get_resource(_account.Account, None) - account.set_metadata(self.session, metadata) + account.set_metadata(self._session, metadata) def delete_account_metadata(self, keys): """Delete metadata for this account. @@ -43,7 +43,7 @@ class Proxy(proxy.BaseProxy): :param keys: The keys of metadata to be deleted. """ account = self._get_resource(_account.Account, None) - account.delete_metadata(self.session, keys) + account.delete_metadata(self._session, keys) def containers(self, **query): """Obtain Container objects for this account. @@ -54,7 +54,7 @@ class Proxy(proxy.BaseProxy): :rtype: A generator of :class:`~openstack.object_store.v1.container.Container` objects. """ - return _container.Container.list(self.session, **query) + return _container.Container.list(self._session, **query) def create_container(self, **attrs): """Create a new container from attributes @@ -121,7 +121,7 @@ class Proxy(proxy.BaseProxy): - `sync_key` """ res = self._get_resource(_container.Container, container) - res.set_metadata(self.session, metadata) + res.set_metadata(self._session, metadata) def delete_container_metadata(self, container, keys): """Delete metadata for a container. @@ -132,7 +132,7 @@ class Proxy(proxy.BaseProxy): :param keys: The keys of metadata to be deleted. """ res = self._get_resource(_container.Container, container) - res.delete_metadata(self.session, keys) + res.delete_metadata(self._session, keys) def objects(self, container, **query): """Return a generator that yields the Container's objects. @@ -149,7 +149,7 @@ class Proxy(proxy.BaseProxy): """ container = _container.Container.from_id(container) - objs = _obj.Object.list(self.session, + objs = _obj.Object.list(self._session, path_args={"container": container.name}, **query) for obj in objs: @@ -300,7 +300,7 @@ class Proxy(proxy.BaseProxy): container_name = self._get_container_name(obj, container) res = self._get_resource(_obj.Object, obj, path_args={"container": container_name}) - res.set_metadata(self.session, metadata) + res.set_metadata(self._session, metadata) def delete_object_metadata(self, obj, container=None, keys=None): """Delete metadata for an object. @@ -315,4 +315,4 @@ class Proxy(proxy.BaseProxy): container_name = self._get_container_name(obj, container) res = self._get_resource(_obj.Object, obj, path_args={"container": container_name}) - res.delete_metadata(self.session, keys) + res.delete_metadata(self._session, keys) diff --git a/openstack/orchestration/v1/_proxy.py b/openstack/orchestration/v1/_proxy.py index 654cc9e3..560219da 100644 --- a/openstack/orchestration/v1/_proxy.py +++ b/openstack/orchestration/v1/_proxy.py @@ -122,7 +122,7 @@ class Proxy(proxy2.BaseProxy): else: stk_obj = _stack.Stack.existing(id=stack) - stk_obj.check(self.session) + stk_obj.check(self._session) def resources(self, stack, **query): """Return a generator of resources @@ -295,6 +295,6 @@ class Proxy(proxy2.BaseProxy): "'template_url' must be specified when template is None") tmpl = _template.Template.new() - return tmpl.validate(self.session, template, environment=environment, + return tmpl.validate(self._session, template, environment=environment, template_url=template_url, ignore_errors=ignore_errors) diff --git a/openstack/proxy.py b/openstack/proxy.py index a3f71c7a..cbe8616e 100644 --- a/openstack/proxy.py +++ b/openstack/proxy.py @@ -41,7 +41,7 @@ def _check_resource(strict=False): class BaseProxy(object): def __init__(self, session): - self.session = session + self._session = session def _get_resource(self, resource_type, value, path_args=None): """Get a resource object to work on @@ -87,7 +87,7 @@ class BaseProxy(object): :returns: An instance of ``resource_type`` or None """ - return resource_type.find(self.session, name_or_id, + return resource_type.find(self._session, name_or_id, path_args=path_args, ignore_missing=ignore_missing) @@ -122,7 +122,7 @@ class BaseProxy(object): res = self._get_resource(resource_type, value, path_args) try: - rv = res.delete(self.session) + rv = res.delete(self._session) except exceptions.NotFoundException as e: if ignore_missing: return None @@ -157,7 +157,7 @@ class BaseProxy(object): """ res = self._get_resource(resource_type, value, path_args) res.update_attrs(attrs) - return res.update(self.session) + return res.update(self._session) def _create(self, resource_type, path_args=None, **attrs): """Create a resource from attributes @@ -176,7 +176,7 @@ class BaseProxy(object): res = resource_type.new(**attrs) if path_args is not None: res.update_attrs(path_args) - return res.create(self.session) + return res.create(self._session) @_check_resource(strict=False) def _get(self, resource_type, value=None, path_args=None, args=None): @@ -198,7 +198,7 @@ class BaseProxy(object): res = self._get_resource(resource_type, value, path_args) try: - return res.get(self.session, args=args) + return res.get(self._session, args=args) except exceptions.NotFoundException as e: raise exceptions.ResourceNotFound( message="No %s found for %s" % @@ -235,8 +235,8 @@ class BaseProxy(object): res = self._get_resource(resource_type, value, path_args) query = res.convert_ids(query) - return res.list(self.session, path_args=path_args, paginated=paginated, - params=query) + return res.list(self._session, path_args=path_args, + paginated=paginated, params=query) def _head(self, resource_type, value=None, path_args=None): """Retrieve a resource's header @@ -255,7 +255,7 @@ class BaseProxy(object): """ res = self._get_resource(resource_type, value, path_args) - return res.head(self.session) + return res.head(self._session) def wait_for_status(self, value, status, failures=[], interval=2, wait=120): @@ -278,7 +278,7 @@ class BaseProxy(object): :raises: :class:`~AttributeError` if the resource does not have a status attribute """ - return resource.wait_for_status(self.session, value, status, + return resource.wait_for_status(self._session, value, status, failures, interval, wait) def wait_for_delete(self, value, interval=2, wait=120): @@ -293,4 +293,4 @@ class BaseProxy(object): :raises: :class:`~openstack.exceptions.ResourceTimeout` transition to delete failed to occur in wait seconds. """ - return resource.wait_for_delete(self.session, value, interval, wait) + return resource.wait_for_delete(self._session, value, interval, wait) diff --git a/openstack/proxy2.py b/openstack/proxy2.py index 6d528d8d..e018d254 100644 --- a/openstack/proxy2.py +++ b/openstack/proxy2.py @@ -41,7 +41,7 @@ def _check_resource(strict=False): class BaseProxy(object): def __init__(self, session): - self.session = session + self._session = session def _get_resource(self, resource_type, value, **attrs): """Get a resource object to work on @@ -100,7 +100,7 @@ class BaseProxy(object): :returns: An instance of ``resource_type`` or None """ - return resource_type.find(self.session, name_or_id, + return resource_type.find(self._session, name_or_id, ignore_missing=ignore_missing, **attrs) @@ -135,7 +135,7 @@ class BaseProxy(object): res = self._get_resource(resource_type, value, **attrs) try: - rv = res.delete(self.session) + rv = res.delete(self._session) except exceptions.NotFoundException as e: if ignore_missing: return None @@ -170,7 +170,7 @@ class BaseProxy(object): :rtype: :class:`~openstack.resource2.Resource` """ res = self._get_resource(resource_type, value, **attrs) - return res.update(self.session) + return res.update(self._session) def _create(self, resource_type, **attrs): """Create a resource from attributes @@ -190,7 +190,7 @@ class BaseProxy(object): :rtype: :class:`~openstack.resource2.Resource` """ res = resource_type.new(**attrs) - return res.create(self.session) + return res.create(self._session) @_check_resource(strict=False) def _get(self, resource_type, value=None, requires_id=True, **attrs): @@ -214,7 +214,7 @@ class BaseProxy(object): res = self._get_resource(resource_type, value, **attrs) try: - return res.get(self.session, requires_id=requires_id) + return res.get(self._session, requires_id=requires_id) except exceptions.NotFoundException as e: raise exceptions.ResourceNotFound( message="No %s found for %s" % @@ -247,7 +247,7 @@ class BaseProxy(object): the ``resource_type``. """ res = self._get_resource(resource_type, value, **attrs) - return res.list(self.session, paginated=paginated, **attrs) + return res.list(self._session, paginated=paginated, **attrs) def _head(self, resource_type, value=None, **attrs): """Retrieve a resource's header @@ -267,7 +267,7 @@ class BaseProxy(object): :rtype: :class:`~openstack.resource2.Resource` """ res = self._get_resource(resource_type, value, **attrs) - return res.head(self.session) + return res.head(self._session) def wait_for_status(self, value, status, failures=[], interval=2, wait=120): @@ -290,7 +290,7 @@ class BaseProxy(object): :raises: :class:`~AttributeError` if the resource does not have a status attribute """ - return resource2.wait_for_status(self.session, value, status, + return resource2.wait_for_status(self._session, value, status, failures, interval, wait) def wait_for_delete(self, value, interval=2, wait=120): @@ -305,4 +305,4 @@ class BaseProxy(object): :raises: :class:`~openstack.exceptions.ResourceTimeout` transition to delete failed to occur in wait seconds. """ - return resource2.wait_for_delete(self.session, value, interval, wait) + return resource2.wait_for_delete(self._session, value, interval, wait) diff --git a/openstack/tests/unit/orchestration/v1/test_proxy.py b/openstack/tests/unit/orchestration/v1/test_proxy.py index 0da8050d..cac11515 100644 --- a/openstack/tests/unit/orchestration/v1/test_proxy.py +++ b/openstack/tests/unit/orchestration/v1/test_proxy.py @@ -61,7 +61,7 @@ class TestOrchestrationProxy(test_proxy_base2.TestProxyBase): res = self.proxy.check_stack(stk) self.assertIsNone(res) - mock_check.assert_called_once_with(self.proxy.session) + mock_check.assert_called_once_with(self.proxy._session) @mock.patch.object(stack.Stack, 'existing') def test_check_stack_with_stack_ID(self, mock_stack): @@ -72,7 +72,7 @@ class TestOrchestrationProxy(test_proxy_base2.TestProxyBase): self.assertIsNone(res) mock_stack.assert_called_once_with(id='FAKE_ID') - stk.check.assert_called_once_with(self.proxy.session) + stk.check.assert_called_once_with(self.proxy._session) @mock.patch.object(stack.Stack, 'find') def test_resources_with_stack_object(self, mock_find): @@ -163,7 +163,7 @@ class TestOrchestrationProxy(test_proxy_base2.TestProxyBase): res = self.proxy.validate_template(tmpl, env, tmpl_url, ignore_errors) mock_validate.assert_called_once_with( - self.proxy.session, tmpl, environment=env, template_url=tmpl_url, + self.proxy._session, tmpl, environment=env, template_url=tmpl_url, ignore_errors=ignore_errors) self.assertEqual(mock_validate.return_value, res)