Move acl security to authorization by mmerickel · Pull Request #3563 · Pylons/pyramid

mmerickel · 2020-01-13T04:00:54Z

This deprecates the ACL-specific parts of pyramid.security and moves them into pyramid.authorization since ACL features are not specifically top-level in the security API any longer.

Here are the options:

merge this, and isolate anything ACL-related in pyramid.authorization.
come up with a way to un-deprecate effective_principals features so that it can be used by the framework as makes sense.

My feeling is that it's good to isolate this stuff into one spot, and if there is pushback by the community after release because request.effective_principals and the predicate are deprecated, then we can re-evaluate them by potentially adding an optional method to the security policy or something.

cc @luhn

stevepiercy

LGTM so far.

Needs a change log entry for how to upgrade to 2.0, pending choice of option 1 or 2 for how to proceed.

Also suggest adding versionchanged or deprecated reST directives where helpful.

luhn · 2020-01-13T18:37:17Z

👍

I agree it's the right way to organize things, even if its temporarily a bit more messy until we can remove the deprecated items.

Re effective_principals, I think if users still want to access it in a new security policy we should recommend they put it in authenticated_identity. It is part of the user's identity, imo. Also I'm loathe to add an extra method to the security policy that's only applicable for specific use cases. But I guess we'll see what the response is.

mmerickel · 2020-01-13T20:02:42Z

Ok I will fix the changelog and docs. There are more changes once #3557 is merged as well - I didn't fix the tutorials in this branch because I knew it would cause conflicts - so I will leave this open until then.

src/pyramid/security.py

stevepiercy

For all single-quoted strings in docs/api/security.rst and docs/api/authorization.rst, should they be double-backticked instead as inline literals?

CHANGES.rst

merwok

Minor markup tweaks to have names rendered as code and strings rendered as strings

docs/api/authorization.rst

docs/api/security.rst

Co-Authored-By: Éric Araujo <merwok@netwok.org>

stevepiercy

The mix of double-backticking thing and 'other' regarding ' is inconsistent. Suggest removing the single quotes.

merwok

apply markup fixes to overlooked mentions

docs/api/authorization.rst

src/pyramid/authorization.py

merwok · 2020-01-15T03:41:32Z

The mix of double-backticking thing and 'other' regarding ' is inconsistent

If you mean that the doc for pyramid.security docs says

the value is the string ``'system.Everyone'``

but the one for pyramid.authorization has

the value is the string 'system.Everyone'

I have sent change suggestions to make them consistent.

If you mean the difference between

the name ``Everyone``

and

the value is the string ``'system.Everyone'``

then I don’t see the inconsistency: the name is not a string.

Co-Authored-By: Éric Araujo <merwok@netwok.org>

mmerickel · 2020-01-16T16:35:35Z

I re-synced some of the docs after merging #3557. This should be good to go.

The import paths for these modules has changed in Pyramid 2.0, and raises warnings. There are other Pyramid 2.0 warnings, but are more involved than changing an import path, and should be addressed as another commit. Refs: Pylons/pyramid#3563 Signed-off-by: Mike Fiedler <miketheman@gmail.com>

