idx
int64
0
63k
question
stringlengths
61
4.03k
target
stringlengths
6
1.23k
35,700
def object_merge ( old , new , unique = False ) : if isinstance ( old , list ) and isinstance ( new , list ) : if old == new : return for item in old [ : : - 1 ] : if unique and item in new : continue new . insert ( 0 , item ) if isinstance ( old , dict ) and isinstance ( new , dict ) : for key , value in old . items (...
Recursively merge two data structures .
35,701
def compat_kwargs ( kwargs ) : warn_deprecations ( kwargs ) for old , new in RENAMED_VARS . items ( ) : if old in kwargs : kwargs [ new ] = kwargs [ old ] for c_old , c_new in RENAMED_VARS . items ( ) : if c_new == new : kwargs [ c_old ] = kwargs [ new ]
To keep backwards compat change the kwargs to new names
35,702
def deduplicate ( list_object ) : new = [ ] for item in list_object : if item not in new : new . append ( item ) return new
Rebuild list_object removing duplicated and keeping order
35,703
def trimmed_split ( s , seps = ( ";" , "," ) ) : for sep in seps : if sep not in s : continue data = [ item . strip ( ) for item in s . strip ( ) . split ( sep ) ] return data return [ s ]
Given a string s split is by one of one of the seps .
35,704
def ensure_a_list ( data ) : if not data : return [ ] if isinstance ( data , ( list , tuple , set ) ) : return list ( data ) if isinstance ( data , str ) : data = trimmed_split ( data ) return data return [ data ]
Ensure data is a list or wrap it in a list
35,705
def load ( obj , env = None , silent = True , key = None ) : redis = StrictRedis ( ** obj . get ( "REDIS_FOR_DYNACONF" ) ) holder = obj . get ( "ENVVAR_PREFIX_FOR_DYNACONF" ) try : if key : value = redis . hget ( holder . upper ( ) , key ) if value : obj . logger . debug ( "redis_loader: loading by key: %s:%s (%s:%s)" ...
Reads and loads in to settings a single key or all keys from redis
35,706
def load ( obj , settings_module , identifier = "py" , silent = False , key = None ) : mod , loaded_from = get_module ( obj , settings_module , silent ) if mod and loaded_from : obj . logger . debug ( "py_loader: {}" . format ( mod ) ) else : obj . logger . debug ( "py_loader: %s (Ignoring, Not Found)" , settings_modul...
Tries to import a python module
35,707
def import_from_filename ( obj , filename , silent = False ) : if filename in [ item . filename for item in inspect . stack ( ) ] : raise ImportError ( "Looks like you are loading dynaconf " "from inside the {} file and then it is trying " "to load itself entering in a circular reference " "problem. To solve it you hav...
If settings_module is a filename path import it .
35,708
def _get_env_list ( obj , env ) : env_list = [ obj . get ( "DEFAULT_ENV_FOR_DYNACONF" ) ] global_env = obj . get ( "ENVVAR_PREFIX_FOR_DYNACONF" ) or "DYNACONF" if global_env not in env_list : env_list . append ( global_env ) if obj . current_env and obj . current_env not in env_list : env_list . append ( obj . current_...
Creates the list of environments to read
35,709
def load ( obj , env = None , silent = None , key = None ) : client = get_client ( obj ) env_list = _get_env_list ( obj , env ) for env in env_list : path = "/" . join ( [ obj . VAULT_PATH_FOR_DYNACONF , env ] ) . replace ( "//" , "/" ) data = client . read ( path ) if data : data = data . get ( "data" , { } ) . get ( ...
Reads and loads in to settings a single key or all keys from vault
35,710
def set_settings ( instance = None ) : global settings settings = None if instance : settings = import_settings ( instance ) elif "INSTANCE_FOR_DYNACONF" in os . environ : settings = import_settings ( os . environ [ "INSTANCE_FOR_DYNACONF" ] ) elif "FLASK_APP" in os . environ : with suppress ( ImportError , click . Usa...
Pick correct settings instance and set it to a global variable .
35,711
def import_settings ( dotted_path ) : if "." in dotted_path : module , name = dotted_path . rsplit ( "." , 1 ) else : raise click . UsageError ( "invalid path to settings instance: {}" . format ( dotted_path ) ) try : module = importlib . import_module ( module ) except ImportError as e : raise click . UsageError ( e )...
Import settings instance from python dotted path .
35,712
def read_file_in_root_directory ( * names , ** kwargs ) : return read_file ( os . path . join ( os . path . dirname ( __file__ ) , * names ) , encoding = kwargs . get ( "encoding" , "utf-8" ) , )
Read a file on root dir .
35,713
def show_banner ( ctx , param , value ) : if not value or ctx . resilient_parsing : return set_settings ( ) click . echo ( settings . dynaconf_banner ) click . echo ( "Learn more at: http://github.com/rochacbruno/dynaconf" ) ctx . exit ( )
Shows dynaconf awesome banner
35,714
def write ( to , _vars , _secrets , path , env , y ) : _vars = split_vars ( _vars ) _secrets = split_vars ( _secrets ) loader = importlib . import_module ( "dynaconf.loaders.{}_loader" . format ( to ) ) if to in EXTS : path = Path ( path ) if str ( path ) . endswith ( constants . ALL_EXTENSIONS + ( "py" , ) ) : setting...
Writes data to specific source
35,715
def validate ( path ) : path = Path ( path ) if not str ( path ) . endswith ( ".toml" ) : path = path / "dynaconf_validators.toml" if not path . exists ( ) : click . echo ( click . style ( "{} not found" . format ( path ) , fg = "white" , bg = "red" ) ) sys . exit ( 1 ) validation_data = toml . load ( open ( str ( path...
Validates Dynaconf settings based on rules defined in dynaconf_validators . toml
35,716
def connect ( server , port , username , password ) : print ( "-" * 79 ) print ( "Connecting to: {}" . format ( server ) ) print ( "At port: {}" . format ( port ) ) print ( "Using username: {}" . format ( username ) ) print ( "Using password: {}" . format ( password ) ) print ( "-" * 79 )
This function might be something coming from your ORM
35,717
def write ( settings_path , settings_data , ** kwargs ) : for key , value in settings_data . items ( ) : dotenv_cli . set_key ( str ( settings_path ) , key . upper ( ) , str ( value ) )
Write data to . env file
35,718
def parse_with_toml ( data ) : try : return toml . loads ( "key={}" . format ( data ) , DynaBox ) . key except toml . TomlDecodeError : return data
Uses TOML syntax to parse data
35,719
def load ( self , filename = None , key = None , silent = True ) : filename = filename or self . obj . get ( self . identifier . upper ( ) ) if not filename : return if not isinstance ( filename , ( list , tuple ) ) : split_files = ensure_a_list ( filename ) if all ( [ f . endswith ( self . extensions ) for f in split_...
Reads and loads in to self . obj a single key or all keys from source
35,720
def _setup ( self ) : default_settings . reload ( ) environment_variable = self . _kwargs . get ( "ENVVAR_FOR_DYNACONF" , default_settings . ENVVAR_FOR_DYNACONF ) settings_module = os . environ . get ( environment_variable ) self . _wrapped = Settings ( settings_module = settings_module , ** self . _kwargs ) self . log...
Initial setup run once .
35,721
def configure ( self , settings_module = None , ** kwargs ) : default_settings . reload ( ) environment_var = self . _kwargs . get ( "ENVVAR_FOR_DYNACONF" , default_settings . ENVVAR_FOR_DYNACONF ) settings_module = settings_module or os . environ . get ( environment_var ) compat_kwargs ( kwargs ) kwargs . update ( sel...
Allows user to reconfigure settings object passing a new settings module or separated kwargs
35,722
def as_dict ( self , env = None , internal = False ) : ctx_mgr = suppress ( ) if env is None else self . using_env ( env ) with ctx_mgr : data = self . store . copy ( ) if not internal : for name in dir ( default_settings ) : data . pop ( name , None ) return data
Returns a dictionary with set key and values .
35,723
def _dotted_get ( self , dotted_key , default = None , ** kwargs ) : split_key = dotted_key . split ( "." ) name , keys = split_key [ 0 ] , split_key [ 1 : ] result = self . get ( name , default = default , ** kwargs ) self . _memoized = result if not keys or result is default : self . _memoized = None return result re...
Perform dotted key lookups and keep track of where we are .
35,724
def exists ( self , key , fresh = False ) : key = key . upper ( ) if key in self . _deleted : return False return self . get ( key , fresh = fresh , default = missing ) is not missing
Check if key exists
35,725
def get_environ ( self , key , default = None , cast = None ) : key = key . upper ( ) data = self . environ . get ( key , default ) if data : if cast in converters : data = converters . get ( cast ) ( data ) if cast is True : data = parse_conf_data ( data , tomlfy = True ) return data
Get value from environment variable using os . environ . get
35,726
def settings_module ( self ) : settings_module = parse_conf_data ( os . environ . get ( self . ENVVAR_FOR_DYNACONF , self . SETTINGS_FILE_FOR_DYNACONF ) , tomlfy = True , ) if settings_module != getattr ( self , "SETTINGS_MODULE" , None ) : self . set ( "SETTINGS_MODULE" , settings_module ) return self . SETTINGS_MODUL...
Gets SETTINGS_MODULE variable
35,727
def clean ( self , * args , ** kwargs ) : for key in list ( self . store . keys ( ) ) : self . unset ( key )
Clean all loaded values to reload when switching envs
35,728
def unset ( self , key ) : key = key . strip ( ) . upper ( ) if key not in dir ( default_settings ) and key not in self . _defaults : self . logger . debug ( "Unset %s" , key ) delattr ( self , key ) self . store . pop ( key , None )
Unset on all references
35,729
def set ( self , key , value , loader_identifier = None , tomlfy = False , dotted_lookup = True , is_secret = False , ) : if "." in key and dotted_lookup is True : return self . _dotted_set ( key , value , loader_identifier = loader_identifier , tomlfy = tomlfy ) value = parse_conf_data ( value , tomlfy = tomlfy ) key ...
Set a value storing references for the loader
35,730
def _merge_before_set ( self , key , existing , value , is_secret ) : def _log_before_merging ( _value ) : self . logger . debug ( "Merging existing %s: %s with new: %s" , key , existing , _value ) def _log_after_merge ( _value ) : self . logger . debug ( "%s merged to %s" , key , _value ) global_merge = getattr ( self...
Merge the new value being set with the existing value before set
35,731
def loaders ( self ) : if self . LOADERS_FOR_DYNACONF in ( None , 0 , "0" , "false" , False ) : self . logger . info ( "No loader defined" ) return [ ] if not self . _loaders : for loader_module_name in self . LOADERS_FOR_DYNACONF : loader = importlib . import_module ( loader_module_name ) self . _loaders . append ( lo...
Return available loaders
35,732
def reload ( self , env = None , silent = None ) : self . clean ( ) self . execute_loaders ( env , silent )
Clean end Execute all loaders
35,733
def execute_loaders ( self , env = None , silent = None , key = None , filename = None ) : if key is None : default_loader ( self , self . _defaults ) env = ( env or self . current_env ) . upper ( ) silent = silent or self . SILENT_ERRORS_FOR_DYNACONF settings_loader ( self , env = env , silent = silent , key = key , f...
Execute all internal and registered loaders
35,734
def load_includes ( self , env , silent , key ) : includes = self . get ( "DYNACONF_INCLUDE" , [ ] ) includes . extend ( ensure_a_list ( self . get ( "INCLUDES_FOR_DYNACONF" ) ) ) if includes : self . logger . debug ( "Processing includes %s" , includes ) self . load_file ( path = includes , env = env , silent = silent...
Do we have any nested includes we need to process?
35,735
def load_file ( self , path = None , env = None , silent = True , key = None ) : env = ( env or self . current_env ) . upper ( ) files = ensure_a_list ( path ) if files : self . logger . debug ( "Got %s files to process" , files ) already_loaded = set ( ) for _filename in files : self . logger . debug ( "Processing fil...
Programmatically load files from path .
35,736
def _root_path ( self ) : if self . ROOT_PATH_FOR_DYNACONF is not None : return self . ROOT_PATH_FOR_DYNACONF elif self . _loaded_files : root_path = os . path . dirname ( self . _loaded_files [ 0 ] ) self . set ( "ROOT_PATH_FOR_DYNACONF" , root_path ) return root_path
ROOT_PATH_FOR_DYNACONF or the path of first loaded file or .
35,737
def load_extra_yaml ( self , env , silent , key ) : if self . get ( "YAML" ) is not None : self . logger . warning ( "The use of YAML var is deprecated, please define multiple " "filepaths instead: " "e.g: SETTINGS_FILE_FOR_DYNACONF = " "'settings.py,settings.yaml,settings.toml' or " "INCLUDES_FOR_DYNACONF=['path.toml'...
This is deprecated kept for compat
35,738
def path_for ( self , * args ) : if args and args [ 0 ] . startswith ( os . path . sep ) : return os . path . join ( * args ) return os . path . join ( self . _root_path or os . getcwd ( ) , * args )
Path containing _root_path
35,739
def validators ( self ) : if not hasattr ( self , "_validators" ) : self . _validators = ValidatorList ( self ) return self . _validators
Gets or creates validator wrapper
35,740
def populate_obj ( self , obj , keys = None ) : keys = keys or self . keys ( ) for key in keys : key = key . upper ( ) value = self . get ( key , empty ) if value is not empty : setattr ( obj , key , value )
Given the obj populate it using self . store items .
35,741
def default_loader ( obj , defaults = None ) : defaults = defaults or { } default_settings_values = { key : value for key , value in default_settings . __dict__ . items ( ) if key . isupper ( ) } all_keys = deduplicate ( list ( defaults . keys ( ) ) + list ( default_settings_values . keys ( ) ) ) for key in all_keys : ...
Loads default settings and check if there are overridings exported as environment variables
35,742
def settings_loader ( obj , settings_module = None , env = None , silent = True , key = None , filename = None ) : if filename is None : settings_module = settings_module or obj . settings_module if not settings_module : return files = ensure_a_list ( settings_module ) else : files = ensure_a_list ( filename ) files . ...
Loads from defined settings module
35,743
def enable_external_loaders ( obj ) : for name , loader in ct . EXTERNAL_LOADERS . items ( ) : enabled = getattr ( obj , "{}_ENABLED_FOR_DYNACONF" . format ( name . upper ( ) ) , False ) if ( enabled and enabled not in false_values and loader not in obj . LOADERS_FOR_DYNACONF ) : obj . logger . debug ( "loaders: Enabli...
Enable external service loaders like VAULT_ and REDIS_ looks forenv variables like REDIS_ENABLED_FOR_DYNACONF
35,744
def _walk_to_root ( path , break_at = None ) : if not os . path . exists ( path ) : raise IOError ( "Starting path not found" ) if os . path . isfile ( path ) : path = os . path . dirname ( path ) last_dir = None current_dir = os . path . abspath ( path ) paths = [ ] while last_dir != current_dir : paths . append ( cur...
Directories starting from the given directory up to the root or break_at
35,745
def find_file ( filename = ".env" , project_root = None , skip_files = None , ** kwargs ) : search_tree = [ ] work_dir = os . getcwd ( ) skip_files = skip_files or [ ] if project_root is None : logger . debug ( "No root_path for %s" , filename ) else : logger . debug ( "Got root_path %s for %s" , project_root , filenam...
Search in increasingly higher folders for the given file Returns path to the file if found or an empty string otherwise .
35,746
def validate ( self , settings ) : if self . envs is None : self . envs = [ settings . current_env ] if self . when is not None : try : if self . when . envs is None : self . when . envs = self . envs self . when . validate ( settings ) except ValidationError : return if ( len ( self . envs ) == 1 and self . envs [ 0 ]...
Raise ValidationError if invalid
35,747
def to_representation ( self , instance ) : ret = OrderedDict ( ) readable_fields = [ field for field in self . fields . values ( ) if not field . write_only ] for field in readable_fields : try : field_representation = self . _get_field_representation ( field , instance ) ret [ field . field_name ] = field_representat...
Object instance - > Dict of primitive datatypes .
35,748
def extract_attributes ( cls , fields , resource ) : data = OrderedDict ( ) for field_name , field in six . iteritems ( fields ) : if field_name == 'id' : continue if fields [ field_name ] . write_only : continue if isinstance ( field , ( relations . RelatedField , relations . ManyRelatedField , BaseSerializer ) ) : co...
Builds the attributes object of the JSON API resource object .
35,749
def extract_relation_instance ( cls , field_name , field , resource_instance , serializer ) : relation_instance = None try : relation_instance = getattr ( resource_instance , field_name ) except AttributeError : try : relation_instance = getattr ( resource_instance , field . child_relation . source ) except AttributeEr...
Determines what instance represents given relation and extracts it .
35,750
def extract_meta ( cls , serializer , resource ) : if hasattr ( serializer , 'child' ) : meta = getattr ( serializer . child , 'Meta' , None ) else : meta = getattr ( serializer , 'Meta' , None ) meta_fields = getattr ( meta , 'meta_fields' , [ ] ) data = OrderedDict ( ) for field_name in meta_fields : data . update ( ...
Gathers the data from serializer fields specified in meta_fields and adds it to the meta object .
35,751
def extract_root_meta ( cls , serializer , resource ) : many = False if hasattr ( serializer , 'child' ) : many = True serializer = serializer . child data = { } if getattr ( serializer , 'get_root_meta' , None ) : json_api_meta = serializer . get_root_meta ( resource , many ) assert isinstance ( json_api_meta , dict )...
Calls a get_root_meta function on a serializer if it exists .
35,752
def get_queryset ( self ) : qs = super ( PrefetchForIncludesHelperMixin , self ) . get_queryset ( ) if not hasattr ( self , 'prefetch_for_includes' ) : return qs includes = self . request . GET . get ( 'include' , '' ) . split ( ',' ) for inc in includes + [ '__all__' ] : prefetches = self . prefetch_for_includes . get...
This viewset provides a helper attribute to prefetch related models based on the include specified in the URL .
35,753
def get_queryset ( self , * args , ** kwargs ) : qs = super ( AutoPrefetchMixin , self ) . get_queryset ( * args , ** kwargs ) included_resources = get_included_resources ( self . request ) for included in included_resources : included_model = None levels = included . split ( '.' ) level_model = qs . model for level in...
This mixin adds automatic prefetching for OneToOne and ManyToMany fields .
35,754
def get_url ( self , name , view_name , kwargs , request ) : if not view_name : return None try : url = self . reverse ( view_name , kwargs = kwargs , request = request ) except NoReverseMatch : msg = ( 'Could not resolve URL for hyperlinked relationship using ' 'view name "%s". You may have failed to include the relat...
Given a name view name and kwargs return the URL that hyperlinks to the object .
35,755
def get_resource_name ( context , expand_polymorphic_types = False ) : from rest_framework_json_api . serializers import PolymorphicModelSerializer view = context . get ( 'view' ) if not view : return None try : code = str ( view . response . status_code ) except ( AttributeError , ValueError ) : pass else : if code . ...
Return the name of a resource .
35,756
def format_field_names ( obj , format_type = None ) : if format_type is None : format_type = json_api_settings . FORMAT_FIELD_NAMES if isinstance ( obj , dict ) : formatted = OrderedDict ( ) for key , value in obj . items ( ) : key = format_value ( key , format_type ) formatted [ key ] = value return formatted return o...
Takes a dict and returns it with formatted keys as set in format_type or JSON_API_FORMAT_FIELD_NAMES
35,757
def _format_object ( obj , format_type = None ) : if json_api_settings . FORMAT_KEYS is not None : return format_keys ( obj , format_type ) return format_field_names ( obj , format_type )
Depending on settings calls either format_keys or format_field_names
35,758
def get_included_resources ( request , serializer = None ) : include_resources_param = request . query_params . get ( 'include' ) if request else None if include_resources_param : return include_resources_param . split ( ',' ) else : return get_default_included_resources_from_serializer ( serializer )
Build a list of included resources .
35,759
def parse ( self , stream , media_type = None , parser_context = None ) : result = super ( JSONParser , self ) . parse ( stream , media_type = media_type , parser_context = parser_context ) if not isinstance ( result , dict ) or 'data' not in result : raise ParseError ( 'Received document does not contain primary data'...
Parses the incoming bytestream as JSON and returns the resulting data
35,760
def get_resource_type_from_included_serializer ( self ) : field_name = self . field_name or self . parent . field_name parent = self . get_parent_serializer ( ) if parent is not None : field_names = [ inflection . singularize ( field_name ) , inflection . pluralize ( field_name ) ] includes = get_included_serializers (...
Check to see it this resource has a different resource_name when included and return that name or None
35,761
def sign_plaintext ( client_secret , resource_owner_secret ) : signature = utils . escape ( client_secret or '' ) signature += '&' signature += utils . escape ( resource_owner_secret or '' ) return signature
Sign a request using plaintext .
35,762
def verify_hmac_sha1 ( request , client_secret = None , resource_owner_secret = None ) : norm_params = normalize_parameters ( request . params ) bs_uri = base_string_uri ( request . uri ) sig_base_str = signature_base_string ( request . http_method , bs_uri , norm_params ) signature = sign_hmac_sha1 ( sig_base_str , cl...
Verify a HMAC - SHA1 signature .
35,763
def verify_plaintext ( request , client_secret = None , resource_owner_secret = None ) : signature = sign_plaintext ( client_secret , resource_owner_secret ) match = safe_string_equals ( signature , request . signature ) if not match : log . debug ( 'Verify PLAINTEXT failed' ) return match
Verify a PLAINTEXT signature .
35,764
def create_authorization_response ( self , uri , http_method = 'GET' , body = None , headers = None , realms = None , credentials = None ) : request = self . _create_request ( uri , http_method = http_method , body = body , headers = headers ) if not request . resource_owner_key : raise errors . InvalidRequestError ( '...
Create an authorization response with a new request token if valid .
35,765
def get_realms_and_credentials ( self , uri , http_method = 'GET' , body = None , headers = None ) : request = self . _create_request ( uri , http_method = http_method , body = body , headers = headers ) if not self . request_validator . verify_request_token ( request . resource_owner_key , request ) : raise errors . I...
Fetch realms and credentials for the presented request token .
35,766
def create_introspect_response ( self , uri , http_method = 'POST' , body = None , headers = None ) : resp_headers = { 'Content-Type' : 'application/json' , 'Cache-Control' : 'no-store' , 'Pragma' : 'no-cache' , } request = Request ( uri , http_method , body , headers ) try : self . validate_introspect_request ( reques...
Create introspect valid or invalid response
35,767
def prepare_request_body ( self , private_key = None , subject = None , issuer = None , audience = None , expires_at = None , issued_at = None , extra_claims = None , body = '' , scope = None , include_client_id = False , ** kwargs ) : import jwt key = private_key or self . private_key if not key : raise ValueError ( '...
Create and add a JWT assertion to the request body .
35,768
def create_authorization_code ( self , request ) : grant = { 'code' : common . generate_token ( ) } if hasattr ( request , 'state' ) and request . state : grant [ 'state' ] = request . state log . debug ( 'Created authorization code grant %r for request %r.' , grant , request ) return grant
Generates an authorization grant represented as a dictionary .
35,769
def create_token_response ( self , request , token_handler ) : headers = self . _get_default_headers ( ) try : self . validate_token_request ( request ) log . debug ( 'Token request validation ok for %r.' , request ) except errors . OAuth2Error as e : log . debug ( 'Client error during validation of %r. %r.' , request ...
Validate the authorization code .
35,770
def validate_authorization_request ( self , request ) : for param in ( 'client_id' , 'response_type' , 'redirect_uri' , 'scope' , 'state' ) : try : duplicate_params = request . duplicate_params except ValueError : raise errors . InvalidRequestFatalError ( description = 'Unable to parse query string' , request = request...
Check the authorization request for normal and fatal errors .
35,771
def create_metadata_response ( self , uri , http_method = 'GET' , body = None , headers = None ) : headers = { 'Content-Type' : 'application/json' } return headers , json . dumps ( self . claims ) , 200
Create metadata response
35,772
def validate_metadata_token ( self , claims , endpoint ) : self . _grant_types . extend ( endpoint . _grant_types . keys ( ) ) claims . setdefault ( "token_endpoint_auth_methods_supported" , [ "client_secret_post" , "client_secret_basic" ] ) self . validate_metadata ( claims , "token_endpoint_auth_methods_supported" , ...
If the token endpoint is used in the grant type the value of this parameter MUST be the same as the value of the grant_type parameter passed to the token endpoint defined in the grant type definition .
35,773
def prepare_request_body ( self , code = None , redirect_uri = None , body = '' , include_client_id = True , ** kwargs ) : code = code or self . code if 'client_id' in kwargs : warnings . warn ( "`client_id` has been deprecated in favor of " "`include_client_id`, a boolean value which will " "include the already config...
Prepare the access token request body .
35,774
def parse_request_uri_response ( self , uri , state = None ) : response = parse_authorization_code_response ( uri , state = state ) self . populate_code_attributes ( response ) return response
Parse the URI query for code and state .
35,775
def add_token ( self , uri , http_method = 'GET' , body = None , headers = None , token_placement = None , ** kwargs ) : if not is_secure_transport ( uri ) : raise InsecureTransportError ( ) token_placement = token_placement or self . default_token_placement case_insensitive_token_types = dict ( ( k . lower ( ) , v ) f...
Add token to the request uri body or authorization header .
35,776
def prepare_authorization_request ( self , authorization_url , state = None , redirect_url = None , scope = None , ** kwargs ) : if not is_secure_transport ( authorization_url ) : raise InsecureTransportError ( ) self . state = state or self . state_generator ( ) self . redirect_url = redirect_url or self . redirect_ur...
Prepare the authorization request .
35,777
def prepare_token_request ( self , token_url , authorization_response = None , redirect_url = None , state = None , body = '' , ** kwargs ) : if not is_secure_transport ( token_url ) : raise InsecureTransportError ( ) state = state or self . state if authorization_response : self . parse_request_uri_response ( authoriz...
Prepare a token creation request .
35,778
def prepare_refresh_token_request ( self , token_url , refresh_token = None , body = '' , scope = None , ** kwargs ) : if not is_secure_transport ( token_url ) : raise InsecureTransportError ( ) self . scope = scope or self . scope body = self . prepare_refresh_body ( body = body , refresh_token = refresh_token , scope...
Prepare an access token refresh request .
35,779
def parse_request_body_response ( self , body , scope = None , ** kwargs ) : self . token = parse_token_response ( body , scope = scope ) self . populate_token_attributes ( self . token ) return self . token
Parse the JSON response body .
35,780
def prepare_refresh_body ( self , body = '' , refresh_token = None , scope = None , ** kwargs ) : refresh_token = refresh_token or self . refresh_token return prepare_token_request ( self . refresh_token_key , body = body , scope = scope , refresh_token = refresh_token , ** kwargs )
Prepare an access token request using a refresh token .
35,781
def _add_mac_token ( self , uri , http_method = 'GET' , body = None , headers = None , token_placement = AUTH_HEADER , ext = None , ** kwargs ) : if token_placement != AUTH_HEADER : raise ValueError ( "Invalid token placement." ) headers = tokens . prepare_mac_header ( self . access_token , uri , self . mac_key , http_...
Add a MAC token to the request authorization header .
35,782
def populate_token_attributes ( self , response ) : if 'access_token' in response : self . access_token = response . get ( 'access_token' ) if 'refresh_token' in response : self . refresh_token = response . get ( 'refresh_token' ) if 'token_type' in response : self . token_type = response . get ( 'token_type' ) if 'exp...
Add attributes from a token exchange response to self .
35,783
def _get_signature_type_and_params ( self , request ) : header_params = signature . collect_parameters ( headers = request . headers , exclude_oauth_signature = False , with_realm = True ) body_params = signature . collect_parameters ( body = request . body , exclude_oauth_signature = False ) query_params = signature ....
Extracts parameters from query headers and body . Signature type is set to the source in which parameters were found .
35,784
def create_token_response ( self , request , token_handler ) : headers = self . _get_default_headers ( ) try : if self . request_validator . client_authentication_required ( request ) : log . debug ( 'Authenticating client, %r.' , request ) if not self . request_validator . authenticate_client ( request ) : log . debug...
Return token or error in json format .
35,785
def check_client_key ( self , client_key ) : lower , upper = self . client_key_length return ( set ( client_key ) <= self . safe_characters and lower <= len ( client_key ) <= upper )
Check that the client key only contains safe characters and is no shorter than lower and no longer than upper .
35,786
def check_request_token ( self , request_token ) : lower , upper = self . request_token_length return ( set ( request_token ) <= self . safe_characters and lower <= len ( request_token ) <= upper )
Checks that the request token contains only safe characters and is no shorter than lower and no longer than upper .
35,787
def check_access_token ( self , request_token ) : lower , upper = self . access_token_length return ( set ( request_token ) <= self . safe_characters and lower <= len ( request_token ) <= upper )
Checks that the token contains only safe characters and is no shorter than lower and no longer than upper .
35,788
def check_nonce ( self , nonce ) : lower , upper = self . nonce_length return ( set ( nonce ) <= self . safe_characters and lower <= len ( nonce ) <= upper )
Checks that the nonce only contains only safe characters and is no shorter than lower and no longer than upper .
35,789
def check_verifier ( self , verifier ) : lower , upper = self . verifier_length return ( set ( verifier ) <= self . safe_characters and lower <= len ( verifier ) <= upper )
Checks that the verifier contains only safe characters and is no shorter than lower and no longer than upper .
35,790
def validate_timestamp_and_nonce ( self , client_key , timestamp , nonce , request , request_token = None , access_token = None ) : raise self . _subclass_must_implement ( "validate_timestamp_and_nonce" )
Validates that the nonce has not been used before .
35,791
def prepare_grant_uri ( uri , client_id , response_type , redirect_uri = None , scope = None , state = None , ** kwargs ) : if not is_secure_transport ( uri ) : raise InsecureTransportError ( ) params = [ ( ( 'response_type' , response_type ) ) , ( ( 'client_id' , client_id ) ) ] if redirect_uri : params . append ( ( '...
Prepare the authorization grant request URI .
35,792
def prepare_token_request ( grant_type , body = '' , include_client_id = True , ** kwargs ) : params = [ ( 'grant_type' , grant_type ) ] if 'scope' in kwargs : kwargs [ 'scope' ] = list_to_scope ( kwargs [ 'scope' ] ) client_id = kwargs . pop ( 'client_id' , None ) if include_client_id : if client_id is not None : para...
Prepare the access token request .
35,793
def parse_authorization_code_response ( uri , state = None ) : if not is_secure_transport ( uri ) : raise InsecureTransportError ( ) query = urlparse . urlparse ( uri ) . query params = dict ( urlparse . parse_qsl ( query ) ) if not 'code' in params : raise MissingCodeError ( "Missing code parameter in response." ) if ...
Parse authorization grant response URI into a dict .
35,794
def parse_implicit_response ( uri , state = None , scope = None ) : if not is_secure_transport ( uri ) : raise InsecureTransportError ( ) fragment = urlparse . urlparse ( uri ) . fragment params = dict ( urlparse . parse_qsl ( fragment , keep_blank_values = True ) ) for key in ( 'expires_in' , ) : if key in params : pa...
Parse the implicit token response URI into a dict .
35,795
def parse_token_response ( body , scope = None ) : try : params = json . loads ( body ) except ValueError : params = dict ( urlparse . parse_qsl ( body ) ) for key in ( 'expires_in' , ) : if key in params : params [ key ] = int ( params [ key ] ) if 'scope' in params : params [ 'scope' ] = scope_to_list ( params [ 'sco...
Parse the JSON token response body into a dict .
35,796
def validate_token_parameters ( params ) : if 'error' in params : raise_from_error ( params . get ( 'error' ) , params ) if not 'access_token' in params : raise MissingTokenError ( description = "Missing access token parameter." ) if not 'token_type' in params : if os . environ . get ( 'OAUTHLIB_STRICT_TOKEN_TYPE' ) : ...
Ensures token precence token type expiration and scope in params .
35,797
def prepare_request_body ( self , username , password , body = '' , scope = None , include_client_id = False , ** kwargs ) : kwargs [ 'client_id' ] = self . client_id kwargs [ 'include_client_id' ] = include_client_id return prepare_token_request ( self . grant_type , body = body , username = username , password = pass...
Add the resource owner password and username to the request body .
35,798
def prepare_request_uri ( self , uri , redirect_uri = None , scope = None , state = None , ** kwargs ) : return prepare_grant_uri ( uri , self . client_id , self . response_type , redirect_uri = redirect_uri , state = state , scope = scope , ** kwargs )
Prepare the implicit grant request URI .
35,799
def parse_request_uri_response ( self , uri , state = None , scope = None ) : self . token = parse_implicit_response ( uri , state = state , scope = scope ) self . populate_token_attributes ( self . token ) return self . token
Parse the response URI fragment .