Skip to content

docs: for apt, clarify that add_package doesn't raise PackageNotFoundError #167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
james-garner-canonical merged 2 commits into from
Aug 21, 2025
Merged

docs: for apt, clarify that add_package doesn't raise PackageNotFoundError #167

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
65d2558
bump patch version
dwilding Aug 21, 2025
7cffdfa
clarify when `PackageNotFoundError` is raised
dwilding Aug 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 13 additions & 7 deletions lib/charms/operator_libs_linux/v0/apt.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,14 @@
apt.update()
apt.add_package("zsh")
apt.add_package(["vim", "htop", "wget"])
except PackageNotFoundError:
logger.error("a specified package not found in package cache or on system")
except PackageError as e:
logger.error("could not install package. Reason: %s", e.message)
````

The convenience methods don't raise `PackageNotFoundError`. If any packages aren't found in
the cache, `apt.add_package` raises `PackageError` with a message 'Failed to install
packages: foo, bar'.

To find details of a specific package:

```python
Expand Down Expand Up @@ -131,7 +133,7 @@

# Increment this PATCH version before using `charmcraft publish-lib` or reset
# to 0 if you are raising the major API version
LIBPATCH = 18
LIBPATCH = 19

PYDEPS = ["opentelemetry-api"]

Expand Down Expand Up @@ -160,11 +162,15 @@ def message(self):


class PackageError(Error):
"""Raised when there's an error installing or removing a package."""
"""Raised when there's an error installing or removing a package.

Additionally, `apt.add_package` raises `PackageError` if any packages aren't found in
the cache.
"""


class PackageNotFoundError(Error):
"""Raised when a requested package is not known to the system."""
"""Raised by `DebianPackage` methods if a requested package is not found."""


class PackageState(Enum):
Expand Down Expand Up @@ -779,8 +785,8 @@ def add_package(

Raises:
TypeError if no package name is given, or explicit version is set for multiple packages
PackageNotFoundError if the package is not in the cache.
PackageError if packages fail to install
PackageError: if packages fail to install, including if any packages aren't found in the
cache
"""
cache_refreshed = False
if update_cache:
Expand Down