plone.api 2.5.2__tar.gz → 3.0.0__tar.gz

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

@@ -9,6 +9,61 @@
 
 <!-- towncrier release notes start -->
 
+## 3.0.0 (2026-05-07)
+
+
+### Documentation
+
+- Added example to construct a complex email. @1letter 
+
+## 3.0.0a3 (2026-03-25)
+
+
+### Bug fixes
+
+- Fix ``plone.api.user.create()`` to respect ``use_uuid_as_userid`` and
+  ``use_email_as_login`` registry settings, as well as custom ``IUserIdGenerator``
+  and ``ILoginNameGenerator`` utilities. #4292
+
+
+### Internal
+
+- Update configuration files @plone 
+
+
+### Tests
+
+- Fix `test_create_raises_unicodedecodeerror` for deferred indexing queue processing since Products.CMFCore 3.9.
+  @jensens #602
+
+## 3.0.0a2 (2025-12-18)
+
+
+### Bug fixes:
+
+- Fix deprecation warnings for `INonInstallable` and `get_installer`.  @mauritsvanrees 
+
+
+### Internal:
+
+- Improve trigger for RTD PR preview builds. @stevepiercy #591
+- Ignore the `/_build` directory from building documentation. @stevepiercy #598
+
+## 3.0.0a1 (2025-11-26)
+
+
+### Breaking changes:
+
+- Replace ``pkg_resources`` namespace with PEP 420 native namespace.
+  Support only Plone 6.2 and Python 3.10+. #3928
+
+## 2.5.3 (2025-09-10)
+
+
+### Bug fixes:
+
+- Drop `pkg_resources` usage @gforcada #4126
+
 ## 2.5.2 (2025-06-05)
 
 

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

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: plone.api
-Version: 2.5.2
+Version: 3.0.0
 Summary: A Plone API.
 Home-page: https://github.com/plone/plone.api
 Author: Plone Foundation
@@ -19,17 +19,18 @@ Platform: Any
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Web Environment
 Classifier: Framework :: Plone
-Classifier: Framework :: Plone :: 6.0
+Classifier: Framework :: Plone :: 6.2
 Classifier: Framework :: Plone :: Core
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Requires-Python: >=3.8
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: Acquisition
@@ -37,6 +38,7 @@ Requires-Dist: Products.statusmessages
 Requires-Dist: Products.PlonePAS
 Requires-Dist: Products.CMFPlone
 Requires-Dist: decorator
+Requires-Dist: plone.app.users
 Requires-Dist: plone.app.uuid
 Requires-Dist: plone.app.dexterity
 Requires-Dist: plone.app.intid
@@ -46,7 +48,6 @@ Requires-Dist: plone.dexterity
 Requires-Dist: plone.i18n
 Requires-Dist: plone.registry
 Requires-Dist: plone.uuid
-Requires-Dist: setuptools
 Requires-Dist: zope.globalrequest
 Requires-Dist: Products.CMFCore
 Requires-Dist: z3c.relationfield
@@ -71,6 +72,7 @@ Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: keywords
 Dynamic: license
+Dynamic: license-file
 Dynamic: platform
 Dynamic: project-url
 Dynamic: provides-extra
@@ -132,6 +134,61 @@ Continuous Integration
 
 <!-- towncrier release notes start -->
 
+## 3.0.0 (2026-05-07)
+
+
+### Documentation
+
+- Added example to construct a complex email. @1letter 
+
+## 3.0.0a3 (2026-03-25)
+
+
+### Bug fixes
+
+- Fix ``plone.api.user.create()`` to respect ``use_uuid_as_userid`` and
+  ``use_email_as_login`` registry settings, as well as custom ``IUserIdGenerator``
+  and ``ILoginNameGenerator`` utilities. #4292
+
+
+### Internal
+
+- Update configuration files @plone 
+
+
+### Tests
+
+- Fix `test_create_raises_unicodedecodeerror` for deferred indexing queue processing since Products.CMFCore 3.9.
+  @jensens #602
+
+## 3.0.0a2 (2025-12-18)
+
+
+### Bug fixes:
+
+- Fix deprecation warnings for `INonInstallable` and `get_installer`.  @mauritsvanrees 
+
+
+### Internal:
+
+- Improve trigger for RTD PR preview builds. @stevepiercy #591
+- Ignore the `/_build` directory from building documentation. @stevepiercy #598
+
+## 3.0.0a1 (2025-11-26)
+
+
+### Breaking changes:
+
+- Replace ``pkg_resources`` namespace with PEP 420 native namespace.
+  Support only Plone 6.2 and Python 3.10+. #3928
+
+## 2.5.3 (2025-09-10)
+
+
+### Bug fixes:
+
+- Drop `pkg_resources` usage @gforcada #4126
+
 ## 2.5.2 (2025-06-05)
 
 

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

