Array protocol and __array__ in NumPy - Mini Project: Build & Apply

Using the Array Protocol and __array__ Method in NumPy

📖 Scenario: Imagine you have a custom class that stores data like a list, but you want to use NumPy functions on it easily. NumPy can convert objects to arrays if they follow the array protocol by implementing the __array__ method.

🎯 Goal: You will create a simple custom class with a __array__ method so that NumPy can convert it to an array. Then, you will use NumPy functions on your custom object.

📋 What You'll Learn

Create a custom class called MyData that stores a list of numbers.

Add a __array__ method to MyData that returns a NumPy array of the stored data.

Create an instance of MyData with specific numbers.

Use np.array() to convert the MyData instance to a NumPy array.

Print the resulting NumPy array.

💡 Why This Matters

🌍 Real World

Custom data classes can store data in special ways but still work with NumPy functions by implementing the array protocol.

💼 Career

Understanding the array protocol helps you integrate your own data structures with NumPy, a key skill in data science and scientific computing.

1

Create the MyData class with stored data

Create a class called MyData with an __init__ method that takes a list called data and stores it in self.data. Then create an instance called my_data with the list [10, 20, 30].

NumPy

# Your code here

Hint

Define a class with __init__ to save the list in self.data. Then create an object my_data with the list [10, 20, 30].

2

Add the __array__ method to MyData

Inside the MyData class, add a method called __array__ that takes self, dtype=None and returns np.array(self.data, dtype=dtype). Make sure to import NumPy as np at the top.

NumPy

import numpy as np

class MyData:
    def __init__(self, data):
        self.data = data
    # Your code here

my_data = MyData([10, 20, 30])

Hint

The __array__ method should take self, dtype=None and return np.array(self.data, dtype=dtype).

3

Convert my_data to a NumPy array using np.array()

Create a variable called array_version and set it to np.array(my_data) to convert the MyData instance to a NumPy array.

NumPy

import numpy as np

class MyData:
    def __init__(self, data):
        self.data = data
    def __array__(self, dtype=None):
        return np.array(self.data, dtype=dtype)

my_data = MyData([10, 20, 30])

# Your code here

Hint

Use np.array(my_data) to get the NumPy array from your custom object.

4

Print the NumPy array array_version

Write a print statement to display the variable array_version.

NumPy

import numpy as np

class MyData:
    def __init__(self, data):
        self.data = data
    def __array__(self, dtype=None):
        return np.array(self.data, dtype=dtype)

my_data = MyData([10, 20, 30])

array_version = np.array(my_data)

# Your code here

Hint

Use print(array_version) to show the NumPy array.

Practice

1. What is the main purpose of the __array__ method in a custom Python class when working with NumPy?

easy

A. To create a plot from the array data

B. To allow the object to be converted automatically into a NumPy array

C. To perform element-wise multiplication on arrays

D. To define a new data type for NumPy arrays

Solution

1. Step 1: Understand the role of __array__

   The __array__ method is designed to let custom objects tell NumPy how to convert them into arrays.

2. Step 2: Identify the main purpose

   This method enables automatic conversion, so NumPy can work with the data efficiently.

3. Final Answer:

   To allow the object to be converted automatically into a NumPy array -> Option B

4. Quick Check:

   Conversion to NumPy array [OK]

Hint: Remember: __array__ means 'convert me to array' [OK]

Common Mistakes:

• Confusing __array__ with data type definition
• Thinking __array__ performs calculations
• Assuming __array__ creates plots

2. Which of the following is the correct way to define the __array__ method in a custom class to return a NumPy array?

easy

A. def __array__(self, dtype): return self.data.astype(dtype)

B. def __array__(self): return list(self.data)

C. def __array__(self): return self.data.tolist()

D. def __array__(self, dtype=None): return np.array(self.data, dtype=dtype)

Solution

1. Step 1: Check method signature

   The __array__ method should accept an optional dtype argument for flexibility.

2. Step 2: Verify return type

   It must return a NumPy array, so using np.array(self.data, dtype=dtype) is correct.

3. Final Answer:

   def __array__(self, dtype=None): return np.array(self.data, dtype=dtype) -> Option D

4. Quick Check:

   Correct signature and return type [OK]

Hint: Include dtype=None and return np.array inside __array__ [OK]

Common Mistakes:

• Omitting dtype parameter
• Returning list instead of np.array
• Using tolist() which returns Python list

3. Given the code below, what will be the output of print(np.array(obj))?

import numpy as np

class MyData:
    def __init__(self):
        self.data = [1, 2, 3]
    def __array__(self, dtype=None):
        return np.array(self.data, dtype=dtype)

obj = MyData()
print(np.array(obj))

medium

A. [1 2 3]

B. [[1 2 3]]

C. TypeError: object cannot be converted to array

D. [1, 2, 3]

Solution

1. Step 1: Understand __array__ method behavior

   The method returns a NumPy array created from the list [1, 2, 3].

2. Step 2: Predict np.array conversion

   Calling np.array(obj) triggers obj.__array__(), returning np.array([1, 2, 3]), which prints as [1 2 3].

3. Final Answer:

   [1 2 3] -> Option A

4. Quick Check:

   Custom __array__ returns array [1 2 3] [OK]

Hint: np.array calls __array__, returns array, prints without commas [OK]

Common Mistakes:

• Expecting Python list output with commas
• Thinking output is nested array
• Assuming TypeError due to custom class

4. What is wrong with this __array__ method implementation?

def __array__(self):
    return self.data.astype(float)

medium

A. It does not accept the optional dtype argument

B. astype cannot convert to float

C. Returning self.data directly is required

D. The method should return a list, not an array

Solution

1. Step 1: Check method signature

   The __array__ method should accept an optional dtype argument to allow flexible conversions.

2. Step 2: Identify missing dtype parameter

   This method lacks the dtype=None parameter, so it cannot handle dtype requests from NumPy.

3. Final Answer:

   It does not accept the optional dtype argument -> Option A

4. Quick Check:

   Missing dtype parameter [OK]

Hint: Always include dtype=None in __array__ method [OK]

Common Mistakes:

• Forgetting dtype argument
• Thinking astype cannot convert types
• Returning list instead of array

5. You have a custom class with a __array__ method that returns a NumPy array. You want to ensure that when you call np.array(obj, dtype=np.float64), the returned array respects the requested dtype. How should you modify the __array__ method?

hard

A. def __array__(self, dtype=None): return np.array(self.data)

B. def __array__(self): return np.array(self.data, dtype=np.float64)

C. def __array__(self, dtype=None): return np.array(self.data, dtype=dtype)

D. def __array__(self, dtype): return self.data.astype(dtype)

Solution

1. Step 1: Understand dtype propagation

   NumPy passes the requested dtype to __array__ as an argument; the method must accept it.

2. Step 2: Implement dtype-aware conversion

   Return np.array(self.data, dtype=dtype) so the requested dtype is applied correctly.

3. Final Answer:

   def __array__(self, dtype=None): return np.array(self.data, dtype=dtype) -> Option C

4. Quick Check:

   Accept dtype and pass to np.array [OK]

Hint: Pass dtype argument to np.array inside __array__ method [OK]

Common Mistakes:

• Ignoring dtype argument
• Hardcoding dtype inside method
• Not accepting dtype parameter