Difference between revisions of "Designate/Development/StyleGuide"
< Designate | Development
(Created page with "==== Designate Style Guide ==== {{note|This guide is unofficial at the moment}} Follow PEP8 and the [http://www.pocoo.org/internal/styleguide/ Pocoo Style Guide] Start new...") |
(→Logging) |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | === Designate Style Guide === | |
| − | + | '''This guide is unofficial at the moment''' | |
| − | Follow | + | Follow [http://docs.openstack.org/developer/hacking/ OpenStack Style Guidelines] and the [http://www.pocoo.org/internal/styleguide/ Pocoo Style Guide] |
| + | ==== File header ==== | ||
Start new files with the following. Replace where needed: | Start new files with the following. Replace where needed: | ||
| − | + | <source lang="python" collapse="true"> | |
| − | < | ||
# -*- coding: utf-8 -*- | # -*- coding: utf-8 -*- | ||
# Copyright <year> <company> | # Copyright <year> <company> | ||
| Line 29: | Line 29: | ||
~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~~ | ||
<Describe what the module should do, especially interactions with other components> | <Describe what the module should do, especially interactions with other components> | ||
| − | Specs: <Link to the spec document | + | Specs: <Link to the spec document> |
""" | """ | ||
| − | </ | + | </source> |
| + | |||
| + | ==== Docstrings ==== | ||
| + | |||
| + | Use the Sphinx markup. Here is an example: | ||
| + | |||
| + | <source lang="python" collapse="true"> | ||
| + | class MyClass(object): | ||
| + | """<description> | ||
| + | mention a function :func:`foo` or a class :class:`Bar` | ||
| + | """ | ||
| + | |||
| + | def function(self, foo): | ||
| + | """<describe what the function does> | ||
| + | :param foo: <description> | ||
| + | :type foo: <type> | ||
| + | :returns: <describe the returned value> | ||
| + | :rtype: <returned type> | ||
| + | :raises: <list raised exceptions> | ||
| + | |||
| + | :Example: | ||
| + | |||
| + | >>> a = b - c | ||
| + | >>> <more Python code> | ||
| + | |||
| + | .. note:: <add a note here> | ||
| + | .. seealso:: <blah> | ||
| + | .. warning:: <use sparingly> | ||
| + | """ | ||
| + | </source> | ||
| + | |||
| + | ==== Logging ==== | ||
| + | |||
| + | See http://docs.openstack.org/developer/oslo.i18n/guidelines.html | ||
| + | |||
| + | <source lang="python" collapse="true"> | ||
| + | # Do not use "%" string formatting | ||
| + | # No localization for debug | ||
| + | LOG.debug("... %s", variable) | ||
| + | LOG.info(_LI("... %s..."), variable) | ||
| + | # Use named interpolation when more than one replacement is done | ||
| + | LOG.info(_LI("... %(key)s ..."), {'key': 'value', ...}) | ||
| + | LOG.warn(_LW("... %(key)s"), {'key': 'value'}) | ||
| + | LOG.error(_LE("... %(key)s"), {'key': 'value'}) | ||
| + | LOG.critical(_LC("... %(key)s"), {'key': 'value'}) | ||
| + | </source> | ||
Latest revision as of 11:13, 18 March 2016
Designate Style Guide
This guide is unofficial at the moment
Follow OpenStack Style Guidelines and the Pocoo Style Guide
File header
Start new files with the following. Replace where needed:
# -*- coding: utf-8 -*-
# Copyright <year> <company>
#
# Author: <name> <email addr>
#
# 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.
"""
<package.module>
~~~~~~~~~~~~~~
<Describe what the module should do, especially interactions with other components>
Specs: <Link to the spec document>
"""
Docstrings
Use the Sphinx markup. Here is an example:
class MyClass(object):
"""<description>
mention a function :func:`foo` or a class :class:`Bar`
"""
def function(self, foo):
"""<describe what the function does>
:param foo: <description>
:type foo: <type>
:returns: <describe the returned value>
:rtype: <returned type>
:raises: <list raised exceptions>
:Example:
>>> a = b - c
>>> <more Python code>
.. note:: <add a note here>
.. seealso:: <blah>
.. warning:: <use sparingly>
"""
Logging
See http://docs.openstack.org/developer/oslo.i18n/guidelines.html
# Do not use "%" string formatting
# No localization for debug
LOG.debug("... %s", variable)
LOG.info(_LI("... %s..."), variable)
# Use named interpolation when more than one replacement is done
LOG.info(_LI("... %(key)s ..."), {'key': 'value', ...})
LOG.warn(_LW("... %(key)s"), {'key': 'value'})
LOG.error(_LE("... %(key)s"), {'key': 'value'})
LOG.critical(_LC("... %(key)s"), {'key': 'value'})
