publicsuffix2 2.20190205

Usage

Install with:

pip install publicsuffix2

The module provides a function to query a domain name:

>>> from publicsuffix2 import get_public_suffix
>>> get_public_suffix('www.example.com')
'example.com'
>>> get_public_suffix('www.example.co.uk')
'example.co.uk'
>>> get_public_suffix('www.super.example.co.uk')
'example.co.uk'

This function loads and caches the public suffix list.

For more control, there is also a class that parses a Public Suffix List and allows the same queries on individual domain names:

>>> from publicsuffix2 import PublicSuffixList
>>> psl = PublicSuffixList()
>>> psl.get_public_suffix('www.example.com')
'example.com'
>>> psl.get_public_suffix('www.example.co.uk')
'example.co.uk'
>>> psl.get_public_suffix('www.super.example.co.uk')
'example.co.uk'

Note that the host part of an URL can contain strings that are not plain DNS domain names (IP addresses, Punycode-encoded names, name in combination with a port number or a username, etc.). It is up to the caller to ensure only domain names are passed to the get_public_suffix() method.

The get_public_suffix() function and the PublicSuffixList class initializer accept an optional argument pointing to a public suffix file. This can either be a file path, an iterable of public suffix lines, or a file-like object pointing to an opened list:

>>> from publicsuffix import get_public_suffix
>>> psl_file = 'path to some psl data file'
>>> get_public_suffix('www.example.com', psl_file)
'example.com'

Note that when using get_public_suffix() a global cache keeps the latest provided suffix list data. This will use the cached latest loaded above:

>>> get_public_suffix('www.example.co.uk')
'example.co.uk'

To update the bundled suffix list use the provided setup.py command:

python setup.py update_psl

The update list will be saved in src/publicsuffix2/public_suffix_list.dat and you can build a new wheel with this bundled data.

Alternatively, there is a fetch() function that will fetch the latest version of a Public Suffix data file from https://publicsuffix.org/list/public_suffix_list.dat You can use it this way:

>>> from publicsuffix import get_public_suffix
>>> from publicsuffix import fetch
>>> psl_file = fetch()
>>> get_public_suffix('www.example.com', psl_file)
'example.com'

Note that the once loaded, the data file is cached and therefore fetched only once.

Source

Get a local copy of the development repository. The development takes place in the develop branch. Stable releases are tagged in the master branch:

git clone https://github.com/nexB/python-publicsuffix2.git

History

This code is forked from Tomaž Šolc’s fork of David Wilson’s code originally at:

https://www.tablix.org/~avian/git/publicsuffix.git

Copyright (c) 2014 Tomaž Šolc <tomaz.solc@tablix.org>

The API is essentially the same as publicsuffix including using the same package name to allow a straight forward replacement.

David Wilson’s code was originally at:

from http://code.google.com/p/python-public-suffix-list/

Copyright (c) 2009 David Wilson

License

The code is MIT-licensed. The vendored public suffix list data from Mozilla is under the MPL-2.0.

Copyright (c) 2015 nexB Inc.

Copyright (c) 2014 Tomaž Šolc <tomaz.solc@tablix.org>

Copyright (c) 2009 David Wilson

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Changelog

2019-02-05 publicsuffix2 2.201902051213

• Updated publicsuffix.file to the latest version from Mozilla.

• Restored a fetch() function by popular demand

2018-12-13 publicsuffix2 2.20181213

• Updated publicsuffix.file to the latest version from Mozilla.

2018-10-01 publicsuffix2 2.20180921.2

• Updated publicsuffix.file to the latest version from Mozilla.

• Breaking API change: publicsuffix module renamed to publicsuffix2

2016-08-18 publicsuffix2 2.20160818

• Updated publicsuffix.file to the latest version from Mozilla.

2016-06-21 publicsuffix2 2.20160621

• Updated publicsuffix.file to the latest version from Mozilla.

• new version scheme: major.<publisiffix list date>

2016-06-21 publicsuffix2 2.20160621

• Updated publicsuffix.file to the latest version from Mozilla.

• new version scheme: major.<publisiffix list date>

2015-10-12 publicsuffix2 2.1.0

• Merged latest updates from publicsuffix

• Added new convenience top level get_public_suffix_function caching a loaded list if needed.

• Updated publicsuffix.file to the latest version from Mozilla.

• Added an update_psl setup command to fetch and vendor the latest list Use as: python setup.py update_psl

2015-06-04 publicsuffix2 2.0.0

• Forked publicsuffix, but kept the same API

• Updated publicsuffix.file to the latest version from Mozilla.

• Changed packaging to have the suffix list be package data and be wheel friendly.

• Use spaces indentation, not tabs

2014-01-14 publicsuffix 1.0.5

• Correctly handle fully qualified domain names (thanks to Matthäus Wander).

• Updated publicsuffix.txt to the latest version from Mozilla.

2013-01-02 publicsuffix 1.0.4

• Added missing change log.

2013-01-02 publicsuffix 1.0.3

• Updated publicsuffix.txt to the latest version from Mozilla.

• Added trove classifiers.

• Minor update of the README.

2011-10-10 publicsuffix 1.0.2

• Compatibility with Python 3.x (thanks to Joern Koerner) and Python 2.5

2011-09-22 publicsuffix 1.0.1

• Fixed installation issue under virtualenv (thanks to Mark McClain)

2011-07-29 publicsuffix 1.0.0

• First release