ops 2.23.0.dev0__tar.gz → 2.23.2__tar.gz

{ops-2.23.0.dev0 → ops-2.23.2}/CHANGES.md

@@ -1,3 +1,86 @@
+# 2.23.2 - 11 February 2026
+
+## Fixes
+
+* Drop unused `setuptools_scm` build dependency (#2318)
+
+## Documentation
+
+* For 2.23, update links and config for switch to documentation.ubuntu.com/ops (#1942)
+* For 2.x, fix site title and unstyled error pages (#1945)
+* For 2.x, remove .html extensions (#1954)
+* For 2.x, fix unstyled error pages (#1973)
+
+# 2.23.1 - 30 July 2025
+
+## Fixes
+
+* Add the remote unit to `Relation.data` but not `Relation.units` (#1928)
+
+## Documentation
+
+* Be consistent with recommending `self.app` and `self.unit` (#1856)
+* Add notice about ops 2 and ops 3 (#1867)
+* Update title and edit links for ops 2.23 docs (#1885)
+
+## CI
+
+* Hotfix, publish job for ops-tracing (#1865)
+
+# 2.23.0 - 30 June 2025
+
+## Features
+
+* Support for config schema as Python classes (#1741)
+* Support for action parameter schema as Python classes (#1756)
+* Ops[tracing] compatibility with jhack (#1806)
+* Support for relation data schema as Python classes (#1701)
+* Add CheckInfo.successes field and .has_run property (#1819)
+* Provide a method to create a testing.State from a testing.Context (#1797)
+* Expose trace data in testing (#1842)
+* Add a helper to generate a Layer from rockcraft.yaml (#1831)
+
+## Fixes
+
+* Correctly load an empty Juju config options map (#1778)
+* Fix type annotation of container check_infos in ops.testing (#1784)
+* Restrict the version of a dependency, opentelemetry-sdk (#1794)
+* Remote unit data is available in relation-departed (#1364)
+* Juju allows access to the remote app databag in relation-broken, so Harness should too (#1787)
+* Don't use private OpenTelemetry API (#1798)
+* Do not return this unit in a mocked peer relation (#1828)
+* Testing.PeerRelation properly defaults to no peers (#1832)
+* In meter-status-changed JUJU_VERSION is not set (#1840)
+* Only provide the units belonging to the app in Relation.units (#1837)
+
+## Documentation
+
+* Remove two best practices, and drop two to tips (#1758)
+* Update link to Charmcraft for managing app config (#1763)
+* Update link to Juju documentation for setting up deployment (#1781)
+* Fix external OTLP link (#1786)
+* Distribute the ops-scenario README content across the ops docs (#1773)
+* Improve testing.errors.UncaughtCharmError message (#1795)
+* In the "manage the charm version" how-to, give an example of using override-build (#1802)
+* Small adjustments to the 'how to trace charm code' doc (#1792)
+* Replace Harness example and fix links in README (#1820)
+* Add httpbin charm from Charmcraft as an example charm (#1743)
+* Fix on_collect mistake in sample code (#1829)
+* Update code in K8s tutorial, with source in repo (part 2) (#1734)
+* Update Loki section on charming zero-to-hero tutorial (#1847)
+* Remove expandable boxes of text (#1844)
+* Improve httpbin charm by removing defer() and adding collect_status (#1833)
+* Move {posargs} to the end of pytest command lines in tox.ini (#1854)
+
+## CI
+
+* Install the ops[tracing] dependencies for the TIOBE action (#1761)
+* Add ops-scenario and ops-tracing as explicit installs for TIOBE (#1764)
+* Persist credentials for update-charm-pins workflow (#1766)
+* Stop smoke testing Charmcraft 2 (#1782)
+* Use Charmcraft 3.x for smoke testing 20.04 and 22.04 (#1821)
+* Enable xdist for the 'unit' tox environments (#1830)
+
 # 2.22.0 - 29 May 2025
 
 ## Features

{ops-2.23.0.dev0 → ops-2.23.2}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: ops
-Version: 2.23.0.dev0
+Version: 2.23.2
 Summary: The Python library behind great charms
 Author: The Charm Tech team at Canonical Ltd.
-Project-URL: Homepage, https://ops.readthedocs.io/en/latest/
+Project-URL: Homepage, https://documentation.ubuntu.com/ops/2.x/
 Project-URL: Repository, https://github.com/canonical/operator
 Project-URL: Issues, https://github.com/canonical/operator/issues
-Project-URL: Documentation, https://ops.readthedocs.io
+Project-URL: Documentation, https://documentation.ubuntu.com/ops/2.x/
 Project-URL: Changelog, https://github.com/canonical/operator/blob/main/CHANGES.md
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: Apache Software License
@@ -23,9 +23,9 @@ Requires-Dist: websocket-client==1.*
 Requires-Dist: opentelemetry-api~=1.0
 Requires-Dist: importlib-metadata
 Provides-Extra: testing
-Requires-Dist: ops-scenario==7.23.0.dev0; extra == "testing"
+Requires-Dist: ops-scenario==7.23.2; extra == "testing"
 Provides-Extra: tracing
-Requires-Dist: ops-tracing==2.23.0.dev0; extra == "tracing"
+Requires-Dist: ops-tracing==2.23.2; extra == "tracing"
 Provides-Extra: harness
 Dynamic: license-file
 
@@ -36,8 +36,8 @@ Dynamic: license-file
 The `ops` library is a Python framework for developing and testing Kubernetes and machine [charms](https://charmhub.io/). While charms can be written in any language, `ops` defines the latest standard, and charmers are encouraged to use Python with `ops` for all charms. The library is an official component of the Charm SDK, itself a part of [the Juju universe](https://juju.is/).
 
 > - `ops` is  [available on PyPI](https://pypi.org/project/ops/).
-> - The latest version of `ops` requires Python 3.8 or above.
-> - Read our [docs](https://ops.readthedocs.io/en/latest/) for tutorials, how-to guides, the library reference, and more.
+> - Version 2.x of `ops` requires Python 3.8 or above.
+> - Read our [docs](https://documentation.ubuntu.com/ops/2.x/) for tutorials, how-to guides, the library reference, and more.
 
 ## Give it a try
 
@@ -181,6 +181,6 @@ Congratulations, you’ve just built your first Kubernetes charm using `ops`!
 
 ## Next steps
 
-- Read the [docs](https://ops.readthedocs.io/en/latest/).
+- Read the [docs](https://documentation.ubuntu.com/ops/2.x/).
 - Read our [Code of conduct](https://ubuntu.com/community/code-of-conduct) and join our [chat](https://matrix.to/#/#charmhub-ops:ubuntu.com) and [forum](https://discourse.charmhub.io/) or [open an issue](https://github.com/canonical/operator/issues).
 - Read our [CONTRIBUTING guide](https://github.com/canonical/operator/blob/main/HACKING.md) and contribute!

{ops-2.23.0.dev0 → ops-2.23.2}/README.md

@@ -5,8 +5,8 @@
 The `ops` library is a Python framework for developing and testing Kubernetes and machine [charms](https://charmhub.io/). While charms can be written in any language, `ops` defines the latest standard, and charmers are encouraged to use Python with `ops` for all charms. The library is an official component of the Charm SDK, itself a part of [the Juju universe](https://juju.is/).
 
 > - `ops` is  [available on PyPI](https://pypi.org/project/ops/).
-> - The latest version of `ops` requires Python 3.8 or above.
-> - Read our [docs](https://ops.readthedocs.io/en/latest/) for tutorials, how-to guides, the library reference, and more.
+> - Version 2.x of `ops` requires Python 3.8 or above.
+> - Read our [docs](https://documentation.ubuntu.com/ops/2.x/) for tutorials, how-to guides, the library reference, and more.
 
 ## Give it a try
 
@@ -150,6 +150,6 @@ Congratulations, you’ve just built your first Kubernetes charm using `ops`!
 
 ## Next steps
 
-- Read the [docs](https://ops.readthedocs.io/en/latest/).
+- Read the [docs](https://documentation.ubuntu.com/ops/2.x/).
 - Read our [Code of conduct](https://ubuntu.com/community/code-of-conduct) and join our [chat](https://matrix.to/#/#charmhub-ops:ubuntu.com) and [forum](https://discourse.charmhub.io/) or [open an issue](https://github.com/canonical/operator/issues).
 - Read our [CONTRIBUTING guide](https://github.com/canonical/operator/blob/main/HACKING.md) and contribute!

{ops-2.23.0.dev0/test/charms/test_main/lib → ops-2.23.2}/ops/_main.py

@@ -368,24 +368,30 @@ class _Manager:
     def _make_framework(self, dispatcher: _Dispatcher):
         # If we are in a RelationBroken event, we want to know which relation is
         # broken within the model, not only in the event's `.relation` attribute.
-        if self._juju_context.dispatch_path.endswith(('-relation-broken', '_relation_broken')):
+        if dispatcher.event_name.endswith('_relation_broken'):
             broken_relation_id = self._juju_context.relation_id
         else:
             broken_relation_id = None
 
+        # In a RelationDeparted event, the unit is not included in the Juju
+        # `relation-list` output, but the charm still has access to the remote
+        # relation data. To provide the charm with a mechanism for getting
+        # access to that data, we include the remote unit in Relation.units.
+        # We also expect it to be available in RelationBroken events, so ensure
+        # that it's available then as well. For other relation events, the unit
+        # will either already be in the set via `relation-list` (such as in a
+        # RelationChanged event) or correctly not in the list yet because the
+        # relation has not been fully set up (such as in a RelationJoined event).
+        if dispatcher.event_name.endswith(('_relation_departed', '_relation_broken')):
+            remote_unit_name = self._juju_context.remote_unit_name
+        else:
+            remote_unit_name = None
+
         model = _model.Model(
             self._charm_meta,
             self._model_backend,
             broken_relation_id=broken_relation_id,
-            # In a RelationDeparted event, the unit is not included in the Juju
-            # `relation-list` output, but the charm still has access to the remote
-            # relation data. To provide the charm with a mechanism for getting
-            # access to that data, we include the remote unit in Relation.units.
-            # In other relation events (such as RelationChanged) the unit will
-            # already be in the set via `relation-list` - adding it via this extra
-            # mechanism will not change the final set, and is simpler than only
-            # adding it in specific events.
-            remote_unit_name=self._juju_context.remote_unit_name,
+            remote_unit_name=remote_unit_name,
         )
         store = self._make_storage(dispatcher)
         framework = _framework.Framework(

{ops-2.23.0.dev0 → ops-2.23.2}/ops/_private/harness.py

@@ -323,7 +323,7 @@ class Harness(Generic[CharmType]):
 
         warnings.warn(
             'Harness is deprecated. For the recommended approach, see: '
-            'https://ops.readthedocs.io/en/latest/howto/write-unit-tests-for-a-charm.html',
+            'https://documentation.ubuntu.com/ops/2.x/howto/write-unit-tests-for-a-charm.html',
             PendingDeprecationWarning,
             stacklevel=2,
         )

{ops-2.23.0.dev0 → ops-2.23.2}/ops/charm.py

@@ -1467,12 +1467,12 @@ class CharmBase(Object):
 
     @property
     def app(self) -> model.Application:
-        """Application that this unit is part of."""
+        """The application that this unit is part of."""
         return self.framework.model.app
 
     @property
     def unit(self) -> model.Unit:
-        """Unit that this execution is responsible for."""
+        """The current unit."""
         return self.framework.model.unit
 
     @property

{ops-2.23.0.dev0/test/charms/test_main/lib → ops-2.23.2}/ops/model.py

@@ -159,17 +159,17 @@ class Model:
 
     @property
     def unit(self) -> Unit:
-        """The unit that is running this code.
+        """The current unit. Equivalent to :attr:`CharmBase.unit`.
 
-        Use :meth:`get_unit` to get an arbitrary unit by name.
+        To get a unit by name, use :meth:`get_unit`.
         """
         return self._unit
 
     @property
     def app(self) -> Application:
-        """The application this unit is a part of.
+        """The application that this unit is part of. Equivalent to :attr:`CharmBase.app`.
 
-        Use :meth:`get_app` to get an arbitrary application by name.
+        To get an application by name, use :meth:`get_app`.
         """
         return self._unit.app
 
@@ -238,22 +238,22 @@ class Model:
         return self._backend._juju_context.version
 
     def get_unit(self, unit_name: str) -> Unit:
-        """Get an arbitrary unit by name.
-
-        Use :attr:`unit` to get the current unit.
+        """Get a unit by name.
 
         Internally this uses a cache, so asking for the same unit two times will
         return the same object.
+
+        To get the current unit, use :attr:`CharmBase.unit` or :attr:`unit`.
         """
         return self._cache.get(Unit, unit_name)
 
     def get_app(self, app_name: str) -> Application:
         """Get an application by name.
 
-        Use :attr:`app` to get this charm's application.
-
         Internally this uses a cache, so asking for the same application two times will
         return the same object.
+
+        To get the application that this unit is part of, use :attr:`CharmBase.app` or :attr:`app`.
         """
         return self._cache.get(Application, app_name)
 
@@ -380,9 +380,10 @@ class Application:
     """Represents a named application in the model.
 
     This might be this charm's application, or might be an application this charm is integrated
-    with. Charmers should not instantiate Application objects directly, but should use
-    :attr:`Model.app` to get the application this unit is part of, or
-    :meth:`Model.get_app` if they need a reference to a given application.
+    with.
+
+    Don't instantiate Application objects directly. To get the application that this unit is
+    part of, use :attr:`CharmBase.app`. To get an application by name, use :meth:`Model.get_app`.
     """
 
     name: str
@@ -426,7 +427,7 @@ class Application:
 
         Example::
 
-            self.model.app.status = ops.BlockedStatus('I need a human to come help me')
+            self.app.status = ops.BlockedStatus('I need a human to come help me')
         """
         if not self._is_our_app:
             return UnknownStatus()
@@ -556,6 +557,9 @@ class Unit:
 
     This might be the current unit, another unit of the charm's application, or a unit of
     another application that the charm is integrated with.
+
+    Don't instantiate Unit objects directly. To get the current unit, use :attr:`CharmBase.unit`.
+    To get a unit by name, use :meth:`Model.get_unit`.
     """
 
     name: str
@@ -609,7 +613,7 @@ class Unit:
 
         Example::
 
-            self.model.unit.status = ops.MaintenanceStatus('reconfiguring the frobnicators')
+            self.unit.status = ops.MaintenanceStatus('reconfiguring the frobnicators')
         """
         if not self._is_our_unit:
             return UnknownStatus()
@@ -1770,16 +1774,23 @@ class Relation:
 
         # self.app will not be None and always be set because of the fallback mechanism above.
         self.app = typing.cast('Application', app)
-        self.data = RelationData(self, our_unit, backend)
 
         # In relation-departed `relation-list` doesn't include the remote unit,
         # but the data should still be available.
         if (
             _remote_unit is not None
             and not is_peer
+            # In practice, the "self.app will not be None" statement above is not
+            # necessarily true. Once https://bugs.launchpad.net/juju/+bug/1960934
+            # is resolved, we should be able to remove the next line.
+            and self.app is not None
             and _remote_unit.name.startswith(f'{self.app.name}/')
         ):
-            self.units.add(_remote_unit)
+            remote_unit = _remote_unit
+        else:
+            remote_unit = None
+
+        self.data = RelationData(self, our_unit, backend, remote_unit)
 
         self._remote_model: RemoteModel | None = None
 
@@ -1975,7 +1986,13 @@ class RelationData(Mapping[Union[Unit, Application], 'RelationDataContent']):
     :attr:`Relation.data`
     """
 
-    def __init__(self, relation: Relation, our_unit: Unit, backend: _ModelBackend):
+    def __init__(
+        self,
+        relation: Relation,
+        our_unit: Unit,
+        backend: _ModelBackend,
+        remote_unit: Unit | None = None,
+    ):
         self.relation = weakref.proxy(relation)
         self._data: dict[Unit | Application, RelationDataContent] = {
             our_unit: RelationDataContent(self.relation, our_unit, backend),
@@ -1989,6 +2006,9 @@ class RelationData(Mapping[Union[Unit, Application], 'RelationDataContent']):
             self._data.update({
                 self.relation.app: RelationDataContent(self.relation, self.relation.app, backend),
             })
+        # The unit might be departing or broken, so not in relation-list, but accessible.
+        if remote_unit is not None and remote_unit not in self._data:
+            self._data[remote_unit] = RelationDataContent(self.relation, remote_unit, backend)
 
     def __contains__(self, key: Unit | Application):
         return key in self._data

{ops-2.23.0.dev0/test/charms/test_main/lib → ops-2.23.2}/ops/version.py

@@ -19,4 +19,4 @@ This module is NOT to be used when developing charms using ops.
 
 from __future__ import annotations
 
-version: str = '2.23.0.dev0'
+version: str = '2.23.2'

{ops-2.23.0.dev0 → ops-2.23.2}/ops.egg-info/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: ops
-Version: 2.23.0.dev0
+Version: 2.23.2
 Summary: The Python library behind great charms
 Author: The Charm Tech team at Canonical Ltd.
-Project-URL: Homepage, https://ops.readthedocs.io/en/latest/
+Project-URL: Homepage, https://documentation.ubuntu.com/ops/2.x/
 Project-URL: Repository, https://github.com/canonical/operator
 Project-URL: Issues, https://github.com/canonical/operator/issues
-Project-URL: Documentation, https://ops.readthedocs.io
+Project-URL: Documentation, https://documentation.ubuntu.com/ops/2.x/
 Project-URL: Changelog, https://github.com/canonical/operator/blob/main/CHANGES.md
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: Apache Software License
@@ -23,9 +23,9 @@ Requires-Dist: websocket-client==1.*
 Requires-Dist: opentelemetry-api~=1.0
 Requires-Dist: importlib-metadata
 Provides-Extra: testing
-Requires-Dist: ops-scenario==7.23.0.dev0; extra == "testing"
+Requires-Dist: ops-scenario==7.23.2; extra == "testing"
 Provides-Extra: tracing
-Requires-Dist: ops-tracing==2.23.0.dev0; extra == "tracing"
+Requires-Dist: ops-tracing==2.23.2; extra == "tracing"
 Provides-Extra: harness
 Dynamic: license-file
 
@@ -36,8 +36,8 @@ Dynamic: license-file
 The `ops` library is a Python framework for developing and testing Kubernetes and machine [charms](https://charmhub.io/). While charms can be written in any language, `ops` defines the latest standard, and charmers are encouraged to use Python with `ops` for all charms. The library is an official component of the Charm SDK, itself a part of [the Juju universe](https://juju.is/).
 
 > - `ops` is  [available on PyPI](https://pypi.org/project/ops/).
-> - The latest version of `ops` requires Python 3.8 or above.
-> - Read our [docs](https://ops.readthedocs.io/en/latest/) for tutorials, how-to guides, the library reference, and more.
+> - Version 2.x of `ops` requires Python 3.8 or above.
+> - Read our [docs](https://documentation.ubuntu.com/ops/2.x/) for tutorials, how-to guides, the library reference, and more.
 
 ## Give it a try
 
@@ -181,6 +181,6 @@ Congratulations, you’ve just built your first Kubernetes charm using `ops`!
 
 ## Next steps
 
-- Read the [docs](https://ops.readthedocs.io/en/latest/).
+- Read the [docs](https://documentation.ubuntu.com/ops/2.x/).
 - Read our [Code of conduct](https://ubuntu.com/community/code-of-conduct) and join our [chat](https://matrix.to/#/#charmhub-ops:ubuntu.com) and [forum](https://discourse.charmhub.io/) or [open an issue](https://github.com/canonical/operator/issues).
 - Read our [CONTRIBUTING guide](https://github.com/canonical/operator/blob/main/HACKING.md) and contribute!

{ops-2.23.0.dev0 → ops-2.23.2}/ops.egg-info/requires.txt

@@ -6,7 +6,7 @@ importlib-metadata
 [harness]
 
 [testing]
-ops-scenario==7.23.0.dev0
+ops-scenario==7.23.2
 
 [tracing]
-ops-tracing==2.23.0.dev0
+ops-tracing==2.23.2

{ops-2.23.0.dev0 → ops-2.23.2}/pyproject.toml

@@ -26,10 +26,10 @@ dynamic = ["version"]
 
 [project.optional-dependencies]
 testing = [
-    "ops-scenario==7.23.0.dev0",
+    "ops-scenario==7.23.2",
 ]
 tracing = [
-    "ops-tracing==2.23.0.dev0",
+    "ops-tracing==2.23.2",
 ]
 # Empty for now, because Harness is bundled with the base install, but allow
 # specifying the extra to ease transition later.
@@ -89,10 +89,10 @@ integration = [
 ]
 
 [project.urls]
-"Homepage" = "https://ops.readthedocs.io/en/latest/"
+"Homepage" = "https://documentation.ubuntu.com/ops/2.x/"
 "Repository" = "https://github.com/canonical/operator"
 "Issues" = "https://github.com/canonical/operator/issues"
-"Documentation" = "https://ops.readthedocs.io"
+"Documentation" = "https://documentation.ubuntu.com/ops/2.x/"
 "Changelog" = "https://github.com/canonical/operator/blob/main/CHANGES.md"
 
 [build-system]

{ops-2.23.0.dev0 → ops-2.23.2/test/charms/test_main/lib}/ops/_main.py

@@ -368,24 +368,30 @@ class _Manager:
     def _make_framework(self, dispatcher: _Dispatcher):
         # If we are in a RelationBroken event, we want to know which relation is
         # broken within the model, not only in the event's `.relation` attribute.
-        if self._juju_context.dispatch_path.endswith(('-relation-broken', '_relation_broken')):
+        if dispatcher.event_name.endswith('_relation_broken'):
             broken_relation_id = self._juju_context.relation_id
         else:
             broken_relation_id = None
 
+        # In a RelationDeparted event, the unit is not included in the Juju
+        # `relation-list` output, but the charm still has access to the remote
+        # relation data. To provide the charm with a mechanism for getting
+        # access to that data, we include the remote unit in Relation.units.
+        # We also expect it to be available in RelationBroken events, so ensure
+        # that it's available then as well. For other relation events, the unit
+        # will either already be in the set via `relation-list` (such as in a
+        # RelationChanged event) or correctly not in the list yet because the
+        # relation has not been fully set up (such as in a RelationJoined event).
+        if dispatcher.event_name.endswith(('_relation_departed', '_relation_broken')):
+            remote_unit_name = self._juju_context.remote_unit_name
+        else:
+            remote_unit_name = None
+
         model = _model.Model(
             self._charm_meta,
             self._model_backend,
             broken_relation_id=broken_relation_id,
-            # In a RelationDeparted event, the unit is not included in the Juju
-            # `relation-list` output, but the charm still has access to the remote
-            # relation data. To provide the charm with a mechanism for getting
-            # access to that data, we include the remote unit in Relation.units.
-            # In other relation events (such as RelationChanged) the unit will
-            # already be in the set via `relation-list` - adding it via this extra
-            # mechanism will not change the final set, and is simpler than only
-            # adding it in specific events.
-            remote_unit_name=self._juju_context.remote_unit_name,
+            remote_unit_name=remote_unit_name,
         )
         store = self._make_storage(dispatcher)
         framework = _framework.Framework(

{ops-2.23.0.dev0 → ops-2.23.2}/test/charms/test_main/lib/ops/_private/harness.py

@@ -323,7 +323,7 @@ class Harness(Generic[CharmType]):
 
         warnings.warn(
             'Harness is deprecated. For the recommended approach, see: '
-            'https://ops.readthedocs.io/en/latest/howto/write-unit-tests-for-a-charm.html',
+            'https://documentation.ubuntu.com/ops/2.x/howto/write-unit-tests-for-a-charm.html',
             PendingDeprecationWarning,
             stacklevel=2,
         )

{ops-2.23.0.dev0 → ops-2.23.2}/test/charms/test_main/lib/ops/charm.py

@@ -1467,12 +1467,12 @@ class CharmBase(Object):
 
     @property
     def app(self) -> model.Application:
-        """Application that this unit is part of."""
+        """The application that this unit is part of."""
         return self.framework.model.app
 
     @property
     def unit(self) -> model.Unit:
-        """Unit that this execution is responsible for."""
+        """The current unit."""
         return self.framework.model.unit
 
     @property

{ops-2.23.0.dev0 → ops-2.23.2/test/charms/test_main/lib}/ops/model.py

@@ -159,17 +159,17 @@ class Model:
 
     @property
     def unit(self) -> Unit:
-        """The unit that is running this code.
+        """The current unit. Equivalent to :attr:`CharmBase.unit`.
 
-        Use :meth:`get_unit` to get an arbitrary unit by name.
+        To get a unit by name, use :meth:`get_unit`.
         """
         return self._unit
 
     @property
     def app(self) -> Application:
-        """The application this unit is a part of.
+        """The application that this unit is part of. Equivalent to :attr:`CharmBase.app`.
 
-        Use :meth:`get_app` to get an arbitrary application by name.
+        To get an application by name, use :meth:`get_app`.
         """
         return self._unit.app
 
@@ -238,22 +238,22 @@ class Model:
         return self._backend._juju_context.version
 
     def get_unit(self, unit_name: str) -> Unit:
-        """Get an arbitrary unit by name.
-
-        Use :attr:`unit` to get the current unit.
+        """Get a unit by name.
 
         Internally this uses a cache, so asking for the same unit two times will
         return the same object.
+
+        To get the current unit, use :attr:`CharmBase.unit` or :attr:`unit`.
         """
         return self._cache.get(Unit, unit_name)
 
     def get_app(self, app_name: str) -> Application:
         """Get an application by name.
 
-        Use :attr:`app` to get this charm's application.
-
         Internally this uses a cache, so asking for the same application two times will
         return the same object.
+
+        To get the application that this unit is part of, use :attr:`CharmBase.app` or :attr:`app`.
         """
         return self._cache.get(Application, app_name)
 
@@ -380,9 +380,10 @@ class Application:
     """Represents a named application in the model.
 
     This might be this charm's application, or might be an application this charm is integrated
-    with. Charmers should not instantiate Application objects directly, but should use
-    :attr:`Model.app` to get the application this unit is part of, or
-    :meth:`Model.get_app` if they need a reference to a given application.
+    with.
+
+    Don't instantiate Application objects directly. To get the application that this unit is
+    part of, use :attr:`CharmBase.app`. To get an application by name, use :meth:`Model.get_app`.
     """
 
     name: str
@@ -426,7 +427,7 @@ class Application:
 
         Example::
 
-            self.model.app.status = ops.BlockedStatus('I need a human to come help me')
+            self.app.status = ops.BlockedStatus('I need a human to come help me')
         """
         if not self._is_our_app:
             return UnknownStatus()
@@ -556,6 +557,9 @@ class Unit:
 
     This might be the current unit, another unit of the charm's application, or a unit of
     another application that the charm is integrated with.
+
+    Don't instantiate Unit objects directly. To get the current unit, use :attr:`CharmBase.unit`.
+    To get a unit by name, use :meth:`Model.get_unit`.
     """
 
     name: str
@@ -609,7 +613,7 @@ class Unit:
 
         Example::
 
-            self.model.unit.status = ops.MaintenanceStatus('reconfiguring the frobnicators')
+            self.unit.status = ops.MaintenanceStatus('reconfiguring the frobnicators')
         """
         if not self._is_our_unit:
             return UnknownStatus()
@@ -1770,16 +1774,23 @@ class Relation:
 
         # self.app will not be None and always be set because of the fallback mechanism above.
         self.app = typing.cast('Application', app)
-        self.data = RelationData(self, our_unit, backend)
 
         # In relation-departed `relation-list` doesn't include the remote unit,
         # but the data should still be available.
         if (
             _remote_unit is not None
             and not is_peer
+            # In practice, the "self.app will not be None" statement above is not
+            # necessarily true. Once https://bugs.launchpad.net/juju/+bug/1960934
+            # is resolved, we should be able to remove the next line.
+            and self.app is not None
             and _remote_unit.name.startswith(f'{self.app.name}/')
         ):
-            self.units.add(_remote_unit)
+            remote_unit = _remote_unit
+        else:
+            remote_unit = None
+
+        self.data = RelationData(self, our_unit, backend, remote_unit)
 
         self._remote_model: RemoteModel | None = None
 
@@ -1975,7 +1986,13 @@ class RelationData(Mapping[Union[Unit, Application], 'RelationDataContent']):
     :attr:`Relation.data`
     """
 
-    def __init__(self, relation: Relation, our_unit: Unit, backend: _ModelBackend):
+    def __init__(
+        self,
+        relation: Relation,
+        our_unit: Unit,
+        backend: _ModelBackend,
+        remote_unit: Unit | None = None,
+    ):
         self.relation = weakref.proxy(relation)
         self._data: dict[Unit | Application, RelationDataContent] = {
             our_unit: RelationDataContent(self.relation, our_unit, backend),
@@ -1989,6 +2006,9 @@ class RelationData(Mapping[Union[Unit, Application], 'RelationDataContent']):
             self._data.update({
                 self.relation.app: RelationDataContent(self.relation, self.relation.app, backend),
             })
+        # The unit might be departing or broken, so not in relation-list, but accessible.
+        if remote_unit is not None and remote_unit not in self._data:
+            self._data[remote_unit] = RelationDataContent(self.relation, remote_unit, backend)
 
     def __contains__(self, key: Unit | Application):
         return key in self._data

{ops-2.23.0.dev0 → ops-2.23.2/test/charms/test_main/lib}/ops/version.py

@@ -19,4 +19,4 @@ This module is NOT to be used when developing charms using ops.
 
 from __future__ import annotations
 
-version: str = '2.23.0.dev0'
+version: str = '2.23.2'

{ops-2.23.0.dev0 → ops-2.23.2}/test/test_model.py

@@ -4421,84 +4421,27 @@ class TestGetCloudSpec:
         assert str(excinfo.value) == 'ERROR cannot access cloud credentials\n'
 
 
-@pytest.mark.skipif(
-    not hasattr(ops.testing, 'Context'), reason='requires optional ops[testing] install'
-)
-def test_departing_unit_in_relations():
-    ctx = ops.testing.Context(
-        ops.CharmBase, meta={'name': 'mycharm', 'requires': {'db': {'interface': 'db'}}}
-    )
-    # In this mocked Juju data, only unit/0 is included.
-    rel = ops.testing.Relation('db', remote_units_data={0: {}}, remote_app_name='db')
-    state_in = ops.testing.State(relations={rel})
-    # We simulate a relation-departed event where the departing unit is unit/1.
-    with ctx(ctx.on.relation_departed(rel, remote_unit=1), state_in) as mgr:
-        mgr.run()
-        # The departing unit, unit/1, should be in the .units set for the relation
-        # even though it was not in the mocked Juju data.
-        assert {unit.name for unit in mgr.charm.model.relations['db'][0].units} == {'db/0', 'db/1'}
-
-
-@pytest.mark.skipif(
-    not hasattr(ops.testing, 'Context'), reason='requires optional ops[testing] install'
-)
-def test_relation_has_correct_units():
-    class Charm(ops.CharmBase):
-        def __init__(self, framework: ops.Framework):
-            super().__init__(framework)
-            framework.observe(self.on['db'].relation_changed, self._on_peer_relation_changed)
-            framework.observe(self.on['peer'].relation_changed, self._on_peer_relation_changed)
-
-        def _on_peer_relation_changed(self, event: ops.RelationChangedEvent):
-            self.event = event
-
-    ctx = ops.testing.Context(
-        Charm,
-        meta={
-            'name': 'mycharm',
-            'requires': {'db': {'interface': 'db'}, 'ingress': {'interface': 'ingress'}},
-            'peers': {'peer': {'interface': 'gossip'}},
-        },
-    )
-    rel1 = ops.testing.Relation(
-        'db', remote_units_data={1: {}, 2: {}, 3: {}}, remote_app_name='test-db'
-    )
-    rel2 = ops.testing.Relation(
-        'ingress', remote_units_data={4: {}, 6: {}}, remote_app_name='test-ingress'
-    )
-    peer = ops.testing.PeerRelation('peer', peers_data={1: {}, 2: {}})
-    state_in = ops.testing.State(relations={rel1, rel2, peer})
-
-    def unit_names(relation: ops.Relation):
-        return {unit.name for unit in relation.units}
-
-    with ctx(ctx.on.relation_changed(peer, remote_unit=1), state_in) as mgr:
-        mgr.run()
-        assert unit_names(mgr.charm.event.relation) == {'mycharm/1', 'mycharm/2'}
-        assert unit_names(mgr.charm.model.relations['peer'][0]) == {'mycharm/1', 'mycharm/2'}
-        assert unit_names(mgr.charm.model.relations['db'][0]) == {
-            'test-db/1',
-            'test-db/2',
-            'test-db/3',
-        }
-        assert unit_names(mgr.charm.model.relations['ingress'][0]) == {
-            'test-ingress/4',
-            'test-ingress/6',
-        }
-
-    with ctx(ctx.on.relation_changed(rel1, remote_unit=1), state_in) as mgr:
-        mgr.run()
-        assert unit_names(mgr.charm.event.relation) == {'test-db/1', 'test-db/2', 'test-db/3'}
-        assert unit_names(mgr.charm.model.relations['peer'][0]) == {'mycharm/1', 'mycharm/2'}
-        assert unit_names(mgr.charm.model.relations['db'][0]) == {
-            'test-db/1',
-            'test-db/2',
-            'test-db/3',
-        }
-        assert unit_names(mgr.charm.model.relations['ingress'][0]) == {
-            'test-ingress/4',
-            'test-ingress/6',
-        }
+def test_departing_unit_data_available(fake_script: FakeScript):
+    fake_script.write('relation-ids', """echo '["db0:1"]'""")
+    fake_script.write('relation-list', """echo '["db/0"]'""")
+    fake_script.write('relation-get', """echo '{"db": "data"}'""")
+
+    meta = ops.charm.CharmMeta({'name': 'mycharm', 'requires': {'db': {'interface': 'db'}}})
+    backend = ops.model._ModelBackend('myapp/0')
+    model = ops.model.Model(meta, backend, remote_unit_name='db/1')
+    relation = model.get_relation('db')
+    assert relation is not None
+    for unit in relation.units:
+        assert relation.data[unit] == {'db': 'data'}
+    unit = model.get_unit('db/1')
+    assert relation.data[unit] == {'db': 'data'}
+    calls = fake_script.calls(clear=True)
+    assert calls[:2] == [
+        ['relation-ids', 'db', '--format=json'],
+        ['relation-list', '-r', '1', '--format=json'],
+    ]
+    assert ['relation-get', '-r', '1', '-', 'db/0', '--format=json'] in calls
+    assert ['relation-get', '-r', '1', '-', 'db/1', '--format=json'] in calls
 
 
 if __name__ == '__main__':

{ops-2.23.0.dev0 → ops-2.23.2}/tox.ini

@@ -47,14 +47,17 @@ passenv =
     # ReadTheDocs builder wants the output in a place of its choosing.
     # https://docs.readthedocs.com/platform/stable/build-customization.html#where-to-put-files
     READTHEDOCS_OUTPUT
+    # docs/conf.py uses these variables to build URLs of static assets on error pages.
+    READTHEDOCS_CANONICAL_URL
+    READTHEDOCS_VERSION
 commands =
-    sphinx-build -W --keep-going docs/ {env:READTHEDOCS_OUTPUT:docs/_build}/html
+    sphinx-build -W --keep-going -b dirhtml docs/ {env:READTHEDOCS_OUTPUT:docs/_build}/html
 
 [testenv:docs-live]
 description = Live development: build the Sphinx docs with autoreloading enabled
 dependency_groups = docs
 commands =
-    sphinx-autobuild docs/ docs/_build/html --watch ops/ --port 8000 {posargs}
+    sphinx-autobuild -b dirhtml docs/ docs/_build/html --watch ops/ --port 8000 {posargs}
 
 [testenv:format]
 description = Apply coding style standards to code