Description

busywhitespace

opened on Jan 28, 2023

Issue body actions

The documentation of LoazyLoader.factory in the module importlib.util says:

classmethod factory(loader)

A static method which returns a callable that creates a lazy loader. This is meant to be used in situations where the loader is passed by class instead of by instance.

The problem is that there is a mixing of words classmethod and static method. And the documentation defines the static method as ... Static method objects are created by the built-in staticmethod() constructor.

The source code for the method is:

@classmethod
def factory(cls, loader):
    """Construct a callable which returns the eager loader made lazy."""
    cls.__check_eager_loader(loader)
    return lambda *args, **kwargs: cls(loader(*args, **kwargs))

So, in my opition, "a static method" in the documentation should be corrected to "a class method".

I've created the PR in case the issue is right.

Linked PRs

• gh-101390: Fix docs for imporlib.util.LazyLoader.factory to properly call it a class method #101391
• [3.11] gh-101390: Fix docs for imporlib.util.LazyLoader.factory to properly call it a class method (GH-101391) #101813
• [3.10] gh-101390: Fix docs for imporlib.util.LazyLoader.factory to properly call it a class method (GH-101391) #101814

Activity

1. busywhitespace

   added

   docsDocumentation in the Doc dirDocumentation in the Doc dir

   on Jan 28, 2023
2. AlexWaygood

   added

   topic-importlib

   on Jan 28, 2023
3. brettcannon commented on Feb 10, 2023

   

   brettcannon

   on Feb 10, 2023

   Member

   More actions

   The specific code lines in question:

   cpython/Lib/importlib/util.py

   Lines 170 to 171 in 61f2be0

   	@classmethod
   	def factory(cls, loader):

   So @busywhitespace is correct that the docs are wrong about calling it a static method.
4. brettcannon

   added a commit that references this issue on Feb 10, 2023

   gh-101390: Fix docs for `imporlib.util.LazyLoader.factory` to properl…

   17143e2
5. miss-islington

   added 2 commits that reference this issue on Feb 10, 2023

   pythongh-101390: Fix docs for `imporlib.util.LazyLoader.factory` to p…

   3974c6b

   pythongh-101390: Fix docs for `imporlib.util.LazyLoader.factory` to p…

   cea61cc
6. brettcannon

   added 2 commits that reference this issue on Feb 11, 2023

   [3.11] gh-101390: Fix docs for `imporlib.util.LazyLoader.factory` to …

   91fb7c3

   [3.10] gh-101390: Fix docs for `imporlib.util.LazyLoader.factory` to …

   6c0e3dc
7. carljm

   added a commit that references this issue on Feb 13, 2023

   Merge branch 'main' into inlinecomp2

   ae0bd02
8. hauntsaninja commented on Feb 25, 2023

   

   hauntsaninja

   on Feb 25, 2023

   Contributor

   More actions

   Thanks, looks like this was fixed
9. hauntsaninja

   closed this as completedon Feb 25, 2023

Issue actions