l1test 3.3.0__tar.gz

l1test-3.3.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [year] [fullname]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

l1test-3.3.0/PKG-INFO

@@ -0,0 +1,62 @@
+Metadata-Version: 2.1
+Name: l1test
+Version: 3.3.0
+Summary: A basic unit testing tool for novice programmers provided as a Thonny plugin
+Home-page: https://gitlab.univ-lille.fr/mirabelle.nebut/thonny-tests
+Author: Mirabelle MARVIE-NEBUT, Reda ID TALEB
+Author-email: Mirabelle NEBUT <mirabelle.nebut@univ-lille.fr>, Reda ID TALEB <reda@example.com>
+License: MIT License
+        
+        Copyright (c) [year] [fullname]
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Platform: Windows
+Platform: macOS
+Platform: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 4 - Beta
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Education
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Developers
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+L1Test is a plugin for the IDE Thonny, that provides a basic unit test tool for novice programmers (hence the name, L1 = CS1). For teaching purpose. Beta status.
+
+Building
+
+To build a wheel for the plugin you can use the Makefile in this directory:
+
+```
+make build
+```
+
+If you need to ensure Python 3 is used (for example when `python` points to Python 2), run:
+
+```
+make build3
+```
+
+Note: the `build3` Makefile target forces the build to use Python 3. Use
+`make build3` on systems where `python` defaults to Python 2.

l1test-3.3.0/README.md

@@ -0,0 +1,18 @@
+L1Test is a plugin for the IDE Thonny, that provides a basic unit test tool for novice programmers (hence the name, L1 = CS1). For teaching purpose. Beta status.
+
+Building
+
+To build a wheel for the plugin you can use the Makefile in this directory:
+
+```
+make build
+```
+
+If you need to ensure Python 3 is used (for example when `python` points to Python 2), run:
+
+```
+make build3
+```
+
+Note: the `build3` Makefile target forces the build to use Python 3. Use
+`make build3` on systems where `python` defaults to Python 2.

l1test-3.3.0/l1test.egg-info/PKG-INFO

@@ -0,0 +1,62 @@
+Metadata-Version: 2.1
+Name: l1test
+Version: 3.3.0
+Summary: A basic unit testing tool for novice programmers provided as a Thonny plugin
+Home-page: https://gitlab.univ-lille.fr/mirabelle.nebut/thonny-tests
+Author: Mirabelle MARVIE-NEBUT, Reda ID TALEB
+Author-email: Mirabelle NEBUT <mirabelle.nebut@univ-lille.fr>, Reda ID TALEB <reda@example.com>
+License: MIT License
+        
+        Copyright (c) [year] [fullname]
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Platform: Windows
+Platform: macOS
+Platform: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 4 - Beta
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Education
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Developers
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+L1Test is a plugin for the IDE Thonny, that provides a basic unit test tool for novice programmers (hence the name, L1 = CS1). For teaching purpose. Beta status.
+
+Building
+
+To build a wheel for the plugin you can use the Makefile in this directory:
+
+```
+make build
+```
+
+If you need to ensure Python 3 is used (for example when `python` points to Python 2), run:
+
+```
+make build3
+```
+
+Note: the `build3` Makefile target forces the build to use Python 3. Use
+`make build3` on systems where `python` defaults to Python 2.

l1test-3.3.0/l1test.egg-info/SOURCES.txt

