Most aud Python module instance methods are documented as classmethods #108245

New Issue

Thomas Barlow · 2023-05-25T00:17:24+02:00

Thomas Barlow commented

2023-05-25 00:17:24 +02:00

System Information
Operating system: Windows-10-10.0.19045-SP0 64 Bits
Graphics card: NVIDIA GeForce GTX 1070 Ti/PCIe/SSE2 NVIDIA Corporation 4.5.0 NVIDIA 531.41

Blender Version
Broken: version: 4.0.0 Alpha, branch: main, commit date: 2023-05-24 15:26, hash: 9acff4edabe5
Worked: (newest version of Blender that worked as expected)

Short description of error
The aud module contains a number of classes that have their own functions. These functions have been documented as classmethod, implying that an instance of the class is not needed to call the function (e.g. aud.Device.lock()), however, most of the functions do need an instance of the class to be called because they are actually instance methods (e.g. my_device.lock() or less common aud.Device.lock(my_device)).

Exact steps for others to reproduce the error
The current documentation for the aud module can be found at https://docs.blender.org/api/current/aud.html

For a single example, run the following lines in the Python console:

import aud
print(aud.Device.lock.__doc__)
- Observe that the documentation says it is a classmethod
aud.Device.lock()
- Observe that a TypeError occurs because the function is actually an unbound instance method and requires an instance to be passed as the first argument when called directly like this. If this function was a classmethod aud.Device would have been bound to the first argument automatically.

The below script can be run from the Text Editor to print to the console each function of a class in the aud module that claims to be a classmethod and whether this is actually the case:

import aud

class TestClass:
    @staticmethod
    def my_static_method(): ...
    
    @classmethod
    def my_class_method(cls): ...
    
    def my_instance_method(self): ...

def is_classmethod(clazz, m):
    # A classmethod when accessed from the class it belongs to will be bound to that class
    return getattr(m, "__self__", None) == clazz

assert not is_classmethod(TestClass, TestClass.my_static_method)
assert not is_classmethod(TestClass, TestClass.my_instance_method)
assert is_classmethod(TestClass, TestClass.my_class_method)

is_list = []
is_not_list = []
for attr_name in dir(aud):
    clazz = getattr(aud, attr_name)
    if not isinstance(clazz, type):
        continue

    for class_attr_name in dir(clazz):
        class_attr = getattr(clazz, class_attr_name)
        doc = getattr(class_attr, "__doc__", None)
        if not doc:
            continue
        if "classmethod" in doc:
            tup = (attr_name, class_attr_name)
            if is_classmethod(clazz, class_attr):
                is_list.append(tup)
            else:
                is_not_list.append(tup)

print()
print()

for attr_name, class_attr_name in is_list:
    print(f"Y aud.{attr_name}.{class_attr_name} is a classmethod")

print()

for attr_name, class_attr_name in is_not_list:
    print(f"N aud.{attr_name}.{class_attr_name} is not a classmethod")

**System Information** Operating system: Windows-10-10.0.19045-SP0 64 Bits Graphics card: NVIDIA GeForce GTX 1070 Ti/PCIe/SSE2 NVIDIA Corporation 4.5.0 NVIDIA 531.41 **Blender Version** Broken: version: 4.0.0 Alpha, branch: main, commit date: 2023-05-24 15:26, hash: `9acff4edabe5` Worked: (newest version of Blender that worked as expected) **Short description of error** The `aud` module contains a number of classes that have their own functions. These functions have been documented as `classmethod`, implying that an instance of the class is not needed to call the function (e.g. `aud.Device.lock()`), however, most of the functions do need an instance of the class to be called because they are actually instance methods (e.g. `my_device.lock()` or less common `aud.Device.lock(my_device)`). **Exact steps for others to reproduce the error** The current documentation for the `aud` module can be found at https://docs.blender.org/api/current/aud.html For a single example, run the following lines in the Python console: 1) `import aud` 1) `print(aud.Device.lock.__doc__)` - Observe that the documentation says it is a classmethod 1) `aud.Device.lock()` - Observe that a `TypeError` occurs because the function is actually an unbound instance method and requires an instance to be passed as the first argument when called directly like this. If this function was a `classmethod` `aud.Device` would have been bound to the first argument automatically. ![image](/attachments/cf7b5a29-81d7-46f1-8361-377bf4c63abc) The below script can be run from the Text Editor to print to the console each function of a class in the `aud` module that claims to be a `classmethod` and whether this is actually the case: ```py import aud class TestClass: @staticmethod def my_static_method(): ... @classmethod def my_class_method(cls): ... def my_instance_method(self): ... def is_classmethod(clazz, m): # A classmethod when accessed from the class it belongs to will be bound to that class return getattr(m, "__self__", None) == clazz assert not is_classmethod(TestClass, TestClass.my_static_method) assert not is_classmethod(TestClass, TestClass.my_instance_method) assert is_classmethod(TestClass, TestClass.my_class_method) is_list = [] is_not_list = [] for attr_name in dir(aud): clazz = getattr(aud, attr_name) if not isinstance(clazz, type): continue for class_attr_name in dir(clazz): class_attr = getattr(clazz, class_attr_name) doc = getattr(class_attr, "__doc__", None) if not doc: continue if "classmethod" in doc: tup = (attr_name, class_attr_name) if is_classmethod(clazz, class_attr): is_list.append(tup) else: is_not_list.append(tup) print() print() for attr_name, class_attr_name in is_list: print(f"Y aud.{attr_name}.{class_attr_name} is a classmethod") print() for attr_name, class_attr_name in is_not_list: print(f"N aud.{attr_name}.{class_attr_name} is not a classmethod") ```

image.png

32 KiB

👍 1

Thomas Barlow added the

labels 2023-05-25 00:17:25 +02:00

Iliya Katushenock added the