2 new revisions:
Revision: b6cc7d214592
Branch: default
Author: Anssi Syrjäsalo
Date: Tue Jun 11 04:48:21 2013
Log: Minor API doc docstrings format unifying...
http://code.google.com/p/robotframework/source/detail?r=b6cc7d214592
Revision: aaed9e7b9866
Branch: default
Author: Anssi Syrjäsalo
Date: Tue Jun 11 04:48:31 2013
Log: Automated merge with https://code.google.com/p/robotframework/
http://code.google.com/p/robotframework/source/detail?r=aaed9e7b9866
==============================================================================
Revision: b6cc7d214592
Branch: default
Author: Anssi Syrjäsalo
Date: Tue Jun 11 04:48:21 2013
Log: Minor API doc docstrings format unifying
Update issue 1468
Went through all the API docstrings and unified their format.
http://code.google.com/p/robotframework/source/detail?r=b6cc7d214592
Modified:
/src/robot/model/keyword.py
/src/robot/model/message.py
/src/robot/model/statistics.py
/src/robot/model/stats.py
/src/robot/model/suitestatistics.py
/src/robot/model/totalstatistics.py
/src/robot/result/keyword.py
/src/robot/result/testcase.py
/src/robot/result/testsuite.py
/src/robot/running/model.py
=======================================
--- /src/robot/model/keyword.py Tue Jun 11 04:28:49 2013
+++ /src/robot/model/keyword.py Tue Jun 11 04:48:21 2013
@@ -20,8 +20,7 @@
class Keyword(ModelObject):
- """Base model for single keyword.
- """
+ """Base model for single keyword."""
__slots__ = ['parent', 'name', 'doc', 'args', 'type', 'timeout']
KEYWORD_TYPE = 'kw'
SETUP_TYPE = 'setup'
@@ -48,8 +47,7 @@
#: Keyword messages, a list of
#: :class:`~robot.model.message.Messages` instances.
self.messages = []
- #: Child keyword results, a list of
- #: :class:`~.Keyword`. instances
+ #: Child keyword results, a list of class:`~.Keyword`. instances
self.keywords = []
@setter
=======================================
--- /src/robot/model/message.py Tue Jun 11 04:28:49 2013
+++ /src/robot/model/message.py Tue Jun 11 04:48:21 2013
@@ -39,10 +39,10 @@
self.timestamp = timestamp
#: The object this message was triggered by.
self.parent = parent
+
@property
def html_message(self):
- """Returns the message content as HTML.
- """
+ """Returns the message content as HTML."""
return self.message if self.html else html_escape(self.message)
def visit(self, visitor):
=======================================
--- /src/robot/model/statistics.py Tue Jun 11 04:28:49 2013
+++ /src/robot/model/statistics.py Tue Jun 11 04:48:21 2013
@@ -35,7 +35,7 @@
suite.visit(StatisticsBuilder(total_builder, suite_builder,
tag_builder))
#: Instance
of :class:`~robot.model.totalstatistics.TotalStatistics`.
self.total = total_builder.stats
- #: Instance
of :class:`~robot.model.suitestatistics.SuiteStatistics`.
+ #: Instance
of :class:`~robot.model.suitestatistics.SuiteStatistics`.
self.suite = suite_builder.stats
#: Instance of :class:`~robot.model.tagstatistics.TagStatistics`.
self.tags = tag_builder.stats
=======================================
--- /src/robot/model/stats.py Tue Jun 11 04:28:49 2013
+++ /src/robot/model/stats.py Tue Jun 11 04:48:21 2013
@@ -18,8 +18,7 @@
class Stat(object):
- """Generic statistic object used for storing all the statistic values.
- """
+ """Generic statistic object used for storing all the statistic
values."""
def __init__(self, name):
#: Human readable identifier of the object these statistics
@@ -90,15 +89,13 @@
class TotalStat(Stat):
- """Stores statistic values for a test run.
- """
+ """Stores statistic values for a test run."""
#: Always string `total`
type = 'total'
class SuiteStat(Stat):
- """Stores statistics values for a single suite.
- """
+ """Stores statistics values for a single suite."""
#: Always string `suite`
type = 'suite'
@@ -123,8 +120,7 @@
class TagStat(Stat):
- """Stores statistic values for a single tag.
- """
+ """Stores statistic values for a single tag."""
#: Always string `tag`.
type = 'tag'
=======================================
--- /src/robot/model/suitestatistics.py Tue Jun 11 04:28:49 2013
+++ /src/robot/model/suitestatistics.py Tue Jun 11 04:48:21 2013
@@ -16,8 +16,7 @@
class SuiteStatistics(object):
- """Container for suite statistics.
- """
+ """Container for suite statistics."""
def __init__(self, suite):
#: Instance of :class:`~robot.model.stats.SuiteStat`.
=======================================
--- /src/robot/model/totalstatistics.py Tue Jun 11 04:28:49 2013
+++ /src/robot/model/totalstatistics.py Tue Jun 11 04:48:21 2013
@@ -17,8 +17,7 @@
class TotalStatistics(object):
- """Container for total statistics.
- """
+ """Container for total statistics."""
def __init__(self):
#: Instance of :class:`~robot.model.stats.TotalStat` for critical
tests.
=======================================
--- /src/robot/result/keyword.py Tue Jun 11 04:28:49 2013
+++ /src/robot/result/keyword.py Tue Jun 11 04:48:21 2013
@@ -18,13 +18,12 @@
class Keyword(model.Keyword):
+ """Results of a single keyword."""
__slots__ = ['status', 'starttime', 'endtime', 'message']
message_class = Message
def __init__(self, name='', doc='', args=(), type='kw', timeout='',
status='FAIL', starttime=None, endtime=None):
- """Results of a single keyword.
- """
model.Keyword.__init__(self, name, doc, args, type, timeout)
#: String 'PASS' of 'FAIL'.
self.status = status
@@ -38,12 +37,10 @@
@property
def elapsedtime(self):
- """Elapsed execution time of the keyword in milliseconds.
- """
+ """Elapsed execution time of the keyword in milliseconds."""
return utils.get_elapsed_time(self.starttime, self.endtime)
@property
def passed(self):
- """``True`` if the keyword did pass, ``False`` otherwise.
- """
+ """``True`` if the keyword did pass, ``False`` otherwise."""
return self.status == 'PASS'
=======================================
--- /src/robot/result/testcase.py Tue Jun 11 04:28:49 2013
+++ /src/robot/result/testcase.py Tue Jun 11 04:48:21 2013
@@ -18,13 +18,12 @@
class TestCase(model.TestCase):
+ """Results of a single test case."""
__slots__ = ['status', 'message', 'starttime', 'endtime']
keyword_class = Keyword
def __init__(self, name='', doc='', tags=None, timeout=None,
status='FAIL',
message='', starttime=None, endtime=None):
- """Results of a single test case.
- """
model.TestCase.__init__(self, name, doc, tags, timeout)
#: String 'PASS' of 'FAIL'.
self.status = status
@@ -37,19 +36,18 @@
@property
def elapsedtime(self):
- """Elapsed execution time of the test case in milliseconds.
- """
+ """Elapsed execution time of the test case in milliseconds."""
return utils.get_elapsed_time(self.starttime, self.endtime)
@property
def passed(self):
- """``True`` if the test case did pass, ``False`` otherwise.
- """
+ """``True`` if the test case did pass, ``False`` otherwise."""
return self.status == 'PASS'
@property
def critical(self):
- """``True`` if the test case is marked as critical, ``False``
otherwise.
+ """``True`` if the test case is marked as critical,
+ ``False`` otherwise.
"""
if not self.parent:
return True
=======================================
--- /src/robot/result/testsuite.py Tue Jun 11 04:28:49 2013
+++ /src/robot/result/testsuite.py Tue Jun 11 04:48:21 2013
@@ -27,14 +27,13 @@
class TestSuite(model.TestSuite):
+ """Result of a single test suite."""
__slots__ = ['message', 'starttime', 'endtime', '_criticality']
test_class = TestCase
keyword_class = Keyword
def __init__(self, name='', doc='', metadata=None, source=None,
message='', starttime=None, endtime=None):
- """Result of a single test suite.
- """
model.TestSuite.__init__(self, name, doc, metadata, source)
#: Suite setup/teardown error message.
self.message = message
@@ -116,9 +115,9 @@
def remove_keywords(self, how):
"""Remove keywords based on the given condition.
- ``how`` is either ``ALL``, ``PASSED``, ``FOR``, or ``WUKS``.
- These values have exact same semantics as values accepted by
- ``--removekeywords`` command line option.
+ :param how: Is either ``ALL``, ``PASSED``, ``FOR``, or ``WUKS``.
+ These values have exact same semantics as values
accepted by
+ ``--removekeywords`` command line option.
"""
self.visit(KeywordRemover(how))
@@ -129,9 +128,9 @@
def configure(self, **options):
"""A shortcut to configure a suite using one method call.
- ``options`` are passed to
- :class:`~robot.result.configurer.SuiteConfigurer` that will then
call
- :meth:`filter`, :meth:`remove_keywords`, etc. based on them.
+ :param options: Passed to
+ :class:`~robot.result.configurer.SuiteConfigurer`
that will then call
+ :meth:`filter`, :meth:`remove_keywords`, etc.
based on them.
Example::
=======================================
--- /src/robot/running/model.py Tue Jun 11 04:28:49 2013
+++ /src/robot/running/model.py Tue Jun 11 04:48:21 2013
@@ -30,12 +30,12 @@
class Keyword(model.Keyword):
+ """Running model for single keyword."""
__slots__ = ['assign']
message_class = None # TODO: Remove from base model?
def __init__(self, name='', args=(), assign=(), type='kw'):
- """Running model for single keyword.
- """
+
model.Keyword.__init__(self, name=name, args=args, type=type)
#: Variables to be assigned.
self.assign = assign
@@ -48,8 +48,7 @@
@property
def keyword(self):
- """ Name of the keyword.
- """
+ """Name of the keyword."""
return self.name
@@ -78,12 +77,11 @@
class TestCase(model.TestCase):
+ """Running model for single test case."""
__slots__ = ['template']
keyword_class = Keyword
def __init__(self, name='', doc='', tags=None, timeout=None,
template=None):
- """Running model for single test case.
- """
model.TestCase.__init__(self, name, doc, tags, timeout)
#: Name of the keyword that has been used as template
#: when building the test. `None` if no is template used.
@@ -91,19 +89,20 @@
@setter
def timeout(self, timeout):
- """Timeout limit of the test case as an instance
of :class:`~.Timeout`
+ """Timeout limit of the test case as an instance of
+ :class:`~.Timeout.
"""
return Timeout(*timeout) if timeout else None
class TestSuite(model.TestSuite):
+ """Running model for single test suite."""
__slots__ = []
test_class = TestCase
keyword_class = Keyword
def __init__(self, name='', doc='', metadata=None, source=None):
- """Running model for single test suite.
- """
+
model.TestSuite.__init__(self, name, doc, metadata, source)
#: Imports the suite contains.
self.imports = []
==============================================================================
Revision: aaed9e7b9866
Branch: default
Author: Anssi Syrjäsalo
Date: Tue Jun 11 04:48:31 2013
Log: Automated merge with https://code.google.com/p/robotframework/
http://code.google.com/p/robotframework/source/detail?r=aaed9e7b9866
--
---
You received this message because you are subscribed to the Google Groups "robotframework-commit" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to robotframework-commit+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.
