Python: Let’s Create a Easy HTTP Server (Tutorial)

Internet severs are all over the place.

Heck you’re interacting with one proper now!

It doesn’t matter what kind of software program engineer you’re, in some unspecified time in the future in your profession you’ll have to work together with net servers. Could also be you’re constructing an API server for a backend service. Or could also be you’re simply configuring an online server in your web site.

On this article, I’ll cowl the way to create essentially the most fundamental http net server in Python.

However as a result of I need to ensure you perceive what we’re constructing, I’m going to provide an summary first about what net servers are and the way they work.

In the event you already understand how net servers work, then you may skip on to this part.

What’s an HTTP Server?

An HTTP net server is nothing however a course of that’s operating in your machine and does precisely two issues:

1- Listens for incoming http requests on a particular TCP socket deal with (IP deal with and a port quantity which I’ll speak about later)

2- Handles this request and sends a response again to the person.

Let me make my level much less summary.

Think about you pull up your Chrome browser and kind within the deal with bar.

After all you’re going to get the Yahoo dwelling web page rendered in your browser window.

However what actually simply occurred below the hood?

Truly plenty of issues have occurred and I’d dedicate a complete article to clarify the magic behind how this occurred.

However for the sake of simplicity, I’ll summary away a number of the particulars and speak about this at a very excessive degree.

At a excessive degree, whenever you kind in your browser, your browser will create a community message referred to as an HTTP request.

This Request will journey all the best way to a Yahoo laptop that has an online server operating on it. This net server will intercept your request, and deal with it by responding again with the html of the Yahoo dwelling web page.

Lastly your browser renders this html on the display and that’s what you see in your display.

Each interplay with the Yahoo dwelling web page after that (for instance, whenever you click on on a hyperlink) initiates a brand new request and response precisely like the primary one.

To reiterate, the machine that receives the http request has a software program course of referred to as an online server operating on it. This net server is chargeable for intercepting these requests and dealing with them appropriately.

Alright, now that what an online server is and what its perform is precisely, you is perhaps questioning how does the request attain that yahoo machine within the first place?

Good query!

In truth that is one among my favourite questions that I ask potential candidates in a coding interview.

Let me clarify how, however once more….at a excessive degree.

The TCP Socket Tackle

Any http message (whether or not it’s a request or response) must know the way to attain its vacation spot.

With a purpose to attain its vacation spot, every http message carries an deal with referred to as the vacation spot TCP deal with.

And every TCP deal with consists of an IP deal with and a port quantity.

I do know all these acronyms (TCP, IP, and so on..) is perhaps overwhelming in case your networking ideas usually are not sturdy.

I’ll attempt to preserve it easy however in case you are fascinated by bettering your information of networking ideas, I extremely suggest this guide by Ross and Kurose.

So the place is that deal with when all you probably did was kind in your browser?

Nicely, this area identify is transformed into an IP deal with by means of a big distributed database referred to as the DNS.

Do you need to take a look at what this IP deal with is?

Simple! Head to your terminal and do the next:

$ host has deal with has deal with has deal with has deal with has deal with has deal with has IPv6 deal with 2001:4998:44:41d::3 has IPv6 deal with 2001:4998:c:1023::5 has IPv6 deal with 2001:4998:c:1023::4 has IPv6 deal with 2001:4998:58:1836::10 has IPv6 deal with 2001:4998:58:1836::11 has IPv6 deal with 2001:4998:44:41d::4 mail is dealt with by 1 mta5.am0.yahoodns.internet. mail is dealt with by 1 mta6.am0.yahoodns.internet. mail is dealt with by 1 mta7.am0.yahoodns.internet.

As you may see, the DNS will translate to any of the addresses above.

The IP deal with alone will enable the HTTP message to reach on the proper machine, however you continue to want the port quantity to ensure that the HTTP request to reach precisely on the net server.

In different phrases, the net server is a daily community utility that’s listening on a particular port.

And the http request MUST be addressed to that port.

So the place is the port quantity whenever you kind

By default, the port quantity is 80 for http and 443 for https, so although you haven’t explicitly specified the port quantity, it’s nonetheless there.

And if the net server is listening on a non-default port quantity (neither 80 nor 443), it’s essential to explicitly specify the port quantity like this:

By now it is best to have all the required data to create an http net server in Python.

So with out additional ado, let’s get began.

Create a easy HTML file

Here’s what we need to do.

We need to create a easy http server that serves a static html net web page.

Let’s create our html web page.

        Python is superior!


Congratulations! The HTTP Server is working!

