Skip to content

# Sort

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

::

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

Provides some utilities related to the sorting mechanism.

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 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.

## `get_best_sorting_key()`

Provides the best sorting key from the configuration.

Source code in `PyFunceble/cli/utils/sort.py`

    114
    115
    116
    117
    118
    119
    120
    121
    122

    def get_best_sorting_key() -> Callable[[Any], List[Union[int, Any]]]:
        """
        Provides the best sorting key from the configuration.
        """

        if PyFunceble.facility.ConfigLoader.is_already_loaded():
            if PyFunceble.storage.CONFIGURATION.cli_testing.sorting_mode.hierarchical:
                return hierarchical
        return standard

## `hierarchical(element)`

Provides the key to use for the hierarchical sorting.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`element` | `Any` | The element to format. | required

Source code in `PyFunceble/cli/utils/sort.py`

     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111

    def hierarchical(element: Any) -> List[Union[int, Any]]:
        """
        Provides the key to use for the hierarchical sorting.

        :param element:
            The element to format.
        """

        element = element.strip()

        if not element:
            return []

        element = Url2Netloc(element).get_converted().strip()

        if PyFunceble.facility.ConfigLoader.is_already_loaded():
            element = RegexHelper(
                r"^%s\s+" % PyFunceble.storage.CONFIGURATION.cli_testing.hosts_ip
            ).replace_match(element, "")

        return standard(".".join(reversed(element.split("."))))

## `standard(element)`

Provides the key to use for the standard sorting.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`element` | `Any` | The element to format. | required

Source code in `PyFunceble/cli/utils/sort.py`

    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

    def standard(element: Any) -> List[Union[int, Any]]:
        """
        Provides the key to use for the standard sorting.

        :param element:
            The element to format.
        """

        element = element.strip()

        if not element:
            return []

        regex_helper = RegexHelper()

        element = Url2Netloc(element).get_converted().strip()

        if PyFunceble.facility.ConfigLoader.is_already_loaded():
            element = regex_helper.set_regex(
                r"^%s\s+" % PyFunceble.storage.CONFIGURATION.cli_testing.hosts_ip
            ).replace_match(element, "")

        cleaned = regex_helper.set_regex(r"[^a-zA-Z0-9\.]").replace_match(element, "")

        return [
            int(x) if x.isdigit() else x
            for x in regex_helper.set_regex(r"(\d+)").split(cleaned)
        ]