diff --git a/.cruft.json b/.cruft.json index 40cbfcc..1a59ea6 100644 --- a/.cruft.json +++ b/.cruft.json @@ -1,6 +1,6 @@ { "template": "https://github.com/woltapp/wolt-python-package-cookiecutter", - "commit": "4eecc9c4d27e3c9321438bc1fdaf717bec5eadf6", + "commit": "b25684a2c63387153b83a1cc03ea332be8c8279a", "checkout": null, "context": { "cookiecutter": { diff --git a/.github/actions/python-poetry-env/action.yml.rej b/.github/actions/python-poetry-env/action.yml.rej new file mode 100644 index 0000000..35a35ba --- /dev/null +++ b/.github/actions/python-poetry-env/action.yml.rej @@ -0,0 +1,16 @@ +diff a/.github/actions/python-poetry-env/action.yml b/.github/actions/python-poetry-env/action.yml (rejected hunks) +@@ -5,12 +5,12 @@ inputs: + python-version: + required: false + description: 'Python version' +- default: '3.10' ++ default: '3.12' + outputs: {} + runs: + using: 'composite' + steps: +- - uses: actions/setup-python@v4 ++ - uses: actions/setup-python@v5 + with: + python-version: ${{inputs.python-version}} + - name: Install poetry diff --git a/.github/workflows/cookiecutter.yml b/.github/workflows/cookiecutter.yml index 556f468..c9886db 100644 --- a/.github/workflows/cookiecutter.yml +++ b/.github/workflows/cookiecutter.yml @@ -8,11 +8,11 @@ jobs: auto-update-project: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - name: Set up Python - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: - python-version: 3.9 + python-version: "3.12" - name: Install dependencies run: python -m pip install cruft poetry jello tabulate diff --git a/.github/workflows/dependencies.yml b/.github/workflows/dependencies.yml index f7a6f51..a657d27 100644 --- a/.github/workflows/dependencies.yml +++ b/.github/workflows/dependencies.yml @@ -8,7 +8,7 @@ jobs: auto-update-dependencies: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - uses: ./.github/actions/python-poetry-env - name: Install tabulate diff --git a/.github/workflows/draft_release.yml b/.github/workflows/draft_release.yml index 9f8b0f3..5729bf4 100644 --- a/.github/workflows/draft_release.yml +++ b/.github/workflows/draft_release.yml @@ -12,7 +12,7 @@ jobs: draft-release: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - uses: ./.github/actions/python-poetry-env - name: Update version id: updated_version diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 09929d4..070b134 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -8,7 +8,7 @@ jobs: build-and-publish: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - uses: ./.github/actions/python-poetry-env - name: Publish to pypi run: | diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 20ad288..42a0fcf 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -10,7 +10,7 @@ jobs: actionlint: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - name: Download actionlint run: bash <(curl https://raw.githubusercontent.com/rhysd/actionlint/main/scripts/download-actionlint.bash) 1.6.21 shell: bash @@ -22,14 +22,14 @@ jobs: name: Check if automatic project update was successful runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - name: Fail if .rej files exist as structure update was not successful run: test -z "$(find . -iname '*.rej')" pre-commit: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - uses: ./.github/actions/python-poetry-env - run: poetry run pre-commit run --all-files diff --git a/.github/workflows/test.yml.rej b/.github/workflows/test.yml.rej new file mode 100644 index 0000000..2b17ffd --- /dev/null +++ b/.github/workflows/test.yml.rej @@ -0,0 +1,21 @@ +diff a/.github/workflows/test.yml b/.github/workflows/test.yml (rejected hunks) +@@ -38,10 +38,17 @@ jobs: + strategy: + fail-fast: false + matrix: +- python-version: ["3.7", "3.8", "3.9", "3.10"] ++ python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"] + steps: +- - uses: actions/checkout@v2 ++ - uses: actions/checkout@v4 + - uses: ./.github/actions/python-poetry-env + with: + python-version: ${{ matrix.python-version }} + - run: poetry run pytest ++ ++ docs: ++ runs-on: ubuntu-latest ++ steps: ++ - uses: actions/checkout@v4 ++ - uses: ./.github/actions/python-poetry-env ++ - run: poetry run mkdocs build diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index bb125fd..efe1796 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -11,30 +11,24 @@ repos: - id: check-yaml - id: debug-statements - id: end-of-file-fixer + exclude: 'CHANGELOG.md' - id: trailing-whitespace - id: mixed-line-ending - repo: local hooks: - - id: autoflake - name: autoflake - entry: poetry run autoflake -r -i --remove-all-unused-imports --remove-unused-variables + - id: ruff-format + name: ruff-format + entry: poetry run ruff format + require_serial: true language: system types: [ python ] - - id: isort - name: isort - entry: poetry run isort - language: system - types: [python] - - id: black - name: black - entry: poetry run black - language: system - types: [python] - - id: pyupgrade - name: pyupgrade - entry: poetry run pyupgrade --py37-plus + - id: ruff + name: ruff + # Add --fix, in case you want it to autofix when this hook runs + entry: poetry run ruff check --force-exclude + require_serial: true language: system - types: [python] + types: [ python ] - id: mypy name: mypy entry: poetry run mypy . @@ -42,11 +36,6 @@ repos: language: system types: [python] pass_filenames: false - - id: flake8 - name: flake8 - entry: poetry run flake8 - language: system - types: [python] - id: kacl-verify name: kacl-verify entry: poetry run kacl-cli verify diff --git a/LICENCE b/LICENSE similarity index 100% rename from LICENCE rename to LICENSE diff --git a/LICENSE.rej b/LICENSE.rej new file mode 100644 index 0000000..fada1f2 --- /dev/null +++ b/LICENSE.rej @@ -0,0 +1,9 @@ +diff a/LICENSE b/LICENSE (rejected hunks) +@@ -1,6 +1,6 @@ + The MIT License (MIT) + +-Copyright (c) 2021 Adnan M. Niazi ++Copyright (c) 2024 Adnan M. Niazi + + 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 diff --git a/README.md b/README.md index f8aa132..efdb53f 100644 --- a/README.md +++ b/README.md @@ -77,9 +77,8 @@ pytest ### Documentation -The documentation is automatically generated from the content of the [docs directory](./docs) and from the docstrings - of the public signatures of the source code. The documentation is updated and published as a [Github project page - ](https://pages.github.com/) automatically as part each release. +The documentation is automatically generated from the content of the [docs directory](https://github.com/adnaniazi/capfinder/tree/master/docs) and from the docstrings + of the public signatures of the source code. The documentation is updated and published as a [Github Pages page](https://pages.github.com/) automatically as part each release. ### Releasing @@ -93,7 +92,7 @@ Find the draft release from the ### Pre-commit -Pre-commit hooks run all the auto-formatters (e.g. `black`, `isort`), linters (e.g. `mypy`, `flake8`), and other quality +Pre-commit hooks run all the auto-formatting (`ruff format`), linters (e.g. `ruff` and `mypy`), and other quality checks to make sure the changeset is in good shape before a commit/push happens. You can install the hooks with (runs for each commit): diff --git a/README.md.rej b/README.md.rej new file mode 100644 index 0000000..121b2c1 --- /dev/null +++ b/README.md.rej @@ -0,0 +1,10 @@ +diff a/README.md b/README.md (rejected hunks) +@@ -29,7 +29,7 @@ pip install capfinder + * Clone this repository + * Requirements: + * [Poetry](https://python-poetry.org/) +- * Python 3.7+ ++ * Python 3.8+ + * Create a virtual environment and install the dependencies + + ```sh diff --git a/mkdocs.yml b/mkdocs.yml index 440ce27..172d512 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -28,9 +28,7 @@ plugins: default_handler: python handlers: python: - rendering: + options: show_signature_annotations: true show_source: true show_submodules: true - watch: - - src/capfinder diff --git a/poetry.lock b/poetry.lock index c72c74d..010df83 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1,4 +1,4 @@ -# This file is automatically @generated by Poetry 1.8.2 and should not be changed by hand. +# This file is automatically @generated by Poetry 1.8.3 and should not be changed by hand. [[package]] name = "absl-py" @@ -1351,6 +1351,7 @@ description = "Python AST that abstracts the underlying Python version" optional = false python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,>=2.7" files = [ + {file = "gast-0.6.0-py3-none-any.whl", hash = "sha256:52b182313f7330389f72b069ba00f174cfe2a06411099547288839c6cbafbd54"}, {file = "gast-0.6.0.tar.gz", hash = "sha256:88fc5300d32c7ac6ca7b515310862f71e6fdf2c029bbec7c66c0f5dd47b6b1fb"}, ] @@ -2291,6 +2292,7 @@ description = "Clang Python Bindings, mirrored from the official LLVM repo: http optional = false python-versions = "*" files = [ + {file = "libclang-18.1.1-1-py2.py3-none-macosx_11_0_arm64.whl", hash = "sha256:0b2e143f0fac830156feb56f9231ff8338c20aecfe72b4ffe96f19e5a1dbb69a"}, {file = "libclang-18.1.1-py2.py3-none-macosx_10_9_x86_64.whl", hash = "sha256:6f14c3f194704e5d09769108f03185fce7acaf1d1ae4bbb2f30a72c2400cb7c5"}, {file = "libclang-18.1.1-py2.py3-none-macosx_11_0_arm64.whl", hash = "sha256:83ce5045d101b669ac38e6da8e58765f12da2d3aafb3b9b98d88b286a60964d8"}, {file = "libclang-18.1.1-py2.py3-none-manylinux2010_x86_64.whl", hash = "sha256:c533091d8a3bbf7460a00cb6c1a71da93bffe148f172c7d03b1c31fbf8aa2a0b"}, @@ -4341,6 +4343,7 @@ files = [ {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:69b023b2b4daa7548bcfbd4aa3da05b3a74b772db9e23b982788168117739938"}, {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:81e0b275a9ecc9c0c0c07b4b90ba548307583c125f54d5b6946cfee6360c733d"}, {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ba336e390cd8e4d1739f42dfe9bb83a3cc2e80f567d8805e11b46f4a943f5515"}, + {file = "PyYAML-6.0.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:326c013efe8048858a6d312ddd31d56e468118ad4cdeda36c719bf5bb6192290"}, {file = "PyYAML-6.0.1-cp310-cp310-win32.whl", hash = "sha256:bd4af7373a854424dabd882decdc5579653d7868b8fb26dc7d0e99f823aa5924"}, {file = "PyYAML-6.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:fd1592b3fdf65fff2ad0004b5e363300ef59ced41c2e6b3a99d4089fa8c5435d"}, {file = "PyYAML-6.0.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:6965a7bc3cf88e5a1c3bd2e0b5c22f8d677dc88a455344035f03399034eb3007"}, @@ -4348,8 +4351,16 @@ files = [ {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:42f8152b8dbc4fe7d96729ec2b99c7097d656dc1213a3229ca5383f973a5ed6d"}, {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:062582fca9fabdd2c8b54a3ef1c978d786e0f6b3a1510e0ac93ef59e0ddae2bc"}, {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d2b04aac4d386b172d5b9692e2d2da8de7bfb6c387fa4f801fbf6fb2e6ba4673"}, + {file = "PyYAML-6.0.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:e7d73685e87afe9f3b36c799222440d6cf362062f78be1013661b00c5c6f678b"}, {file = "PyYAML-6.0.1-cp311-cp311-win32.whl", hash = "sha256:1635fd110e8d85d55237ab316b5b011de701ea0f29d07611174a1b42f1444741"}, {file = "PyYAML-6.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34"}, + {file = "PyYAML-6.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28"}, + {file = "PyYAML-6.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9"}, + {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a08c6f0fe150303c1c6b71ebcd7213c2858041a7e01975da3a99aed1e7a378ef"}, + {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0"}, + {file = "PyYAML-6.0.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4"}, + {file = "PyYAML-6.0.1-cp312-cp312-win32.whl", hash = "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54"}, + {file = "PyYAML-6.0.1-cp312-cp312-win_amd64.whl", hash = "sha256:0d3304d8c0adc42be59c5f8a4d9e3d7379e6955ad754aa9d6ab7a398b59dd1df"}, {file = "PyYAML-6.0.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:50550eb667afee136e9a77d6dc71ae76a44df8b3e51e41b77f6de2932bfe0f47"}, {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1fe35611261b29bd1de0070f0b2f47cb6ff71fa6595c077e42bd0c419fa27b98"}, {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:704219a11b772aea0d8ecd7058d0082713c3562b4e271b849ad7dc4a5c90c13c"}, @@ -4366,6 +4377,7 @@ files = [ {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a0cd17c15d3bb3fa06978b4e8958dcdc6e0174ccea823003a106c7d4d7899ac5"}, {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:28c119d996beec18c05208a8bd78cbe4007878c6dd15091efb73a30e90539696"}, {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7e07cbde391ba96ab58e532ff4803f79c4129397514e1413a7dc761ccd755735"}, + {file = "PyYAML-6.0.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:49a183be227561de579b4a36efbb21b3eab9651dd81b1858589f796549873dd6"}, {file = "PyYAML-6.0.1-cp38-cp38-win32.whl", hash = "sha256:184c5108a2aca3c5b3d3bf9395d50893a7ab82a38004c8f61c258d4428e80206"}, {file = "PyYAML-6.0.1-cp38-cp38-win_amd64.whl", hash = "sha256:1e2722cc9fbb45d9b87631ac70924c11d3a401b2d7f410cc0e3bbf249f2dca62"}, {file = "PyYAML-6.0.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:9eb6caa9a297fc2c2fb8862bc5370d0303ddba53ba97e71f08023b6cd73d16a8"}, @@ -4373,6 +4385,7 @@ files = [ {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5773183b6446b2c99bb77e77595dd486303b4faab2b086e7b17bc6bef28865f6"}, {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b786eecbdf8499b9ca1d697215862083bd6d2a99965554781d0d8d1ad31e13a0"}, {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bc1bf2925a1ecd43da378f4db9e4f799775d6367bdb94671027b73b393a7c42c"}, + {file = "PyYAML-6.0.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5"}, {file = "PyYAML-6.0.1-cp39-cp39-win32.whl", hash = "sha256:faca3bdcf85b2fc05d06ff3fbc1f83e1391b3e724afa3feba7d13eeab355484c"}, {file = "PyYAML-6.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:510c9deebc5c0225e8c96813043e62b680ba2f9c50a08d3724c7f28a747d1486"}, {file = "PyYAML-6.0.1.tar.gz", hash = "sha256:bfdf460b1736c775f2ba9f6a92bca30bc2095067b8a9d77876d1fad6cc3b4a43"}, diff --git a/pyproject.toml.rej b/pyproject.toml.rej new file mode 100644 index 0000000..56a1699 --- /dev/null +++ b/pyproject.toml.rej @@ -0,0 +1,124 @@ +diff a/pyproject.toml b/pyproject.toml (rejected hunks) +@@ -18,9 +18,11 @@ classifiers = [ + "Operating System :: OS Independent", + "Programming Language :: Python", + "Programming Language :: Python :: 3", +- "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", ++ "Programming Language :: Python :: 3.10", ++ "Programming Language :: Python :: 3.11", ++ "Programming Language :: Python :: 3.12", + "Topic :: Software Development :: Libraries :: Python Modules", + "Typing :: Typed", + ] +@@ -30,43 +32,54 @@ packages = [ + ] + + [tool.poetry.dependencies] +-python = ">=3.7.1, <4.0" +- +-[tool.poetry.dev-dependencies] +-autoflake = "*" +-black = "*" +-flake8 = "*" +-flake8-bugbear = "*" +-flake8-builtins = "*" +-flake8-comprehensions = "*" +-flake8-debugger = "*" +-flake8-eradicate = "*" +-flake8-logging-format = "*" +-isort = "*" +-mkdocstrings = {version = ">=0.18", extras = ["python"]} ++python = ">=3.8.1, <4.0" ++ ++[tool.poetry.group.dev.dependencies] ++mkdocstrings = {version = ">=0.23", extras = ["python"]} + mkdocs-material = "*" + mypy = "*" +-pep8-naming = "*" + pre-commit = "*" + pymdown-extensions = "*" + pytest = "*" + pytest-github-actions-annotate-failures = "*" + pytest-cov = "*" + python-kacl = "*" +-pyupgrade = "*" +-tryceratops = "*" ++ruff = ">=0.2.0" + + [build-system] + requires = ["poetry-core>=1.0.0"] + build-backend = "poetry.core.masonry.api" + +-[tool.isort] +-profile = "black" +-src_paths = ["src", "tests"] ++[tool.ruff] ++target-version = "py38" # The lowest supported version ++ ++[tool.ruff.lint] ++# By default, enable all the lint rules. ++# Add to the ignore list below if you don't want some rules. ++# If you need some ignores for certain modules, see tool.ruff.lint.per-file-ignores below. ++# For individual ignore cases, prefer inline `# noqa`s within the code. ++select = ["ALL"] ++ignore = [ ++ "ANN", # Type hints related, let mypy handle these. ++ "D", # Docstrings related, way too strict to our taste ++ ] ++ ++[tool.ruff.lint.per-file-ignores] ++"tests/**" = [ ++ "S101", # "Use of `assert` detected" ++ "ARG", # "Unused function argument". Fixtures are often unused. ++ "S105", # "Possible hardcoded password". ++] ++ ++[tool.ruff.lint.mccabe] ++max-complexity = 10 + +-[tool.black] +-target-version = ["py37", "py38", "py39"] +-include = '\.pyi?$' ++[tool.ruff.lint.pep8-naming] ++classmethod-decorators = [ ++ "classmethod", ++ "pydantic.validator", ++ "pydantic.root_validator", ++] + + [tool.pytest.ini_options] + addopts = """\ +@@ -84,12 +97,23 @@ exclude_lines = [ + ] + + [tool.mypy] ++# This is the global mypy configuration. ++# Avoid changing this! ++strict = true # See all the enabled flags `mypy --help | grep -A 10 'Strict mode'` + disallow_any_unimported = true +-disallow_untyped_defs = true +-no_implicit_optional = true +-strict_equality = true +-warn_unused_ignores = true +-warn_redundant_casts = true +-warn_return_any = true +-check_untyped_defs = true +-show_error_codes = true ++ ++# If you need to ignore something for some specific module, ++# add overrides for them. Avoid changing the global config! ++# For example: ++# [[tool.mypy.overrides]] ++# module = [ ++# "my_unpyted_dependency1.*", ++# "my_unpyted_dependency2.*" ++# ] ++# ignore_missing_imports = true ++ ++# [[tool.mypy.overrides]] ++# module = [ ++# "tests/my_thing/test_my_thing", ++# ] ++# disallow_untyped_defs = false