openstack/deb-python-autobahn
Code Issues Proposed changes

expand on style guide

Browse Source
This commit is contained in:
Tobias Oberstein
2015-09-08 10:10:22 +02:00
parent 1f365dac1c
commit 8914111b5b
1 changed files with 8 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
DEVELOPERS.md
View File

@@ -14,11 +14,12 @@ Please follow these coding standards when writing code for inclusion in Autobahn
> The rules and text here follows [Django](https://docs.djangoproject.com/en/1.8/internals/contributing/writing-code/coding-style/).
1. Unless otherwise specified, follow [PEP 8](https://www.python.org/dev/peps/pep-0008).
2. Use 4 spaces for indents, CamelCase for classes, and snake_case for variables, functions and members.
3. Remember that PEP 8 is only a guide, so respect the style of the surrounding code as a primary goal.
4. An exception to PEP 8 is our rules on line lengths. Don’t limit lines of code to 79 characters if it means the code looks significantly uglier or is harder to read. We allow up to 119 characters as this is the width of GitHub code review; anything longer requires horizontal scrolling which makes review more difficult. This check is included when you run flake8. Documentation, comments, and docstrings should be wrapped at 79 characters, even though PEP 8 suggests 72.
5. Using hanging indents, with each argument strictly on a separate line (see also [here](http://stackoverflow.com/questions/15435811/what-is-pep8s-e128-continuation-line-under-indented-for-visual-indent/15435837#15435837) for an explanation why this is PEP8 compliant):
1. Unless otherwise specified, follow [PEP 8](https://www.python.org/dev/peps/pep-0008). However, remember that PEP 8 is only a guide, so respect the style of the surrounding code as a primary goal.
2. Use 4 spaces for indents, CamelCase for classes and snake_case for variables, functions and members.
3. Members/functions that are not part of the public API must be prefixed with a single underscore.
4. Rule 2./3. apply to the public API exposed by AutobahnPython for **both** Twisted and asyncio users as well as everything within the library itself.
5. An exception to PEP 8 is our rules on line lengths. Don’t limit lines of code to 79 characters if it means the code looks significantly uglier or is harder to read. We allow up to 119 characters as this is the width of GitHub code review; anything longer requires horizontal scrolling which makes review more difficult. This check is included when you run flake8. Documentation, comments, and docstrings should be wrapped at 79 characters, even though PEP 8 suggests 72.
6. Using hanging indents, with each argument strictly on a separate line (see also [here](http://stackoverflow.com/questions/15435811/what-is-pep8s-e128-continuation-line-under-indented-for-visual-indent/15435837#15435837) for an explanation why this is PEP8 compliant):
```python
raise ApplicationError(
@@ -27,17 +28,11 @@ raise ApplicationError(
)
```
**Code must be checked for adherence to above rules using [flake8](https://flake8.readthedocs.org/en/2.4.1/).**
Currently, code is checked using
flake8 --ignore=E501 autobahn
but this will be
Code must be checked for adherence to above rules using [flake8](https://flake8.readthedocs.org/en/2.4.1/):
flake8 --max-line-length=119 autobahn
upcoming.
## Release Process