Skip to main content

charmlibs-pathops

pathops provides a pathlib-like interface for local filesystem and workload container paths for Juju Charms.

To install, add charmlibs-pathops to your requirements. Then in your Python code, import as:

from charmlibs import pathops

Check out the reference docs on the charmlibs docsite.

Getting started

To get started, you can create an attribute self.root with the root directory for the local or remote paths you'll be working with.

import ops
from charmlibs import pathops

class KubernetesCharm(ops.CharmBase):
    def __init__(self, framework: ops.Framework):
        super().__init__(framework)
        container = self.unit.get_container('container-name')
        self.root = pathops.ContainerPath('/', container=container)

# or

class MachineCharm(ops.CharmBase):
    def __init__(self, framework: ops.Framework):
        super().__init__(framework)
        self.root = pathops.LocalPath('/')

You can then write code that could be used by either charm, using the pathops.PathProtocol type, which describes the operations supported by both local and container paths.

CONFIG_FILE_LOCATION = '/foo/bar'
CONFIG_FILE_CONTENTS = '...'

def write_config_file(root: pathops.PathProtocol) -> None:
    path = root / CONFIG_FILE_LOCATION
    path.write_text(CONFIG_FILE_CONTENTS)

For a Kubernetes charm, this also allows you to use the same API to work with paths in the charm container or the workload container.

import ops
from charmlibs import pathops

class KubernetesCharm(ops.CharmBase):
    def __init__(self, framework: ops.Framework):
        super().__init__(framework)
        self.charm_root = pathops.LocalPath('/')
        container = self.unit.get_container('container-name')
        self.workload_root = pathops.ContainerPath('/', container=container)
        ...

    def copy_config(self):
        source = self.charm_root / 'foo/bar'
        dest = self.workload_root / 'foo/bar/baz'
        dest.parent.mkdir(parents=True, exist_ok=True)
        dest.write_bytes(source.read_bytes())

pathops also provides a helper function for ensuring that a file is present with specified content, which returns whether changes were made.

import ops
from charmlibs import pathops

class KubernetesCharm(ops.CharmBase):
    ...

    def copy_config(self):
        changed = pathops.ensure_contents(
            path=self.workload_root / 'foo/bar/baz',
            source=(self.charm_root / 'foo/bar').read_bytes(),
        )
        if changed:
            # make the workload reload its configuration
            ...

pathops.PathProtocol provides a subset of the pathlib.Path API. PathProtocol doesn't support relative paths, open, or manipulating hardlinks and symlinks.

pathops doesn't provide a separate chmod method, as Pebble doesn't currently support this. Instead, mkdir, write_bytes, and write_text have arguments mode, user, and group to set directory or file permissions and ownership. ensure_contents also has these arguments.

Metadata

Release files for charmlibs-pathops 1.4.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for charmlibs-pathops 1.4.1
File Size Uploaded Provenance Actions
charmlibs_pathops-1.4.1.tar.gz 23.0 kB With provenance Details for charmlibs_pathops-1.4.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for charmlibs-pathops 1.4.1
File Interpreter ABI Platform Actions
charmlibs_pathops-1.4.1-py3-none-any.whl Python 3 none any Details for charmlibs_pathops-1.4.1-py3-none-any.whl

Total release size: 51.1 kB

Release files / charmlibs_pathops-1.4.1.tar.gz

Download URL charmlibs_pathops-1.4.1.tar.gz
Size 23.0 kB
Tags Source
SHA-256 checksum
How to use checksums
443fa7f6a9b818c0030a674e7fe8622ea2a4d253c3820b4e414bfa84dd221f12
BLAKE2b-256 checksum
How to use checksums
222a93d0c5dc9a4055ba74233e4574e9b27fa609b07f5926579b4f9c8bc1d642
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 10, 2026.

Transparency log

Release files / charmlibs_pathops-1.4.1-py3-none-any.whl

Download URL charmlibs_pathops-1.4.1-py3-none-any.whl
Size 28.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ceb960fbc1ac58b337cb7fcb561d6a56a1952d4f6c7a009cc6f754aaaa6964d5
BLAKE2b-256 checksum
How to use checksums
b16c91f89642f07d6865651ec8528206a86d0b105b2bb3fca61d83b752231f3a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 10, 2026.

Transparency log

Security for charmlibs-pathops 1.4.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for charmlibs_pathops-1.4.1.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 10, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page