@@ -257,6 +257,109 @@ api.portal.send_email(
 %     'attachment; filename="report.xml',
 %     payloads[1]['Content-Disposition']
 % )
+% mailhost.messages.clear()
+
+The following code is a more complex example that constructs an email with a file attachment, HTML, plain text, and mail headers to control the mail response.
+
+```python
+from email.encoders import encode_base64
+from email.header import Header
+from email.mime.base import MIMEBase
+from email.mime.multipart import MIMEMultipart
+from email.mime.text import MIMEText
+from plone import api
+
+# we need a message part to bundle the HTML and Plain Text
+textmsgpart = MIMEMultipart("alternative")
+
+# create plain text part of email
+plaintextpart = MIMEText("Fill out your plain text", "plain", "utf-8")
+
+# create html text of email
+html = "<html><body><p>fill out your text in HTML</p></body></html>"
+htmlpart = MIMEText(html, "html", "utf-8")
+
+# bundle the parts
+textmsgpart.attach(plaintextpart)
+textmsgpart.attach(htmlpart)
+
+# handle the file attachment
+
+# Create a dummy PDF as NamedBlobFile
+from plone.namedfile.file import NamedBlobFile
+
+# Minimal PDF content (a valid but nearly empty PDF)
+pdf_content = b"""%PDF-1.4
+1 0 obj<</Type/Catalog/Pages 2 0 R>>endobj
+2 0 obj<</Type/Pages/Count 1/Kids[3 0 R]>>endobj
+3 0 obj<</Type/Page/Parent 2 0 R/MediaBox[0 0 612 792]/Contents 4 0 R>>endobj
+4 0 obj<</Length 44>>stream
+BT /F1 12 Tf 100 700 Td (Hello World) Tj ET
+endstream endobj
+xref
+0 5
+0000000000 65535 f
+0000000009 00000 n
+0000000056 00000 n
+0000000115 00000 n
+0000000214 00000 n
+trailer<</Size 5/Root 1 0 R>>
+startxref
+315
+%%EOF"""
+
+attachment = NamedBlobFile(
+    data=pdf_content,
+    contentType='application/pdf',
+    filename='document.pdf'
+)
+
+filepart = MIMEBase("application", "pdf")
+filepart.set_payload(attachment.data)
+encode_base64(filepart)
+filepart.add_header(
+    "Content-Disposition",
+    "attachment",
+    filename=(Header(attachment.filename, "utf-8").encode()),
+)
+
+# we need a mixed Multipart Message to bundle the text bundle and the attachment
+msg = MIMEMultipart("mixed")
+msg["From"] = "sender@abc"
+msg["To"] = "recipient@zzz"
+msg["Subject"] = "The Mail Subject"
+msg["Reply-To"] = "community@plone.org"
+msg["Return-Path"] = "error@xxx"
+
+# add the text message bundle
+msg.attach(textmsgpart)
+
+# add the file attachment
+msg.attach(filepart)
+
+# send with plone.api
+api.portal.send_email(
+    sender=msg["From"],
+    recipient=msg["To"],
+    subject=msg["Subject"],
+    body=msg.as_string()
+)
+```
+
+% invisible-code-block: python
+%
+% self.assertEqual(len(mailhost.messages), 1)
+%
+% msg = message_from_bytes(mailhost.messages[0])
+% payloads = msg.get_payload()
+% self.assertTrue(len(payloads) == 2)
+% self.assertTrue(msg['Reply-To'] == 'community@plone.org')
+% text_payloads = payloads[0].get_payload()
+% self.assertEqual(len(text_payloads), 2)
+% self.assertIn(
+%     'attachment; filename',
+%     payloads[1]['Content-Disposition']
+% )
 % api.portal.PRINTINGMAILHOST_ENABLED = False
 % mailhost.reset()
 

{plone_api-2.5.2 → plone_api-3.0.0}/pyproject.toml

@@ -1,8 +1,8 @@
 # Generated from:
