Change main to use argsparser (#2952)

* Initial work with argsparse. Must change to __init__

* Change the way to parse arguments with argsparse

Author: HelioGuilherme66

CHANGELOG.adoc

@@ -18,6 +18,7 @@ and this project adheres to http://semver.org/spec/v2.0.0.html[Semantic Versioni
 when selecting in Tree shows the filename in StatusBar.
 
 === Changed
+- Changed arguments parser to allow ``--version`` and ``--help`` functional in Windows
 - Improved auto-complete in Grid Editor, to allow several matches
 - Changed some informative dialogs and JSON Editor to use the customized colors.
 - Modified import statements to allow running RIDE without Robot Framework installed or versions older than 6.0.

README.adoc

@@ -41,7 +41,7 @@ Likewise, the current version of wxPython, is 4.2.3, but RIDE is known to work w
 
 `pip install -U robotframework-ride`
 
-(3.8 <= python <= 3.13) Install current development version (**2.2dev26**) with:
+(3.8 <= python <= 3.13) Install current development version (**2.2dev27**) with:
 
 `pip install -U https://github.com/robotframework/RIDE/archive/develop.zip`
 

src/robotide/__init__.py

@@ -13,41 +13,51 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-"""RIDE -- Robot Framework test data editor
-
-Usage: ride.py [--noupdatecheck] [--debugconsole] [--settingspath <full path|settings filename>] [--version] [inpath]
-
-RIDE can be started either without any arguments or by giving a path to a test
-data file or directory to be opened.
-
-To disable update checker use --noupdatecheck.
-
-To start debug console for RIDE problem debugging use --debugconsole option.
-
-To use different settings use the option --settingspath followed by the path to the settings file or file name.
-
-To see RIDE's version use --version.
-
-RIDE's API is still evolving while the project is moving towards the 1.0
-release. The most stable, and best documented, module is `robotide.pluginapi`.
-"""
-
+import argparse
 import os
 import sys
-from string import Template
 
-errorMessageTemplate = Template("""$reason
-RIDE depends on wx (wxPython). Known versions for Python3 are: 4.0.7.post2, 4.1.1 and 4.2.1.\
-At the time of this release the current wxPython version is 4.2.1.\
+try:
+    from robotide import version
+except ImportError:
+    print("Error getting RIDE version!")
+    sys.exit(1)
+
+errorMessage = """wxPython not found.\n
+RIDE depends on wx (wxPython). Known versions for Python3 are: 4.0.7.post2, 4.1.1 and 4.2.3.\
+At the time of this release the current wxPython version is 4.2.3.\
 You can install with 'pip install wxPython' on most operating systems, or find the \
-the download link from https://wxPython.org/""")
+the download link from https://wxPython.org/"""
+
+if __name__ == '__main__' and 'robotide' not in sys.modules:
+    from pathlib import Path
+    robotide_dir = Path(__file__).absolute().parent  # zipsafe
+    sys.path = [str(robotide_dir.parent)] + [p for p in sys.path if Path(p) != robotide_dir]
+
+parser = argparse.ArgumentParser(prog='ride', description='RIDE is an IDE for Robot Framework test cases and tasks.',
+                    epilog='See information about Robot Framework ecosystem at https://robotframewok.org/',
+                    add_help=False)
+parser.add_argument('inpath', nargs='?', help='Path to a test data file or'
+                                         ' directory to be opened.')
+parser.add_argument('-n', '--noupdatecheck', action='store_true', help='To disable update check.')
+parser.add_argument('-d', '--debugconsole', action='store_true',
+                    help='To start debug console for RIDE problem debugging, and wxPython inspection tool.')
+parser.add_argument('-s', '--settingspath', default=None, help='<full path|settings filename>\n'
+                                                 'To use different settings use the option --settingspath followed by'
+                                                 ' the path to the settings file or file name.')
+parser.add_argument('-v', '--version', action='version', version=f'{version.VERSION}',
+                    help='To see RIDE\'s version.')
+parser.add_argument('-h', '--help', action='help', help='RIDE can be started either without any '
+                                         'arguments or by giving a path to a test data file or'
+                                         ' directory to be opened.')
+# arguments = parser.parse_args()
 
 try:
     import wx
     import wx.lib.inspection
-    from wx import Colour
+    from wx import Colour, Size
 except ModuleNotFoundError:
-    print(errorMessageTemplate.substitute(reason="wxPython not found."))
+    print(errorMessage)
     sys.exit(1)
 
 # Insert bundled robot to path before anything else
@@ -57,47 +67,20 @@
 
 def main(*args):
     _replace_std_for_win()
-    if '--version' in args:
-        try:
-            from . import version
-        except ImportError:
-            print("Error getting RIDE version!")
-            sys.exit(1)
-        print(version.VERSION)
-        sys.exit(0)
-    noupdatecheck, debug_console, settings_path, inpath = _parse_args(args)
-    if len(args) > 3 or '--help' in args:
-        print(__doc__)
-        sys.exit()
+    arguments = parser.parse_args()
+    noupdatecheck = arguments.noupdatecheck
+    debugconsole = arguments.debugconsole
+    settingspath = arguments.settingspath
+    inpath = arguments.inpath  # _parse_args(*args)
+    # print(f"DEBUG: main.py {noupdatecheck=} {debugconsole=} {settingspath=} {inpath=}")
     try:
-        _run(inpath, not noupdatecheck, debug_console, settingspath=settings_path)
+        _run(inpath, not noupdatecheck, debugconsole, settingspath=settingspath)
     except Exception:  # DEBUG
         import traceback
         traceback.print_exception(*sys.exc_info())
         sys.stderr.write('\n\nUse --help to get usage information.\n')
 
 
-def _parse_args(args):
-    if not args:
-        return False, False, None, None
-    arguments = list(args)
-    noupdatecheck = '--noupdatecheck' in arguments
-    if noupdatecheck:
-        arguments.remove('--noupdatecheck')
-    debug_console = '--debugconsole' in arguments
-    if debug_console:
-        arguments.remove('--debugconsole')
-    settings_path = None
-    if '--settingspath' in arguments:
-        arguments.remove('--settingspath')
-        if len(arguments) > 0:
-            settings_path = arguments.pop(0)
-        else:
-            settings_path = None
-    inpath = arguments[0] if arguments else None
-    return noupdatecheck, debug_console, settings_path, inpath
-
-
 def _run(inpath=None, updatecheck=True, debug_console=False, settingspath=None):
     # print(f"DEBUG: ENTER _run {inpath=}, {updatecheck=}, {debug_console=}")
     try:
@@ -158,7 +141,7 @@ def _show_old_wxpython_warning_if_needed(parent=None):
         style = wx.ICON_EXCLAMATION
         if not parent:
             _ = wx.App()
-            parent = wx.Frame(None, size=(0, 0))
+            parent = wx.Frame(None, size=Size(0, 0))
         sys.stderr.write("{0}\n{1}\n".format(title, message))
         dlg = wx.MessageDialog(parent, message=message, caption=title, style=style)
         dlg.ShowModal()

src/robotide/__main__.py

@@ -15,13 +15,6 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-import sys
-
-if __name__ == '__main__' and 'robotide' not in sys.modules:
-    from pathlib import Path
-    robotide_dir = Path(__file__).absolute().parent  # zipsafe
-    sys.path = [str(robotide_dir.parent)] + [p for p in sys.path if Path(p) != robotide_dir]
-
 from robotide import main
 
-main(*sys.argv[1:])
+main()

src/robotide/application/CHANGELOG.html

@@ -14,6 +14,8 @@
 Added divided Status Bar. Left side for main window, right side for Plugins. Working example in Text Editor,
 when selecting in Tree shows the filename in StatusBar.
 </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">
+Changed arguments parser to allow ``--version`` and ``--help`` functional in Windows
+</li><li class="listitem">
 Improved auto-complete in Grid Editor, to allow several matches
 </li><li class="listitem">
 Changed some informative dialogs and JSON Editor to use the customized colors.

src/robotide/application/releasenotes.py

@@ -172,6 +172,7 @@ def set_content(self, html_win, content):
 </ul>
 <p><strong>New Features and Fixes Highlights</strong></p>
 <ul class="simple">
+<li>Changed arguments parser to allow <b>--version</b> and <b>--help</b> functional in Windows.</li>
 <li>Improved auto-complete in Grid Editor, to allow several matches.</li>
 <li>Fixed white blocks on Tree due to failed animation when test execution is too rapid, causing crash on Windows.</li>
 <li>Added Settings Editor button to Preferences dialog, to edit settings.cfg.</li>
@@ -238,7 +239,7 @@ def set_content(self, html_win, content):
 <pre class="literal-block">python -m robotide.postinstall -install</pre>
 <p>or</p>
 <pre class="literal-block">ride_postinstall.py -install</pre>
-<p>RIDE {VERSION} was released on 18/May/2025.</p>
+<p>RIDE {VERSION} was released on 20/May/2025.</p>
 <!-- <br/>
 <h3>May The Fourth Be With You!</h3>
 <h3>Celebrate the bank holiday, 10th June, Day of Portugal, Portuguese Communities and Camões!!</h3>

src/robotide/version.py

@@ -15,4 +15,4 @@
 #
 # Automatically generated by `tasks.py`.
 
-VERSION = 'v2.2dev26'
+VERSION = 'v2.2dev27'

tasks.py

@@ -171,7 +171,9 @@ def devel(ctx, args=''):
     _ = ctx
     _set_development_path()
     from robotide import main
-    main(*args.split(','))
+    main(*args)
+    # from robotide import __main__
+    # __main__(*args) 
 
 
 @task

utest/application/test_app_main.py

@@ -55,32 +55,37 @@ class TestMain(unittest.TestCase):
     def tearDown(self):
         builtins.__import__ = real_import
 
+    @pytest.mark.skip("New main process uses sys.argv")
     def test_main_call_with_extra_args(self):
         from robotide import main
         with pytest.raises(SystemExit):
             main('--noupdatecheck', '--debugconsole', '--version', 'test.robot')
 
+    @pytest.mark.skip("New main process uses sys.argv")
     def test_main_call_with_help(self):
         from robotide import main
         with pytest.raises(SystemExit):
             result = main('--noupdatecheck', '--debugconsole', '--help')
-            assert result.startswith('RIDE')
+            assert result.startswith('usage: ride')
 
+    @pytest.mark.skip("New main process uses sys.argv")
     def test_main_call_with_version(self):
         from robotide import main
         with pytest.raises(SystemExit):
             result = main('--version')
             print(f"DEBUG: Result is {result}")
-            assert result.startswith('v2.0')
+            assert result.startswith('v2.')
 
+    @pytest.mark.skip("New main process uses sys.argv")
     def test_main_call_with_fail_version(self):
         import robotide
-        with MonkeyPatch().context():
+        with (MonkeyPatch().context()):
             with pytest.raises((ImportError, SystemExit)):
                 builtins.__import__ = myimport
                 result = robotide.main('--version')  # Need to capture output
-                assert result.startswith('v2.0.7')
+                assert result.startswith('v2.')
 
+    """
     def test_parse_args(self):
         from robotide import _parse_args
         noupdatecheck, debug_console, settings_path, inpath = _parse_args(args=None)
@@ -98,6 +103,7 @@ def test_parse_args(self):
         noupdatecheck, debug_console, settings_path, inpath = _parse_args(args=('--garbagein', '--garbageout'))
         # returns always first arg
         assert (noupdatecheck, debug_console, settings_path, inpath) == (False, False, None, '--garbagein')
+    """
 
     def test_run_call_with_fail_import(self):
         import robotide.application