plone.api 2.1.0__tar.gz → 2.2.1__tar.gz

{plone.api-2.1.0 → plone_api-2.2.1}/CHANGES.rst

@@ -8,6 +8,40 @@ Changelog
 
 .. towncrier release notes start
 
+2.2.1 (2024-06-26)
+------------------
+
+Bug fixes:
+
+
+- Removed `portal_properties` from documentation and tests.
+  [maurits] (#125)
+
+
+2.2.0 (2024-05-06)
+------------------
+
+New features:
+
+
+- Report if a permission does not exist
+  when calling `api.user.has_permission`.
+  [gforcada] (#515)
+
+
+Bug fixes:
+
+
+- In relation.create: Fix edge case where existing RelationList value is None. @davisagli (#535)
+
+
+Internal:
+
+
+- Update configuration files.
+  [plone devs] (cfffba8c)
+
+
 2.1.0 (2024-02-22)
 ------------------
 
@@ -84,8 +118,8 @@ Bug fixes:
 
 
 - Do not run GitHub Actions tests twice.
-  Only run GitHub Actions tests when commiting directly against master or main or
-  opening a pull request agains master or main. This avoids to run the same test
+  Only run GitHub Actions tests when committing directly against master or main or
+  opening a pull request against master or main. This avoids to run the same test
   suite for the same environment twice.
   [thet] (#0)
 - Mockup TinyMCE settings: Remove unused AtD related views.
@@ -474,7 +508,7 @@ Bug fixes:
 - Simplify the ``plone.api.content.delete`` method.
   [thet]
 
-- content.copy with safe_id=False should raise it's own exeception. Fixes #340
+- content.copy with safe_id=False should raise it's own exception. Fixes #340
   [jaroel]
 
 

{plone.api-2.1.0 → plone_api-2.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: plone.api
-Version: 2.1.0
+Version: 2.2.1
 Summary: A Plone API.
 Home-page: https://github.com/plone/plone.api
 Author: Plone Foundation
@@ -22,24 +22,37 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
 License-File: LICENSE
 Requires-Dist: Products.statusmessages
+Requires-Dist: Products.PlonePAS
+Requires-Dist: Products.CMFPlone
 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.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
+Requires-Dist: zc.relation
+Requires-Dist: Zope
+Requires-Dist: zope.intid
 Provides-Extra: test
-Requires-Dist: Products.CMFPlone; extra == "test"
+Requires-Dist: borg.localrole; extra == "test"
 Requires-Dist: manuel>=1.11.2; extra == "test"
-Requires-Dist: plone.app.dexterity; extra == "test"
-Requires-Dist: plone.app.intid; extra == "test"
+Requires-Dist: plone.app.contenttypes; extra == "test"
+Requires-Dist: plone.app.textfield; extra == "test"
 Requires-Dist: plone.app.testing; extra == "test"
+Requires-Dist: plone.testing; extra == "test"
 Requires-Dist: plone.indexer; extra == "test"
 Requires-Dist: plone.registry; extra == "test"
-Requires-Dist: z3c.relationfield; extra == "test"
-Requires-Dist: zope.testrunner; extra == "test"
 
 # plone.api
 
@@ -88,7 +101,6 @@ Code Coverage
     is measured at [Coveralls.io](https://coveralls.io/github/plone/plone.api).
 
 
-
 Changelog
 =========
 
@@ -99,6 +111,40 @@ Changelog
 
 .. towncrier release notes start
 
+2.2.1 (2024-06-26)
+------------------
+
+Bug fixes:
+
+
+- Removed `portal_properties` from documentation and tests.
+  [maurits] (#125)
+
+
+2.2.0 (2024-05-06)
+------------------
+
+New features:
+
+
+- Report if a permission does not exist
+  when calling `api.user.has_permission`.
+  [gforcada] (#515)
+
+
+Bug fixes:
+
+
+- In relation.create: Fix edge case where existing RelationList value is None. @davisagli (#535)
+
+
+Internal:
+
+
+- Update configuration files.
+  [plone devs] (cfffba8c)
+
+
 2.1.0 (2024-02-22)
 ------------------
 
@@ -175,8 +221,8 @@ Bug fixes:
 
 
 - Do not run GitHub Actions tests twice.
-  Only run GitHub Actions tests when commiting directly against master or main or
-  opening a pull request agains master or main. This avoids to run the same test
+  Only run GitHub Actions tests when committing directly against master or main or
+  opening a pull request against master or main. This avoids to run the same test
   suite for the same environment twice.
   [thet] (#0)
 - Mockup TinyMCE settings: Remove unused AtD related views.
@@ -565,7 +611,7 @@ Bug fixes:
 - Simplify the ``plone.api.content.delete`` method.
   [thet]
 
-- content.copy with safe_id=False should raise it's own exeception. Fixes #340
+- content.copy with safe_id=False should raise it's own exception. Fixes #340
   [jaroel]
 
 
@@ -1157,7 +1203,6 @@ Fixes:
   [davisagli, fulv, iElectric, jcerjak, jonstahl, kcleong, mauritsvanrees,
   wamdam, witsch, zupo]
 
-
 License
 =======
 

{plone.api-2.1.0 → plone_api-2.2.1}/docs/about.md

@@ -70,12 +70,7 @@ In general, importing and using an API looks something like this:
 % invisible-code-block: python
 %
 % from plone import api
-% from plone.api.exc import InvalidParameterError
-% try:
-%     api.portal.set_registry_record('plone.use_email_as_login', True)
-% except InvalidParameterError:
-%     portal = api.portal.get()
-%     portal.portal_properties.site_properties.use_email_as_login = True
+% api.portal.set_registry_record('plone.use_email_as_login', True)
 
 ```python
 from plone import api

{plone.api-2.1.0 → plone_api-2.2.1}/docs/user.md

@@ -26,12 +26,7 @@ If your portal is configured to use emails as usernames, you just need to pass i
 % invisible-code-block: python
 %
 % from plone import api
-% from plone.api.exc import InvalidParameterError
-% try:
-%     api.portal.set_registry_record('plone.use_email_as_login', True)
-% except InvalidParameterError:
-%     portal = api.portal.get()
-%     portal.portal_properties.site_properties.use_email_as_login = True
+% api.portal.set_registry_record('plone.use_email_as_login', True)
 
 ```python
 from plone import api
@@ -47,11 +42,7 @@ Otherwise, you also need to pass in the username of the new user.
 
 % invisible-code-block: python
 %
-% try:
-%     api.portal.set_registry_record('plone.use_email_as_login', False)
-% except InvalidParameterError:
-%     portal = api.portal.get()
-%     portal.portal_properties.site_properties.use_email_as_login = False
+% api.portal.set_registry_record('plone.use_email_as_login', False)
 
 ```python
 user = api.user.create(email='jane@plone.org', username='jane')

plone_api-2.2.1/pyproject.toml

@@ -0,0 +1,177 @@
+# Generated from:
+# https://github.com/plone/meta/tree/main/config/default
+# See the inline comments on how to expand/tweak this configuration file
+[build-system]
+requires = ["setuptools>=68.2"]
+
+[tool.towncrier]
+directory = "news/"
+filename = "CHANGES.rst"
+title_format = "{version} ({project_date})"
+underlines = ["-", ""]
+
+[[tool.towncrier.type]]
+directory = "breaking"
+name = "Breaking changes:"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "feature"
+name = "New features:"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "bugfix"
+name = "Bug fixes:"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "internal"
+name = "Internal:"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "documentation"
+name = "Documentation:"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "tests"
+name = "Tests"
+showcontent = true
+
+##
+# Add extra configuration options in .meta.toml:
+#  [pyproject]
+#  towncrier_extra_lines = """
+#  extra_configuration
+#  """
+##
+
+[tool.isort]
+profile = "plone"
+
+##
+# Add extra configuration options in .meta.toml:
+#  [pyproject]
+#  isort_extra_lines = """
+#  extra_configuration
+#  """
+##
+
+[tool.black]
+target-version = ["py38"]
+
+##
+# Add extra configuration options in .meta.toml:
+#  [pyproject]
+#  black_extra_lines = """
+#  extra_configuration
+#  """
+##
+
+[tool.codespell]
+ignore-words-list = "discreet,manuel"
+skip = "*.po,"
+##
+# Add extra configuration options in .meta.toml:
+#  [pyproject]
+#  codespell_ignores = "foo,bar"
+#  codespell_skip = "*.po,*.map,package-lock.json"
+##
+
+[tool.dependencychecker]
+Zope = [
+  # Zope own provided namespaces
+  'App', 'OFS', 'Products.Five', 'Products.OFSP', 'Products.PageTemplates',
+  'Products.SiteAccess', 'Shared', 'Testing', 'ZPublisher', 'ZTUtils',
+  'Zope2', 'webdav', 'zmi',
+  # ExtensionClass own provided namespaces
+  'ExtensionClass', 'ComputedAttribute', 'MethodObject',
+  # Zope dependencies
+  'AccessControl', 'Acquisition', 'AuthEncoding', 'beautifulsoup4', 'BTrees',
+  'cffi', 'Chameleon', 'DateTime', 'DocumentTemplate',
+  'MultiMapping', 'multipart', 'PasteDeploy', 'Persistence', 'persistent',
+  'pycparser', 'python-gettext', 'pytz', 'RestrictedPython', 'roman',
+  'soupsieve', 'transaction', 'waitress', 'WebOb', 'WebTest', 'WSGIProxy2',
+  'z3c.pt', 'zc.lockfile', 'ZConfig', 'zExceptions', 'ZODB', 'zodbpickle',
+  'zope.annotation', 'zope.browser', 'zope.browsermenu', 'zope.browserpage',
+  'zope.browserresource', 'zope.cachedescriptors', 'zope.component',
+  'zope.configuration', 'zope.container', 'zope.contentprovider',
+  'zope.contenttype', 'zope.datetime', 'zope.deferredimport',
+  'zope.deprecation', 'zope.dottedname', 'zope.event', 'zope.exceptions',
+  'zope.filerepresentation', 'zope.globalrequest', 'zope.hookable',
+  'zope.i18n', 'zope.i18nmessageid', 'zope.interface', 'zope.lifecycleevent',
+  'zope.location', 'zope.pagetemplate', 'zope.processlifetime', 'zope.proxy',
+  'zope.ptresource', 'zope.publisher', 'zope.schema', 'zope.security',
+  'zope.sequencesort', 'zope.site', 'zope.size', 'zope.structuredtext',
+  'zope.tal', 'zope.tales', 'zope.testbrowser', 'zope.testing',
+  'zope.traversing', 'zope.viewlet'
+]
+'Products.CMFCore' = [
+  'docutils', 'five.localsitemanager', 'Missing', 'Products.BTreeFolder2',
+  'Products.GenericSetup', 'Products.MailHost', 'Products.PythonScripts',
+  'Products.StandardCacheManagers', 'Products.ZCatalog', 'Record',
+  'zope.sendmail', 'Zope'
+]
+'plone.base' = [
+  'plone.batching', 'plone.registry', 'plone.schema','plone.z3cform',
+  'Products.CMFCore', 'Products.CMFDynamicViewFTI',
+]
+python-dateutil = ['dateutil']
+ignore-packages = ['Products.PrintingMailHost', 'plone.app.iterate',]
+
+##
+# Add extra configuration options in .meta.toml:
+#  [pyproject]
+#  dependencies_ignores = "['zestreleaser.towncrier']"
+#  dependencies_mappings = [
+#    "gitpython = ['git']",
+#    "pygithub = ['github']",
+#  ]
+##
+
+[tool.check-manifest]
+ignore = [
+    ".editorconfig",
+    ".flake8",
+    ".meta.toml",
+    ".pre-commit-config.yaml",
+    "dependabot.yml",
+    "mx.ini",
+    "tox.ini",
+    ".editorconfig",
+    "*.cfg",
+    "constraints_plone52.txt",
+    "constraints_plone60.txt",
+    "constraints.txt",
+    "fix-converted-myst.py",
+    "Makefile",
+    "netlify.toml",
+    "requirements-docs.txt",
+    "requirements.txt",
+
+]
+
+##
+# Add extra configuration options in .meta.toml:
+#  [pyproject]
+#  check_manifest_ignores = """
+#      "*.map.js",
+#      "*.pyc",
+#  """
+#  check_manifest_extra_lines = """
+#  ignore-bad-ideas = [
+#      "some/test/file/PKG-INFO",
+#  ]
+#  """
+##
+
+
+##
+# Add extra configuration options in .meta.toml:
+#  [pyproject]
+#  extra_lines = """
+#  _your own configuration lines_
+#  """
+##

plone_api-2.2.1/setup.cfg

@@ -0,0 +1,23 @@
+[coverage:run]
+branch = True
+source = 
+	src
+omit = 
+	*.rst
+	*/doctests/*
+	*/tests/*
+
+[coverage:report]
+precision = 2
+omit = 
+	*.rst
+	*/doctests/*
+	*/tests/*
+
+[coverage:html]
+directory = _build/coverage
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

{plone.api-2.1.0 → plone_api-2.2.1}/setup.py

@@ -1,24 +1,22 @@
+from pathlib import Path
 from setuptools import find_packages
 from setuptools import setup
 
-import os
-
-
-def read(*rnames):
-    return open(os.path.join(os.path.dirname(__file__), *rnames)).read()
 
+version = "2.2.1"
 
 long_description = (
-    read("README.md") + "\n\n" + read("CHANGES.rst") + "\n\n" + read("LICENSE")
+    f"{Path('README.md').read_text()}\n"
+    f"{Path('CHANGES.rst').read_text()}\n"
+    f"{Path('LICENSE').read_text()}"
 )
 
-version = "2.1.0"
-
 setup(
     name="plone.api",
     version=version,
     description="A Plone API.",
     long_description=long_description,
+    long_description_content_type="text/x-rst",
     author="Plone Foundation",
     author_email="plone-developers@lists.sourceforge.net",
     license="GPL version 2",
@@ -32,26 +30,40 @@ setup(
     python_requires=">=3.8",
     install_requires=[
         "Products.statusmessages",
+        "Products.PlonePAS",
+        "Products.CMFPlone",
         "decorator",
         "plone.app.uuid",
+        "plone.app.dexterity",
+        "plone.app.intid",
+        "plone.app.layout",
         "plone.app.linkintegrity",
+        "plone.dexterity",
+        "plone.i18n",
+        "plone.registry",
         "plone.uuid",
         "setuptools",
         "zope.globalrequest",
+        "Products.CMFCore",
+        "z3c.relationfield",
+        "zc.relation",
+        "Zope",
+        "zope.intid",
     ],
     extras_require={
         "test": [
-            "Products.CMFPlone",
+            "borg.localrole",
             "manuel>=1.11.2",
-            "plone.app.dexterity",
-            "plone.app.intid",
+            "plone.app.contenttypes",
+            "plone.app.textfield",
             "plone.app.testing",
+            "plone.testing",
             "plone.indexer",
             "plone.registry",
-            "z3c.relationfield",
-            "zope.testrunner",
         ],
     },
+    # Get more strings from
+    # https://pypi.org/classifiers/
     classifiers=[
         "Development Status :: 5 - Production/Stable",
         "Environment :: Web Environment",

{plone.api-2.1.0 → plone_api-2.2.1}/src/plone/api/configure.zcml

@@ -1,5 +1,6 @@
 <configure
     xmlns="http://namespaces.zope.org/zope"
-    i18n_domain="plone.api">
+    i18n_domain="plone.api"
+    >
 
 </configure>

{plone.api-2.1.0 → plone_api-2.2.1}/src/plone/api/content.py

@@ -34,7 +34,7 @@ def create(
     id=None,
     title=None,
     safe_id=False,
-    **kwargs  # NOQA: C816, S101
+    **kwargs,  # NOQA: C816, S101
 ):
     """Create a new content item.
 
@@ -127,7 +127,7 @@ def get(path=None, UID=None):
     if path:
         site = portal.get()
         site_absolute_path = "/".join(site.getPhysicalPath())
-        if not path.startswith("{path}".format(path=site_absolute_path)):
+        if not path.startswith(f"{site_absolute_path}"):
             path = "{site_path}{relative_path}".format(
                 site_path=site_absolute_path,
                 relative_path=path,
@@ -297,7 +297,7 @@ def delete(obj=None, objects=None, check_linkintegrity=True):
         breaches = linkintegrity_view.get_breaches(objects)
         if breaches:
             raise LinkIntegrityNotificationException(
-                "Linkintegrity-breaches: {}".format(breaches),
+                f"Linkintegrity-breaches: {breaches}",
             )
 
     for obj_ in objects:

{plone.api-2.1.0 → plone_api-2.2.1}/src/plone/api/env.py

@@ -231,4 +231,4 @@ def zope_version():
     :returns: string denoting what release of Zope2 this distribution contains
     :Example: :ref:`env-zope-version-example`
     """
-    return get_distribution("Zope2").version
+    return get_distribution("Zope").version

{plone.api-2.1.0 → plone_api-2.2.1}/src/plone/api/portal.py

@@ -280,7 +280,7 @@ def get_registry_record(name=None, interface=None, default=MISSING):
         records = registry.forInterface(interface, check=False)
         _marker = object()
         if getattr(records, name, _marker) != _marker:
-            return registry["{}.{}".format(interface.__identifier__, name)]
+            return registry[f"{interface.__identifier__}.{name}"]
 
         if default is not MISSING:
             return default
@@ -307,7 +307,7 @@ def get_registry_record(name=None, interface=None, default=MISSING):
 
     # Show all records that 'look like' name.
     # We don't dump the whole list, because it 1500+ items.
-    msg = "Cannot find a record with name '{name}'".format(name=name)
+    msg = f"Cannot find a record with name '{name}'"
     records = [key for key in registry.records.keys() if name in key]
     if records:
         msg = (

{plone.api-2.1.0 → plone_api-2.2.1}/src/plone/api/profiles/testfixture/metadata.xml

@@ -1,4 +1,4 @@
-<?xml version="1.0"?>
+<?xml version="1.0" encoding="utf-8"?>
 <metadata>
   <version>1</version>
   <dependencies>

plone_api-2.2.1/src/plone/api/profiles/testfixture/types/Dexterity_Folder.xml

@@ -0,0 +1,62 @@
+<?xml version="1.0" encoding="utf-8"?>
+<object xmlns:i18n="http://xml.zope.org/namespaces/i18n"
+        meta_type="Dexterity FTI"
+        name="Dexterity Folder"
+>
+  <property name="title">Dexterity Folder</property>
+  <property name="description" />
+  <property name="content_icon" />
+  <property name="link_target" />
+  <property name="immediate_view">view</property>
+  <property name="global_allow">True</property>
+  <property name="filter_content_types">False</property>
+  <property name="allowed_content_types" />
+  <property name="allow_discussion">False</property>
+  <property name="default_view">view</property>
+  <property name="view_methods">
+    <element value="view" />
+  </property>
+  <property name="default_view_fallback">False</property>
+  <property name="add_permission">cmf.AddPortalContent</property>
+  <property name="klass">plone.dexterity.content.Container</property>
+  <property name="behaviors">
+    <element value="plone.app.dexterity.behaviors.metadata.IDublinCore" />
+  </property>
+  <property name="schema" />
+  <property name="model_source" />
+  <property name="model_file">plone.api.tests:Dexterity_Folder.xml</property>
+  <alias from="(Default)"
+         to="(dynamic view)"
+  />
+  <alias from="edit"
+         to="@@edit"
+  />
+  <alias from="sharing"
+         to="@@sharing"
+  />
+  <alias from="view"
+         to="(selected layout)"
+  />
+  <action action_id="view"
+          category="object"
+          condition_expr=""
+          icon_expr=""
+          link_target=""
+          title="View"
+          url_expr="string:${object_url}"
+          visible="True"
+  >
+    <permission value="View" />
+  </action>
+  <action action_id="edit"
+          category="object"
+          condition_expr=""
+          icon_expr=""
+          link_target=""
+          title="Edit"
+          url_expr="string:${object_url}/edit"
+          visible="True"
+  >
+    <permission value="Modify portal content" />
+  </action>
+</object>