lilac2.api — The lilac.py API

exception lilac2.api.AurDownloadError(pkgname: str)

class lilac2.api.Union

Represent a union type

E.g. for int | str

lilac2.api.add_arch(extra: Iterable[str]) → None

Add more values into the arch shell array in the PKGBUILD file

lilac2.api.add_checkdepends(extra: Iterable[str]) → None

Add more values into the checkdepends shell array in the PKGBUILD file

lilac2.api.add_conflicts(extra: Iterable[str]) → None

Add more values into the conflicts shell array in the PKGBUILD file

lilac2.api.add_depends(extra: Iterable[str]) → None

Add more values into the depends shell array in the PKGBUILD file

lilac2.api.add_groups(extra: Iterable[str]) → None

Add more values into the groups shell array in the PKGBUILD file

lilac2.api.add_into_array(which: str, extra: Iterable[str]) → None

Add more values into the which shell array in the PKGBUILD file

lilac2.api.add_makedepends(extra: Iterable[str]) → None

Add more values into the makedepends shell array in the PKGBUILD file

lilac2.api.add_provides(extra: Iterable[str]) → None

Add more values into the provides shell array in the PKGBUILD file

lilac2.api.add_replaces(extra: Iterable[str]) → None

Add more values into the replaces shell array in the PKGBUILD file

lilac2.api.at_dir(d: PathLike) → Generator[None, None, None]

lilac2.api.aur_post_build() → None

lilac2.api.aur_pre_build(name: str | None = None, *, do_vcs_update: bool | None = None, maintainers: str | Container[str] = ()) → None

lilac2.api.check_library_provides() → None

lilac2.api.clean_directory() → List[str]

clean all PKGBUILD and related files

lilac2.api.download_official_pkgbuild(name: str) → list[str]

lilac2.api.edit_file(filename: str) → Iterator[str]

Edit the file in a loop, e.g.:

for line in edit_file('PKGBUILD'):
  if line.startswith('_name='):
    line = '_name=newname'
  print(line)

lilac2.api.file_lock(file: PathLike | str | bytes) → Generator[None, None, None]

lilac2.api.gen_pkgbuild(pypi_name: str, pkgname: str | None = None, depends: List[str] | None = None, python2: bool = False, arch: Iterable[str] | None = None, makedepends: List[str] | None = None, optdepends: List[str] | None = None, depends_setuptools: bool = False, check: str | None = None, provides: Iterable[str] | None = None, conflicts: Iterable[str] | None = None, license: str | None = None, license_file: str | None = None, prepare: str | None = None, pep517: bool = False) → Tuple[str, str]

lilac2.api.get_pkgver_and_pkgrel() → Tuple[str | None, int | str | None]

lilac2.api.get_srcinfo() → bytes

lilac2.api.git_add_files(files: str | List[str], *, force: bool = False) → None

lilac2.api.git_commit(*, check_status: bool = True) → None

lilac2.api.git_pkgbuild_commit() → None

lilac2.api.git_pull() → bool

lilac2.api.git_push() → None

lilac2.api.git_rm_files(files: List[str]) → None

lilac2.api.mediawiki_post_build() → None

lilac2.api.mediawiki_pre_build(name: str, mwver: str, desc: str, license: str) → None

lilac2.api.obtain_array(name: str) → List[str] | None

Obtain an array variable from PKGBUILD.

Works by calling bash to source PKGBUILD, writing the array to a temporary file, and reading from the file.

lilac2.api.obtain_depends() → List[str] | None

lilac2.api.obtain_makedepends() → List[str] | None

lilac2.api.obtain_optdepends(parse_dict: bool = True) → Dict[str, str] | List[str] | None

lilac2.api.parse_document_from_httpx(response, session=None, *, encoding=None)

response: httpx or requests Response object, or URL encoding: override detected encoding

lilac2.api.pypi_post_build() → None

lilac2.api.pypi_pre_build(depends: List[str] | None = None, python2: bool = False, pypi_name: str | None = None, arch: Iterable[str] | None = None, makedepends: List[str] | None = None, depends_setuptools: bool = True, provides: Iterable[str] | None = None, conflicts: Iterable[str] | None = None, prepare: str | None = None, check: str | None = None, optdepends: List[str] | None = None, license: str | None = None, license_file: str | None = None, pep517: bool = False) → None

lilac2.api.run_cmd(cmd: Sequence[str | Path], **kwargs) → str

lilac2.api.run_protected(cmd: Sequence[str | Path], **kwargs) → str

run a command that sources PKGBUILD and thus is protected by bwrap

lilac2.api.single_main(build_prefix: str = 'makepkg') → None

class lilac2.api.suppress(*exceptions)

Context manager to suppress specified exceptions

After the exception is suppressed, execution proceeds with the next statement following the with statement.

with suppress(FileNotFoundError):

os.remove(somefile)

# Execution still resumes here if the file was already removed

lilac2.api.update_aur_repo() → None

update the package on AUR if suitable.

lilac must have the permission to do so, i.e. added as a co-maintainer.

For VCS packages, if only the version changes, the package on AUR won’t be updated.

lilac2.api.update_pkgrel(rel: int | str | None = None) → None

lilac2.api.update_pkgver_and_pkgrel(newver: str, *, updpkgsums: bool = True) → None

lilac2.api.vcs_update() → None

update VCS sources

lilac2.api.s: httpx.Client

A shared httpx.Client object to send out HTTP requests.