Merge branch 'main' into ci/coverage

Author: Borda

.git-blame-ignore-revs

@@ -0,0 +1 @@
+1f423a22d8b27926da7d7b7393c833da0f3714a4

.github/dependabot.yml

@@ -6,9 +6,17 @@ updates:
       interval: "monthly"
     labels:
       - "type: Maintenance"
+    groups:
+      actions:
+        patterns:
+          - "*"
   - package-ecosystem: "pip"
     directory: "/"
     schedule:
       interval: "monthly"
     labels:
       - "type: Maintenance"
+    groups:
+      actions:
+        patterns:
+          - "*"

.github/workflows/ci-tests.yml

@@ -1,6 +1,10 @@
 name: test
 
-on: [push, pull_request]
+on: [workflow_dispatch, push, pull_request]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 jobs:
   default:
@@ -9,7 +13,7 @@ jobs:
       matrix:
         os: [ubuntu, macos, windows]
         python-version:
-          ["3.8", "3.9", "3.10", "3.11", "3.12", "pypy-3.8", "pypy-3.9"]
+          ["3.9", "3.10", "3.11", "3.12", "3.13", "pypy-3.9", "pypy-3.10"]
 
     steps:
       - uses: actions/checkout@v4

.github/workflows/label-check.yaml

@@ -4,8 +4,10 @@ on:
   pull_request:
     types:
       - opened
+      - reopened
       - labeled
       - unlabeled
+      - synchronize
 
 env:
   LABELS: ${{ join( github.event.pull_request.labels.*.name, ' ' ) }}

.github/workflows/lint.yml

@@ -12,7 +12,7 @@ jobs:
     name: attach to PR
     runs-on: ubuntu-latest
     steps:
-      - uses: scientific-python/attach-next-milestone-action@bc07be829f693829263e57d5e8489f4e57d3d420
+      - uses: scientific-python/attach-next-milestone-action@c9cfab10ad0c67fed91b01103db26b7f16634639
         with:
           token: ${{ secrets.MILESTONE_LABELER_TOKEN }}
           force: true

.github/workflows/milestone-merged-prs.yaml

@@ -1,9 +1,15 @@
 # Install pre-commit hooks via
 # pre-commit install
 
+ci:
+  autofix_prs: false
+  autofix_commit_msg: |
+    '[pre-commit.ci 🤖] Apply code format tools to PR'
+  autoupdate_schedule: quarterly
+
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: c4a0b883114b00d8d76b479c820ce7950211c99b # frozen: v4.5.0
+    rev: cef0300fd0fc4d2a87a85fa2093c6b283ea36f4b # frozen: v5.0.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
@@ -16,20 +22,21 @@ repos:
       - id: check-toml
       - id: check-added-large-files
 
-  - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: ffb6a759a979008c0e6dff86e39f4745a2d9eac4 # frozen: v3.1.0
+  - repo: https://github.com/rbubley/mirrors-prettier
+    rev: bc7af46104f0f5368b95878decf720f9f00c2559 # frozen: v3.4.2
     hooks:
       - id: prettier
         files: \.(html|md|yml|yaml|toml)
         args: [--prose-wrap=preserve]
 
-  - repo: https://github.com/psf/black
-    rev: 552baf822992936134cbd31a38f69c8cfe7c0f05 # frozen: 24.3.0
-    hooks:
-      - id: black
-
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: 0ccbb5b7942d83fbcf7cb5e0fd99633efd2351d7 # frozen: v0.3.5
+    rev: 89c421dff2e1026ba12cdb9ebd731f4a83aa8021 # frozen: v0.8.6
     hooks:
       - id: ruff
-        args: [--fix, --exit-non-zero-on-fix]
+        args: ["--fix", "--show-fixes", "--exit-non-zero-on-fix"]
+      - id: ruff-format
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: "193cd7d27cd571f79358af09a8fb8997e54f8fff" # frozen: v2.3.0
+    hooks:
+      - id: codespell

.pre-commit-config.yaml

