Improve code (#2592)

HelioGuilherme66 · web-flow · commit 223035616d6f · 2023-05-27T00:43:48.000+01:00
diff --git a/README.adoc b/README.adoc
@@ -32,7 +32,7 @@ Likewise, the current version of wxPython, is 4.2.0, but RIDE is known to work w
 
 `pip install -U robotframework-ride`
 
-Install current development version (**2.0.5**) with:
+Install current development version (**2.0.6dev#**) with:
 
 `pip install -U https://github.com/robotframework/RIDE/archive/master.zip`
 
diff --git a/pytest.ini b/pytest.ini
@@ -0,0 +1,3 @@
+[pytest]
+addopts = -p no:warnings
+
diff --git a/src/robotide/__init__.py b/src/robotide/__init__.py
@@ -35,8 +35,8 @@
 from string import Template
 
 errorMessageTemplate = Template("""$reason
-RIDE depends on wx (wxPython). Historically, the last supported version was 2.8.12.1 with unicode support.\
-At the time of this release the current wxPython version is 4.0.7.post2.\
+RIDE depends on wx (wxPython). Known versions for Python3 are: 4.0.7.post2, 4.1.1 and 4.2.0.\
+At the time of this release the current wxPython version is 4.2.0.\
 You can install with 'pip install wxPython' on most operating systems, or find the \
 the download link from https://wxPython.org/""")
 
@@ -106,13 +106,21 @@ def _run(inpath=None, updatecheck=True, debug_console=False):
 def _replace_std_for_win():
 
     class NullStream:
-        def close(self): pass
+        def close(self):
+            """ Override """
+            pass
 
-        def flush(self): pass
+        def flush(self):
+            """ Override """
+            pass
 
-        def write(self, line): pass
+        def write(self, line):
+            """ Override """
+            pass
 
-        def writelines(self, sequence): pass
+        def writelines(self, sequence):
+            """ Override """
+            pass
 
     if sys.executable.endswith('pythonw.exe'):
         # In windows, when launching RIDE with pythonw.exe
@@ -124,12 +132,12 @@ def writelines(self, sequence): pass
 
 
 def _show_old_wxpython_warning_if_needed(parent=None):
-    if wx.VERSION <=(4, 0, 4, '', ''):
+    if wx.VERSION <= (4, 0, 4, '', ''):
         title = "Please upgrade your wxPython installation"
         message = ("RIDE needs a newer wxPython version. Your current "
                    "version is %s."
                    "\n"
-                   "At the time of this release the current wxPython version is 4.0.7.post2. See "
+                   "At the time of this release the current wxPython version is 4.2.0. See "
                    "https://wxPython.org/ for downloads and instructions."
                    % wx.VERSION_STRING)
         style = wx.ICON_EXCLAMATION
@@ -138,10 +146,6 @@ def _show_old_wxpython_warning_if_needed(parent=None):
             parent = wx.Frame(None, size=(0, 0))
         sys.stderr.write("{0}\n{1}\n".format(title, message))
         dlg = wx.MessageDialog(parent, message=message, caption=title, style=style)
-        """
-        dlg.SetBackgroundColour(Colour(200, 222, 40))
-        dlg.SetForegroundColour(Colour(7, 0, 70))
-        """
         dlg.ShowModal()
 
 
diff --git a/src/robotide/application/CHANGELOG.html b/src/robotide/application/CHANGELOG.html
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" xml:lang="en"/><title>Changelog</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /></head><body><div xml:lang="en" class="article" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idm45173585623536"></a>Changelog</h2></div></div><hr /></div><p>All notable changes to this project will be documented in this file.</p><p>The format is based on <a class="ulink" href="http://keepachangelog.com/en/1.0.0/" target="_top">Keep a Changelog</a>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" xml:lang="en"/><title>Changelog</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /></head><body><div xml:lang="en" class="article" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idm45173585623536"></a>Changelog</h2></div></div><hr /></div><p>All notable changes to this project will be documented in this file.</p><p>The format is based on <a class="ulink" href="http://keepachangelog.com/en/1.0.0/" target="_top">Keep a Changelog</a>
 and this project adheres to <a class="ulink" href="http://semver.org/spec/v2.0.0.html" target="_top">Semantic Versioning</a>.</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_ulink_url_https_github_com_robotframework_ride_unreleased_ulink"></a>1. <a class="ulink" href="https://github.com/robotframework/RIDE" target="_top">Unreleased</a></h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_added"></a>1.1. Added</h3></div></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
 Added boolean parameter ``filter newlines`` to Grid Editor with default ``True``, to hide or show newlines in cells
 </li></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_changed"></a>1.2. Changed</h3></div></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
diff --git a/src/robotide/version.py b/src/robotide/version.py
@@ -14,4 +14,4 @@
 #  limitations under the License.
 #
 # Automatically generated by `tasks.py`.
-VERSION = 'v2.0.6dev2'
+VERSION = 'v2.0.6dev3'
diff --git a/utest/controller/base_command_test.py b/utest/controller/base_command_test.py
@@ -18,6 +18,8 @@
 import pathlib
 import shutil
 import sys
+from robotide.publish import PUBLISHER
+from robotide.publish.messages import RideItemStepsChanged
 
 # Workaround for relative import in non-module
 # see https://stackoverflow.com/questions/16981921/relative-imports-in-python-3
@@ -27,24 +29,20 @@
 sys.path.insert(0, os.path.normpath(os.path.join(SCRIPT_DIR, PACKAGE_PARENT)))
 SCRIPT_DIR = os.path.dirname(pathlib.Path(__file__).parent)
 sys.path.insert(0, SCRIPT_DIR)
-
-from robotide.publish import PUBLISHER
-from robotide.publish.messages import RideItemStepsChanged
-from controller.controller_creator import _FakeProject, testcase_controller, BASE_DATA
+from controller_creator import _FakeProject, testcase_controller, BASE_DATA
 
 
 class TestCaseCommandTest(unittest.TestCase, _FakeProject):
 
     resource_file_controller_factory = None
 
     def setUp(self):
-        # self._steps = None
         self._data = self._create_data()
         self._ctrl = testcase_controller(self, data=self._data)
         PUBLISHER.subscribe(self._test_changed, RideItemStepsChanged)
         self._orig_number_of_steps = len(self._ctrl.steps)
         self._steps = self._ctrl.steps
-        print(f"\nBase Data")
+        print("\nBase Data")
         for row in self._steps:
             print(f"{row.as_list()}")
         print(f"DEBUG: base setup  self._orig_number_of_steps={self._orig_number_of_steps}")
@@ -61,9 +59,6 @@ def _create_data(self):
     def save(self, controller):
         self._file_saved = (controller == self._ctrl.datafile_controller)
 
-    # def tearDown(self):
-    #     PUBLISHER.unsubscribe(self._test_changed, RideItemStepsChanged)
-
     def _get_macros(self):
         return [m for m in self._ctrl._parent]
 
@@ -73,7 +68,8 @@ def _get_macro_by_name(self, name):
     def _data_row(self, line):
         return self._data.index(line) - 1
 
-    def _data_step_as_list(self, step_data):
+    @staticmethod
+    def _data_step_as_list(step_data):
         return step_data.split('  ')[:]
 
     def _exec(self, command):
@@ -86,8 +82,6 @@ def _test_changed(self, message):
     def _verify_step_unchanged(self, step_data):
         row = self._data_row(step_data)
         step = self._steps[row].as_list()
-        # if step and step[0] != '':
-        #    step = [''] + step
         step = [''] + step
         assert step == self._data_step_as_list(step_data)[:]
 
@@ -106,7 +100,9 @@ def _verify_row_does_not_exist(self, line):
     def _verify_step_is_empty(self, index):
         assert self._steps[index].as_list() == []
 
-    def _verify_step(self, index, exp_name, exp_args=[], exp_comment=None, kw=True):
+    def _verify_step(self, index, exp_name, exp_args=None, exp_comment=None, kw=True):
+        if not exp_args:
+            exp_args = []
         if exp_name == '':
             exp_name = []
         else:
@@ -125,4 +121,3 @@ def _verify_step_number_change(self, change):
 
 if __name__ == '__main__':
     unittest.main()
-
diff --git a/utest/controller/test_tags.py b/utest/controller/test_tags.py
@@ -16,6 +16,8 @@
 import os
 import sys
 import unittest
+from robotide.controller.tags import Tag, DefaultTag, ForcedTag
+from robotide.controller.ctrlcommands import ChangeTag
 
 # Workaround for relative import in non-module
 # see https://stackoverflow.com/questions/16981921/relative-imports-in-python-3
@@ -29,9 +31,6 @@
 except ModuleNotFoundError:
     from .controller_creator import testcase_controller
 
-from robotide.controller.tags import Tag, DefaultTag, ForcedTag
-from robotide.controller.ctrlcommands import ChangeTag
-
 
 class Test(unittest.TestCase):
 
@@ -146,6 +145,6 @@ def _tag_with_name_exists(self, name):
     def _tag_with_name_does_not_exists(self, name):
         assert not any(t for t in self.tags if t.name == name)
 
+
 if __name__ == "__main__":
-    #import sys;sys.argv = ['', 'Test.testName']
     unittest.main()
diff --git a/utest/resources/robotdata/datagenerator.py b/utest/resources/robotdata/datagenerator.py
@@ -19,57 +19,56 @@
 from random import randint
 import os
 
-SUITE=\
-"""*** Settings ***
-Resource    resource.robot
-
-*** Test Cases ***
-%TESTCASES%
-
-*** Keywords ***
-Test Keyword
-    Log jee
-"""
-
-RESOURCE=\
-"""*** Variables ***
-@{Resource Var}  MOI
-
-*** Keywords ***
-%KEYWORDS%
-"""
-
-KEYWORD_TEMPLATE=\
-"""My Keyword %KW_ID%
-    No Operation"""
-
-TEST_CASE_TEMPLATE=\
-"""My Test %TEST_ID%
-    My Keyword %KW_ID%
-    Log  moi
+SUITE = \
+    """*** Settings ***
+    Resource    resource.robot
+    
+    *** Test Cases ***
+    %TESTCASES%
+    
+    *** Keywords ***
     Test Keyword
-    Log  moi
-    Test Keyword
-    Log  moi
-    Test Keyword
-    Log  moi
-    Test Keyword
-    Log  moi
-    Test Keyword
-    My Keyword %KW_ID%
-    Test Keyword
-    Log  moi
-    Test Keyword
-    Log  moi
-    Test Keyword
-    Log  moi"""
+        Log jee
+    """
+
+RESOURCE = \
+    """*** Variables ***
+    @{Resource Var}  MOI
+    
+    *** Keywords ***
+    %KEYWORDS%
+    """
+
+KEYWORD_TEMPLATE = \
+    """My Keyword %KW_ID%
+        No Operation"""
+
+TEST_CASE_TEMPLATE = \
+    """My Test %TEST_ID%
+        My Keyword %KW_ID%
+        Log  moi
+        Test Keyword
+        Log  moi
+        Test Keyword
+        Log  moi
+        Test Keyword
+        Log  moi
+        Test Keyword
+        Log  moi
+        Test Keyword
+        My Keyword %KW_ID%
+        Test Keyword
+        Log  moi
+        Test Keyword
+        Log  moi
+        Test Keyword
+        Log  moi"""
 
 
 def generate_tests(number_of_tests, number_of_keywords):
     mytests = range(number_of_tests)
-    return '\n'.join(TEST_CASE_TEMPLATE.replace('%TEST_ID%', str(test_id))\
-                      .replace('%KW_ID%', str(randint(0,number_of_keywords-1)))\
-                      for test_id in mytests)
+    return '\n'.join(TEST_CASE_TEMPLATE.replace('%TEST_ID%', str(test_id))
+                     .replace('%KW_ID%', str(randint(0, number_of_keywords-1))) for test_id in mytests)
 
 
 def generate_keywords(number_of_keywords):
@@ -97,10 +96,10 @@ def generate(directory, suites, tests, keywords):
         return
     mysuites = range(suites)
     for suite_index in mysuites:
-        f = open(os.path.join(safepath, 'suite%s.robot' % suite_index), 'w')
+        f = open(os.path.commonpath(os.path.join(safepath, 'suite%s.robot' % suite_index)), 'w')
         f.write(generate_suite(tests, keywords))
         f.close()
-    r = open(os.path.join(safepath, 'resource.robot'), 'w')
+    r = open(os.path.commonpath(os.path.join(safepath, 'resource.robot')), 'w')
     r.write(generate_resource(keywords))
     r.close()
 
@@ -121,6 +120,7 @@ def main(args):
             print(opts)
         usage()
         sys.exit(2)
+    directory = suites = tests = keywords = None
     for opt, arg in opts:
         if opt == '-d':
             directory = arg
@@ -132,7 +132,7 @@ def main(args):
             keywords = int(arg)
     generate(directory, suites, tests, keywords)
 
+
 if __name__ == '__main__':
     import sys
     main(sys.argv[1:])
-

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+[pytest]`
	`2`	`+addopts = -p no:warnings`
	`3`	`+`
Original file line number	Diff line number	Diff line change
`@@ -14,4 +14,4 @@`
`14`	`14`	`# limitations under the License.`
`15`	`15`	`#`
`16`	`16`	# Automatically generated by `tasks.py`.
`17`		`-VERSION = 'v2.0.6dev2'`
	`17`	`+VERSION = 'v2.0.6dev3'`