Skip to content

# Public suffix

The tool to check the availability or syntax of domain, IP or URL.

::

    ██████╗ ██╗   ██╗███████╗██╗   ██╗███╗   ██╗ ██████╗███████╗██████╗ ██╗     ███████╗
    ██╔══██╗╚██╗ ██╔╝██╔════╝██║   ██║████╗  ██║██╔════╝██╔════╝██╔══██╗██║     ██╔════╝
    ██████╔╝ ╚████╔╝ █████╗  ██║   ██║██╔██╗ ██║██║     █████╗  ██████╔╝██║     █████╗
    ██╔═══╝   ╚██╔╝  ██╔══╝  ██║   ██║██║╚██╗██║██║     ██╔══╝  ██╔══██╗██║     ██╔══╝
    ██║        ██║   ██║     ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
    ╚═╝        ╚═╝   ╚═╝      ╚═════╝ ╚═╝  ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝

Provides our public suffix file generator.

Author: Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom

Special thanks: https://pyfunceble.github.io/#/special-thanks

Contributors: https://pyfunceble.github.io/#/contributors

Project link: https://github.com/funilrys/PyFunceble

Project documentation: https://docs.pyfunceble.com

Project homepage: https://pyfunceble.github.io/

License: ::

    Copyright 2017, 2018, 2019, 2020, 2022, 2023, 2024, 2025 Nissar Chababy

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        https://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

## `PublicSuffixGenerator`

Provides an interface for the generation of the public suffix file.

Source code in `PyFunceble/cli/scripts/public_suffix.py`

     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202

    class PublicSuffixGenerator:
        """
        Provides an interface for the generation of the public suffix file.
        """

        UPSTREAM_LINK: str = (
            "https://raw.githubusercontent.com/publicsuffix/list/%s/public_suffix_list.dat"
            % "master"
        )
        """
        Provides the upstream stream.
        """

        COMMENT_SIGN: str = ["//", "!"]
        """
        The sign which we should consider as comment.
        """

        _destination: Optional[str] = None

        database: dict = {}
        """
        An internal storage of our map.
        """

        wildcard2subject: Wildcard2Subject = Wildcard2Subject()

        def __init__(self, destination: Optional[str] = None) -> None:
            if destination is not None:
                self.destination = destination
            else:
                self.destination = PublicSuffixDataset().source_file

        @property
        def destination(self) -> Optional[str]:
            """
            Provides the current state of the :code:`_destination` attribute.
            """

            return self._destination

        @destination.setter
        def destination(self, value: str) -> None:
            """
            Sets the destination to write.

            :param value:
                The value to set.

            :raise TypeError:
                When the given :code:`value` is not a :py:class:`str`.
            :raise ValueError:
                When the given :code:`value` is empty.
            """

            if not isinstance(value, str):
                raise TypeError(f"<value> should be {str}, {type(value)} given.")

            if not value:
                raise ValueError("<value> should not be empty.")

            self._destination = value

        def set_destination(self, value: str) -> "PublicSuffixGenerator":
            """
            Sets the destination to write.

            :param value:
                The value to set.
            """

            self.destination = value

            return self

        def parse_line(self, line: str) -> dict:
            """
            Parses and provides the dataset to save.
            """

            line = line.strip()
            result = {}

            if not any(line.startswith(x) for x in self.COMMENT_SIGN) and "." in line:
                lines = [line, line.encode("idna").decode("utf-8")]
                lines = [
                    self.wildcard2subject.set_data_to_convert(x).get_converted()
                    for x in lines
                ]
                extension = lines[0].rsplit(".", 1)[-1]

                for suffix in lines:
                    if extension in result:
                        result[extension].append(suffix)
                    else:
                        result[extension] = [suffix]

            return result

        def start(self, max_workers: Optional[int] = None):
            """
            Starts the generation of the dataset file.
            """

            raw_data = (
                DownloadHelper(
                    self.UPSTREAM_LINK,
                    certificate_validation=(
                        PyFunceble.storage.CONFIGURATION.verify_ssl_certificate
                        if PyFunceble.storage.CONFIGURATION
                        else True
                    ),
                    own_proxy_handler=True,
                    proxies=PyFunceble.storage.PROXY,
                )
                .download_text()
                .split("\n")
            )

            with concurrent.futures.ThreadPoolExecutor(max_workers=max_workers) as executor:
                for result in executor.map(self.parse_line, raw_data):
                    for extension, suffixes in result.items():
                        if extension not in self.database:
                            self.database[extension] = suffixes
                        else:
                            self.database[extension].extend(suffixes)

                        PyFunceble.facility.Logger.debug(
                            "Got: extension: %r ; suffixes: %r.", extension, suffixes
                        )

            for extension, suffixes in self.database.items():
                self.database[extension] = (
                    ListHelper(suffixes).remove_duplicates().remove_empty().sort().subject
                )

            DictHelper(self.database).to_json_file(self.destination)

            return self

