ops 2.23.0.dev0__tar.gz → 3.0.0__tar.gz

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

@@ -1,3 +1,69 @@
+# 3.0.0 - 02 July 2025
+
+The minimum version of Python for Ops 3.x is 3.10.
+
+## Documentation
+
+* Be consistent with recommending self.app and self.unit (#1856)
+
+## 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-3.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ops
-Version: 2.23.0.dev0
+Version: 3.0.0
 Summary: The Python library behind great charms
 Author: The Charm Tech team at Canonical Ltd.
 Project-URL: Homepage, https://ops.readthedocs.io/en/latest/
@@ -15,7 +15,7 @@ Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: System Administrators
 Classifier: Operating System :: MacOS :: MacOS X
 Classifier: Operating System :: POSIX :: Linux
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: PyYAML==6.*
@@ -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==8.0.0; extra == "testing"
 Provides-Extra: tracing
-Requires-Dist: ops-tracing==2.23.0.dev0; extra == "tracing"
+Requires-Dist: ops-tracing==3.0.0; extra == "tracing"
 Provides-Extra: harness
 Dynamic: license-file
 

{ops-2.23.0.dev0 → ops-3.0.0}/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-3.0.0}/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()

{ops-2.23.0.dev0/test/charms/test_main/lib → ops-3.0.0}/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 = '3.0.0'

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ops
-Version: 2.23.0.dev0
+Version: 3.0.0
 Summary: The Python library behind great charms
 Author: The Charm Tech team at Canonical Ltd.
 Project-URL: Homepage, https://ops.readthedocs.io/en/latest/
@@ -15,7 +15,7 @@ Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: System Administrators
 Classifier: Operating System :: MacOS :: MacOS X
 Classifier: Operating System :: POSIX :: Linux
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: PyYAML==6.*
@@ -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==8.0.0; extra == "testing"
 Provides-Extra: tracing
-Requires-Dist: ops-tracing==2.23.0.dev0; extra == "tracing"
+Requires-Dist: ops-tracing==3.0.0; extra == "tracing"
 Provides-Extra: harness
 Dynamic: license-file
 

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

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

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

@@ -2,7 +2,7 @@
 name = "ops"
 description = "The Python library behind great charms"
 readme = "README.md"
-requires-python = ">=3.8"
+requires-python = ">=3.10"
 authors = [
     {name="The Charm Tech team at Canonical Ltd."},
 ]
@@ -26,10 +26,10 @@ dynamic = ["version"]
 
 [project.optional-dependencies]
 testing = [
-    "ops-scenario==7.23.0.dev0",
+    "ops-scenario==8.0.0",
 ]
 tracing = [
-    "ops-tracing==2.23.0.dev0",
+    "ops-tracing==3.0.0",
 ]
 # Empty for now, because Harness is bundled with the base install, but allow
 # specifying the extra to ease transition later.
@@ -133,6 +133,7 @@ aggressive = 3
 # Linting tools configuration
 [tool.ruff]
 line-length = 99
+# FIXME
 target-version = "py38"
 extend-exclude = ["docs/conf.py", "docs/.sphinx/"]
 
@@ -321,7 +322,7 @@ builtins-ignorelist = ["id", "min", "map", "range", "type", "TimeoutError", "Con
 include = ["ops/*.py", "ops/_private/*.py", "test/*.py", "test/charms/*/src/*.py", "testing/src/*.py"]
 exclude = ["tracing/*"]
 extraPaths = ["testing", "tracing"]
-pythonVersion = "3.8" # check no python > 3.8 features are used
+pythonVersion = "3.10" # check no python > 3.10 features are used
 pythonPlatform = "All"
 typeCheckingMode = "strict"
 reportIncompatibleMethodOverride = false

{ops-2.23.0.dev0 → ops-3.0.0}/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-3.0.0/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()

{ops-2.23.0.dev0 → ops-3.0.0/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 = '3.0.0'

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

@@ -75,7 +75,7 @@ allowlist_externals = cp
 dependency_groups = unit, static
 commands = pyright {posargs}
 
-[testenv:py{3.8,3.10,3.12}-unit]
+[testenv:py{3.10,3.12}-unit]
 runner = uv-venv-lock-runner
 base=unit
 
@@ -151,7 +151,7 @@ commands =
         {[vars]testing_tst_path}benchmark \
         {posargs}
 
-[testenv:py{3.8,3.10,3.12}-pebble]
+[testenv:py{3.10,3.12}-pebble]
 runner = uv-venv-lock-runner
 base=pebble