Extra PlatformsΒΆ
What is Extra Platforms?ΒΆ
Provides a list of all known platforms
Detect the current platform, at the distribution level
Gather current platform metadata (version, codename, etc.)
Group platforms into families
Manage collection of platforms and groups
Associate each platform and group to an emoji symbol
New conditional markers for
pytest
:@skip_linux
,@skip_macos
and@skip_windows
@unless_linux
,@unless_macos
and@unless_windows
ExamplesΒΆ
Get the current platform ID and name:
>>> from extra_platforms import CURRENT_OS_ID, CURRENT_OS_LABEL
>>> CURRENT_OS_ID
'macos'
>>> CURRENT_OS_LABEL
'macOS'
Get the current platform object, from which you can access lots of metadata:
>>> from extra_platforms import current_os
>>> my_os = current_os()
>>> my_os
Platform(id='macos', name='macOS', current=True)
>>> my_os.id
'macos'
>>> my_os.name
'macOS'
>>> my_os.icon
'π'
>>> my_os.info()
{
"id": "macos",
"name": "macOS",
"icon": "π",
"current": True,
"distro_id": "darwin",
"version": "23.6.0",
"version_parts": {"major": "23", "minor": "6", "build_number": "0"},
"like": None,
"codename": None,
}
Check if a platform is a specific system:
>>> from extra_platforms import is_gentoo
>>> is_gentoo()
False
Use groups to check if the current platform is part of a specific family:
>>> from extra_platforms import UNIX, current_os
>>> current_os() in UNIX
False
Or directly use the boolean variables available for each family:
>>> from extra_platforms import is_unix
>>> is_unix
False
List all platforms of a family:
>>> from extra_platforms import LINUX
>>> LINUX
Group(id='linux', name='Any Linux', platform_ids=frozenset({'ibm_powerkvm', 'rocky', 'debian', 'ubuntu', 'mageia', 'xenserver', 'opensuse', 'buildroot', 'rhel', 'parallels', 'pidora', 'sles', 'amzn', 'scientific', 'linuxmint', 'centos', 'android', 'gentoo', 'raspbian', 'unknown_linux', 'mandriva', 'exherbo', 'cloudlinux', 'fedora', 'guix', 'arch', 'altlinux', 'slackware', 'oracle', 'kvmibm'}))
>>> print("\n".join([p.name for p in LINUX]))
ALT Linux
Amazon Linux
Android
Arch Linux
Buildroot
CentOS
CloudLinux OS
Debian
Exherbo Linux
Fedora
Gentoo Linux
Guix System
IBM PowerKVM
KVM for IBM z Systems
Linux Mint
Mageia
Mandriva Linux
openSUSE
Oracle Linux
Parallels
Pidora
Raspbian
RedHat Enterprise Linux
Rocky Linux
Scientific Linux
Slackware
SUSE Linux Enterprise Server
Ubuntu
Unknown Linux
XenServer
Reduce a disparate collection of groups and platforms into a minimal descriptive set, by grouping all platforms into families:
>>> from extra_platforms import AIX, MACOS, SOLARIS, reduce
>>> reduce([AIX, MACOS])
{
Platform(id='aix', name='IBM AIX', current=False),
Platform(id='macos', name='macOS', current=True),
}
>>> reduce([AIX, MACOS, SOLARIS])
{
Group(id='system_v', name='Any Unix derived from AT&T System Five', platform_ids=frozenset({'aix', 'solaris'})),
Platform(id='macos', name='macOS', current=True),
}
Group β platforms mappingΒΆ
Relationships between groups and platforms:
OS familiesΒΆ
Each platform is assigned to a group of non-overlpaping families:
extra_platforms.NON_OVERLAPPING_GROUPS
- Non-overlapping groups.ΒΆ
Other groupsΒΆ
Other groups are available for convenience, but these overlaps:
extra_platforms.EXTRA_GROUPS
- Overlapping groups, defined for convenience.ΒΆ
[!IMPORTANT] All the graphs above would be better off if merged. Unfortunately Graphviz is not capable of producing Euler diagrams. Only non-overlapping clusters can be rendered.
Thereβs still a chance to have them supported by Mermaid so we can switch to that if the feature materialize.
Used inΒΆ
Check these projects to get real-life examples of extra-platforms
usage:
Meta Package Manager - A unifying CLI for multiple package managers.
Click Extra - Drop-in replacement for Click to make user-friendly and colorful CLI.
Feel free to send a PR to add your project in this list if you are relying on Click Extra in any way.
DevelopmentΒΆ
Development guidelines are the same as parent project Click Extra, from which extra-platforms
originated.