robotframework 6.1rc1__zip → 7.0__zip

{robotframework-6.1rc1 → robotframework-7.0}/src/robot/htmldata/rebot/report.css

@@ -1,25 +1,42 @@
+:root {
+    --col-toggle-color: #6c6c6c; /* same as in sort icon */
+}
+
+@media (prefers-color-scheme: dark) {
+    :root {
+        --col-toggle-color: #adadad;
+    }
+}
 /* Generic table styles */
 table {
     margin: 0 1px;
-    background: white;
+    background: white; /* Fallback value */
+    background: var(--background-color);
 }
 tr {
-    background: white;
+    background: white; /* Fallback value */
+    background: var(--background-color);
 }
 th {
-    background: #ddd;
-    color: black;
+    background: #ddd; /* Fallback value */
+    background: var(--primary-color);
+    color: black; /* Fallback value */
+    color: var(--text-color);
 }
 /* Summary and total/tag/suite details */
 .details {
-    border: 1px solid #ccc;
+    border-color: #ccc; /* Fallback value */
+    border-color: var(--secondary-color);
+    border-width: 1px;
+    border-style: solid;
     border-spacing: 0.2em;
     clear: both;
     width: 65em;
     margin-bottom: 1em;
 }
 .details th {
-    background: white;
+    background: white; /* Fallback value */
+    background: var(--background-color);
     width: 11em;
     text-align: left;
     vertical-align: top;
@@ -46,8 +63,30 @@ th {
     display: none;
 }
 /* Search */
+input[type='submit'], input[type='button'] {
+    background-color: #ddd; /* Fallback value */
+    background-color: var(--primary-color);
+    border-radius: 4px;
+    border: 0;
+    padding: 4px 6px 4px 6px;
+    color: black; /* Fallback value */
+    color: var(--text-color);
+}
+input[type='submit']:hover, input[type='button']:hover {
+    background-color: #ccc; /* Fallback value */
+    background-color: var(--secondary-color);
+}
 #search-suite, #search-test, #search-include, #search-exclude {
     width: 25em;
+    background-color: white; /* Fallback value */
+    background-color: var(--background-color);
+    border-color: #ccc; /* Fallback value */
+    border-color: var(--secondary-color);
+    border-width: 2px;
+    border-style: solid;
+    border-radius: 2px;
+    color: black; /* Fallback value */
+    color: var(--text-color);
 }
 #search a:hover {
     text-decoration: none;
@@ -55,8 +94,12 @@ th {
 #search-help div {
     margin: 0.5em 0.5em 0.7em 0;
     padding: 0.7em;
-    background: #eee;
-    border: 1px solid #ccc;
+    background: #eee; /* Fallback value */
+    background: var(--highlight-color);
+    border-color: #ccc; /* Fallback value */
+    border-color: var(--secondary-color);
+    border-width: 1px;
+    border-style: solid;
     border-radius: 3px;
 }
 #search-help h3, #search-help p {
@@ -91,18 +134,24 @@ th {
 }
 .detail-tab {
     float: left;
-    background: #ddd;
-    border: 1px solid #ccc;
+    background: #ddd; /* Fallback value */
+    background: var(--primary-color);
+    border-color: #ccc; /* Fallback value */
+    border-color: var(--secondary-color);
+    border-width: 1px;
+    border-style: solid;
     border-bottom-width: 0;
     margin: 0 0.5em 0 0;
     padding-top: 0.1em;
     border-radius: 3px 3px 0 0;
 }
 .detail-tab:hover {
-    background: #ccc;
+    background: #ccc; /* Fallback value */
+    background: var(--secondary-color);
 }
 .detail-tab a {
-    color: black;
+    color: black; /* Fallback value */
+    color: var(--text-color);
     text-decoration: none;
     font-weight: bold;
     padding: 0 1em;
@@ -110,19 +159,23 @@ th {
 .detail-tab-selected {
     position: relative;
     top: 1px;
-    background: white;
+    background: white; /* Fallback value */
+    background: var(--background-color);
 }
 .detail-tab-selected:hover {
-    background: white;
+    background: white; /* Fallback value */
+    background: var(--background-color);
 }
 /* Test details table */
 #test-details {
     width: 100%;
     border-spacing: 1px;
-    background-color: #ccc;
+    background-color: #ccc; /* Fallback value */
+    background-color: var(--secondary-color);
 }
 #test-details > tbody > tr:hover {
-    background: #f4f4f4;
+    background: #eee; /* Fallback value */
+    background: var(--highlight-color);
     cursor: pointer;
 }
 #test-details th, #test-details td {
