automatic import of python-approvaltests

3 files changed, 1051 insertions, 0 deletions

diff --git a/.gitignore b/.gitignore
index e69de29..f1219b5 100644
--- a/.gitignore
+++ b/.gitignore
@@ -0,0 +1 @@
+/approvaltests-8.2.5.tar.gz
diff --git a/python-approvaltests.spec b/python-approvaltests.spec
new file mode 100644
index 0000000..53ca8f6
--- /dev/null
+++ b/python-approvaltests.spec
@@ -0,0 +1,1049 @@
+%global _empty_manifest_terminate_build 0
+Name:		python-approvaltests
+Version:	8.2.5
+Release:	1
+Summary:	Assertion/verification library to aid testing
+License:	Apache Software License
+URL:		https://github.com/approvals/ApprovalTests.Python
+Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/50/af/16032614256ff4d3656feac1955a73dfe1351869a28497a8d9a001fcd3c3/approvaltests-8.2.5.tar.gz
+BuildArch:	noarch
+
+Requires:	python3-pytest
+Requires:	python3-empty-files
+Requires:	python3-typing-extensions
+Requires:	python3-pyperclip
+Requires:	python3-beautifulsoup4
+Requires:	python3-allpairspy
+Requires:	python3-mrjob
+Requires:	python3-approval-utilities
+
+%description
+# ApprovalTests.Python
+
+
+<!-- toc -->
+## Contents
+
+  * [What can I use ApprovalTests for?](#what-can-i-use-approvaltests-for)
+  * [Getting Started](#getting-started)
+    * [New Projects](#new-projects)
+      * [Minimal Example Tutorial](#minimal-example-tutorial)
+    * [Adding to Existing Projects](#adding-to-existing-projects)
+  * [Overview](#overview)
+    * [Example using pytest](#example-using-pytest)
+    * [Example using unittest](#example-using-unittest)
+    * [Example using CLI](#example-using-cli)
+      * [Usage](#usage)
+      * [Argument Definitions](#argument-definitions)
+  * [Reporters](#reporters)
+    * [Selecting a Reporter](#selecting-a-reporter)
+    * [JSON file for collection of reporters](#json-file-for-collection-of-reporters)
+  * [Support and Documentation](#support-and-documentation)
+    * [Missing Documentation?](#missing-documentation)
+    * [Dependencies](#dependencies)
+      * [Required dependencies](#required-dependencies)
+  * [For developers](#for-developers)
+    * [Weekly Ensemble](#weekly-ensemble)
+    * [Pull Requests](#pull-requests)<!-- endToc -->
+
+Capturing Human Intelligence - ApprovalTests is an open source assertion/verification library to aid testing.  
+`approvaltests` is the ApprovalTests port for Python.
+
+For more information see: [www.approvaltests.com](http://approvaltests.com/).
+
+[![PyPI version](https://img.shields.io/pypi/v/approvaltests.svg)](https://pypi.org/project/approvaltests)
+[![Python versions](https://img.shields.io/pypi/pyversions/approvaltests.svg)](https://pypi.org/project/approvaltests)
+[![Build Status](https://github.com/approvals/ApprovalTests.Python/workflows/Test/badge.svg?branch=master)](https://github.com/approvals/ApprovalTests.Python/actions)
+[![Build Status](https://github.com/approvals/ApprovalTests.Python/workflows/on-push-do-doco/badge.svg)](https://github.com/approvals/ApprovalTests.Python/actions?query=workflow%3Aon-push-do-doco)
+[![Build Status](https://github.com/approvals/ApprovalTests.Python/workflows/Upload%20Python%20Package/badge.svg)](https://github.com/approvals/ApprovalTests.Python/actions?query=workflow%3A%22Upload+Python+Package%22)
+
+
+## What can I use ApprovalTests for?
+
+You can use ApprovalTests to verify objects that require more than a simple assert including long strings, large arrays, 
+and complex hash structures and objects.  ApprovalTests really shines when you need a more granular look at the test 
+failure.  Sometimes, trying to find a small difference in a long string printed to STDOUT is just too hard!  
+ApprovalTests solves this problem by providing reporters which let you view the test results in one of many popular diff 
+utilities.
+
+
+## Getting Started
+
+### New Projects
+
+If you are starting a new project, we suggest you use the [Starter Project](https://github.com/approvals/ApprovalTests.Python.StarterProject).
+You can just clone this and go. It's great for exercises, katas, and green field projects.
+
+#### Minimal Example Tutorial
+
+If this is first time approvaltesting in python, consider starting here: [Minimal Example Tutorial](docs/tutorial/minimal-example.md)
+
+###  Adding to Existing Projects 
+
+From [pypi](https://pypi.org/project/approvaltests/):
+
+	pip install approvaltests
+
+## Overview
+
+Approvals work by comparing the test results to a golden master.  If no golden master exists you can create a snapshot 
+of the current test results and use that as the golden master.  The reporter helps you manage the golden master.  
+Whenever your current results differ from the golden master, Approvals will launch an external application for you to 
+examine the differences.  Either you will update the master because you expected the changes and they are good,
+or you will go back to your code and update or roll back your changes to get your results back in line with the 
+golden master.
+
+
+### Example using pytest
+
+<!-- snippet: getting_started_with_pytest.py -->
+<a id='snippet-getting_started_with_pytest.py'></a>
+```py
+from approvaltests.approvals import verify
+
+
+def test_simple():
+    result = "Hello ApprovalTests"
+    verify(result)
+```
+<sup><a href='/tests/examples/getting_started_with_pytest.py#L1-L6' title='Snippet source file'>snippet source</a> | <a href='#snippet-getting_started_with_pytest.py' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->
+
+Install the plugin pytest-approvaltests and use it to select a reporter:
+
+    pip install pytest-approvaltests
+    pytest --approvaltests-use-reporter='PythonNative'
+
+The reporter is used both to alert you to changes in your test output, and to provide a tool to update the golden 
+master. In this snippet, we chose the 'PythonNative' reporter when we ran the tests. For more information about selecting
+reporters see [the documentation](https://github.com/approvals/ApprovalTests.Python.PytestPlugin)
+
+
+### Example using unittest
+
+<!-- snippet: getting_started_with_unittest.py -->
+<a id='snippet-getting_started_with_unittest.py'></a>
+```py
+import unittest
+
+from approvaltests.approvals import verify
+
+
+class GettingStartedTest(unittest.TestCase):
+    def test_simple(self):
+        verify("Hello ApprovalTests")
+
+
+if __name__ == "__main__":
+    unittest.main()
+```
+<sup><a href='/tests/examples/getting_started_with_unittest.py#L1-L12' title='Snippet source file'>snippet source</a> | <a href='#snippet-getting_started_with_unittest.py' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->
+
+This example has the same behaviour as the pytest version, but uses the built-in test framework `unittest` instead.
+
+### Example using CLI
+
+You can invoke a verify() call from the command line. This allows invoking python approvals from any other stack via subprocesses.
+
+#### Usage
+
+```
+python -m approvaltests --test-id hello --received "hello world!"
+```
+or
+```
+python -m approvaltests -t hello -r "hello world!"
+```
+
+or 
+
+```
+echo "hello world!" | python -m approvaltests -t hello
+```
+
+#### Argument Definitions
+
+- __`--test-id`__ or __`-t`__: Test identifier used to name the `approved.txt` and `received.txt` files for the test.
+
+- __`--received`__ or __`-r`__: The output of the program under test (a string) that is passed to the verify method.
+
+  - __`stdin`__: Instead of providing a `received` argument, you may use `stdin`.
+
+
+## Reporters
+
+### Selecting a Reporter
+
+All verify functions take an optional `options` parameter that can configure reporters (as well as many other aspects).
+
+ApprovalTests.Python comes with a few reporters configured, supporting Linux, Mac OSX, and Windows.
+
+In the example shown below, we pass in an options with a reporter we're selecting directly:
+
+<!-- snippet: select_reporter_from_class -->
+<a id='snippet-select_reporter_from_class'></a>
+```py
+class TestSelectReporterFromClass(unittest.TestCase):
+    def test_simple(self):
+        verify("Hello", options=Options().with_reporter(report_with_beyond_compare()))
+```
+<sup><a href='/tests/samples/test_getting_started.py#L25-L31' title='Snippet source file'>snippet source</a> | <a href='#snippet-select_reporter_from_class' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->
+
+You can also use the `GenericDiffReporterFactory` to find and select the first diff utility that exists on our system.
+
+An advantage of this method is you can modify the reporters.json file directly to handle your unique system.
+
+<!-- snippet: select_reporter_from_factory -->
+<a id='snippet-select_reporter_from_factory'></a>
+```py
+class TestSelectReporter(unittest.TestCase):
+    def setUp(self):
+        self.factory = GenericDiffReporterFactory()
+
+    def test_simple(self):
+        verify(
+            "Hello", options=Options().with_reporter(self.factory.get("BeyondCompare"))
+        )
+```
+<sup><a href='/tests/samples/test_getting_started.py#L11-L22' title='Snippet source file'>snippet source</a> | <a href='#snippet-select_reporter_from_factory' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->
+
+
+
+Or you can build your own GenericDiffReporter on the fly
+
+<!-- snippet: custom_generic_diff_reporter -->
+<a id='snippet-custom_generic_diff_reporter'></a>
+```py
+class GettingStartedTest(unittest.TestCase):
+    def test_simple(self):
+        verify(
+            "Hello",
+            options=Options().with_reporter(
+                GenericDiffReporter.create(r"C:\my\favorite\diff\utility.exe")
+            ),
+        )
+```
+<sup><a href='/tests/samples/test_getting_started.py#L34-L45' title='Snippet source file'>snippet source</a> | <a href='#snippet-custom_generic_diff_reporter' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->
+
+As long as `C:/my/favorite/diff/utility.exe` can be invoked from the command line using the format `utility.exe file1 file2` 
+then it will be compatible with GenericDiffReporter.  Otherwise you will have to derive your own reporter, which 
+we won't cover here.
+
+### JSON file for collection of reporters
+
+To wrap things up, I should note that you can completely replace the collection of reporters known to the reporter 
+factory by writing your own JSON file and loading it.
+
+For example if you had `C:/myreporters.json`
+
+```json
+[
+    [
+        "BeyondCompare4",
+        "C:/Program Files (x86)/Beyond Compare 4/BCompare.exe"
+    ],
+    [
+        "WinMerge",
+        "C:/Program Files (x86)/WinMerge/WinMergeU.exe"
+    ],
+    [
+        "Tortoise",
+        "C:/Program Files (x86)/TortoiseSVN/bin/tortoisemerge.exe"
+    ]
+]
+```
+
+You could then use that file by loading it into the factory:
+
+```python
+
+import unittest
+
+from approvaltests.approvals import verify
+from approvaltests.reporters.generic_diff_reporter_factory import GenericDiffReporterFactory
+
+
+class GettingStartedTest(unittest.TestCase):
+    def setUp(self):
+        factory = GenericDiffReporterFactory()
+        factory.load('C:/myreporters.json')
+        self.reporter = factory.get_first_working()
+
+    def test_simple(self):
+        verify('Hello', self.reporter)
+
+if __name__ == "__main__":
+    unittest.main()
+```
+
+Of course, if you have some interesting new reporters in `myreporters.json` then please consider updating the 
+`reporters.json` file that ships with Approvals and submitting a pull request.
+
+## Support and Documentation
+
+* [Documentation](/docs/README.md)
+
+* GitHub: [https://github.com/approvals/ApprovalTests.Python](https://github.com/approvals/ApprovalTests.Python)
+
+* ApprovalTests Homepage: [http://www.approvaltests.com](http://www.approvaltests.com)
+
+### Missing Documentation?
+If there is documentation you wish existed, please add a `page request` to [this issue](https://github.com/approvals/ApprovalTests.Python/issues/135).
+
+
+### Dependencies
+
+ApprovalTests require Python 3.7 or greater and the following dependencies:
+#### Required dependencies
+These dependencies are always required for approvaltests
+<!-- snippet: requirements.prod.required.txt -->
+<a id='snippet-requirements.prod.required.txt'></a>
+```txt
+pytest>=4.0.0
+empty-files>=0.0.3
+typing_extensions>=3.6.2
+```
+<sup><a href='/requirements.prod.required.txt#L1-L5' title='Snippet source file'>snippet source</a> | <a href='#snippet-requirements.prod.required.txt' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->
+#### Extra dependencies
+These dependencies are required if you are going to use the related functionality
+If you want the bare minimum you can use the pypi project 
+[approvaltests-minimal](https://pypi.org/project/approvaltests-minimal/) 
+
+<!-- snippet: requirements.prod.extras.txt -->
+<a id='snippet-requirements.prod.extras.txt'></a>
+```txt
+pyperclip>=1.5.29     # For Clipboard Reporter
+beautifulsoup4>=4.4.0 # For verify_html
+allpairspy>=2.1.0     # For PairwiseCombinations
+mrjob>=0.7.4          # For MrJob
+```
+<sup><a href='/requirements.prod.extras.txt#L1-L4' title='Snippet source file'>snippet source</a> | <a href='#snippet-requirements.prod.extras.txt' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->
+
+## For developers
+### Weekly Ensemble
+
+The best way to contribute is to [join our weekly mob/ensemble](./docs/Contribute.md)
+
+### Pull Requests
+Pull requests are welcomed, particularly those accompanied by automated tests.
+
+To run the self-tests, install pytest and tox, then execute
+
+    python -m tox
+
+This will run the self-tests on several python versions. We support python 3.7 and above. 
+
+All pull requests will be pre-checked using GitHub actions to execute all these tests. You can see the [results of test
+runs here](https://github.com/approvals/ApprovalTests.Python/actions).
+
+
+%package -n python3-approvaltests
+Summary:	Assertion/verification library to aid testing
+Provides:	python-approvaltests
+BuildRequires:	python3-devel
+BuildRequires:	python3-setuptools
+BuildRequires:	python3-pip
+%description -n python3-approvaltests
+# ApprovalTests.Python
+
+
+<!-- toc -->
+## Contents
+
+  * [What can I use ApprovalTests for?](#what-can-i-use-approvaltests-for)
+  * [Getting Started](#getting-started)
+    * [New Projects](#new-projects)
+      * [Minimal Example Tutorial](#minimal-example-tutorial)
+    * [Adding to Existing Projects](#adding-to-existing-projects)
+  * [Overview](#overview)
+    * [Example using pytest](#example-using-pytest)
+    * [Example using unittest](#example-using-unittest)
+    * [Example using CLI](#example-using-cli)
+      * [Usage](#usage)
+      * [Argument Definitions](#argument-definitions)
+  * [Reporters](#reporters)
+    * [Selecting a Reporter](#selecting-a-reporter)
+    * [JSON file for collection of reporters](#json-file-for-collection-of-reporters)
+  * [Support and Documentation](#support-and-documentation)
+    * [Missing Documentation?](#missing-documentation)
+    * [Dependencies](#dependencies)
+      * [Required dependencies](#required-dependencies)
+  * [For developers](#for-developers)
+    * [Weekly Ensemble](#weekly-ensemble)
+    * [Pull Requests](#pull-requests)<!-- endToc -->
+
+Capturing Human Intelligence - ApprovalTests is an open source assertion/verification library to aid testing.  
+`approvaltests` is the ApprovalTests port for Python.
+
+For more information see: [www.approvaltests.com](http://approvaltests.com/).
+
+[![PyPI version](https://img.shields.io/pypi/v/approvaltests.svg)](https://pypi.org/project/approvaltests)
+[![Python versions](https://img.shields.io/pypi/pyversions/approvaltests.svg)](https://pypi.org/project/approvaltests)
+[![Build Status](https://github.com/approvals/ApprovalTests.Python/workflows/Test/badge.svg?branch=master)](https://github.com/approvals/ApprovalTests.Python/actions)
+[![Build Status](https://github.com/approvals/ApprovalTests.Python/workflows/on-push-do-doco/badge.svg)](https://github.com/approvals/ApprovalTests.Python/actions?query=workflow%3Aon-push-do-doco)
+[![Build Status](https://github.com/approvals/ApprovalTests.Python/workflows/Upload%20Python%20Package/badge.svg)](https://github.com/approvals/ApprovalTests.Python/actions?query=workflow%3A%22Upload+Python+Package%22)
+
+
+## What can I use ApprovalTests for?
+
+You can use ApprovalTests to verify objects that require more than a simple assert including long strings, large arrays, 
+and complex hash structures and objects.  ApprovalTests really shines when you need a more granular look at the test 
+failure.  Sometimes, trying to find a small difference in a long string printed to STDOUT is just too hard!  
+ApprovalTests solves this problem by providing reporters which let you view the test results in one of many popular diff 
+utilities.
+
+
+## Getting Started
+
+### New Projects
+
+If you are starting a new project, we suggest you use the [Starter Project](https://github.com/approvals/ApprovalTests.Python.StarterProject).
+You can just clone this and go. It's great for exercises, katas, and green field projects.
+
+#### Minimal Example Tutorial
+
+If this is first time approvaltesting in python, consider starting here: [Minimal Example Tutorial](docs/tutorial/minimal-example.md)
+
+###  Adding to Existing Projects 
+
+From [pypi](https://pypi.org/project/approvaltests/):
+
+	pip install approvaltests
+
+## Overview
+
+Approvals work by comparing the test results to a golden master.  If no golden master exists you can create a snapshot 
+of the current test results and use that as the golden master.  The reporter helps you manage the golden master.  
+Whenever your current results differ from the golden master, Approvals will launch an external application for you to 
+examine the differences.  Either you will update the master because you expected the changes and they are good,
+or you will go back to your code and update or roll back your changes to get your results back in line with the 
+golden master.
+
+
+### Example using pytest
+
+<!-- snippet: getting_started_with_pytest.py -->
+<a id='snippet-getting_started_with_pytest.py'></a>
+```py
+from approvaltests.approvals import verify
+
+
+def test_simple():
+    result = "Hello ApprovalTests"
+    verify(result)
+```
+<sup><a href='/tests/examples/getting_started_with_pytest.py#L1-L6' title='Snippet source file'>snippet source</a> | <a href='#snippet-getting_started_with_pytest.py' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->
+
+Install the plugin pytest-approvaltests and use it to select a reporter:
+
+    pip install pytest-approvaltests
+    pytest --approvaltests-use-reporter='PythonNative'
+
+The reporter is used both to alert you to changes in your test output, and to provide a tool to update the golden 
+master. In this snippet, we chose the 'PythonNative' reporter when we ran the tests. For more information about selecting
+reporters see [the documentation](https://github.com/approvals/ApprovalTests.Python.PytestPlugin)
+
+
+### Example using unittest
+
+<!-- snippet: getting_started_with_unittest.py -->
+<a id='snippet-getting_started_with_unittest.py'></a>
+```py
+import unittest
+
+from approvaltests.approvals import verify
+
+
+class GettingStartedTest(unittest.TestCase):
+    def test_simple(self):
+        verify("Hello ApprovalTests")
+
+
+if __name__ == "__main__":
+    unittest.main()
+```
+<sup><a href='/tests/examples/getting_started_with_unittest.py#L1-L12' title='Snippet source file'>snippet source</a> | <a href='#snippet-getting_started_with_unittest.py' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->
+
+This example has the same behaviour as the pytest version, but uses the built-in test framework `unittest` instead.
+
+### Example using CLI
+
+You can invoke a verify() call from the command line. This allows invoking python approvals from any other stack via subprocesses.
+
+#### Usage
+
+```
+python -m approvaltests --test-id hello --received "hello world!"
+```
+or
+```
+python -m approvaltests -t hello -r "hello world!"
+```
+
+or 
+
+```
+echo "hello world!" | python -m approvaltests -t hello
+```
+
+#### Argument Definitions
+
+- __`--test-id`__ or __`-t`__: Test identifier used to name the `approved.txt` and `received.txt` files for the test.
+
+- __`--received`__ or __`-r`__: The output of the program under test (a string) that is passed to the verify method.
+
+  - __`stdin`__: Instead of providing a `received` argument, you may use `stdin`.
+
+
+## Reporters
+
+### Selecting a Reporter
+
+All verify functions take an optional `options` parameter that can configure reporters (as well as many other aspects).
+
+ApprovalTests.Python comes with a few reporters configured, supporting Linux, Mac OSX, and Windows.
+
+In the example shown below, we pass in an options with a reporter we're selecting directly:
+
+<!-- snippet: select_reporter_from_class -->
+<a id='snippet-select_reporter_from_class'></a>
+```py
+class TestSelectReporterFromClass(unittest.TestCase):
+    def test_simple(self):
+        verify("Hello", options=Options().with_reporter(report_with_beyond_compare()))
+```
+<sup><a href='/tests/samples/test_getting_started.py#L25-L31' title='Snippet source file'>snippet source</a> | <a href='#snippet-select_reporter_from_class' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->
+
+You can also use the `GenericDiffReporterFactory` to find and select the first diff utility that exists on our system.
+
+An advantage of this method is you can modify the reporters.json file directly to handle your unique system.
+
+<!-- snippet: select_reporter_from_factory -->
+<a id='snippet-select_reporter_from_factory'></a>
+```py
+class TestSelectReporter(unittest.TestCase):
+    def setUp(self):
+        self.factory = GenericDiffReporterFactory()
+
+    def test_simple(self):
+        verify(
+            "Hello", options=Options().with_reporter(self.factory.get("BeyondCompare"))
+        )
+```
+<sup><a href='/tests/samples/test_getting_started.py#L11-L22' title='Snippet source file'>snippet source</a> | <a href='#snippet-select_reporter_from_factory' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->
+
+
+
+Or you can build your own GenericDiffReporter on the fly
+
+<!-- snippet: custom_generic_diff_reporter -->
+<a id='snippet-custom_generic_diff_reporter'></a>
+```py
+class GettingStartedTest(unittest.TestCase):
+    def test_simple(self):
+        verify(
+            "Hello",
+            options=Options().with_reporter(
+                GenericDiffReporter.create(r"C:\my\favorite\diff\utility.exe")
+            ),
+        )
+```
+<sup><a href='/tests/samples/test_getting_started.py#L34-L45' title='Snippet source file'>snippet source</a> | <a href='#snippet-custom_generic_diff_reporter' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->
+
+As long as `C:/my/favorite/diff/utility.exe` can be invoked from the command line using the format `utility.exe file1 file2` 
+then it will be compatible with GenericDiffReporter.  Otherwise you will have to derive your own reporter, which 
+we won't cover here.
+
+### JSON file for collection of reporters
+
+To wrap things up, I should note that you can completely replace the collection of reporters known to the reporter 
+factory by writing your own JSON file and loading it.
+
+For example if you had `C:/myreporters.json`
+
+```json
+[
+    [
+        "BeyondCompare4",
+        "C:/Program Files (x86)/Beyond Compare 4/BCompare.exe"
+    ],
+    [
+        "WinMerge",
+        "C:/Program Files (x86)/WinMerge/WinMergeU.exe"
+    ],
+    [
+        "Tortoise",
+        "C:/Program Files (x86)/TortoiseSVN/bin/tortoisemerge.exe"
+    ]
+]
+```
+
+You could then use that file by loading it into the factory:
+
+```python
+
+import unittest
+
+from approvaltests.approvals import verify
+from approvaltests.reporters.generic_diff_reporter_factory import GenericDiffReporterFactory
+
+
+class GettingStartedTest(unittest.TestCase):
+    def setUp(self):
+        factory = GenericDiffReporterFactory()
+        factory.load('C:/myreporters.json')
+        self.reporter = factory.get_first_working()
+
+    def test_simple(self):
+        verify('Hello', self.reporter)
+
+if __name__ == "__main__":
+    unittest.main()
+```
+
+Of course, if you have some interesting new reporters in `myreporters.json` then please consider updating the 
+`reporters.json` file that ships with Approvals and submitting a pull request.
+
+## Support and Documentation
+
+* [Documentation](/docs/README.md)
+
+* GitHub: [https://github.com/approvals/ApprovalTests.Python](https://github.com/approvals/ApprovalTests.Python)
+
+* ApprovalTests Homepage: [http://www.approvaltests.com](http://www.approvaltests.com)
+
+### Missing Documentation?
+If there is documentation you wish existed, please add a `page request` to [this issue](https://github.com/approvals/ApprovalTests.Python/issues/135).
+
+
+### Dependencies
+
+ApprovalTests require Python 3.7 or greater and the following dependencies:
+#### Required dependencies
+These dependencies are always required for approvaltests
+<!-- snippet: requirements.prod.required.txt -->
+<a id='snippet-requirements.prod.required.txt'></a>
+```txt
+pytest>=4.0.0
+empty-files>=0.0.3
+typing_extensions>=3.6.2
+```
+<sup><a href='/requirements.prod.required.txt#L1-L5' title='Snippet source file'>snippet source</a> | <a href='#snippet-requirements.prod.required.txt' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->
+#### Extra dependencies
+These dependencies are required if you are going to use the related functionality
+If you want the bare minimum you can use the pypi project 
+[approvaltests-minimal](https://pypi.org/project/approvaltests-minimal/) 
+
+<!-- snippet: requirements.prod.extras.txt -->
+<a id='snippet-requirements.prod.extras.txt'></a>
+```txt
+pyperclip>=1.5.29     # For Clipboard Reporter
+beautifulsoup4>=4.4.0 # For verify_html
+allpairspy>=2.1.0     # For PairwiseCombinations
+mrjob>=0.7.4          # For MrJob
+```
+<sup><a href='/requirements.prod.extras.txt#L1-L4' title='Snippet source file'>snippet source</a> | <a href='#snippet-requirements.prod.extras.txt' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->
+
+## For developers
+### Weekly Ensemble
+
+The best way to contribute is to [join our weekly mob/ensemble](./docs/Contribute.md)
+
+### Pull Requests
+Pull requests are welcomed, particularly those accompanied by automated tests.
+
+To run the self-tests, install pytest and tox, then execute
+
+    python -m tox
+
+This will run the self-tests on several python versions. We support python 3.7 and above. 
+
+All pull requests will be pre-checked using GitHub actions to execute all these tests. You can see the [results of test
+runs here](https://github.com/approvals/ApprovalTests.Python/actions).
+
+
+%package help
+Summary:	Development documents and examples for approvaltests
+Provides:	python3-approvaltests-doc
+%description help
+# ApprovalTests.Python
+
+
+<!-- toc -->
+## Contents
+
+  * [What can I use ApprovalTests for?](#what-can-i-use-approvaltests-for)
+  * [Getting Started](#getting-started)
+    * [New Projects](#new-projects)
+      * [Minimal Example Tutorial](#minimal-example-tutorial)
+    * [Adding to Existing Projects](#adding-to-existing-projects)
+  * [Overview](#overview)
+    * [Example using pytest](#example-using-pytest)
+    * [Example using unittest](#example-using-unittest)
+    * [Example using CLI](#example-using-cli)
+      * [Usage](#usage)
+      * [Argument Definitions](#argument-definitions)
+  * [Reporters](#reporters)
+    * [Selecting a Reporter](#selecting-a-reporter)
+    * [JSON file for collection of reporters](#json-file-for-collection-of-reporters)
+  * [Support and Documentation](#support-and-documentation)
+    * [Missing Documentation?](#missing-documentation)
+    * [Dependencies](#dependencies)
+      * [Required dependencies](#required-dependencies)
+  * [For developers](#for-developers)
+    * [Weekly Ensemble](#weekly-ensemble)
+    * [Pull Requests](#pull-requests)<!-- endToc -->
+
+Capturing Human Intelligence - ApprovalTests is an open source assertion/verification library to aid testing.  
+`approvaltests` is the ApprovalTests port for Python.
+
+For more information see: [www.approvaltests.com](http://approvaltests.com/).
+
+[![PyPI version](https://img.shields.io/pypi/v/approvaltests.svg)](https://pypi.org/project/approvaltests)
+[![Python versions](https://img.shields.io/pypi/pyversions/approvaltests.svg)](https://pypi.org/project/approvaltests)
+[![Build Status](https://github.com/approvals/ApprovalTests.Python/workflows/Test/badge.svg?branch=master)](https://github.com/approvals/ApprovalTests.Python/actions)
+[![Build Status](https://github.com/approvals/ApprovalTests.Python/workflows/on-push-do-doco/badge.svg)](https://github.com/approvals/ApprovalTests.Python/actions?query=workflow%3Aon-push-do-doco)
+[![Build Status](https://github.com/approvals/ApprovalTests.Python/workflows/Upload%20Python%20Package/badge.svg)](https://github.com/approvals/ApprovalTests.Python/actions?query=workflow%3A%22Upload+Python+Package%22)
+
+
+## What can I use ApprovalTests for?
+
+You can use ApprovalTests to verify objects that require more than a simple assert including long strings, large arrays, 
+and complex hash structures and objects.  ApprovalTests really shines when you need a more granular look at the test 
+failure.  Sometimes, trying to find a small difference in a long string printed to STDOUT is just too hard!  
+ApprovalTests solves this problem by providing reporters which let you view the test results in one of many popular diff 
+utilities.
+
+
+## Getting Started
+
+### New Projects
+
+If you are starting a new project, we suggest you use the [Starter Project](https://github.com/approvals/ApprovalTests.Python.StarterProject).
+You can just clone this and go. It's great for exercises, katas, and green field projects.
+
+#### Minimal Example Tutorial
+
+If this is first time approvaltesting in python, consider starting here: [Minimal Example Tutorial](docs/tutorial/minimal-example.md)
+
+###  Adding to Existing Projects 
+
+From [pypi](https://pypi.org/project/approvaltests/):
+
+	pip install approvaltests
+
+## Overview
+
+Approvals work by comparing the test results to a golden master.  If no golden master exists you can create a snapshot 
+of the current test results and use that as the golden master.  The reporter helps you manage the golden master.  
+Whenever your current results differ from the golden master, Approvals will launch an external application for you to 
+examine the differences.  Either you will update the master because you expected the changes and they are good,
+or you will go back to your code and update or roll back your changes to get your results back in line with the 
+golden master.
+
+
+### Example using pytest
+
+<!-- snippet: getting_started_with_pytest.py -->
+<a id='snippet-getting_started_with_pytest.py'></a>
+```py
+from approvaltests.approvals import verify
+
+
+def test_simple():
+    result = "Hello ApprovalTests"
+    verify(result)
+```
+<sup><a href='/tests/examples/getting_started_with_pytest.py#L1-L6' title='Snippet source file'>snippet source</a> | <a href='#snippet-getting_started_with_pytest.py' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->
+
+Install the plugin pytest-approvaltests and use it to select a reporter:
+
+    pip install pytest-approvaltests
+    pytest --approvaltests-use-reporter='PythonNative'
+
+The reporter is used both to alert you to changes in your test output, and to provide a tool to update the golden 
+master. In this snippet, we chose the 'PythonNative' reporter when we ran the tests. For more information about selecting
+reporters see [the documentation](https://github.com/approvals/ApprovalTests.Python.PytestPlugin)
+
+
+### Example using unittest
+
+<!-- snippet: getting_started_with_unittest.py -->
+<a id='snippet-getting_started_with_unittest.py'></a>
+```py
+import unittest
+
+from approvaltests.approvals import verify
+
+
+class GettingStartedTest(unittest.TestCase):
+    def test_simple(self):
+        verify("Hello ApprovalTests")
+
+
+if __name__ == "__main__":
+    unittest.main()
+```
+<sup><a href='/tests/examples/getting_started_with_unittest.py#L1-L12' title='Snippet source file'>snippet source</a> | <a href='#snippet-getting_started_with_unittest.py' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->
+
+This example has the same behaviour as the pytest version, but uses the built-in test framework `unittest` instead.
+
+### Example using CLI
+
+You can invoke a verify() call from the command line. This allows invoking python approvals from any other stack via subprocesses.
+
+#### Usage
+
+```
+python -m approvaltests --test-id hello --received "hello world!"
+```
+or
+```
+python -m approvaltests -t hello -r "hello world!"
+```
+
+or 
+
+```
+echo "hello world!" | python -m approvaltests -t hello
+```
+
+#### Argument Definitions
+
+- __`--test-id`__ or __`-t`__: Test identifier used to name the `approved.txt` and `received.txt` files for the test.
+
+- __`--received`__ or __`-r`__: The output of the program under test (a string) that is passed to the verify method.
+
+  - __`stdin`__: Instead of providing a `received` argument, you may use `stdin`.
+
+
+## Reporters
+
+### Selecting a Reporter
+
+All verify functions take an optional `options` parameter that can configure reporters (as well as many other aspects).
+
+ApprovalTests.Python comes with a few reporters configured, supporting Linux, Mac OSX, and Windows.
+
+In the example shown below, we pass in an options with a reporter we're selecting directly:
+
+<!-- snippet: select_reporter_from_class -->
+<a id='snippet-select_reporter_from_class'></a>
+```py
+class TestSelectReporterFromClass(unittest.TestCase):
+    def test_simple(self):
+        verify("Hello", options=Options().with_reporter(report_with_beyond_compare()))
+```
+<sup><a href='/tests/samples/test_getting_started.py#L25-L31' title='Snippet source file'>snippet source</a> | <a href='#snippet-select_reporter_from_class' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->
+
+You can also use the `GenericDiffReporterFactory` to find and select the first diff utility that exists on our system.
+
+An advantage of this method is you can modify the reporters.json file directly to handle your unique system.
+
+<!-- snippet: select_reporter_from_factory -->
+<a id='snippet-select_reporter_from_factory'></a>
+```py
+class TestSelectReporter(unittest.TestCase):
+    def setUp(self):
+        self.factory = GenericDiffReporterFactory()
+
+    def test_simple(self):
+        verify(
+            "Hello", options=Options().with_reporter(self.factory.get("BeyondCompare"))
+        )
+```
+<sup><a href='/tests/samples/test_getting_started.py#L11-L22' title='Snippet source file'>snippet source</a> | <a href='#snippet-select_reporter_from_factory' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->
+
+
+
+Or you can build your own GenericDiffReporter on the fly
+
+<!-- snippet: custom_generic_diff_reporter -->
+<a id='snippet-custom_generic_diff_reporter'></a>
+```py
+class GettingStartedTest(unittest.TestCase):
+    def test_simple(self):
+        verify(
+            "Hello",
+            options=Options().with_reporter(
+                GenericDiffReporter.create(r"C:\my\favorite\diff\utility.exe")
+            ),
+        )
+```
+<sup><a href='/tests/samples/test_getting_started.py#L34-L45' title='Snippet source file'>snippet source</a> | <a href='#snippet-custom_generic_diff_reporter' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->
+
+As long as `C:/my/favorite/diff/utility.exe` can be invoked from the command line using the format `utility.exe file1 file2` 
+then it will be compatible with GenericDiffReporter.  Otherwise you will have to derive your own reporter, which 
+we won't cover here.
+
+### JSON file for collection of reporters
+
+To wrap things up, I should note that you can completely replace the collection of reporters known to the reporter 
+factory by writing your own JSON file and loading it.
+
+For example if you had `C:/myreporters.json`
+
+```json
+[
+    [
+        "BeyondCompare4",
+        "C:/Program Files (x86)/Beyond Compare 4/BCompare.exe"
+    ],
+    [
+        "WinMerge",
+        "C:/Program Files (x86)/WinMerge/WinMergeU.exe"
+    ],
+    [
+        "Tortoise",
+        "C:/Program Files (x86)/TortoiseSVN/bin/tortoisemerge.exe"
+    ]
+]
+```
+
+You could then use that file by loading it into the factory:
+
+```python
+
+import unittest
+
+from approvaltests.approvals import verify
+from approvaltests.reporters.generic_diff_reporter_factory import GenericDiffReporterFactory
+
+
+class GettingStartedTest(unittest.TestCase):
+    def setUp(self):
+        factory = GenericDiffReporterFactory()
+        factory.load('C:/myreporters.json')
+        self.reporter = factory.get_first_working()
+
+    def test_simple(self):
+        verify('Hello', self.reporter)
+
+if __name__ == "__main__":
+    unittest.main()
+```
+
+Of course, if you have some interesting new reporters in `myreporters.json` then please consider updating the 
+`reporters.json` file that ships with Approvals and submitting a pull request.
+
+## Support and Documentation
+
+* [Documentation](/docs/README.md)
+
+* GitHub: [https://github.com/approvals/ApprovalTests.Python](https://github.com/approvals/ApprovalTests.Python)
+
+* ApprovalTests Homepage: [http://www.approvaltests.com](http://www.approvaltests.com)
+
+### Missing Documentation?
+If there is documentation you wish existed, please add a `page request` to [this issue](https://github.com/approvals/ApprovalTests.Python/issues/135).
+
+
+### Dependencies
+
+ApprovalTests require Python 3.7 or greater and the following dependencies:
+#### Required dependencies
+These dependencies are always required for approvaltests
+<!-- snippet: requirements.prod.required.txt -->
+<a id='snippet-requirements.prod.required.txt'></a>
+```txt
+pytest>=4.0.0
+empty-files>=0.0.3
+typing_extensions>=3.6.2
+```
+<sup><a href='/requirements.prod.required.txt#L1-L5' title='Snippet source file'>snippet source</a> | <a href='#snippet-requirements.prod.required.txt' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->
+#### Extra dependencies
+These dependencies are required if you are going to use the related functionality
+If you want the bare minimum you can use the pypi project 
+[approvaltests-minimal](https://pypi.org/project/approvaltests-minimal/) 
+
+<!-- snippet: requirements.prod.extras.txt -->
+<a id='snippet-requirements.prod.extras.txt'></a>
+```txt
+pyperclip>=1.5.29     # For Clipboard Reporter
+beautifulsoup4>=4.4.0 # For verify_html
+allpairspy>=2.1.0     # For PairwiseCombinations
+mrjob>=0.7.4          # For MrJob
+```
+<sup><a href='/requirements.prod.extras.txt#L1-L4' title='Snippet source file'>snippet source</a> | <a href='#snippet-requirements.prod.extras.txt' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->
+
+## For developers
+### Weekly Ensemble
+
+The best way to contribute is to [join our weekly mob/ensemble](./docs/Contribute.md)
+
+### Pull Requests
+Pull requests are welcomed, particularly those accompanied by automated tests.
+
+To run the self-tests, install pytest and tox, then execute
+
+    python -m tox
+
+This will run the self-tests on several python versions. We support python 3.7 and above. 
+
+All pull requests will be pre-checked using GitHub actions to execute all these tests. You can see the [results of test
+runs here](https://github.com/approvals/ApprovalTests.Python/actions).
+
+
+%prep
+%autosetup -n approvaltests-8.2.5
+
+%build
+%py3_build
+
+%install
+%py3_install
+install -d -m755 %{buildroot}/%{_pkgdocdir}
+if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
+if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
+if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
+if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
+pushd %{buildroot}
+if [ -d usr/lib ]; then
+	find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+if [ -d usr/lib64 ]; then
+	find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+if [ -d usr/bin ]; then
+	find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+if [ -d usr/sbin ]; then
+	find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+touch doclist.lst
+if [ -d usr/share/man ]; then
+	find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
+fi
+popd
+mv %{buildroot}/filelist.lst .
+mv %{buildroot}/doclist.lst .
+
+%files -n python3-approvaltests -f filelist.lst
+%dir %{python3_sitelib}/*
+
+%files help -f doclist.lst
+%{_docdir}/*
+
+%changelog
+* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 8.2.5-1
+- Package Spec generated
diff --git a/sources b/sources
new file mode 100644
index 0000000..405094f
--- /dev/null
+++ b/sources
@@ -0,0 +1 @@
+cc2d5910249d703cddb2c17091f3574c  approvaltests-8.2.5.tar.gz