* Fix PytestCollectionWarning When collecting tests, this class raises a warning since it's named `Test*`: PytestCollectionWarning: cannot collect test class 'TestAdminFlagValues' because it has a __new__ constructor Set an attribute that informs pytest to ignore this class, and thus remove the warning. Refs: https://docs.pytest.org/en/6.2.x/example/pythoncollection.html#customizing-test-collection (last lines) Signed-off-by: Mike Fiedler <miketheman@gmail.com> * Fix PytestDeprecationWarning Current test warns: PytestDeprecationWarning: The --strict option is deprecated, use --strict-markers instead. Marked as deprecated in pytest-dev/pytest#7985 Released in pytest 6.2.0 Signed-off-by: Mike Fiedler <miketheman@gmail.com> * Fix DeprecationWarning pyramid import The import paths for these modules has changed in Pyramid 2.0, and raises warnings. There are other Pyramid 2.0 warnings, but are more involved than changing an import path, and should be addressed as another commit. Refs: Pylons/pyramid#3563 Signed-off-by: Mike Fiedler <miketheman@gmail.com> * Fix DeprecationWarning for jinja.contextfilter A few instances of this warning are raised: DeprecationWarning: 'contextfilter' is renamed to 'pass_context', the old name will be removed in Jinja 3.1. Replace the usages accordingly. Refs: pallets/jinja#1389 Signed-off-by: Mike Fiedler <miketheman@gmail.com> * Fix DeprecationWarning for jinja.Markup The pass-through import of markup.Markup() has been deprecated in Jinja 3.0, and will be removed in Jinja 3.1. Warnings raised: DeprecationWarning: 'jinja2.Markup' is deprecated and will be removed in Jinja 3.1. Import 'markupsafe.Markup' instead. Replace the import paths. TODO: Determine if the requirements/main.in needs to be changed as well. Refs: pallets/jinja#1391 Signed-off-by: Mike Fiedler <miketheman@gmail.com> * Fix DeprecationWarning for babel.numbers.from_number Warnings raised: DeprecationWarning: Use babel.numbers.format_decimal() instead. Deprecated since 2.6.0 Refs: python-babel/babel#538 Signed-off-by: Mike Fiedler <miketheman@gmail.com> Co-authored-by: Dustin Ingram <di@users.noreply.github.com>

mmerickel added 3 commits January 12, 2020 20:30

move acl helper apis from pyramid.security to pyramid.authorization

1395359

move doc references from pyramid.security to pyramid.authorization

7917307

fix lint

8b6efc3

stevepiercy reviewed Jan 13, 2020

View reviewed changes

mmerickel added this to the 2.0 milestone Jan 13, 2020

merwok reviewed Jan 13, 2020

View reviewed changes

src/pyramid/security.py Show resolved Hide resolved

update changelog and docs

f486795

stevepiercy reviewed Jan 14, 2020

View reviewed changes

merwok reviewed Jan 14, 2020

View reviewed changes

CHANGES.rst Show resolved Hide resolved

merwok reviewed Jan 14, 2020

View reviewed changes

Apply suggestions from code review

32fca41

Co-Authored-By: Éric Araujo <merwok@netwok.org>

merwok mentioned this pull request Jan 14, 2020

Rewrite docs for custom predicates #3560

Merged

stevepiercy reviewed Jan 14, 2020

View reviewed changes

merwok reviewed Jan 15, 2020

View reviewed changes

docs/api/authorization.rst Outdated Show resolved Hide resolved

docs/api/authorization.rst Outdated Show resolved Hide resolved

src/pyramid/authorization.py Outdated Show resolved Hide resolved

mmerickel and others added 4 commits January 14, 2020 23:01

Apply suggestions from code review

1d6d0fc

Co-Authored-By: Éric Araujo <merwok@netwok.org>

fix comment

eb7046c

Merge branch 'master' into move-acl-security-to-authorization

a7f61dc

update docs with pyramid.authorizatio imports after syncing master

592cadd

mmerickel merged commit a71df99 into Pylons:master Jan 17, 2020

mmerickel deleted the move-acl-security-to-authorization branch November 29, 2020 03:09

Conversation

mmerickel commented Jan 13, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stevepiercy left a comment

Choose a reason for hiding this comment

Uh oh!

luhn commented Jan 13, 2020

Uh oh!

mmerickel commented Jan 13, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

stevepiercy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

merwok left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stevepiercy left a comment

Choose a reason for hiding this comment

Uh oh!

merwok left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

merwok commented Jan 15, 2020

Uh oh!

mmerickel commented Jan 16, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mmerickel commented Jan 13, 2020 •

edited

Loading

mmerickel commented Jan 13, 2020 •

edited

Loading