8.34. platformids.custom.parrot

Module ParrotLinux [doc].

8.34.1. Module

Example for a dynamic added custom platform.

Here Parrot Linux, which actually has a default release version layout, and though could be handled by the default handler.

8.34.2. Data

8.34.2.1. RTE_PARROT

Registration of the dist value:

RTE_PARROT        = RTE_LINUX   + custom_dist.add_enum()

8.34.2.2. rte2num

Mapping of the rte string and numeric representation to the numeric value.

8.34.2.3. num2rte

Mapping of the rte numeric representation to the string value.

8.34.2.4. num2pretty

Mapping of the rte numeric representation to the pretty string value.

8.34.2.5. custom_rte_distrel2tuple

Registered callbacks for special handling of custom layout.

custom_rte_distrel2tuple.update(
    {
        RTE_PARROT: my_distrel2tuple,  #: the callback to be registered
    }
)

8.34.3. Functions

8.34.3.1. my_distrel2tuple

platformids.custom.parrot.my_distrel2tuple(rte=276917248)[source]

A custom example only - standard encoding is default layout.

Convert the Parrot specific distrel version layout to a tuple.

A callback to be used by the function:

platformids.decode_rte_distrel_to_segments(rte=RTE)

Decodes the compressed distrel from the 32bit integer bitmask rte into the corresponding tuple of integer segments.

Parameters

rte –

The comppressed runtime environment identifier bitmask.

default := RTE

Returns

Tuple of Integer values of the encoded segments, either as defined by the default layout, or any known as defined by additional extended and/or custom criteria.

Raises

pass-through –

Examples

decode_rte_distrel_to_segments()
=>  (4, 1, 0)     # on Parrot-4.1
=>  (4, 5, 1)     # on Parrot-4.5.1

8.34.4. Source

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
# -*- coding: utf-8 -*-
"""Example for a dynamic added custom platform.

Here *Parrot* Linux, which actually has a default 
release version layout, and though could be handled 
by the default handler.

"""
from __future__ import absolute_import

from platformids import RTE, rte2num, num2rte, num2pretty, custom_rte_distrel2tuple, custom_dist, \
    PlatformIDsUnknownError, \
    RTE_LINUX, RTE_OSTYPE, RTE_DIST


__author__ = 'Arno-Can Uestuensoez'
__license__ = "Artistic-License-2.0 + Forced-Fairplay-Constraints"
__copyright__ = "Copyright (C) 2019 Arno-Can Uestuensoez" \
                " @Ingenieurbuero Arno-Can Uestuensoez"
__version__ = '0.0.1'
__uuid__ = "7add5ded-c39b-4b6e-8c87-1b3a1c150ee9"

RTE_PARROT        = RTE_LINUX   + custom_dist.add_enum()     #: Parrot

    
#: mapping of the rte string and numeric representation to the numeric value
rte2num.update(
    {
        'parrot':        RTE_PARROT,
        RTE_PARROT:      RTE_PARROT,
    }
)


#: mapping of the rte numeric representation to the string value
num2rte.update(
    {
        RTE_PARROT:          'parrot',
    }
)

#: mapping of the rte numeric representation to the string value
num2pretty.update(
    {
        RTE_PARROT:          'Parrot',
    }
)


#-----------------------------------------------#
#                                               #
# optional constants for convenience            #
#                                               #
#-----------------------------------------------#


RTE_PARROT451     = RTE_PARROT  + 0x000010a1                              #: Parrot-4.5.1

    
#: mapping of the rte string and numeric representation to the numeric value
rte2num.update(
    {
        'parrot451':     RTE_PARROT451,
        RTE_PARROT451:   RTE_PARROT451,
    }
)


#: mapping of the rte numeric representation to the string value
num2rte.update(
    {
        RTE_PARROT451:       'parrot451',
    }
)

#: mapping of the rte numeric representation to the string value
num2pretty.update(
    {
        RTE_PARROT451:       'Parrot-4.5.1',
    }
)

def my_distrel2tuple(rte=RTE):
    """
    A custom example only - standard encoding is default layout.

    Convert the *Parrot* specific *distrel* version layout
    to a tuple.
    
    A callback to be used by the function:
    
       platformids.decode_rte_distrel_to_segments(rte=RTE)
    
    Decodes the compressed *distrel* from the 32bit integer
    bitmask *rte* into the corresponding tuple of integer
    segments.

    Args:
       rte:
           The comppressed runtime environment identifier bitmask.
            
           default := RTE

    Returns:
       Tuple of Integer values of the encoded segments, either
       as defined by the default layout, or any known as defined
       by additional extended and/or custom criteria.
    
    Raises:
       pass-through

    Examples:
      ::

        decode_rte_distrel_to_segments()     
        =>  (4, 1, 0)     # on Parrot-4.1
        =>  (4, 5, 1)     # on Parrot-4.5.1

    """
    if rte & RTE_OSTYPE != RTE_LINUX:
        raise PlatformIDsUnknownError("Not Linux:  rte = " + str(rte))
        
    if rte & RTE_DIST != RTE_PARROT:
        raise PlatformIDsUnknownError("Not Parrot: rte = " + str(rte))
    
    try:
        _rte = rte2num[rte]
    except KeyError:
        # non-registered release
        
        if type(_rte) is int:
            # can split basically any number, let's see...
            _rte = rte

        else:
            raise PlatformIDsUnknownError("Unknown Parrot release rte = " + str(rte))

    # here same as the default handler
    return (
        (_rte & 0xfc00) >> 10, 
        (_rte & 0x03e0) >> 5, 
        _rte & 0x001f, 
        )


#: registered callbacks for special handling of custom layout
custom_rte_distrel2tuple.update(
    {
        # e.g. RTE_PARROT: parrot.platformids.my_distrel2tuple,
        
        RTE_PARROT: my_distrel2tuple,  #: the callback to be registered
    }
)

8.34.5. Download

custom parrot.py