robotframework-pabot 4.1.0__py3-none-any.whl → 4.1.1__py3-none-any.whl

pabot/__init__.py

@@ -2,4 +2,4 @@ from __future__ import absolute_import
 
 from .pabotlib import PabotLib
 
-__version__ = "4.1.0"
+__version__ = "4.1.1"

pabot/arguments.py

@@ -79,6 +79,7 @@ def _parse_pabot_args(args):  # type: (List[str]) -> Tuple[List[str], Dict[str,
         "command": ["pybot" if ROBOT_VERSION < "3.1" else "robot"],
         "verbose": False,
         "help": False,
+        "version": False,
         "testlevelsplit": False,
         "pabotlib": True,
         "pabotlibhost": "127.0.0.1",

pabot/pabot.py

@@ -91,6 +91,12 @@ try:
 except ImportError:
     from pipes import quote  # type: ignore
 
+try:
+    import importlib.metadata
+    METADATA_AVAILABLE = True
+except ImportError:
+    METADATA_AVAILABLE = False
+
 from typing import IO, Any, Dict, List, Optional, Tuple, Union
 
 CTRL_C_PRESSED = False
@@ -122,11 +128,63 @@ _ROBOT_EXTENSIONS = [
 ]
 _ALL_ELAPSED = []  # type: List[Union[int, float]]
 
+# Python version check for supporting importlib.metadata (requires Python 3.8+)
+IS_PYTHON_3_8_OR_NEWER = sys.version_info >= (3, 8)
+
+
+def read_args_from_readme():
+    """Reads a specific section from package METADATA or development README.md if available."""
+
+    # 1. Try to read from METADATA (only if available and Python version is compatible)
+    metadata_section = read_from_metadata()
+    if metadata_section:
+        return f"Extracted from METADATA:\n\n{metadata_section}"
+
+    # 2. If METADATA is not available, fall back to development environment README.md
+    dev_readme_path = os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "..", "README.md"))
+    if os.path.exists(dev_readme_path):
+        with open(dev_readme_path, encoding="utf-8") as f:
+            lines = f.readlines()
+            help_args = extract_section(lines)
+            if help_args:
+                return f"Extracted from README.md ({dev_readme_path}):\n\n{help_args}"
+
+    if not IS_PYTHON_3_8_OR_NEWER:
+        return (
+            "Warning: Your Python version is too old and does not support importlib.metadata.\n"
+            "Please consider upgrading to Python 3.8 or newer for better compatibility.\n\n"
+            "To view any possible arguments, please kindly read the README.md here:\n"
+            "https://github.com/mkorpela/pabot"
+        )
+
+    return (
+        "Error: README.md or METADATA long_description not found.\n"
+        "If you believe this is an issue, please report it at:\n"
+        "https://github.com/mkorpela/pabot/issues"
+    )
+
+
+def read_from_metadata():
+    """Reads the long_description section from package METADATA if available."""
+    if not METADATA_AVAILABLE:
+        return None
+
+    try:
+        metadata = importlib.metadata.metadata("robotframework-pabot")
+        description = metadata.get("Description", "")
+
+        if not description:
+            return None
+
+        lines = description.splitlines(True)
+        return extract_section(lines)
+
+    except importlib.metadata.PackageNotFoundError:
+        return None
 
-def extract_section(filename, start_marker, end_marker):
-    with open(filename, "r", encoding="utf-8") as f:
-        lines = f.readlines()
 
+def extract_section(lines, start_marker="<!-- START DOCSTRING -->", end_marker="<!-- END DOCSTRING -->"):
+    """Extracts content between two markers in a list of lines."""
     inside_section = False
     extracted_lines = []
 
@@ -135,10 +193,9 @@ def extract_section(filename, start_marker, end_marker):
             inside_section = True
             continue
         if end_marker in line:
-            inside_section = False
             break
         if inside_section:
-            # Add line from README.md without [] and (https: address)
+            # Remove Markdown links but keep the text
             extracted_lines.append(re.sub(r'\[([^\]]+)\]\(https?://[^\)]+\)', r'\1', line))
 
     return "".join(extracted_lines).strip()
@@ -1913,7 +1970,7 @@ def main_program(args):
         if pabot_args["help"]:
             help_print = __doc__.replace(
                 "PLACEHOLDER_README.MD",
-                extract_section("README.md", "<!-- START DOCSTRING -->", "<!-- END DOCSTRING -->")
+                read_args_from_readme()
                 )
             print(help_print.replace("[PABOT_VERSION]", PABOT_VERSION))
             return 0

robotframework_pabot-4.1.1.dist-info/METADATA

