From 1f3bea3081d1e980e8cb3e53281ee517c9557b30 Mon Sep 17 00:00:00 2001 From: Dina Belova Date: Wed, 20 Aug 2014 16:43:14 +0400 Subject: [PATCH] Triple double-quoted strings should be used for docstrings Change-Id: Ie854ca1a468a0e71b7fa96e6606ead36d1c5d1d2 --- ceilometer/dispatcher/database.py | 4 ++-- ceilometer/dispatcher/file.py | 4 ++-- ceilometer/network/statistics/__init__.py | 6 +++--- ceilometer/network/statistics/driver.py | 4 ++-- ceilometer/publisher/__init__.py | 2 +- ceilometer/tests/api/v2/test_alarm_scenarios.py | 3 +-- ceilometer/tests/network/statistics/test_statistics.py | 6 +++--- 7 files changed, 14 insertions(+), 15 deletions(-) diff --git a/ceilometer/dispatcher/database.py b/ceilometer/dispatcher/database.py index 58dbcedf3..7bb13c523 100644 --- a/ceilometer/dispatcher/database.py +++ b/ceilometer/dispatcher/database.py @@ -26,7 +26,7 @@ LOG = log.getLogger(__name__) class DatabaseDispatcher(dispatcher.Base): - '''Dispatcher class for recording metering data into database. + """Dispatcher class for recording metering data into database. The dispatcher class which records each meter into a database configured in ceilometer configuration file. @@ -35,7 +35,7 @@ class DatabaseDispatcher(dispatcher.Base): ceilometer.conf file dispatchers = database - ''' + """ def __init__(self, conf): super(DatabaseDispatcher, self).__init__(conf) self.storage_conn = storage.get_connection_from_config(conf) diff --git a/ceilometer/dispatcher/file.py b/ceilometer/dispatcher/file.py index 57b37e2e2..694f0816a 100644 --- a/ceilometer/dispatcher/file.py +++ b/ceilometer/dispatcher/file.py @@ -38,7 +38,7 @@ cfg.CONF.register_opts(file_dispatcher_opts, group="dispatcher_file") class FileDispatcher(dispatcher.Base): - '''Dispatcher class for recording metering data to a file. + """Dispatcher class for recording metering data to a file. The dispatcher class which logs each meter into a file configured in ceilometer configuration file. An example configuration may look like the @@ -52,7 +52,7 @@ class FileDispatcher(dispatcher.Base): [collector] dispatchers = file - ''' + """ def __init__(self, conf): super(FileDispatcher, self).__init__(conf) diff --git a/ceilometer/network/statistics/__init__.py b/ceilometer/network/statistics/__init__.py index 53ef251d5..76d2dd221 100644 --- a/ceilometer/network/statistics/__init__.py +++ b/ceilometer/network/statistics/__init__.py @@ -32,15 +32,15 @@ class _Base(plugin.CentralPollster): @abc.abstractproperty def meter_name(self): - '''Return a Meter Name.''' + """Return a Meter Name.""" @abc.abstractproperty def meter_type(self): - '''Return a Meter Type.''' + """Return a Meter Type.""" @abc.abstractproperty def meter_unit(self): - '''Return a Meter Unit.''' + """Return a Meter Unit.""" @staticmethod def _parse_my_resource(resource): diff --git a/ceilometer/network/statistics/driver.py b/ceilometer/network/statistics/driver.py index c3b527932..2336c7470 100644 --- a/ceilometer/network/statistics/driver.py +++ b/ceilometer/network/statistics/driver.py @@ -23,7 +23,7 @@ class Driver(): @abc.abstractmethod def get_sample_data(self, meter_name, parse_url, params, cache): - '''Return volume, resource_id, resource_metadata, timestamp in tuple. + """Return volume, resource_id, resource_metadata, timestamp in tuple. If not implemented for meter_name, returns None - ''' + """ diff --git a/ceilometer/publisher/__init__.py b/ceilometer/publisher/__init__.py index a0a7f851d..8fdeaa059 100644 --- a/ceilometer/publisher/__init__.py +++ b/ceilometer/publisher/__init__.py @@ -45,4 +45,4 @@ class PublisherBase(object): @abc.abstractmethod def publish_samples(self, context, samples): - "Publish samples into final conduit." + """Publish samples into final conduit.""" diff --git a/ceilometer/tests/api/v2/test_alarm_scenarios.py b/ceilometer/tests/api/v2/test_alarm_scenarios.py index e0665f867..79408c64b 100644 --- a/ceilometer/tests/api/v2/test_alarm_scenarios.py +++ b/ceilometer/tests/api/v2/test_alarm_scenarios.py @@ -16,8 +16,7 @@ # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the # License for the specific language governing permissions and limitations # under the License. -'''Tests alarm operation -''' +"""Tests alarm operation.""" import datetime import json as jsonutils diff --git a/ceilometer/tests/network/statistics/test_statistics.py b/ceilometer/tests/network/statistics/test_statistics.py index b327bf2ec..a3624c34f 100644 --- a/ceilometer/tests/network/statistics/test_statistics.py +++ b/ceilometer/tests/network/statistics/test_statistics.py @@ -37,19 +37,19 @@ class TestBase(test.BaseTestCase): def test_subclass_ng(self): class NgSubclass1(statistics._Base): - '''meter_name is lost.''' + """meter_name is lost.""" meter_type = sample.TYPE_GAUGE meter_unit = 'B' class NgSubclass2(statistics._Base): - '''meter_type is lost.''' + """meter_type is lost.""" meter_name = 'foo' meter_unit = 'B' class NgSubclass3(statistics._Base): - '''meter_unit is lost.''' + """meter_unit is lost.""" meter_name = 'foo' meter_type = sample.TYPE_GAUGE