Notice
This module is Dropping Support for Python 2.7 and 3.4
In the upcoming version 1.0.0, support for Python 2.7 and 3.4 will be discontinued. Version 0.10.x (or auto-released versions with the .yyyymmdd suffix) will be the last to support Python 2.7.
The minimum requirement for new versions will be Python 3.5 or later.
The new version will include type hinting to enhance API stability. The updated code is currently available in the devel branch. https://github.com/ko-zu/psl/tree/devel
If you know of any users still relying on this module with Python 2.7, please comment on github issue. https://github.com/ko-zu/psl/issues/30
publicsuffixlist
Public Suffix List parser implementation for Python 2.6+/3.x.
- Compliant with TEST DATA
- Support IDN (unicode or punycoded).
- Support Python2.6+ and Python 3.x
- Shipped with built-in PSL and the updater script.
- Written in Pure Python. No library dependencies.
Install
publicsuffixlist can be installed via pip or pip3.
$ sudo pip install publicsuffixlist
If you are in a bit old distributions (RHEL/CentOS6.x), you may need to update pip itself before install.
$ sudo pip install -U pip
Usage
from publicsuffixlist import PublicSuffixList
psl = PublicSuffixList()
# uses built-in PSL file
psl.publicsuffix("www.example.com") # "com"
# longest public suffix part
psl.privatesuffix("www.example.com") # "example.com"
# shortest domain assigned for a registrant
psl.privatesuffix("com") # None
# None if no private (non-public) part found
psl.publicsuffix("www.example.unknownnewtld") # "unknownnewtld"
# new TLDs are valid public suffix by default
psl.publicsuffix(u"www.example.香港") # u"香港"
# accept unicode
psl.publicsuffix("www.example.xn--j6w193g") # "xn--j6w193g"
# accept punycoded IDNs by default
Latest PSL can be passed as a file like line-iterable object.
with open("latest_psl.dat", "rb") as f:
psl = PublicSuffixList(f)
Works with both Python 2.x and 3.x.
$ python2 setup.py test
$ python3 setup.py test
Drop-in compatibility code to replace publicsuffix
# from publicsuffix import PublicSuffixList
from publicsuffixlist.compat import PublicSuffixList
psl = PublicSuffixList()
psl.suffix("www.example.com") # return "example.com"
psl.suffix("com") # return "" (as str, not None)
Some convenient methods available.
psl.is_private("example.com") # True
psl.privateparts("aaa.www.example.com") # ("aaa", "www", "example.com")
psl.subdomain("aaa.www.example.com", depth=1) # "www.example.com"
Limitation
publicsuffixlist do NOT provide domain name validation.
In DNS protocol, most of 8-bit characters are acceptable label of domain name. ICANN compliant registries do not accept domain names that have _ (underscore) but hostname may have. DMARC records, for example.
Users need to confirm the input is valid based on the users' context.
Partially encoded (Unicode-mixed) Punycode is not supported because of very slow Punycode en/decoding and unpredictable encoding of results.
If you are not sure the input is valid Punycode or not, you should do unknowndomain.encode("idna") which is idempotence.
ICANN and private suffixes
The public suffix list contains both suffixes for ICANN domains and private suffixes. Using the flag only_icann the private suffixes can be deactivated:
>>> psl = PublicSuffixList()
>>> psl.publicsuffix("example.priv.at")
'priv.at'
>>> psl = PublicSuffixList(only_icann=True)
>>> psl.publicsuffix("example.priv.at")
'at'
License
- This module is licensed under Mozilla Public License 2.0.
- Public Suffix List maintained by Mozilla Foundation is licensed under Mozilla Public License 2.0.
- PSL testcase dataset is public domain (CC0).
Development / Packaging
This module and its packaging workflow are maintained in the author's repository located at https://github.com/ko-zu/psl.
A new package, which includes the latest PSL file, is automatically generated and uploaded to PyPI.
The last part of the version number represents the release date, for instance, 0.10.1.20230331.
Source / Link
- Git repository on GitHub (https://github.com/ko-zu/psl)
- PyPI (https://pypi.org/project/publicsuffixlist/)
1 maintainer
Release files for publicsuffixlist 0.10.1.20240616
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| publicsuffixlist-0.10.1.20240616.tar.gz | 102.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| publicsuffixlist-0.10.1.20240616-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 204.7 kB
Release files / publicsuffixlist-0.10.1.20240616.tar.gz
| Download URL | publicsuffixlist-0.10.1.20240616.tar.gz |
|---|---|
| Size | 102.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7d598406bf689ac09e440b1a3d4674ef2d629ff6f1ec97861c83f0ac1c46a58f
|
|
BLAKE2b-256 checksum How to use checksums |
af573ea928fac754715161b13560582e5c46e9914880d211e9caf3fda91ef930
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.12.4
|
Release files / publicsuffixlist-0.10.1.20240616-py2.py3-none-any.whl
| Download URL | publicsuffixlist-0.10.1.20240616-py2.py3-none-any.whl |
|---|---|
| Size | 102.2 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
8b629f5404a5f2ca78cba24cb4a4fbf1d594f7ada062eb1dd5d8cdd62d9dfbe1
|
|
BLAKE2b-256 checksum How to use checksums |
e121437b0cbbbddfc254cb56bbc09c65fb291fde63803b832bdf30a538a20028
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.12.4
|