@@ -0,0 +1,81 @@
+LICENSE
+README.md
+pyproject.toml
+setup.py
+l1test.egg-info/PKG-INFO
+l1test.egg-info/SOURCES.txt
+l1test.egg-info/dependency_links.txt
+l1test.egg-info/requires.txt
+l1test.egg-info/top_level.txt
+thonnycontrib/ThonnyLogsGenerator.py
+thonnycontrib/__init__.py
+thonnycontrib/environement_vars.py
+thonnycontrib/exceptions.py
+thonnycontrib/plugin_loader.py
+thonnycontrib/properties.py
+thonnycontrib/utils.py
+thonnycontrib/backend/__init__.py
+thonnycontrib/backend/approx_comp.py
+thonnycontrib/backend/ast_parser.py
+thonnycontrib/backend/doctest_parser.py
+thonnycontrib/backend/evaluator.py
+thonnycontrib/backend/l1test_backend.py
+thonnycontrib/backend/test_finder.py
+thonnycontrib/backend/verdicts/ExampleVerdict.py
+thonnycontrib/backend/verdicts/ExceptionVerdict.py
+thonnycontrib/backend/verdicts/FailedVerdict.py
+thonnycontrib/backend/verdicts/FailedWhenExceptionExpectedVerdict.py
+thonnycontrib/backend/verdicts/PassedSetupVerdict.py
+thonnycontrib/backend/verdicts/PassedVerdict.py
+thonnycontrib/backend/verdicts/__init__.py
+thonnycontrib/frontend/__init__.py
+thonnycontrib/frontend/l1test_error_view.py
+thonnycontrib/frontend/l1test_outliner_menu.py
+thonnycontrib/frontend/l1test_reporter.py
+thonnycontrib/frontend/l1test_runner.py
+thonnycontrib/frontend/l1test_treeview.py
+thonnycontrib/frontend/docstring_generator/__init__.py
+thonnycontrib/frontend/docstring_generator/doc_generator.py
+thonnycontrib/frontend/docstring_generator/doc_template.py
+thonnycontrib/frontend/main_generator/__init__.py
+thonnycontrib/frontend/main_generator/main_generator.py
+thonnycontrib/i18n/__init__.py
+thonnycontrib/i18n/languages.py
+thonnycontrib/i18n/locale/l1test.pot
+thonnycontrib/i18n/locale/en_US/LC_MESSAGES/l1test.mo
+thonnycontrib/i18n/locale/en_US/LC_MESSAGES/l1test.po
+thonnycontrib/i18n/locale/fr_FR/LC_MESSAGES/l1test.mo
+thonnycontrib/i18n/locale/fr_FR/LC_MESSAGES/l1test.po
+thonnycontrib/img/error_icon.png
+thonnycontrib/img/exception_red_chip.png
+thonnycontrib/img/failed.png
+thonnycontrib/img/failed_red_chip.png
+thonnycontrib/img/l1test_icon.png
+thonnycontrib/img/l1test_icon_old.png
+thonnycontrib/img/outline_class.png
+thonnycontrib/img/outline_method.gif
+thonnycontrib/img/passed.png
+thonnycontrib/img/pending_icon.png
+thonnycontrib/img/restart_icon.png
+thonnycontrib/img/success_green_chip.png
+thonnycontrib/img/warning.png
+thonnycontrib/l1test_configuration/__init__.py
+thonnycontrib/l1test_configuration/l1test_options.py
+thonnycontrib/tests/__init__.py
+thonnycontrib/tests/test_evaluator_source_tests.py
+thonnycontrib/tests/tests_approx_comp.py
+thonnycontrib/tests/tests_ast_parser.py
+thonnycontrib/tests/tests_doc_generator.py
+thonnycontrib/tests/tests_example_no_expected.py
+thonnycontrib/tests/tests_example_with_exception.py
+thonnycontrib/tests/tests_example_with_expected.py
+thonnycontrib/tests/tests_float_prompt.py
+thonnycontrib/tests/tests_l1TestRunner.py
+thonnycontrib/tests/tests_l1test_options.py
+thonnycontrib/tests/tests_main_generator.py
+thonnycontrib/tests/tests_test_finder.py
+thonnycontrib/tests/tests_utils.py
+thonnycontrib/tests/tests_view.py
+thonnycontrib/tests/fixtures/__init__.py
+thonnycontrib/tests/fixtures/backend_mock.py
+thonnycontrib/tests/fixtures/workbench_mock.py

l1test-3.3.0/l1test.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

l1test-3.3.0/l1test.egg-info/requires.txt

@@ -0,0 +1 @@
+thonny>=4.0.0

l1test-3.3.0/l1test.egg-info/top_level.txt

@@ -0,0 +1 @@
+thonnycontrib

l1test-3.3.0/pyproject.toml

@@ -0,0 +1,28 @@
+[build-system]
+requires = ["setuptools>61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "l1test"
+version = "3.3.0"
+authors = [
+  { name="Mirabelle NEBUT", email="mirabelle.nebut@univ-lille.fr" },
+  { name="Reda ID TALEB", email="reda@example.com"},
+]
+description = "A basic unit testing tool for novice programmers provided as a Thonny plugin"
+readme = "README.md"
+license = { file="LICENSE" }
+requires-python = ">=3.9"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Development Status :: 4 - Beta",
+    "Topic :: Software Development :: Testing",
+    "Topic :: Education",
+    "Intended Audience :: Education",
+    "Intended Audience :: Developers"
+]
+dependencies = ["thonny>=4.0.0"]    
+
+

