Run Ruff on Your Python Code: ruff check and ruff rule Explained

Key Takeaways

Now that you've installed rough, you're ready to start using it to check your code for linting errors. And you will do that with a subcomand rough check. Not necessarily often, but it might happen that you will link your code. And rough reports a linting error that you've never seen before and that you don't really understand. And so you will also learn how to use the subcommand rough rule to get more information about that error. And you will see everything in action in just a second. You just need some code to work with, right? So, go ahead and download the file one ring. py from the course materials. You should be able to download this file and move it to a directory where you're comfortable working in. Once you do that, let's just take a quick look at what the file looks like. So, the file one ring py should have roughly 20 lines of Python code. It should have a global variable called characters which is very long, doesn't fit on the screen. It has a couple of functions and then a couple of if statements at the bottom of the file. And this is the code you're going to be working with. So the first thing you'll do is open your terminal and make sure you've navigated to the directory where the file one ring. py is right now. If you use the command ls, you can see that you are in the correct directory. And once you're there, you can run the subcomand rough check to check if there are any errors in your code. And once you run rough check, you get two different errors on the screen. Now, when rough presents an error, the error will start with an error code, which is typically one or a couple of letters followed by some numbers. and then one line, a short sentence describing the error. Ruff will also show you the context, the file and the line where the error is found and also the surrounding code. And sometimes it will also show you some help text giving hints or suggestions as to what you could do to fix the error. Now, the thing is sometimes these errors aren't very easy to understand in the first place. And when that's the case, you can use the subcomand ref rule to get more information about that error. For example, if you look at the second error, it has the error code F821. So what you can do is you can type the subcomand rough rule and then F821. And if you press enter, you get some markdown text describing the error that you got, what the error does, how to fix it, or some examples of how you can fix the error, options that might be relevant, references in case you want to learn more. So, rough will give you a lot of information about different errors and this is very helpful if you get an error that you've never seen or an error that you seldom see and that you don't really remember what it means. Now, when you check your code, you run the subcomand rough check. And what this subcomand does by default is go through all files in the current directory, traverse the directory recursively and check every single file. But you can also provide a subfolder or a specific file to check. So if you ran rough check one ring py, you would check explicitly only the file that you specified. So that's very helpful. And another thing that might be of interest is that the subcomand rough rule accepts an option d- all which lets you take a look at all errors that rough could possibly report. You can't see it on the screen because it was a lot of text and it scrolled past really really fast. But this is a lot of output. It's not convenient to scroll up to the top to find the beginning. You might not even have enough history length to be able to scroll to the beginning. So one thing you might want to do is run rough rule d-pole and then pipe. So the vertical bar character and pipe that output to the command less which will let you page through the output of all of the rules and therefore making it easier to take a look at all of the rules if if you wanted to just read about them from start to finish. So you can use the up and down arrows to go up and down the output. And when you want to quit, just press Q. Now, this is just a curiosity. It's unlikely that you'll want to read the whole document from start to finish, but at least you know the information is there. If the internet goes down, you can still access the documentation about each rule that Ruff can check for. And now that you know how to check for linting issues, it's time to learn how to fix them with Rough. And that's what you'll do in the next lesson.