{"id":936,"date":"2024-05-12T13:01:25","date_gmt":"2024-05-12T13:01:25","guid":{"rendered":"https:\/\/bookwormhub.com\/blog\/?p=936"},"modified":"2024-05-12T13:01:39","modified_gmt":"2024-05-12T13:01:39","slug":"understanding-the-print-function-in-python","status":"publish","type":"post","link":"https:\/\/bookwormhub.com\/blog\/understanding-the-print-function-in-python\/","title":{"rendered":"Understanding the Print Function in Python"},"content":{"rendered":"One of the first function you\u2019ll be introduced to when learning Python is the print() function. This article will cover how printing in Python works from the basics along with a few tricks you\u2019d be interested to use in your projects. This function is commonly used in conjunction with python input techniques, and this article is the best guide to string formatting in python.<\/span>\r\n\r\n\r\n

The Basics of Print in Python<\/span><\/h2>\r\nGiven a string in python, the print function displays it in the console as an output. The function accepts not one, not two, but as many strings as you like to print in the console. Let\u2019s work on an example: the task is to print \u201cHello world\u201d. There are two ways to achieve this\u2014either print one string \u201cHello world\u201d, or two strings at the same time\u2014\u201cHello\u201d and \u201cworld\u201d.<\/span>\r\n\r\n\"\"\r\n

Syntax and Parameters<\/span><\/h3>\r\nTo understand the print function basics, below is the syntax in python of the print function. It consists of 4 optional parameters\u2014sep, end, file, and flush:<\/span>\r\n
print<\/b>(<\/span>*objects<\/span><\/i>,\u00a0<\/span>sep='\u00a0'<\/span><\/i>,\u00a0<\/span>end='\\n'<\/span><\/i>,\u00a0<\/span>file=None<\/span><\/i>,\u00a0<\/span>flush=False<\/span><\/i>)<\/span><\/pre>\r\nThe <\/span>*objects<\/span><\/i> parameter takes in a string (or multiple strings) as we discussed above and is the primary parameter for printing strings. The optional <\/span>sep<\/span><\/i> parameter specifies the string that is used to separate each of the <\/span>object<\/span><\/i> strings passed (this is of course only relevant if we are printing multiple strings at once!). By default, the value of <\/span>sep<\/span><\/i> is simply a space character, which is why our output for <\/span>print(\u201cHello\u201d, \u201cworld\u201d)<\/span><\/i> above was \u201cHello world\u201d (instead of \u201cHelloworld\u201d). The <\/span>end<\/span><\/i> parameter specifies the string to print at the end of the print statement. By default, the <\/span>end<\/span><\/i> parameter is \u2018\\n\u2019 which is the line-break character. The <\/span>file<\/span><\/i> parameter specifies a file object to write the print output to. By default, the <\/span>file<\/span><\/i> parameter (if <\/span>None<\/span><\/i>) is set to <\/span>sys.stdout<\/span><\/i> (i.e., standard system output\u2014which is your console!). The <\/span>flush<\/span><\/i> parameter is a rather advanced topic for most, however to simply put\u2014output to console or a file is normally buffered (i.e., not immediately written) for performance reasons. This feature may be toggled by specifying the <\/span>flush<\/span><\/i> parameter.<\/span>\r\n\r\n \r\n
Customizing Print Output<\/span><\/h2>\r\nTo customize the output of print function, we will focus on the first 3 parameters\u2014<\/span>*objects<\/span><\/i>, <\/span>sep<\/span><\/i>, and <\/span>end<\/span><\/i>. Setting <\/span>sep<\/span><\/i> to \u2018\\n\u2019 (i.e., line break) lets us print a series of strings in different lines\u2014all using just one print function-call. Below is an example of using the custom separator (\u2018\\n\u2019).<\/span>\r\n\r\n\"\"\r\n\r\nLikewise, a customized <\/span>end<\/span><\/i> parameter may help when printing punctuated sentences. Combining the two, we can print a list of strings nicely punctuated all in one print function call and in one line!<\/span>\r\n\r\n\"\"\r\n
Working with Strings and Objects<\/span><\/h3>\r\nPython\u2019s print function goes a step further. The function displays not just strings, but numbers and even complex objects (like dictionaries and lists!). This is something that isn\u2019t readily possible using string concatenation, but definitely something that the print function can undertake.<\/span>\r\n\r\n\"\"\r\n\r\nAs observed above, string concatenation fails to combine strings with numbers. However, specifying each string and variable as a parameter to print function quickly solves this issue (you probably want to substitute the variable values with additional python input techniques in the example below!).<\/span>\r\n\r\n\"\"\r\n\r\nEven more powerful functionality is one that allows print function to display Python objects. Yes, you read it correctly\u2014you can define the logic behind how objects are displayed using Python\u2019s <\/span>__str__<\/span><\/i> object overload function as described below:<\/span>\r\n\r\n\"\"\r\n\r\nOur implementation looks a lot nicer with this addition. Printing objects had never been simpler. In the example above, we use a functionality known as <\/span>f-strings<\/span><\/i> in Python\u2014a formatted string if you will. This is a method to concatenate strings (incl. numbers!) without the necessity of using type-conversion functions such as str().<\/span>\r\n\r\n\u00a0<\/span>\r\n
Practical Examples of Print Function<\/span><\/h2>\r\nAs we\u2019ve discovered from prior examples, the versatility of the print function allows us to print strings in a much more readable manner. This is especially useful when printing data for logging. Consider the previous scenario where we have a Human class representing a person with the attributes\u2014name, age, and location. Using the __str__ object overload, we define a string representation for class attributes and print log messages for our game server this way:<\/span>\r\n\r\n\"\"\r\n\r\nThis approach lets us print custom messages incorporating objects (a complex data type!) seamlessly. The output is both\u2014informative, and easy to read. Combining objects and strings eases dynamic creation of text.<\/span>\r\n
Advanced Techniques with Print<\/span><\/h2>\r\nAn often-overlooked parameter of the print function is the <\/span>file <\/span><\/i>parameter\u2014a powerful feature that extends the utility of print beyond just the console. This parameter allows writing nicely formatted strings to a file, which is yet another bonus for logging mechanisms.<\/span>\r\n
Redirecting Output<\/span><\/h3>\r\nThe simplest use of the file parameter is to redirect output from the console to a file. To do this, you first need a file object that you can obtain by using Python’s <\/span>open<\/span><\/i> function.<\/span>\r\n\r\n\"\"\r\n\r\nThe example above creates the output.txt file and writes the line \u2018I wrote this line.\u2019 into the file. Here we use the file parameter to specify the program to write to the output.txt file. As a result, no output is printed to the console (the output is <\/span>redirected<\/span><\/i>!). The simple yet powerful <\/span>file<\/span><\/i> parameter allows writing CSV (comma-separated values) files and creating a tabular display structure out of existing data. Going back to our persons example, the two person objects may be written to a data.csv file using the <\/span>sep<\/span><\/i> parameter in conjunction with <\/span>file<\/span><\/i> parameter as follows:<\/span>\r\n\r\n\"\"\r\n\r\nThe following is the result obtained from executing the above Python code\u2014a nice excel-readable data file of our registered persons.<\/span>\r\n\r\n\"\"\r\n
F.A.Q<\/span><\/h2>\r\n
How to use the print function in Python?<\/span><\/h3>\r\nThe print function in Python can be used by simply calling the function print() and supplying a string within its parenthesis. The result is that the given string is printed to the console. The function may be used to write to a file (instead of console) by specifying the <\/span>file<\/span><\/i> parameter.<\/span>\r\n
What are the key parameters of the print function?<\/span><\/h3>\r\nThe print function includes 3 key parameters\u2014<\/span>*objects<\/span><\/i>, <\/span>sep<\/span><\/i>, and <\/span>end<\/span><\/i>, with a 4<\/span>th<\/span> parameter <\/span>file<\/span><\/i> to specify where to output the text (by default, the console). The <\/span>*objects<\/span><\/i> parameter represents strings, numbers, or objects to be printed. The <\/span>sep<\/span><\/i> parameter determines the string used to separate the objects, and the <\/span>end<\/span><\/i> parameter the string to print after the subsequent objects are printed.<\/span>","protected":false},"excerpt":{"rendered":"One of the first function you\u2019ll be introduced to when learning Python is the print() function. This article will cover how printing in Python works from the basics along with a few tricks you\u2019d be interested to use in your projects. This function is commonly used in conjunction with python input techniques, and this article […]","protected":false},"author":1,"featured_media":938,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-936","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-uncategorized"],"_links":{"self":[{"href":"https:\/\/bookwormhub.com\/blog\/wp-json\/wp\/v2\/posts\/936","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/bookwormhub.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/bookwormhub.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/bookwormhub.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/bookwormhub.com\/blog\/wp-json\/wp\/v2\/comments?post=936"}],"version-history":[{"count":3,"href":"https:\/\/bookwormhub.com\/blog\/wp-json\/wp\/v2\/posts\/936\/revisions"}],"predecessor-version":[{"id":966,"href":"https:\/\/bookwormhub.com\/blog\/wp-json\/wp\/v2\/posts\/936\/revisions\/966"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/bookwormhub.com\/blog\/wp-json\/wp\/v2\/media\/938"}],"wp:attachment":[{"href":"https:\/\/bookwormhub.com\/blog\/wp-json\/wp\/v2\/media?parent=936"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/bookwormhub.com\/blog\/wp-json\/wp\/v2\/categories?post=936"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/bookwormhub.com\/blog\/wp-json\/wp\/v2\/tags?post=936"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}