Merge remote-tracking branch 'upstream/main' into glossary

Author: RDaxini

.github/workflows/top-ranked-issues.yml

@@ -0,0 +1,34 @@
+name: Update Top Ranked Issues
+
+on:
+  # For testing purposes (can be removed later)
+  pull_request:  
+  schedule:
+    # # Runs every day at 3:00 AM UTC
+    # - cron: '0 3 * * *'
+    - cron: '*/10 * * * *'
+
+jobs:
+  run-script:
+    runs-on: ubuntu-latest
+
+    env:
+      GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    steps:
+      - name: Check out the repository
+        uses: actions/checkout@v4  # This ensures the repository code is available
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install PyGithub
+
+      - name: Run update_top_ranking_issues.py
+        run: |
+          python ./scripts/update_top_ranking_issues.py

docs/sphinx/source/whatsnew/v0.11.2.rst

@@ -29,8 +29,16 @@ Requirements
 ~~~~~~~~~~~~
 
 
+Maintenance
+~~~~~~~~~~~
+* Added a decorator to deprecate renamed keyword arguments in functions,
+  :py:func:`pvlib._deprecation.renamed_kwarg_warning`. (:pull:`2237`)
+
+
 Contributors
 ~~~~~~~~~~~~
 * Cliff Hansen (:ghuser:`cwhanse`)
 * Rajiv Daxini (:ghuser:`RDaxini`)
-
+* Mark Mikofski (:ghuser:`mikofski`)
+* matsuobasho (:ghuser:`matsuobasho`)
+* Echedey Luis (:ghuser:`echedey-ls`)

pvlib/tests/test__deprecation.py

@@ -5,10 +5,56 @@
 import pytest
 
 from pvlib import _deprecation
+from .conftest import fail_on_pvlib_version
 
 import warnings
 
 
+@pytest.mark.xfail(strict=True,
+                   reason='fail_on_pvlib_version should cause test to fail')
+@fail_on_pvlib_version('0.0')
+def test_fail_on_pvlib_version():
+    pass  # pragma: no cover
+
+
+@fail_on_pvlib_version('100000.0')
+def test_fail_on_pvlib_version_pass():
+    pass
+
+
+@pytest.mark.xfail(strict=True, reason='ensure that the test is called')
+@fail_on_pvlib_version('100000.0')
+def test_fail_on_pvlib_version_fail_in_test():
+    raise Exception
+
+
+# set up to test using fixtures with function decorated with
+# conftest.fail_on_pvlib_version
+@pytest.fixture
+def some_data():
+    return "some data"
+
+
+def alt_func(*args):
+    return args
+
+
+@pytest.fixture
+def deprec_func():
+    return _deprecation.deprecated(
+        "350.8", alternative="alt_func", name="deprec_func", removal="350.9"
+    )(alt_func)
+
+
+@fail_on_pvlib_version('350.9')
+def test_use_fixture_with_decorator(some_data, deprec_func):
+    # test that the correct data is returned by the some_data fixture
+    assert some_data == "some data"
+    with pytest.warns(_deprecation.pvlibDeprecationWarning):
+        # test for custom deprecation warning provided by pvlib
+        deprec_func(some_data)
+
+
 @pytest.fixture
 def renamed_kwarg_func():
     """Returns a function decorated by renamed_kwarg_warning.

pvlib/tests/test_conftest.py

@@ -1,50 +1,6 @@
 import pytest
-import pandas
 
 from pvlib.tests import conftest
-from pvlib.tests.conftest import fail_on_pvlib_version
-
-from pvlib._deprecation import pvlibDeprecationWarning, deprecated
-
-@pytest.mark.xfail(strict=True,
-                   reason='fail_on_pvlib_version should cause test to fail')
-@fail_on_pvlib_version('0.0')
-def test_fail_on_pvlib_version():
-    pass
-
-
-@fail_on_pvlib_version('100000.0')
-def test_fail_on_pvlib_version_pass():
-    pass
-
-
-@pytest.mark.xfail(strict=True, reason='ensure that the test is called')
-@fail_on_pvlib_version('100000.0')
-def test_fail_on_pvlib_version_fail_in_test():
-    raise Exception
-
-
-# set up to test using fixtures with function decorated with
-# conftest.fail_on_pvlib_version
-@pytest.fixture()
-def some_data():
-    return "some data"
-
-
-def alt_func(*args):
-    return args
-
-
-deprec_func = deprecated('350.8', alternative='alt_func',
-                         name='deprec_func', removal='350.9')(alt_func)
-
-
-@fail_on_pvlib_version('350.9')
-def test_use_fixture_with_decorator(some_data):
-    # test that the correct data is returned by the some_data fixture
-    assert some_data == "some data"
-    with pytest.warns(pvlibDeprecationWarning):  # test for deprecation warning
-        deprec_func(some_data)
 
 
 @pytest.mark.parametrize('function_name', ['assert_index_equal',

scripts/update_top_ranking_issues.py

@@ -0,0 +1,81 @@
+import os
+import itertools
+from datetime import datetime, timedelta
+
+from github import Github
+from github.Issue import Issue
+from github.Repository import Repository
+
+
+def main():
+    start_time: datetime = datetime.now()
+
+    # --- Initialization ---
+    # GitHub Workflow will pass in the token as an environment variable,
+    # but we can place it in our env when running the script locally,
+    # for convenience
+    local_github_token: str | None = None
+    github_token: str | None = (
+        local_github_token or os.getenv("GITHUB_ACCESS_TOKEN")
+    )
+    github = Github(github_token)
+
+    # repository name
+    repo_name: str = "pvlib/pvlib-python"
+    repository: Repository = github.get_repo(repo_name)
+
+    # Number of top issues to list
+    MAX_ISSUES = 19
+    TOP_ISSUES_CARD_NUMBER = 2196
+
+    # Rate limiting
+    remaining_requests_before: int = github.rate_limiting[0]
+    print(f"Remaining requests before: {remaining_requests_before}")
+
+    # --- Actions ---
+    # Get sorted issues
+    query: str = (
+        f'repo:{repository.full_name} is:open is:issue sort:reactions-+1-desc'
+    )
+    issues = github.search_issues(query)
+
+    # Format
+    ranked_issues = []
+    # Continuous number generator for the numbered list, starts at 1
+    index_generator = itertools.count(1)
+    for issue in issues:
+        # Don't include the overview card (skip to next iteration)
+        if issue.number == TOP_ISSUES_CARD_NUMBER:
+            continue
+
+        # Get numbered list item index from generator
+        i = next(index_generator)
+        if i >= MAX_ISSUES:
+            break
+
+        markdown_bullet_point: str = (
+            f"{issue.html_url} " +
+            f"({issue._rawData['reactions']['+1']} :thumbsup:)"
+        )
+
+        markdown_bullet_point = f"{i}. {markdown_bullet_point}"
+        ranked_issues.append(markdown_bullet_point)
+
+    # edit top issues
+    top_issues_card: Issue = repository.get_issue(
+        number=TOP_ISSUES_CARD_NUMBER
+    )
+    header = "Top Ranking Issues"
+    new_body = header + "\n" + "\n".join(ranked_issues)
+    top_issues_card.edit(
+        body=new_body
+    )
+
+    print(top_issues_card.body)
+
+    run_duration: timedelta = datetime.now() - start_time
+    print(run_duration)
+
+
+if __name__ == "__main__":
+    main()