@@ -137,11 +190,13 @@ th {
 }
 .details-col-toggle {
     float: left;
-    color: #6c6c6c; /* same as in sort icon */
+    color: #6c6c6c; /* Fallback value */
+    color: var(--col-toggle-color);
     cursor: pointer;
 }
 .details-col-toggle:hover {
-    color: black;
+    color: black; /* Fallback value */
+    color: var(--text-color);
 }
 .details-col-name {
     min-width: 20em;
@@ -182,5 +237,14 @@ th {
     background-image: none;
 }
 th.hidden:hover {
-    background-color: #ccc;
+    background-color: #ddd; /* Fallback value */
+    background-color: var(--primary-color);
+}
+
+#status-bar {
+    height: 100%;
+    width: 10px;
+    position: fixed;
+    top: 0;
+    left: 0;
 }

{robotframework-6.1rc1 → robotframework-7.0}/src/robot/htmldata/rebot/report.html

@@ -25,7 +25,7 @@
 <!-- JS MODEL --><script type="text/javascript" src="../testdata/data.js"></script>
 <title></title>
 </head>
-<body>
+<body data-theme="dark">
 <div id="javascript-disabled">
   <h1>Opening Robot Framework report failed</h1>
   <ul>
@@ -35,13 +35,15 @@
   </ul>
 </div>
 <script type="text/javascript">removeJavaScriptDisabledWarning();</script>
