Issue #532: Implement get_path helper API

[ujsquared]

Fixes Issue #532

• Uses Zope's inbuilt getPhysicalPath internally.
• optional parameter relative_to_portal to fetch patch relative to Plone portal
• throws InvalidParameterError when used to fetch an object outside of Plone portal with relative_to_portal parameter set to True

---

📚 Documentation preview 📚: https://ploneapi--559.org.readthedocs.build/

[mister-roboto]

@ujsquared thanks for creating this Pull Request and helping to improve Plone!

TL;DR: Finish pushing changes, pass all other checks, then paste a comment:

@jenkins-plone-org please run jobs

To ensure that these changes do not break other parts of Plone, the Plone test suite matrix needs to pass, but it takes 30-60 min. Other CI checks are usually much faster and the Plone Jenkins resources are limited, so when done pushing changes and all other checks pass either start all Jenkins PR jobs yourself, or simply add the comment above in this PR to start all the jobs automatically.

Happy hacking!

[stevepiercy]

Some reStructuredText syntax and English grammar docs and change log fixes. Otherwise the docs and change log look good to me.

Links to rendered docs to review.

• https://ploneapi--559.org.readthedocs.build/content.html#get-content-path
• https://ploneapi--559.org.readthedocs.build/api/content.html#plone.api.content.get_path
• https://ploneapi--559.org.readthedocs.build/_modules/plone/api/content.html#get_path

Still needs a technical review. It looks pretty good from what I can understand.

[gforcada]

Mostly opinions, let's see if others agree on them

[stevepiercy]

Docs LGTM! Technical review still needed.

[ale-rt]

IMO it is disorienting that a relative path starts with "/".

I find it awkward but acceptable that absolute_url(relative=True) returns an initial "/" (the method has absolute in its name), but get_path(obj, realtive=True) returning something with a leading slash feels inconsistent.

[ujsquared]

okay, will fix this.

[davisagli]

@ale-rt @ujsquared I was going back and forth about whether I like removing the slash from the portal-relative path, but it has a nice benefit that you can do portal.unrestrictedTraverse(path) with the result.

[ale-rt]

@ale-rt @ujsquared I was going back and forth about whether I like removing the slash from the portal-relative path, but it has a nice benefit that you can do portal.unrestrictedTraverse(path) with the result.

You mean that it is better without the slash:

>>> portal.restrictedTraverse("/acl_users")
<PluggableAuthService at /acl_users>
>>> portal.restrictedTraverse("acl_users")
<PluggableAuthService at /Plone/acl_users>

Note that you do not need to pass a string to resolve a path:

>>> portal.restrictedTraverse(["acl_users", "source_users"])
<UserManager at /Plone/acl_users/source_users>

[ujsquared]

@ale-rt @ujsquared I was going back and forth about whether I like removing the slash from the portal-relative path, but it has a nice benefit that you can do portal.unrestrictedTraverse(path) with the result.

You mean that it is better without the slash:

>>> portal.restrictedTraverse("/acl_users")
<PluggableAuthService at /acl_users>
>>> portal.restrictedTraverse("acl_users")
<PluggableAuthService at /Plone/acl_users>

Note that you do not need to pass a string to resolve a path:

>>> portal.restrictedTraverse(["acl_users", "source_users"])
<UserManager at /Plone/acl_users/source_users>

Currently, the repo has more instances of using getPhysicalPath() without a starting slash.

[mauritsvanrees]

I would say:

• relative=True should give no slash in front
• relative=False should give a slash in front

So:

content.get_path(app.plone.folder.page) == "/plone/folder/page"
content.get_path(app.plone.folder.page, relative=True) == "folder/page"

So for the absolute case this would be: return "/".join(obj.getPhysicalPath())

[ale-rt]

I would say:

• relative=True should give no slash in front
• relative=False should give a slash in front

So:

content.get_path(app.plone.folder.page) == "/plone/folder/page"
content.get_path(app.plone.folder.page, relative=True) == "folder/page"

So for the absolute case this would be: return "/".join(obj.getPhysicalPath())

Excatly:

• absolute => "/foo/bar"
• relative => "foo/bar"

[stevepiercy]

Minor changes. Thanks for the contribution and responsiveness to suggestions.

Direct links to affected docs pull request preview pages all LGTM.

• https://ploneapi--559.org.readthedocs.build/content.html#get-content-path
• https://ploneapi--559.org.readthedocs.build/api/content.html#plone.api.content.get_path
• https://ploneapi--559.org.readthedocs.build/_modules/plone/api/content.html#get_path

[davisagli]

I would still much prefer that we call the parameter relative_to_portal instead of relative. I think it makes it clearer what it does. Never mind, I looked again at Gil's reason of making it match absolute_url, and I think that makes sense.

[davisagli]

@jenkins-plone-org please run jobs

[stevepiercy]

Docs look good to me. Thank you! Are there any unresolved matters to address?

[ale-rt]

LGTM