paludis.MetadataKey

Module paludis :: Class MetadataKey

[show private | hide private]

Type MetadataKey

object --+    
         |    
  instance --+
             |
            MetadataKey

Known Subclasses:: MetadataContentsKey, MetadataDependencySpecTreeKey, MetadataFetchableURISpecTreeKey, MetadataFSEntryIterableKey, MetadataFSEntryKey, MetadataIUseFlagIterableKey, MetadataKeywordNameIterableKey, MetadataLicenseSpecTreeKey, MetadataPackageIDIterableKey, MetadataPackageIDKey, MetadataProvideSpecTreeKey, MetadataRepositoryMaskInfoKey, MetadataRestrictSpecTreeKey, MetadataSectionKey, MetadataSimpleURISpecTreeKey, MetadataStringIterableKey, MetadataStringKey, MetadataTimeKey, MetadataUseFlagNameIterableKey

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.

Method Summary
	`__init__(...)` Raises an exception This class cannot be instantiated from Python
	`__reduce__(...)`
string	`human_name()` Fetch our human name.
string	`raw_name()` Fetch our raw name.
MetadataKeyType	`type()` Fetch our key type.
Inherited from instance
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__reduce_ex__(...)` helper for pickle
	`__repr__(x)` x.__repr__() <==> repr(x)
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value
	`__str__(x)` x.__str__() <==> str(x)

Method Details

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

Generated by Epydoc 2.1 on Mon Aug 4 19:40:18 2008

http://epydoc.sf.net