Merge pull request #78 from fuzzylite/feature/improvements

Version 8.0.3

.github/workflows/build.yml

@@ -23,7 +23,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
 
       - name: Install requirements
-        run: pip install -r requirements.txt
+        run: pip install -r requirements-dev.txt
 
       - name: Check
         run: nox -e check

.github/workflows/publish.yml

@@ -29,7 +29,7 @@ jobs:
           python-version: "3.9"
 
       - name: Install requirements
-        run: pip install -r requirements.txt
+        run: pip install -r requirements-dev.txt
 
       - name: Build
         run: poetry build

.github/workflows/test.yml

@@ -23,7 +23,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
 
       - name: Install requirements
-        run: pip install -r requirements.txt
+        run: pip install -r requirements-dev.txt
 
       - name: Check
         run: nox -e check

CITATION.cff

@@ -11,7 +11,7 @@ authors:
   - given-names: Juan
     family-names: Rada-Vilela
     email: jcrada@fuzzylite.com
-    affiliation: FuzzyLite Limited
+    affiliation: FuzzyLite
 repository-code: 'https://github.com/fuzzylite/pyfuzzylite'
 url: 'https://fuzzylite.com'
 abstract: >-

COPYRIGHT

@@ -0,0 +1,6 @@
+pyfuzzylite: a fuzzy logic control library in Python.
+
+fuzzylite is a registered trademark of FuzzyLite.
+pyfuzzylite, jfuzzylite and QtFuzzyLite are trademarks of FuzzyLite.
+
+Copyright (C) 2010-2024 FuzzyLite by Juan Rada-Vilela. All rights reserved.

HISTORY.md

@@ -1,3 +1,14 @@
+# Version 8.0.3
+
+- Renamed `requirements.txt` to `requirements-dev.txt`
+- Added `__author__`, `__copyright__` and `__license__` to `fuzzylite.__init__.py` and `fuzzylite.library.information`
+- Removed `Limited` in `FuzzyLite Limited` everywhere, eg, `fuzzylite.information.company = "FuzzyLite"`
+- `RuleBlock`: Added `RuleBlock.rule(int)` to get rule by index
+- `Function`: Unary functions can be defined in either left or right nodes
+- Upgraded dependencies: `nox`, `poetry`, `mypy`, `pyright`, `black`, `ruff`
+- Improved tests
+- Shortened preamble in every file
+
 # Version 8.0.2
 
 ### Bug fixes

README.md