### `COMMENT_SIGN = ['//', '!']` `class-attribute` `instance-attribute`

The sign which we should consider as comment.

### `UPSTREAM_LINK = 'https://raw.githubusercontent.com/publicsuffix/list/%s/public_suffix_list.dat' % 'master'` `class-attribute` `instance-attribute`

Provides the upstream stream.

### `database = {}` `class-attribute` `instance-attribute`

An internal storage of our map.

### `destination` `property` `writable`

Provides the current state of the :code:`_destination` attribute.

### `parse_line(line)`

Parses and provides the dataset to save.

Source code in `PyFunceble/cli/scripts/public_suffix.py`

    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161

    def parse_line(self, line: str) -> dict:
        """
        Parses and provides the dataset to save.
        """

        line = line.strip()
        result = {}

        if not any(line.startswith(x) for x in self.COMMENT_SIGN) and "." in line:
            lines = [line, line.encode("idna").decode("utf-8")]
            lines = [
                self.wildcard2subject.set_data_to_convert(x).get_converted()
                for x in lines
            ]
            extension = lines[0].rsplit(".", 1)[-1]

            for suffix in lines:
                if extension in result:
                    result[extension].append(suffix)
                else:
                    result[extension] = [suffix]

        return result

### `set_destination(value)`

Sets the destination to write.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`value` | `str` | The value to set. | required

Source code in `PyFunceble/cli/scripts/public_suffix.py`

    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137

    def set_destination(self, value: str) -> "PublicSuffixGenerator":
        """
        Sets the destination to write.

        :param value:
            The value to set.
        """

        self.destination = value

        return self

### `start(max_workers=None)`

Starts the generation of the dataset file.

Source code in `PyFunceble/cli/scripts/public_suffix.py`

    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202

    def start(self, max_workers: Optional[int] = None):
        """
        Starts the generation of the dataset file.
        """

        raw_data = (
            DownloadHelper(
                self.UPSTREAM_LINK,
                certificate_validation=(
                    PyFunceble.storage.CONFIGURATION.verify_ssl_certificate
                    if PyFunceble.storage.CONFIGURATION
                    else True
                ),
                own_proxy_handler=True,
                proxies=PyFunceble.storage.PROXY,
            )
            .download_text()
            .split("\n")
        )

        with concurrent.futures.ThreadPoolExecutor(max_workers=max_workers) as executor:
            for result in executor.map(self.parse_line, raw_data):
                for extension, suffixes in result.items():
                    if extension not in self.database:
                        self.database[extension] = suffixes
                    else:
                        self.database[extension].extend(suffixes)

                    PyFunceble.facility.Logger.debug(
                        "Got: extension: %r ; suffixes: %r.", extension, suffixes
                    )

        for extension, suffixes in self.database.items():
            self.database[extension] = (
                ListHelper(suffixes).remove_duplicates().remove_empty().sort().subject
            )

        DictHelper(self.database).to_json_file(self.destination)

        return self