e34c6c9a5e
Many well-known libraries have a conventions regarding which alias to use. Choosing a different one will not break the code but makes it less readable and harder to maintain for other developers. Unless there is specific reason, it is usually best to use the recommended alias which most people are already familiar with. For datetime this convention is dt. Change-Id: Ifba7b7beafdac8377b98ce952b7d3b9dade01670 Closes-Bug: #1535786 |
||
---|---|---|
.. | ||
__init__.py | ||
checks.py | ||
README.rst |
Rally Style Commandments
- Step 1: Read the OpenStack Style Commandments http://docs.openstack.org/developer/hacking/
- Step 2: Read on
Rally Specific Commandments
- * [N30x] - Reserved for rules related to
mock
library -
- [N301] - Ensure that
assert_*
methods frommock
library is used correctly - [N302] - Ensure that nonexistent "assert_called" is not used
- [N303] - Ensure that nonexistent "assert_called_once" is not used
- [N301] - Ensure that
- * [N310-N314] - Reserved for rules related to logging
-
- [N310] - Ensure that
rally.common.log
is used as logging module - [N311] - Validate that debug level logs are not translated
- [N312] - Validate correctness of debug on check.
- [N310] - Ensure that
- * [N32x] - Reserved for rules related to assert* methods
-
- [N320] - Ensure that
assertTrue(isinstance(A, B))
is not used - [N321] - Ensure that
assertEqual(type(A), B)
is not used - [N322] - Ensure that
assertEqual(A, None)
andassertEqual(None, A)
are not used - [N323] - Ensure that
assertTrue/assertFalse(A in/not in B)
are not used with collection contents - [N324] - Ensure that
assertEqual(A in/not in B, True/False)
andassertEqual(True/False, A in/not in B)
are not used with collection contents
- [N320] - Ensure that
- [N340] - Ensure that we are importing always
from rally import objects
- [N341] - Ensure that we are importing oslo_xyz packages instead of deprecated oslo.xyz ones
- [N350] - Ensure that single quotes are not used
- [N351] - Ensure that data structs (i.e Lists and Dicts) are declared literally rather than using constructors
- [N352] - Ensure that string formatting only uses a mapping if multiple mapping keys are used.
- [N353] - Ensure that unicode() function is not uset because of absence in py3
- [N354] - Ensure that
:raises: Exception
is not used - [N355] - Ensure that we use only "new-style" Python classes
- [N356] - Ensure using
dt
as alias fordatetime
- * [N360-N370] - Reserved for rules related to CLI
-
- [N360] - Ensure that CLI modules do not use
rally.common.db
- [N361] - Ensure that CLI modules do not use
rally.common.objects
- [N360] - Ensure that CLI modules do not use