starlingx/utilities
Code Issues Proposed changes

Enable Flake8 Docstring Errors

Browse Source 
Flake8 currently ignores the following errors:
H401: docstring should not start with a space
H404: multi line docstring should start without a leading new line
H405: multi line docstring summary not separated with an empty line
Enable them for more consistent formatting of docstrings

Change-Id: I385e28e9c6eca3c02a3def51ff64b00b7a63a853
Story: 2004515
Task: 30076
Signed-off-by: Eric Barrett <eric.barrett@windriver.com>
This commit is contained in:
Eric Barrett 2019-04-18 09:11:20 -04:00
parent ca74c5401f
commit abd4587682
4 changed files with 7 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
ceph/ceph-manager/ceph-manager/ceph_manager/ceph.py
View File

@ -15,6 +15,7 @@ LOG = logging.getLogger(__name__)
def osd_pool_set_quota(ceph_api, pool_name, max_bytes=0, max_objects=0): def osd_pool_set_quota(ceph_api, pool_name, max_bytes=0, max_objects=0):
"""Set the quota for an OSD pool_name """Set the quota for an OSD pool_name
Setting max_bytes or max_objects to 0 will disable that quota param Setting max_bytes or max_objects to 0 will disable that quota param
:param pool_name: OSD pool_name :param pool_name: OSD pool_name
:param max_bytes: maximum bytes for OSD pool_name :param max_bytes: maximum bytes for OSD pool_name
@ -112,6 +113,7 @@ def osd_pool_create(ceph_api, pool_name, pg_num, pgp_num):
def osd_pool_delete(ceph_api, pool_name): def osd_pool_delete(ceph_api, pool_name):
"""Delete an osd pool """Delete an osd pool
:param pool_name: pool name :param pool_name: pool name
""" """
response, body = ceph_api.osd_pool_delete( response, body = ceph_api.osd_pool_delete(

8
utilities/logmgmt/logmgmt/logmgmt/logmgmt.py
View File

@ -48,9 +48,7 @@ def start_polling():
def handle_exception(exc_type, exc_value, exc_traceback): def handle_exception(exc_type, exc_value, exc_traceback):
""" """Exception handler to log any uncaught exceptions"""
Exception handler to log any uncaught exceptions
"""
logging.error("Uncaught exception", logging.error("Uncaught exception",
exc_info=(exc_type, exc_value, exc_traceback)) exc_info=(exc_type, exc_value, exc_traceback))
sys.__excepthook__(exc_type, exc_value, exc_traceback) sys.__excepthook__(exc_type, exc_value, exc_traceback)
@ -60,9 +58,7 @@ def handle_exception(exc_type, exc_value, exc_traceback):
# CLASSES # CLASSES
################### ###################
class LogMgmtDaemon(): class LogMgmtDaemon():
""" Daemon process representation of """Daemon process representation of the /var/log monitoring program"""
the /var/log monitoring program
"""
def __init__(self): def __init__(self):
# Daemon-specific init # Daemon-specific init
self.stdin_path = '/dev/null' self.stdin_path = '/dev/null'

2
utilities/platform-util/platform-util/platform_util/license/exception.py
View File

@ -6,7 +6,7 @@
class ValidateError(Exception): class ValidateError(Exception):
"""Base class for license validation exceptions.""" """Base class for license validation exceptions"""
def __init__(self, message=None): def __init__(self, message=None):
self.message = message self.message = message