Skip to content

PackageDependency

Source code in docs_src/capo_codeartifact/types/package_dependency.py 
13
14
15
16
17
18
19
20
21
class PackageDependency(TypedDict, closed=True):
    namespace: NotRequired["capo_codeartifact.types.package_namespace.PackageNamespace"]
    """<p>The namespace of the package that this package depends on. The package component that specifies its namespace depends on its type. For example:</p> <ul> <li> <p> The namespace of a Maven package version is its <code>groupId</code>. </p> </li> <li> <p> The namespace of an npm or Swift package version is its <code>scope</code>. </p> </li> <li> <p>The namespace of a generic package is its <code>namespace</code>.</p> </li> <li> <p> Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace. </p> </li> </ul>"""
    package: NotRequired["capo_codeartifact.types.package_name.PackageName"]
    """<p> The name of the package that this package depends on. </p>"""
    dependency_type: NotRequired["capo_codeartifact.types.string.String"]
    """<p> The type of a package dependency. The possible values depend on the package type.</p> <ul> <li> <p>npm: <code>regular</code>, <code>dev</code>, <code>peer</code>, <code>optional</code> </p> </li> <li> <p>maven: <code>optional</code>, <code>parent</code>, <code>compile</code>, <code>runtime</code>, <code>test</code>, <code>system</code>, <code>provided</code>.</p> <note> <p>Note that <code>parent</code> is not a regular Maven dependency type; instead this is extracted from the <code><parent></code> element if one is defined in the package version's POM file.</p> </note> </li> <li> <p>nuget: The <code>dependencyType</code> field is never set for NuGet packages.</p> </li> <li> <p>pypi: <code>Requires-Dist</code> </p> </li> </ul>"""
    version_requirement: NotRequired["capo_codeartifact.types.string.String"]
    """<p> The required version, or version range, of the package that this package depends on. The version format is specific to the package type. For example, the following are possible valid required versions: <code>1.2.3</code>, <code>^2.3.4</code>, or <code>4.x</code>. </p>"""

dependency_type instance-attribute 

dependency_type: NotRequired[String]

The type of a package dependency. The possible values depend on the package type.

  • npm: regular, dev, peer, optional

  • maven: optional, parent, compile, runtime, test, system, provided.

    Note that parent is not a regular Maven dependency type; instead this is extracted from the element if one is defined in the package version's POM file.

  • nuget: The dependencyType field is never set for NuGet packages.

  • pypi: Requires-Dist

namespace instance-attribute 

namespace: NotRequired[PackageNamespace]

The namespace of the package that this package depends on. The package component that specifies its namespace depends on its type. For example:

  • The namespace of a Maven package version is its groupId.

  • The namespace of an npm or Swift package version is its scope.

  • The namespace of a generic package is its namespace.

  • Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

package instance-attribute 

package: NotRequired[PackageName]

The name of the package that this package depends on.

version_requirement instance-attribute 

version_requirement: NotRequired[String]

The required version, or version range, of the package that this package depends on. The version format is specific to the package type. For example, the following are possible valid required versions: 1.2.3, ^2.3.4, or 4.x.