@@ -1,26 +1,23 @@
-# pyfuzzylite 8.0.2
-
-<img src="https://fuzzylite.github.io/pyfuzzylite/image/fuzzylite.svg" align="left" alt="fuzzylite">
-
-## A Fuzzy Logic Control Library in Python
-
-by [**Juan Rada-Vilela, PhD**](https://fuzzylite.com/about)
-
-<br>
-<br>
+<div align="center">
+<img src="/fuzzylite.png" alt="fuzzylite" width="10%">
+<h1>pyfuzzylite 8.0.3</h1>
+<h2>A Fuzzy Logic Control Library in Python</h2>
+<h3>by <a href="https://fuzzylite.com/about"><b>Juan Rada-Vilela, PhD</b></a></h3>
 
 [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://opensource.org/license/gpl-3-0/)
 [![License: Paid](https://img.shields.io/badge/License-proprietary-blue)](mailto:sales@fuzzylite.com)
 [![Coverage Status](
 https://coveralls.io/repos/github/fuzzylite/pyfuzzylite/badge.svg?branch=main)](
-https://coveralls.io/github/fuzzylite/pyfuzzylite?branch=main)
+https://coveralls.io/github/fuzzylite/pyfuzzylite?branch=main)  
 [![Build](https://github.com/fuzzylite/pyfuzzylite/actions/workflows/build.yml/badge.svg)](
 https://github.com/fuzzylite/pyfuzzylite/actions/workflows/build.yml)
 [![Test](https://github.com/fuzzylite/pyfuzzylite/actions/workflows/test.yml/badge.svg)](
 https://github.com/fuzzylite/pyfuzzylite/actions/workflows/test.yml)
 [![Publish](https://github.com/fuzzylite/pyfuzzylite/actions/workflows/publish.yml/badge.svg)](
 https://github.com/fuzzylite/pyfuzzylite/actions/workflows/publish.yml)
 
+</div>
+
 ## <a name="fuzzylite">FuzzyLite</a>
 
 **The FuzzyLite Libraries for Fuzzy Logic Control** refer to [`fuzzylite`](https://github.com/fuzzylite/fuzzylite/)
@@ -223,7 +220,5 @@ Or using `bibtex`:
 
 ***
 
-fuzzylite&reg; is a registered trademark of FuzzyLite Limited <br>
-jfuzzylite&trade; is a trademark of FuzzyLite Limited <br>
-pyfuzzylite&trade; is a trademark of FuzzyLite Limited <br>
-QtFuzzyLite&trade; is a trademark of FuzzyLite Limited <br>
+fuzzylite&reg; is a registered trademark of FuzzyLite <br>
+jfuzzylite&trade;, pyfuzzylite&trade; and QtFuzzyLite&trade; are trademarks of FuzzyLite

docs/index.md

@@ -1,28 +1,22 @@
-# pyfuzzylite 8.0.2
-
-***
-
-<img src="https://fuzzylite.github.io/pyfuzzylite/image/fuzzylite.svg" align="left" alt="fuzzylite">
-
-## A Fuzzy Logic Control Library in Python
-
-by [**Juan Rada-Vilela, PhD** :fontawesome-solid-square-arrow-up-right:](https://fuzzylite.com/about)
-
-***
+<div align="center">
+<img src="/fuzzylite.png" alt="fuzzylite" width="10%">
+<h1>pyfuzzylite 8.0.3</h1>
+<h2>A Fuzzy Logic Control Library in Python</h2>
+<h3>by <a href="https://fuzzylite.com/about"><b>Juan Rada-Vilela, PhD</b></a></h3>
 
 [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://opensource.org/license/gpl-3-0/)
 [![License: Paid](https://img.shields.io/badge/License-proprietary-blue)](mailto:sales@fuzzylite.com)
 [![Coverage Status](
 https://coveralls.io/repos/github/fuzzylite/pyfuzzylite/badge.svg?branch=main)](
-https://coveralls.io/github/fuzzylite/pyfuzzylite?branch=main)
+https://coveralls.io/github/fuzzylite/pyfuzzylite?branch=main)  
 [![Build](https://github.com/fuzzylite/pyfuzzylite/actions/workflows/build.yml/badge.svg)](
 https://github.com/fuzzylite/pyfuzzylite/actions/workflows/build.yml)
 [![Test](https://github.com/fuzzylite/pyfuzzylite/actions/workflows/test.yml/badge.svg)](
 https://github.com/fuzzylite/pyfuzzylite/actions/workflows/test.yml)
 [![Publish](https://github.com/fuzzylite/pyfuzzylite/actions/workflows/publish.yml/badge.svg)](
 https://github.com/fuzzylite/pyfuzzylite/actions/workflows/publish.yml)
 
-***
+</div>
 
 ## <a name="fuzzylite">FuzzyLite</a>
 
@@ -221,7 +215,5 @@ Or using `bibtex`:
 
 ***
 
-fuzzylite&reg; is a registered trademark of FuzzyLite Limited <br>
-jfuzzylite&trade; is a trademark of FuzzyLite Limited <br>
-pyfuzzylite&trade; is a trademark of FuzzyLite Limited <br>
-QtFuzzyLite&trade; is a trademark of FuzzyLite Limited <br>
+fuzzylite&reg; is a registered trademark of FuzzyLite <br>
+jfuzzylite&trade;, pyfuzzylite&trade; and QtFuzzyLite&trade; are trademarks of FuzzyLite

fuzzylite/__init__.py

@@ -1,21 +1,15 @@
-"""pyfuzzylite (TM), a fuzzy logic control library in Python.
-
-Copyright (C) 2010-2023 FuzzyLite Limited. All rights reserved.
-Author: Juan Rada-Vilela, PhD <jcrada@fuzzylite.com>.
+"""pyfuzzylite: a fuzzy logic control library in Python.
 
 This file is part of pyfuzzylite.
 
-pyfuzzylite is free software: you can redistribute it and/or modify it under
-the terms of the FuzzyLite License included with the software.
-
-You should have received a copy of the FuzzyLite License along with
-pyfuzzylite. If not, see <https://github.com/fuzzylite/pyfuzzylite/>.
+Repository: https://github.com/fuzzylite/pyfuzzylite/
 
-pyfuzzylite is a trademark of FuzzyLite Limited.
+License: FuzzyLite License
 
-fuzzylite is a registered trademark of FuzzyLite Limited.
+Copyright: FuzzyLite by Juan Rada-Vilela. All rights reserved.
 """
-from . import examples  # noqa
+
+from . import examples  # noqa: F401
 from .activation import *
 from .benchmark import *
 from .defuzzifier import *
@@ -35,3 +29,6 @@
 __name__ = information.name
 __doc__ = information.description
 __version__ = information.version
+__author__ = information.author
+__copyright__ = information.copyright
+__license__ = information.license

fuzzylite/activation.py

@@ -1,20 +1,14 @@
-"""pyfuzzylite (TM), a fuzzy logic control library in Python.
-
-Copyright (C) 2010-2023 FuzzyLite Limited. All rights reserved.
-Author: Juan Rada-Vilela, PhD <jcrada@fuzzylite.com>.
+"""pyfuzzylite: a fuzzy logic control library in Python.
 
 This file is part of pyfuzzylite.
 
-pyfuzzylite is free software: you can redistribute it and/or modify it under
-the terms of the FuzzyLite License included with the software.
-
-You should have received a copy of the FuzzyLite License along with
-pyfuzzylite. If not, see <https://github.com/fuzzylite/pyfuzzylite/>.
+Repository: https://github.com/fuzzylite/pyfuzzylite/
 
-pyfuzzylite is a trademark of FuzzyLite Limited.
+License: FuzzyLite License
 
-fuzzylite is a registered trademark of FuzzyLite Limited.
+Copyright: FuzzyLite by Juan Rada-Vilela. All rights reserved.
 """
+
 from __future__ import annotations
 
 __all__ = [

fuzzylite/benchmark.py

@@ -1,19 +1,12 @@
-"""pyfuzzylite (TM), a fuzzy logic control library in Python.
-
-Copyright (C) 2010-2023 FuzzyLite Limited. All rights reserved.
-Author: Juan Rada-Vilela, PhD <jcrada@fuzzylite.com>.
+"""pyfuzzylite: a fuzzy logic control library in Python.
 
 This file is part of pyfuzzylite.
 
-pyfuzzylite is free software: you can redistribute it and/or modify it under
-the terms of the FuzzyLite License included with the software.
-
-You should have received a copy of the FuzzyLite License along with
-pyfuzzylite. If not, see <https://github.com/fuzzylite/pyfuzzylite/>.
+Repository: https://github.com/fuzzylite/pyfuzzylite/
 
-pyfuzzylite is a trademark of FuzzyLite Limited.
+License: FuzzyLite License
 
-fuzzylite is a registered trademark of FuzzyLite Limited.
+Copyright: FuzzyLite by Juan Rada-Vilela. All rights reserved.
 """
 
 from __future__ import annotations

fuzzylite/defuzzifier.py

@@ -1,20 +1,14 @@
-"""pyfuzzylite (TM), a fuzzy logic control library in Python.
-
-Copyright (C) 2010-2023 FuzzyLite Limited. All rights reserved.
-Author: Juan Rada-Vilela, PhD <jcrada@fuzzylite.com>.
+"""pyfuzzylite: a fuzzy logic control library in Python.
 
 This file is part of pyfuzzylite.
 
-pyfuzzylite is free software: you can redistribute it and/or modify it under
-the terms of the FuzzyLite License included with the software.
-
-You should have received a copy of the FuzzyLite License along with
-pyfuzzylite. If not, see <https://github.com/fuzzylite/pyfuzzylite/>.
+Repository: https://github.com/fuzzylite/pyfuzzylite/
 
-pyfuzzylite is a trademark of FuzzyLite Limited.
+License: FuzzyLite License
 
-fuzzylite is a registered trademark of FuzzyLite Limited.
+Copyright: FuzzyLite by Juan Rada-Vilela. All rights reserved.
 """
+
 from __future__ import annotations
 
 __all__ = [

fuzzylite/engine.py

@@ -1,20 +1,14 @@
-"""pyfuzzylite (TM), a fuzzy logic control library in Python.
-
-Copyright (C) 2010-2023 FuzzyLite Limited. All rights reserved.
-Author: Juan Rada-Vilela, PhD <jcrada@fuzzylite.com>.
+"""pyfuzzylite: a fuzzy logic control library in Python.
 
 This file is part of pyfuzzylite.
 
-pyfuzzylite is free software: you can redistribute it and/or modify it under
-the terms of the FuzzyLite License included with the software.
-
-You should have received a copy of the FuzzyLite License along with
-pyfuzzylite. If not, see <https://github.com/fuzzylite/pyfuzzylite/>.
+Repository: https://github.com/fuzzylite/pyfuzzylite/
 
-pyfuzzylite is a trademark of FuzzyLite Limited.
+License: FuzzyLite License
 
-fuzzylite is a registered trademark of FuzzyLite Limited.
+Copyright: FuzzyLite by Juan Rada-Vilela. All rights reserved.
 """
+
 from __future__ import annotations
 
 __all__ = ["Engine"]

fuzzylite/exporter.py

@@ -1,20 +1,14 @@
-"""pyfuzzylite (TM), a fuzzy logic control library in Python.
-
-Copyright (C) 2010-2023 FuzzyLite Limited. All rights reserved.
-Author: Juan Rada-Vilela, PhD <jcrada@fuzzylite.com>.
+"""pyfuzzylite: a fuzzy logic control library in Python.
 
 This file is part of pyfuzzylite.
 
-pyfuzzylite is free software: you can redistribute it and/or modify it under
-the terms of the FuzzyLite License included with the software.
-
-You should have received a copy of the FuzzyLite License along with
-pyfuzzylite. If not, see <https://github.com/fuzzylite/pyfuzzylite/>.
+Repository: https://github.com/fuzzylite/pyfuzzylite/
 
-pyfuzzylite is a trademark of FuzzyLite Limited.
+License: FuzzyLite License
 
-fuzzylite is a registered trademark of FuzzyLite Limited.
+Copyright: FuzzyLite by Juan Rada-Vilela. All rights reserved.
 """
+
 from __future__ import annotations
 
 __all__ = ["Exporter", "FllExporter", "PythonExporter", "FldExporter"]
@@ -386,11 +380,12 @@ def format(self, code: str, **kwargs: Any) -> str:
         Returns:
             code formatted if `black` is installed, otherwise the code without format
         """
-        kwargs = {"line_length": 100} | kwargs
         try:
             import black
 
-            return black.format_str(code, mode=black.Mode(**kwargs))
+            kwargs = dict(line_length=100) | kwargs
+            formatted = black.format_str(code, mode=black.Mode(**kwargs))
+            return formatted
         except ModuleNotFoundError:
             settings.logger.error("expected `black` module to be installed, but could not be found")
         except ValueError:  # black.parsing.InvalidInput
@@ -414,7 +409,6 @@ def encapsulate(self, instance: Any) -> str:
         if isinstance(instance, Engine):
             code += f"""\
 class {Op.pascal_case(instance.name)}:
-
     def __init__(self) -> None:
         self.engine = {repr(instance)}
 """

fuzzylite/factory.py

@@ -1,20 +1,14 @@
-"""pyfuzzylite (TM), a fuzzy logic control library in Python.
-
-Copyright (C) 2010-2023 FuzzyLite Limited. All rights reserved.
-Author: Juan Rada-Vilela, PhD <jcrada@fuzzylite.com>.
+"""pyfuzzylite: a fuzzy logic control library in Python.
 
 This file is part of pyfuzzylite.
 
-pyfuzzylite is free software: you can redistribute it and/or modify it under
-the terms of the FuzzyLite License included with the software.
-
-You should have received a copy of the FuzzyLite License along with
-pyfuzzylite. If not, see <https://github.com/fuzzylite/pyfuzzylite/>.
+Repository: https://github.com/fuzzylite/pyfuzzylite/
 
-pyfuzzylite is a trademark of FuzzyLite Limited.
+License: FuzzyLite License
 
-fuzzylite is a registered trademark of FuzzyLite Limited.
+Copyright: FuzzyLite by Juan Rada-Vilela. All rights reserved.
 """
+
 from __future__ import annotations
 
 __all__ = [

fuzzylite/hedge.py

@@ -1,20 +1,14 @@
-"""pyfuzzylite (TM), a fuzzy logic control library in Python.
-
-Copyright (C) 2010-2023 FuzzyLite Limited. All rights reserved.
-Author: Juan Rada-Vilela, PhD <jcrada@fuzzylite.com>.
+"""pyfuzzylite: a fuzzy logic control library in Python.
 
 This file is part of pyfuzzylite.
 
-pyfuzzylite is free software: you can redistribute it and/or modify it under
-the terms of the FuzzyLite License included with the software.
-
-You should have received a copy of the FuzzyLite License along with
-pyfuzzylite. If not, see <https://github.com/fuzzylite/pyfuzzylite/>.
+Repository: https://github.com/fuzzylite/pyfuzzylite/
 
-pyfuzzylite is a trademark of FuzzyLite Limited.
+License: FuzzyLite License
 
-fuzzylite is a registered trademark of FuzzyLite Limited.
+Copyright: FuzzyLite by Juan Rada-Vilela. All rights reserved.
 """
+
 from __future__ import annotations
 
 __all__ = [