Module paludis :: Class MetadataKey
[hide private]

Class MetadataKey

 object --+    
          |    
??.instance --+
              |
             MetadataKey
Known Subclasses:

A MetadataKey is a generic key that contains a particular piece of
information about a PackageID instance.

A basic MetadataKey has:

- A raw name. This is in a repository-defined format designed to closely
  represent the internal name. For example, ebuilds and VDB IDs use
  raw names like 'DESCRIPTION' and 'KEYWORDS', whereas CRAN uses names
  like 'Title' and 'BundleDescription'. The raw name is unique in a
  PackageID.

- A human name. This is the name that should be used when outputting
  normally for a human to read.

- A MetadataKeyType. This is a hint to clients as to whether the key
  should be displayed when outputting information about a package ID.

Subclasses provide additional information, including the 'value' of the
key.

Instance Methods [hide private]
 
__init__(...)
Raises an exception This class cannot be instantiated from Python
 
__reduce__(...)
helper for pickle
string
human_name()
Fetch our human name.
string
raw_name()
Fetch our raw name.
MetadataKeyType
type()
Fetch our key type.

Inherited from unreachable.instance: __new__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(...)
(Constructor)

 

Raises an exception This class cannot be instantiated from Python

Overrides: object.__init__

__reduce__(...)

 

helper for pickle

Overrides: object.__reduce__
(inherited documentation)

human_name()

 

Fetch our human name.

human_name() -> string Fetch our human name.

Returns: string

raw_name()

 

Fetch our raw name.

raw_name() -> string Fetch our raw name.

Returns: string

type()

 

Fetch our key type.

type() -> MetadataKeyType Fetch our key type.

Returns: MetadataKeyType