From ea6c773facb3c4738b3372d737c8e13a618e8d85 Mon Sep 17 00:00:00 2001 From: David TARDIVEL Date: Mon, 19 Sep 2016 17:31:57 +0200 Subject: [PATCH] Clean the code by renaming 'type' parameters Closes-bug: #1533392 Change-Id: I02b6aae718a3a7d043c3316dbdccec5e2ade5d2a --- watcher_dashboard/api/watcher.py | 4 +- watcher_dashboard/utils/cached_property.py | 63 ---------------------- watcher_dashboard/utils/utils.py | 6 +-- 3 files changed, 5 insertions(+), 68 deletions(-) delete mode 100644 watcher_dashboard/utils/cached_property.py diff --git a/watcher_dashboard/api/watcher.py b/watcher_dashboard/api/watcher.py index bbe495c..e15e9ab 100644 --- a/watcher_dashboard/api/watcher.py +++ b/watcher_dashboard/api/watcher.py @@ -75,8 +75,8 @@ class Audit(base.APIDictWrapper): :param audit_template_uuid: related audit template UUID :type audit_template_uuid: string - :param type: audit type - :type type: string + :param audit_type: audit type + :type audit_type: string :param deadline: audit deadline: :type deadline: string diff --git a/watcher_dashboard/utils/cached_property.py b/watcher_dashboard/utils/cached_property.py deleted file mode 100644 index 7e37044..0000000 --- a/watcher_dashboard/utils/cached_property.py +++ /dev/null @@ -1,63 +0,0 @@ -# Licensed under the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. You may obtain -# a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations -# under the License. - -# Copyright (c) Django Software Foundation and individual contributors. -# All rights reserved. -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions are met: -# -# 1. Redistributions of source code must retain the above copyright notice, -# this list of conditions and the following disclaimer. -# -# 2. Redistributions in binary form must reproduce the above copyright -# notice, this list of conditions and the following disclaimer in the -# documentation and/or other materials provided with the distribution. -# -# 3. Neither the name of Django nor the names of its contributors may be -# used to endorse or promote products derived from this software without -# specific prior written permission. -# -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE -# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF -# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN -# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -# POSSIBILITY OF SUCH DAMAGE. - - -# We would be using django.utils.functional.cached_property, except it -# breaks when used with mox in our tests, because of -# https://code.djangoproject.com/ticket/19872 -# -# So we have a copy of it here, with the bug fixed. -# FIXME: Use django's version when the bug is fixed there. -class cached_property(object): - """Cached property decorator. - - Decorator that creates converts a method with a single self argument - into a property cached on the instance. - """ - - def __init__(self, func): - self.func = func - - def __get__(self, instance, type): - if instance is None: - return self - res = instance.__dict__[self.func.__name__] = self.func(instance) - return res diff --git a/watcher_dashboard/utils/utils.py b/watcher_dashboard/utils/utils.py index a75eb24..f708ecc 100644 --- a/watcher_dashboard/utils/utils.py +++ b/watcher_dashboard/utils/utils.py @@ -45,14 +45,14 @@ def length(iterator): return sum(1 for _item in iterator) -def check_image_type(image, type): - """Check if image 'type' property matches passed-in type. +def check_image_type(image, image_type): + """Check if image 'type' property matches passed-in image_type. If image has no 'type' property' return True, as we cannot be sure what type of image it is. """ - return (image.properties.get('type', type) == type) + return (image.properties.get('type', image_type) == image_type) def filter_items(items, **kwargs):