plone.api 2.2.3__tar.gz → 2.2.5__tar.gz

{plone_api-2.2.3 → plone_api-2.2.5}/CHANGES.rst

@@ -8,6 +8,38 @@ Changelog
 
 .. towncrier release notes start
 
+2.2.5 (2025-01-24)
+------------------
+
+Bug fixes:
+
+
+- Fix api.content.get(path=path) when a item in the path is not accessible to the user.
+  [pbauer] (#549)
+- Fix DeprecationWarnings. [maurits] (#4090)
+
+
+Documentation:
+
+
+- Preview docs on Read the Docs instead of Netlify. @stevepiercy (#545)
+- Remove Netlify stuff, follow up to #545. @stevepiercy
+  - Sort and remove duplicate entries in `pyproject.toml`
+  - Remove unused docs requirements.
+  - Fix comments and remove unnecessary steps from `tox.ini`.
+  - Enable copy button for code blocks.
+  - Add linkcheck to documentation of documentation. (#546)
+
+
+2.2.4 (2024-12-16)
+------------------
+
+Documentation:
+
+
+- Remove references to unused Coveralls. @stevepiercy (#543)
+
+
 2.2.3 (2024-10-23)
 ------------------
 

{plone_api-2.2.3 → plone_api-2.2.5}/MANIFEST.in

@@ -13,6 +13,8 @@ global-exclude *.pyc
 include pyproject.toml
 recursive-exclude news *
 exclude news
+recursive-exclude .vscode *
+exclude .readthedocs.yaml
 
 # added by check-manifest
 recursive-include src *.py

{plone_api-2.2.3 → plone_api-2.2.5}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.1
 Name: plone.api
-Version: 2.2.3
+Version: 2.2.5
 Summary: A Plone API.
 Home-page: https://github.com/plone/plone.api
 Author: Plone Foundation
 Author-email: plone-developers@lists.sourceforge.net
 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/master/CHANGES.rst
+Project-URL: Changelog, https://github.com/plone/plone.api/blob/main/CHANGES.rst
 Project-URL: Issue Tracker, https://github.com/plone/plone.api/issues
 Keywords: plone api
 Platform: Any
@@ -34,8 +34,8 @@ Requires-Dist: decorator
 Requires-Dist: plone.app.uuid
 Requires-Dist: plone.app.dexterity
 Requires-Dist: plone.app.intid
-Requires-Dist: plone.app.layout
 Requires-Dist: plone.app.linkintegrity
+Requires-Dist: plone.base
 Requires-Dist: plone.dexterity
 Requires-Dist: plone.i18n
 Requires-Dist: plone.registry
@@ -99,9 +99,6 @@ Issues
 Continuous Integration
     tested on [GitHub Actions](https://github.com/plone/plone.api/actions).
 
-Code Coverage
-    is measured at [Coveralls.io](https://coveralls.io/github/plone/plone.api).
-
 
 Changelog
 =========
@@ -113,6 +110,38 @@ Changelog
 
 .. towncrier release notes start
 
+2.2.5 (2025-01-24)
+------------------
+
+Bug fixes:
+
+
+- Fix api.content.get(path=path) when a item in the path is not accessible to the user.
+  [pbauer] (#549)
+- Fix DeprecationWarnings. [maurits] (#4090)
+
+
+Documentation:
+
+
+- Preview docs on Read the Docs instead of Netlify. @stevepiercy (#545)
+- Remove Netlify stuff, follow up to #545. @stevepiercy
+  - Sort and remove duplicate entries in `pyproject.toml`
+  - Remove unused docs requirements.
+  - Fix comments and remove unnecessary steps from `tox.ini`.
+  - Enable copy button for code blocks.
+  - Add linkcheck to documentation of documentation. (#546)
+
+
+2.2.4 (2024-12-16)
+------------------
+
+Documentation:
+
+
+- Remove references to unused Coveralls. @stevepiercy (#543)
+
+
 2.2.3 (2024-10-23)
 ------------------
 

{plone_api-2.2.3 → plone_api-2.2.5}/README.md

@@ -40,6 +40,3 @@ Issues
 Continuous Integration
     tested on [GitHub Actions](https://github.com/plone/plone.api/actions).
 
-Code Coverage
-    is measured at [Coveralls.io](https://coveralls.io/github/plone/plone.api).
-

{plone_api-2.2.3 → plone_api-2.2.5}/docs/contribute.md

@@ -12,17 +12,14 @@ myst:
 This section describes how to contribute to the `plone.api` project.
 It extends {doc}`plone:contributing/index`.
 
-
 ## Prerequisites
 
 Prepare your system by installing prerequisites.
 
-
 ### System libraries
 
 You need to install system libraries, as described in {ref}`plone:plone-prerequisites-label`, with the exception of GNU make.
 
-
 ### tox
 
 [tox](https://tox.wiki/en/stable/index.html) automates and standardizes testing in Python.
@@ -49,7 +46,6 @@ Once installed, set up the git hook scripts to run on every commit.
 pre-commit install
 ```
 
-
 ## Create development environment
 
 After satisfying the prerequisites, you are ready to create your development environment.
@@ -81,7 +77,6 @@ tox -e livehtml       # build, serve, and reload changes to documentation
 tox -l                # list all tox environments
 ```
 
-
 (git-workflow)=
 
 ## git
@@ -89,24 +84,22 @@ tox -l                # list all tox environments
 Use the following git branches when contributing to `plone.api`.
 
 feature branches
-:   All development for a new feature or bug fix must be done on a new branch.
+: All development for a new feature or bug fix must be done on a new branch.
 
-`master`
-:   Pull requests should be made from a feature branch against the `master` branch.
-    When features and bug fixes are complete and approved, they are merged into the `master` branch.
+`main`
+: Pull requests should be made from a feature branch against the `main` branch.
+When features and bug fixes are complete and approved, they are merged into the `main` branch.
 
 ```{seealso}
 {ref}`plone:contributing-core-work-with-git-label`
 ```
 
-
 ## Continuous integration
 
 `plone.api` uses GitHub workflows for continuous integration.
-On every push to the `master` branch, GitHub runs its workflows for all tests and code quality checks.
+On every push to the `main` branch, GitHub runs its workflows for all tests and code quality checks.
 GitHub workflows are configured in the directory `.github/workflows` at the root of this package.
 
-
 ## Documentation
 
 For every feature change or addition to `plone.api`, you must add documentation of it.
@@ -128,8 +121,13 @@ Alternatively, you can automatically reload changes to the documentation as you
 tox -e livehtml
 ```
 
-The [`plone.api` documentation](https://6.docs.plone.org/plone.api) is automatically generated from the documentation source files when its submodule is updated in the [main Plone `documentation` repository](https://github.com/plone/documentation/).
+You can run a link checker on documentation.
+
+```shell
+tox -e linkcheck
+```
 
+The [`plone.api` documentation](https://6.docs.plone.org/plone.api) is automatically generated from the documentation source files when its submodule is updated in the [main Plone `documentation` repository](https://github.com/plone/documentation/).
 
 ## Add a function to an existing module
 
@@ -171,8 +169,8 @@ def foo(path=None, UID=None):
 %
 % from plone.api.exc import InvalidParameterError
 % self.assertRaises(
-%     InvalidParameterError,
-%     lambda: foo("/plone/blog", "abcd001")
+% InvalidParameterError,
+% lambda: foo("/plone/blog", "abcd001")
 % )
 
 Add documentation in {file}`docs/api/content.md`.
@@ -235,10 +233,8 @@ The function references the narrative documentation via the label `content-foo-e
 The narrative documentation references the API function documentation via `` {meth}`api.content.foo` ``.
 The documentation is rendered with a link from the API reference to the narrative documentation, which in turn links back to the API reference.
 
-
 ## Resources
 
--   {doc}`plone:index`
--   [Source code](https://github.com/plone/plone.api)
--   [Issue tracker](https://github.com/plone/plone.api/issues)
--   [Code Coverage](https://coveralls.io/github/plone/plone.api)
+- {doc}`plone:index`
+- [Source code](https://github.com/plone/plone.api)
+- [Issue tracker](https://github.com/plone/plone.api/issues)

{plone_api-2.2.3 → plone_api-2.2.5}/docs/portal.md

@@ -45,7 +45,7 @@ Assuming there is a document `english_page` in a folder `en`, which is the navig
 % invisible-code-block: python
 %
 % from plone import api
-% from plone.app.layout.navigation.interfaces import INavigationRoot
+% from plone.base.interfaces import INavigationRoot
 % from zope.interface import alsoProvides
 %
 % portal = api.portal.get()

{plone_api-2.2.3 → plone_api-2.2.5}/pyproject.toml

@@ -140,14 +140,14 @@ ignore = [
     "dependabot.yml",
     "mx.ini",
     "tox.ini",
-    ".editorconfig",
     "*.cfg",
+    ".editorconfig",
+    ".readthedocs.yaml",
     "constraints_plone52.txt",
     "constraints_plone60.txt",
     "constraints.txt",
     "fix-converted-myst.py",
     "Makefile",
-    "netlify.toml",
     "requirements-docs.txt",
     "requirements.txt",
 

{plone_api-2.2.3 → plone_api-2.2.5}/setup.py

@@ -3,7 +3,7 @@ from setuptools import find_packages
 from setuptools import setup
 
 
-version = "2.2.3"
+version = "2.2.5"
 
 long_description = (
     f"{Path('README.md').read_text()}\n"
@@ -36,8 +36,8 @@ setup(
         "plone.app.uuid",
         "plone.app.dexterity",
         "plone.app.intid",
-        "plone.app.layout",
         "plone.app.linkintegrity",
+        "plone.base",
         "plone.dexterity",
         "plone.i18n",
         "plone.registry",
@@ -82,7 +82,7 @@ setup(
     platforms="Any",
     project_urls={
         "Documentation": "https://6.docs.plone.org/plone.api/index.html",
-        "Changelog": "https://github.com/plone/plone.api/blob/master/CHANGES.rst",
+        "Changelog": "https://github.com/plone/plone.api/blob/main/CHANGES.rst",
         "Issue Tracker": "https://github.com/plone/plone.api/issues",
     },
 )

{plone_api-2.2.3 → plone_api-2.2.5}/src/plone/api/content.py

@@ -133,7 +133,12 @@ def get(path=None, UID=None):
                 relative_path=path,
             )
         try:
-            content = site.restrictedTraverse(path)
+            path = path.split("/")
+            if len(path) > 1:
+                parent = site.unrestrictedTraverse(path[:-1])
+                content = parent.restrictedTraverse(path[-1])
+            else:
+                content = site.restrictedTraverse(path[-1])
         except (KeyError, AttributeError):
             return None  # When no object is found don't raise an error
         else:

{plone_api-2.2.3 → plone_api-2.2.5}/src/plone/api/portal.py

@@ -7,7 +7,7 @@ from logging import getLogger
 from plone.api.exc import CannotGetPortalError
 from plone.api.exc import InvalidParameterError
 from plone.api.validation import required_parameters
-from plone.app.layout.navigation.root import getNavigationRootObject
+from plone.base.navigationroot import get_navigation_root_object
 from plone.registry.interfaces import IRegistry
 from Products.CMFCore.interfaces import ISiteRoot
 from Products.CMFCore.utils import getToolByName
@@ -86,7 +86,7 @@ def get_navigation_root(context=None):
     :Example: :ref:`portal-get-navigation-root-example`
     """
     context = aq_inner(context)
-    return getNavigationRootObject(context, get())
+    return get_navigation_root_object(context, get())
 
 
 @required_parameters("name")

{plone_api-2.2.3 → plone_api-2.2.5}/src/plone/api/relation.py

@@ -10,8 +10,8 @@ from plone.api.validation import at_least_one_of
 from plone.api.validation import required_parameters
 from plone.app.linkintegrity.handlers import modifiedContent
 from plone.app.linkintegrity.utils import referencedRelationship
+from plone.base.utils import base_hasattr
 from plone.dexterity.utils import iterSchemataForType
-from Products.CMFPlone.utils import base_hasattr
 from z3c.relationfield import event
 from z3c.relationfield import RelationValue
 from z3c.relationfield.schema import Relation

{plone_api-2.2.3 → plone_api-2.2.5}/src/plone/api/testing.zcml

@@ -14,7 +14,7 @@
       title="plone.api: Test fixture"
       description="Extension profile to configure a test fixture"
       provides="Products.GenericSetup.interfaces.EXTENSION"
-      for="Products.CMFPlone.interfaces.ITestCasePloneSiteRoot"
+      for="plone.base.interfaces.ITestCasePloneSiteRoot"
       directory="profiles/testfixture"
       />
 

{plone_api-2.2.3 → plone_api-2.2.5}/src/plone/api/tests/doctests/portal.md

@@ -45,7 +45,7 @@ Assuming there is a document `english_page` in a folder `en`, which is the navig
 % invisible-code-block: python
 %
 % from plone import api
-% from plone.app.layout.navigation.interfaces import INavigationRoot
+% from plone.base.interfaces import INavigationRoot
 % from zope.interface import alsoProvides
 %
 % portal = api.portal.get()

{plone_api-2.2.3 → plone_api-2.2.5}/src/plone/api/tests/test_content.py

@@ -8,9 +8,9 @@ from plone import api
 from plone.api.content import _parse_object_provides_query
 from plone.api.tests.base import INTEGRATION_TESTING
 from plone.app.contenttypes.interfaces import IFolder
-from plone.app.layout.navigation.interfaces import INavigationRoot
 from plone.app.linkintegrity.exceptions import LinkIntegrityNotificationException
 from plone.app.textfield import RichTextValue
+from plone.base.interfaces import INavigationRoot
 from plone.indexer import indexer
 from plone.uuid.interfaces import IMutableUUID
 from plone.uuid.interfaces import IUUIDGenerator
@@ -192,7 +192,7 @@ class TestPloneApiContent(unittest.TestCase):
             folder.setConstrainTypesMode(ENABLED)
             folder.setLocallyAllowedTypes(("News Item",))
         else:  # DX
-            from Products.CMFPlone.interfaces import ISelectableConstrainTypes
+            from plone.base.interfaces import ISelectableConstrainTypes
 
             constraints = ISelectableConstrainTypes(folder)
             constraints.setConstrainTypesMode(ENABLED)
@@ -478,6 +478,16 @@ class TestPloneApiContent(unittest.TestCase):
         # title is an attribute
         self.assertIsNone(api.content.get("/about/team/title"))
 
+    def test_get_of_content_in_inaccessible_container(self):
+        """Test getting items in a inaccessible container.
+        Worked in Plone 5.1 but raised Unauthorized since 5.2."""
+        api.content.transition(obj=self.team, transition="publish")
+        with api.env.adopt_roles(["Member"]):
+            team_by_path = api.content.get("/about/team")
+            self.assertEqual(self.team, team_by_path)
+            team_by_uid = api.content.get(UID=self.team.UID())
+            self.assertEqual(self.team, team_by_uid)
+
     def test_move_constraints(self):
         """Test the constraints for moving content."""
         from plone.api.exc import MissingParameterError

{plone_api-2.2.3 → plone_api-2.2.5}/src/plone/api/tests/test_portal.py

@@ -7,7 +7,7 @@ from plone.api import content
 from plone.api import env
 from plone.api import portal
 from plone.api.tests.base import INTEGRATION_TESTING
-from plone.app.layout.navigation.interfaces import INavigationRoot
+from plone.base.interfaces import INavigationRoot
 from plone.registry import field
 from plone.registry.interfaces import IRegistry
 from plone.registry.record import Record

{plone_api-2.2.3 → plone_api-2.2.5}/src/plone.api.egg-info/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.1
 Name: plone.api
-Version: 2.2.3
+Version: 2.2.5
 Summary: A Plone API.
 Home-page: https://github.com/plone/plone.api
 Author: Plone Foundation
 Author-email: plone-developers@lists.sourceforge.net
 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/master/CHANGES.rst
+Project-URL: Changelog, https://github.com/plone/plone.api/blob/main/CHANGES.rst
 Project-URL: Issue Tracker, https://github.com/plone/plone.api/issues
 Keywords: plone api
 Platform: Any
@@ -34,8 +34,8 @@ Requires-Dist: decorator
 Requires-Dist: plone.app.uuid
 Requires-Dist: plone.app.dexterity
 Requires-Dist: plone.app.intid
-Requires-Dist: plone.app.layout
 Requires-Dist: plone.app.linkintegrity
+Requires-Dist: plone.base
 Requires-Dist: plone.dexterity
 Requires-Dist: plone.i18n
 Requires-Dist: plone.registry
@@ -99,9 +99,6 @@ Issues
 Continuous Integration
     tested on [GitHub Actions](https://github.com/plone/plone.api/actions).
 
-Code Coverage
-    is measured at [Coveralls.io](https://coveralls.io/github/plone/plone.api).
-
 
 Changelog
 =========
@@ -113,6 +110,38 @@ Changelog
 
 .. towncrier release notes start
 
+2.2.5 (2025-01-24)
+------------------
+
+Bug fixes:
+
+
+- Fix api.content.get(path=path) when a item in the path is not accessible to the user.
+  [pbauer] (#549)
+- Fix DeprecationWarnings. [maurits] (#4090)
+
+
+Documentation:
+
+
+- Preview docs on Read the Docs instead of Netlify. @stevepiercy (#545)
+- Remove Netlify stuff, follow up to #545. @stevepiercy
+  - Sort and remove duplicate entries in `pyproject.toml`
+  - Remove unused docs requirements.
+  - Fix comments and remove unnecessary steps from `tox.ini`.
+  - Enable copy button for code blocks.
+  - Add linkcheck to documentation of documentation. (#546)
+
+
+2.2.4 (2024-12-16)
+------------------
+
+Documentation:
+
+
+- Remove references to unused Coveralls. @stevepiercy (#543)
+
+
 2.2.3 (2024-10-23)
 ------------------
 

{plone_api-2.2.3 → plone_api-2.2.5}/src/plone.api.egg-info/requires.txt

@@ -5,8 +5,8 @@ decorator
 plone.app.uuid
 plone.app.dexterity
 plone.app.intid
-plone.app.layout
 plone.app.linkintegrity
+plone.base
 plone.dexterity
 plone.i18n
 plone.registry

{plone_api-2.2.3 → plone_api-2.2.5}/tox.ini

@@ -255,7 +255,7 @@ allowlist_externals =
     echo
 
 [testenv:plone6docs]
-# New docs with sphinx-book-theme
+# New docs with plone-sphinx-theme
 # See [testenv:docs] for classic documentation
 basepython = python3.11
 skip_install = False
@@ -271,6 +271,18 @@ commands =
     mkdir -p {toxinidir}/_build/plone6docs
     sphinx-build -b html -d _build/plone6docs/doctrees docs _build/plone6docs/html
 
+[testenv:rtd-preview]
+# Build docs on Read the Docs to preview pull requests using plone-sphinx-theme
+basepython = python3.11
+skip_install = False
+extras =
+    tests
+deps =
+    -r requirements-docs.txt
+commands =
+    python -VV
+    sphinx-build -b html -d "{env:READTHEDOCS_OUTPUT}"/doctrees/ docs "{env:READTHEDOCS_OUTPUT}"/html/
+
 [testenv:docs]
 basepython = python3.9
 skip_install = False