plone.api 2.5.0__tar.gz → 2.5.2__tar.gz

{plone_api-2.5.0 → plone_api-2.5.2}/CHANGES.md

@@ -9,6 +9,27 @@
 
 <!-- towncrier release notes start -->
 
+## 2.5.2 (2025-06-05)
+
+
+### Bug fixes:
+
+- Make plone.api.exc.UserNotFoundError message more informative by including the not found username [@ale-rt] #585
+
+## 2.5.1 (2025-05-02)
+
+
+### Internal:
+
+- Add project URLs to display on PyPI. @stevepiercy #582
+
+
+### Documentation:
+
+- Add missing members to API methods and sort items. @stevepiercy #579
+- Resolve Sphinx warning `duplicate object description of plone` by using `currentmodule` instead of `module`. This avoids creating duplicate entries in the index. They are already documented in the `docs/api/*.md` files. @stevepiercy #581
+- Pin plone-sphinx-theme to prepare for PLIP 4097. See https://github.com/plone/Products.CMFPlone/issues/4097. @stevepiercy #583
+
 ## 2.5.0 (2025-03-25)
 
 

{plone_api-2.5.0 → plone_api-2.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: plone.api
-Version: 2.5.0
+Version: 2.5.2
 Summary: A Plone API.
 Home-page: https://github.com/plone/plone.api
 Author: Plone Foundation
@@ -9,6 +9,11 @@ License: GPL version 2
 Project-URL: Documentation, https://6.docs.plone.org/plone.api/index.html
 Project-URL: Changelog, https://github.com/plone/plone.api/blob/main/CHANGES.md
 Project-URL: Issue Tracker, https://github.com/plone/plone.api/issues
+Project-URL: Repository, https://github.com/plone/plone.api
+Project-URL: Sponsor, https://github.com/sponsors/plone
+Project-URL: Discord, https://discord.com/channels/786421998426521600/786421998426521603
+Project-URL: Mastodon, https://plone.social/@plone
+Project-URL: YouTube, https://www.youtube.com/@plonecms
 Keywords: plone api
 Platform: Any
 Classifier: Development Status :: 5 - Production/Stable
@@ -127,6 +132,27 @@ Continuous Integration
 
 <!-- towncrier release notes start -->
 
+## 2.5.2 (2025-06-05)
+
+
+### Bug fixes:
+
+- Make plone.api.exc.UserNotFoundError message more informative by including the not found username [@ale-rt] #585
+
+## 2.5.1 (2025-05-02)
+
+
+### Internal:
+
+- Add project URLs to display on PyPI. @stevepiercy #582
+
+
+### Documentation:
+
+- Add missing members to API methods and sort items. @stevepiercy #579
+- Resolve Sphinx warning `duplicate object description of plone` by using `currentmodule` instead of `module`. This avoids creating duplicate entries in the index. They are already documented in the `docs/api/*.md` files. @stevepiercy #581
+- Pin plone-sphinx-theme to prepare for PLIP 4097. See https://github.com/plone/Products.CMFPlone/issues/4097. @stevepiercy #583
+
 ## 2.5.0 (2025-03-25)
 
 

{plone_api-2.5.0 → plone_api-2.5.2}/docs/addon.md

@@ -8,8 +8,9 @@ myst:
 ---
 
 ```{eval-rst}
-.. module:: plone
+.. currentmodule:: plone.api.addon
 ```
+% The Sphinx directive `currentmodule` is used to both run `code-block` examples via [Manuel](https://manuel.readthedocs.io/en/latest/#code-blocks-1) and to avoid duplicating an index entry that is already provided by its counterpart in `docs/api/*.md`.
 
 (chapter-addons)=
 

{plone_api-2.5.0/src/plone/api/tests/doctests → plone_api-2.5.2/docs}/content.md

@@ -8,8 +8,10 @@ myst:
 ---
 
 ```{eval-rst}
-.. module:: plone
+.. currentmodule:: plone.api.content
 ```
+% The Sphinx directive `currentmodule` is used to both run `code-block` examples via [Manuel](https://manuel.readthedocs.io/en/latest/#code-blocks-1) and to avoid duplicating an index entry that is already provided by its counterpart in `docs/api/*.md`.
+
 
 (chapter-content)=
 

{plone_api-2.5.0/src/plone/api/tests/doctests → plone_api-2.5.2/docs}/env.md

@@ -8,9 +8,10 @@ myst:
 ---
 
 ```{eval-rst}
-.. module:: plone
-    :no-index:
+.. currentmodule:: plone.api.env
 ```
+% The Sphinx directive `currentmodule` is used to both run `code-block` examples via [Manuel](https://manuel.readthedocs.io/en/latest/#code-blocks-1) and to avoid duplicating an index entry that is already provided by its counterpart in `docs/api/*.md`.
+
 
 (chapter-env)=
 

{plone_api-2.5.0/src/plone/api/tests/doctests → plone_api-2.5.2/docs}/group.md

@@ -8,9 +8,9 @@ myst:
 ---
 
 ```{eval-rst}
-.. module:: plone
-    :no-index:
+.. currentmodule:: plone.api.group
 ```
+% The Sphinx directive `currentmodule` is used to both run `code-block` examples via [Manuel](https://manuel.readthedocs.io/en/latest/#code-blocks-1) and to avoid duplicating an index entry that is already provided by its counterpart in `docs/api/*.md`.
 
 (chapter-groups)=
 

{plone_api-2.5.0 → plone_api-2.5.2}/docs/portal.md

@@ -8,9 +8,9 @@ myst:
 ---
 
 ```{eval-rst}
-.. module:: plone
-    :no-index:
+.. currentmodule:: plone.api.portal
 ```
+% The Sphinx directive `currentmodule` is used to both run `code-block` examples via [Manuel](https://manuel.readthedocs.io/en/latest/#code-blocks-1) and to avoid duplicating an index entry that is already provided by its counterpart in `docs/api/*.md`.
 
 (chapter-portal)=
 

{plone_api-2.5.0 → plone_api-2.5.2}/docs/relation.md

@@ -8,9 +8,9 @@ myst:
 ---
 
 ```{eval-rst}
-.. module:: plone
-    :no-index:
+.. currentmodule:: plone.api.relation
 ```
+% The Sphinx directive `currentmodule` is used to both run `code-block` examples via [Manuel](https://manuel.readthedocs.io/en/latest/#code-blocks-1) and to avoid duplicating an index entry that is already provided by its counterpart in `docs/api/*.md`.
 
 (chapter-relation)=
 

{plone_api-2.5.0/src/plone/api/tests/doctests → plone_api-2.5.2/docs}/user.md

@@ -8,9 +8,10 @@ myst:
 ---
 
 ```{eval-rst}
-.. module:: plone
-    :no-index:
+.. currentmodule:: plone.api.user
 ```
+% The Sphinx directive `currentmodule` is used to both run `code-block` examples via [Manuel](https://manuel.readthedocs.io/en/latest/#code-blocks-1) and to avoid duplicating an index entry that is already provided by its counterpart in `docs/api/*.md`.
+
 
 (chapter-users)=
 

{plone_api-2.5.0 → plone_api-2.5.2}/setup.py

@@ -3,7 +3,7 @@ from setuptools import find_packages
 from setuptools import setup
 
 
-version = "2.5.0"
+version = "2.5.2"
 
 long_description = "\n".join(
     [Path("README.md").read_text(), Path("CHANGES.md").read_text()]
@@ -84,5 +84,10 @@ setup(
         "Documentation": "https://6.docs.plone.org/plone.api/index.html",
         "Changelog": "https://github.com/plone/plone.api/blob/main/CHANGES.md",
         "Issue Tracker": "https://github.com/plone/plone.api/issues",
+        "Repository": "https://github.com/plone/plone.api",
+        "Sponsor": "https://github.com/sponsors/plone",
+        "Discord": "https://discord.com/channels/786421998426521600/786421998426521603",
+        "Mastodon": "https://plone.social/@plone",
+        "YouTube": "https://www.youtube.com/@plonecms",
     },
 )

{plone_api-2.5.0 → plone_api-2.5.2}/src/plone/api/env.py

@@ -59,7 +59,7 @@ def adopt_user(username=None, user=None):
                 user = unwrapped.__of__(acl_users)
                 break
         else:
-            raise UserNotFoundError
+            raise UserNotFoundError(username)
 
     return _adopt_user(user)
 

{plone_api-2.5.0 → plone_api-2.5.2}/src/plone/api/group.py

@@ -85,7 +85,7 @@ def get_groups(username=None, user=None):
     if username:
         user = user_get(username=username)
         if not user:
-            raise UserNotFoundError
+            raise UserNotFoundError(username)
 
     group_tool = portal.get_tool("portal_groups")
 
@@ -157,7 +157,7 @@ def add_user(groupname=None, group=None, username=None, user=None):
     if username:
         user = user_get(username=username)
         if not user:
-            raise UserNotFoundError
+            raise UserNotFoundError(username)
 
     user_id = user.id
     group_id = groupname or group.id
@@ -194,7 +194,7 @@ def remove_user(groupname=None, group=None, username=None, user=None):
     if username:
         user = user_get(username=username)
         if not user:
-            raise UserNotFoundError
+            raise UserNotFoundError(username)
     user_id = user.id
     group_id = groupname or group.id
     portal_groups = portal.get_tool("portal_groups")

{plone_api-2.5.0 → plone_api-2.5.2}/src/plone/api/tests/doctests/addon.md

@@ -8,8 +8,9 @@ myst:
 ---
 
 ```{eval-rst}
-.. module:: plone
+.. currentmodule:: plone.api.addon
 ```
+% The Sphinx directive `currentmodule` is used to both run `code-block` examples via [Manuel](https://manuel.readthedocs.io/en/latest/#code-blocks-1) and to avoid duplicating an index entry that is already provided by its counterpart in `docs/api/*.md`.
 
 (chapter-addons)=
 

{plone_api-2.5.0/docs → plone_api-2.5.2/src/plone/api/tests/doctests}/content.md

@@ -8,8 +8,10 @@ myst:
 ---
 
 ```{eval-rst}
-.. module:: plone
+.. currentmodule:: plone.api.content
 ```
+% The Sphinx directive `currentmodule` is used to both run `code-block` examples via [Manuel](https://manuel.readthedocs.io/en/latest/#code-blocks-1) and to avoid duplicating an index entry that is already provided by its counterpart in `docs/api/*.md`.
+
 
 (chapter-content)=
 

{plone_api-2.5.0/docs → plone_api-2.5.2/src/plone/api/tests/doctests}/env.md

@@ -8,9 +8,10 @@ myst:
 ---
 
 ```{eval-rst}
-.. module:: plone
-    :no-index:
+.. currentmodule:: plone.api.env
 ```
+% The Sphinx directive `currentmodule` is used to both run `code-block` examples via [Manuel](https://manuel.readthedocs.io/en/latest/#code-blocks-1) and to avoid duplicating an index entry that is already provided by its counterpart in `docs/api/*.md`.
+
 
 (chapter-env)=
 

{plone_api-2.5.0/docs → plone_api-2.5.2/src/plone/api/tests/doctests}/group.md

@@ -8,9 +8,9 @@ myst:
 ---
 
 ```{eval-rst}
-.. module:: plone
-    :no-index:
+.. currentmodule:: plone.api.group
 ```
+% The Sphinx directive `currentmodule` is used to both run `code-block` examples via [Manuel](https://manuel.readthedocs.io/en/latest/#code-blocks-1) and to avoid duplicating an index entry that is already provided by its counterpart in `docs/api/*.md`.
 
 (chapter-groups)=
 

{plone_api-2.5.0 → plone_api-2.5.2}/src/plone/api/tests/doctests/portal.md

@@ -8,9 +8,9 @@ myst:
 ---
 
 ```{eval-rst}
-.. module:: plone
-    :no-index:
+.. currentmodule:: plone.api.portal
 ```
+% The Sphinx directive `currentmodule` is used to both run `code-block` examples via [Manuel](https://manuel.readthedocs.io/en/latest/#code-blocks-1) and to avoid duplicating an index entry that is already provided by its counterpart in `docs/api/*.md`.
 
 (chapter-portal)=
 

{plone_api-2.5.0 → plone_api-2.5.2}/src/plone/api/tests/doctests/relation.md

@@ -8,9 +8,9 @@ myst:
 ---
 
 ```{eval-rst}
-.. module:: plone
-    :no-index:
+.. currentmodule:: plone.api.relation
 ```
+% The Sphinx directive `currentmodule` is used to both run `code-block` examples via [Manuel](https://manuel.readthedocs.io/en/latest/#code-blocks-1) and to avoid duplicating an index entry that is already provided by its counterpart in `docs/api/*.md`.
 
 (chapter-relation)=
 

{plone_api-2.5.0/docs → plone_api-2.5.2/src/plone/api/tests/doctests}/user.md

@@ -8,9 +8,10 @@ myst:
 ---
 
 ```{eval-rst}
-.. module:: plone
-    :no-index:
+.. currentmodule:: plone.api.user
 ```
+% The Sphinx directive `currentmodule` is used to both run `code-block` examples via [Manuel](https://manuel.readthedocs.io/en/latest/#code-blocks-1) and to avoid duplicating an index entry that is already provided by its counterpart in `docs/api/*.md`.
+
 
 (chapter-users)=
 

{plone_api-2.5.0 → plone_api-2.5.2}/src/plone/api/tests/test_group.py

@@ -152,8 +152,9 @@ class TestPloneApiGroup(unittest.TestCase):
         """Test retrieving of groups for a user that does not exist."""
         from plone.api.exc import UserNotFoundError
 
-        with self.assertRaises(UserNotFoundError):
+        with self.assertRaises(UserNotFoundError) as exc:
             api.group.get_groups(username="theurbanspaceman")
+        self.assertEqual(str(exc.exception), "theurbanspaceman")
 
     def test_get_groups_anonymous(self):
         from AccessControl.users import nobody
@@ -239,8 +240,9 @@ class TestPloneApiGroup(unittest.TestCase):
         """Test adding a user that does not exist to a group."""
         from plone.api.exc import UserNotFoundError
 
-        with self.assertRaises(UserNotFoundError):
+        with self.assertRaises(UserNotFoundError) as exc:
             api.group.add_user(username="jane", groupname="staff")
+        self.assertEqual(str(exc.exception), "jane")
 
     def test_add_user_username(self):
         """Test adding a user to a group by username."""
@@ -327,8 +329,9 @@ class TestPloneApiGroup(unittest.TestCase):
 
         api.group.create(groupname="staff")
         group = api.group.get(groupname="staff")
-        with self.assertRaises(UserNotFoundError):
+        with self.assertRaises(UserNotFoundError) as exc:
             api.group.remove_user(group=group, username="iamnothere")
+        self.assertEqual(str(exc.exception), "iamnothere")
 
     def test_grant_roles(self):
         """Test grant roles."""

{plone_api-2.5.0 → plone_api-2.5.2}/src/plone/api/tests/test_user.py

@@ -342,8 +342,9 @@ class TestPloneApiUser(unittest.TestCase):
         """Test get roles for a user that does not exist."""
         from plone.api.exc import UserNotFoundError
 
-        with self.assertRaises(UserNotFoundError):
+        with self.assertRaises(UserNotFoundError) as exc:
             api.user.get_roles(username="theurbanspaceman")
+        self.assertEqual(str(exc.exception), "theurbanspaceman")
 
     def test_get_roles_anonymous(self):
         """Test get_roles for an anonymous user."""
@@ -509,8 +510,9 @@ class TestPloneApiUser(unittest.TestCase):
         """Test get_permissions for a user that does not exist."""
         from plone.api.exc import UserNotFoundError
 
-        with self.assertRaises(UserNotFoundError):
+        with self.assertRaises(UserNotFoundError) as exc:
             api.user.get_permissions(username="ming")
+        self.assertEqual(str(exc.exception), "ming")
 
     def test_get_permissions_context(self):
         """Test get permissions on some context."""

{plone_api-2.5.0 → plone_api-2.5.2}/src/plone/api/user.py

@@ -232,7 +232,7 @@ def get_roles(username=None, user=None, obj=None, inherit=True):
         user = portal_membership.getMemberById(username)
 
     if user is None:
-        raise UserNotFoundError
+        raise UserNotFoundError(username)
 
     if obj is not None:
         if inherit:

{plone_api-2.5.0 → plone_api-2.5.2}/src/plone.api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: plone.api
-Version: 2.5.0
+Version: 2.5.2
 Summary: A Plone API.
 Home-page: https://github.com/plone/plone.api
 Author: Plone Foundation
@@ -9,6 +9,11 @@ License: GPL version 2
 Project-URL: Documentation, https://6.docs.plone.org/plone.api/index.html
 Project-URL: Changelog, https://github.com/plone/plone.api/blob/main/CHANGES.md
 Project-URL: Issue Tracker, https://github.com/plone/plone.api/issues
+Project-URL: Repository, https://github.com/plone/plone.api
+Project-URL: Sponsor, https://github.com/sponsors/plone
+Project-URL: Discord, https://discord.com/channels/786421998426521600/786421998426521603
+Project-URL: Mastodon, https://plone.social/@plone
+Project-URL: YouTube, https://www.youtube.com/@plonecms
 Keywords: plone api
 Platform: Any
 Classifier: Development Status :: 5 - Production/Stable
@@ -127,6 +132,27 @@ Continuous Integration
 
 <!-- towncrier release notes start -->
 
+## 2.5.2 (2025-06-05)
+
+
+### Bug fixes:
+
+- Make plone.api.exc.UserNotFoundError message more informative by including the not found username [@ale-rt] #585
+
+## 2.5.1 (2025-05-02)
+
+
+### Internal:
+
+- Add project URLs to display on PyPI. @stevepiercy #582
+
+
+### Documentation:
+
+- Add missing members to API methods and sort items. @stevepiercy #579
+- Resolve Sphinx warning `duplicate object description of plone` by using `currentmodule` instead of `module`. This avoids creating duplicate entries in the index. They are already documented in the `docs/api/*.md` files. @stevepiercy #581
+- Pin plone-sphinx-theme to prepare for PLIP 4097. See https://github.com/plone/Products.CMFPlone/issues/4097. @stevepiercy #583
+
 ## 2.5.0 (2025-03-25)