-# https://github.com/plone/meta/tree/main/config/default
+# https://github.com/plone/meta/tree/main/src/plone/meta/default
 # See the inline comments on how to expand/tweak this configuration file
 [build-system]
-requires = ["setuptools>=68.2,<77"]
+requires = ["setuptools>=68.2,<83", "wheel"]
 
 [tool.towncrier]
 directory = "news/"
@@ -14,27 +14,27 @@ underlines = ["", "", ""]
 
 [[tool.towncrier.type]]
 directory = "breaking"
-name = "Breaking changes:"
+name = "Breaking changes"
 showcontent = true
 
 [[tool.towncrier.type]]
 directory = "feature"
-name = "New features:"
+name = "New features"
 showcontent = true
 
 [[tool.towncrier.type]]
 directory = "bugfix"
-name = "Bug fixes:"
+name = "Bug fixes"
 showcontent = true
 
 [[tool.towncrier.type]]
 directory = "internal"
-name = "Internal:"
+name = "Internal"
 showcontent = true
 
 [[tool.towncrier.type]]
 directory = "documentation"
-name = "Documentation:"
+name = "Documentation"
 showcontent = true
 
 [[tool.towncrier.type]]
@@ -62,7 +62,7 @@ profile = "plone"
 ##
 
 [tool.black]
-target-version = ["py38"]
+target-version = ["py310"]
 
 ##
 # Add extra configuration options in .meta.toml:
@@ -73,7 +73,7 @@ target-version = ["py38"]
 ##
 
 [tool.codespell]
-ignore-words-list = "discreet,manuel"
+ignore-words-list = "discreet,assertin,thet,manuel,checkin"
 skip = "*.po,"
 ##
 # Add extra configuration options in .meta.toml:
@@ -121,6 +121,7 @@ Zope = [
   'Products.CMFCore', 'Products.CMFDynamicViewFTI',
 ]
 python-dateutil = ['dateutil']
+pytest-plone = ['pytest', 'zope.pytestlayer', 'plone.testing', 'plone.app.testing']
 ignore-packages = ['Products.PrintingMailHost', 'plone.app.iterate',]
 
 ##
