Test2::Todo(3perl)

💖 Test2::Todo — the manual page, but make it a group chat 💖

okay bestie so this is Test2::Todo, from the Perl Programmers Reference Guide. it's a lil Perl module, she's serving <pink>3perl</pink> realness, and she's here to help you manage TODO states for your tests. let's get into it 🎀

✨ NAME ✨

Test2::Todo — TODO extension for Test2. that's it, that's the name, short and iconic 💅

---

🌸 DESCRIPTION 🌸

so basically? this is an object that lets you create and manage TODO states for tests. periodt.

important vibe check tho: this is an extension, not a plugin or a tool. she's the behind-the-scenes girly. this library can be used by plugins and tools to manage todo states — she's not here for the spotlight, she's here to make everything run 👑

if you simply want to write a todo test then you should go look at the "todo" function provided by Test2::Tools::Basic. that's the one you want for casual everyday use, bestie. this one is for the machinery 💖

---

🦋 SYNOPSIS 🦋

here's the whole vibe, look:

use Test2::Todo;

# Start the todo
my $todo = Test2::Todo->new(reason => 'Fix later');

# Will be considered todo, so suite still passes
ok(0, "oops");

# End the todo
$todo->end;

# TODO has ended, this test will actually fail.
ok(0, "oops");

see how the first ok(0, "oops") is fine and the second one isn't? that's the whole point ✨ the todo state is doing the heavy lifting in between.

---

🌈 CONSTRUCTION OPTIONS 🌈

• reason (required) — the reason for the todo. this can be any defined value. it's required, so like… don't skip her, she needs to be there 🫶
• hub (optional) — the hub to which the TODO state should be applied. if none is provided then the current global hub is used. no hub? she'll just use the global one, no stress 💜

---

💅 INSTANCE METHODS 💅

• $todo->end — end the todo state. that's the whole method. short, sweet, ended 💀

---

⭐ CLASS METHODS ⭐

• $count = Test2::Todo->hub_in_todo($hub) — if the hub has any todo objects this will return the total number of them. if the hub has no todo objects it will return 0. so it's the "how many todos we got" counter 🧚

---

🎀 OTHER NOTES 🎀

💜 How it works 💜

when an instance is created, a filter sub is added to the Test2::Hub. this filter will set the "todo" and "diag_todo" attributes on all events as they come in. when the instance is destroyed, or end() is called, the filter is removed. clean exit, no mess, we love to see it 😭

when a new hub is pushed (such as when a subtest is started) the new hub will inherit the filter, but it will only set "diag_todo" — it will not set "todo" on events in child hubs. important distinction, don't forget it bestie ⚠️

🙈 $todo->end is called at destruction 🙈

if your $todo object falls out of scope and gets garbage collected, the todo will end. she ends herself. no cap 💀

👑 Can I use multiple instances? 👑

yes. the most recently created one that is still active will win. newest girlie takes the crown, periodt ✨

---

🔥 SOURCE 🔥

the source code repository for Test2-Suite can be found at:

https://github.com/Test-More/test-more/

go look, it's giving open source excellence 🫶

---

🌸 MAINTAINERS 🌸

• Chad Granum <exodist@cpan.org>

💖 AUTHORS 💖

• Chad Granum <exodist@cpan.org>

⭐ COPYRIGHT ⭐

Copyright Chad Granum <exodist@cpan.org>.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

See:

http://dev.perl.org/licenses/

---

okay and finally the cute sign-off 💅 this whole thing is from perl v5.44.0, dated 2026-10-17, and it's the Test2::Todo(3perl) page. slay, go write your tests, ily, bye 🎀✨🦋