l1test-3.3.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

l1test-3.3.0/setup.py

@@ -0,0 +1,55 @@
+# Auteur : Esteban COLLARD, Nordine EL AMMARI
+# Modifications : Reda ID TALEB & Manal LAGHMICH
+
+from setuptools import find_packages, setup
+import os.path
+
+
+def recursive_files(directory):
+    paths = []
+    for (path, _, filenames) in os.walk(directory):
+        for filename in filenames:
+            if not filename.endswith(".pyc"):
+                paths.append(os.path.join('..', path, filename))
+    return paths
+
+packages = find_packages()
+
+def get_packages_data(packages: list[str]=packages):
+    py_packs = dict([(p, ["*.py"]) for p in packages])
+    unpackaged = {"": recursive_files("thonnycontrib/i18n/locale") + recursive_files("thonnycontrib/img")}
+    return {**py_packs, **unpackaged} 
+
+setupdir = os.path.dirname(__file__)
+
+
+requirements = []
+for line in open(os.path.join(setupdir, "requirements.txt"), encoding="ASCII"):
+    if line.strip() and not line.startswith("#"):
+        requirements.append(line)
+        
+setup(
+    name="l1test",
+    version="3.3.0",
+    author="Mirabelle MARVIE-NEBUT, Reda ID TALEB",
+    description="A plug-in which adds a test framework",
+    long_description="""A plug-in for Thonny which allows you to test your doc examples
+ 
+More info: https://gitlab.univ-lille.fr/mirabelle.nebut/thonny-tests""",
+    url="https://gitlab.univ-lille.fr/mirabelle.nebut/thonny-tests",
+#    keywords="IDE education programming tests in documentation",
+    classifiers=[
+        "Topic :: Education :: Testing",
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+        "Development Status :: 4 - Beta",
+        "Intended Audience :: Education"
+        ],
+    platforms=["Windows", "macOS", "Linux"],
+    python_requires=">=3.9",
+    package_data=get_packages_data(),
+    install_requires=requirements,
+    packages=packages,
+)
+

l1test-3.3.0/thonnycontrib/ThonnyLogsGenerator.py

@@ -0,0 +1,56 @@
+'''
+Permet de générer pour le plugin de log une synthèse des tests exécutés.
+Corentin.
+'''
+
+from typing import List
+from thonny import get_workbench
+from .backend.ast_parser import L1DocTest
+
+#Attention si le nom change ici, il faut aussi le changer dans Thonny-LoggingPlugin
+NOM_EVENT_TEST = "l1Tests"
+NOM_EVENT_DOC = "l1Tests.DocGenerator"
+wb = get_workbench() 
+
+# Modifié par Mathieu Bachelet, PJI 2022-2023, mais sur la V2 de L1test
+# Modifié par Mirabelle pour adaptation à la V3 de L1test
+def log_in_thonny(
+    test_results: List[L1DocTest],
+    filename: str,
+    selected,
+    status: bool = True,
+    error: str | None = None,
+):
+    tests_data = []
+    if status:
+        for l1doctest in test_results:
+            for example in l1doctest.get_examples():
+                # test:Example
+                verdict = example.get_verdict() # type ExampleVerdict
+                res = vars(verdict).copy() # pour récupérer les attributs filename, lineno, tested_line, expected_results, details
+                res['details'] = str(res['details']) # sinon on peut récupérer un entier
+                res['verdict'] = type(verdict).__name__ # pour connaître le verdict, qui n'est pas dans une champ quelconque mais ds le type lui-même
+                res['name'] = l1doctest.get_name() # nom fonction ou classe
+                res['status'] = verdict.isSuccess() # True si test au vert
+                tests_data.append(res)
+    wb.event_generate(
+        NOM_EVENT_TEST,
+        None,
+        selected=selected,
+        tests=tests_data,
+        filename=filename,
+        status=status,
+        error=error,
+    )
+
+
+def log_doc_in_thonny(docstring_data:tuple):#node):
+    if wb:
+        selected_lineno, filename, source = docstring_data
+        wb.event_generate(NOM_EVENT_DOC,None, selected_lineno=selected_lineno, filename=filename, signature=source) # TODO : non
+
+
+#La fonction anonyme car il faut une fonction pour bind, avec un argument parce qu'elle reçoit l'événement. 
+if wb:   
+    wb.bind(NOM_EVENT_TEST, lambda x : 0, True)
+    wb.bind(NOM_EVENT_DOC, lambda x : 0, True)

