python-alpm 0.2.0__cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

alpm/__init__.py

@@ -0,0 +1,6 @@
+"""Python bindings for the Arch Linux Package Management (ALPM) project."""
+
+from ._native import alpm_srcinfo, alpm_types, ALPMError
+from . import type_aliases
+
+__all__ = ["alpm_types", "alpm_srcinfo", "type_aliases", "ALPMError"]

alpm/_native.pyi

@@ -0,0 +1,4 @@
+from alpm import alpm_types, alpm_srcinfo
+from alpm.alpm_types import ALPMError
+
+__all__ = ["alpm_types", "alpm_srcinfo", "ALPMError"]

alpm/alpm_srcinfo/__init__.pyi

@@ -0,0 +1,20 @@
+"""A module for parsing and linting of ALPM SRCINFO files."""
+
+from . import error, source_info, schema
+from .error import SourceInfoError
+from .schema import SourceInfoSchema
+from .source_info import source_info_from_file, source_info_from_str
+from .source_info.v1 import SourceInfoV1
+from .source_info.v1.merged import MergedPackage
+
+__all__ = [
+    "SourceInfoError",
+    "error",
+    "source_info",
+    "SourceInfoV1",
+    "MergedPackage",
+    "schema",
+    "SourceInfoSchema",
+    "source_info_from_str",
+    "source_info_from_file",
+]

alpm/alpm_srcinfo/error.pyi

@@ -0,0 +1,8 @@
+"""Exceptions used by alpm_srcinfo module."""
+
+class SourceInfoError(Exception):
+    """The high-level exception that can occur when using alpm_srcinfo module."""
+
+__all__ = [
+    "SourceInfoError",
+]

alpm/alpm_srcinfo/schema.pyi

@@ -0,0 +1,70 @@
+"""Schemas for SRCINFO data."""
+
+from pathlib import Path
+from typing import Union, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from alpm.alpm_types import SchemaVersion
+
+class SourceInfoSchema:
+    """SRCINFO schema.
+
+    The schema of a SRCINFO refers to the minimum required sections and keywords, as
+    well as the complete set of available keywords in a specific version.
+    """
+
+    def __init__(self, version: Union[str, "SchemaVersion"]) -> None:
+        """Create a SourceInfoSchema from SchemaVersion or its string representation.
+
+        Args:
+            version (Union[str, SchemaVersion]): either a SchemaVersion or a string
+                representation of SchemaVersion.
+
+        Raises:
+            ALPMError: if the string representation of the version is invalid.
+            SourceInfoError: if there is no corresponding schema for the provided major
+                version.
+
+        """
+
+    @staticmethod
+    def derive_from_str(srcinfo: str) -> "SourceInfoSchema":
+        """Derive the schema from a string containing SRCINFO data.
+
+        Args:
+            srcinfo (str): The srcinfo string to derive the schema from.
+
+        Returns:
+            SourceInfoSchema: The derived schema.
+
+        Raises:
+            SourceInfoError: if the srcinfo string cannot be parsed.
+
+        """
+
+    @staticmethod
+    def derive_from_file(path: Union[str, Path]) -> "SourceInfoSchema":
+        """Derive the schema from a file containing SRCINFO data.
+
+        Args:
+            path (Union[str, Path]): The path to the file containing SRCINFO data.
+
+        Returns:
+            SourceInfoSchema: The derived schema.
+
+        Raises:
+            SourceInfoError: if the file cannot be read or parsed.
+
+        """
+
+    @property
+    def version(self) -> "SchemaVersion":
+        """The schema version."""
+
+    def __str__(self) -> str: ...
+    def __repr__(self) -> str: ...
+    def __eq__(self, other: object) -> bool: ...
+
+__all__ = [
+    """SourceInfoSchema""",
+]

alpm/alpm_srcinfo/source_info/__init__.pyi

@@ -0,0 +1,54 @@
+"""Data representations and integrations for reading of SRCINFO data."""
+
+from pathlib import Path
+from typing import Optional, TYPE_CHECKING, Union
+
+from . import v1
+
+if TYPE_CHECKING:
+    from alpm.alpm_srcinfo.schema import SourceInfoSchema
+    from alpm.type_aliases import SourceInfo
+
+def source_info_from_str(
+    s: str, schema: Optional["SourceInfoSchema"] = None
+) -> "SourceInfo":
+    """Create a SourceInfo object from a string.
+
+    Optionally validated using a SourceInfoSchema.
+
+    If schema is None, attempts to detect the SourceInfoSchema from s.
+
+    Args:
+        s (str): The srcinfo string to parse.
+        schema (Optional[SourceInfoSchema]): The schema to validate against.
+
+    Returns:
+        SourceInfo: The parsed SourceInfo object.
+
+    Raises:
+        SourceInfoError: If the string is not a valid SRCINFO.
+
+    """
+
+def source_info_from_file(
+    path: Union[str, Path], schema: Optional["SourceInfoSchema"] = None
+) -> "SourceInfo":
+    """Create a SourceInfo object from a file.
+
+    Optionally validated using a SourceInfoSchema.
+
+    If schema is None, attempts to detect the SourceInfoSchema from the file contents.
+
+    Args:
+        path (Union[str, Path]): The path to the file containing SRCINFO data.
+        schema (Optional[SourceInfoSchema]): The schema to validate against.
+
+    Returns:
+        SourceInfo: The parsed SourceInfo object.
+
+    Raises:
+        SourceInfoError: If the file cannot be read or is not a valid SRCINFO.
+
+    """
+
+__all__ = ["v1", "source_info_from_str", "source_info_from_file"]

