Source code for PyFunceble.utils.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://pyfunceble.readthedocs.io/en/dev/

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

License:
::


    Copyright 2017, 2018, 2019, 2020, 2022 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

        http://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.
"""

import platform


[docs]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. """
[docs] @staticmethod def get() -> str: """ Returns the current platform. """ return platform.system().lower()
[docs] @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)
[docs] @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()
[docs] @classmethod def is_unix(cls) -> bool: """ Checks if the current platform is in our unix list. """ return cls.get() in cls.UNIX
[docs] @classmethod def is_mac_os(cls) -> bool: """ Checks if the current platform is in our OSX list. """ return cls.get() in cls.MAC