From d8dc0d7403d4d7e5d5bce91089d204bf1627b5c3 Mon Sep 17 00:00:00 2001 From: Massimiliano Pippi Date: Thu, 4 May 2023 15:49:26 +0200 Subject: [PATCH] chore: move custom linter to a separate package (#4790) * move custom linter to its own package * install the custom linter * fix formatting * drop python 3.7 --- .github/workflows/linting.yml | 4 +- haystack-linter/LICENSE | 202 ++++++++++++++++++ haystack-linter/README.md | 22 ++ haystack-linter/haystack_linter/__about__.py | 4 + haystack-linter/haystack_linter/__init__.py | 4 + .../haystack_linter}/linting.py | 4 + haystack-linter/pyproject.toml | 60 ++++++ haystack-linter/tests/__init__.py | 3 + pyproject.toml | 2 +- 9 files changed, 303 insertions(+), 2 deletions(-) create mode 100644 haystack-linter/LICENSE create mode 100644 haystack-linter/README.md create mode 100644 haystack-linter/haystack_linter/__about__.py create mode 100644 haystack-linter/haystack_linter/__init__.py rename {haystack/utils => haystack-linter/haystack_linter}/linting.py (96%) create mode 100644 haystack-linter/pyproject.toml create mode 100644 haystack-linter/tests/__init__.py diff --git a/.github/workflows/linting.yml b/.github/workflows/linting.yml index 9080084a2..cccea2c57 100644 --- a/.github/workflows/linting.yml +++ b/.github/workflows/linting.yml @@ -69,7 +69,9 @@ jobs: python-version: ${{ env.PYTHON_VERSION }} - name: Install Haystack - run: pip install ".[all]" + run: | + pip install ".[all]" + pip install ./haystack-linter - name: Pylint if: steps.files.outputs.any_changed == 'true' diff --git a/haystack-linter/LICENSE b/haystack-linter/LICENSE new file mode 100644 index 000000000..6fb66d8d5 --- /dev/null +++ b/haystack-linter/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2021 deepset GmbH + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/haystack-linter/README.md b/haystack-linter/README.md new file mode 100644 index 000000000..5a8b958b5 --- /dev/null +++ b/haystack-linter/README.md @@ -0,0 +1,22 @@ +# haystack_linter + +[![PyPI - Version](https://img.shields.io/pypi/v/haystack-linter.svg)](https://pypi.org/project/haystack-linter) +[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/haystack-linter.svg)](https://pypi.org/project/haystack-linter) + +----- + +**Table of Contents** + +- [haystack\_linter](#haystack_linter) + - [Installation](#installation) + - [License](#license) + +## Installation + +```console +pip install haystack-linter +``` + +## License + +`haystack-linter` is distributed under the terms of the [Apache License 2.0](https://spdx.org/licenses/Apache-2.0.html) license. diff --git a/haystack-linter/haystack_linter/__about__.py b/haystack-linter/haystack_linter/__about__.py new file mode 100644 index 000000000..858696fbf --- /dev/null +++ b/haystack-linter/haystack_linter/__about__.py @@ -0,0 +1,4 @@ +# SPDX-FileCopyrightText: 2023-present deepset +# +# SPDX-License-Identifier: Apache-2.0 +__version__ = "0.0.1" diff --git a/haystack-linter/haystack_linter/__init__.py b/haystack-linter/haystack_linter/__init__.py new file mode 100644 index 000000000..9c6a149fd --- /dev/null +++ b/haystack-linter/haystack_linter/__init__.py @@ -0,0 +1,4 @@ +# SPDX-FileCopyrightText: 2023-present deepset +# +# SPDX-License-Identifier: Apache-2.0 +from .linting import register diff --git a/haystack/utils/linting.py b/haystack-linter/haystack_linter/linting.py similarity index 96% rename from haystack/utils/linting.py rename to haystack-linter/haystack_linter/linting.py index 5629db002..a55bfab84 100644 --- a/haystack/utils/linting.py +++ b/haystack-linter/haystack_linter/linting.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2023-present deepset +# +# SPDX-License-Identifier: Apache-2.0 +# # https://pylint.pycqa.org/en/latest/development_guide/how_tos/custom_checkers.html from typing import TYPE_CHECKING, Optional, List, Any diff --git a/haystack-linter/pyproject.toml b/haystack-linter/pyproject.toml new file mode 100644 index 000000000..22ab4c02c --- /dev/null +++ b/haystack-linter/pyproject.toml @@ -0,0 +1,60 @@ +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" + +[project] +name = "haystack-linter" +description = '' +readme = "README.md" +requires-python = ">=3.8" +license = "Apache-2.0" +keywords = [] +authors = [ + { name = "deepset.ai", email = "info@deepset.ai" }, +] +classifiers = [ + "Development Status :: 4 - Beta", + "Programming Language :: Python", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: Implementation :: CPython", + "Programming Language :: Python :: Implementation :: PyPy", +] +dependencies = [] +dynamic = ["version"] + +[project.urls] +Documentation = "https://github.com/unknown/haystack-linter#readme" +Issues = "https://github.com/unknown/haystack-linter/issues" +Source = "https://github.com/unknown/haystack-linter" + +[tool.hatch.version] +path = "haystack_linter/__about__.py" + +[tool.hatch.envs.default] +dependencies = [ + "pytest", + "pytest-cov", +] +[tool.hatch.envs.default.scripts] +cov = "pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=haystack_linter --cov=tests {args}" +no-cov = "cov --no-cov {args}" + +[[tool.hatch.envs.test.matrix]] +python = ["38", "39", "310", "311"] + +[tool.coverage.run] +branch = true +parallel = true +omit = [ + "haystack_linter/__about__.py", +] + +[tool.coverage.report] +exclude_lines = [ + "no cov", + "if __name__ == .__main__.:", + "if TYPE_CHECKING:", +] diff --git a/haystack-linter/tests/__init__.py b/haystack-linter/tests/__init__.py new file mode 100644 index 000000000..af1543e3a --- /dev/null +++ b/haystack-linter/tests/__init__.py @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2023-present deepset +# +# SPDX-License-Identifier: Apache-2.0 diff --git a/pyproject.toml b/pyproject.toml index 7be67269a..6b54a9235 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -267,7 +267,7 @@ skip_magic_trailing_comma = true # For compatibility with pydoc>=4.6, check if [tool.pylint.'MESSAGES CONTROL'] max-line-length=120 -load-plugins = "haystack.utils.linting" +load-plugins = "haystack_linter" disable = [ # To keep