zun/HACKING.rst
Madhuri Kumari 6ef76f47b1 Add Hacking Rule to Higgins.
Change-Id: I22509f5054a574656cc5fcc41aa0d366b9a4134b
2016-05-21 19:56:06 +05:30

1.0 KiB

Higgins Style Commandments

Read the OpenStack Style Commandments http://docs.openstack.org/developer/hacking/

Higgins Specific Commandments ----------------------------

  • [M302] Change assertEqual(A is not None) by optimal assert like assertIsNotNone(A).
  • [M310] timeutils.utcnow() wrapper must be used instead of direct calls to datetime.datetime.utcnow() to make it easy to override its return value.
  • [M316] Change assertTrue(isinstance(A, B)) by optimal assert like assertIsInstance(A, B).
  • [M318] Change assertEqual(A, None) or assertEqual(None, A) by optimal assert like assertIsNone(A)
  • [M322] Method's default argument shouldn't be mutable.
  • [M323] Change assertEqual(True, A) or assertEqual(False, A) by optimal assert like assertTrue(A) or assertFalse(A)
  • [M336] Must use a dict comprehension instead of a dict constructor with a sequence of key-value pairs.
  • [M338] Use assertIn/NotIn(A, B) rather than assertEqual(A in B, True/False).
  • [M339] Don't use xrange()