Skip to content

# Platform

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

::

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

Provides a simple way to get the current platform.

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.

## `PlatformUtility`

Provides an easy way to get the current platform.

Source code in `PyFunceble/utils/platform.py`

     56
     57
     58
     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

    class PlatformUtility:
        """
        Provides an easy way to get the current platform.
        """

        WINDOWS: list = ["windows"]
        """
        Provides the list of supported windows platform.
        """

        CYGWIN: list = ["cygwin", "cygwin_nt-10.0"]
        """
        Provides the list of supporter cygwin platform.
        """

        UNIX: list = ["linux", "darwin"]
        """
        Provides the list of supported unix platform.
        """

        MAC: list = ["darwin"]
        """
        Provides the list of supported MAC platform.
        """

        @staticmethod
        def get() -> str:
            """
            Returns the current platform.
            """

            return platform.system().lower()

        @classmethod
        def is_cygwin(cls) -> bool:
            """
            Checks if the current platform is in our cygwin list.
            """

            current_platform = cls.get()

            return any(x in current_platform for x in cls.CYGWIN)

        @classmethod
        def is_windows(cls) -> bool:
            """
            Checks if the current platform is in our windows list.
            """

            return cls.get() in cls.WINDOWS or cls.is_cygwin()

        @classmethod
        def is_unix(cls) -> bool:
            """
            Checks if the current platform is in our unix list.
            """

            return cls.get() in cls.UNIX

        @classmethod
        def is_mac_os(cls) -> bool:
            """
            Checks if the current platform is in our OSX list.
            """

            return cls.get() in cls.MAC

### `CYGWIN = ['cygwin', 'cygwin_nt-10.0']` `class-attribute` `instance-attribute`

Provides the list of supporter cygwin platform.

### `MAC = ['darwin']` `class-attribute` `instance-attribute`

Provides the list of supported MAC platform.

### `UNIX = ['linux', 'darwin']` `class-attribute` `instance-attribute`

Provides the list of supported unix platform.

### `WINDOWS = ['windows']` `class-attribute` `instance-attribute`

Provides the list of supported windows platform.

### `get()` `staticmethod`

Returns the current platform.

Source code in `PyFunceble/utils/platform.py`

    81
    82
    83
    84
    85
    86
    87

    @staticmethod
    def get() -> str:
        """
        Returns the current platform.
        """

        return platform.system().lower()

### `is_cygwin()` `classmethod`

Checks if the current platform is in our cygwin list.

Source code in `PyFunceble/utils/platform.py`

    89
    90
    91
    92
    93
    94
    95
    96
    97

    @classmethod
    def is_cygwin(cls) -> bool:
        """
        Checks if the current platform is in our cygwin list.
        """

        current_platform = cls.get()

        return any(x in current_platform for x in cls.CYGWIN)

### `is_mac_os()` `classmethod`

Checks if the current platform is in our OSX list.

Source code in `PyFunceble/utils/platform.py`

    115
    116
    117
    118
    119
    120
    121

    @classmethod
    def is_mac_os(cls) -> bool:
        """
        Checks if the current platform is in our OSX list.
        """

        return cls.get() in cls.MAC

### `is_unix()` `classmethod`

Checks if the current platform is in our unix list.

Source code in `PyFunceble/utils/platform.py`

    107
    108
    109
    110
    111
    112
    113

    @classmethod
    def is_unix(cls) -> bool:
        """
        Checks if the current platform is in our unix list.
        """

        return cls.get() in cls.UNIX

### `is_windows()` `classmethod`

Checks if the current platform is in our windows list.

Source code in `PyFunceble/utils/platform.py`

     99
    100
    101
    102
    103
    104
    105

    @classmethod
    def is_windows(cls) -> bool:
        """
        Checks if the current platform is in our windows list.
        """

        return cls.get() in cls.WINDOWS or cls.is_cygwin()