alpm/alpm_srcinfo/source_info/v1/__init__.pyi

@@ -0,0 +1,102 @@
+"""Contains the second parsing and linting pass."""
+
+from pathlib import Path
+from typing import Union
+
+from . import merged, package, package_base
+from .package import Package
+from .package_base import PackageBase
+from .merged import MergedPackage
+from alpm.alpm_types import Architecture
+
+class SourceInfoV1:
+    """The representation of SRCINFO data.
+
+    Provides access to a PackageBase which tracks all data in a pkgbase section and a
+    list of Package instances that provide the accumulated data of all pkgname sections.
+
+    This is the entry point for parsing SRCINFO files. Once created,
+    packages_for_architecture method can be used to create usable MergedPackages.
+    """
+
+    __hash__ = None  # type: ignore
+
+    def __init__(self, content: str):
+        """Create SourceInfoV1 from a string representation.
+
+        Args:
+            content (str): The content of a SRCINFO as a string.
+
+        Raises:
+            SourceInfoError: If the content is not a valid SRCINFO representation.
+
+        """
+
+    @staticmethod
+    def from_file(path: Union[Path, str]) -> "SourceInfoV1":
+        """Read the file at the specified path and convert it into a SourceInfoV1.
+
+        Args:
+            path (Path | str): The path to the SRCINFO file.
+
+        Returns:
+            SourceInfoV1: The SourceInfoV1 instance created from the file content.
+
+        Raises:
+            SourceInfoError: If the file content is not a valid SRCINFO representation.
+
+        """
+
+    @staticmethod
+    def from_pkgbuild(path: Union[Path, str]) -> "SourceInfoV1":
+        """Create a SourceInfoV1 from a PKGBUILD file.
+
+        Args:
+            path (Path | str): The path to the PKGBUILD file.
+
+        Returns:
+            SourceInfoV1: The SourceInfoV1 instance created from the PKGBUILD file.
+
+        Raises:
+            SourceInfoError: If the PKGBUILD file cannot be parsed or is invalid.
+
+        """
+
+    @property
+    def base(self) -> "PackageBase":
+        """The information of the pkgbase section."""
+
+    @property
+    def packages(self) -> list["Package"]:
+        """The information of the pkgname sections."""
+
+    def as_srcinfo(self) -> str:
+        """Get a string representation in valid SRCINFO format.
+
+        Returns:
+            str: The string representation of the SourceInfoV1 instance.
+
+        """
+
+    def packages_for_architecture(
+        self, architecture: "Architecture"
+    ) -> list["MergedPackage"]:
+        """Get a list of all packages for architecture.
+
+        Args:
+            architecture (Architecture): The architecture to get packages for.
+
+        Returns:
+            list[MergedPackage]: A list of all packages for the given architecture.
+
+        """
+
+    def __str__(self) -> str: ...
+    def __repr__(self) -> str: ...
+
+__all__ = [
+    "SourceInfoV1",
+    "merged",
+    "package",
+    "package_base",
+]

alpm/alpm_srcinfo/source_info/v1/merged.pyi

