Skip to content

# Internal url

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

::

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

Provides a way to convert our internal 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.

## `InternalUrlConverter`

Bases: `ConverterBase`

Converter of the internal URLs.

.. note:: The internal URLs are actually the URL that has nothing to do with what we are going to test.

    They are only relevant for the software itself.

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

     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

    class InternalUrlConverter(ConverterBase):
        """
        Converter of the internal URLs.

        .. note::
            The internal URLs are actually the URL that has nothing to
            do with what we are going to test.

            They are only relevant for the software itself.
        """

        @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`
            """
            if not isinstance(value, str):
                raise TypeError(f"<value> should be {str}, {type(value)} given.")

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

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

            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

            if VersionUtility(PyFunceble.storage.PROJECT_VERSION).is_dev():
                return data.replace("master", "dev")
            return data.replace("dev", "master")

### `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/internal_url.py`

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

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

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

        _ = aggressive

        if VersionUtility(PyFunceble.storage.PROJECT_VERSION).is_dev():
            return data.replace("master", "dev")
        return data.replace("dev", "master")

### `data_to_convert(value)`

Overrides the default behavior.

Raises:

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

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

    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83

    @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`
        """
        if not isinstance(value, str):
            raise TypeError(f"<value> should be {str}, {type(value)} given.")

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

### `get_converted()`

Provides the converted data (after conversion)

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

    85
    86
    87
    88
    89
    90

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

        return self.convert(self.data_to_convert)