Maintenance updates (#23)

yarnabrina · web-flow · commit e2011d83761d · 2023-10-24T16:03:21.000+05:30
* pre-commit autoupdate * updated ruff configurations * update read the docs python version * show line number in documentation * added version bounds * updated dependabot configuration * bump version * change workflow run conditions * added operating system tag * increased number of parallel matrix jobs * Revert "update read the docs python version" This reverts commit cc0cfee. * fixed typo * Revert "fixed typo" This reverts commit 5142d99. * debug commit * added dispatch support * configure codecov * debug commit * revert debug commits
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -3,18 +3,23 @@ updates:
   - package-ecosystem: pip
     directory: /
     schedule:
-      interval: daily
+      interval: monthly
     commit-message:
-      prefix: "[Dependabot]"
+      prefix: "[Dependabot] [PIP]"
       include: "scope"
     labels:
       - maintenance
+      - bump-pip
   - package-ecosystem: github-actions
     directory: /
     schedule:
-      interval: daily
+      interval: weekly
+      day: sunday
+      time: 00:00
+      timezone: Asia/Calcutta
     commit-message:
-      prefix: "[Dependabot]"
+      prefix: "[Dependabot] [GHA]"
       include: "scope"
     labels:
       - maintenance
+      - bump-gha
diff --git a/.github/workflows/format.yml b/.github/workflows/format.yml
@@ -1,12 +1,6 @@
 name: format-workflow-name
 run-name: format workflow run name
-on:
-  pull_request:
-    branches:
-      - main
-    types:
-      - opened
-      - synchronize
+on: workflow_dispatch
 defaults:
   run:
     shell: bash
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -1,12 +1,6 @@
 name: lint-workflow-name
 run-name: lint workflow run name
-on:
-  pull_request:
-    branches:
-      - main
-    types:
-      - opened
-      - synchronize
+on: workflow_dispatch
 defaults:
   run:
     shell: bash
diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml
@@ -1,6 +1,16 @@
 name: pre-commit-workflow-name
 run-name: pre-commit workflow run name
-on: push
+on:
+  pull_request:
+    branches:
+      - main
+    types:
+      - opened
+      - synchronize
+  push:
+    branches:
+      - main
+  workflow_dispatch:
 defaults:
   run:
     shell: bash
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -1,20 +1,18 @@
 name: test-workflow-name
 run-name: test workflow run name
 on:
-  pull_request:
-    branches:
-      - main
+  workflow_dispatch:
+  workflow_run:
+    workflows:
+      - pre-commit-workflow-name
     types:
-      - opened
-      - synchronize
-  push:
-    branches:
-      - main
+      - completed
 defaults:
   run:
     shell: bash
 jobs:
   test-job-identifier:
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
     name: test job name
     strategy:
       fail-fast: false
@@ -27,7 +25,7 @@ jobs:
           - "3.10"
           - "3.11"
           - "3.12"
-      max-parallel: 2
+      max-parallel: 5
     runs-on: ${{ matrix.runner-platform }}
     steps:
       - name: checkout commit
@@ -49,4 +47,4 @@ jobs:
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           files: coverage_xml_report.xml
-          flags: ${{ matrix.python-version }}
+          flags: ${{ matrix.python-version }},${{ matrix.runner-platform }}
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -42,7 +42,7 @@ repos:
           - src
         pass_filenames: false
   - repo: https://github.com/psf/black
-    rev: 23.9.1
+    rev: 23.10.1
     hooks:
       - id: black
         args:
@@ -68,7 +68,7 @@ repos:
           - src
         pass_filenames: false
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.5.1
+    rev: v1.6.1
     hooks:
       - id: mypy
         additional_dependencies:
@@ -88,14 +88,14 @@ repos:
         stages:
           - manual
   - repo: https://github.com/RobertCraigie/pyright-python
-    rev: v1.1.330.post0
+    rev: v1.1.332
     hooks:
       - id: pyright
         pass_filenames: false
         stages:
           - manual
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.0.292
+    rev: v0.1.1
     hooks:
       - id: ruff
         args:
@@ -146,7 +146,7 @@ repos:
     hooks:
       - id: pyproject-fmt
   - repo: https://github.com/abravalheri/validate-pyproject
-    rev: v0.14
+    rev: v0.15
     hooks:
       - id: validate-pyproject
   - repo: https://github.com/codespell-project/codespell
diff --git a/codecov.yml b/codecov.yml
@@ -0,0 +1,12 @@
+codecov:
+  require_ci_to_pass: true
+coverage:
+  status:
+    project:
+      default:
+        target: 80%
+ignore:
+  - "**/tests/*.py"
+comment:
+  layout: "reach, flags"
+  behavior: new
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -63,6 +63,7 @@
 todo_include_todos = True
 
 viewcode_follow_imported_members = True
+viewcode_line_numbers = True
 
 copybutton_prompt_text = r">>> |\.\.\. |\$ "
 copybutton_prompt_is_regexp = True
diff --git a/pyproject.toml b/pyproject.toml
@@ -6,7 +6,7 @@ requires = [
 
 [project]
 name = "package-name-to-install-with"
-version = "0.0.2"
+version = "0.0.3"
 description = "A small example package"
 keywords = [
   "development",
@@ -53,8 +53,8 @@ dynamic=[
   "readme",
 ]
 dependencies = [
-  "pydantic",
-  "PySimpleGUI",
+  "pydantic<3,>=2.4.2",
+  "PySimpleGUI<4.61,>=4.60.4",
 ]
 [project.optional-dependencies]
 all = [
@@ -181,53 +181,76 @@ extend-exclude = [
 ]
 fix = true
 ignore = [
-  "ANN401",
+  "COM",
   "D203",
   "D213",
+  "DTZ",
+  "EM",
+  "FBT",
+  "FIX",
+  "G",
+  "ICN",
+  "PD",
+  "RET501",
+  "RET502",
+  "RET503",
+  "RET504",
+  "SLF",
   "TRY003",
 ]
 ignore-init-module-imports = true
 line-length = 99
 output-format = "grouped"
 select = [
-  "F",
-  "E",
-  "W",
-  "C90",
-  "I",
-  "N",
-  "D",
-  "UP",
-  "ANN",
-  "S",
-  "B",
-  "A",
-  "C4",
-  "T10",
-  "ISC",
-  "G",
-  "T20",
-  "PT",
-  "Q",
-  "SIM",
-  "TID",
-  "ERA",
-  "PD",
-  "PGH",
-  "PL",
-  "TRY",
-  "RUF",
+  "ALL",
 ]
 src = [
   "src",
 ]
 target-version = "py310"
 
+[tool.ruff.flake8-annotations]
+allow-star-arg-any = true
+ignore-fully-untyped = true
+
+[tool.ruff.flake8-bugbear]
+extend-immutable-calls = [
+  "fastapi.Depends",
+  "fastapi.Query",
+]
+
+[tool.ruff.flake8-type-checking]
+exempt-modules = [
+  "typing",
+  "typing_extensions",
+]
+runtime-evaluated-base-classes = [
+  "pydantic.BaseModel",
+]
+
+[tool.ruff.pep8-naming]
+classmethod-decorators = ["pydantic.field_validator"]
+
 [tool.ruff.per-file-ignores]
+"**/__init__.py" = [
+  "F401",
+]
 "**/test_*.py" = [
   "S101",
 ]
 
+[tool.ruff.pycodestyle]
+max-doc-length = 99
+
+[tool.ruff.pydocstyle]
+convention = "numpy"
+ignore-decorators = [
+  "typing.overload",
+]
+
+[tool.ruff.pyupgrade]
+keep-runtime-typing = true
+
 [tool.isort]
 overwrite_in_place = true
 profile = "black"
@@ -329,6 +352,9 @@ logging-format-style = "new"
 enable = [
   "all",
 ]
+disable = [
+  "logging-fstring-interpolation",
+]
 
 [tool.pylint.reports]
 output-format = "colorized"
diff --git a/requirements/requirements.txt b/requirements/requirements.txt
@@ -1,2 +1,2 @@
-pydantic
-PySimpleGUI
+pydantic<3,>=2.4.2
+PySimpleGUI<4.61,>=4.60.4
diff --git a/src/module_that_can_be_invoked_from_cli.py b/src/module_that_can_be_invoked_from_cli.py
@@ -37,7 +37,7 @@ def console_calculator() -> None:
         operation_result = package_name_to_import_with.calculate_results(
             user_inputs["first_number"], user_inputs["operator"], user_inputs["second_number"]
         )
-    except Exception as error:  # pylint: disable=broad-except
+    except Exception as error:  # noqa: BLE001  # pylint: disable=broad-except
         sys.stderr.write(f"Error: {error}")
     else:
         sys.stdout.write(f"Result = {operation_result}")
diff --git a/src/module_that_can_invoke_gui_from_cli.py b/src/module_that_can_invoke_gui_from_cli.py
@@ -77,7 +77,7 @@ def orchestrate_interaction(gui_window: pydantic.InstanceOf[PySimpleGUI.Window])
                 gui_elements[OPERATOR_INPUT],
                 gui_elements[SECOND_NUMBER_INPUT],
             )
-        except Exception as error:  # pylint: disable=broad-except
+        except Exception as error:  # noqa: BLE001  # pylint: disable=broad-except
             gui_window[OPERATION_RESULT].update(value=str(error))
         else:
             gui_window[OPERATION_RESULT].update(value=operation_result)
diff --git a/src/package_name_to_import_with/calculator_sub_package/tests/test_wrappers.py b/src/package_name_to_import_with/calculator_sub_package/tests/test_wrappers.py
@@ -46,7 +46,7 @@ def test_successful_operation(
     ],
 )
 def test_operation_failure(
-    first_input: typing.Any, operator: typing.Any, second_input: typing.Any
+    first_input: typing.Any, operator: typing.Any, second_input: typing.Any  # noqa: ANN401
 ) -> None:
     """Check failure during calculations.
 
diff --git a/src/package_name_to_import_with/garbage_collection_module.py b/src/package_name_to_import_with/garbage_collection_module.py
@@ -25,7 +25,7 @@ def define_garbage_collection_decorator(
     """
 
     @functools.wraps(function_to_be_decorated)
-    def wrapper_function(*args: typing.Any, **kwargs: typing.Any) -> typing.Any:
+    def wrapper_function(*args: typing.Any, **kwargs: typing.Any) -> typing.Any:  # noqa: ANN401
         """Execute provided function with forceful garbage collection afterwards.
 
         Parameters
diff --git a/src/package_name_to_import_with/metadata.json b/src/package_name_to_import_with/metadata.json
@@ -1,4 +1,4 @@
 {
     "Name": "package-name-to-install-with",
-    "Version": "0.0.2"
+    "Version": "0.0.3"
 }