@@ -1,8 +1,8 @@
-[![PyPI](https://img.shields.io/pypi/v/lazy_loader)](https://pypi.org/project/lazy_loader/)
-[![Test status](https://github.com/scientific-python/lazy_loader/workflows/test/badge.svg?branch=main)](https://github.com/scientific-python/lazy_loader/actions?query=workflow%3A%22test%22)
-[![Test coverage](https://codecov.io/gh/scientific-python/lazy_loader/branch/main/graph/badge.svg)](https://app.codecov.io/gh/scientific-python/lazy_loader/branch/main)
+[![PyPI](https://img.shields.io/pypi/v/lazy-loader)](https://pypi.org/project/lazy-loader/)
+[![Test status](https://github.com/scientific-python/lazy-loader/workflows/test/badge.svg?branch=main)](https://github.com/scientific-python/lazy-loader/actions?query=workflow%3A%22test%22)
+[![Test coverage](https://codecov.io/gh/scientific-python/lazy-loader/branch/main/graph/badge.svg)](https://app.codecov.io/gh/scientific-python/lazy-loader/branch/main)
 
-`lazy_loader` makes it easy to load subpackages and functions on demand.
+`lazy-loader` makes it easy to load subpackages and functions on demand.
 
 ## Motivation
 
@@ -14,10 +14,10 @@ For a more detailed discussion, see [the SPEC](https://scientific-python.org/spe
 ## Installation
 
 ```
-pip install -U lazy_loader
+pip install -U lazy-loader
 ```
 
-We recommend using `lazy_loader` with Python >= 3.11.
+We recommend using `lazy-loader` with Python >= 3.11.
 If using Python 3.11, please upgrade to 3.11.9 or later.
 If using Python 3.12, please upgrade to 3.12.3 or later.
 These versions [avoid](https://github.com/python/cpython/pull/114781) a [known race condition](https://github.com/python/cpython/issues/114763).

CHANGELOG.md

@@ -1,4 +1,4 @@
-# Release process for `lazy_loader`
+# Release process for `lazy-loader`
 
 ## Introduction
 
@@ -17,7 +17,7 @@ Example `version number`
       export VERSION=<version number>
       export PREVIOUS=<previous version number>
       export ORG="scientific-python"
-      export REPO="lazy_loader"
+      export REPO="lazy-loader"
       export LOG="CHANGELOG.md"
 
 - Autogenerate release notes
@@ -46,17 +46,17 @@ Example `version number`
 
       git push --tags origin main
 
-  where `origin` is the name of the `github.com:scientific-python/lazy_loader`
+  where `origin` is the name of the `github.com:scientific-python/lazy-loader`
   repository
 
 - Create release from tag
 
-      - go to https://github.com/scientific-python/lazy_loader/releases/new?tag=v${VERSION}
+      - go to https://github.com/scientific-python/lazy-loader/releases/new?tag=v${VERSION}
       - add v${VERSION} for the `Release title`
       - paste contents (or upload) of ${VERSION}.md in the `Describe this release section`
       - if pre-release check the box labelled `Set as a pre-release`
 
-- Update https://github.com/scientific-python/lazy_loader/milestones:
+- Update https://github.com/scientific-python/lazy-loader/milestones:
 
       - close old milestone
       - ensure new milestone exists (perhaps setting due date)

README.md

@@ -15,7 +15,7 @@
 import warnings
 
 __version__ = "0.5rc0.dev0"
-__all__ = ["attach", "load", "attach_stub"]
+__all__ = ["attach", "attach_stub", "load"]
 
 
 threadlock = threading.Lock()
@@ -38,9 +38,7 @@ def attach(package_name, submodules=None, submod_attrs=None):
     The typical way to call this function, replacing the above imports, is::
 
       __getattr__, __dir__, __all__ = lazy.attach(
-        __name__,
-        ['mysubmodule', 'anothersubmodule'],
-        {'foo': ['someattr']}
+          __name__, ["mysubmodule", "anothersubmodule"], {"foo": ["someattr"]}
       )
 
     Parameters
@@ -92,13 +90,13 @@ def __getattr__(name):
             raise AttributeError(f"No {package_name} attribute {name}")
 
     def __dir__():
-        return __all__
+        return __all__.copy()
 
     if os.environ.get("EAGER_IMPORT", ""):
         for attr in set(attr_to_modules.keys()) | submodules:
             __getattr__(attr)
 
-    return __getattr__, __dir__, list(__all__)
+    return __getattr__, __dir__, __all__.copy()
 
 
 class DelayedImportErrorModule(types.ModuleType):
@@ -114,13 +112,13 @@ def __getattr__(self, x):
             fd = self.__frame_data
             raise ModuleNotFoundError(
                 f"{self.__message}\n\n"
-                "This error is lazily reported, having originally occured in\n"
+                "This error is lazily reported, having originally occurred in\n"
                 f'  File {fd["filename"]}, line {fd["lineno"]}, in {fd["function"]}\n\n'
                 f'----> {"".join(fd["code_context"] or "").strip()}'
             )
 
 
-def load(fullname, *, require=None, error_on_import=False):
+def load(fullname, *, require=None, error_on_import=False, suppress_warning=False):
     """Return a lazily imported proxy for a module.
 
     We often see the following pattern::
@@ -162,7 +160,7 @@ def myfunc():
     fullname : str
         The full name of the module or submodule to import.  For example::
 
-          sp = lazy.load('scipy')  # import scipy as sp
+          sp = lazy.load("scipy")  # import scipy as sp
 
     require : str
         A dependency requirement as defined in PEP-508.  For example::
@@ -176,6 +174,10 @@ def myfunc():
         Whether to postpone raising import errors until the module is accessed.
         If set to `True`, import errors are raised as soon as `load` is called.
 
+    suppress_warning : bool
+        Whether to prevent emitting a warning when loading subpackages.
+        If set to `True`, no warning will occur.
+
     Returns
     -------
     pm : importlib.util._LazyModule
@@ -191,10 +193,10 @@ def myfunc():
         if have_module and require is None:
             return module
 
-        if "." in fullname:
+        if not suppress_warning and "." in fullname:
             msg = (
                 "subpackages can technically be lazily loaded, but it causes the "
-                "package to be eagerly loaded even if it is already lazily loaded."
+                "package to be eagerly loaded even if it is already lazily loaded. "
                 "So, you probably shouldn't use subpackages with this lazy feature."
             )
             warnings.warn(msg, RuntimeWarning)
@@ -224,21 +226,19 @@ def myfunc():
                 raise ModuleNotFoundError(not_found_message)
             import inspect
 
-            try:
-                parent = inspect.stack()[1]
-                frame_data = {
-                    "filename": parent.filename,
-                    "lineno": parent.lineno,
-                    "function": parent.function,
-                    "code_context": parent.code_context,
-                }
-                return DelayedImportErrorModule(
-                    frame_data,
-                    "DelayedImportErrorModule",
-                    message=not_found_message,
-                )
-            finally:
-                del parent
+            parent = inspect.stack()[1]
+            frame_data = {
+                "filename": parent.filename,
+                "lineno": parent.lineno,
+                "function": parent.function,
+                "code_context": parent.code_context,
+            }
+            del parent
+            return DelayedImportErrorModule(
+                frame_data,
+                "DelayedImportErrorModule",
+                message=not_found_message,
+            )
 
         if spec is not None:
             module = importlib.util.module_from_spec(spec)

RELEASE.md

@@ -1,3 +1,2 @@
 def some_func():
     """Function with same name as submodule."""
-    pass

lazy_loader/__init__.py

@@ -35,7 +35,7 @@ def test_lazy_import_subpackages():
     with pytest.warns(RuntimeWarning):
         hp = lazy.load("html.parser")
     assert "html" in sys.modules
-    assert type(sys.modules["html"]) == type(pytest)
+    assert type(sys.modules["html"]) is type(pytest)
     assert isinstance(hp, importlib.util._LazyModule)
     assert "html.parser" in sys.modules
     assert sys.modules["html.parser"] == hp
@@ -104,6 +104,29 @@ def test_lazy_attach():
             assert locls[k] == v
 
 
+def test_lazy_attach_returns_copies():
+    _get, _dir, _all = lazy.attach(
+        __name__, ["my_submodule", "another_submodule"], {"foo": ["some_attr"]}
+    )
+    assert _dir() is not _dir()
+    assert _dir() == _all
+    assert _dir() is not _all
+
+    expected = ["another_submodule", "my_submodule", "some_attr"]
+    assert _dir() == expected
+    assert _all == expected
+    assert _dir() is not _all
+
+    _dir().append("modify_returned_list")
+    assert _dir() == expected
+    assert _all == expected
+    assert _dir() is not _all
+
+    _all.append("modify_returned_all")
+    assert _dir() == expected
+    assert _all == [*expected, "modify_returned_all"]
+
+
 def test_attach_same_module_and_attr_name():
     from lazy_loader.tests import fake_pkg
 
@@ -186,5 +209,6 @@ def test_parallel_load():
         [
             sys.executable,
             os.path.join(os.path.dirname(__file__), "import_np_parallel.py"),
-        ]
+        ],
+        check=True,
     )