l1test-3.3.0/thonnycontrib/backend/approx_comp.py

@@ -0,0 +1,116 @@
+# fonction approx pour comparer des flottants avec une précision fournie
+# très largement inspiré du approx de pytest
+# https://docs.pytest.org/en/4.6.x/_modules/_pytest/python_api.html#approx
+# Auteur : Mirabelle
+
+# La fonction approx crée un objet de type ApproxXXX 
+# Les objets ApproxXXX contiennent une méthode __eq__ qui prend en compte
+# la tolérance passée en paramètre ou celle par défaut
+# C'est ainsi que fait pytest. Ça marche car x == y est récrit en Python en
+# x.__eq__(y) MAIS il semble que c'est finalement y.__eq__(x) qui est exécuté,
+# peut-être quand le __eq__ de x ne sait pas répondre.
+# Donc x == approx(y) exécute ApproxXXX(y).__eq__(x)
+# démo :
+# >>> class truc(object):
+# ...    def __eq__(self, other):
+# ...       print("eq truc")
+# ... 
+# >>> t = truc()
+# >>> 1 == t
+# eq truc
+# >>> "ert" == t
+# eq truc
+# >>> [] == t
+# eq truc
+# >>> None == t
+# eq truc
+
+from ..i18n.languages import tr
+
+DEFAULT_TOLERANCE = 1e-6
+
+def are_close(x:float, y:float, tol:float) -> bool:
+    """
+    Compare x et y avec une tolérance tol.
+    """
+    return abs(x - y) <= tol
+
+from abc import ABC, abstractmethod
+
+class ApproxBase(ABC):
+    DEFAULT_TOLERANCE = 1e-6
+
+    def __init__(self, expected, tol=None):
+        self.expected = expected
+        self.tolerance = tol if tol is not None else self.DEFAULT_TOLERANCE
+
+    def __eq__(self, actual) -> bool:
+        return self.compare(actual)
+
+    @abstractmethod
+    def compare(self, actual) -> bool:
+        """
+        Determines whether the actual value is approximately equal to the expected value, within the specified tolerance.
+
+        Args:
+            actual: The actual value to compare with the expected value.
+
+        Returns:
+            True if the actual value is approximately equal to the expected value, within the specified tolerance. False otherwise.
+        """
+        pass
+
+    def __repr__(self):
+        return "{} +- {}".format(self.expected, self.tolerance)
+
+
+class ApproxSimple(ApproxBase):
+
+    def compare(self, actual) -> bool:
+        return are_close(self.expected, actual, self.tolerance)
+
+
+class ApproxList(ApproxBase):
+
+    def compare(self, actual) -> bool:
+        if len(self.expected) != len(actual):
+            return False
+        return all(are_close(e, a, self.tolerance) for e, a in zip(self.expected, actual))
+
+
+class ApproxDict(ApproxBase):
+
+    def compare(self, actual) -> bool:
+        if (len(self.expected) != len(actual)) or (set(self.expected.keys()) != set(actual.keys())):
+            return False
+        return all(are_close(self.expected[k], actual[k], self.tolerance) for k in self.expected.keys())
+
+
+class ApproxTuple(ApproxBase):
+
+    def compare(self, actual) -> bool:
+        if len(self.expected) != len(actual):
+            return False
+        return all(are_close(e, a, self.tolerance) for e, a in zip(self.expected, actual))
+        
+        
+def approx(expected, tol=None) -> ApproxBase:
+    """
+    Renvoie un objet qui saura comparer expected avec
+    une autre valeur (par __eq__) éventuellement avec une tolérance
+    tol.
+    """
+    if tol and tol<0:
+        raise ValueError("La tolérance doit être positive ou nulle : {}".format(tol))
+    if isinstance(expected, float) or isinstance(expected, int):
+        return ApproxSimple(expected, tol)
+    if isinstance(expected, list):
+        if all((isinstance(x, int) or isinstance(x, float)) for x in expected): 
+            return ApproxList(expected, tol)
+    if isinstance(expected, dict):
+        if all((isinstance(x, int) or isinstance(x, float)) for x in expected.values()): 
+            return ApproxDict(expected, tol)
+    if isinstance(expected,tuple):
+        if all((isinstance(x, int) or isinstance(x, float)) for x in expected):
+            return ApproxTuple(expected, tol)
+    raise TypeError("approx ne s'applique pas au type" + f" {type(expected).__name__}")