Ñò
»Ic @ s³ d Z d d k l Z l Z d d d d d d d d
d d d
d d d d g Z d e f d „ ƒ YZ d e f d „ ƒ YZ d e f d „ ƒ YZ d e f d „ ƒ YZ d e f d „ ƒ YZ
d
e f d „ ƒ YZ d e f d „ ƒ YZ d
e f d „ ƒ YZ
d e
f d „ ƒ YZ d e f d „ ƒ YZ d e f d „ ƒ YZ d e f d „ ƒ YZ d e f d „ ƒ YZ d e
f d „ ƒ YZ d e f d! „ ƒ YZ d e f d" „ ƒ YZ d# S($ s¥
Built-in predicate checkers.
This is module provides the predicate checkers that were present in the
original "identity" framework of TurboGears 1, plus others.
iÿÿÿÿ( t parse_formvarst parse_dict_querystringt Predicatet CompoundPredicatet Allt Anyt has_all_permissionst has_any_permissiont has_permissiont
in_all_groupst in_any_groupt in_groupt is_usert is_anonymoust
not_anonymoust PredicateErrort NotAuthorizedErrorc B s\ e Z d Z d d „ Z d „ Z d „ Z d „ Z d d „ Z d „ Z d „ Z
d „ Z RS(
s–
Generic predicate checker.
This is the base predicate class. It won't do anything useful for you,
unless you subclass it.
c C s | o
| | _ n d S( sB
Create a predicate and use ``msg`` as the error message if it fails.
:param msg: The error message, if you want to override the default one
defined by the predicate.
:type msg: str
You may use the ``msg`` keyword argument with any predicate.
N( t message( t selft msg( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyt __init__/ s c C s | i | ƒ d S( sò
Raise an exception if the predicate is not met.
:param environ: The WSGI environment.
:type environ: dict
:param credentials: The :mod:`repoze.what` ``credentials`` dictionary
as a short-cut.
:type credentials: dict
:raise NotImplementedError: When the predicate doesn't define this
method.
:raises NotAuthorizedError: If the predicate is not met (use
:meth:`unmet` to raise it).
This is the method that must be overridden by any predicate checker.
For example, if your predicate is "The current month is the specified
one", you may define the following predicate checker::
from datetime import date
from repoze.what.predicates import Predicate
class is_month(Predicate):
message = 'The current month must be %(right_month)s'
def __init__(self, right_month, **kwargs):
self.right_month = right_month
super(is_month, self).__init__(**kwargs)
def evaluate(self, environ, credentials):
today = date.today()
if today.month != self.right_month:
# Raise an exception because the predicate is not met.
self.unmet()
.. versionadded:: 1.0.2
.. attention::
Do not evaluate predicates by yourself using this method. See
:meth:`check_authorization` and :meth:`is_met`.
.. warning::
To make your predicates thread-safe, keep in mind that they may
be instantiated at module-level and then shared among many threads,
so avoid predicates from being modified after their evaluation.
This is, the ``evaluate()`` method should not add, modify or
delete any attribute of the predicate.
N( t eval_with_environ( R t environt credentials( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyt evaluate= s 2c C s
t ‚ d S( s
Check whether the predicate is met.
:param environ: The WSGI environment.
:type environ: dict
:return: Whether the predicate is met or not.
:rtype: bool
:raise NotImplementedError: This must be defined by the predicate
itself.
.. deprecated:: 1.0.2
Only :meth:`evaluate` will be used as of :mod:`repoze.what` v2.
N( t NotImplementedError( R R ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyt _eval_with_environq s c C sK d d k l } d } | | t d d ƒ| i | ƒ p | i ƒ n d S( sç
Make sure this predicate is met.
:param environ: The WSGI environment.
:raises NotAuthorizedError: If the predicate is not met.
.. versionchanged:: 1.0.1
In :mod:`repoze.what`<1.0.1, this method returned a ``bool`` and
set the ``error`` instance attribute of the predicate to the
predicate message.
.. deprecated:: 1.0.2
Define :meth:`evaluate` instead.
iÿÿÿÿ( t warnsš Predicate._eval_with_environ(environ) is deprecated for forward compatibility with repoze.what v2; define Predicate.evaluate(environ, credentials) insteadt
stackleveli N( t warningsR t DeprecationWarningR t unmet( R R R R ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR ‚ s
c K sV | o
| } n
| i } t | ƒ } | i i ƒ } | i | ƒ t | | ƒ ‚ d S( s
Raise an exception because this predicate is not met.
:param msg: The error message to be used; overrides the predicate's
default one.
:type msg: str
:raises NotAuthorizedError: If the predicate is not met.
``placeholders`` represent the placeholders for the predicate message.
The predicate's attributes will also be taken into account while
creating the message with its placeholders.
For example, if you have a predicate that checks that the current
month is the specified one, where the predicate message is defined with
two placeholders as in::
The current month must be %(right_month)s and it is %(this_month)s
and the predicate has an attribute called ``right_month`` which
represents the expected month, then you can use this method as in::
self.unmet(this_month=this_month)
Then :meth:`unmet` will build the message using the ``this_month``
keyword argument and the ``right_month`` attribute as the placeholders
for ``this_month`` and ``right_month``, respectively. So, if
``this_month`` equals ``3`` and ``right_month`` equals ``5``,
the message for the exception to be raised will be::
The current month must be 5 and it is 3
If you have a context-sensitive predicate checker and thus you want
to change the error message on evaluation, you can call :meth:`unmet`
as::
self.unmet('%(this_month)s is not a good month',
this_month=this_month)
The exception raised would contain the following message::
3 is not a good month
.. versionadded:: 1.0.2
.. versionchanged:: 1.0.4
Introduced the ``msg`` argument.
.. attention::
This method should only be called from :meth:`evaluate`.
N( R t unicodet __dict__t copyt updateR ( R R t placeholdersR t all_placeholders( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR š s 5
c C s€ | i d ƒ } | i d h ƒ } y | i | | ƒ Wn0 t j
o$ } | o | i d | ƒ ‚ n X| o
| i d ƒ d S( sÈ
Evaluate the predicate and raise an exception if it's not met.
:param environ: The WSGI environment.
:raise NotAuthorizedError: If it the predicate is not met.
Example::
>>> from repoze.what.predicates import is_user
>>> environ = gimme_the_environ()
>>> p = is_user('gustavo')
>>> p.check_authorization(environ)
# ...
repoze.what.predicates.NotAuthorizedError: The current user must be "gustavo"
.. versionadded:: 1.0.4
Backported from :mod:`repoze.what` v2; deprecates
:func:`repoze.what.authorize.check_authorization`.
s repoze.who.loggers repoze.what.credentialsu Authorization denied: %ss Authorization grantedN( t getR R t info( R R t loggerR t error( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyt check_authorizationÛ s c C sG | i d h ƒ } y | i | | ƒ t SWn t j
o
} t SXd S( s
Find whether the predicate is met or not.
:param environ: The WSGI environment.
:return: Whether the predicate is met or not.
:rtype: bool
Example::
>>> from repoze.what.predicates import is_user
>>> environ = gimme_the_environ()
>>> p = is_user('gustavo')
>>> p.is_met(environ)
False
.. versionadded:: 1.0.4
Backported from :mod:`repoze.what` v2.
s repoze.what.credentialsN( R& R t TrueR t False( R R R R) ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyt is_metù s c C s© t | ƒ p h } y t | t ƒ p h } Wn t j
o
h } n X| i d g h f ƒ } | d p d } | d p h } h | d 6| d 6| d 6| d 6} | S( sj
Return the GET and POST variables in the request, as well as
``wsgiorg.routing_args`` arguments.
:param environ: The WSGI environ.
:return: The GET and POST variables and ``wsgiorg.routing_args``
arguments.
:rtype: dict
This is a handy method for request-sensitive predicate checkers.
It will return a dictionary for the POST and GET variables, as well as
the `wsgiorg.routing_args
`_'s
``positional_args`` and ``named_args`` arguments, in the ``post``,
``get``, ``positional_args`` and ``named_args`` items (respectively) of
the returned dictionary.
For example, if the user submits a form using the POST method to
``http://example.com/blog/hello-world/edit_post?wysiwyg_editor=Yes``,
this method may return::
{
'post': {'new_post_contents': 'These are the new contents'},
'get': {'wysiwyg_editor': 'Yes'},
'named_args': {'post_slug': 'hello-world'},
'positional_args': (),
}
But note that the ``named_args`` and ``positional_args`` items depend
completely on how you configured the dispatcher.
.. versionadded:: 1.0.4
s wsgiorg.routing_argsi i t postR& t positional_argst
named_args( ( R R R, t KeyErrorR& ( R R t get_varst post_varst routing_argsR/ R0 t variables( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyt parse_variables s $
N( t __name__t
__module__t __doc__t NoneR R R R R R* R- R6 ( ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR & s 4 A c B s e Z d Z d „ Z RS( s) A predicate composed of other predicates.c O s# t t | ƒ i | | | _ d S( N( t superR R t
predicates( R R< t kwargs( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR K s ( R7 R8 R9 R ( ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR H s t Notc B s& e Z d Z d Z d „ Z d „ Z RS( sÇ
Negate the specified predicate.
:param predicate: The predicate to be negated.
Example::
# The user *must* be anonymous:
p = Not(not_anonymous())
u The condition must not be metc K s# t t | ƒ i | | | _ d S( N( R; R> R t predicate( R R? R= ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR ^ s c C s> y | i i | | ƒ Wn t j
o
} d SX| i ƒ d S( N( R? R R R ( R R R R) ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR b s
( R7 R8 R9 R R R ( ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR> P s c B s e Z d Z d „ Z RS( s<
Check that all of the specified predicates are met.
:param predicates: All of the predicates that must be met.
Example::
# Grant access if the current month is July and the user belongs to
# the human resources group.
p = All(is_month(7), in_group('hr'))
c C s( x! | i D] } | i | | ƒ q
Wd S( s
Evaluate all the predicates it contains.
:param environ: The WSGI environment.
:param credentials: The :mod:`repoze.what` ``credentials``.
:raises NotAuthorizedError: If one of the predicates is not met.
N( R< R ( R R R t p( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR x s
( R7 R8 R9 R ( ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR j s c B s e Z d Z d Z d „ Z RS( s4
Check that at least one of the specified predicates is met.
:param predicates: Any of the predicates that must be met.
Example::
# Grant access if the currest user is Richard Stallman or Linus
# Torvalds.
p = Any(is_user('rms'), is_user('linus'))
uK At least one of the following predicates must be met: %(failed_predicates)sc C s€ g } xT | i D]I } y | i | | ƒ d SWq t j
o } | i t | ƒ ƒ q Xq Wd i | ƒ } | i d | ƒ d S( s
Evaluate all the predicates it contains.
:param environ: The WSGI environment.
:param credentials: The :mod:`repoze.what` ``credentials``.
:raises NotAuthorizedError: If none of the predicates is met.
Ns , t failed_predicates( R< R R t appendR t joinR ( R R R t errorsR@ t excRA ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR • s
( R7 R8 R9 R R ( ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR … s c B s& e Z d Z d Z d „ Z d „ Z RS( sÒ
Check that the authenticated user's username is the specified one.
:param user_name: The required user name.
:type user_name: str
Example::
p = is_user('linus')
u( The current user must be "%(user_name)s"c K s# t t | ƒ i | | | _ d S( N( R; R R t user_name( R RF R= ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR ¸ s c C s3 | o | i | i d ƒ j o d S| i ƒ d S( Ns repoze.what.userid( RF R& R ( R R R ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR ¼ s ( R7 R8 R9 R R R ( ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR © s c B s& e Z d Z d Z d „ Z d „ Z RS( sç
Check that the user belongs to the specified group.
:param group_name: The name of the group to which the user must belong.
:type group_name: str
Example::
p = in_group('customers')
u: The current user must belong to the group "%(group_name)s"c K s# t t | ƒ i | | | _ d S( N( R; R R t
group_name( R RG R= ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR Ò s c C s3 | o | i | i d ƒ j o d S| i ƒ d S( Nt groups( RG R& R ( R R R ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR Ö s ( R7 R8 R9 R R R ( ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR Ã s c B s e Z d Z d „ Z RS( sã
Check that the user belongs to all of the specified groups.
:param groups: The name of all the groups the user must belong to.
Example::
p = in_all_groups('developers', 'designers')
c O sD g } | D] } | t | ƒ q ~ } t t | ƒ i | | Ž d S( N( R R; R R ( R RH R= t _[1]t gt group_predicates( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR é s '( R7 R8 R9 R ( ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR Ü s
c B s e Z d Z d Z d „ Z RS( så
Check that the user belongs to at least one of the specified groups.
:param groups: The name of any of the groups the user may belong to.
Example::
p = in_any_group('directors', 'hr')
uN The member must belong to at least one of the following groups: %(group_list)sc O sV d i | ƒ | _ g } | D] } | t | ƒ q ~ } t t | ƒ i | | Ž d S( Ns , ( RC t
group_listR R; R
R ( R RH R= RI RJ RK ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR ý s '( R7 R8 R9 R R ( ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR
î s
c B s e Z d Z d Z d „ Z RS( s²
Check that the current user is anonymous.
Example::
# The user must be anonymous!
p = is_anonymous()
.. versionadded:: 1.0.7
u" The current user must be anonymousc C s | o | i ƒ n d S( N( R ( R R R ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR s ( R7 R8 R9 R R ( ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR
s c B s e Z d Z d Z d „ Z RS( s§
Check that the current user has been authenticated.
Example::
# The user must have been authenticated!
p = not_anonymous()
u- The current user must have been authenticatedc C s | p | i ƒ n d S( N( R ( R R R ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR $ s ( R7 R8 R9 R R ( ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR s c B s& e Z d Z d Z d „ Z d „ Z RS( sê
Check that the current user has the specified permission.
:param permission_name: The name of the permission that must be granted to
the user.
Example::
p = has_permission('hire')
u7 The user must have the "%(permission_name)s" permissionc K s# t t | ƒ i | | | _ d S( N( R; R R t permission_name( R RM R= ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR 7 s c C s3 | o | i | i d ƒ j o d S| i ƒ d S( Nt permissions( RM R& R ( R R R ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR ; s ( R7 R8 R9 R R R ( ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR ) s c B s e Z d Z d „ Z RS( s
Check that the current user has been granted all of the specified
permissions.
:param permissions: The names of all the permissions that must be
granted to the user.
Example::
p = has_all_permissions('view-users', 'edit-users')
c O sD g } | D] } | t | ƒ q ~ } t t | ƒ i | | Ž d S( N( R R; R R ( R RN R= RI R@ t permission_predicates( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR P s '( R7 R8 R9 R ( ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR B s c B s e Z d Z d Z d „ Z RS( s
Check that the user has at least one of the specified permissions.
:param permissions: The names of any of the permissions that have to be
granted to the user.
Example::
p = has_any_permission('manage-users', 'edit-users')
uQ The user must have at least one of the following permissions: %(permission_list)sc O sV d i | ƒ | _ g } | D] } | t | ƒ q ~ } t t | ƒ i | | Ž d S( Ns , ( RC t permission_listR R; R R ( R RN R= RI R@ RO ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR f s '( R7 R8 R9 R R ( ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR V s c B s+ e Z d Z e e d ƒ p
d „ Z n RS( sè
Former exception raised by a :class:`Predicate` if it's not met.
.. deprecated:: 1.0.4
Deprecated in favor of :class:`NotAuthorizedError`, for forward
compatibility with :mod:`repoze.what` v2.
t __unicode__c C s" t | i o | i d p d ƒ S( Ni t ( R t args( R ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyRQ | s ( R7 R8 R9 t hasattrt ExceptionRQ ( ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR p s c B s e Z d Z RS( s.
Exception raised by :meth:`Predicate.check_authorization` if the subject
is not allowed to access the requested source.
This exception deprecates :class:`PredicateError` as of v1.0.4, but
extends it to avoid breaking backwards compatibility.
.. versionchanged:: 1.0.4
This exception was defined at :mod:`repoze.what.authorize` until
version 1.0.3, but is still imported into that module to keep backwards
compatibility with v1.X releases -- but it won't work in
:mod:`repoze.what` v2.
( R7 R8 R9 ( ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyR € s N( R9 t
paste.requestR R t __all__t objectR R R> R R R R R R
R
R R R R RU R R ( ( ( s: /usr/lib/python2.6/site-packages/repoze/what/predicates.pyt s. ÿ #$