7023050edd
The best practice in Python is not to use mutable object (i.e. list, dictionary, or instances of most classes) as value of default argument (see https://goo.gl/Kwhg0T). A hacking rule to enforce this practice is added as well. The patch was inspired by CR https://review.openstack.org/#/c/198465/ and took most of its code from it as well. That's why original copyrights are kept. Closes-Bug: #1471349 Change-Id: Ia77b1736dbc3d4e28ff2d2c3424e9cfcaefa5077
42 lines
1.5 KiB
Python
42 lines
1.5 KiB
Python
# Copyright (c) 2015 Intel, Inc.
|
|
# All Rights Reserved.
|
|
#
|
|
# 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.
|
|
|
|
import re
|
|
|
|
"""
|
|
Guidelines for writing new hacking checks
|
|
- Use only for Horizon specific tests. OpenStack general tests
|
|
should be submitted to the common 'hacking' module.
|
|
- Pick numbers in the range M3xx. Find the current test with
|
|
the highest allocated number and then pick the next value.
|
|
If nova has an N3xx code for that test, use the same number.
|
|
- Keep the test method code in the source file ordered based
|
|
on the M3xx value.
|
|
- List the new rule in the top level HACKING.rst file
|
|
- Add test cases for each new rule to /tests/unit/test_hacking.py
|
|
"""
|
|
|
|
mutable_default_args = re.compile(r"^\s*def .+\((.+=\{\}|.+=\[\])")
|
|
|
|
|
|
def no_mutable_default_args(logical_line):
|
|
msg = "M322: Method's default argument shouldn't be mutable!"
|
|
if mutable_default_args.match(logical_line):
|
|
yield (0, msg)
|
|
|
|
|
|
def factory(register):
|
|
register(no_mutable_default_args)
|