@@ -0,0 +1,314 @@
+Metadata-Version: 2.2
+Name: robotframework-pabot
+Version: 4.1.1
+Summary: Parallel test runner for Robot Framework
+Home-page: https://pabot.org
+Download-URL: https://pypi.python.org/pypi/robotframework-pabot
+Author: Mikko Korpela
+Author-email: mikko.korpela@gmail.com
+License: Apache License, Version 2.0
+Project-URL: Source, https://github.com/mkorpela/pabot
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Testing
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: Robot Framework
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: robotframework>=3.2
+Requires-Dist: robotframework-stacktrace>=0.4.1
+Requires-Dist: natsort>=8.2.0
+Dynamic: download-url
+
+# Pabot
+
+[中文版](README_zh.md)
+
+[![Version](https://img.shields.io/pypi/v/robotframework-pabot.svg)](https://pypi.python.org/pypi/robotframework-pabot)
+[![Downloads](http://pepy.tech/badge/robotframework-pabot)](http://pepy.tech/project/robotframework-pabot)
+
+<img src="https://raw.githubusercontent.com/mkorpela/pabot/master/pabot.png" width="100">
+
+----
+
+A parallel executor for [Robot Framework](http://www.robotframework.org) tests. With Pabot you can split one execution into multiple and save test execution time.
+
+[![Pabot presentation at robocon.io 2018](http://img.youtube.com/vi/i0RV6SJSIn8/0.jpg)](https://youtu.be/i0RV6SJSIn8 "Pabot presentation at robocon.io 2018")
+
+## Installation:
+
+From PyPi:
+
+     pip install -U robotframework-pabot
+
+OR clone this repository and run:
+
+     setup.py  install
+
+OR clone this repository and run:
+
+     pip install --editable .
+
+## Basic use
+
+Split execution to suite files.
+
+     pabot [path to tests]
+
+Split execution on test level.
+
+     pabot --testlevelsplit [path to tests]
+
+Run same tests with two different configurations.
+
+     pabot --argumentfile1 first.args --argumentfile2 second.args [path to tests]
+
+For more complex cases please read onward.
+
+## Contact
+
+Join [Pabot Slack channel](https://robotframework.slack.com/messages/C7HKR2L6L) in Robot Framework slack.
+[Get invite to Robot Framework slack](https://robotframework-slack-invite.herokuapp.com/).
+
+
+## Contributing to the project
+
+There are several ways you can help in improving this tool:
+
+   - Report an issue or an improvement idea to the [issue tracker](https://github.com/mkorpela/pabot/issues)
+   - Contribute by programming and making a pull request (easiest way is to work on an issue from the issue tracker)
+
+## Command-line options
+<!-- START DOCSTRING -->
+pabot [--verbose|--testlevelsplit|--command .. --end-command|
+        --processes num|--no-pabotlib|--pabotlibhost host|--pabotlibport port|
+        --processtimeout num|
+        --shard i/n|
+        --artifacts extensions|--artifactsinsubfolders|
+        --resourcefile file|--argumentfile[num] file|--suitesfrom file|--ordering file
+        --chunk
+        --pabotprerunmodifier modifier
+        --help|--version]
+      [robot options] [path ...]
+
+PabotLib remote server is started by default to enable locking and resource distribution between parallel test executions.
+
+Supports all [Robot Framework command line options](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#all-command-line-options) and also following pabot options:
+
+--verbose     
+  More output from the parallel execution.
+
+--testlevelsplit          
+  Split execution on test level instead of default suite level. If .pabotsuitenames contains both tests and suites then
+  this will only affect new suites and split only them. Leaving this flag out when both suites and tests in 
+  .pabotsuitenames file will also only affect new suites and add them as suite files.
+
+--command [ACTUAL COMMANDS TO START ROBOT EXECUTOR] --end-command    
+  RF script for situations where robot is not used directly.
+
+--processes [NUMBER OF PROCESSES]          
+  How many parallel executors to use (default max of 2 and cpu count). Special option "all" will use as many processes as 
+  there are executable suites or tests.
+
+--no-pabotlib  
+  Disable the PabotLib remote server if you don't need locking or resource distribution features.
+
+--pabotlibhost [HOSTNAME]          
+  Connect to an already running instance of the PabotLib remote server at the given host (disables the local PabotLib 
+  server start). For example, to connect to a remote PabotLib server running on another machine:
+  
+      pabot --pabotlibhost 192.168.1.123 --pabotlibport 8271 tests/
+
+  The remote server can be also started and executed separately from pabot instances:
+  
+      python -m pabot.pabotlib <path_to_resourcefile> <host> <port>
+      python -m pabot.pabotlib resource.txt 192.168.1.123 8271
+  
+  This enables sharing a resource with multiple Robot Framework instances.
+
+--pabotlibport [PORT]          
+  Port number of the PabotLib remote server (default is 8270). See --pabotlibhost for more information.
+
+--processtimeout [TIMEOUT]          
+  Maximum time in seconds to wait for a process before killing it. If not set, there's no timeout.
+
+--shard [INDEX]/[TOTAL]   
+  Optionally split execution into smaller pieces. This can be used for distributing testing to multiple machines.
+  
+--artifacts [FILE EXTENSIONS]   
+  List of file extensions (comma separated). Defines which files (screenshots, videos etc.) from separate reporting 
+  directories would be copied and included in a final report. Possible links to copied files in RF log would be updated 
+  (only relative paths supported). The default value is `png`.
+
+  Examples:
+
+     --artifacts png,mp4,txt
+
+--artifactsinsubfolders   
+  Copy artifacts located not only directly in the RF output dir, but also in it's sub-folders.
+
+--resourcefile [FILEPATH]          
+  Indicator for a file that can contain shared variables for distributing resources. This needs to be used together with 
+  pabotlib option. Resource file syntax is same as Windows ini files. Where a section is a shared set of variables.
+
+--argumentfile [INTEGER] [FILEPATH]          
+  Run same suites with multiple [argumentfile](http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#argument-files) options.
+
+  For example:
+
+     --argumentfile1 arg1.txt --argumentfile2 arg2.txt
+
+--suitesfrom [FILEPATH TO OUTPUTXML]          
+  Optionally read suites from output.xml file. Failed suites will run first and longer running ones will be executed 
+  before shorter ones.
+
+--ordering [FILE PATH]   
+  Optionally give execution order from a file.
+
+--chunk   
+  Optionally chunk tests to PROCESSES number of robot runs. This can save time because all the suites will share the same 
+  setups and teardowns.
+
+--pabotprerunmodifier [PRERUNMODIFIER MODULE OR CLASS]   
+  Like Robot Framework's --prerunmodifier, but executed only once in the pabot's main process after all other 
+  --prerunmodifiers. But unlike the regular --prerunmodifier command, --pabotprerunmodifier is not executed again in each 
+  pabot subprocesses. Depending on the intended use, this may be desirable as well as more efficient. Can be used, for 
+  example, to modify the list of tests to be performed.
+
+ --help             
+ Print usage instructions.
+ 
+ --version                
+ Print version information.
+
+Example usages:
+
+     pabot test_directory
+     pabot --exclude FOO directory_to_tests
+     pabot --command java -jar robotframework.jar --end-command --include SMOKE tests
+     pabot --processes 10 tests     
+     pabot --pabotlibhost 192.168.1.123 --pabotlibport 8271 --processes 10 tests
+     pabot --artifacts png,mp4,txt --artifactsinsubfolders directory_to_tests
+     # To disable PabotLib:
+     pabot --no-pabotlib tests
+
+<!-- END DOCSTRING -->
+### PabotLib
+
+pabot.PabotLib provides keywords that will help communication and data sharing between the executor processes.
+These can be helpful when you must ensure that only one of the processes uses some piece of data or operates on some part of the system under test at a time.
+
+PabotLib Docs are located at https://pabot.org/PabotLib.html.
+
+### PabotLib example:
+
+test.robot
+
+      *** Settings ***
+      Library    pabot.PabotLib
+      
+      *** Test Case ***
+      Testing PabotLib
+        Acquire Lock   MyLock
+        Log   This part is critical section
+        Release Lock   MyLock
+        ${valuesetname}=    Acquire Value Set  admin-server
+        ${host}=   Get Value From Set   host
+        ${username}=     Get Value From Set   username
+        ${password}=     Get Value From Set   password
+        Log   Do something with the values (for example access host with username and password)
+        Release Value Set
+        Log   After value set release others can obtain the variable values
+
+valueset.dat
+
+      [Server1]
+      tags=admin-server
+      HOST=123.123.123.123
+      USERNAME=user1
+      PASSWORD=password1
+      
+      [Server2]
+      tags=server
+      HOST=121.121.121.121
+      USERNAME=user2
+      PASSWORD=password2
+
+      [Server3]
+      tags=admin-server
+      HOST=222.222.222.222
+      USERNAME=user3
+      PASSWORD=password4
+
+
+pabot call using resources from valueset.dat
+
+      pabot --pabotlib --resourcefile valueset.dat test.robot
+
+### Controlling execution order and level of parallelism
+
+.pabotsuitenames file contains the list of suites that will be executed.
+File is created during pabot execution if not already there.
+The file is a cache that pabot uses when re-executing same tests to speed up processing. 
+This file can be partially manually edited but easier option is to use ```--ordering FILENAME```.
+First 4 rows contain information that should not be edited - pabot will edit these when something changes.
+After this come the suite names.
+
+With ```--ordering FILENAME``` you can have a list that controls order also. The syntax is same as .pabotsuitenames file syntax but does not contain 4 hash rows that are present in .pabotsuitenames. 
+
+There different possibilities to influence the execution:
+
+  * The order of suites can be changed.
+  * If a directory (or a directory structure) should be executed sequentially, add the directory suite name to a row as a ```--suite``` option.
+  * If the base suite name is changing with robot option [```--name / -N```](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#setting-the-name) you can also give partial suite name without the base suite.
+  * You can add a line with text `#WAIT` to force executor to wait until all previous suites have been executed.
+  * You can group suites and tests together to same executor process by adding line `{` before the group and `}`after.
+  * You can introduce dependencies using the word `#DEPENDS` after a test declaration. Can be used several times if it is necessary to refer to several different tests. Please take care that in case of circular dependencies an exception will be thrown. An example could be.
+
+```
+--test robotTest.1 Scalar.Test With Environment Variables #DEPENDS robotTest.1 Scalar.Test with BuiltIn Variables of Robot Framework
+--test robotTest.1 Scalar.Test with BuiltIn Variables of Robot Framework
+--test robotTest.2 Lists.Test with Keywords and a list
+#WAIT
+--test robotTest.2 Lists.Test with a Keyword that accepts multiple arguments
+--test robotTest.2 Lists.Test with some Collections keywords
+--test robotTest.2 Lists.Test to access list entries
+--test robotTest.3 Dictionary.Test that accesses Dictionaries
+--test robotTest.3 Dictionary.Dictionaries for named arguments #DEPENDS robotTest.3 Dictionary.Test that accesses Dictionaries
+--test robotTest.1 Scalar.Test Case With Variables #DEPENDS robotTest.3 Dictionary.Test that accesses Dictionaries
+--test robotTest.1 Scalar.Test with Numbers #DEPENDS robotTest.1 Scalar.Test With Arguments and Return Values
+--test robotTest.1 Scalar.Test Case with Return Values #DEPENDS robotTest.1 Scalar.Test with Numbers
+--test robotTest.1 Scalar.Test With Arguments and Return Values
+--test robotTest.3 Dictionary.Test with Dictionaries as Arguments
+--test robotTest.3 Dictionary.Test with FOR loops and Dictionaries #DEPENDS robotTest.1 Scalar.Test Case with Return Values
+```
+
+### Programmatic use
+
+Library offers an endpoint `main_program` that will not call `sys.exit`. This can help in developing your own python program around pabot.
+
+```Python
+import sys
+from pabot.pabot import main_program
+
+def amazing_new_program():
+    print("Before calling pabot")
+    exit_code = main_program(['tests'])
+    print(f"After calling pabot (return code {exit_code})")
+    sys.exit(exit_code)
+
+```
+
+### Global variables
+
+Pabot will insert following global variables to Robot Framework namespace. These are here to enable PabotLib functionality and for custom listeners etc. to get some information on the overall execution of pabot.
+
+      PABOTQUEUEINDEX - this contains a unique index number for the execution. Indexes start from 0.
+      PABOTLIBURI - this contains the URI for the running PabotLib server
+      PABOTEXECUTIONPOOLID - this contains the pool id (an integer) for the current Robot Framework executor. This is helpful for example when visualizing the execution flow from your own listener.
+      PABOTNUMBEROFPROCESSES - max number of concurrent processes that pabot may use in execution.
+      CALLER_ID - a universally unique identifier for this execution.
+ 

{robotframework_pabot-4.1.0.dist-info → robotframework_pabot-4.1.1.dist-info}/RECORD

@@ -1,10 +1,10 @@
 pabot/SharedLibrary.py,sha256=mIipGs3ZhKYEakKprcbrMI4P_Un6qI8gE7086xpHaLY,2552
-pabot/__init__.py,sha256=yBQqfUgp6NEiDxMJ80_JZcdX9DSOJKt_-R-hAiiT23c,94
-pabot/arguments.py,sha256=F0EDLv2qYqmw2_kOSUIyJGGwwRSgEwyQp-uGdoTlAFo,6816
+pabot/__init__.py,sha256=KIz2lUOAX4LIQ5wjdtv4z7UJ4g2DDn7QCTslKSdY4NA,94
+pabot/arguments.py,sha256=XBaWujhuw_5dnZnEwAJcl4mArgzMkjNfNHBty6jqZRo,6842
 pabot/clientwrapper.py,sha256=yz7battGs0exysnDeLDWJuzpb2Q-qSjitwxZMO2TlJw,231
 pabot/coordinatorwrapper.py,sha256=nQQ7IowD6c246y8y9nsx0HZbt8vS2XODhPVDjm-lyi0,195
 pabot/execution_items.py,sha256=qs15SZjGE5CQAO0UpNuVWZ60wTLdWGDK1CkbBz7JtfQ,8892
-pabot/pabot.py,sha256=GBP_LoO5BcvkX5A0Z4BX3fidoD0SGhBzjhQYajkeyf8,68417
+pabot/pabot.py,sha256=WrQsrgUVQZmzmfYLu0m01c2nbyc_Aj-Kz8sTpPo2jC8,70522
 pabot/pabotlib.py,sha256=FRZKaKy1ybyRkE-0SpaCsUWzxZAzNNU5dAywSm1QoPk,22324
 pabot/result_merger.py,sha256=8iIptBn5MdgiW-OdhwVR2DZ0hUYuQeQXwIHAEPkMTuw,9095
 pabot/robotremoteserver.py,sha256=L3O2QRKSGSE4ux5M1ip5XJMaelqaxQWJxd9wLLdtpzM,22272
@@ -14,9 +14,9 @@ pabot/py3/client.py,sha256=Od9L4vZ0sozMHq_W_ITQHBBt8kAej40DG58wnxmbHGM,1434
 pabot/py3/coordinator.py,sha256=kBshCzA_1QX_f0WNk42QBJyDYSwSlNM-UEBxOReOj6E,2313
 pabot/py3/messages.py,sha256=7mFr4_0x1JHm5sW8TvKq28Xs_JoeIGku2bX7AyO0kng,2557
 pabot/py3/worker.py,sha256=5rfp4ZiW6gf8GRz6eC0-KUkfx847A91lVtRYpLAv2sg,1612
-robotframework_pabot-4.1.0.dist-info/LICENSE.txt,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
-robotframework_pabot-4.1.0.dist-info/METADATA,sha256=jP70LRXHbIDdkpV8h0x1H31nh7Gk59qIGc5IdsJmMA4,1019
-robotframework_pabot-4.1.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-robotframework_pabot-4.1.0.dist-info/entry_points.txt,sha256=JpAIFADTeFOQWdwmn56KpAil8V3-41ZC5ICXCYm3Ng0,43
-robotframework_pabot-4.1.0.dist-info/top_level.txt,sha256=t3OwfEAsSxyxrhjy_GCJYHKbV_X6AIsgeLhYeHvObG4,6
-robotframework_pabot-4.1.0.dist-info/RECORD,,
+robotframework_pabot-4.1.1.dist-info/LICENSE.txt,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+robotframework_pabot-4.1.1.dist-info/METADATA,sha256=5cHJ-pp3VvOWIjwvrCbBdcVt2_wtBdZHnBvXlD_x-aw,13484
+robotframework_pabot-4.1.1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+robotframework_pabot-4.1.1.dist-info/entry_points.txt,sha256=JpAIFADTeFOQWdwmn56KpAil8V3-41ZC5ICXCYm3Ng0,43
+robotframework_pabot-4.1.1.dist-info/top_level.txt,sha256=t3OwfEAsSxyxrhjy_GCJYHKbV_X6AIsgeLhYeHvObG4,6
+robotframework_pabot-4.1.1.dist-info/RECORD,,

robotframework_pabot-4.1.0.dist-info/METADATA

@@ -1,25 +0,0 @@
-Metadata-Version: 2.2
-Name: robotframework-pabot
-Version: 4.1.0
-Summary: Parallel test runner for Robot Framework
-Home-page: https://pabot.org
-Download-URL: https://pypi.python.org/pypi/robotframework-pabot
-Author: Mikko Korpela
-Author-email: mikko.korpela@gmail.com
-License: Apache License, Version 2.0
-Project-URL: Source, https://github.com/mkorpela/pabot
-Classifier: Intended Audience :: Developers
-Classifier: Natural Language :: English
-Classifier: Programming Language :: Python :: 3
-Classifier: Topic :: Software Development :: Testing
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Framework :: Robot Framework
-Requires-Python: >=3.6
-License-File: LICENSE.txt
-Requires-Dist: robotframework>=3.2
-Requires-Dist: robotframework-stacktrace>=0.4.1
-Requires-Dist: natsort>=8.2.0
-Dynamic: download-url
-
-A parallel executor for Robot Framework tests. With Pabot you can split one execution into multiple and save test execution time.