535f2f48ff
This sucks in the git history for both projects, then moves their files in place. It should not introduce any behavior changes to any of the existing openstacksdk code, nor to openstack.config and openstack.cloud - other than the name change. TODO(shade) comments have been left indicating places where further integration work should be done. It should not be assumed that these are the final places for either to live. This is just about getting them in-tree so we can work with them. The enforcer code for reasons surpassing understanding does not work with python setup.py build_sphinx but it does work with sphinx-build (what?) For now turn it off. We can turn it back on once the build sphinx job is migrated to the new PTI. Change-Id: I9523e4e281285360c61e9e0456a8e07b7ac1243c
50 lines
1.4 KiB
ReStructuredText
50 lines
1.4 KiB
ReStructuredText
openstacksdk Style Commandments
|
|
===============================
|
|
|
|
Read the OpenStack Style Commandments
|
|
http://docs.openstack.org/developer/hacking/
|
|
|
|
Indentation
|
|
-----------
|
|
|
|
PEP-8 allows for 'visual' indentation. Do not use it. Visual indentation looks
|
|
like this:
|
|
|
|
.. code-block:: python
|
|
|
|
return_value = self.some_method(arg1, arg1,
|
|
arg3, arg4)
|
|
|
|
Visual indentation makes refactoring the code base unneccesarily hard.
|
|
|
|
Instead of visual indentation, use this:
|
|
|
|
.. code-block:: python
|
|
|
|
return_value = self.some_method(
|
|
arg1, arg1, arg3, arg4)
|
|
|
|
That way, if some_method ever needs to be renamed, the only line that needs
|
|
to be touched is the line with some_method. Additionaly, if you need to
|
|
line break at the top of a block, please indent the continuation line
|
|
an additional 4 spaces, like this:
|
|
|
|
.. code-block:: python
|
|
|
|
for val in self.some_method(
|
|
arg1, arg1, arg3, arg4):
|
|
self.do_something_awesome()
|
|
|
|
Neither of these are 'mandated' by PEP-8. However, they are prevailing styles
|
|
within this code base.
|
|
|
|
Unit Tests
|
|
----------
|
|
|
|
Unit tests should be virtually instant. If a unit test takes more than 1 second
|
|
to run, it is a bad unit test. Honestly, 1 second is too slow.
|
|
|
|
All unit test classes should subclass `openstack.tests.unit.base.BaseTestCase`. The
|
|
base TestCase class takes care of properly creating `OpenStackCloud` objects
|
|
in a way that protects against local environment.
|