Effective PyCharm Transcripts
Chapter: Tool windows
Lecture: The TODO window
Login or
purchase this course
to watch this video and the rest of the course contents.
0:00
How do you keep track of the open work that you have to do on your
0:04
program. For large feature, something you might create a feature branch for and you might
0:09
have other people's input on you would probably create a GitHub issue or Ajira tracking issue or your track issue one of those types of things.
0:18
But for smaller little things as you're building up, your program may be tiny little code issues that are part of a larger issue or
0:25
whatever, it's very common to use code comments. So let's go down here and check out this program from the profiling section.
0:33
There's a couple of things that we maybe want to do. Remember we talked about how we might optimize this if we were allowing more interactivity and
0:40
running these searches more than once. So maybe we'll come over here and go remember to explore if we use, you know, more than one,
0:48
run something like that. Okay, great. But there's a lot of source code over here and in this project,
0:56
if I'm trying to find all the stuff that's still open and for me to do how do I find that?
1:00
That's not very clear. So we can come back here and we can use a common way we could say 'todo' and check that out as soon as we say
1:10
'todo' in PyCharm, it turns yellow. That's super. That means we get a nice visual reminder,
1:16
you know, comments are kind of subdued to do is stand out as oh my gosh, something is on this page to be done here.
1:21
Right. That only helps if you actually go and explore the code again, if we have many, many files as large projects do how do you find them
1:29
Well that's the 'todo' window. So check this out down here in our 'todo' window. We can say I want to see the 'todo's in the current file,
1:36
notice that the color both the color of the file to show that it is a
1:40
modified from what it was in source control and then down here the highlighted todo and the line and column even.
1:46
That's pretty cool. We could do it in the project notice there's a bunch so it's really handy to have things like this,
1:54
like maybe over in this data access section down here remember we wanted to add an index. So if we have that down here,
2:02
when we were looking through our 'todo's, go to our demos, let's go to the performance one, you can see all of those that we might want.
2:11
And actually if, if we were in here we could say I want to, if that was all collapsed, we could collapse it or we could expand it all
2:18
out real quick like this. That's pretty awesome and we can come in here and say, okay, um we're going to add that index and we're going to do
2:27
that here, move our to do and soon as we remove our to do obviously as you would expect it removes it from the project.
2:37
Now. That's super cool. And I definitely recommend that you may take advantage of this. Right? Don't try to put a whole bunch of 'todo's to
2:45
manage large project work. Right? Those are feature branches. Those are issues and your issue tracker and so on.
2:52
But as you're building it up like you know you want to maybe work on this part but then you want to be sure you remember to come back here,
2:57
go ahead and make it super obvious by adding that as it to do one of the thing. I'm sure you noticed as I was flipping through here is there's a
3:04
lot of 'todo's. There's a lot of stuff going down here over here in the your turn we can expand at the wrong one over here.
3:12
We can expand that and those look like real issues. Right? This is actually from performance app that you worked with on the your turn
3:18
section over there and we got some for testing and so on. But notice from the transcript right,
3:24
this is the transcripts We decided to include those in the GitHub repo and over here we just said the word to do.
3:30
That's cool. You don't care about that. Right? There is not something you need to do.
3:35
So what we can do is we can go over to the transcripts folder mark directory
3:39
as excluded and then notice we have a whole lot fewer to collapse that with a lot fewer. The transcripts section is gone here.
3:48
Right if you were to do but over here there's still some problems. Check this out over in the virtual environment.
3:54
Remember we were opening these at different levels. Sometimes I wanted to open the whole course set of demos and other times when we
4:01
were working on say packages, it was important that the package was the top level of the project. So we open that separately.
4:08
So in here you'll see like in pytest or Olympic, they have some 'todo's left in their source code that got installed when we pip
4:15
install them. That's not ideal. We don't want that. So notice also the color here. This is not orange so it's not ignored.
4:23
We can come over here and jump to source by clicking this or just command down or whatever your hotkey on your platform is.
4:29
We could exclude that one as well and there we go. Now. We got our project into a good space.
4:36
We can expand them all out and kind of scroll through here and see what work is left to do. Alright,
4:41
definitely be sure to take advantage of typing these keywords like to do and stuff and then use the 'todo' window to make sure that you have addressed them all