-
+<div id="status-bar"></div>
 <div id="header"></div>
 <div id="statistics-container"></div>
 <div id="test-details-container"></div>
 
 <script type="text/javascript">
 $(document).ready(function () {
+    storage.init();
+    theme.init(storage);
     try {
         var topsuite = window.testdata.suite();
     } catch (error) {
@@ -49,24 +51,37 @@ $(document).ready(function () {
         return;
     }
     window.prevLocationHash = '';
-    setBackground(topsuite);
     initLayout(topsuite.name, 'Report');
-    storage.init('report');
+    setStatusColor(topsuite);
     addSummary(topsuite);
     addStatistics();
     addDetails();
     window.onhashchange = showDetailsByHash;
+    document.addEventListener("theme-change", () => {
+        setStatusColor(topsuite);
+    });
 });
 
-function setBackground(topsuite) {
+function setStatusColor(topsuite) {
     var color;
-    if (topsuite.fail)
+    let fail = Boolean(topsuite.fail);
+    let pass = Boolean(!topsuite.fail && topsuite.pass);
+    let skip = Boolean(!topsuite.fail && !topsuite.pass);
+    if (theme.getPreference() === 'dark') {
+        $('#status-bar').toggleClass("fail-bar", fail);
+        $('#status-bar').toggleClass("pass-bar", pass);
+        $('#status-bar').toggleClass("skip-bar", skip);
+        $('body').css('background-color', "#1c2227");
+        return;
+    }
+    if (fail)
         color = window.settings.background.fail;
-    else if (topsuite.pass)
+    else if (pass)
         color = window.settings.background.pass;
     else
         color = window.settings.background.skip;
     $('body').css('background-color', color);
+    $('#status-bar').toggleClass("fail-bar pass-bar skip-bar", false);
 }
 
 function addSummary(topsuite) {

{robotframework-6.1rc1 → robotframework-7.0}/src/robot/htmldata/rebot/testdata.js

@@ -5,8 +5,9 @@ window.testdata = function () {
     var _statistics = null;
     var LEVELS = ['TRACE', 'DEBUG', 'INFO', 'WARN', 'ERROR', 'FAIL', 'SKIP'];
     var STATUSES = ['FAIL', 'PASS', 'SKIP', 'NOT RUN'];
-    var KEYWORD_TYPES = ['KEYWORD', 'SETUP', 'TEARDOWN', 'FOR', 'ITERATION', 'IF', 'ELSE IF', 'ELSE', 'RETURN',
-                         'TRY', 'EXCEPT', 'FINALLY', 'WHILE', 'CONTINUE', 'BREAK', 'ERROR'];
+    var KEYWORD_TYPES = ['KEYWORD', 'SETUP', 'TEARDOWN', 'FOR', 'ITERATION', 'IF',
+                         'ELSE IF', 'ELSE', 'RETURN', 'VAR', 'TRY', 'EXCEPT', 'FINALLY',
+                         'WHILE', 'CONTINUE', 'BREAK', 'ERROR'];
 
     function addElement(elem) {
         if (!elem.id)
@@ -57,6 +58,7 @@ window.testdata = function () {
     }
 
     function createKeyword(parent, element, strings, index) {
+        var status = element[8];
         var kw = model.Keyword({
             parent: parent,
             type: KEYWORD_TYPES[element[0]],
@@ -72,7 +74,12 @@ window.testdata = function () {
                 this.doc = function () { return doc; };
                 return doc;
             },
-            status: parseStatus(element[8], strings),
+            status: parseStatus(status),
+            message: function () {
+                var msg = status.length == 4 ? strings.get(status[3]) : '';
+                this.message = function () { return msg; };
+                return msg;
+            },
             times: model.Times(times(element[8])),
             isChildrenLoaded: typeof(element[9]) !== 'number'
         });

{robotframework-6.1rc1 → robotframework-7.0}/src/robot/htmldata/rebot/view.js

@@ -1,3 +1,20 @@
+const lightModeIcon = `
+<svg class="light-mode-icon" xmlns="http://www.w3.org/2000/svg" enable-background="new 0 0 24 24"
+    viewBox="0 0 24 24" fill="var(--text-color)">
+    <rect fill="none" height="24" width="24" />
+    <path
+        d="M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0 c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2 c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1 C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06 c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41 l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41 c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36 c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z" />
+</svg>`
+
+const darkModeIcon = `
+<svg class="dark-mode-icon" xmlns="http://www.w3.org/2000/svg" enable-background="new 0 0 24 24"
+    viewBox="0 0 24 24" fill="var(--text-color)">
+    <rect fill="none" height="24" width="24" />
+    <path
+        d="M11.01,3.05C6.51,3.54,3,7.36,3,12c0,4.97,4.03,9,9,9c4.63,0,8.45-3.5,8.95-8c0.09-0.79-0.78-1.42-1.54-0.95 c-0.84,0.54-1.84,0.85-2.91,0.85c-2.98,0-5.4-2.42-5.4-5.4c0-1.06,0.31-2.06,0.84-2.89C12.39,3.94,11.9,2.98,11.01,3.05z" />
+</svg>`
+
+
 function removeJavaScriptDisabledWarning() {
     // Not using jQuery here for maximum speed
     document.getElementById('javascript-disabled').style.display = 'none';
@@ -39,6 +56,10 @@ function setTitle(suiteName, type) {
 function addHeader() {
     var generated = util.timestamp(window.output.generated);
     $.tmpl('<h1>${title}</h1>' +
+           '<button id=theme-toggle>' +
+             lightModeIcon +
+             darkModeIcon +
+           '</button>' +
            '<div id="generated">' +
              '<span>Generated<br>${generated}</span><br>' +
              '<span id="generated-ago">${ago} ago</span>' +
@@ -50,6 +71,7 @@ function addHeader() {
         ago: util.createGeneratedAgoString(generated),
         title: document.title
     }).appendTo($('#header'));
+    document.getElementById('theme-toggle')?.addEventListener('click', theme.onClick);
 }
 
 function addReportOrLogLink(myType) {
@@ -188,3 +210,65 @@ function stopPropagation(event) {
     if (event.stopPropagation)
         event.stopPropagation();
 }
+
+
+const theme = function () {
+
+    const storageKey = 'theme-preference';
+    const urlParams = new URLSearchParams(window.location.search);
+    var storage;
+    var theme;
+
+    function init(givenStorage) {
+        storage = givenStorage;
+        theme = { value: getPreference() };
+        document.body.setAttribute('data-theme', theme.value);
+        reflectPreference();
+
+        window.matchMedia('(prefers-color-scheme: dark)')
+            .addEventListener('change', ({matches:isDark}) => {
+                theme.value = isDark ? 'dark' : 'light';
+                setPreference();
+            });
+
+        window.addEventListener('storage', ({key, newValue}) => {
+            if (key === storage.fullKey(storageKey)) {
+                theme.value = newValue === 'dark' ? 'dark' : 'light';
+                setPreference();
+            }
+        });
+    }
+
+    function getPreference() {
+        if (urlParams.has('theme')) {
+            var urlTheme = urlParams.get('theme') === 'dark' ? 'dark' : 'light';
+            storage.set(storageKey, urlTheme);
+            urlParams.delete('theme');
+            return urlTheme;
+        }
+        if (storage.get(storageKey))
+            return storage.get(storageKey) === 'dark' ? 'dark' : 'light';
+        return window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light';
+    }
+
+    function setPreference() {
+        storage.set(storageKey, theme.value);
+        reflectPreference();
+    }
+
+    function reflectPreference() {
+        document.body.setAttribute('data-theme', theme.value);
+        document.querySelector('#theme-toggle')?.setAttribute('aria-label', theme.value);
+        const event = new Event('theme-change', {value: theme.value});
+        document.dispatchEvent(event);
+    }
+
+    function onClick() {
+        theme.value = theme.value === 'light' ? 'dark' : 'light';
+        document.body.setAttribute('theme-toggled', "");
+        setPreference();
+    }
+
+    return {init: init, getPreference: getPreference, setPreference: setPreference,
+        reflectPreference: reflectPreference, onClick: onClick};
+}();

{robotframework-6.1rc1 → robotframework-7.0}/src/robot/htmldata/template.py

@@ -27,13 +27,13 @@ if sys.version_info < (3, 9) and not Path(__file__).exists():    # zipsafe
     except ImportError:
         raise ImportError(
             "'importlib_resources' backport module needs to be installed with "
-            "Python 3.8 and older when Robot Framework is distributed as a zip "
-            "package or '__file__' does not exist for other reasons."
+            "Python 3.8 when Robot Framework is distributed as a zip package "
+            "or '__file__' does not exist for other reasons."
         )
 else:
     try:
         from importlib.resources import files
-    except ImportError:    # Python 3.8 or older
+    except ImportError:    # Python 3.8
         BASE_DIR = Path(__file__).absolute().parent.parent.parent    # zipsafe
 
         def files(module):

{robotframework-6.1rc1 → robotframework-7.0}/src/robot/libdocpkg/builder.py

@@ -71,14 +71,6 @@ class DocumentationBuilder:
     instead.
     """
 
-    def __init__(self, library_or_resource=None):
-        """`library_or_resource` is accepted for backwards compatibility reasons.
-
-        It is not used for anything internally and passing it to the builder is
-        considered deprecated starting from RF 6.0.1.
-        """
-        pass
-
     def build(self, source):
         # Source can contain arguments separated with `::` so we cannot convert
         # it to Path and instead need to make sure it's a string. It would be

{robotframework-6.1rc1 → robotframework-7.0}/src/robot/libdocpkg/datatypes.py

@@ -47,12 +47,12 @@ class TypeDoc(Sortable):
         return self.name.lower()
 
     @classmethod
-    def for_type(cls, type_hint, converters):
-        if isinstance(type_hint, EnumType):
-            return cls.for_enum(type_hint)
-        if isinstance(type_hint, typeddict_types):
-            return cls.for_typed_dict(type_hint)
-        converter = TypeConverter.converter_for(type_hint, converters)
+    def for_type(cls, type_info, converters):
+        if isinstance(type_info.type, EnumType):
+            return cls.for_enum(type_info.type)
+        if isinstance(type_info.type, typeddict_types):
+            return cls.for_typed_dict(type_info.type)
+        converter = TypeConverter.converter_for(type_info, converters)
         if not converter:
             return None
         elif not converter.type:
@@ -83,15 +83,14 @@ class TypeDoc(Sortable):
         return cls(cls.TYPED_DICT, typed_dict.__name__, getdoc(typed_dict),
                    accepts=(str, 'Mapping'), items=items)
 
-    def to_dictionary(self, legacy=False):
+    def to_dictionary(self):
         data = {
             'type': self.type,
             'name': self.name,
             'doc': self.doc,
+            'usages': self.usages,
+            'accepts': self.accepts
         }
-        if not legacy:
-            data['usages'] = self.usages
-            data['accepts'] = self.accepts
         if self.members is not None:
             data['members'] = [m.to_dictionary() for m in self.members]
         if self.items is not None:

{robotframework-6.1rc1 → robotframework-7.0}/src/robot/libdocpkg/htmlutils.py

@@ -14,10 +14,7 @@
 #  limitations under the License.
 
 import re
-try:
-    from urllib import quote
-except ImportError:
-    from urllib.parse import quote
+from urllib.parse import quote
 
 from robot.errors import DataError
 from robot.utils import html_escape, html_format, NormalizedDict
@@ -97,10 +94,10 @@ class DocToHtml:
                     'HTML': lambda doc: doc,
                     'REST': self._format_rest}[doc_format]
         except KeyError:
-            raise DataError("Invalid documentation format '%s'." % doc_format)
+            raise DataError(f"Invalid documentation format '{doc_format}'.")
 
     def _format_text(self, doc):
-        return '<p style="white-space: pre-wrap">%s</p>' % html_escape(doc)
+        return f'<p style="white-space: pre-wrap">{html_escape(doc)}</p>'
 
     def _format_rest(self, doc):
         try:
@@ -133,7 +130,7 @@ class HtmlToText:
         '&apos;': "'"
     }
 
-    def get_shortdoc_from_html(self, doc):
+    def get_short_doc_from_html(self, doc):
         match = re.search(r'<p.*?>(.*?)</?p>', doc, re.DOTALL)
         if match:
             doc = match.group(1)

{robotframework-6.1rc1 → robotframework-7.0}/src/robot/libdocpkg/jsonbuilder.py

@@ -16,7 +16,7 @@
 import json
 import os.path
 
-from robot.running import ArgInfo
+from robot.running import ArgInfo, TypeInfo
 from robot.errors import DataError
 
 from .datatypes import EnumMember, TypedDictItem, TypeDoc
@@ -57,50 +57,68 @@ class JsonDocBuilder:
     def _create_keyword(self, data):
         kw = KeywordDoc(name=data.get('name'),
                         doc=data['doc'],
-                        shortdoc=data['shortdoc'],
+                        short_doc=data['shortdoc'],
                         tags=data['tags'],
                         private=data.get('private', False),
                         deprecated=data.get('deprecated', False),
                         source=data['source'],
                         lineno=int(data.get('lineno', -1)))
         self._create_arguments(data['args'], kw)
+        self._add_return_type(data.get('returnType'), kw)
         return kw
 
     def _create_arguments(self, arguments, kw: KeywordDoc):
         spec = kw.args
-        setters = {
-            ArgInfo.POSITIONAL_ONLY: spec.positional_only.append,
-            ArgInfo.POSITIONAL_ONLY_MARKER: lambda value: None,
-            ArgInfo.POSITIONAL_OR_NAMED: spec.positional_or_named.append,
-            ArgInfo.VAR_POSITIONAL: lambda value: setattr(spec, 'var_positional', value),
-            ArgInfo.NAMED_ONLY_MARKER: lambda value: None,
-            ArgInfo.NAMED_ONLY: spec.named_only.append,
-            ArgInfo.VAR_NAMED: lambda value: setattr(spec, 'var_named', value),
-        }
+        positional_only = []
+        positional_or_named = []
+        named_only = []
         for arg in arguments:
+            kind = arg['kind']
             name = arg['name']
-            setters[arg['kind']](name)
+            if kind == ArgInfo.POSITIONAL_ONLY:
+                positional_only.append(name)
+            elif kind == ArgInfo.POSITIONAL_OR_NAMED:
+                positional_or_named.append(name)
+            elif kind == ArgInfo.VAR_POSITIONAL:
+                spec.var_positional = name
+            elif kind == ArgInfo.NAMED_ONLY:
+                named_only.append(name)
+            elif kind == ArgInfo.VAR_NAMED:
+                spec.var_named = name
             default = arg.get('defaultValue')
             if default is not None:
                 spec.defaults[name] = default
-            if arg.get('type'):
+            if 'type' in arg:    # RF >= 6.1
                 type_docs = {}
-                type_info = self._parse_modern_type_info(arg['type'], type_docs)
-            else:    # Compatibility with RF < 6.1.
+                type_info = self._parse_type_info(arg['type'], type_docs)
+            else:                # RF < 6.1
                 type_docs = arg.get('typedocs', {})
-                type_info = tuple(arg['types'])
+                type_info = self._parse_legacy_type_info(arg['types'])
             if type_info:
                 if not spec.types:
                     spec.types = {}
                 spec.types[name] = type_info
             kw.type_docs[name] = type_docs
+        spec.positional_only = positional_only
+        spec.positional_or_named = positional_or_named
+        spec.named_only = named_only
 
-    def _parse_modern_type_info(self, data, type_docs):
+    def _parse_type_info(self, data, type_docs):
+        if not data:
+            return None
         if data.get('typedoc'):
             type_docs[data['name']] = data['typedoc']
-        return {'name': data['name'],
-                'nested': [self._parse_modern_type_info(nested, type_docs)
-                           for nested in data.get('nested', ())]}
+        nested = [self._parse_type_info(typ, type_docs) for typ in data.get('nested', ())]
+        return TypeInfo(data['name'], None, nested=nested or None)
+
+    def _parse_legacy_type_info(self, types):
+        return TypeInfo.from_sequence(types) if types else None
+
+    def _add_return_type(self, data, kw: KeywordDoc):
+        if data:
+            type_docs = {}
+            kw.args.return_type = self._parse_type_info(data, type_docs)
+            kw.type_docs['return'] = type_docs
 
     def _parse_type_docs(self, type_docs):
         for data in type_docs: