pynguin 0.46.0.dev0__tar.gz → 0.48.0__tar.gz

pynguin-0.48.0/PKG-INFO

@@ -0,0 +1,240 @@
+Metadata-Version: 2.3
+Name: pynguin
+Version: 0.48.0
+Summary: Pynguin is a tool for automated unit test generation for Python
+License: MIT
+Keywords: unit test,random testing,search based,test generation
+Author: Stephan Lukasczyk
+Author-email: stephan@pynguin.eu
+Requires-Python: >=3.10,<3.16
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Education :: Testing
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Software Development :: Testing :: Unit
+Classifier: Typing :: Typed
+Provides-Extra: fandango-faker
+Provides-Extra: numpy
+Provides-Extra: openai
+Provides-Extra: typing
+Requires-Dist: Jinja2 (>=3.1.6,<4.0.0)
+Requires-Dist: Pygments (>=2.19.2,<3.0.0)
+Requires-Dist: black (>=25.1.0,<26.0.0)
+Requires-Dist: bytecode (==0.17.0) ; python_version < "3.15"
+Requires-Dist: bytecode (==0.19.1) ; python_version >= "3.15"
+Requires-Dist: dill (>=0.4.0,<0.5.0)
+Requires-Dist: faker (>=37.3.0,<38.0.0) ; extra == "fandango-faker"
+Requires-Dist: fandango-fuzzer (>=0.8.2,<0.9.0) ; extra == "fandango-faker"
+Requires-Dist: httpx (>=0.28.1,<0.29.0) ; extra == "openai"
+Requires-Dist: libcst (>=1.7.0,<2.0.0)
+Requires-Dist: multiprocess (>=0.70.18,<0.71.0)
+Requires-Dist: mypy (>=1.15.0,<2.0.0) ; extra == "typing"
+Requires-Dist: networkx (>=3.4.2,<4.0.0)
+Requires-Dist: numpy (>=1.26.4,<2.0.0) ; extra == "numpy"
+Requires-Dist: openai (>=1.72.0,<2.0.0) ; extra == "openai"
+Requires-Dist: psutil (>=7.1.1,<8.0.0)
+Requires-Dist: pytest (>=8.3.5,<9.0.0)
+Requires-Dist: python-dotenv (>=1.0.0,<2.0.0) ; extra == "openai"
+Requires-Dist: pyyaml (>=6.0.2,<7.0.0) ; extra == "openai"
+Requires-Dist: rich (>=14.0.0,<15.0.0)
+Requires-Dist: rstr (>=3.2.2,<4.0.0)
+Requires-Dist: setuptools (>=80.9.0,<81.0.0)
+Requires-Dist: simple-parsing (>=0.1.7,<0.2.0)
+Requires-Dist: toml (>=0.10.2,<0.11.0)
+Requires-Dist: typeshed-client (>=2.13.0,<3.0.0)
+Requires-Dist: typing-extensions (>=4.12.2,<5.0.0) ; extra == "typing"
+Project-URL: Documentation, https://pynguin.readthedocs.io
+Project-URL: Homepage, https://www.pynguin.eu
+Project-URL: Repository, https://github.com/se2p/pynguin
+Description-Content-Type: text/markdown
+
+<!--
+SPDX-FileCopyrightText: 2019–2026 Pynguin Contributors
+
+SPDX-License-Identifier: CC-BY-4.0
+-->
+
+# Pynguin
+
+Pynguin (IPA: ˈpɪŋɡuiːn),
+the
+PYthoN
+General
+UnIt
+test
+geNerator,
+is a tool that allows developers to generate unit tests automatically.
+
+Testing software is often considered to be a tedious task.
+Thus, automated generation techniques have been proposed and mature tools exist—for
+statically typed languages, such as Java.
+There is, however, no fully automated tool available that produces unit tests for
+general-purpose programs in a dynamically typed language.
+Pynguin is, to the best of our knowledge, the first tool that fills this gap
+and allows the automated generation of unit tests for Python programs.
+
+<details>
+<summary>Internal Pipeline Status</summary>
+
+[![pipeline status](https://gitlab.infosun.fim.uni-passau.de/se2/pynguin/pynguin/badges/main/pipeline.svg)](https://gitlab.infosun.fim.uni-passau.de/se2/pynguin/pynguin/-/commits/main)
+[![coverage report](https://gitlab.infosun.fim.uni-passau.de/se2/pynguin/pynguin/badges/main/coverage.svg)](https://gitlab.infosun.fim.uni-passau.de/se2/pynguin/pynguin/-/commits/main)
+
+</details>
+
+[![License MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![PyPI version](https://badge.fury.io/py/pynguin.svg)](https://badge.fury.io/py/pynguin)
+[![Supported Python Versions](https://img.shields.io/pypi/pyversions/pynguin.svg)](https://github.com/se2p/pynguin)
+[![Documentation Status](https://readthedocs.org/projects/pynguin/badge/?version=latest)](https://pynguin.readthedocs.io/)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3989840.svg)](https://doi.org/10.5281/zenodo.3989840)
+[![REUSE status](https://api.reuse.software/badge/github.com/se2p/pynguin)](https://api.reuse.software/info/github.com/se2p/pynguin)
+[![Downloads](https://static.pepy.tech/personalized-badge/pynguin?period=total&units=international_system&left_color=grey&right_color=blue&left_text=Downloads)](https://pepy.tech/project/pynguin)
+[![SWH](https://archive.softwareheritage.org/badge/origin/https://github.com/se2p/pynguin/)](https://archive.softwareheritage.org/browse/origin/?origin_url=https://github.com/se2p/pynguin)
+
+
+![Pynguin Logo](https://raw.githubusercontent.com/se2p/pynguin/master/docs/source/_static/pynguin-logo.png "Pynguin Logo")
+
+## Attention
+
+*Please Note:*
+
+**Pynguin executes the module under test!**
+As a consequence, depending on what code is in that module,
+running Pynguin can cause serious harm to your computer,
+for example, wipe your entire hard disk!
+We recommend running Pynguin in an isolated environment;
+use, for example, a Docker container to minimize the risk of damaging
+your system.
+
+**Pynguin is only a research prototype!**
+It is not tailored towards production use whatsoever.
+However, we would love to see Pynguin in a production-ready stage at some point;
+please report your experiences in using Pynguin to us.
+
+
+## Prerequisites
+
+Before you begin, ensure you have met the following requirements:
+- You have installed Python 3.10 (the support for 3.11, 3.12, 3.13, 3.14, and 3.15 is experimental).
+
+  **Attention:** Pynguin now requires at least Python 3.10!  Older versions are no longer
+  supported!
+- You have a recent Linux/macOS/Windows machine.
+
+Please consider reading the [online documentation](https://pynguin.readthedocs.io)
+to start your Pynguin adventure.
+
+## Installing Pynguin
+
+Pynguin can be easily installed using the `pip` tool by typing:
+```bash
+pip install pynguin
+```
+
+Make sure that your version of `pip` is that of a supported Python version, as any
+older version is not supported by Pynguin!
+
+## Using Pynguin
+
+Before you continue, please read the [quick start guide](https://pynguin.readthedocs.io/latest/user/quickstart.html)
+
+Pynguin is a command-line application.
+Once you installed it to a virtual environment, you can invoke the tool by typing
+`pynguin` inside this virtual environment.
+Pynguin will then print a list of its command-line parameters.
+
+A minimal full command line to invoke Pynguin could be the following,
+where we assume that a project `foo` is located in `/tmp/foo`,
+we want to store Pynguin's generated tests in `/tmp/testgen`,
+and we want to generate tests using a whole-suite approach for the module `foo.bar`
+(wrapped for better readability):
+```bash
+pynguin \
+  --project-path /tmp/foo \
+  --output-path /tmp/testgen \
+  --module-name foo.bar
+```
+Please find a more detailed example in the [quick start guide](https://pynguin.readthedocs.io/latest/user/quickstart.html).
+
+
+## Contributing to Pynguin
+
+For the development of Pynguin you will need the [`poetry`](https://python-poetry.org)
+dependency management and packaging tool.
+To start developing, follow these steps:
+1. Clone the repository
+2. Change to the `pynguin` folder: `cd pynguin`
+3. Create a virtual environment and install dependencies using `poetry`: `poetry install`
+4. Make your changes
+5. Run `make check` to verify that your changes pass all checks
+
+   Please see the [`poetry` documentation](https://python-poetry.org/docs/) for more information on this tool.
+
+## Contributors
+
+Pynguin is developed at the
+[Chair of Software Engineering II](https://www.fim.uni-passau.de/lehrstuhl-fuer-software-engineering-ii/)
+of the [University of Passau](https://www.uni-passau.de).
+
+Maintainer: [Lukas Krodinger](https://github.com/LuKrO2011)
+
+Former Maintainer: [Stephan Lukasczyk](https://codeberg.org/stephanlukasczyk)
+
+Contributors:
+- [Kejdi Domi](https://github.com/kdomi18)
+- [Erkin Berk Türe](https://github.com/erkintuere)
+- [Lukas Vögl](https://github.com/lvoegl)
+- [Louis Leppelmann](https://github.com/Tudeldu)
+- [Alexander Wüst](https://github.com/Ravaqor)
+- [Altin Hajdari](https://github.com/AltinHajdari)
+- [Ahmed Abidi](https://github.com/AhmedHedi0)
+- [Abdelillah Aissani](https://github.com/Abassion)
+- [Juan Altmayer Pizzorno](https://github.com/jaltmayerpizzorno)
+- [Lucas Berg](https://github.com/BergLucas)
+- [Tucker Blue](https://github.com/tuckcodes)
+- [Gordon Fraser](https://github.com/gofraser)
+- [Abdur-Rahmaan Janhangeer](https://github.com/Abdur-rahmaanJ)
+- [Maximilian Königseder](https://github.com/mak1ng)
+- [Florian Kroiß](https://github.com/Wooza)
+- [Simon Labrenz](https://github.com/labrenz)
+- [Roman Levin](https://github.com/romanlevin)
+- [Juan Julián Merelo Guervós](https://github.com/JJ)
+- [Lukas Steffens](https://github.com/Luki42)
+- [Florian Straubinger](https://github.com/f-str)
+- [Sara Tavares](https://github.com/stavares843)
+
+
+### Development using PyCharm.
+
+If you want to use the PyCharm IDE, you have to set up a few things:
+1. Import `pynguin` into PyCharm.
+2. Let PyCharm configure a virtual environment using `poetry`.
+3. Set the default test runner to `pytest`
+4. Set the DocString format to `Google`
+
+
+## License
+
+This project is licensed under the terms of the [MIT License](LICENSE.rst).
+Pynguin was using the GNU Lesser General Public License (LGPL) until version 0.29.0,
+its license was changed with version 0.30.0.
+
+## Star History
+
+[![Star History Chart](https://star-history.dera.page/svg?repos=se2p/pynguin&type=Date)](https://star-history.dera.page/#se2p/pynguin)
+

pynguin-0.48.0/README.md

@@ -0,0 +1,174 @@
+<!--
+SPDX-FileCopyrightText: 2019–2026 Pynguin Contributors
+
+SPDX-License-Identifier: CC-BY-4.0
+-->
+
+# Pynguin
+
+Pynguin (IPA: ˈpɪŋɡuiːn),
+the
+PYthoN
+General
+UnIt
+test
+geNerator,
+is a tool that allows developers to generate unit tests automatically.
+
+Testing software is often considered to be a tedious task.
+Thus, automated generation techniques have been proposed and mature tools exist—for
+statically typed languages, such as Java.
+There is, however, no fully automated tool available that produces unit tests for
+general-purpose programs in a dynamically typed language.
+Pynguin is, to the best of our knowledge, the first tool that fills this gap
+and allows the automated generation of unit tests for Python programs.
+
+<details>
+<summary>Internal Pipeline Status</summary>
+
+[![pipeline status](https://gitlab.infosun.fim.uni-passau.de/se2/pynguin/pynguin/badges/main/pipeline.svg)](https://gitlab.infosun.fim.uni-passau.de/se2/pynguin/pynguin/-/commits/main)
+[![coverage report](https://gitlab.infosun.fim.uni-passau.de/se2/pynguin/pynguin/badges/main/coverage.svg)](https://gitlab.infosun.fim.uni-passau.de/se2/pynguin/pynguin/-/commits/main)
+
+</details>
+
+[![License MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![PyPI version](https://badge.fury.io/py/pynguin.svg)](https://badge.fury.io/py/pynguin)
+[![Supported Python Versions](https://img.shields.io/pypi/pyversions/pynguin.svg)](https://github.com/se2p/pynguin)
+[![Documentation Status](https://readthedocs.org/projects/pynguin/badge/?version=latest)](https://pynguin.readthedocs.io/)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3989840.svg)](https://doi.org/10.5281/zenodo.3989840)
+[![REUSE status](https://api.reuse.software/badge/github.com/se2p/pynguin)](https://api.reuse.software/info/github.com/se2p/pynguin)
+[![Downloads](https://static.pepy.tech/personalized-badge/pynguin?period=total&units=international_system&left_color=grey&right_color=blue&left_text=Downloads)](https://pepy.tech/project/pynguin)
+[![SWH](https://archive.softwareheritage.org/badge/origin/https://github.com/se2p/pynguin/)](https://archive.softwareheritage.org/browse/origin/?origin_url=https://github.com/se2p/pynguin)
+
+
+![Pynguin Logo](https://raw.githubusercontent.com/se2p/pynguin/master/docs/source/_static/pynguin-logo.png "Pynguin Logo")
+
+## Attention
+
+*Please Note:*
+
+**Pynguin executes the module under test!**
+As a consequence, depending on what code is in that module,
+running Pynguin can cause serious harm to your computer,
+for example, wipe your entire hard disk!
+We recommend running Pynguin in an isolated environment;
+use, for example, a Docker container to minimize the risk of damaging
+your system.
+
+**Pynguin is only a research prototype!**
+It is not tailored towards production use whatsoever.
+However, we would love to see Pynguin in a production-ready stage at some point;
+please report your experiences in using Pynguin to us.
+
+
+## Prerequisites
+
+Before you begin, ensure you have met the following requirements:
+- You have installed Python 3.10 (the support for 3.11, 3.12, 3.13, 3.14, and 3.15 is experimental).
+
+  **Attention:** Pynguin now requires at least Python 3.10!  Older versions are no longer
+  supported!
+- You have a recent Linux/macOS/Windows machine.
+
+Please consider reading the [online documentation](https://pynguin.readthedocs.io)
+to start your Pynguin adventure.
+
+## Installing Pynguin
+
+Pynguin can be easily installed using the `pip` tool by typing:
+```bash
+pip install pynguin
+```
+
+Make sure that your version of `pip` is that of a supported Python version, as any
+older version is not supported by Pynguin!
+
+## Using Pynguin
+
+Before you continue, please read the [quick start guide](https://pynguin.readthedocs.io/latest/user/quickstart.html)
+
+Pynguin is a command-line application.
+Once you installed it to a virtual environment, you can invoke the tool by typing
+`pynguin` inside this virtual environment.
+Pynguin will then print a list of its command-line parameters.
+
+A minimal full command line to invoke Pynguin could be the following,
+where we assume that a project `foo` is located in `/tmp/foo`,
+we want to store Pynguin's generated tests in `/tmp/testgen`,
+and we want to generate tests using a whole-suite approach for the module `foo.bar`
+(wrapped for better readability):
+```bash
+pynguin \
+  --project-path /tmp/foo \
+  --output-path /tmp/testgen \
+  --module-name foo.bar
+```
+Please find a more detailed example in the [quick start guide](https://pynguin.readthedocs.io/latest/user/quickstart.html).
+
+
+## Contributing to Pynguin
+
+For the development of Pynguin you will need the [`poetry`](https://python-poetry.org)
+dependency management and packaging tool.
+To start developing, follow these steps:
+1. Clone the repository
+2. Change to the `pynguin` folder: `cd pynguin`
+3. Create a virtual environment and install dependencies using `poetry`: `poetry install`
+4. Make your changes
+5. Run `make check` to verify that your changes pass all checks
+
+   Please see the [`poetry` documentation](https://python-poetry.org/docs/) for more information on this tool.
+
+## Contributors
+
+Pynguin is developed at the
+[Chair of Software Engineering II](https://www.fim.uni-passau.de/lehrstuhl-fuer-software-engineering-ii/)
+of the [University of Passau](https://www.uni-passau.de).
+
+Maintainer: [Lukas Krodinger](https://github.com/LuKrO2011)
+
+Former Maintainer: [Stephan Lukasczyk](https://codeberg.org/stephanlukasczyk)
+
+Contributors:
+- [Kejdi Domi](https://github.com/kdomi18)
+- [Erkin Berk Türe](https://github.com/erkintuere)
+- [Lukas Vögl](https://github.com/lvoegl)
+- [Louis Leppelmann](https://github.com/Tudeldu)
+- [Alexander Wüst](https://github.com/Ravaqor)
+- [Altin Hajdari](https://github.com/AltinHajdari)
+- [Ahmed Abidi](https://github.com/AhmedHedi0)
+- [Abdelillah Aissani](https://github.com/Abassion)
+- [Juan Altmayer Pizzorno](https://github.com/jaltmayerpizzorno)
+- [Lucas Berg](https://github.com/BergLucas)
+- [Tucker Blue](https://github.com/tuckcodes)
+- [Gordon Fraser](https://github.com/gofraser)
+- [Abdur-Rahmaan Janhangeer](https://github.com/Abdur-rahmaanJ)
+- [Maximilian Königseder](https://github.com/mak1ng)
+- [Florian Kroiß](https://github.com/Wooza)
+- [Simon Labrenz](https://github.com/labrenz)
+- [Roman Levin](https://github.com/romanlevin)
+- [Juan Julián Merelo Guervós](https://github.com/JJ)
+- [Lukas Steffens](https://github.com/Luki42)
+- [Florian Straubinger](https://github.com/f-str)
+- [Sara Tavares](https://github.com/stavares843)
+
+
+### Development using PyCharm.
+
+If you want to use the PyCharm IDE, you have to set up a few things:
+1. Import `pynguin` into PyCharm.
+2. Let PyCharm configure a virtual environment using `poetry`.
+3. Set the default test runner to `pytest`
+4. Set the DocString format to `Google`
+
+
+## License
+
+This project is licensed under the terms of the [MIT License](LICENSE.rst).
+Pynguin was using the GNU Lesser General Public License (LGPL) until version 0.29.0,
+its license was changed with version 0.30.0.
+
+## Star History
+
+[![Star History Chart](https://star-history.dera.page/svg?repos=se2p/pynguin&type=Date)](https://star-history.dera.page/#se2p/pynguin)