hyperx.api.PackageManager Class Reference

Public Member Functions
	__init__ (self, _api.PackageManager packageManager)
types.SimpleStatus	AddPathSource (self, str path, str name)
	Add a file system source by path and name.
types.SimpleStatus	Demote (self, Package package)
	Update package from a standalone package to a dependency package.
types.SimpleStatus	Install (self, item1=None)
types.SimpleStatus	Install (self, Package package)
	Install the latest version of package.
types.SimpleStatus	Install (self, PackageVersion packageVersion)
	Install a particular packageVersion.
types.SimpleStatus	Install (self, tuple[Package] packages)
	Install the latest versions of a collection of packages.
types.SimpleStatus	Install (self, tuple[PackageVersion] packageVersions)
	Install particular versions of a collection of packageVersions.
types.SimpleStatus	Pin (self, Package package)
	Prevent package from automatically updating to the latest version.
types.SimpleStatus	Promote (self, Package package)
	Promote package to be standalone.
types.SimpleStatus	Remove (self, Package package, bool force)
	Uninstall package.
types.SimpleStatus	RemoveSource (self, PackageFileSystemSource source)
	Remove a file system source.
types.SimpleStatus	Unpin (self, Package package)
	Allow package to automatically update to the latest version.

Protected Attributes
	_Entity = packageManager

Properties
	CachePath = property
	Full path of the package cache directory.
	Installed = property
	All installed packages.
	PackageFileSystemSources = property
	Packages = property
	All available packages.

Constructor & Destructor Documentation

__init__()

hyperx.api.PackageManager.__init__	(		self,
		_api.PackageManager	packageManager )

Member Function Documentation

AddPathSource()

types.SimpleStatus hyperx.api.PackageManager.AddPathSource	(		self,
		str	path,
		str	name )

Add a file system source by path and name.

Demote()

types.SimpleStatus hyperx.api.PackageManager.Demote	(		self,
		Package	package )

Update package from a standalone package to a dependency package.

Install() [1/5]

types.SimpleStatus hyperx.api.PackageManager.Install	(		self,
			item1 = None )

Install the latest version of package.

Install a particular packageVersion.

Install the latest versions of a collection of packages.

Install particular versions of a collection of packageVersions.

Install() [2/5]

types.SimpleStatus hyperx.api.PackageManager.Install	(		self,
		Package	package )

Install the latest version of package.

Install() [3/5]

types.SimpleStatus hyperx.api.PackageManager.Install	(		self,
		PackageVersion	packageVersion )

Install a particular packageVersion.

Install() [4/5]

types.SimpleStatus hyperx.api.PackageManager.Install	(		self,
		tuple[Package]	packages )

Install the latest versions of a collection of packages.

Install() [5/5]

types.SimpleStatus hyperx.api.PackageManager.Install	(		self,
		tuple[PackageVersion]	packageVersions )

Install particular versions of a collection of packageVersions.

Pin()

types.SimpleStatus hyperx.api.PackageManager.Pin	(		self,
		Package	package )

Prevent package from automatically updating to the latest version.

Promote()

types.SimpleStatus hyperx.api.PackageManager.Promote	(		self,
		Package	package )

Promote package to be standalone.

Remove()

types.SimpleStatus hyperx.api.PackageManager.Remove	(		self,
		Package	package,
		bool	force )

Uninstall package.

Parameters

force

If true, entities associated with the package will be removed. If false, removal will fail if any entities are associated with the package.

RemoveSource()

types.SimpleStatus hyperx.api.PackageManager.RemoveSource	(		self,
		PackageFileSystemSource	source )

Remove a file system source.

Unpin()

types.SimpleStatus hyperx.api.PackageManager.Unpin	(		self,
		Package	package )

Allow package to automatically update to the latest version.

Member Data Documentation

_Entity

hyperx.api.PackageManager._Entity = packageManager

protected

Property Documentation

CachePath

hyperx.api.PackageManager.CachePath = property

static

Full path of the package cache directory.

Installed

hyperx.api.PackageManager.Installed = property

static

All installed packages.

PackageFileSystemSources

hyperx.api.PackageManager.PackageFileSystemSources = property

static

Packages

hyperx.api.PackageManager.Packages = property

static

All available packages.

---

The documentation for this class was generated from the following file:

• C:/Dev/HyperX/HyperX/HyperX.Scripting.Wrapper/hyperx/api/__init__.py