Skip to content

# Url2netloc

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

::

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

Provides a way to convert/extract the network location of a given URL.

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.

## `Url2Netloc`

Bases: `ConverterBase`

Provides the interface for the conversion/extraction of the network location of a given URL.

Source code in `PyFunceble/converter/url2netloc.py`

     59
     60
     61
     62
     63
     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

    class Url2Netloc(ConverterBase):
        """
        Provides the interface for the conversion/extraction of the network location
        of a given URL.
        """

        parsed_url: Optional[urllib.parse.ParseResult] = None
        """
        Expose the parsed URL.
        """

        @ConverterBase.data_to_convert.setter
        def data_to_convert(self, value: Any) -> None:
            """
            Overrides the default behavior.

            :raise TypeError:
                When the given data to convert is not :py:class:`str`
            :raise ValueError:
                When the given data to convert 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.")

            # pylint: disable=no-member
            super(Url2Netloc, self.__class__).data_to_convert.fset(self, value)

        @staticmethod
        def parse_single_url(data) -> Optional[urllib.parse.ParseResult]:
            """
            Parses the URL.
            """

            if data:
                if "[" in data and "]" not in data or "]" in data and "[" not in data:
                    # Own wrapper around "Invalid IPv6 URL" when
                    # http://example.org."] is given (for example.)
                    data = data.replace("[", "").replace("]", "")

                return urllib.parse.urlparse(data)
            return None

        def parse_url(self) -> "Url2Netloc":
            """
            Parses the URL.
            """

            self.parsed_url = self.parse_single_url(self.data_to_convert)

            return self

        def get_converted(self) -> str:
            """
            Provides the converted data (after conversion)
            """

            # Retro-compatibility.
            self.parse_url()

            return self.convert(self.data_to_convert)

        def convert(self, data: Any, *, aggressive: bool = False) -> str:
            """
            Converts the given dataset.

            :param data:
                The data to convert.
            """

            _ = aggressive
            parsed_url = self.parse_single_url(data)

            if not parsed_url.netloc and parsed_url.path:
                netloc = parsed_url.path
            elif parsed_url.netloc:
                netloc = parsed_url.netloc
            else:  # pragma: no cover ## Safety
                netloc = data

            if "//" in netloc:
                netloc = netloc[netloc.find("//") + 2 :]

            if "/" in netloc:
                netloc = netloc[: netloc.find("/")]

            return netloc

### `parsed_url = None` `class-attribute` `instance-attribute`

Expose the parsed URL.

### `convert(data, *, aggressive=False)`

Converts the given dataset.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`data` | `Any` | The data to convert. | required

Source code in `PyFunceble/converter/url2netloc.py`

    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

    def convert(self, data: Any, *, aggressive: bool = False) -> str:
        """
        Converts the given dataset.

        :param data:
            The data to convert.
        """

        _ = aggressive
        parsed_url = self.parse_single_url(data)

        if not parsed_url.netloc and parsed_url.path:
            netloc = parsed_url.path
        elif parsed_url.netloc:
            netloc = parsed_url.netloc
        else:  # pragma: no cover ## Safety
            netloc = data

        if "//" in netloc:
            netloc = netloc[netloc.find("//") + 2 :]

        if "/" in netloc:
            netloc = netloc[: netloc.find("/")]

        return netloc

### `data_to_convert(value)`

Overrides the default behavior.

Raises:

Type | Description
--- | ---
`TypeError` | When the given data to convert is not class:`str`
`ValueError` | When the given data to convert is empty.

Source code in `PyFunceble/converter/url2netloc.py`

    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88

    @ConverterBase.data_to_convert.setter
    def data_to_convert(self, value: Any) -> None:
        """
        Overrides the default behavior.

        :raise TypeError:
            When the given data to convert is not :py:class:`str`
        :raise ValueError:
            When the given data to convert 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.")

        # pylint: disable=no-member
        super(Url2Netloc, self.__class__).data_to_convert.fset(self, value)

### `get_converted()`

Provides the converted data (after conversion)

Source code in `PyFunceble/converter/url2netloc.py`

    114
    115
    116
    117
    118
    119
    120
    121
    122

    def get_converted(self) -> str:
        """
        Provides the converted data (after conversion)
        """

        # Retro-compatibility.
        self.parse_url()

        return self.convert(self.data_to_convert)

### `parse_single_url(data)` `staticmethod`

Parses the URL.

Source code in `PyFunceble/converter/url2netloc.py`

     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103

    @staticmethod
    def parse_single_url(data) -> Optional[urllib.parse.ParseResult]:
        """
        Parses the URL.
        """

        if data:
            if "[" in data and "]" not in data or "]" in data and "[" not in data:
                # Own wrapper around "Invalid IPv6 URL" when
                # http://example.org."] is given (for example.)
                data = data.replace("[", "").replace("]", "")

            return urllib.parse.urlparse(data)
        return None

### `parse_url()`

Parses the URL.

Source code in `PyFunceble/converter/url2netloc.py`

    105
    106
    107
    108
    109
    110
    111
    112

    def parse_url(self) -> "Url2Netloc":
        """
        Parses the URL.
        """

        self.parsed_url = self.parse_single_url(self.data_to_convert)

        return self