# Copyright (c) 2022, Moritz E. Beber
#
# 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.


"""Provide a platform description."""


from __future__ import annotations

import platform
from typing import NamedTuple


class Platform(NamedTuple):
    """
    Define a platform description.

    Attributes:
        name: The platform name, typically one of Linux, Darwin, or Windows.
        version: The platform's full release string and machine architecture.

    """

    name: str
    version: str

    @classmethod
    def create(cls) -> Platform:
        """Return a platform instance generated from the current environment."""
        return cls(
            name=platform.system(), version=f"{platform.release()}-{platform.machine()}"
        )