paludis

Module paludis

[show private | hide private]

Module paludis

Classes
`Action`	An Action represents an action that can be executed by a PackageID via PackageID::perform_action.
`AdaptedEnvironment`	An Environment that allows you to change aspects of an existing Environment, e.g.
`AllDepSpec`	Represents a ( first second third ) or top level group of dependency specs.
`AnyDepSpec`	Represents a "\|\| ( )" dependency block.
`AssociationMask`	An AssociationMask is a Mask that signifies that a PackageID is masked because of its association with another PackageID that is itself masked.
`BlockDepSpec`	A BlockDepSpec represents a block on a package name (for example, 'app-editors/vim'), possibly with associated version and SLOT restrictions.
`CanFormatBlockDepSpec`	Descendents of this class implement the necessary methods to format a BlockDepSpec.
`CanFormatConditionalDepSpec`	Descendents of this class implement the necessary methods to format a ConditionalDepSpec.
`CanFormatDependencyLabelsDepSpec`	Descendents of this class implement the necessary methods to format a DependencyLabelsDepSpec.
`CanFormatFetchableURIDepSpec`	Descendents of this class implement the necessary methods to format a FetchableURIDepSpec.
`CanFormatIUseFlag`	Descendents of this class implement the necessary methods to format a IUseFlag.
`CanFormatKeywordName`	Descendents of this class implement the necessary methods to format a KeywordName.
`CanFormatLicenseDepSpec`	Descendents of this class implement the necessary methods to format a LicenseDepSpec.
`CanFormatNamedSetDepSpec`	Descendents of this class implement the necessary methods to format a NamedSetDepSpec.
`CanFormatPackageDepSpec`	Descendents of this class implement the necessary methods to format a PackageDepSpec.
`CanFormatPlainTextDepSpec`	Descendents of this class implement the necessary methods to format a PlainTextDepSpec.
`CanFormatSimpleURIDepSpec`	Descendents of this class implement the necessary methods to format a SimpleURIDepSpec.
`CanFormatString`	Descendents of this class implement the necessary methods to format a String.
`CanFormatURILabelsDepSpec`	Descendents of this class implement the necessary methods to format an URILabelsDepSpec.
`CanFormatUseFlagName`	Descendents of this class implement the necessary methods to format a UseFlagName.
`CanSpace`	Descendents of this class implement the necessary methods to format whitespace.
`CategoryNamePart`	Holds a string that is a valid name for the category part of a QualifiedPackageName.
`CategoryNamePartIterable`	Iterable of CategoryNamePart
`CompositeDepSpec`	Iterable class for dependency specs that have a number of child dependency specs.
`ConditionalDepSpec`	Represents a use? ( ) dependency spec.
`ConfigAction`	A ConfigAction is used via PackageID::perform_action to execute post-install configuration (for example, via 'paludis --config') on a PackageID.
`Contents`	Iterable of ContentsEntry.
`ContentsDevEntry`	A dev contents entry.
`ContentsDirEntry`	A directory contents entry.
`ContentsEntry`	Base class for a contents entry.
`ContentsFifoEntry`	A fifo contents entry.
`ContentsFileEntry`	A file contents entry.
`ContentsMiscEntry`	A misc contents entry.
`ContentsSymEntry`	A sym contents entry.
`DependencyABILabel`	A DependencyABILabel specifies that a dependency can be satisfied by a named ABI.
`DependencyABIsLabel`	ABI dependency label base class.
`DependencyAnyLabel`	A DependencyAnyLabel specifies that a dependency can be satisfied by any ABI.
`DependencyBuildLabel`	A DependencyBuildLabel specifies build-time requirements for building a package.
`DependencyCompileLabel`	A DependencyCompileLabel specifies compiled-against requirements for building a package.
`DependencyDepTag`	DepTag subclass for dependencies.
`DependencyHostLabel`	A DependencyHostLabel specifies host requirements for building a package.
`DependencyInstallLabel`	A DependencyInstallLabel specifies install-time requirements for building a package.
`DependencyLabel`	Dependency label base class.
`DependencyLabelsDepSpec`	A DependencyLabelsDepSpec represents a dependency label.
`DependencyMineLabel`	A DependencyMineLabel specifies that a dependency is satisfied by ABIs equal to those being used to create the depending package.
`DependencyPrimaryLabel`	A DependencyPrimaryLabel specifies that a dependency can be satisfied by the primary ABI.
`DependencyRecommendedLabel`	A DependencyRecommendedLabel specifies that a dependency is recommended.
`DependencyRequiredLabel`	* A DependencyRequiredLabel specifies that a dependency is required.
`DependencyRunLabel`	A DependencyRunLabel specifies runtime requirements for building a package.
`DependencySpecTreeFormatter`	A formatter that can handle any formattable type found in a DependencySpecTree.
`DependencySuggestedLabel`	A DependencySuggestLabel specifies that a dependency is suggested.
`DependencySuggestLabel`	Suggest dependency label base class.
`DependencySystemLabel`	System dependency label base class.
`DependencyTargetLabel`	A DependencyTargetLabel specifies target requirements for building a package.
`DependencyTypeLabel`	Type dependency label base class.
`DepList`	Holds a list of dependencies in merge order.
`DepListBlocksOption`	How we handle blocks.
`DepListCircularOption`	How we should handle circular deps.
`DepListDepsOption`	How we should handle a dep class.
`DepListDowngradeOption`	What to do when we downgrade.
`DepListEntry`	An entry in a DepList.
`DepListEntryKind`	Kind of a DepListEntry.
`DepListEntryState`	State of a DepListEntry.
`DepListEntryTags`	Tags attached to a DepListEntry.
`DepListFallBackOption`	When we should fall back to an installed package.
`DepListNewSlotsOption`	When we should pull in a new slot.
`DepListOptions`	Parameters for a DepList.
`DepListReinstallOption`	When we should reinstall.
`DepListReinstallScmOption`	When we should reinstall SCM packages.
`DepListSuggestedOption`	How we should handle suggested deps.
`DepListTargetType`	Type of target being handled at the top level.
`DepListUpgradeOption`	When we should upgrade.
`DepListUseOption`	How we handle use deps.
`DepSpec`	Base class for a dependency spec.
`DepTag`	A DepTag can be associated with a PackageDepSpec, and is transferred onto any associated DepListEntry instances.
`DepTagCategory`	A DepTagCategory is identified by its name and has associated display information for a DepTag's category.
`DepTagCategoryMaker`	Virtual constructor for accessing DepTagCategory instances.
`DestinationsIterable`	Iterable of Repository.
`Environment`	Represents a working environment, which contains an available packages database and provides various methods for querying package visibility and options.
`EnvironmentImplementation`	Represents a working environment, which contains an available packages database and provides various methods for querying package visibility and options.
`EnvironmentMaker`	Virtual constructor for environments.
`FakeRepository`	Fake repository for use in test cases.
`FetchableURIDepSpec`	A FetchableURIDepSpec represents a fetchable URI part.
`FetchableURISpecTreeFormatter`	A formatter that can handle any formattable type found in a FetchableURISpecTree.
`FetchAction`	A FetchAction can be used to fetch source files for a PackageID using PackageID::perform_action.
`FetchActionOptions`	Options for FetchAction.
`FSEntryIterable`	Iterable of FSEntry
`GeneralSetDepTag`	DepTag subclass for general sets.
`GLSADepTag`	DepTag subclass for GLSAs.
`InfoAction`	An InfoAction is used via PackageID::perform_action to execute additional information (for example, via 'paludis --info') on a PackageID.
`InstallAction`	An InstallAction is used by InstallTask to perform a build / install on a PackageID.
`InstallActionChecksOption`	Whether to run post-build checks (for example, 'make check' or 'src_test'), if they are available.
`InstallActionDebugOption`	Debug build mode for an InstallAction.
`InstallActionOptions`	Options for InstallAction.
`InstalledAction`	InstalledAction is a dummy action used by SupportsActionTest and query::SupportsAction to determine whether a PackageID is installed.
`IUseFlag`	Represents an IUse flag.
`IUseFlagFormatter`	A formatter that can handle IUseFlags.
`IUseFlagIterable`	Iterable of IUseFlag
`IUseFlagParseOption`	How to parse an IUSE flag string.
`IUseFlagParseOptions`	Options for IUseFlag.
`KeywordName`	Holds a string that is a valid name for a KEYWORD.
`KeywordNameFormatter`	A formatter that can handle KeywordNames.
`KeywordNameIterable`	Iterable of KeywordName
`LicenseDepSpec`	A LicenseDepSpec represents a license.
`LicenseSpecTreeFormatter`	A formatter that can handle any formattable type found in a LicenseSpecTree.
`Log`	Singleton class that handles log messages.
`LogContext`	Specifies whether a log message has context.
`LogLevel`	Specifies the level of a log message.
`Mask`	A Mask represents one reason why a PackageID is masked (not available to be installed).
`MetadataContentsKey`	A MetadataContentsKey is a MetadataKey that holds a Contents heirarchy.
`MetadataDependencySpecTreeKey`	A MetadataSpecTreeKey is a MetadataKey that holds a spec tree of some kind as its value.
`MetadataFetchableURISpecTreeKey`	A MetadataSpecTreeKey is a MetadataKey that holds a spec tree of some kind as its value.
`MetadataFSEntryIterableKey`	A MetadataCollectionKey is a MetadataKey that holds a Set or Sequence of some kind of item as its value.
`MetadataFSEntryKey`	A MetadataFSEntryKey is a MetadataKey that has an string(FSEntry) as its value.
`MetadataIUseFlagIterableKey`	A MetadataCollectionKey is a MetadataKey that holds a Set or Sequence of some kind of item as its value.
`MetadataKey`	A MetadataKey is a generic key that contains a particular piece of information about a PackageID instance.
`MetadataKeyType`	The significance of a MetadataKey to a user.
`MetadataKeywordNameIterableKey`	A MetadataCollectionKey is a MetadataKey that holds a Set or Sequence of some kind of item as its value.
`MetadataLicenseSpecTreeKey`	A MetadataSpecTreeKey is a MetadataKey that holds a spec tree of some kind as its value.
`MetadataPackageIDIterableKey`	A MetadataCollectionKey is a MetadataKey that holds a Set or Sequence of some kind of item as its value.
`MetadataPackageIDKey`	A MetadataPackageIDKey is a MetadataKey that has a PackageID as its value.
`MetadataProvideSpecTreeKey`	A MetadataSpecTreeKey is a MetadataKey that holds a spec tree of some kind as its value.
`MetadataRepositoryMaskInfoKey`	A MetadataRepositoryMaskInfoKey is a MetadataKey that holds RepositoryMaskInfo as its value.
`MetadataRestrictSpecTreeKey`	A MetadataSpecTreeKey is a MetadataKey that holds a spec tree of some kind as its value.
`MetadataSectionKey`	A MetadataSectionKey holds a number of other MetadataKey instances, and may have a title.
`MetadataSimpleURISpecTreeKey`	A MetadataSpecTreeKey is a MetadataKey that holds a spec tree of some kind as its value.
`MetadataStringIterableKey`	A MetadataCollectionKey is a MetadataKey that holds a Set or Sequence of some kind of item as its value.
`MetadataStringKey`	A MetadataStringKey is a MetadataKey that has a std::string as its value.
`MetadataTimeKey`	A MetadataTimeKey is a MetadataKey that has a int(time_t) as its value.
`MetadataUseFlagNameIterableKey`	A MetadataCollectionKey is a MetadataKey that holds a Set or Sequence of some kind of item as its value.
`NamedSetDepSpec`	A NamedSetDepSpec represents a named package set.
`NoConfigEnvironment`	An environment that uses a single repository, with no user configuration.
`PackageDatabase`	A PackageDatabase can be queried for Package instances.
`PackageDepSpec`	A PackageDepSpec represents a package name (for example, 'app-editors/vim'), possibly with associated version and SLOT restrictions.
`PackageID`
`PackageIDCanonicalForm`	How to generate paludis::PackageID::canonical_form().
`PackageIDIterable`	Iterable of PackageID
`PackageNamePart`	Holds a string that is a valid name for the package part of a QualifiedPackageName.
`PackageNamePartIterable`	Iterable of PackageNamePart
`PaludisEnvironment`	The PaludisEnvironment is an Environment that corresponds to the normal operating evironment.
`PlainTextDepSpec`	A PlainTextDepSpec represents a plain text entry (for example, a RESTRICT keyword).
`PretendAction`	A PretendAction is used by InstallTask to handle install-pretend-phase checks on a PackageID.
`ProvideSpecTreeFormatter`	A formatter that can handle any formattable type found in a ProvideSpecTree.
`PythonFormatter`
`QACheckProperties`	A collection of properties for a QA check.
`QACheckProperty`	Properties of a QA check.
`QAMessage`	NEED_DOC
`QAMessageLevel`	The importance of a QA notice.
`QAReporter`	NEED_DOC
`QualifiedPackageName`	Represents a category plus package name.
`QualifiedPackageNameIterable`	Iterable of QualifiedPackageName
`Query`	Parameter for a PackageDatabase query.
`QueryBase`	Parameter for a PackageDatabase query.
`QueryOrder`	How to order query results.
`Repository`	A Repository provides a representation of a physical repository to a PackageDatabase.
`RepositoryDestinationInterface`	Interface for repositories that can be used as an install destination.
`RepositoryEInterface`	Interface for handling ERepository specific functionality.
`RepositoryEInterfaceProfilesDescLine`	A profiles.desc line in a Repository implementing RepositoryEInterface.
`RepositoryEnvironmentVariableInterface`	Interface for environment variable querying for repositories.
`RepositoryMask`	A RepositoryMask is a Mask that signifies that a PackageID has been marked as masked by a Repository.
`RepositoryMaskInfo`	Information about a RepositoryMask.
`RepositoryMirrorsInterface`	Interface for mirror querying for repositories.
`RepositoryName`	Holds a string that is a valid name for a Repository.
`RepositoryNameIterable`	Iterable of RepositoryName
`RepositoryProvidesInterface`	Interface for repositories that provide packages.
`RepositoryQAInterface`	Interface for handling QA tasks.
`RepositorySetsInterface`	Interface for package sets for repositories.
`RepositorySyncableInterface`	Interface for syncing for repositories.
`RepositoryUseInterface`	Interface for handling USE flags for the Repository class.
`RepositoryVirtualsInterface`	Interface for repositories that define virtuals.
`RestrictSpecTreeFormatter`	A formatter that can handle any formattable type found in a RestrictSpecTree.
`SetName`	Holds a string that is a valid name for a set.
`SetNameIterable`	Iterable of SetName
`SimpleURIDepSpec`	A SimpleURIDepSpec represents a simple URI.
`SimpleURISpecTreeFormatter`	A formatter that can handle any formattable type found in a SimpleURISpecTree.
`SlotName`	Holds a string that is a valid name for a SLOT.
`StringDepSpec`	A StringDepSpec represents a non-composite dep spec with an associated piece of text.
`StringFormatter`	A formatter that can handle Strings.
`StringifyFormatter`	A StringifyFormatter is a Formatter that implements every format function by calling paludis::stringify().
`StringIterable`	Iterable of string
`StringSetIterable`	Iterable of string
`SupportsActionTestBase`	Base class for SupportsActionTests.
`SupportsConfigActionTest`	SupportsActionTest is used by PackageID::supports_action and Repository::some_ids_might_support_action to query whether a particular action is supported by that PackageID or potentially supported by some IDs in that Repository.
`SupportsFetchActionTest`	SupportsActionTest is used by PackageID::supports_action and Repository::some_ids_might_support_action to query whether a particular action is supported by that PackageID or potentially supported by some IDs in that Repository.
`SupportsInfoActionTest`	SupportsActionTest is used by PackageID::supports_action and Repository::some_ids_might_support_action to query whether a particular action is supported by that PackageID or potentially supported by some IDs in that Repository.
`SupportsInstallActionTest`	SupportsActionTest is used by PackageID::supports_action and Repository::some_ids_might_support_action to query whether a particular action is supported by that PackageID or potentially supported by some IDs in that Repository.
`SupportsInstalledActionTest`	SupportsActionTest is used by PackageID::supports_action and Repository::some_ids_might_support_action to query whether a particular action is supported by that PackageID or potentially supported by some IDs in that Repository.
`SupportsPretendActionTest`	SupportsActionTest is used by PackageID::supports_action and Repository::some_ids_might_support_action to query whether a particular action is supported by that PackageID or potentially supported by some IDs in that Repository.
`SupportsUninstallActionTest`	SupportsActionTest is used by PackageID::supports_action and Repository::some_ids_might_support_action to query whether a particular action is supported by that PackageID or potentially supported by some IDs in that Repository.
`TargetDepTag`	DepTag subclass for explicit targets.
`TestEnvironment`	A TestEnvironment is an environment used during testing that lets us control all the options rather than reading them from configuration files.
`UnacceptedMask`	An UnacceptedMask is a Mask that signifies that a particular value or combination of values in (for example) a MetadataSetKey or MetadataSpecTreeKey is not accepted by user configuration.
`UninstallAction`	An UninstallAction is used by UninstallTask to uninstall a PackageID.
`UninstallActionOptions`	Options for UninstallAction.
`UnsupportedMask`	An UnsupportedMask is a Mask that signifies that a PackageID is not supported, for example because it is broken or because it uses an unrecognised EAPI.
`URILabel`	URI label base class.
`URILabelsDepSpec`	A URILabelsDepSpec represents a URI label.
`URIListedOnlyLabel`	A concrete URI label class.
`URIListedThenMirrorsLabel`	A concrete URI label class.
`URILocalMirrorsOnlyLabel`	A concrete URI label class.
`URIManualOnlyLabel`	A concrete URI label class.
`URIMirrorsOnlyLabel`	A concrete URI label class.
`URIMirrorsThenListedLabel`	A concrete URI label class.
`UseFlagName`	Holds a string that is a valid name for a USE flag.
`UseFlagNameFormatter`	A formatter that can handle UseFlagNames.
`UseFlagNameIterable`	Iterable of UseFlagName
`UseFlagState`	A USE flag can be on, off or unspecified.
`UserMask`	A UserMask is a Mask due to user configuration.
`UserPackageDepSpecOption`	Options for parse_user_package_dep_spec.
`UserPackageDepSpecOptions`	Options for parse_user_package_dep_spec.
`VersionOperator`	An operator attached to a VersionSpec, validated.
`VersionOperatorValue`	Represents an operator attached to a VersionSpec.
`VersionRequirement`
`VersionRequirements`	Iterable collection of VersionRequirement instances, usually for a PackageDepSpec.
`VersionRequirementsMode`	Whether our version requirements are an 'and' or an 'or' set.
`VersionSpec`	A VersionSpec represents a version number (for example, 1.2.3b-r1).