Now go forward and save this file as index.html

With the net web page that we need to serve out of the best way, the following step is to create an online server that may serve this html web page.

Create an HTTP net server

With a purpose to create an online server in Python 3, you will want to import two modules: http.server and socketserver

Discover that in Python 2, there was a module named SimpleHTTPServer. This module has been merged into http.server in Python 3

Let’s check out the code to create an http server

import http.server
import socketserver

PORT = 8080
Handler = http.server.SimpleHTTPRequestHandler

with socketserver.TCPServer(("", PORT), Handler) as httpd:
    print("serving at port", PORT)

Identical to that now we have a practical http server.

Now let’s dissect this code line-by-line.

First, as I discussed earlier, an online server is a course of that listens to incoming requests on particular TCP deal with.

And as by now a TCP deal with is recognized by an ip deal with and a port quantity.

Second, an online server additionally must be instructed the way to deal with incoming requests.

These incoming requests are dealt with by particular handlers. You may consider an online server as a dispatcher, a request is available in, the http server inspects the request and dispatches it to a delegated handler.

After all these handlers can do something you want.

However what do you suppose essentially the most fundamental handler is?

Nicely, that might be a handler that simply serves a static file.

In different phrases, once I go to, the net server on the different finish sends again a static html file.

That is in truth what we’re precisely making an attempt to do.

And that, my pal, is what the http.server.SimpleHTTPRequestHandler is: a easy HTTP request handler that serves information from the present listing and any of its subdirectories.

Now let’s discuss concerning the socketserver.TCPServer class.

An occasion of TCPServer describes a server that makes use of the TCP protocol to ship and obtain messages (http is an utility layer protocol on high of TCP).

To instantiate a TCP Server, we’d like two issues:

1- The TCP deal with (IP deal with and a port quantity)

2- The handler

socketserver.TCPServer(("", PORT), Handler)

As you may see, the TCP deal with is handed as a tuple of (ip deal with, port quantity)

Passing an empty string because the ip deal with implies that the server shall be listening on any community interface (all accessible IP addresses).

And since PORT shops the worth of 8080, then the server shall be listening on incoming requests on that port.

For the handler, we’re passing the straightforward handler that we talked about earlier.

Handler = http.server.SimpleHTTPRequestHandler

Nicely, how about serve_forever?

serve_forever is a technique on the TCPServer occasion that begins the server and begins listening and responding to incoming requests.

Cool, let’s save this file as in the identical listing as index.html as a result of by default the SimpleHTTPRequestHandler will search for a file named index.html within the present listing.

In that listing, begin the net server:

$ python
serving at port 8080

By doing that, you now have an HTTP server that’s listening on any interface at port 8080 ready for incoming http requests.

It’s time now for the enjoyable stuff!

Open your browser and kind localhost:8080 within the deal with bar.

Superior! Seems like every part is working nice.

However hey what’s localhost?

localhost is a bunch identify meaning this laptop. It’s used to entry the community providers which can be operating on the host through the loopback community interface.

And for the reason that net server is listening on any interface, additionally it is listening on the loopback interface.

You need to know what IP deal with corresponds to localhost?

You bought it.

$ host localhost
localhost has deal with
localhost has IPv6 deal with ::1
Host localhost not discovered: 3(NXDOMAIN)

In truth you may completely change localhost with in your browser and you’ll nonetheless get the identical outcome.

Attempt it out 🙂

One Ultimate Phrase

You may really begin an online server with python with out even having to write down any scripts.

Simply go to your terminal and do the next (however ensure you are on python 3)

python -m http.server 8080

By default, this server shall be listening on all interfaces and on port 8080.

If you wish to take heed to a particular interface, do the next:

python -m http.server 8080 --bind

Additionally ranging from Python 3.7, you should use the –listing flag to serve information from a listing that isn’t essentially the present listing.

So the query now could be, why would you ever want to write down a script when you may simply invoke the server simply from the terminal?

Nicely, keep in mind that you’re utilizing the SimpleHTTPRequestHandler. If you wish to create your customized handlers (which you’ll in all probability need to do) you then gained’t be capable of try this from the terminal.

Studying Python?

Try the Programs part!

Featured Posts

Are you Starting your Programming Profession?

I present my finest content material for freshmen within the publication.

  • Python suggestions for freshmen, intermediate, and superior ranges.
  • CS Profession suggestions and recommendation.
  • Particular reductions on my premium programs once they launch.

And a lot extra…

Subscribe now. It’s Free.

Leave a Reply

Your email address will not be published. Required fields are marked *