@@ -0,0 +1,188 @@
+"""Provides fully resolved package metadata derived from SRCINFO data."""
+
+from typing import Optional, Union
+from pathlib import Path
+
+from alpm.alpm_srcinfo.source_info.v1.package import Package
+from alpm.alpm_srcinfo.source_info.v1.package_base import PackageBase
+from alpm.type_aliases import MakepkgOption, OpenPGPIdentifier, RelationOrSoname
+from alpm.alpm_types import (
+    Url,
+    License,
+    Architecture,
+    FullVersion,
+    PackageRelation,
+    OptionalDependency,
+    Source,
+    SkippableBlake2b512Checksum,
+    SkippableMd5Checksum,
+    SkippableSha1Checksum,
+    SkippableSha224Checksum,
+    SkippableSha256Checksum,
+    SkippableSha384Checksum,
+    SkippableSha512Checksum,
+)
+
+class MergedPackage:
+    """Fully resolved metadata of a single package based on SRCINFO data.
+
+    This struct incorporates all PackageBase properties and the Package specific
+    overrides in an architecture-specific representation of a package. It can be
+    created using SourceInfoV1.packages_for_architecture.
+    """
+
+    def __init__(
+        self,
+        architecture: "Architecture",
+        base: "PackageBase",
+        package_or_name: Union[Package | str],
+    ):
+        """Create architecture-specific metadata representation of a package.
+
+        Based on the provided parameters can either create a fully resolved or a basic
+        (incomplete) MergedPackage.
+
+        Args:
+            architecture (Architecture): Defines the architecture for which to create
+                the representation.
+            base (PackageBase): The package base which provides the initial data.
+            package_or_name (Union[Package, str]): Either the Package from which to
+                derive the metadata for a fully resolved MergedPackage, or a name of
+                the package for a basic, incomplete representation of a package.
+
+        Raises:
+            ALPMError: If the provided name is not valid.
+
+        """
+
+    @property
+    def name(self) -> str:
+        """The alpm-package-name for the package."""
+
+    @property
+    def description(self) -> Optional[str]:
+        """The description for the package."""
+
+    @property
+    def url(self) -> Optional["Url"]:
+        """The upstream URL for the package."""
+
+    @property
+    def licenses(self) -> list["License"]:
+        """Licenses that apply to the package."""
+
+    @property
+    def architecture(self) -> "Architecture":
+        """Alpm-architecture for the package."""
+
+    @property
+    def changelog(self) -> Optional[Path]:
+        """Path to a changelog file for the package."""
+
+    @property
+    def install(self) -> Optional[Path]:
+        """Path to an alpm-install-scriptlet for the package."""
+
+    @property
+    def groups(self) -> list[str]:
+        """Alpm-package-groups the package is part of."""
+
+    @property
+    def options(self) -> list["MakepkgOption"]:
+        """Build tool options used when building the package."""
+
+    @property
+    def backups(self) -> list[Path]:
+        """Paths to files in the package that should be backed up."""
+
+    @property
+    def version(self) -> "FullVersion":
+        """The full version of the package."""
+
+    @property
+    def pgp_fingerprints(self) -> list["OpenPGPIdentifier"]:
+        """OpenPGPIdentifiers used for the verification of upstream sources."""
+
+    @property
+    def dependencies(self) -> list["RelationOrSoname"]:
+        """The list of run-time dependencies."""
+
+    @property
+    def optional_dependencies(self) -> list["OptionalDependency"]:
+        """The list of optional dependencies."""
+
+    @property
+    def provides(self) -> list["RelationOrSoname"]:
+        """The list of provisions."""
+
+    @property
+    def conflicts(self) -> list["PackageRelation"]:
+        """The list of conflicts."""
+
+    @property
+    def replaces(self) -> list["PackageRelation"]:
+        """The list of replacements."""
+
+    @property
+    def check_dependencies(self) -> list["PackageRelation"]:
+        """The list of test dependencies."""
+
+    @property
+    def make_dependencies(self) -> list["PackageRelation"]:
+        """The list of build dependencies."""
+
+    @property
+    def sources(self) -> list["MergedSource"]:
+        """The list of sources for the package."""
+
+    @property
+    def no_extracts(self) -> list[str]:
+        """The list of sources for the package that are not extracted."""
+
+    def __str__(self) -> str: ...
+    def __repr__(self) -> str: ...
+
+class MergedSource:
+    """A merged representation of source related information.
+
+    SRCINFO provides this info as separate lists. This struct resolves that list
+    representation and provides a convenient aggregated representation for a single
+    source.
+    """
+
+    @property
+    def source(self) -> "Source":
+        """The source."""
+
+    @property
+    def b2_checksum(self) -> Optional[SkippableBlake2b512Checksum]:
+        """The optional Blake2 hash digest of source."""
+
+    @property
+    def md5_checksum(self) -> Optional[SkippableMd5Checksum]:
+        """The optional MD-5 hash digest of source."""
+
+    @property
+    def sha1_checksum(self) -> Optional[SkippableSha1Checksum]:
+        """The optional SHA-1 hash digest of source."""
+
+    @property
+    def sha224_checksum(self) -> Optional[SkippableSha224Checksum]:
+        """The optional SHA-224 hash digest of source."""
+
+    @property
+    def sha256_checksum(self) -> Optional[SkippableSha256Checksum]:
+        """The optional SHA-256 hash digest of source."""
+
+    @property
+    def sha384_checksum(self) -> Optional[SkippableSha384Checksum]:
+        """The optional SHA-384 hash digest of source."""
+
+    @property
+    def sha512_checksum(self) -> Optional[SkippableSha512Checksum]:
+        """The optional SHA-512 hash digest of source."""
+
+__all__ = [
+    "MergedPackage",
+    "MergedSource",
+]