{"id":2893,"date":"2022-06-17T10:44:19","date_gmt":"2022-06-17T14:44:19","guid":{"rendered":"https:\/\/www.alpharithms.com\/?p=2893"},"modified":"2022-06-17T10:44:19","modified_gmt":"2022-06-17T14:44:19","slug":"python-datetime-string-conversions","status":"publish","type":"post","link":"https:\/\/www.alpharithms.com\/python-datetime-string-conversions-194410\/","title":{"rendered":"Converting Between Strings and Datetime Objects in Python"},"content":{"rendered":"

Python offers the datetime library for handling many date-based operations such as converting timestamps into human-readable formats. This library provides convenient means to convert string timestamps to datetime objects via which developers are provided a unified API for interacting with, updating and making time-based calculations.<\/p>\n

In many cases, string-formatted timestamps need to be converted to datetime objects. This allows easy manipulation, comparison, and standardization across an application. Also, one also finds the case to convert datetime objects to a string in Python as well — perhaps to provide human-readable outputs. In this short tutorial, both cases will be addressed and considered.<\/p>\n

TL;DR<\/h2>\n

Converting from a datetime object to a string is as simple as specifying the output format and using the strftime<\/code> function:<\/p>\n

# Create a datetime object\r\ndto = datetime.now()\r\n\r\n# Convert to string\r\nprint(dto.strftime(\"%Y-%m-%d\"))\r\n\r\n# Output\r\n2022-06-17<\/pre>\n
One can also easily convert from string to datetime in Python using the strptime<\/code> function as such:<\/p>\n
# Have a string\r\ndto = \"2022-06-17\"\r\n\r\n# Convert to datetime\r\ndto = datetime.strptime(dto, \"%Y-%m-%d\")\r\n\r\n>>> dto \r\n2022-06-17\r\n\r\n>>> type(dto)\r\n<class 'datetime.datetime'><\/pre>\n
Introduction: Datetime & Time Utilities<\/b><\/h2>\n
Handling dates, times, and calendar events in programming languages are deceptively complex. One must account for timezones, daylight savings changes, and even leap years. Fortunately for developers, Python offers the datetime module<\/a> as part of the standard library.<\/p>\n
Datetime objects can be categorized as either aware<\/strong> or naive<\/strong>. An “aware” datetime<\/code> object contains information about daylight savings time and the intended timezone. As such, these objects can be compared relative to one another without issue or need for conversion.<\/p>\n
A “naive” datetime<\/code> object only contains information about the time (which can include year, day, month as well) but no information about timezones or daylight savings periods. As such, application developers must decide how these objects are to be compared.<\/p>\n
Python’s datetime module converts between strings and datetime objects using a unique symbolic syntax. These symbols can be passed in string format to the datetime module via the strftime<\/code> and strptime<\/code> functions and control the format in which a datetime object is either parsed from a string or converted to a string.<\/p>\n
strftime<\/h3>\n
The strftime<\/code>\u00a0 method creates a string from a datetime object and is used as such:<\/p>\n
# Create a datetime object\r\ndto = datetime.now()\r\n\r\n# Convert to string\r\ndto_string = dto.strftime(\"%Y-%m-%d\")\r\n\r\n>>> dto_string\r\n2022-06-17 <class 'str'>\r\n\r\n>>> dto\r\n2022-06-17 00:00:00 <class 'datetime.datetime'>\r\n<\/pre>\n
Note that the dto<\/code> object remains a datetime<\/code> object, meaning the strftime<\/code> the method\u00a0returns<\/em> a string object but does not affect the underlying object. The meaning of this function’s name isn’t certain but possibly “string format time.”<\/p>\n
strptime<\/h3>\n
The strptime<\/code> method creates a new datetime<\/code> object from a string object and is used as such:<\/p>\n
# Have a string\r\ndto = \"2022-06-17\"\r\n\r\n# Convert to datetime\r\ndto = datetime.strptime(dto, \"%Y-%m-%d\")\r\n\r\n>>> dto\r\n2022-06-17 00:00:00 \r\n\r\n>>> type(dto)\r\n<class 'datetime.datetime'><\/pre>\n
Note that the dto<\/code> object now contains information for the hours, minutes, and seconds even those this information was not supplied. This utility will assume midnight exactly unless otherwise specified. The meaning of this function isn’t certain either, but possibly “string parse time.”<\/p>\n
Formatting<\/h2>\n
Formatting datetime objects and strings resulting form the strftime<\/code> function require some working knowledge of the datetime format codes. Python uses C-standard (1989) syntax for string formatting. See the full reference here<\/a>. Below are some of the more commonly-used terms:<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Symbol<\/td>\nMeaning<\/td>\nExample<\/td>\n<\/tr>\n
%Y<\/td>\nYear with century as a decimal number.<\/td>\n2001<\/td>\n<\/tr>\n
%y<\/td>\nYear without century as a zero-padded decimal number.<\/td>\n01<\/td>\n<\/tr>\n
%m<\/td>\nMonth as a zero-padded decimal number.<\/td>\n03<\/td>\n<\/tr>\n
%B<\/td>\nMonth as locale\u2019s full name.<\/td>\nJanuary<\/td>\n<\/tr>\n
%b<\/td>\nMonth as locale\u2019s abbreviated name.<\/td>\nJan<\/td>\n<\/tr>\n
%a<\/td>\nWeekday as locale\u2019s abbreviated name.<\/td>\nMon<\/td>\n<\/tr>\n
%A<\/td>\nWeekday as locale\u2019s full name.<\/td>\nMonday<\/td>\n<\/tr>\n
%H<\/td>\n24-Hour as a zero-padded number.<\/td>\n22<\/td>\n<\/tr>\n
%I<\/td>\n12-Hour as a zero-padded number<\/td>\n12<\/td>\n<\/tr>\n
%M<\/td>\nMinute as a zero-padded decimal number<\/td>\n03<\/td>\n<\/tr>\n
%S<\/td>\nSecond as a zero-padded decimal number.<\/td>\n59<\/td>\n<\/tr>\n
%Z<\/td>\nTime zone name<\/td>\nUTC<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
See the full reference here<\/a>.<\/p>\n
Convert String to Datetime<\/h2>\n
The above references and general use of the strptime<\/code> method provides the groundwork for converting strings to datetime objects in Python. The essential steps of this process are as follows:<\/p>\n
    \n
  1. Decide on the format<\/li>\n
  2. Construct Format string based on the reference list<\/li>\n
  3. Pass string and format string to strptime<\/code> method<\/li>\n<\/ol>\n
    Below is a slightly more complex example in which a string containing date, time and timezone information is presented:<\/p>\n
    \"\"\"\u00a0\r\nConvert a string to a datetime object\r\n\"\"\"\r\nfrom datetime import datetime\r\n\r\n# Create a string datetime\r\ndate = \"2022-06-17T18:23:59\"\r\n\r\n# Print output\r\nprint(date, type(date))<\/pre>\n
    Here we define an ISO format string representing the date and time then use the strptime<\/code> method to convert it to a datetime object. The following is the result from running this code:<\/p>\n
    2022-06-17 18:23:59 <class 'datetime.datetime'><\/pre>\n
    Convert Datetime to String<\/h2>\n
    Using Python to convert a datetime object to a string is similar to the process of converting a string to a datetime object — our previous example. One must use the same formatting syntax, make the same accommodations for timezone handling, and use the same underlying datetime<\/code> class. The difference is in the use of the strftime<\/code> methods rather than the strptime<\/code>. Consider the code below:<\/p>\n
    \"\"\"\r\nConvert datetime object to a string\r\n\"\"\"\r\nfrom datetime import datetime, timezone\r\n\r\n# Create a datetime object using explicit arguments\r\ndate = datetime(\r\n    year=2022,\r\n    month=6,\r\n    day=17,\r\n    hour=18,\r\n    minute=23,\r\n    second=59,\r\n    tzinfo=timezone.utc\r\n)\r\nprint(date, type(date))\r\n\r\n# Convert to string using formatting syntax\r\ndate = date.strftime(\"%Y-%m-%dT%H:%M:%S %Z%z\")\r\nprint(date, type(date))<\/pre>\n
    In this code a datetime object is constructed explicitly using keyword arguments, including the timezone — thus making an aware datetime object. This object is then converted to a string representation via the strftime<\/code> method such that the full date, time, and timezone information is displayed. Below is the resulting output:<\/p>\n
    2022-06-17 18:23:59+00:00 <class 'datetime.datetime'>\r\n2022-06-17T18:23:59 UTC+0000 <class 'str'><\/pre>\n
    Handling Timezone Information<\/h2>\n
    In the first example, a string was converted to a naive datetime object — meaning there is no timezone information.\u00a0 The following code outlines a process via which timezone information (be it local timezone or another) can be injected into any datetime object:<\/p>\n
    \"\"\"\r\nConvert a string to a datetime object, adding timezone information,\r\nthen convert back into a string with timezone information.\r\n\"\"\"\r\nfrom datetime import datetime, timezone\r\n\r\n# Create a string datetime\r\ndate = \"2022-06-17T18:23:59\"\r\n\r\n# Convert to naive datetime object\r\ndate = datetime.strptime(date, \"%Y-%m-%dT%H:%M:%S\")\r\n\r\n# Add UTC Timezone Info\r\ndate.replace(tzinfo=timezone.utc)\r\nprint(\"Initial Timezone:\", date.tzinfo)\r\n\r\n# Add UTC Timezone w\/ Assignment\r\ndate = date.replace(tzinfo=timezone.utc)\r\nprint(\"Updated Timezone:\", date.tzinfo)\r\n\r\n# Convert to Timezone Format\r\ntz_date = date.strftime(\"%Y-%m-%dT%H:%M:%S %Z%z\")\r\nprint(\"Converted Timezone:\", tz_date)<\/pre>\n
    Here a datetime object is created via the strptime<\/code> method which parses the date<\/code> string which provides no timezone information. The replace<\/code> method is then used to replace the None<\/code> value for the tzinfo<\/code> field with the timezone.utc<\/code> value indicating UTC time. However, in printing the value for date<\/code> directly afterward, it is realized that the date<\/code> object is still timezone naive — what gives?<\/p>\n
    To ensure the replacement happens one must assign the return value to a new variable or, as is the case with this example, replace the value of an existing variable. After such an approach in the above code, we now see the date.tzinfo<\/code> field to reflect the intended value.<\/p>\n
    Finally, we use the strptime<\/code> method to convert the now-aware date<\/code> object into a final output string which reflects the timezone information via the %T%t<\/code> format syntax. The result of this code is as follows:<\/p>\n
    Initial Timezone: None\r\nUpdated Timezone: UTC\r\nConverted Timezone: 2022-06-17T18:23:59 UTC+0000<\/pre>\n
    Final Thoughts<\/h2>\n
    The datetime module in Python allows developers to easily convert between strings and datetime objects. Special attention should be given to ensuring timezone information is encoded, replaced, and converted to a string format as intended. These values, while tricky to manage sometimes, allow the robust representation of dates and times through a range of applications.<\/p>\n","protected":false},"excerpt":{"rendered":"
    Python offers the datetime library for handling many date-based operations such as converting timestamps into human-readable formats. This library provides convenient means to convert string timestamps to datetime objects via which developers are provided a unified API for interacting with, updating and making time-based calculations. In many cases, string-formatted timestamps need to be converted to […]<\/p>\n","protected":false},"author":2,"featured_media":2894,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"inline_featured_image":false,"footnotes":""},"categories":[10],"tags":[277,143,278,657],"acf":[],"_links":{"self":[{"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/posts\/2893"}],"collection":[{"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/comments?post=2893"}],"version-history":[{"count":1,"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/posts\/2893\/revisions"}],"predecessor-version":[{"id":2895,"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/posts\/2893\/revisions\/2895"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/media\/2894"}],"wp:attachment":[{"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/media?parent=2893"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/categories?post=2893"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/tags?post=2893"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}