@@ -142,11 +143,11 @@ ignore = [
     "dependabot.yml",
     "mx.ini",
     "tox.ini",
+    # From `.meta.toml`, pyproject.check_manifest_ignores.
     "*.cfg",
     ".editorconfig",
     ".readthedocs.yaml",
-    "constraints_plone52.txt",
-    "constraints_plone60.txt",
+    "constraints_plone62.txt",
     "constraints.txt",
     "fix-converted-myst.py",
     "Makefile",

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

@@ -1,9 +1,7 @@
 from pathlib import Path
-from setuptools import find_packages
 from setuptools import setup
 
-
-version = "2.5.2"
+version = "3.0.0"
 
 long_description = "\n".join(
     [Path("README.md").read_text(), Path("CHANGES.md").read_text()]
@@ -18,20 +16,18 @@ setup(
     author="Plone Foundation",
     author_email="plone-developers@lists.sourceforge.net",
     license="GPL version 2",
-    packages=find_packages("src"),
-    package_dir={"": "src"},
-    namespace_packages=["plone"],
     include_package_data=True,
     zip_safe=False,
     url="https://github.com/plone/plone.api",
     keywords="plone api",
-    python_requires=">=3.8",
+    python_requires=">=3.10",
     install_requires=[
         "Acquisition",
         "Products.statusmessages",
         "Products.PlonePAS",
         "Products.CMFPlone",
         "decorator",
+        "plone.app.users",
         "plone.app.uuid",
         "plone.app.dexterity",
         "plone.app.intid",
@@ -41,7 +37,6 @@ setup(
         "plone.i18n",
         "plone.registry",
         "plone.uuid",
-        "setuptools",
         "zope.globalrequest",
         "Products.CMFCore",
         "z3c.relationfield",
@@ -68,16 +63,17 @@ setup(
         "Development Status :: 5 - Production/Stable",
         "Environment :: Web Environment",
         "Framework :: Plone",
-        "Framework :: Plone :: 6.0",
+        "Framework :: Plone :: 6.2",
         "Framework :: Plone :: Core",
         "Intended Audience :: Developers",
         "License :: OSI Approved :: GNU General Public License v2 (GPLv2)",
         "Operating System :: OS Independent",
         "Programming Language :: Python",
-        "Programming Language :: Python :: 3.8",
-        "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+        "Programming Language :: Python :: 3.13",
+        "Programming Language :: Python :: 3.14",
     ],
     platforms="Any",
     project_urls={

{plone_api-2.5.2 → plone_api-3.0.0}/src/plone/api/addon.py

@@ -2,22 +2,19 @@
 
 from dataclasses import dataclass
 from functools import lru_cache
+from importlib.metadata import distribution
+from importlib.metadata import PackageNotFoundError
 from plone.api import portal
 from plone.api.exc import InvalidParameterError
 from plone.api.validation import required_parameters
+from plone.base.interfaces import INonInstallable
+from plone.base.utils import get_installer
 from Products.CMFPlone.controlpanel.browser.quickinstaller import InstallerView
-from Products.CMFPlone.interfaces import INonInstallable
-from Products.CMFPlone.utils import get_installer
 from Products.GenericSetup import EXTENSION
-from typing import Dict
-from typing import List
-from typing import Tuple
 from zope.component import getAllUtilitiesRegisteredFor
 from zope.globalrequest import getRequest
 
 import logging
-import pkg_resources
-
 
 logger = logging.getLogger("plone.api.addon")
 
@@ -38,8 +35,8 @@ __all__ = [
 class NonInstallableAddons:
     """Set of add-ons not available for installation."""
 
-    profiles: List[str]
-    products: List[str]
+    profiles: list[str]
+    products: list[str]
 
 
 @dataclass
@@ -51,14 +48,14 @@ class AddonInformation:
     title: str
     description: str
 
-    upgrade_profiles: Dict
-    other_profiles: List[List]
-    install_profile: Dict
-    uninstall_profile: Dict
+    upgrade_profiles: dict
+    other_profiles: list[list]
+    install_profile: dict
+    uninstall_profile: dict
     profile_type: str
-    upgrade_info: Dict
+    upgrade_info: dict
     valid: bool
-    flags: List[str]
+    flags: list[str]
 
     def __repr__(self) -> str:
         """Return a string representation of this object."""
@@ -97,7 +94,7 @@ def _get_non_installable_addons() -> NonInstallableAddons:
 
 
 @lru_cache(maxsize=1)
-def _cached_addons() -> Tuple[Tuple[str, AddonInformation]]:
+def _cached_addons() -> tuple[tuple[str, AddonInformation]]:
     """Return information about add-ons in this installation.
 
     :returns: Tuple of tuples with add-on id and AddonInformation.
@@ -197,7 +194,7 @@ def _update_addon_info(
     return addon
 
 
-def _get_addons() -> List[AddonInformation]:
+def _get_addons() -> list[AddonInformation]:
     """Return an updated list of add-on information.
 
     :returns: List of AddonInformation.
@@ -211,7 +208,7 @@ def _get_addons() -> List[AddonInformation]:
     return result
 
 
-def get_addons(limit: str = "") -> List[AddonInformation]:
+def get_addons(limit: str = "") -> list[AddonInformation]:
     """List add-ons in this Plone site.
 
     :param limit: Limit list of add-ons.
@@ -238,7 +235,7 @@ def get_addons(limit: str = "") -> List[AddonInformation]:
     return addons
 
 
-def get_addon_ids(limit: str = "") -> List[str]:
+def get_addon_ids(limit: str = "") -> list[str]:
     """List add-ons ids in this Plone site.
 
     :param limit: Limit list of add-ons.
@@ -258,9 +255,9 @@ def get_addon_ids(limit: str = "") -> List[str]:
 def get_version(addon: str) -> str:
     """Return the version of the product (package)."""
     try:
-        dist = pkg_resources.get_distribution(addon)
+        dist = distribution(addon)
         return dist.version
-    except pkg_resources.DistributionNotFound:
+    except PackageNotFoundError:
         if "." in addon:
             return ""
     return get_version(f"Products.{addon}")

{plone_api-2.5.2 → plone_api-3.0.0}/src/plone/api/content.py

@@ -25,7 +25,6 @@ from zope.interface import providedBy
 import transaction
 import uuid
 
-
 _marker = []
 
 # Maximum number of attempts to generate a unique random ID

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

@@ -18,7 +18,6 @@ from zope.globalrequest import getRequest
 import traceback
 import Zope2
 
-
 IS_TEST = None
 
 

{plone_api-2.5.2 → plone_api-3.0.0}/src/plone/api/portal.py

@@ -24,7 +24,6 @@ from zope.schema.interfaces import IVocabularyFactory
 import datetime as dtime
 import re
 
-
 logger = getLogger("plone.api.portal")
 
 try:

{plone_api-2.5.2 → plone_api-3.0.0}/src/plone/api/relation.py

@@ -26,7 +26,6 @@ from zope.lifecycleevent import modified
 
 import logging
 
-
 try:
     distribution("plone.app.iterate")
 except PackageNotFoundError:

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

@@ -257,6 +257,109 @@ api.portal.send_email(
 %     'attachment; filename="report.xml',
 %     payloads[1]['Content-Disposition']
 % )
+% mailhost.messages.clear()
+
+The following code is a more complex example that constructs an email with a file attachment, HTML, plain text, and mail headers to control the mail response.
+
+```python
+from email.encoders import encode_base64
+from email.header import Header
+from email.mime.base import MIMEBase
+from email.mime.multipart import MIMEMultipart
+from email.mime.text import MIMEText
+from plone import api
+
+# we need a message part to bundle the HTML and Plain Text
+textmsgpart = MIMEMultipart("alternative")
+
+# create plain text part of email
+plaintextpart = MIMEText("Fill out your plain text", "plain", "utf-8")
+
+# create html text of email
+html = "<html><body><p>fill out your text in HTML</p></body></html>"
+htmlpart = MIMEText(html, "html", "utf-8")
+
+# bundle the parts
+textmsgpart.attach(plaintextpart)
+textmsgpart.attach(htmlpart)
+
+# handle the file attachment
+
+# Create a dummy PDF as NamedBlobFile
+from plone.namedfile.file import NamedBlobFile
+
+# Minimal PDF content (a valid but nearly empty PDF)
+pdf_content = b"""%PDF-1.4
+1 0 obj<</Type/Catalog/Pages 2 0 R>>endobj
+2 0 obj<</Type/Pages/Count 1/Kids[3 0 R]>>endobj
+3 0 obj<</Type/Page/Parent 2 0 R/MediaBox[0 0 612 792]/Contents 4 0 R>>endobj
+4 0 obj<</Length 44>>stream
+BT /F1 12 Tf 100 700 Td (Hello World) Tj ET
+endstream endobj
+xref
+0 5
+0000000000 65535 f
+0000000009 00000 n
+0000000056 00000 n
+0000000115 00000 n
+0000000214 00000 n
+trailer<</Size 5/Root 1 0 R>>
+startxref
+315
+%%EOF"""
+
+attachment = NamedBlobFile(
+    data=pdf_content,
+    contentType='application/pdf',
+    filename='document.pdf'
+)
+
+filepart = MIMEBase("application", "pdf")
+filepart.set_payload(attachment.data)
+encode_base64(filepart)
+filepart.add_header(
+    "Content-Disposition",
+    "attachment",
+    filename=(Header(attachment.filename, "utf-8").encode()),
+)
+
+# we need a mixed Multipart Message to bundle the text bundle and the attachment
+msg = MIMEMultipart("mixed")
+msg["From"] = "sender@abc"
+msg["To"] = "recipient@zzz"
+msg["Subject"] = "The Mail Subject"
+msg["Reply-To"] = "community@plone.org"
+msg["Return-Path"] = "error@xxx"
+
+# add the text message bundle
+msg.attach(textmsgpart)
+
+# add the file attachment
+msg.attach(filepart)
+
+# send with plone.api
+api.portal.send_email(
+    sender=msg["From"],
+    recipient=msg["To"],
+    subject=msg["Subject"],
+    body=msg.as_string()
+)
+```
+
+% invisible-code-block: python
+%
+% self.assertEqual(len(mailhost.messages), 1)
+%
+% msg = message_from_bytes(mailhost.messages[0])
+% payloads = msg.get_payload()
+% self.assertTrue(len(payloads) == 2)
+% self.assertTrue(msg['Reply-To'] == 'community@plone.org')
+% text_payloads = payloads[0].get_payload()
+% self.assertEqual(len(text_payloads), 2)
+% self.assertIn(
+%     'attachment; filename',
+%     payloads[1]['Content-Disposition']
+% )
 % api.portal.PRINTINGMAILHOST_ENABLED = False
 % mailhost.reset()
 

{plone_api-2.5.2 → plone_api-3.0.0}/src/plone/api/tests/test_addon.py

@@ -6,7 +6,6 @@ from plone.api.tests.base import INTEGRATION_TESTING
 
 import unittest
 
-
 ADDON = "plone.session"