🎓 Top 15 Udemy Courses (80-90% Discount): My Udemy Courses - Ramesh Fadatare — All my Udemy courses are real-time and project oriented courses.

▶️ Subscribe to My YouTube Channel (178K+ subscribers): Java Guides on YouTube

▶️ For AI, ChatGPT, Web, Tech, and Generative AI, subscribe to another channel: Ramesh Fadatare on YouTube

In this guide, you'll explore Python's weakref module, which creates weak references to objects. Learn its features and examples for memory management.

The weakref module in Python provides functions for creating weak references to objects. Weak references allow the referenced object to be garbage collected when there are no strong references to it, which can help with memory management in certain scenarios.

Introduction
Weak Reference Types
- ref
- proxy
Weak Reference Methods
- callback
Weak Reference Collections
- WeakKeyDictionary
- WeakValueDictionary
- WeakSet
Examples
- Creating Weak References
- Using Callbacks with Weak References
- Using Weak Reference Collections
Conclusion
7References

Introduction

The weakref module provides support for weak references in Python. A weak reference allows an object to be referenced without preventing it from being garbage collected. This is useful for caching, observing, and other scenarios where you want to avoid creating reference cycles that would prevent garbage collection.

Weak Reference Types

ref

The ref function creates a weak reference to an object. The referenced object can be retrieved using the weak reference.

import weakref

class MyClass:
    pass

obj = MyClass()
weak_ref = weakref.ref(obj)
print(weak_ref)
print(weak_ref())

Output:

<weakref at 0x0000025235A427F0; to 'MyClass' at 0x0000025235A35CD0>
<__main__.MyClass object at 0x0000025235A35CD0>

proxy

The proxy function creates a proxy object that behaves like a weak reference but automatically dereferences itself.

import weakref

class MyClass:
    def __init__(self, value):
        self.value = value

obj = MyClass(10)
weak_proxy = weakref.proxy(obj)
print(weak_proxy.value)

Output:

Weak Reference Methods

callback

A callback function can be registered to be called when the referenced object is about to be finalized.

import weakref

class MyClass:
    pass

def on_finalize(ref):
    print("Object is being garbage collected")

obj = MyClass()
weak_ref = weakref.ref(obj, on_finalize)
del obj

Output:

Object is being garbage collected

Weak Reference Collections

WeakKeyDictionary

A WeakKeyDictionary is a dictionary that holds weak references to its keys. When a key is garbage collected, the corresponding item is automatically removed from the dictionary.

import weakref

class MyClass:
    pass

obj = MyClass()
weak_dict = weakref.WeakKeyDictionary()
weak_dict[obj] = "value"
print(list(weak_dict.keys()))
del obj
print(list(weak_dict.keys()))

Output:

[<__main__.MyClass object at 0x0000016866255E50>]
[]

WeakValueDictionary

A WeakValueDictionary is a dictionary that holds weak references to its values. When a value is garbage collected, the corresponding item is automatically removed from the dictionary.

import weakref

class MyClass:
    pass

obj = MyClass()
weak_dict = weakref.WeakValueDictionary()
weak_dict["key"] = obj
print(list(weak_dict.values()))
del obj
print(list(weak_dict.values()))

Output:

[<__main__.MyClass object at 0x000002511F655E50>]
[]

WeakSet

A WeakSet is a set that holds weak references to its elements. When an element is garbage collected, it is automatically removed from the set.

import weakref

class MyClass:
    pass

obj = MyClass()
weak_set = weakref.WeakSet()
weak_set.add(obj)
print(list(weak_set))
del obj
print(list(weak_set))

Output:

[<__main__.MyClass object at 0x000002B5C7145E20>]
[]

Examples

Creating Weak References

Create a weak reference to an object and retrieve it.

import weakref

class MyClass:
    pass

obj = MyClass()
weak_ref = weakref.ref(obj)
print(weak_ref())  # Retrieve the referenced object

Output:

<__main__.MyClass object at 0x000001C61FF45C70>

Using Callbacks with Weak References

import weakref

class MyClass:
    pass

def on_finalize(ref):
    print("Object is being garbage collected")

obj = MyClass()
weak_ref = weakref.ref(obj, on_finalize)
del obj  # Trigger garbage collection

Output:

Object is being garbage collected

Using Weak Reference Collections

Use WeakKeyDictionary to manage objects with weak references.

import weakref

class MyClass:
    pass

obj = MyClass()
weak_dict = weakref.WeakKeyDictionary()
weak_dict[obj] = "value"
print(list(weak_dict.keys()))
del obj
print(list(weak_dict.keys()))

Output:

[<__main__.MyClass object at 0x0000021C86375E50>]
[]

Conclusion

The weakref module in Python provides functions for managing references to objects without preventing their garbage collection. This is especially useful in scenarios like caching, observing, and managing reference cycles, helping to optimize memory usage and program performance.

References

Python weakref module documentation

My Top and Bestseller Udemy Courses. The sale is going on with a 70 - 80% discount. The discount coupon has been added to each course below:

Spring Boot + RabbitMQ Course - The Practical Guide

Related Python Programs with Output and Step-By-Step Explanation:

Python weakref Module

Table of Contents

Introduction

Weak Reference Types

ref

Output:

proxy

Output:

Weak Reference Methods

callback

Output:

Weak Reference Collections

WeakKeyDictionary

Output:

WeakValueDictionary

Output:

WeakSet

Output:

Examples

Creating Weak References

Output:

Using Callbacks with Weak References

Output:

Using Weak Reference Collections

Output:

Conclusion

References

My Top and Bestseller Udemy Courses. The sale is going on with a 70 - 80% discount. The discount coupon has been added to each course below:

Build REST APIs with Spring Boot 4, Spring Security 7, and JWT

[NEW] Learn Apache Maven with IntelliJ IDEA and Java 25

ChatGPT + Generative AI + Prompt Engineering for Beginners

Spring 7 and Spring Boot 4 for Beginners (Includes 8 Projects)

Building Real-Time REST APIs with Spring Boot - Blog App

Building Microservices with Spring Boot and Spring Cloud

Java Full-Stack Developer Course with Spring Boot and React JS

Build 5 Spring Boot Projects with Java: Line-by-Line Coding

Testing Spring Boot Application with JUnit and Mockito

Spring Boot Thymeleaf Real-Time Web Application - Blog App

Master Spring Data JPA with Hibernate

Spring Boot + Apache Kafka Course - The Practical Guide

Java Testing: Mastering JUnit 5 Framework

Reactive Programming in Java: Spring WebFlux and Testing

Spring Boot + RabbitMQ Course - The Practical Guide

Functional Programming in Java (Includes Java Collections)

ChatGPT for Java Developers: Boost Your Productivity with AI

Related Python Programs with Output and Step-By-Step Explanation:

Comments

Post a Comment

Spring Boot 3 Paid Course Published for Free on my Java Guides YouTube Channel

Spring Boot 3 Paid Course Published for Free
on my Java Guides YouTube Channel