Skip to main content

A pathlib-like interface for Juju K8s charms to interact with files in their workload container.

Project description

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 here.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

charmlibs_pathops-1.0.1.tar.gz (21.4 kB view details)

Uploaded Source

Built Distribution

charmlibs_pathops-1.0.1-py3-none-any.whl (26.6 kB view details)

Uploaded Python 3

File details

Details for the file charmlibs_pathops-1.0.1.tar.gz.

File metadata

  • Download URL: charmlibs_pathops-1.0.1.tar.gz
  • Upload date:
  • Size: 21.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for charmlibs_pathops-1.0.1.tar.gz
Algorithm Hash digest
SHA256 fa5dd9fe5843871a9ebe925c7482bc2d00707a8deca7fdd20d0e35917db1eac4
MD5 7b5c29cf3c7dda60c523cba32f2da1df
BLAKE2b-256 4b0516e17371244d61c513dccc32eecebf5c3acfc9782f8f00de50a4578b28c1

See more details on using hashes here.

Provenance

The following attestation bundles were made for charmlibs_pathops-1.0.1.tar.gz:

Publisher: publish-charmlibs-pathops-package.yaml on canonical/charmtech-charmlibs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file charmlibs_pathops-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for charmlibs_pathops-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 22a80f80afd776a281a230adb8e0909c60f8d380c67e229f4cda6ede2351e199
MD5 c346842e29f237d01e1bda7df39fbde9
BLAKE2b-256 82de7fd6ca87060c2194aea2d18af4fdb7d90283b5bcfd5d60d4ae116df995f3

See more details on using hashes here.

Provenance

The following attestation bundles were made for charmlibs_pathops-1.0.1-py3-none-any.whl:

Publisher: publish-charmlibs-pathops-package.yaml on canonical/charmtech-charmlibs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page