tld¶
Extract the top level domain (TLD) from the URL given. List of TLD names is taken from Mozilla.
Optionally raises exceptions on non-existing TLDs or silently fails (if
fail_silently
argument is set to True).
Prerequisites¶
- Python 2.7, 3.4, 3.5, 3.6, 3.7, 3.8 and PyPy
Documentation¶
Documentation is available on Read the Docs.
Installation¶
Latest stable version on PyPI:
pip install tld
Or latest stable version from GitHub:
pip install https://github.com/barseghyanartur/tld/archive/stable.tar.gz
Or latest stable version from BitBucket:
pip install https://bitbucket.org/barseghyanartur/tld/get/stable.tar.gz
Usage examples¶
In addition to examples below, see the jupyter notebook workbook file.
Get the TLD name as string from the URL given¶
from tld import get_tld
get_tld("http://www.google.co.uk")
# 'co.uk'
get_tld("http://www.google.idontexist", fail_silently=True)
# None
Get the TLD as an object¶
from tld import get_tld
res = get_tld("http://some.subdomain.google.co.uk", as_object=True)
res
# 'co.uk'
res.subdomain
# 'some.subdomain'
res.domain
# 'google'
res.tld
# 'co.uk'
res.fld
# 'google.co.uk'
res.parsed_url
# SplitResult(
# scheme='http',
# netloc='some.subdomain.google.co.uk',
# path='',
# query='',
# fragment=''
# )
Get TLD name, ignoring the missing protocol¶
from tld import get_tld, get_fld
get_tld("www.google.co.uk", fix_protocol=True)
# 'co.uk'
get_fld("www.google.co.uk", fix_protocol=True)
# 'google.co.uk'
Return TLD parts as tuple¶
from tld import parse_tld
parse_tld('http://www.google.com')
# 'com', 'google', 'www'
Get the first level domain name as string from the URL given¶
from tld import get_fld
get_fld("http://www.google.co.uk")
# 'google.co.uk'
get_fld("http://www.google.idontexist", fail_silently=True)
# None
Check if some tld is a valid tld¶
from tld import is_tld
is_tld('co.uk)
# True
is_tld('uk')
# True
is_tld('tld.doesnotexist')
# False
is_tld('www.google.com')
# False
Update the list of TLD names¶
To update/sync the tld names with the most recent version run the following from your terminal:
update-tld-names
Or simply do:
from tld.utils import update_tld_names
update_tld_names()
Custom list of TLD names¶
You could maintain your own custom version of the TLD names list (even multiple ones) and use them simultaneously with built in TLD names list.
You would then store them locally and provide a path to it as shown below:
from tld import get_tld
get_tld(
"http://www.foreverchild",
tld_names_local_path="tests/res/effective_tld_names_custom.dat.txt"
)
# 'foreverchild'
Same goes for first level domain names:
from tld import get_fld
get_fld(
"http://www.foreverchild",
tld_names_local_path="tests/res/effective_tld_names_custom.dat.txt"
)
# 'www.foreverchild'
Note, that in both examples shown above, there the original TLD names file has been modified in the following way:
...
// ===BEGIN ICANN DOMAINS===
// This one actually does not exist, added for testing purposes
foreverchild
...
Free resources¶
To free up memory occupied by loading of custom TLD names, use
reset_tld_names
function with tld_names_local_path
parameter.
from tld import get_tld, reset_tld_names
# Get TLD from a custom TLD names list
get_tld(
"http://www.foreverchild",
tld_names_local_path="tests/res/effective_tld_names_custom.dat.txt"
)
# Free resources occupied by the custom TLD names list
reset_tld_names("tests/res/effective_tld_names_custom.dat.txt")
Troubleshooting¶
If somehow domain names listed here are not recognised, make sure you have the most recent version of TLD names in your virtual environment:
update-tld-names
Writing documentation¶
Keep the following hierarchy.
=====
title
=====
header
======
sub-header
----------
sub-sub-header
~~~~~~~~~~~~~~
sub-sub-sub-header
^^^^^^^^^^^^^^^^^^
sub-sub-sub-sub-header
++++++++++++++++++++++
sub-sub-sub-sub-sub-header
**************************
License¶
MPL-1.1 OR GPL-2.0-only OR LGPL-2.1-or-later
Author¶
Artur Barseghyan <artur.barseghyan@gmail.com>
Docs¶
Contents:
- tld
- Prerequisites
- Documentation
- Installation
- Usage examples
- Update the list of TLD names
- Custom list of TLD names
- Free resources
- Troubleshooting
- Testing
- Writing documentation
- License
- Support
- Author
- Docs
- Indices and tables
- Release history and notes
- tld package