Exceptions
`ActionError`	Parent class for action errors.
`AdditionalRequirementsNotMetError`	Thrown if all versions of a particular spec are masked, but would not be if additional requirements were not in effect.
`AllMaskedError`	Thrown if all versions of a particular spec are masked.
`AmbiguousPackageNameError`	Thrown if a PackageDatabase query results in more than one matching Package.
`BadVersionOperatorError`	Thrown if a bad version operator is encountered.
`BadVersionSpecError`	Thrown if a VersionSpec is created from an invalid version string.
`BaseException`	Base exception class.
`BlockError`	Thrown if a block is encountered.
`CategoryNamePartError`	Thrown if an invalid value is assigned to a CategoryNamePart.
`CircularDependencyError`	Thrown if a circular dependency is encountered.
`ConfigActionError`	Thrown if a configure fails.
`ConfigurationError`	A ConfigurationError is thrown when an invalid configuration occurs.
`DepListError`	Thrown if an error occurs whilst building a DepList.
`DowngradeNotAllowedError`	Thrown if a downgrade is forced and we're not allowed to downgrade.
`DuplicateRepositoryError`	Thrown if a Repository with the same name as an existing member is added to a PackageDatabase.
`FetchActionError`	Thrown if a fetch fails.
`FSError`	Generic filesystem error class.
`InstallActionError`	Thrown if an install fails.
`InternalError`	An InternalError is an Exception that is thrown if something that is never supposed to happen happens.
`IUseFlagNameError`	Thrown if an invalid value is assigned to a IUseFlagName.
`KeywordNameError`	Thrown if an invalid value is assigned to a KeywordName.
`NameError`	A NameError is an Exception that is thrown when some kind of invalid name is encountered.
`NoDestinationError`	Thrown if no destination can be found.
`NoSuchDepTagCategory`	Thrown if DepTagCategoryMaker cannot find the named DepTagCategory.
`NoSuchEnvironmentTypeError`	Thrown if an environment of the specified type does not exist.
`NoSuchPackageError`	Thrown if there is no Package in a PackageDatabase with the given name.
`NoSuchRepositoryError`	Thrown if there is no Repository in a RepositoryDatabase with the given name.
`NotAllowedInThisHeirarchy`	Thrown if a spec part not suitable for a particular heirarchy is present.
`NotAvailableError`	A NotAvailableError is an Exception that is thrown if something that is not available (for example due to compile time configure options or platform limitations) is used.
`PackageDatabaseError`	A PackageDatabaseError is an error that occurs when performing some operation upon a PackageDatabase.
`PackageDatabaseLookupError`	A PackageDatabaseLookupError descendent is thrown if an error occurs when looking for something in a PackageDatabase.
`PackageDepSpecError`	Thrown if an invalid package dep spec specification is encountered.
`PackageNamePartError`	Thrown if an invalid value is assigned to a PackageNamePart.
`PaludisConfigError`	Thrown if a configuration error is encountered by PaludisConfig.
`PaludisConfigNoDirectoryError`	Thrown if the config directory cannot be found by PaludisConfig.
`PaludisEnvironmentSoDirCannotDlopenError`	Thrown if a repository .so cannot be used.
`PaludisEnvironmentSoDirNotADirectoryError`	Thrown if PALUDIS_ENVIRONMENT_SO_DIR is not a directory.
`PythonContainerConversionError`	Thrown if an error occurs during container conversion from python.
`PythonError`	Base exception class for Python specific stuff.
`PythonMethodNotImplemented`	Thrown if a not implemented virtual function was called from C++.
`QualifiedPackageNameError`	May be thrown if an invalid name is assigned to a QualifiedPackageName (alternatively, the exception raised may be a PackageNamePartError or a CategoryNamePartError).
`RepositoryNameError`	Thrown if an invalid value is assigned to a RepositoryName.
`SetNameError`	Thrown if an invalid value is assigned to a SetName.
`SlotNameError`	Thrown if an invalid value is assigned to a SlotName.
`UninstallActionError`	Thrown if an uninstall fails.
`UnsupportedActionError`	Thrown if a PackageID is asked to perform an Action that it does not support.
`UseFlagNameError`	Thrown if an invalid value is assigned to a UseFlagName.

Variable Summary
`function`	`parse_user_package_dep_spec` = `<Boost.Python.function obj...`
`str`	`SUBVERSION_REVISION` = `'4694'`
`str`	`VERSION` = `'0.26.2'`
`int`	`VERSION_MAJOR` = 0
`int`	`VERSION_MICRO` = 2
`int`	`VERSION_MINOR` = 26
`str`	`VERSION_SUFFIX` = `''`

Variable Details

parse_user_package_dep_spec

Type:: function
Value:: <Boost.Python.function object at 0x128c6e0>

SUBVERSION_REVISION

Type:: str
Value:: '4694'

VERSION

Type:: str
Value:: '0.26.2'

VERSION_MAJOR

Type:: int
Value:: 0

VERSION_MICRO

Type:: int
Value:: 2

VERSION_MINOR

Type:: int
Value:: 26

VERSION_SUFFIX

Type:: str
Value:: ''

Generated by Epydoc 2.1 on Thu May 29 15:53:48 2008

http://epydoc.sf.net