id int32 0 252k | repo stringlengths 7 55 | path stringlengths 4 127 | func_name stringlengths 1 88 | original_string stringlengths 75 19.8k | language stringclasses 1
value | code stringlengths 51 19.8k | code_tokens list | docstring stringlengths 3 17.3k | docstring_tokens list | sha stringlengths 40 40 | url stringlengths 87 242 |
|---|---|---|---|---|---|---|---|---|---|---|---|
250,800 | pachyderm/python-pachyderm | src/python_pachyderm/pfs_client.py | PfsClient.get_file | def get_file(self, commit, path, offset_bytes=0, size_bytes=0, extract_value=True):
"""
Returns an iterator of the contents contents of a file at a specific Commit.
Params:
* commit: A tuple, string, or Commit object representing the commit.
* path: The path of the file.
... | python | def get_file(self, commit, path, offset_bytes=0, size_bytes=0, extract_value=True):
req = proto.GetFileRequest(
file=proto.File(commit=commit_from(commit), path=path),
offset_bytes=offset_bytes,
size_bytes=size_bytes
)
res = self.stub.GetFile(req, metadata=sel... | [
"def",
"get_file",
"(",
"self",
",",
"commit",
",",
"path",
",",
"offset_bytes",
"=",
"0",
",",
"size_bytes",
"=",
"0",
",",
"extract_value",
"=",
"True",
")",
":",
"req",
"=",
"proto",
".",
"GetFileRequest",
"(",
"file",
"=",
"proto",
".",
"File",
"... | Returns an iterator of the contents contents of a file at a specific Commit.
Params:
* commit: A tuple, string, or Commit object representing the commit.
* path: The path of the file.
* offset_bytes: Optional. specifies a number of bytes that should be
skipped in the beginning o... | [
"Returns",
"an",
"iterator",
"of",
"the",
"contents",
"contents",
"of",
"a",
"file",
"at",
"a",
"specific",
"Commit",
"."
] | 1c58cf91d30e03716a4f45213989e890f7b8a78c | https://github.com/pachyderm/python-pachyderm/blob/1c58cf91d30e03716a4f45213989e890f7b8a78c/src/python_pachyderm/pfs_client.py#L384-L409 |
250,801 | pachyderm/python-pachyderm | src/python_pachyderm/pfs_client.py | PfsClient.get_files | def get_files(self, commit, paths, recursive=False):
"""
Returns the contents of a list of files at a specific Commit as a
dictionary of file paths to data.
Params:
* commit: A tuple, string, or Commit object representing the commit.
* paths: A list of paths to retrieve.... | python | def get_files(self, commit, paths, recursive=False):
filtered_file_infos = []
for path in paths:
fi = self.inspect_file(commit, path)
if fi.file_type == proto.FILE:
filtered_file_infos.append(fi)
else:
filtered_file_infos += self.list_f... | [
"def",
"get_files",
"(",
"self",
",",
"commit",
",",
"paths",
",",
"recursive",
"=",
"False",
")",
":",
"filtered_file_infos",
"=",
"[",
"]",
"for",
"path",
"in",
"paths",
":",
"fi",
"=",
"self",
".",
"inspect_file",
"(",
"commit",
",",
"path",
")",
... | Returns the contents of a list of files at a specific Commit as a
dictionary of file paths to data.
Params:
* commit: A tuple, string, or Commit object representing the commit.
* paths: A list of paths to retrieve.
* recursive: If True, will go into each directory in the list
... | [
"Returns",
"the",
"contents",
"of",
"a",
"list",
"of",
"files",
"at",
"a",
"specific",
"Commit",
"as",
"a",
"dictionary",
"of",
"file",
"paths",
"to",
"data",
"."
] | 1c58cf91d30e03716a4f45213989e890f7b8a78c | https://github.com/pachyderm/python-pachyderm/blob/1c58cf91d30e03716a4f45213989e890f7b8a78c/src/python_pachyderm/pfs_client.py#L411-L432 |
250,802 | pachyderm/python-pachyderm | src/python_pachyderm/pfs_client.py | PfsClient.inspect_file | def inspect_file(self, commit, path):
"""
Returns info about a specific file.
Params:
* commit: A tuple, string, or Commit object representing the commit.
* path: Path to file.
"""
req = proto.InspectFileRequest(file=proto.File(commit=commit_from(commit), path=pa... | python | def inspect_file(self, commit, path):
req = proto.InspectFileRequest(file=proto.File(commit=commit_from(commit), path=path))
res = self.stub.InspectFile(req, metadata=self.metadata)
return res | [
"def",
"inspect_file",
"(",
"self",
",",
"commit",
",",
"path",
")",
":",
"req",
"=",
"proto",
".",
"InspectFileRequest",
"(",
"file",
"=",
"proto",
".",
"File",
"(",
"commit",
"=",
"commit_from",
"(",
"commit",
")",
",",
"path",
"=",
"path",
")",
")... | Returns info about a specific file.
Params:
* commit: A tuple, string, or Commit object representing the commit.
* path: Path to file. | [
"Returns",
"info",
"about",
"a",
"specific",
"file",
"."
] | 1c58cf91d30e03716a4f45213989e890f7b8a78c | https://github.com/pachyderm/python-pachyderm/blob/1c58cf91d30e03716a4f45213989e890f7b8a78c/src/python_pachyderm/pfs_client.py#L434-L444 |
250,803 | pachyderm/python-pachyderm | src/python_pachyderm/pfs_client.py | PfsClient.list_file | def list_file(self, commit, path, recursive=False):
"""
Lists the files in a directory.
Params:
* commit: A tuple, string, or Commit object representing the commit.
* path: The path to the directory.
* recursive: If True, continue listing the files for sub-directories.
... | python | def list_file(self, commit, path, recursive=False):
req = proto.ListFileRequest(
file=proto.File(commit=commit_from(commit), path=path)
)
res = self.stub.ListFile(req, metadata=self.metadata)
file_infos = res.file_info
if recursive:
dirs = [f for f in fil... | [
"def",
"list_file",
"(",
"self",
",",
"commit",
",",
"path",
",",
"recursive",
"=",
"False",
")",
":",
"req",
"=",
"proto",
".",
"ListFileRequest",
"(",
"file",
"=",
"proto",
".",
"File",
"(",
"commit",
"=",
"commit_from",
"(",
"commit",
")",
",",
"p... | Lists the files in a directory.
Params:
* commit: A tuple, string, or Commit object representing the commit.
* path: The path to the directory.
* recursive: If True, continue listing the files for sub-directories. | [
"Lists",
"the",
"files",
"in",
"a",
"directory",
"."
] | 1c58cf91d30e03716a4f45213989e890f7b8a78c | https://github.com/pachyderm/python-pachyderm/blob/1c58cf91d30e03716a4f45213989e890f7b8a78c/src/python_pachyderm/pfs_client.py#L446-L466 |
250,804 | pachyderm/python-pachyderm | src/python_pachyderm/pfs_client.py | PfsClient.delete_file | def delete_file(self, commit, path):
"""
Deletes a file from a Commit. DeleteFile leaves a tombstone in the
Commit, assuming the file isn't written to later attempting to get the
file from the finished commit will result in not found error. The file
will of course remain intact i... | python | def delete_file(self, commit, path):
req = proto.DeleteFileRequest(file=proto.File(commit=commit_from(commit), path=path))
self.stub.DeleteFile(req, metadata=self.metadata) | [
"def",
"delete_file",
"(",
"self",
",",
"commit",
",",
"path",
")",
":",
"req",
"=",
"proto",
".",
"DeleteFileRequest",
"(",
"file",
"=",
"proto",
".",
"File",
"(",
"commit",
"=",
"commit_from",
"(",
"commit",
")",
",",
"path",
"=",
"path",
")",
")",... | Deletes a file from a Commit. DeleteFile leaves a tombstone in the
Commit, assuming the file isn't written to later attempting to get the
file from the finished commit will result in not found error. The file
will of course remain intact in the Commit's parent.
Params:
* commit:... | [
"Deletes",
"a",
"file",
"from",
"a",
"Commit",
".",
"DeleteFile",
"leaves",
"a",
"tombstone",
"in",
"the",
"Commit",
"assuming",
"the",
"file",
"isn",
"t",
"written",
"to",
"later",
"attempting",
"to",
"get",
"the",
"file",
"from",
"the",
"finished",
"comm... | 1c58cf91d30e03716a4f45213989e890f7b8a78c | https://github.com/pachyderm/python-pachyderm/blob/1c58cf91d30e03716a4f45213989e890f7b8a78c/src/python_pachyderm/pfs_client.py#L475-L487 |
250,805 | IdentityPython/SATOSA | src/satosa/frontends/saml2.py | SAMLFrontend.handle_authn_request | def handle_authn_request(self, context, binding_in):
"""
This method is bound to the starting endpoint of the authentication.
:type context: satosa.context.Context
:type binding_in: str
:rtype: satosa.response.Response
:param context: The current context
:param ... | python | def handle_authn_request(self, context, binding_in):
return self._handle_authn_request(context, binding_in, self.idp) | [
"def",
"handle_authn_request",
"(",
"self",
",",
"context",
",",
"binding_in",
")",
":",
"return",
"self",
".",
"_handle_authn_request",
"(",
"context",
",",
"binding_in",
",",
"self",
".",
"idp",
")"
] | This method is bound to the starting endpoint of the authentication.
:type context: satosa.context.Context
:type binding_in: str
:rtype: satosa.response.Response
:param context: The current context
:param binding_in: The binding type (http post, http redirect, ...)
:ret... | [
"This",
"method",
"is",
"bound",
"to",
"the",
"starting",
"endpoint",
"of",
"the",
"authentication",
"."
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/frontends/saml2.py#L90-L102 |
250,806 | IdentityPython/SATOSA | src/satosa/frontends/saml2.py | SAMLFrontend._create_state_data | def _create_state_data(self, context, resp_args, relay_state):
"""
Returns a dict containing the state needed in the response flow.
:type context: satosa.context.Context
:type resp_args: dict[str, str | saml2.samlp.NameIDPolicy]
:type relay_state: str
:rtype: dict[str, d... | python | def _create_state_data(self, context, resp_args, relay_state):
if "name_id_policy" in resp_args and resp_args["name_id_policy"] is not None:
resp_args["name_id_policy"] = resp_args["name_id_policy"].to_string().decode("utf-8")
return {"resp_args": resp_args, "relay_state": relay_state} | [
"def",
"_create_state_data",
"(",
"self",
",",
"context",
",",
"resp_args",
",",
"relay_state",
")",
":",
"if",
"\"name_id_policy\"",
"in",
"resp_args",
"and",
"resp_args",
"[",
"\"name_id_policy\"",
"]",
"is",
"not",
"None",
":",
"resp_args",
"[",
"\"name_id_po... | Returns a dict containing the state needed in the response flow.
:type context: satosa.context.Context
:type resp_args: dict[str, str | saml2.samlp.NameIDPolicy]
:type relay_state: str
:rtype: dict[str, dict[str, str] | str]
:param context: The current context
:param re... | [
"Returns",
"a",
"dict",
"containing",
"the",
"state",
"needed",
"in",
"the",
"response",
"flow",
"."
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/frontends/saml2.py#L125-L141 |
250,807 | IdentityPython/SATOSA | src/satosa/frontends/saml2.py | SAMLFrontend._handle_authn_request | def _handle_authn_request(self, context, binding_in, idp):
"""
See doc for handle_authn_request method.
:type context: satosa.context.Context
:type binding_in: str
:type idp: saml.server.Server
:rtype: satosa.response.Response
:param context: The current context... | python | def _handle_authn_request(self, context, binding_in, idp):
req_info = idp.parse_authn_request(context.request["SAMLRequest"], binding_in)
authn_req = req_info.message
satosa_logging(logger, logging.DEBUG, "%s" % authn_req, context.state)
try:
resp_args = idp.response_args(au... | [
"def",
"_handle_authn_request",
"(",
"self",
",",
"context",
",",
"binding_in",
",",
"idp",
")",
":",
"req_info",
"=",
"idp",
".",
"parse_authn_request",
"(",
"context",
".",
"request",
"[",
"\"SAMLRequest\"",
"]",
",",
"binding_in",
")",
"authn_req",
"=",
"... | See doc for handle_authn_request method.
:type context: satosa.context.Context
:type binding_in: str
:type idp: saml.server.Server
:rtype: satosa.response.Response
:param context: The current context
:param binding_in: The pysaml binding type
:param idp: The sam... | [
"See",
"doc",
"for",
"handle_authn_request",
"method",
"."
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/frontends/saml2.py#L177-L245 |
250,808 | IdentityPython/SATOSA | src/satosa/frontends/saml2.py | SAMLFrontend._get_approved_attributes | def _get_approved_attributes(self, idp, idp_policy, sp_entity_id, state):
"""
Returns a list of approved attributes
:type idp: saml.server.Server
:type idp_policy: saml2.assertion.Policy
:type sp_entity_id: str
:type state: satosa.state.State
:rtype: list[str]
... | python | def _get_approved_attributes(self, idp, idp_policy, sp_entity_id, state):
name_format = idp_policy.get_name_form(sp_entity_id)
attrconvs = idp.config.attribute_converters
idp_policy.acs = attrconvs
attribute_filter = []
for aconv in attrconvs:
if aconv.name_format == ... | [
"def",
"_get_approved_attributes",
"(",
"self",
",",
"idp",
",",
"idp_policy",
",",
"sp_entity_id",
",",
"state",
")",
":",
"name_format",
"=",
"idp_policy",
".",
"get_name_form",
"(",
"sp_entity_id",
")",
"attrconvs",
"=",
"idp",
".",
"config",
".",
"attribut... | Returns a list of approved attributes
:type idp: saml.server.Server
:type idp_policy: saml2.assertion.Policy
:type sp_entity_id: str
:type state: satosa.state.State
:rtype: list[str]
:param idp: The saml frontend idp server
:param idp_policy: The idp policy
... | [
"Returns",
"a",
"list",
"of",
"approved",
"attributes"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/frontends/saml2.py#L247-L274 |
250,809 | IdentityPython/SATOSA | src/satosa/frontends/saml2.py | SAMLFrontend._build_idp_config_endpoints | def _build_idp_config_endpoints(self, config, providers):
"""
Builds the final frontend module config
:type config: dict[str, Any]
:type providers: list[str]
:rtype: dict[str, Any]
:param config: The module config
:param providers: A list of backend names
... | python | def _build_idp_config_endpoints(self, config, providers):
# Add an endpoint to each provider
idp_endpoints = []
for endp_category in self.endpoints:
for func, endpoint in self.endpoints[endp_category].items():
for provider in providers:
_endpoint =... | [
"def",
"_build_idp_config_endpoints",
"(",
"self",
",",
"config",
",",
"providers",
")",
":",
"# Add an endpoint to each provider",
"idp_endpoints",
"=",
"[",
"]",
"for",
"endp_category",
"in",
"self",
".",
"endpoints",
":",
"for",
"func",
",",
"endpoint",
"in",
... | Builds the final frontend module config
:type config: dict[str, Any]
:type providers: list[str]
:rtype: dict[str, Any]
:param config: The module config
:param providers: A list of backend names
:return: The final config | [
"Builds",
"the",
"final",
"frontend",
"module",
"config"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/frontends/saml2.py#L522-L544 |
250,810 | IdentityPython/SATOSA | src/satosa/frontends/saml2.py | SAMLMirrorFrontend._load_endpoints_to_config | def _load_endpoints_to_config(self, provider, target_entity_id, config=None):
"""
Loads approved endpoints to the config.
:type url_base: str
:type provider: str
:type target_entity_id: str
:rtype: dict[str, Any]
:param url_base: The proxy base url
:para... | python | def _load_endpoints_to_config(self, provider, target_entity_id, config=None):
idp_conf = copy.deepcopy(config or self.idp_config)
for service, endpoint in self.endpoints.items():
idp_endpoints = []
for binding, path in endpoint.items():
url = "{base}/{provider}/{t... | [
"def",
"_load_endpoints_to_config",
"(",
"self",
",",
"provider",
",",
"target_entity_id",
",",
"config",
"=",
"None",
")",
":",
"idp_conf",
"=",
"copy",
".",
"deepcopy",
"(",
"config",
"or",
"self",
".",
"idp_config",
")",
"for",
"service",
",",
"endpoint",... | Loads approved endpoints to the config.
:type url_base: str
:type provider: str
:type target_entity_id: str
:rtype: dict[str, Any]
:param url_base: The proxy base url
:param provider: target backend name
:param target_entity_id: frontend target entity id
... | [
"Loads",
"approved",
"endpoints",
"to",
"the",
"config",
"."
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/frontends/saml2.py#L564-L587 |
250,811 | IdentityPython/SATOSA | src/satosa/frontends/saml2.py | SAMLMirrorFrontend._load_idp_dynamic_entity_id | def _load_idp_dynamic_entity_id(self, state):
"""
Loads an idp server with the entity id saved in state
:type state: satosa.state.State
:rtype: saml.server.Server
:param state: The current state
:return: An idp server
"""
# Change the idp entity id dynam... | python | def _load_idp_dynamic_entity_id(self, state):
# Change the idp entity id dynamically
idp_config_file = copy.deepcopy(self.idp_config)
idp_config_file["entityid"] = "{}/{}".format(self.idp_config["entityid"], state[self.name]["target_entity_id"])
idp_config = IdPConfig().load(idp_config_f... | [
"def",
"_load_idp_dynamic_entity_id",
"(",
"self",
",",
"state",
")",
":",
"# Change the idp entity id dynamically",
"idp_config_file",
"=",
"copy",
".",
"deepcopy",
"(",
"self",
".",
"idp_config",
")",
"idp_config_file",
"[",
"\"entityid\"",
"]",
"=",
"\"{}/{}\"",
... | Loads an idp server with the entity id saved in state
:type state: satosa.state.State
:rtype: saml.server.Server
:param state: The current state
:return: An idp server | [
"Loads",
"an",
"idp",
"server",
"with",
"the",
"entity",
"id",
"saved",
"in",
"state"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/frontends/saml2.py#L605-L619 |
250,812 | IdentityPython/SATOSA | src/satosa/frontends/saml2.py | SAMLVirtualCoFrontend._get_co_name_from_path | def _get_co_name_from_path(self, context):
"""
The CO name is URL encoded and obtained from the request path
for a request coming into one of the standard binding endpoints.
For example the HTTP-Redirect binding request path will have the
format
{base}/{backend}/{co_name... | python | def _get_co_name_from_path(self, context):
url_encoded_co_name = context.path.split("/")[1]
co_name = unquote_plus(url_encoded_co_name)
return co_name | [
"def",
"_get_co_name_from_path",
"(",
"self",
",",
"context",
")",
":",
"url_encoded_co_name",
"=",
"context",
".",
"path",
".",
"split",
"(",
"\"/\"",
")",
"[",
"1",
"]",
"co_name",
"=",
"unquote_plus",
"(",
"url_encoded_co_name",
")",
"return",
"co_name"
] | The CO name is URL encoded and obtained from the request path
for a request coming into one of the standard binding endpoints.
For example the HTTP-Redirect binding request path will have the
format
{base}/{backend}/{co_name}/sso/redirect
:type context: satosa.context.Context
... | [
"The",
"CO",
"name",
"is",
"URL",
"encoded",
"and",
"obtained",
"from",
"the",
"request",
"path",
"for",
"a",
"request",
"coming",
"into",
"one",
"of",
"the",
"standard",
"binding",
"endpoints",
".",
"For",
"example",
"the",
"HTTP",
"-",
"Redirect",
"bindi... | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/frontends/saml2.py#L750-L768 |
250,813 | IdentityPython/SATOSA | src/satosa/frontends/saml2.py | SAMLVirtualCoFrontend._get_co_name | def _get_co_name(self, context):
"""
Obtain the CO name previously saved in the request state, or if not set
use the request path obtained from the current context to determine
the target CO.
:type context: The current context
:rtype: string
:param context: The ... | python | def _get_co_name(self, context):
try:
co_name = context.state[self.name][self.KEY_CO_NAME]
logger.debug("Found CO {} from state".format(co_name))
except KeyError:
co_name = self._get_co_name_from_path(context)
logger.debug("Found CO {} from request path".f... | [
"def",
"_get_co_name",
"(",
"self",
",",
"context",
")",
":",
"try",
":",
"co_name",
"=",
"context",
".",
"state",
"[",
"self",
".",
"name",
"]",
"[",
"self",
".",
"KEY_CO_NAME",
"]",
"logger",
".",
"debug",
"(",
"\"Found CO {} from state\"",
".",
"forma... | Obtain the CO name previously saved in the request state, or if not set
use the request path obtained from the current context to determine
the target CO.
:type context: The current context
:rtype: string
:param context: The current context
:return: CO name | [
"Obtain",
"the",
"CO",
"name",
"previously",
"saved",
"in",
"the",
"request",
"state",
"or",
"if",
"not",
"set",
"use",
"the",
"request",
"path",
"obtained",
"from",
"the",
"current",
"context",
"to",
"determine",
"the",
"target",
"CO",
"."
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/frontends/saml2.py#L770-L789 |
250,814 | IdentityPython/SATOSA | src/satosa/frontends/saml2.py | SAMLVirtualCoFrontend._add_endpoints_to_config | def _add_endpoints_to_config(self, config, co_name, backend_name):
"""
Use the request path from the context to determine the target backend,
then construct mappings from bindings to endpoints for the virtual
IdP for the CO.
The endpoint URLs have the form
{base}/{backe... | python | def _add_endpoints_to_config(self, config, co_name, backend_name):
for service, endpoint in self.endpoints.items():
idp_endpoints = []
for binding, path in endpoint.items():
url = "{base}/{backend}/{co_name}/{path}".format(
base=self.base_url,
... | [
"def",
"_add_endpoints_to_config",
"(",
"self",
",",
"config",
",",
"co_name",
",",
"backend_name",
")",
":",
"for",
"service",
",",
"endpoint",
"in",
"self",
".",
"endpoints",
".",
"items",
"(",
")",
":",
"idp_endpoints",
"=",
"[",
"]",
"for",
"binding",
... | Use the request path from the context to determine the target backend,
then construct mappings from bindings to endpoints for the virtual
IdP for the CO.
The endpoint URLs have the form
{base}/{backend}/{co_name}/{path}
:type config: satosa.satosa_config.SATOSAConfig
:... | [
"Use",
"the",
"request",
"path",
"from",
"the",
"context",
"to",
"determine",
"the",
"target",
"backend",
"then",
"construct",
"mappings",
"from",
"bindings",
"to",
"endpoints",
"for",
"the",
"virtual",
"IdP",
"for",
"the",
"CO",
"."
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/frontends/saml2.py#L791-L828 |
250,815 | IdentityPython/SATOSA | src/satosa/frontends/saml2.py | SAMLVirtualCoFrontend._add_entity_id | def _add_entity_id(self, config, co_name):
"""
Use the CO name to construct the entity ID for the virtual IdP
for the CO.
The entity ID has the form
{base_entity_id}/{co_name}
:type config: satosa.satosa_config.SATOSAConfig
:type co_name: str
:rtype: sa... | python | def _add_entity_id(self, config, co_name):
base_entity_id = config['entityid']
co_entity_id = "{}/{}".format(base_entity_id, quote_plus(co_name))
config['entityid'] = co_entity_id
return config | [
"def",
"_add_entity_id",
"(",
"self",
",",
"config",
",",
"co_name",
")",
":",
"base_entity_id",
"=",
"config",
"[",
"'entityid'",
"]",
"co_entity_id",
"=",
"\"{}/{}\"",
".",
"format",
"(",
"base_entity_id",
",",
"quote_plus",
"(",
"co_name",
")",
")",
"conf... | Use the CO name to construct the entity ID for the virtual IdP
for the CO.
The entity ID has the form
{base_entity_id}/{co_name}
:type config: satosa.satosa_config.SATOSAConfig
:type co_name: str
:rtype: satosa.satosa_config.SATOSAConfig
:param config: satosa ... | [
"Use",
"the",
"CO",
"name",
"to",
"construct",
"the",
"entity",
"ID",
"for",
"the",
"virtual",
"IdP",
"for",
"the",
"CO",
"."
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/frontends/saml2.py#L830-L852 |
250,816 | IdentityPython/SATOSA | src/satosa/frontends/saml2.py | SAMLVirtualCoFrontend._overlay_for_saml_metadata | def _overlay_for_saml_metadata(self, config, co_name):
"""
Overlay configuration details like organization and contact person
from the front end configuration onto the IdP configuration to
support SAML metadata generation.
:type config: satosa.satosa_config.SATOSAConfig
... | python | def _overlay_for_saml_metadata(self, config, co_name):
for co in self.config[self.KEY_CO]:
if co[self.KEY_ENCODEABLE_NAME] == co_name:
break
key = self.KEY_ORGANIZATION
if key in co:
if key not in config:
config[key] = {}
for o... | [
"def",
"_overlay_for_saml_metadata",
"(",
"self",
",",
"config",
",",
"co_name",
")",
":",
"for",
"co",
"in",
"self",
".",
"config",
"[",
"self",
".",
"KEY_CO",
"]",
":",
"if",
"co",
"[",
"self",
".",
"KEY_ENCODEABLE_NAME",
"]",
"==",
"co_name",
":",
"... | Overlay configuration details like organization and contact person
from the front end configuration onto the IdP configuration to
support SAML metadata generation.
:type config: satosa.satosa_config.SATOSAConfig
:type co_name: str
:rtype: satosa.satosa_config.SATOSAConfig
... | [
"Overlay",
"configuration",
"details",
"like",
"organization",
"and",
"contact",
"person",
"from",
"the",
"front",
"end",
"configuration",
"onto",
"the",
"IdP",
"configuration",
"to",
"support",
"SAML",
"metadata",
"generation",
"."
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/frontends/saml2.py#L854-L885 |
250,817 | IdentityPython/SATOSA | src/satosa/frontends/saml2.py | SAMLVirtualCoFrontend._co_names_from_config | def _co_names_from_config(self):
"""
Parse the configuration for the names of the COs for which to
construct virtual IdPs.
:rtype: [str]
:return: list of CO names
"""
co_names = [co[self.KEY_ENCODEABLE_NAME] for
co in self.config[self.KEY_CO]... | python | def _co_names_from_config(self):
co_names = [co[self.KEY_ENCODEABLE_NAME] for
co in self.config[self.KEY_CO]]
return co_names | [
"def",
"_co_names_from_config",
"(",
"self",
")",
":",
"co_names",
"=",
"[",
"co",
"[",
"self",
".",
"KEY_ENCODEABLE_NAME",
"]",
"for",
"co",
"in",
"self",
".",
"config",
"[",
"self",
".",
"KEY_CO",
"]",
"]",
"return",
"co_names"
] | Parse the configuration for the names of the COs for which to
construct virtual IdPs.
:rtype: [str]
:return: list of CO names | [
"Parse",
"the",
"configuration",
"for",
"the",
"names",
"of",
"the",
"COs",
"for",
"which",
"to",
"construct",
"virtual",
"IdPs",
"."
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/frontends/saml2.py#L887-L899 |
250,818 | IdentityPython/SATOSA | src/satosa/frontends/saml2.py | SAMLVirtualCoFrontend._create_co_virtual_idp | def _create_co_virtual_idp(self, context):
"""
Create a virtual IdP to represent the CO.
:type context: The current context
:rtype: saml.server.Server
:param context:
:return: An idp server
"""
co_name = self._get_co_name(context)
context.decorat... | python | def _create_co_virtual_idp(self, context):
co_name = self._get_co_name(context)
context.decorate(self.KEY_CO_NAME, co_name)
# Verify that we are configured for this CO. If the CO was not
# configured most likely the endpoint used was not registered and
# SATOSA core code threw a... | [
"def",
"_create_co_virtual_idp",
"(",
"self",
",",
"context",
")",
":",
"co_name",
"=",
"self",
".",
"_get_co_name",
"(",
"context",
")",
"context",
".",
"decorate",
"(",
"self",
".",
"KEY_CO_NAME",
",",
"co_name",
")",
"# Verify that we are configured for this CO... | Create a virtual IdP to represent the CO.
:type context: The current context
:rtype: saml.server.Server
:param context:
:return: An idp server | [
"Create",
"a",
"virtual",
"IdP",
"to",
"represent",
"the",
"CO",
"."
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/frontends/saml2.py#L901-L943 |
250,819 | IdentityPython/SATOSA | src/satosa/backends/oauth.py | _OAuthBackend._authn_response | def _authn_response(self, context):
"""
Handles the authentication response from the AS.
:type context: satosa.context.Context
:rtype: satosa.response.Response
:param context: The context in SATOSA
:return: A SATOSA response. This method is only responsible to call the c... | python | def _authn_response(self, context):
state_data = context.state[self.name]
aresp = self.consumer.parse_response(AuthorizationResponse, info=json.dumps(context.request))
self._verify_state(aresp, state_data, context.state)
rargs = {"code": aresp["code"], "redirect_uri": self.redirect_url,... | [
"def",
"_authn_response",
"(",
"self",
",",
"context",
")",
":",
"state_data",
"=",
"context",
".",
"state",
"[",
"self",
".",
"name",
"]",
"aresp",
"=",
"self",
".",
"consumer",
".",
"parse_response",
"(",
"AuthorizationResponse",
",",
"info",
"=",
"json"... | Handles the authentication response from the AS.
:type context: satosa.context.Context
:rtype: satosa.response.Response
:param context: The context in SATOSA
:return: A SATOSA response. This method is only responsible to call the callback function
which generates the Response ob... | [
"Handles",
"the",
"authentication",
"response",
"from",
"the",
"AS",
"."
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/backends/oauth.py#L117-L143 |
250,820 | IdentityPython/SATOSA | src/satosa/util.py | hash_data | def hash_data(salt, value, hash_alg=None):
"""
Hashes a value together with a salt with the given hash algorithm.
:type salt: str
:type hash_alg: str
:type value: str
:param salt: hash salt
:param hash_alg: the hash algorithm to use (default: SHA512)
:param value: value to hash together... | python | def hash_data(salt, value, hash_alg=None):
hash_alg = hash_alg or 'sha512'
hasher = hashlib.new(hash_alg)
hasher.update(value.encode('utf-8'))
hasher.update(salt.encode('utf-8'))
value_hashed = hasher.hexdigest()
return value_hashed | [
"def",
"hash_data",
"(",
"salt",
",",
"value",
",",
"hash_alg",
"=",
"None",
")",
":",
"hash_alg",
"=",
"hash_alg",
"or",
"'sha512'",
"hasher",
"=",
"hashlib",
".",
"new",
"(",
"hash_alg",
")",
"hasher",
".",
"update",
"(",
"value",
".",
"encode",
"(",... | Hashes a value together with a salt with the given hash algorithm.
:type salt: str
:type hash_alg: str
:type value: str
:param salt: hash salt
:param hash_alg: the hash algorithm to use (default: SHA512)
:param value: value to hash together with the salt
:return: hashed value | [
"Hashes",
"a",
"value",
"together",
"with",
"a",
"salt",
"with",
"the",
"given",
"hash",
"algorithm",
"."
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/util.py#L15-L32 |
250,821 | IdentityPython/SATOSA | src/satosa/micro_services/ldap_attribute_store.py | LdapAttributeStore._construct_filter_value | def _construct_filter_value(self, candidate, data):
"""
Construct and return a LDAP directory search filter value from the
candidate identifier.
Argument 'canidate' is a dictionary with one required key and
two optional keys:
key required value
--... | python | def _construct_filter_value(self, candidate, data):
context = self.context
attributes = data.attributes
satosa_logging(logger, logging.DEBUG, "Input attributes {}".format(attributes), context.state)
# Get the values configured list of identifier names for this candidate
# and s... | [
"def",
"_construct_filter_value",
"(",
"self",
",",
"candidate",
",",
"data",
")",
":",
"context",
"=",
"self",
".",
"context",
"attributes",
"=",
"data",
".",
"attributes",
"satosa_logging",
"(",
"logger",
",",
"logging",
".",
"DEBUG",
",",
"\"Input attribute... | Construct and return a LDAP directory search filter value from the
candidate identifier.
Argument 'canidate' is a dictionary with one required key and
two optional keys:
key required value
--------------- -------- ---------------------------------
attr... | [
"Construct",
"and",
"return",
"a",
"LDAP",
"directory",
"search",
"filter",
"value",
"from",
"the",
"candidate",
"identifier",
"."
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/micro_services/ldap_attribute_store.py#L119-L214 |
250,822 | IdentityPython/SATOSA | src/satosa/micro_services/ldap_attribute_store.py | LdapAttributeStore._filter_config | def _filter_config(self, config, fields=None):
"""
Filter sensitive details like passwords from a configuration
dictionary.
"""
filter_fields_default = [
'bind_password',
'connection'
]
filter_fields = fields or filter_fields_default
... | python | def _filter_config(self, config, fields=None):
filter_fields_default = [
'bind_password',
'connection'
]
filter_fields = fields or filter_fields_default
return dict(
map(
lambda key: (key, '<hidden>' if key in filter_fields else co... | [
"def",
"_filter_config",
"(",
"self",
",",
"config",
",",
"fields",
"=",
"None",
")",
":",
"filter_fields_default",
"=",
"[",
"'bind_password'",
",",
"'connection'",
"]",
"filter_fields",
"=",
"fields",
"or",
"filter_fields_default",
"return",
"dict",
"(",
"map"... | Filter sensitive details like passwords from a configuration
dictionary. | [
"Filter",
"sensitive",
"details",
"like",
"passwords",
"from",
"a",
"configuration",
"dictionary",
"."
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/micro_services/ldap_attribute_store.py#L216-L232 |
250,823 | IdentityPython/SATOSA | src/satosa/micro_services/ldap_attribute_store.py | LdapAttributeStore._ldap_connection_factory | def _ldap_connection_factory(self, config):
"""
Use the input configuration to instantiate and return
a ldap3 Connection object.
"""
ldap_url = config['ldap_url']
bind_dn = config['bind_dn']
bind_password = config['bind_password']
if not ldap_url:
... | python | def _ldap_connection_factory(self, config):
ldap_url = config['ldap_url']
bind_dn = config['bind_dn']
bind_password = config['bind_password']
if not ldap_url:
raise LdapAttributeStoreError("ldap_url is not configured")
if not bind_dn:
raise LdapAttributeS... | [
"def",
"_ldap_connection_factory",
"(",
"self",
",",
"config",
")",
":",
"ldap_url",
"=",
"config",
"[",
"'ldap_url'",
"]",
"bind_dn",
"=",
"config",
"[",
"'bind_dn'",
"]",
"bind_password",
"=",
"config",
"[",
"'bind_password'",
"]",
"if",
"not",
"ldap_url",
... | Use the input configuration to instantiate and return
a ldap3 Connection object. | [
"Use",
"the",
"input",
"configuration",
"to",
"instantiate",
"and",
"return",
"a",
"ldap3",
"Connection",
"object",
"."
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/micro_services/ldap_attribute_store.py#L234-L279 |
250,824 | IdentityPython/SATOSA | src/satosa/micro_services/ldap_attribute_store.py | LdapAttributeStore._populate_attributes | def _populate_attributes(self, config, record, context, data):
"""
Use a record found in LDAP to populate attributes.
"""
search_return_attributes = config['search_return_attributes']
for attr in search_return_attributes.keys():
if attr in record["attributes"]:
... | python | def _populate_attributes(self, config, record, context, data):
search_return_attributes = config['search_return_attributes']
for attr in search_return_attributes.keys():
if attr in record["attributes"]:
if record["attributes"][attr]:
data.attributes[search... | [
"def",
"_populate_attributes",
"(",
"self",
",",
"config",
",",
"record",
",",
"context",
",",
"data",
")",
":",
"search_return_attributes",
"=",
"config",
"[",
"'search_return_attributes'",
"]",
"for",
"attr",
"in",
"search_return_attributes",
".",
"keys",
"(",
... | Use a record found in LDAP to populate attributes. | [
"Use",
"a",
"record",
"found",
"in",
"LDAP",
"to",
"populate",
"attributes",
"."
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/micro_services/ldap_attribute_store.py#L281-L308 |
250,825 | IdentityPython/SATOSA | src/satosa/micro_services/ldap_attribute_store.py | LdapAttributeStore._populate_input_for_name_id | def _populate_input_for_name_id(self, config, record, context, data):
"""
Use a record found in LDAP to populate input for
NameID generation.
"""
user_id = ""
user_id_from_attrs = config['user_id_from_attrs']
for attr in user_id_from_attrs:
if attr in ... | python | def _populate_input_for_name_id(self, config, record, context, data):
user_id = ""
user_id_from_attrs = config['user_id_from_attrs']
for attr in user_id_from_attrs:
if attr in record["attributes"]:
value = record["attributes"][attr]
if isinstance(value... | [
"def",
"_populate_input_for_name_id",
"(",
"self",
",",
"config",
",",
"record",
",",
"context",
",",
"data",
")",
":",
"user_id",
"=",
"\"\"",
"user_id_from_attrs",
"=",
"config",
"[",
"'user_id_from_attrs'",
"]",
"for",
"attr",
"in",
"user_id_from_attrs",
":",... | Use a record found in LDAP to populate input for
NameID generation. | [
"Use",
"a",
"record",
"found",
"in",
"LDAP",
"to",
"populate",
"input",
"for",
"NameID",
"generation",
"."
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/micro_services/ldap_attribute_store.py#L310-L354 |
250,826 | IdentityPython/SATOSA | src/satosa/satosa_config.py | SATOSAConfig._verify_dict | def _verify_dict(self, conf):
"""
Check that the configuration contains all necessary keys.
:type conf: dict
:rtype: None
:raise SATOSAConfigurationError: if the configuration is incorrect
:param conf: config to verify
:return: None
"""
if not co... | python | def _verify_dict(self, conf):
if not conf:
raise SATOSAConfigurationError("Missing configuration or unknown format")
for key in SATOSAConfig.mandatory_dict_keys:
if key not in conf:
raise SATOSAConfigurationError("Missing key '%s' in config" % key)
for k... | [
"def",
"_verify_dict",
"(",
"self",
",",
"conf",
")",
":",
"if",
"not",
"conf",
":",
"raise",
"SATOSAConfigurationError",
"(",
"\"Missing configuration or unknown format\"",
")",
"for",
"key",
"in",
"SATOSAConfig",
".",
"mandatory_dict_keys",
":",
"if",
"key",
"no... | Check that the configuration contains all necessary keys.
:type conf: dict
:rtype: None
:raise SATOSAConfigurationError: if the configuration is incorrect
:param conf: config to verify
:return: None | [
"Check",
"that",
"the",
"configuration",
"contains",
"all",
"necessary",
"keys",
"."
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/satosa_config.py#L68-L88 |
250,827 | IdentityPython/SATOSA | src/satosa/satosa_config.py | SATOSAConfig._load_yaml | def _load_yaml(self, config_file):
"""
Load config from yaml file or string
:type config_file: str
:rtype: dict
:param config_file: config to load. Can be file path or yaml string
:return: Loaded config
"""
try:
with open(config_file) as f:
... | python | def _load_yaml(self, config_file):
try:
with open(config_file) as f:
return yaml.safe_load(f.read())
except yaml.YAMLError as exc:
logger.error("Could not parse config as YAML: {}", str(exc))
if hasattr(exc, 'problem_mark'):
mark = exc.... | [
"def",
"_load_yaml",
"(",
"self",
",",
"config_file",
")",
":",
"try",
":",
"with",
"open",
"(",
"config_file",
")",
"as",
"f",
":",
"return",
"yaml",
".",
"safe_load",
"(",
"f",
".",
"read",
"(",
")",
")",
"except",
"yaml",
".",
"YAMLError",
"as",
... | Load config from yaml file or string
:type config_file: str
:rtype: dict
:param config_file: config to load. Can be file path or yaml string
:return: Loaded config | [
"Load",
"config",
"from",
"yaml",
"file",
"or",
"string"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/satosa_config.py#L136-L157 |
250,828 | IdentityPython/SATOSA | src/satosa/logging_util.py | satosa_logging | def satosa_logging(logger, level, message, state, **kwargs):
"""
Adds a session ID to the message.
:type logger: logging
:type level: int
:type message: str
:type state: satosa.state.State
:param logger: Logger to use
:param level: Logger level (ex: logging.DEBUG/logging.WARN/...)
... | python | def satosa_logging(logger, level, message, state, **kwargs):
if state is None:
session_id = "UNKNOWN"
else:
try:
session_id = state[LOGGER_STATE_KEY]
except KeyError:
session_id = uuid4().urn
state[LOGGER_STATE_KEY] = session_id
logger.log(level, "... | [
"def",
"satosa_logging",
"(",
"logger",
",",
"level",
",",
"message",
",",
"state",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"state",
"is",
"None",
":",
"session_id",
"=",
"\"UNKNOWN\"",
"else",
":",
"try",
":",
"session_id",
"=",
"state",
"[",
"LOGGER... | Adds a session ID to the message.
:type logger: logging
:type level: int
:type message: str
:type state: satosa.state.State
:param logger: Logger to use
:param level: Logger level (ex: logging.DEBUG/logging.WARN/...)
:param message: Message
:param state: The current state
:param kw... | [
"Adds",
"a",
"session",
"ID",
"to",
"the",
"message",
"."
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/logging_util.py#L10-L33 |
250,829 | IdentityPython/SATOSA | src/satosa/micro_services/consent.py | Consent.process | def process(self, context, internal_response):
"""
Manage consent and attribute filtering
:type context: satosa.context.Context
:type internal_response: satosa.internal.InternalData
:rtype: satosa.response.Response
:param context: response context
:param interna... | python | def process(self, context, internal_response):
consent_state = context.state[STATE_KEY]
internal_response.attributes = self._filter_attributes(internal_response.attributes, consent_state["filter"])
id_hash = self._get_consent_id(internal_response.requester, internal_response.subject_id,
... | [
"def",
"process",
"(",
"self",
",",
"context",
",",
"internal_response",
")",
":",
"consent_state",
"=",
"context",
".",
"state",
"[",
"STATE_KEY",
"]",
"internal_response",
".",
"attributes",
"=",
"self",
".",
"_filter_attributes",
"(",
"internal_response",
"."... | Manage consent and attribute filtering
:type context: satosa.context.Context
:type internal_response: satosa.internal.InternalData
:rtype: satosa.response.Response
:param context: response context
:param internal_response: the response
:return: response | [
"Manage",
"consent",
"and",
"attribute",
"filtering"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/micro_services/consent.py#L106-L141 |
250,830 | IdentityPython/SATOSA | src/satosa/micro_services/consent.py | Consent._get_consent_id | def _get_consent_id(self, requester, user_id, filtered_attr):
"""
Get a hashed id based on requester, user id and filtered attributes
:type requester: str
:type user_id: str
:type filtered_attr: dict[str, str]
:param requester: The calling requester
:param user_... | python | def _get_consent_id(self, requester, user_id, filtered_attr):
filtered_attr_key_list = sorted(filtered_attr.keys())
hash_str = ""
for key in filtered_attr_key_list:
_hash_value = "".join(sorted(filtered_attr[key]))
hash_str += key + _hash_value
id_string = "%s%s%s... | [
"def",
"_get_consent_id",
"(",
"self",
",",
"requester",
",",
"user_id",
",",
"filtered_attr",
")",
":",
"filtered_attr_key_list",
"=",
"sorted",
"(",
"filtered_attr",
".",
"keys",
"(",
")",
")",
"hash_str",
"=",
"\"\"",
"for",
"key",
"in",
"filtered_attr_key_... | Get a hashed id based on requester, user id and filtered attributes
:type requester: str
:type user_id: str
:type filtered_attr: dict[str, str]
:param requester: The calling requester
:param user_id: The authorized user id
:param filtered_attr: a list containing all att... | [
"Get",
"a",
"hashed",
"id",
"based",
"on",
"requester",
"user",
"id",
"and",
"filtered",
"attributes"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/micro_services/consent.py#L146-L166 |
250,831 | IdentityPython/SATOSA | src/satosa/micro_services/consent.py | Consent._consent_registration | def _consent_registration(self, consent_args):
"""
Register a request at the consent service
:type consent_args: dict
:rtype: str
:param consent_args: All necessary parameters for the consent request
:return: Ticket received from the consent service
"""
... | python | def _consent_registration(self, consent_args):
jws = JWS(json.dumps(consent_args), alg=self.signing_key.alg).sign_compact([self.signing_key])
request = "{}/creq/{}".format(self.api_url, jws)
res = requests.get(request)
if res.status_code != 200:
raise UnexpectedResponseError... | [
"def",
"_consent_registration",
"(",
"self",
",",
"consent_args",
")",
":",
"jws",
"=",
"JWS",
"(",
"json",
".",
"dumps",
"(",
"consent_args",
")",
",",
"alg",
"=",
"self",
".",
"signing_key",
".",
"alg",
")",
".",
"sign_compact",
"(",
"[",
"self",
"."... | Register a request at the consent service
:type consent_args: dict
:rtype: str
:param consent_args: All necessary parameters for the consent request
:return: Ticket received from the consent service | [
"Register",
"a",
"request",
"at",
"the",
"consent",
"service"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/micro_services/consent.py#L168-L185 |
250,832 | IdentityPython/SATOSA | src/satosa/micro_services/consent.py | Consent._verify_consent | def _verify_consent(self, consent_id):
"""
Connects to the consent service using the REST api and checks if the user has given consent
:type consent_id: str
:rtype: Optional[List[str]]
:param consent_id: An id associated to the authenticated user, the calling requester and
... | python | def _verify_consent(self, consent_id):
request = "{}/verify/{}".format(self.api_url, consent_id)
res = requests.get(request)
if res.status_code == 200:
return json.loads(res.text)
return None | [
"def",
"_verify_consent",
"(",
"self",
",",
"consent_id",
")",
":",
"request",
"=",
"\"{}/verify/{}\"",
".",
"format",
"(",
"self",
".",
"api_url",
",",
"consent_id",
")",
"res",
"=",
"requests",
".",
"get",
"(",
"request",
")",
"if",
"res",
".",
"status... | Connects to the consent service using the REST api and checks if the user has given consent
:type consent_id: str
:rtype: Optional[List[str]]
:param consent_id: An id associated to the authenticated user, the calling requester and
attributes to be sent.
:return: list attributes... | [
"Connects",
"to",
"the",
"consent",
"service",
"using",
"the",
"REST",
"api",
"and",
"checks",
"if",
"the",
"user",
"has",
"given",
"consent"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/micro_services/consent.py#L187-L204 |
250,833 | IdentityPython/SATOSA | src/satosa/micro_services/consent.py | Consent._end_consent | def _end_consent(self, context, internal_response):
"""
Clear the state for consent and end the consent step
:type context: satosa.context.Context
:type internal_response: satosa.internal.InternalData
:rtype: satosa.response.Response
:param context: response context
... | python | def _end_consent(self, context, internal_response):
del context.state[STATE_KEY]
return super().process(context, internal_response) | [
"def",
"_end_consent",
"(",
"self",
",",
"context",
",",
"internal_response",
")",
":",
"del",
"context",
".",
"state",
"[",
"STATE_KEY",
"]",
"return",
"super",
"(",
")",
".",
"process",
"(",
"context",
",",
"internal_response",
")"
] | Clear the state for consent and end the consent step
:type context: satosa.context.Context
:type internal_response: satosa.internal.InternalData
:rtype: satosa.response.Response
:param context: response context
:param internal_response: the response
:return: response | [
"Clear",
"the",
"state",
"for",
"consent",
"and",
"end",
"the",
"consent",
"step"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/micro_services/consent.py#L206-L219 |
250,834 | IdentityPython/SATOSA | src/satosa/micro_services/primary_identifier.py | PrimaryIdentifier.constructPrimaryIdentifier | def constructPrimaryIdentifier(self, data, ordered_identifier_candidates):
"""
Construct and return a primary identifier value from the
data asserted by the IdP using the ordered list of candidates
from the configuration.
"""
logprefix = PrimaryIdentifier.logprefix
... | python | def constructPrimaryIdentifier(self, data, ordered_identifier_candidates):
logprefix = PrimaryIdentifier.logprefix
context = self.context
attributes = data.attributes
satosa_logging(logger, logging.DEBUG, "{} Input attributes {}".format(logprefix, attributes), context.state)
va... | [
"def",
"constructPrimaryIdentifier",
"(",
"self",
",",
"data",
",",
"ordered_identifier_candidates",
")",
":",
"logprefix",
"=",
"PrimaryIdentifier",
".",
"logprefix",
"context",
"=",
"self",
".",
"context",
"attributes",
"=",
"data",
".",
"attributes",
"satosa_logg... | Construct and return a primary identifier value from the
data asserted by the IdP using the ordered list of candidates
from the configuration. | [
"Construct",
"and",
"return",
"a",
"primary",
"identifier",
"value",
"from",
"the",
"data",
"asserted",
"by",
"the",
"IdP",
"using",
"the",
"ordered",
"list",
"of",
"candidates",
"from",
"the",
"configuration",
"."
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/micro_services/primary_identifier.py#L32-L103 |
250,835 | IdentityPython/SATOSA | src/satosa/state.py | state_to_cookie | def state_to_cookie(state, name, path, encryption_key):
"""
Saves a state to a cookie
:type state: satosa.state.State
:type name: str
:type path: str
:type encryption_key: str
:rtype: http.cookies.SimpleCookie
:param state: The state to save
:param name: Name identifier of the cook... | python | def state_to_cookie(state, name, path, encryption_key):
cookie_data = "" if state.delete else state.urlstate(encryption_key)
max_age = 0 if state.delete else STATE_COOKIE_MAX_AGE
satosa_logging(logger, logging.DEBUG,
"Saving state as cookie, secure: %s, max-age: %s, path: %s" %
... | [
"def",
"state_to_cookie",
"(",
"state",
",",
"name",
",",
"path",
",",
"encryption_key",
")",
":",
"cookie_data",
"=",
"\"\"",
"if",
"state",
".",
"delete",
"else",
"state",
".",
"urlstate",
"(",
"encryption_key",
")",
"max_age",
"=",
"0",
"if",
"state",
... | Saves a state to a cookie
:type state: satosa.state.State
:type name: str
:type path: str
:type encryption_key: str
:rtype: http.cookies.SimpleCookie
:param state: The state to save
:param name: Name identifier of the cookie
:param path: Endpoint path the cookie will be associated to
... | [
"Saves",
"a",
"state",
"to",
"a",
"cookie"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/state.py#L26-L54 |
250,836 | IdentityPython/SATOSA | src/satosa/state.py | cookie_to_state | def cookie_to_state(cookie_str, name, encryption_key):
"""
Loads a state from a cookie
:type cookie_str: str
:type name: str
:type encryption_key: str
:rtype: satosa.state.State
:param cookie_str: string representation of cookie/s
:param name: Name identifier of the cookie
:param e... | python | def cookie_to_state(cookie_str, name, encryption_key):
try:
cookie = SimpleCookie(cookie_str)
state = State(cookie[name].value, encryption_key)
except KeyError as e:
msg_tmpl = 'No cookie named {name} in {data}'
msg = msg_tmpl.format(name=name, data=cookie_str)
logger.exc... | [
"def",
"cookie_to_state",
"(",
"cookie_str",
",",
"name",
",",
"encryption_key",
")",
":",
"try",
":",
"cookie",
"=",
"SimpleCookie",
"(",
"cookie_str",
")",
"state",
"=",
"State",
"(",
"cookie",
"[",
"name",
"]",
".",
"value",
",",
"encryption_key",
")",
... | Loads a state from a cookie
:type cookie_str: str
:type name: str
:type encryption_key: str
:rtype: satosa.state.State
:param cookie_str: string representation of cookie/s
:param name: Name identifier of the cookie
:param encryption_key: Key to encrypt the state information
:return: A ... | [
"Loads",
"a",
"state",
"from",
"a",
"cookie"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/state.py#L57-L88 |
250,837 | IdentityPython/SATOSA | src/satosa/state.py | _AESCipher.encrypt | def encrypt(self, raw):
"""
Encryptes the parameter raw.
:type raw: bytes
:rtype: str
:param: bytes to be encrypted.
:return: A base 64 encoded string.
"""
raw = self._pad(raw)
iv = Random.new().read(AES.block_size)
cipher = AES.new(self... | python | def encrypt(self, raw):
raw = self._pad(raw)
iv = Random.new().read(AES.block_size)
cipher = AES.new(self.key, AES.MODE_CBC, iv)
return base64.urlsafe_b64encode(iv + cipher.encrypt(raw)) | [
"def",
"encrypt",
"(",
"self",
",",
"raw",
")",
":",
"raw",
"=",
"self",
".",
"_pad",
"(",
"raw",
")",
"iv",
"=",
"Random",
".",
"new",
"(",
")",
".",
"read",
"(",
"AES",
".",
"block_size",
")",
"cipher",
"=",
"AES",
".",
"new",
"(",
"self",
... | Encryptes the parameter raw.
:type raw: bytes
:rtype: str
:param: bytes to be encrypted.
:return: A base 64 encoded string. | [
"Encryptes",
"the",
"parameter",
"raw",
"."
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/state.py#L109-L123 |
250,838 | IdentityPython/SATOSA | src/satosa/state.py | _AESCipher._pad | def _pad(self, b):
"""
Will padd the param to be of the correct length for the encryption alg.
:type b: bytes
:rtype: bytes
"""
return b + (self.bs - len(b) % self.bs) * chr(self.bs - len(b) % self.bs).encode("UTF-8") | python | def _pad(self, b):
return b + (self.bs - len(b) % self.bs) * chr(self.bs - len(b) % self.bs).encode("UTF-8") | [
"def",
"_pad",
"(",
"self",
",",
"b",
")",
":",
"return",
"b",
"+",
"(",
"self",
".",
"bs",
"-",
"len",
"(",
"b",
")",
"%",
"self",
".",
"bs",
")",
"*",
"chr",
"(",
"self",
".",
"bs",
"-",
"len",
"(",
"b",
")",
"%",
"self",
".",
"bs",
"... | Will padd the param to be of the correct length for the encryption alg.
:type b: bytes
:rtype: bytes | [
"Will",
"padd",
"the",
"param",
"to",
"be",
"of",
"the",
"correct",
"length",
"for",
"the",
"encryption",
"alg",
"."
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/state.py#L140-L147 |
250,839 | IdentityPython/SATOSA | src/satosa/state.py | State.urlstate | def urlstate(self, encryption_key):
"""
Will return a url safe representation of the state.
:type encryption_key: Key used for encryption.
:rtype: str
:return: Url representation av of the state.
"""
lzma = LZMACompressor()
urlstate_data = json.dumps(sel... | python | def urlstate(self, encryption_key):
lzma = LZMACompressor()
urlstate_data = json.dumps(self._state_dict)
urlstate_data = lzma.compress(urlstate_data.encode("UTF-8"))
urlstate_data += lzma.flush()
urlstate_data = _AESCipher(encryption_key).encrypt(urlstate_data)
lzma = LZM... | [
"def",
"urlstate",
"(",
"self",
",",
"encryption_key",
")",
":",
"lzma",
"=",
"LZMACompressor",
"(",
")",
"urlstate_data",
"=",
"json",
".",
"dumps",
"(",
"self",
".",
"_state_dict",
")",
"urlstate_data",
"=",
"lzma",
".",
"compress",
"(",
"urlstate_data",
... | Will return a url safe representation of the state.
:type encryption_key: Key used for encryption.
:rtype: str
:return: Url representation av of the state. | [
"Will",
"return",
"a",
"url",
"safe",
"representation",
"of",
"the",
"state",
"."
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/state.py#L235-L253 |
250,840 | IdentityPython/SATOSA | src/satosa/state.py | State.copy | def copy(self):
"""
Returns a deepcopy of the state
:rtype: satosa.state.State
:return: A copy of the state
"""
state_copy = State()
state_copy._state_dict = copy.deepcopy(self._state_dict)
return state_copy | python | def copy(self):
state_copy = State()
state_copy._state_dict = copy.deepcopy(self._state_dict)
return state_copy | [
"def",
"copy",
"(",
"self",
")",
":",
"state_copy",
"=",
"State",
"(",
")",
"state_copy",
".",
"_state_dict",
"=",
"copy",
".",
"deepcopy",
"(",
"self",
".",
"_state_dict",
")",
"return",
"state_copy"
] | Returns a deepcopy of the state
:rtype: satosa.state.State
:return: A copy of the state | [
"Returns",
"a",
"deepcopy",
"of",
"the",
"state"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/state.py#L255-L265 |
250,841 | IdentityPython/SATOSA | src/satosa/deprecated.py | saml_name_id_format_to_hash_type | def saml_name_id_format_to_hash_type(name_format):
"""
Translate pySAML2 name format to satosa format
:type name_format: str
:rtype: satosa.internal_data.UserIdHashType
:param name_format: SAML2 name format
:return: satosa format
"""
msg = "saml_name_id_format_to_hash_type is deprecated... | python | def saml_name_id_format_to_hash_type(name_format):
msg = "saml_name_id_format_to_hash_type is deprecated and will be removed."
_warnings.warn(msg, DeprecationWarning)
name_id_format_to_hash_type = {
NAMEID_FORMAT_TRANSIENT: UserIdHashType.transient,
NAMEID_FORMAT_PERSISTENT: UserIdHashType.... | [
"def",
"saml_name_id_format_to_hash_type",
"(",
"name_format",
")",
":",
"msg",
"=",
"\"saml_name_id_format_to_hash_type is deprecated and will be removed.\"",
"_warnings",
".",
"warn",
"(",
"msg",
",",
"DeprecationWarning",
")",
"name_id_format_to_hash_type",
"=",
"{",
"NAME... | Translate pySAML2 name format to satosa format
:type name_format: str
:rtype: satosa.internal_data.UserIdHashType
:param name_format: SAML2 name format
:return: satosa format | [
"Translate",
"pySAML2",
"name",
"format",
"to",
"satosa",
"format"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/deprecated.py#L204-L225 |
250,842 | IdentityPython/SATOSA | src/satosa/deprecated.py | hash_type_to_saml_name_id_format | def hash_type_to_saml_name_id_format(hash_type):
"""
Translate satosa format to pySAML2 name format
:type hash_type: satosa.internal_data.UserIdHashType
:rtype: str
:param hash_type: satosa format
:return: pySAML2 name format
"""
msg = "hash_type_to_saml_name_id_format is deprecated and... | python | def hash_type_to_saml_name_id_format(hash_type):
msg = "hash_type_to_saml_name_id_format is deprecated and will be removed."
_warnings.warn(msg, DeprecationWarning)
hash_type_to_name_id_format = {
UserIdHashType.transient: NAMEID_FORMAT_TRANSIENT,
UserIdHashType.persistent: NAMEID_FORMAT_PE... | [
"def",
"hash_type_to_saml_name_id_format",
"(",
"hash_type",
")",
":",
"msg",
"=",
"\"hash_type_to_saml_name_id_format is deprecated and will be removed.\"",
"_warnings",
".",
"warn",
"(",
"msg",
",",
"DeprecationWarning",
")",
"hash_type_to_name_id_format",
"=",
"{",
"UserId... | Translate satosa format to pySAML2 name format
:type hash_type: satosa.internal_data.UserIdHashType
:rtype: str
:param hash_type: satosa format
:return: pySAML2 name format | [
"Translate",
"satosa",
"format",
"to",
"pySAML2",
"name",
"format"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/deprecated.py#L228-L247 |
250,843 | IdentityPython/SATOSA | src/satosa/deprecated.py | UserIdHasher.save_state | def save_state(internal_request, state):
"""
Saves all necessary information needed by the UserIdHasher
:type internal_request: satosa.internal_data.InternalRequest
:param internal_request: The request
:param state: The current state
"""
state_data = {"hash_type... | python | def save_state(internal_request, state):
state_data = {"hash_type": internal_request.user_id_hash_type}
state[UserIdHasher.STATE_KEY] = state_data | [
"def",
"save_state",
"(",
"internal_request",
",",
"state",
")",
":",
"state_data",
"=",
"{",
"\"hash_type\"",
":",
"internal_request",
".",
"user_id_hash_type",
"}",
"state",
"[",
"UserIdHasher",
".",
"STATE_KEY",
"]",
"=",
"state_data"
] | Saves all necessary information needed by the UserIdHasher
:type internal_request: satosa.internal_data.InternalRequest
:param internal_request: The request
:param state: The current state | [
"Saves",
"all",
"necessary",
"information",
"needed",
"by",
"the",
"UserIdHasher"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/deprecated.py#L122-L132 |
250,844 | IdentityPython/SATOSA | src/satosa/deprecated.py | UserIdHasher.hash_id | def hash_id(salt, user_id, requester, state):
"""
Sets a user id to the internal_response,
in the format specified by the internal response
:type salt: str
:type user_id: str
:type requester: str
:type state: satosa.state.State
:rtype: str
:param... | python | def hash_id(salt, user_id, requester, state):
hash_type_to_format = {
NAMEID_FORMAT_TRANSIENT: "{id}{req}{time}",
NAMEID_FORMAT_PERSISTENT: "{id}{req}",
"pairwise": "{id}{req}",
"public": "{id}",
NAMEID_FORMAT_EMAILADDRESS: "{id}",
NAMEID_F... | [
"def",
"hash_id",
"(",
"salt",
",",
"user_id",
",",
"requester",
",",
"state",
")",
":",
"hash_type_to_format",
"=",
"{",
"NAMEID_FORMAT_TRANSIENT",
":",
"\"{id}{req}{time}\"",
",",
"NAMEID_FORMAT_PERSISTENT",
":",
"\"{id}{req}\"",
",",
"\"pairwise\"",
":",
"\"{id}{... | Sets a user id to the internal_response,
in the format specified by the internal response
:type salt: str
:type user_id: str
:type requester: str
:type state: satosa.state.State
:rtype: str
:param salt: A salt string for the ID hashing
:param user_id: th... | [
"Sets",
"a",
"user",
"id",
"to",
"the",
"internal_response",
"in",
"the",
"format",
"specified",
"by",
"the",
"internal",
"response"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/deprecated.py#L155-L201 |
250,845 | IdentityPython/SATOSA | src/satosa/plugin_loader.py | load_backends | def load_backends(config, callback, internal_attributes):
"""
Load all backend modules specified in the config
:type config: satosa.satosa_config.SATOSAConfig
:type callback:
(satosa.context.Context, satosa.internal.InternalData) -> satosa.response.Response
:type internal_attributes: dict[strin... | python | def load_backends(config, callback, internal_attributes):
backend_modules = _load_plugins(config.get("CUSTOM_PLUGIN_MODULE_PATHS"), config["BACKEND_MODULES"], backend_filter,
config["BASE"], internal_attributes, callback)
logger.info("Setup backends: %s" % [backend.name for b... | [
"def",
"load_backends",
"(",
"config",
",",
"callback",
",",
"internal_attributes",
")",
":",
"backend_modules",
"=",
"_load_plugins",
"(",
"config",
".",
"get",
"(",
"\"CUSTOM_PLUGIN_MODULE_PATHS\"",
")",
",",
"config",
"[",
"\"BACKEND_MODULES\"",
"]",
",",
"back... | Load all backend modules specified in the config
:type config: satosa.satosa_config.SATOSAConfig
:type callback:
(satosa.context.Context, satosa.internal.InternalData) -> satosa.response.Response
:type internal_attributes: dict[string, dict[str, str | list[str]]]
:rtype: Sequence[satosa.backends.ba... | [
"Load",
"all",
"backend",
"modules",
"specified",
"in",
"the",
"config"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/plugin_loader.py#L30-L47 |
250,846 | IdentityPython/SATOSA | src/satosa/plugin_loader.py | load_frontends | def load_frontends(config, callback, internal_attributes):
"""
Load all frontend modules specified in the config
:type config: satosa.satosa_config.SATOSAConfig
:type callback:
(satosa.context.Context, satosa.internal.InternalData) -> satosa.response.Response
:type internal_attributes: dict[str... | python | def load_frontends(config, callback, internal_attributes):
frontend_modules = _load_plugins(config.get("CUSTOM_PLUGIN_MODULE_PATHS"), config["FRONTEND_MODULES"],
frontend_filter, config["BASE"], internal_attributes, callback)
logger.info("Setup frontends: %s" % [frontend.nam... | [
"def",
"load_frontends",
"(",
"config",
",",
"callback",
",",
"internal_attributes",
")",
":",
"frontend_modules",
"=",
"_load_plugins",
"(",
"config",
".",
"get",
"(",
"\"CUSTOM_PLUGIN_MODULE_PATHS\"",
")",
",",
"config",
"[",
"\"FRONTEND_MODULES\"",
"]",
",",
"f... | Load all frontend modules specified in the config
:type config: satosa.satosa_config.SATOSAConfig
:type callback:
(satosa.context.Context, satosa.internal.InternalData) -> satosa.response.Response
:type internal_attributes: dict[string, dict[str, str | list[str]]]
:rtype: Sequence[satosa.frontends.... | [
"Load",
"all",
"frontend",
"modules",
"specified",
"in",
"the",
"config"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/plugin_loader.py#L50-L68 |
250,847 | IdentityPython/SATOSA | src/satosa/plugin_loader.py | _micro_service_filter | def _micro_service_filter(cls):
"""
Will only give a find on classes that is a subclass of MicroService, with the exception that
the class is not allowed to be a direct ResponseMicroService or RequestMicroService.
:type cls: type
:rtype: bool
:param cls: A class object
:return: True if mat... | python | def _micro_service_filter(cls):
is_microservice_module = issubclass(cls, MicroService)
is_correct_subclass = cls != MicroService and cls != ResponseMicroService and cls != RequestMicroService
return is_microservice_module and is_correct_subclass | [
"def",
"_micro_service_filter",
"(",
"cls",
")",
":",
"is_microservice_module",
"=",
"issubclass",
"(",
"cls",
",",
"MicroService",
")",
"is_correct_subclass",
"=",
"cls",
"!=",
"MicroService",
"and",
"cls",
"!=",
"ResponseMicroService",
"and",
"cls",
"!=",
"Reque... | Will only give a find on classes that is a subclass of MicroService, with the exception that
the class is not allowed to be a direct ResponseMicroService or RequestMicroService.
:type cls: type
:rtype: bool
:param cls: A class object
:return: True if match, else false | [
"Will",
"only",
"give",
"a",
"find",
"on",
"classes",
"that",
"is",
"a",
"subclass",
"of",
"MicroService",
"with",
"the",
"exception",
"that",
"the",
"class",
"is",
"not",
"allowed",
"to",
"be",
"a",
"direct",
"ResponseMicroService",
"or",
"RequestMicroService... | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/plugin_loader.py#L97-L110 |
250,848 | IdentityPython/SATOSA | src/satosa/plugin_loader.py | _load_plugins | def _load_plugins(plugin_paths, plugins, plugin_filter, base_url, internal_attributes, callback):
"""
Loads endpoint plugins
:type plugin_paths: list[str]
:type plugins: list[str]
:type plugin_filter: (type | str) -> bool
:type internal_attributes: dict[string, dict[str, str | list[str]]]
:... | python | def _load_plugins(plugin_paths, plugins, plugin_filter, base_url, internal_attributes, callback):
loaded_plugin_modules = []
with prepend_to_import_path(plugin_paths):
for plugin_config in plugins:
try:
module_class = _load_endpoint_module(plugin_config, plugin_filter)
... | [
"def",
"_load_plugins",
"(",
"plugin_paths",
",",
"plugins",
",",
"plugin_filter",
",",
"base_url",
",",
"internal_attributes",
",",
"callback",
")",
":",
"loaded_plugin_modules",
"=",
"[",
"]",
"with",
"prepend_to_import_path",
"(",
"plugin_paths",
")",
":",
"for... | Loads endpoint plugins
:type plugin_paths: list[str]
:type plugins: list[str]
:type plugin_filter: (type | str) -> bool
:type internal_attributes: dict[string, dict[str, str | list[str]]]
:rtype list[satosa.plugin_base.endpoint.InterfaceModulePlugin]
:param plugin_paths: Path to the plugin dir... | [
"Loads",
"endpoint",
"plugins"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/plugin_loader.py#L151-L181 |
250,849 | IdentityPython/SATOSA | src/satosa/scripts/satosa_saml_metadata.py | create_and_write_saml_metadata | def create_and_write_saml_metadata(proxy_conf, key, cert, dir, valid, split_frontend_metadata=False,
split_backend_metadata=False):
"""
Generates SAML metadata for the given PROXY_CONF, signed with the given KEY and associated CERT.
"""
satosa_config = SATOSAConfig(pro... | python | def create_and_write_saml_metadata(proxy_conf, key, cert, dir, valid, split_frontend_metadata=False,
split_backend_metadata=False):
satosa_config = SATOSAConfig(proxy_conf)
secc = _get_security_context(key, cert)
frontend_entities, backend_entities = create_entity_descript... | [
"def",
"create_and_write_saml_metadata",
"(",
"proxy_conf",
",",
"key",
",",
"cert",
",",
"dir",
",",
"valid",
",",
"split_frontend_metadata",
"=",
"False",
",",
"split_backend_metadata",
"=",
"False",
")",
":",
"satosa_config",
"=",
"SATOSAConfig",
"(",
"proxy_co... | Generates SAML metadata for the given PROXY_CONF, signed with the given KEY and associated CERT. | [
"Generates",
"SAML",
"metadata",
"for",
"the",
"given",
"PROXY_CONF",
"signed",
"with",
"the",
"given",
"KEY",
"and",
"associated",
"CERT",
"."
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/scripts/satosa_saml_metadata.py#L38-L63 |
250,850 | IdentityPython/SATOSA | src/satosa/micro_services/account_linking.py | AccountLinking._handle_al_response | def _handle_al_response(self, context):
"""
Endpoint for handling account linking service response. When getting here
user might have approved or rejected linking their account
:type context: satosa.context.Context
:rtype: satosa.response.Response
:param context: The cu... | python | def _handle_al_response(self, context):
saved_state = context.state[self.name]
internal_response = InternalData.from_dict(saved_state)
#subject_id here is the linked id , not the facebook one, Figure out what to do
status_code, message = self._get_uuid(context, internal_response.auth_in... | [
"def",
"_handle_al_response",
"(",
"self",
",",
"context",
")",
":",
"saved_state",
"=",
"context",
".",
"state",
"[",
"self",
".",
"name",
"]",
"internal_response",
"=",
"InternalData",
".",
"from_dict",
"(",
"saved_state",
")",
"#subject_id here is the linked id... | Endpoint for handling account linking service response. When getting here
user might have approved or rejected linking their account
:type context: satosa.context.Context
:rtype: satosa.response.Response
:param context: The current context
:return: response | [
"Endpoint",
"for",
"handling",
"account",
"linking",
"service",
"response",
".",
"When",
"getting",
"here",
"user",
"might",
"have",
"approved",
"or",
"rejected",
"linking",
"their",
"account"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/micro_services/account_linking.py#L38-L70 |
250,851 | IdentityPython/SATOSA | src/satosa/micro_services/account_linking.py | AccountLinking.process | def process(self, context, internal_response):
"""
Manage account linking and recovery
:type context: satosa.context.Context
:type internal_response: satosa.internal.InternalData
:rtype: satosa.response.Response
:param context:
:param internal_response:
... | python | def process(self, context, internal_response):
status_code, message = self._get_uuid(context, internal_response.auth_info.issuer, internal_response.subject_id)
data = {
"issuer": internal_response.auth_info.issuer,
"redirect_endpoint": "%s/account_linking%s" % (self.base_url, se... | [
"def",
"process",
"(",
"self",
",",
"context",
",",
"internal_response",
")",
":",
"status_code",
",",
"message",
"=",
"self",
".",
"_get_uuid",
"(",
"context",
",",
"internal_response",
".",
"auth_info",
".",
"issuer",
",",
"internal_response",
".",
"subject_... | Manage account linking and recovery
:type context: satosa.context.Context
:type internal_response: satosa.internal.InternalData
:rtype: satosa.response.Response
:param context:
:param internal_response:
:return: response
: | [
"Manage",
"account",
"linking",
"and",
"recovery"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/micro_services/account_linking.py#L73-L109 |
250,852 | IdentityPython/SATOSA | src/satosa/routing.py | ModuleRouter.backend_routing | def backend_routing(self, context):
"""
Returns the targeted backend and an updated state
:type context: satosa.context.Context
:rtype satosa.backends.base.BackendModule
:param context: The request context
:return: backend
"""
satosa_logging(logger, logg... | python | def backend_routing(self, context):
satosa_logging(logger, logging.DEBUG, "Routing to backend: %s " % context.target_backend, context.state)
backend = self.backends[context.target_backend]["instance"]
context.state[STATE_KEY] = context.target_frontend
return backend | [
"def",
"backend_routing",
"(",
"self",
",",
"context",
")",
":",
"satosa_logging",
"(",
"logger",
",",
"logging",
".",
"DEBUG",
",",
"\"Routing to backend: %s \"",
"%",
"context",
".",
"target_backend",
",",
"context",
".",
"state",
")",
"backend",
"=",
"self"... | Returns the targeted backend and an updated state
:type context: satosa.context.Context
:rtype satosa.backends.base.BackendModule
:param context: The request context
:return: backend | [
"Returns",
"the",
"targeted",
"backend",
"and",
"an",
"updated",
"state"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/routing.py#L73-L86 |
250,853 | IdentityPython/SATOSA | src/satosa/routing.py | ModuleRouter.frontend_routing | def frontend_routing(self, context):
"""
Returns the targeted frontend and original state
:type context: satosa.context.Context
:rtype satosa.frontends.base.FrontendModule
:param context: The response context
:return: frontend
"""
target_frontend = cont... | python | def frontend_routing(self, context):
target_frontend = context.state[STATE_KEY]
satosa_logging(logger, logging.DEBUG, "Routing to frontend: %s " % target_frontend, context.state)
context.target_frontend = target_frontend
frontend = self.frontends[context.target_frontend]["instance"]
... | [
"def",
"frontend_routing",
"(",
"self",
",",
"context",
")",
":",
"target_frontend",
"=",
"context",
".",
"state",
"[",
"STATE_KEY",
"]",
"satosa_logging",
"(",
"logger",
",",
"logging",
".",
"DEBUG",
",",
"\"Routing to frontend: %s \"",
"%",
"target_frontend",
... | Returns the targeted frontend and original state
:type context: satosa.context.Context
:rtype satosa.frontends.base.FrontendModule
:param context: The response context
:return: frontend | [
"Returns",
"the",
"targeted",
"frontend",
"and",
"original",
"state"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/routing.py#L88-L103 |
250,854 | IdentityPython/SATOSA | src/satosa/routing.py | ModuleRouter.endpoint_routing | def endpoint_routing(self, context):
"""
Finds and returns the endpoint function bound to the path
:type context: satosa.context.Context
:rtype: ((satosa.context.Context, Any) -> Any, Any)
:param context: The request context
:return: registered endpoint and bound parame... | python | def endpoint_routing(self, context):
if context.path is None:
satosa_logging(logger, logging.DEBUG, "Context did not contain a path!", context.state)
raise SATOSABadContextError("Context did not contain any path")
satosa_logging(logger, logging.DEBUG, "Routing path: %s" % contex... | [
"def",
"endpoint_routing",
"(",
"self",
",",
"context",
")",
":",
"if",
"context",
".",
"path",
"is",
"None",
":",
"satosa_logging",
"(",
"logger",
",",
"logging",
".",
"DEBUG",
",",
"\"Context did not contain a path!\"",
",",
"context",
".",
"state",
")",
"... | Finds and returns the endpoint function bound to the path
:type context: satosa.context.Context
:rtype: ((satosa.context.Context, Any) -> Any, Any)
:param context: The request context
:return: registered endpoint and bound parameters | [
"Finds",
"and",
"returns",
"the",
"endpoint",
"function",
"bound",
"to",
"the",
"path"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/routing.py#L128-L172 |
250,855 | IdentityPython/SATOSA | src/satosa/base.py | SATOSABase._auth_req_callback_func | def _auth_req_callback_func(self, context, internal_request):
"""
This function is called by a frontend module when an authorization request has been
processed.
:type context: satosa.context.Context
:type internal_request: satosa.internal.InternalData
:rtype: satosa.resp... | python | def _auth_req_callback_func(self, context, internal_request):
state = context.state
state[STATE_KEY] = {"requester": internal_request.requester}
# TODO consent module should manage any state it needs by itself
try:
state_dict = context.state[consent.STATE_KEY]
except ... | [
"def",
"_auth_req_callback_func",
"(",
"self",
",",
"context",
",",
"internal_request",
")",
":",
"state",
"=",
"context",
".",
"state",
"state",
"[",
"STATE_KEY",
"]",
"=",
"{",
"\"requester\"",
":",
"internal_request",
".",
"requester",
"}",
"# TODO consent mo... | This function is called by a frontend module when an authorization request has been
processed.
:type context: satosa.context.Context
:type internal_request: satosa.internal.InternalData
:rtype: satosa.response.Response
:param context: The request context
:param internal... | [
"This",
"function",
"is",
"called",
"by",
"a",
"frontend",
"module",
"when",
"an",
"authorization",
"request",
"has",
"been",
"processed",
"."
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/base.py#L114-L146 |
250,856 | IdentityPython/SATOSA | src/satosa/base.py | SATOSABase._auth_resp_callback_func | def _auth_resp_callback_func(self, context, internal_response):
"""
This function is called by a backend module when the authorization is
complete.
:type context: satosa.context.Context
:type internal_response: satosa.internal.InternalData
:rtype: satosa.response.Respons... | python | def _auth_resp_callback_func(self, context, internal_response):
context.request = None
internal_response.requester = context.state[STATE_KEY]["requester"]
# If configured construct the user id from attribute values.
if "user_id_from_attrs" in self.config["INTERNAL_ATTRIBUTES"]:
... | [
"def",
"_auth_resp_callback_func",
"(",
"self",
",",
"context",
",",
"internal_response",
")",
":",
"context",
".",
"request",
"=",
"None",
"internal_response",
".",
"requester",
"=",
"context",
".",
"state",
"[",
"STATE_KEY",
"]",
"[",
"\"requester\"",
"]",
"... | This function is called by a backend module when the authorization is
complete.
:type context: satosa.context.Context
:type internal_response: satosa.internal.InternalData
:rtype: satosa.response.Response
:param context: The request context
:param internal_response: The... | [
"This",
"function",
"is",
"called",
"by",
"a",
"backend",
"module",
"when",
"the",
"authorization",
"is",
"complete",
"."
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/base.py#L170-L199 |
250,857 | IdentityPython/SATOSA | src/satosa/base.py | SATOSABase._handle_satosa_authentication_error | def _handle_satosa_authentication_error(self, error):
"""
Sends a response to the requester about the error
:type error: satosa.exception.SATOSAAuthenticationError
:rtype: satosa.response.Response
:param error: The exception
:return: response
"""
context... | python | def _handle_satosa_authentication_error(self, error):
context = Context()
context.state = error.state
frontend = self.module_router.frontend_routing(context)
return frontend.handle_backend_error(error) | [
"def",
"_handle_satosa_authentication_error",
"(",
"self",
",",
"error",
")",
":",
"context",
"=",
"Context",
"(",
")",
"context",
".",
"state",
"=",
"error",
".",
"state",
"frontend",
"=",
"self",
".",
"module_router",
".",
"frontend_routing",
"(",
"context",... | Sends a response to the requester about the error
:type error: satosa.exception.SATOSAAuthenticationError
:rtype: satosa.response.Response
:param error: The exception
:return: response | [
"Sends",
"a",
"response",
"to",
"the",
"requester",
"about",
"the",
"error"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/base.py#L201-L214 |
250,858 | IdentityPython/SATOSA | src/satosa/base.py | SATOSABase._load_state | def _load_state(self, context):
"""
Load state from cookie to the context
:type context: satosa.context.Context
:param context: Session context
"""
try:
state = cookie_to_state(
context.cookie,
self.config["COOKIE_STATE... | python | def _load_state(self, context):
try:
state = cookie_to_state(
context.cookie,
self.config["COOKIE_STATE_NAME"],
self.config["STATE_ENCRYPTION_KEY"])
except SATOSAStateError as e:
msg_tmpl = 'Failed to decrypt state {stat... | [
"def",
"_load_state",
"(",
"self",
",",
"context",
")",
":",
"try",
":",
"state",
"=",
"cookie_to_state",
"(",
"context",
".",
"cookie",
",",
"self",
".",
"config",
"[",
"\"COOKIE_STATE_NAME\"",
"]",
",",
"self",
".",
"config",
"[",
"\"STATE_ENCRYPTION_KEY\"... | Load state from cookie to the context
:type context: satosa.context.Context
:param context: Session context | [
"Load",
"state",
"from",
"cookie",
"to",
"the",
"context"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/base.py#L238-L256 |
250,859 | IdentityPython/SATOSA | src/satosa/base.py | SATOSABase._save_state | def _save_state(self, resp, context):
"""
Saves a state from context to cookie
:type resp: satosa.response.Response
:type context: satosa.context.Context
:param resp: The response
:param context: Session context
"""
cookie = state_to_cookie(context.stat... | python | def _save_state(self, resp, context):
cookie = state_to_cookie(context.state, self.config["COOKIE_STATE_NAME"], "/",
self.config["STATE_ENCRYPTION_KEY"])
resp.headers.append(tuple(cookie.output().split(": ", 1))) | [
"def",
"_save_state",
"(",
"self",
",",
"resp",
",",
"context",
")",
":",
"cookie",
"=",
"state_to_cookie",
"(",
"context",
".",
"state",
",",
"self",
".",
"config",
"[",
"\"COOKIE_STATE_NAME\"",
"]",
",",
"\"/\"",
",",
"self",
".",
"config",
"[",
"\"STA... | Saves a state from context to cookie
:type resp: satosa.response.Response
:type context: satosa.context.Context
:param resp: The response
:param context: Session context | [
"Saves",
"a",
"state",
"from",
"context",
"to",
"cookie"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/base.py#L258-L271 |
250,860 | IdentityPython/SATOSA | src/satosa/base.py | SATOSABase.run | def run(self, context):
"""
Runs the satosa proxy with the given context.
:type context: satosa.context.Context
:rtype: satosa.response.Response
:param context: The request context
:return: response
"""
try:
self._load_state(context)
... | python | def run(self, context):
try:
self._load_state(context)
spec = self.module_router.endpoint_routing(context)
resp = self._run_bound_endpoint(context, spec)
self._save_state(resp, context)
except SATOSANoBoundEndpointError:
raise
except SA... | [
"def",
"run",
"(",
"self",
",",
"context",
")",
":",
"try",
":",
"self",
".",
"_load_state",
"(",
"context",
")",
"spec",
"=",
"self",
".",
"module_router",
".",
"endpoint_routing",
"(",
"context",
")",
"resp",
"=",
"self",
".",
"_run_bound_endpoint",
"(... | Runs the satosa proxy with the given context.
:type context: satosa.context.Context
:rtype: satosa.response.Response
:param context: The request context
:return: response | [
"Runs",
"the",
"satosa",
"proxy",
"with",
"the",
"given",
"context",
"."
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/base.py#L273-L303 |
250,861 | IdentityPython/SATOSA | src/satosa/backends/saml2.py | SAMLBackend.disco_query | def disco_query(self):
"""
Makes a request to the discovery server
:type context: satosa.context.Context
:type internal_req: satosa.internal.InternalData
:rtype: satosa.response.SeeOther
:param context: The current context
:param internal_req: The request
... | python | def disco_query(self):
return_url = self.sp.config.getattr("endpoints", "sp")["discovery_response"][0][0]
loc = self.sp.create_discovery_service_request(self.discosrv, self.sp.config.entityid, **{"return": return_url})
return SeeOther(loc) | [
"def",
"disco_query",
"(",
"self",
")",
":",
"return_url",
"=",
"self",
".",
"sp",
".",
"config",
".",
"getattr",
"(",
"\"endpoints\"",
",",
"\"sp\"",
")",
"[",
"\"discovery_response\"",
"]",
"[",
"0",
"]",
"[",
"0",
"]",
"loc",
"=",
"self",
".",
"sp... | Makes a request to the discovery server
:type context: satosa.context.Context
:type internal_req: satosa.internal.InternalData
:rtype: satosa.response.SeeOther
:param context: The current context
:param internal_req: The request
:return: Response | [
"Makes",
"a",
"request",
"to",
"the",
"discovery",
"server"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/backends/saml2.py#L107-L121 |
250,862 | IdentityPython/SATOSA | src/satosa/backends/saml2.py | SAMLBackend.authn_request | def authn_request(self, context, entity_id):
"""
Do an authorization request on idp with given entity id.
This is the start of the authorization.
:type context: satosa.context.Context
:type entity_id: str
:rtype: satosa.response.Response
:param context: The curr... | python | def authn_request(self, context, entity_id):
# If IDP blacklisting is enabled and the selected IDP is blacklisted,
# stop here
if self.idp_blacklist_file:
with open(self.idp_blacklist_file) as blacklist_file:
blacklist_array = json.load(blacklist_file)['blacklist']
... | [
"def",
"authn_request",
"(",
"self",
",",
"context",
",",
"entity_id",
")",
":",
"# If IDP blacklisting is enabled and the selected IDP is blacklisted,",
"# stop here",
"if",
"self",
".",
"idp_blacklist_file",
":",
"with",
"open",
"(",
"self",
".",
"idp_blacklist_file",
... | Do an authorization request on idp with given entity id.
This is the start of the authorization.
:type context: satosa.context.Context
:type entity_id: str
:rtype: satosa.response.Response
:param context: The current context
:param entity_id: Target IDP entity id
... | [
"Do",
"an",
"authorization",
"request",
"on",
"idp",
"with",
"given",
"entity",
"id",
".",
"This",
"is",
"the",
"start",
"of",
"the",
"authorization",
"."
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/backends/saml2.py#L143-L195 |
250,863 | IdentityPython/SATOSA | src/satosa/backends/saml2.py | SAMLBackend.disco_response | def disco_response(self, context):
"""
Endpoint for the discovery server response
:type context: satosa.context.Context
:rtype: satosa.response.Response
:param context: The current context
:return: response
"""
info = context.request
state = cont... | python | def disco_response(self, context):
info = context.request
state = context.state
try:
entity_id = info["entityID"]
except KeyError as err:
satosa_logging(logger, logging.DEBUG, "No IDP chosen for state", state, exc_info=True)
raise SATOSAAuthentication... | [
"def",
"disco_response",
"(",
"self",
",",
"context",
")",
":",
"info",
"=",
"context",
".",
"request",
"state",
"=",
"context",
".",
"state",
"try",
":",
"entity_id",
"=",
"info",
"[",
"\"entityID\"",
"]",
"except",
"KeyError",
"as",
"err",
":",
"satosa... | Endpoint for the discovery server response
:type context: satosa.context.Context
:rtype: satosa.response.Response
:param context: The current context
:return: response | [
"Endpoint",
"for",
"the",
"discovery",
"server",
"response"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/backends/saml2.py#L240-L259 |
250,864 | IdentityPython/SATOSA | src/satosa/backends/saml2.py | SAMLBackend._translate_response | def _translate_response(self, response, state):
"""
Translates a saml authorization response to an internal response
:type response: saml2.response.AuthnResponse
:rtype: satosa.internal.InternalData
:param response: The saml authorization response
:return: A translated i... | python | def _translate_response(self, response, state):
# The response may have been encrypted by the IdP so if we have an
# encryption key, try it.
if self.encryption_keys:
response.parse_assertion(self.encryption_keys)
authn_info = response.authn_info()[0]
auth_class_ref =... | [
"def",
"_translate_response",
"(",
"self",
",",
"response",
",",
"state",
")",
":",
"# The response may have been encrypted by the IdP so if we have an",
"# encryption key, try it.",
"if",
"self",
".",
"encryption_keys",
":",
"response",
".",
"parse_assertion",
"(",
"self",... | Translates a saml authorization response to an internal response
:type response: saml2.response.AuthnResponse
:rtype: satosa.internal.InternalData
:param response: The saml authorization response
:return: A translated internal response | [
"Translates",
"a",
"saml",
"authorization",
"response",
"to",
"an",
"internal",
"response"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/backends/saml2.py#L261-L304 |
250,865 | IdentityPython/SATOSA | src/satosa/attribute_mapping.py | AttributeMapper.to_internal_filter | def to_internal_filter(self, attribute_profile, external_attribute_names):
"""
Converts attribute names from external "type" to internal
:type attribute_profile: str
:type external_attribute_names: list[str]
:type case_insensitive: bool
:rtype: list[str]
:param ... | python | def to_internal_filter(self, attribute_profile, external_attribute_names):
try:
profile_mapping = self.to_internal_attributes[attribute_profile]
except KeyError:
logger.warn("no attribute mapping found for the given attribute profile '%s'", attribute_profile)
# no att... | [
"def",
"to_internal_filter",
"(",
"self",
",",
"attribute_profile",
",",
"external_attribute_names",
")",
":",
"try",
":",
"profile_mapping",
"=",
"self",
".",
"to_internal_attributes",
"[",
"attribute_profile",
"]",
"except",
"KeyError",
":",
"logger",
".",
"warn",... | Converts attribute names from external "type" to internal
:type attribute_profile: str
:type external_attribute_names: list[str]
:type case_insensitive: bool
:rtype: list[str]
:param attribute_profile: From which external type to convert (ex: oidc, saml, ...)
:param ext... | [
"Converts",
"attribute",
"names",
"from",
"external",
"type",
"to",
"internal"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/attribute_mapping.py#L44-L73 |
250,866 | IdentityPython/SATOSA | src/satosa/attribute_mapping.py | AttributeMapper.to_internal | def to_internal(self, attribute_profile, external_dict):
"""
Converts the external data from "type" to internal
:type attribute_profile: str
:type external_dict: dict[str, str]
:rtype: dict[str, str]
:param attribute_profile: From which external type to convert (ex: oid... | python | def to_internal(self, attribute_profile, external_dict):
internal_dict = {}
for internal_attribute_name, mapping in self.from_internal_attributes.items():
if attribute_profile not in mapping:
logger.debug("no attribute mapping found for internal attribute '%s' the attribute ... | [
"def",
"to_internal",
"(",
"self",
",",
"attribute_profile",
",",
"external_dict",
")",
":",
"internal_dict",
"=",
"{",
"}",
"for",
"internal_attribute_name",
",",
"mapping",
"in",
"self",
".",
"from_internal_attributes",
".",
"items",
"(",
")",
":",
"if",
"at... | Converts the external data from "type" to internal
:type attribute_profile: str
:type external_dict: dict[str, str]
:rtype: dict[str, str]
:param attribute_profile: From which external type to convert (ex: oidc, saml, ...)
:param external_dict: Attributes in the external format... | [
"Converts",
"the",
"external",
"data",
"from",
"type",
"to",
"internal"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/attribute_mapping.py#L75-L107 |
250,867 | IdentityPython/SATOSA | src/satosa/attribute_mapping.py | AttributeMapper.from_internal | def from_internal(self, attribute_profile, internal_dict):
"""
Converts the internal data to "type"
:type attribute_profile: str
:type internal_dict: dict[str, str]
:rtype: dict[str, str]
:param attribute_profile: To which external type to convert (ex: oidc, saml, ...)
... | python | def from_internal(self, attribute_profile, internal_dict):
external_dict = {}
for internal_attribute_name in internal_dict:
try:
attribute_mapping = self.from_internal_attributes[internal_attribute_name]
except KeyError:
logger.debug("no attribute ... | [
"def",
"from_internal",
"(",
"self",
",",
"attribute_profile",
",",
"internal_dict",
")",
":",
"external_dict",
"=",
"{",
"}",
"for",
"internal_attribute_name",
"in",
"internal_dict",
":",
"try",
":",
"attribute_mapping",
"=",
"self",
".",
"from_internal_attributes"... | Converts the internal data to "type"
:type attribute_profile: str
:type internal_dict: dict[str, str]
:rtype: dict[str, str]
:param attribute_profile: To which external type to convert (ex: oidc, saml, ...)
:param internal_dict: attributes to map
:return: attribute valu... | [
"Converts",
"the",
"internal",
"data",
"to",
"type"
] | 49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb | https://github.com/IdentityPython/SATOSA/blob/49da5d4c0ac1a5ebf1a71b4f7aaf04f0e52d8fdb/src/satosa/attribute_mapping.py#L167-L208 |
250,868 | c4urself/bump2version | bumpversion/version_part.py | VersionConfig._serialize | def _serialize(self, version, serialize_format, context, raise_if_incomplete=False):
"""
Attempts to serialize a version with the given serialization format.
Raises MissingValueForSerializationException if not serializable
"""
values = context.copy()
for k in version:
... | python | def _serialize(self, version, serialize_format, context, raise_if_incomplete=False):
values = context.copy()
for k in version:
values[k] = version[k]
# TODO dump complete context on debug level
try:
# test whether all parts required in the format have values
... | [
"def",
"_serialize",
"(",
"self",
",",
"version",
",",
"serialize_format",
",",
"context",
",",
"raise_if_incomplete",
"=",
"False",
")",
":",
"values",
"=",
"context",
".",
"copy",
"(",
")",
"for",
"k",
"in",
"version",
":",
"values",
"[",
"k",
"]",
"... | Attempts to serialize a version with the given serialization format.
Raises MissingValueForSerializationException if not serializable | [
"Attempts",
"to",
"serialize",
"a",
"version",
"with",
"the",
"given",
"serialization",
"format",
"."
] | 22d981ebfb94a7d26716e2b936f932a58883aa30 | https://github.com/c4urself/bump2version/blob/22d981ebfb94a7d26716e2b936f932a58883aa30/bumpversion/version_part.py#L194-L247 |
250,869 | lawsie/guizero | guizero/ButtonGroup.py | ButtonGroup.value_text | def value_text(self):
"""
Sets or returns the option selected in a ButtonGroup by its text value.
"""
search = self._selected.get() # a string containing the selected option
# This is a bit nasty - suggestions welcome
for item in self._rbuttons:
if item.value ... | python | def value_text(self):
search = self._selected.get() # a string containing the selected option
# This is a bit nasty - suggestions welcome
for item in self._rbuttons:
if item.value == search:
return item.text
return "" | [
"def",
"value_text",
"(",
"self",
")",
":",
"search",
"=",
"self",
".",
"_selected",
".",
"get",
"(",
")",
"# a string containing the selected option",
"# This is a bit nasty - suggestions welcome",
"for",
"item",
"in",
"self",
".",
"_rbuttons",
":",
"if",
"item",
... | Sets or returns the option selected in a ButtonGroup by its text value. | [
"Sets",
"or",
"returns",
"the",
"option",
"selected",
"in",
"a",
"ButtonGroup",
"by",
"its",
"text",
"value",
"."
] | 84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2 | https://github.com/lawsie/guizero/blob/84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2/guizero/ButtonGroup.py#L171-L180 |
250,870 | lawsie/guizero | guizero/ButtonGroup.py | ButtonGroup.append | def append(self, option):
"""
Appends a new `option` to the end of the ButtonGroup.
:param string/List option:
The option to append to the ButtonGroup. If a 2D list is specified,
the first element is the text, the second is the value.
"""
self._options.ap... | python | def append(self, option):
self._options.append(self._parse_option(option))
self._refresh_options()
self.resize(self._width, self._height) | [
"def",
"append",
"(",
"self",
",",
"option",
")",
":",
"self",
".",
"_options",
".",
"append",
"(",
"self",
".",
"_parse_option",
"(",
"option",
")",
")",
"self",
".",
"_refresh_options",
"(",
")",
"self",
".",
"resize",
"(",
"self",
".",
"_width",
"... | Appends a new `option` to the end of the ButtonGroup.
:param string/List option:
The option to append to the ButtonGroup. If a 2D list is specified,
the first element is the text, the second is the value. | [
"Appends",
"a",
"new",
"option",
"to",
"the",
"end",
"of",
"the",
"ButtonGroup",
"."
] | 84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2 | https://github.com/lawsie/guizero/blob/84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2/guizero/ButtonGroup.py#L235-L245 |
250,871 | lawsie/guizero | guizero/ButtonGroup.py | ButtonGroup.insert | def insert(self, index, option):
"""
Insert a new `option` in the ButtonGroup at `index`.
:param int option:
The index of where to insert the option.
:param string/List option:
The option to append to the ButtonGroup. If a 2D list is specified,
the f... | python | def insert(self, index, option):
self._options.insert(index, self._parse_option(option))
self._refresh_options()
self.resize(self._width, self._height) | [
"def",
"insert",
"(",
"self",
",",
"index",
",",
"option",
")",
":",
"self",
".",
"_options",
".",
"insert",
"(",
"index",
",",
"self",
".",
"_parse_option",
"(",
"option",
")",
")",
"self",
".",
"_refresh_options",
"(",
")",
"self",
".",
"resize",
"... | Insert a new `option` in the ButtonGroup at `index`.
:param int option:
The index of where to insert the option.
:param string/List option:
The option to append to the ButtonGroup. If a 2D list is specified,
the first element is the text, the second is the value. | [
"Insert",
"a",
"new",
"option",
"in",
"the",
"ButtonGroup",
"at",
"index",
"."
] | 84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2 | https://github.com/lawsie/guizero/blob/84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2/guizero/ButtonGroup.py#L247-L260 |
250,872 | lawsie/guizero | guizero/ButtonGroup.py | ButtonGroup.remove | def remove(self, option):
"""
Removes the first `option` from the ButtonGroup.
Returns `True` if an item was removed.
:param string option:
The value of the option to remove from the ButtonGroup.
"""
for existing_option in self._options:
if exist... | python | def remove(self, option):
for existing_option in self._options:
if existing_option[1] == option:
self._options.remove(existing_option)
self._refresh_options()
return True
return False | [
"def",
"remove",
"(",
"self",
",",
"option",
")",
":",
"for",
"existing_option",
"in",
"self",
".",
"_options",
":",
"if",
"existing_option",
"[",
"1",
"]",
"==",
"option",
":",
"self",
".",
"_options",
".",
"remove",
"(",
"existing_option",
")",
"self",... | Removes the first `option` from the ButtonGroup.
Returns `True` if an item was removed.
:param string option:
The value of the option to remove from the ButtonGroup. | [
"Removes",
"the",
"first",
"option",
"from",
"the",
"ButtonGroup",
"."
] | 84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2 | https://github.com/lawsie/guizero/blob/84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2/guizero/ButtonGroup.py#L262-L276 |
250,873 | lawsie/guizero | guizero/ButtonGroup.py | ButtonGroup.update_command | def update_command(self, command, args=None):
"""
Updates the callback command which is called when the ButtonGroup
changes.
Setting to `None` stops the callback.
:param callback command:
The callback function to call.
:param callback args:
A li... | python | def update_command(self, command, args=None):
if command is None:
self._command = lambda: None
else:
if args is None:
self._command = command
else:
self._command = utils.with_args(command, *args) | [
"def",
"update_command",
"(",
"self",
",",
"command",
",",
"args",
"=",
"None",
")",
":",
"if",
"command",
"is",
"None",
":",
"self",
".",
"_command",
"=",
"lambda",
":",
"None",
"else",
":",
"if",
"args",
"is",
"None",
":",
"self",
".",
"_command",
... | Updates the callback command which is called when the ButtonGroup
changes.
Setting to `None` stops the callback.
:param callback command:
The callback function to call.
:param callback args:
A list of arguments to pass to the widgets `command`, defaults to
... | [
"Updates",
"the",
"callback",
"command",
"which",
"is",
"called",
"when",
"the",
"ButtonGroup",
"changes",
"."
] | 84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2 | https://github.com/lawsie/guizero/blob/84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2/guizero/ButtonGroup.py#L290-L310 |
250,874 | lawsie/guizero | guizero/Combo.py | Combo.insert | def insert(self, index, option):
"""
Insert a new `option` in the Combo at `index`.
:param int option:
The index of where to insert the option.
:param string option:
The option to insert into to the Combo.
"""
option = str(option)
self._o... | python | def insert(self, index, option):
option = str(option)
self._options.insert(index, option)
# if this is the first option, set it.
if len(self._options) == 1:
self.value = option
self._refresh_options() | [
"def",
"insert",
"(",
"self",
",",
"index",
",",
"option",
")",
":",
"option",
"=",
"str",
"(",
"option",
")",
"self",
".",
"_options",
".",
"insert",
"(",
"index",
",",
"option",
")",
"# if this is the first option, set it.",
"if",
"len",
"(",
"self",
"... | Insert a new `option` in the Combo at `index`.
:param int option:
The index of where to insert the option.
:param string option:
The option to insert into to the Combo. | [
"Insert",
"a",
"new",
"option",
"in",
"the",
"Combo",
"at",
"index",
"."
] | 84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2 | https://github.com/lawsie/guizero/blob/84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2/guizero/Combo.py#L204-L220 |
250,875 | lawsie/guizero | guizero/Combo.py | Combo.remove | def remove(self, option):
"""
Removes the first `option` from the Combo.
Returns `True` if an item was removed.
:param string option:
The option to remove from the Combo.
"""
if option in self._options:
if len(self._options) == 1:
... | python | def remove(self, option):
if option in self._options:
if len(self._options) == 1:
# this is the last option in the list so clear it
self.clear()
else:
self._options.remove(option)
self._refresh_options()
# ha... | [
"def",
"remove",
"(",
"self",
",",
"option",
")",
":",
"if",
"option",
"in",
"self",
".",
"_options",
":",
"if",
"len",
"(",
"self",
".",
"_options",
")",
"==",
"1",
":",
"# this is the last option in the list so clear it",
"self",
".",
"clear",
"(",
")",
... | Removes the first `option` from the Combo.
Returns `True` if an item was removed.
:param string option:
The option to remove from the Combo. | [
"Removes",
"the",
"first",
"option",
"from",
"the",
"Combo",
"."
] | 84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2 | https://github.com/lawsie/guizero/blob/84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2/guizero/Combo.py#L222-L244 |
250,876 | lawsie/guizero | guizero/Combo.py | Combo.clear | def clear(self):
"""
Clears all the options in a Combo
"""
self._options = []
self._combo_menu.tk.delete(0, END)
self._selected.set("") | python | def clear(self):
self._options = []
self._combo_menu.tk.delete(0, END)
self._selected.set("") | [
"def",
"clear",
"(",
"self",
")",
":",
"self",
".",
"_options",
"=",
"[",
"]",
"self",
".",
"_combo_menu",
".",
"tk",
".",
"delete",
"(",
"0",
",",
"END",
")",
"self",
".",
"_selected",
".",
"set",
"(",
"\"\"",
")"
] | Clears all the options in a Combo | [
"Clears",
"all",
"the",
"options",
"in",
"a",
"Combo"
] | 84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2 | https://github.com/lawsie/guizero/blob/84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2/guizero/Combo.py#L247-L253 |
250,877 | lawsie/guizero | guizero/Combo.py | Combo._set_option | def _set_option(self, value):
"""
Sets a single option in the Combo, returning True if it was able too.
"""
if len(self._options) > 0:
if value in self._options:
self._selected.set(value)
return True
else:
return Fal... | python | def _set_option(self, value):
if len(self._options) > 0:
if value in self._options:
self._selected.set(value)
return True
else:
return False
else:
return False | [
"def",
"_set_option",
"(",
"self",
",",
"value",
")",
":",
"if",
"len",
"(",
"self",
".",
"_options",
")",
">",
"0",
":",
"if",
"value",
"in",
"self",
".",
"_options",
":",
"self",
".",
"_selected",
".",
"set",
"(",
"value",
")",
"return",
"True",
... | Sets a single option in the Combo, returning True if it was able too. | [
"Sets",
"a",
"single",
"option",
"in",
"the",
"Combo",
"returning",
"True",
"if",
"it",
"was",
"able",
"too",
"."
] | 84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2 | https://github.com/lawsie/guizero/blob/84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2/guizero/Combo.py#L271-L282 |
250,878 | lawsie/guizero | guizero/Combo.py | Combo._set_option_by_index | def _set_option_by_index(self, index):
"""
Sets a single option in the Combo by its index, returning True if it was able too.
"""
if index < len(self._options):
self._selected.set(self._options[index])
return True
else:
return False | python | def _set_option_by_index(self, index):
if index < len(self._options):
self._selected.set(self._options[index])
return True
else:
return False | [
"def",
"_set_option_by_index",
"(",
"self",
",",
"index",
")",
":",
"if",
"index",
"<",
"len",
"(",
"self",
".",
"_options",
")",
":",
"self",
".",
"_selected",
".",
"set",
"(",
"self",
".",
"_options",
"[",
"index",
"]",
")",
"return",
"True",
"else... | Sets a single option in the Combo by its index, returning True if it was able too. | [
"Sets",
"a",
"single",
"option",
"in",
"the",
"Combo",
"by",
"its",
"index",
"returning",
"True",
"if",
"it",
"was",
"able",
"too",
"."
] | 84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2 | https://github.com/lawsie/guizero/blob/84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2/guizero/Combo.py#L284-L292 |
250,879 | lawsie/guizero | guizero/tkmixins.py | ScheduleMixin.after | def after(self, time, function, args = []):
"""Call `function` after `time` milliseconds."""
callback_id = self.tk.after(time, self._call_wrapper, time, function, *args)
self._callback[function] = [callback_id, False] | python | def after(self, time, function, args = []):
callback_id = self.tk.after(time, self._call_wrapper, time, function, *args)
self._callback[function] = [callback_id, False] | [
"def",
"after",
"(",
"self",
",",
"time",
",",
"function",
",",
"args",
"=",
"[",
"]",
")",
":",
"callback_id",
"=",
"self",
".",
"tk",
".",
"after",
"(",
"time",
",",
"self",
".",
"_call_wrapper",
",",
"time",
",",
"function",
",",
"*",
"args",
... | Call `function` after `time` milliseconds. | [
"Call",
"function",
"after",
"time",
"milliseconds",
"."
] | 84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2 | https://github.com/lawsie/guizero/blob/84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2/guizero/tkmixins.py#L8-L11 |
250,880 | lawsie/guizero | guizero/tkmixins.py | ScheduleMixin.repeat | def repeat(self, time, function, args = []):
"""Repeat `function` every `time` milliseconds."""
callback_id = self.tk.after(time, self._call_wrapper, time, function, *args)
self._callback[function] = [callback_id, True] | python | def repeat(self, time, function, args = []):
callback_id = self.tk.after(time, self._call_wrapper, time, function, *args)
self._callback[function] = [callback_id, True] | [
"def",
"repeat",
"(",
"self",
",",
"time",
",",
"function",
",",
"args",
"=",
"[",
"]",
")",
":",
"callback_id",
"=",
"self",
".",
"tk",
".",
"after",
"(",
"time",
",",
"self",
".",
"_call_wrapper",
",",
"time",
",",
"function",
",",
"*",
"args",
... | Repeat `function` every `time` milliseconds. | [
"Repeat",
"function",
"every",
"time",
"milliseconds",
"."
] | 84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2 | https://github.com/lawsie/guizero/blob/84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2/guizero/tkmixins.py#L13-L16 |
250,881 | lawsie/guizero | guizero/tkmixins.py | ScheduleMixin.cancel | def cancel(self, function):
"""Cancel the scheduled `function` calls."""
if function in self._callback.keys():
callback_id = self._callback[function][0]
self.tk.after_cancel(callback_id)
self._callback.pop(function)
else:
utils.error_format("Could ... | python | def cancel(self, function):
if function in self._callback.keys():
callback_id = self._callback[function][0]
self.tk.after_cancel(callback_id)
self._callback.pop(function)
else:
utils.error_format("Could not cancel function - it doesnt exist, it may have al... | [
"def",
"cancel",
"(",
"self",
",",
"function",
")",
":",
"if",
"function",
"in",
"self",
".",
"_callback",
".",
"keys",
"(",
")",
":",
"callback_id",
"=",
"self",
".",
"_callback",
"[",
"function",
"]",
"[",
"0",
"]",
"self",
".",
"tk",
".",
"after... | Cancel the scheduled `function` calls. | [
"Cancel",
"the",
"scheduled",
"function",
"calls",
"."
] | 84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2 | https://github.com/lawsie/guizero/blob/84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2/guizero/tkmixins.py#L18-L25 |
250,882 | lawsie/guizero | guizero/tkmixins.py | ScheduleMixin._call_wrapper | def _call_wrapper(self, time, function, *args):
"""Fired by tk.after, gets the callback and either executes the function and cancels or repeats"""
# execute the function
function(*args)
if function in self._callback.keys():
repeat = self._callback[function][1]
if ... | python | def _call_wrapper(self, time, function, *args):
# execute the function
function(*args)
if function in self._callback.keys():
repeat = self._callback[function][1]
if repeat:
# setup the call back again and update the id
callback_id = self.tk... | [
"def",
"_call_wrapper",
"(",
"self",
",",
"time",
",",
"function",
",",
"*",
"args",
")",
":",
"# execute the function",
"function",
"(",
"*",
"args",
")",
"if",
"function",
"in",
"self",
".",
"_callback",
".",
"keys",
"(",
")",
":",
"repeat",
"=",
"se... | Fired by tk.after, gets the callback and either executes the function and cancels or repeats | [
"Fired",
"by",
"tk",
".",
"after",
"gets",
"the",
"callback",
"and",
"either",
"executes",
"the",
"function",
"and",
"cancels",
"or",
"repeats"
] | 84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2 | https://github.com/lawsie/guizero/blob/84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2/guizero/tkmixins.py#L27-L39 |
250,883 | lawsie/guizero | guizero/event.py | EventCallback.rebind | def rebind(self, tks):
"""
Rebinds the tk event, only used if a widget has been destroyed
and recreated.
"""
self._tks = tks
for tk in self._tks:
tk.unbind_all(self._tk_event)
func_id = tk.bind(self._tk_event, self._event_callback)
self... | python | def rebind(self, tks):
self._tks = tks
for tk in self._tks:
tk.unbind_all(self._tk_event)
func_id = tk.bind(self._tk_event, self._event_callback)
self._func_ids.append(func_id) | [
"def",
"rebind",
"(",
"self",
",",
"tks",
")",
":",
"self",
".",
"_tks",
"=",
"tks",
"for",
"tk",
"in",
"self",
".",
"_tks",
":",
"tk",
".",
"unbind_all",
"(",
"self",
".",
"_tk_event",
")",
"func_id",
"=",
"tk",
".",
"bind",
"(",
"self",
".",
... | Rebinds the tk event, only used if a widget has been destroyed
and recreated. | [
"Rebinds",
"the",
"tk",
"event",
"only",
"used",
"if",
"a",
"widget",
"has",
"been",
"destroyed",
"and",
"recreated",
"."
] | 84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2 | https://github.com/lawsie/guizero/blob/84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2/guizero/event.py#L129-L138 |
250,884 | lawsie/guizero | guizero/event.py | EventManager.rebind_events | def rebind_events(self, *tks):
"""
Rebinds all the tk events, only used if a tk widget has been destroyed
and recreated.
"""
for ref in self._refs:
self._refs[ref].rebind(tks) | python | def rebind_events(self, *tks):
for ref in self._refs:
self._refs[ref].rebind(tks) | [
"def",
"rebind_events",
"(",
"self",
",",
"*",
"tks",
")",
":",
"for",
"ref",
"in",
"self",
".",
"_refs",
":",
"self",
".",
"_refs",
"[",
"ref",
"]",
".",
"rebind",
"(",
"tks",
")"
] | Rebinds all the tk events, only used if a tk widget has been destroyed
and recreated. | [
"Rebinds",
"all",
"the",
"tk",
"events",
"only",
"used",
"if",
"a",
"tk",
"widget",
"has",
"been",
"destroyed",
"and",
"recreated",
"."
] | 84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2 | https://github.com/lawsie/guizero/blob/84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2/guizero/event.py#L200-L206 |
250,885 | lawsie/guizero | guizero/Box.py | Box.set_border | def set_border(self, thickness, color="black"):
"""
Sets the border thickness and color.
:param int thickness:
The thickenss of the border.
:param str color:
The color of the border.
"""
self._set_tk_config("highlightthickness", thickness)
... | python | def set_border(self, thickness, color="black"):
self._set_tk_config("highlightthickness", thickness)
self._set_tk_config("highlightbackground", utils.convert_color(color)) | [
"def",
"set_border",
"(",
"self",
",",
"thickness",
",",
"color",
"=",
"\"black\"",
")",
":",
"self",
".",
"_set_tk_config",
"(",
"\"highlightthickness\"",
",",
"thickness",
")",
"self",
".",
"_set_tk_config",
"(",
"\"highlightbackground\"",
",",
"utils",
".",
... | Sets the border thickness and color.
:param int thickness:
The thickenss of the border.
:param str color:
The color of the border. | [
"Sets",
"the",
"border",
"thickness",
"and",
"color",
"."
] | 84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2 | https://github.com/lawsie/guizero/blob/84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2/guizero/Box.py#L87-L98 |
250,886 | lawsie/guizero | guizero/Window.py | Window.hide | def hide(self):
"""Hide the window."""
self.tk.withdraw()
self._visible = False
if self._modal:
self.tk.grab_release() | python | def hide(self):
self.tk.withdraw()
self._visible = False
if self._modal:
self.tk.grab_release() | [
"def",
"hide",
"(",
"self",
")",
":",
"self",
".",
"tk",
".",
"withdraw",
"(",
")",
"self",
".",
"_visible",
"=",
"False",
"if",
"self",
".",
"_modal",
":",
"self",
".",
"tk",
".",
"grab_release",
"(",
")"
] | Hide the window. | [
"Hide",
"the",
"window",
"."
] | 84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2 | https://github.com/lawsie/guizero/blob/84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2/guizero/Window.py#L32-L37 |
250,887 | lawsie/guizero | guizero/Window.py | Window.show | def show(self, wait = False):
"""Show the window."""
self.tk.deiconify()
self._visible = True
self._modal = wait
if self._modal:
self.tk.grab_set() | python | def show(self, wait = False):
self.tk.deiconify()
self._visible = True
self._modal = wait
if self._modal:
self.tk.grab_set() | [
"def",
"show",
"(",
"self",
",",
"wait",
"=",
"False",
")",
":",
"self",
".",
"tk",
".",
"deiconify",
"(",
")",
"self",
".",
"_visible",
"=",
"True",
"self",
".",
"_modal",
"=",
"wait",
"if",
"self",
".",
"_modal",
":",
"self",
".",
"tk",
".",
... | Show the window. | [
"Show",
"the",
"window",
"."
] | 84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2 | https://github.com/lawsie/guizero/blob/84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2/guizero/Window.py#L39-L45 |
250,888 | lawsie/guizero | guizero/App.py | App.destroy | def destroy(self):
"""
Destroy and close the App.
:return:
None.
:note:
Once destroyed an App can no longer be used.
"""
# if this is the main_app - set the _main_app class variable to `None`.
if self == App._main_app:
App._m... | python | def destroy(self):
# if this is the main_app - set the _main_app class variable to `None`.
if self == App._main_app:
App._main_app = None
self.tk.destroy() | [
"def",
"destroy",
"(",
"self",
")",
":",
"# if this is the main_app - set the _main_app class variable to `None`.",
"if",
"self",
"==",
"App",
".",
"_main_app",
":",
"App",
".",
"_main_app",
"=",
"None",
"self",
".",
"tk",
".",
"destroy",
"(",
")"
] | Destroy and close the App.
:return:
None.
:note:
Once destroyed an App can no longer be used. | [
"Destroy",
"and",
"close",
"the",
"App",
"."
] | 84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2 | https://github.com/lawsie/guizero/blob/84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2/guizero/App.py#L51-L64 |
250,889 | lawsie/guizero | guizero/Drawing.py | Drawing.line | def line(self, x1, y1, x2, y2, color="black", width=1):
"""
Draws a line between 2 points
:param int x1:
The x position of the starting point.
:param int y1:
The y position of the starting point.
:param int x2:
The x position of the end poin... | python | def line(self, x1, y1, x2, y2, color="black", width=1):
return self.tk.create_line(
x1, y1, x2, y2,
width = width,
fill = "" if color is None else utils.convert_color(color)
) | [
"def",
"line",
"(",
"self",
",",
"x1",
",",
"y1",
",",
"x2",
",",
"y2",
",",
"color",
"=",
"\"black\"",
",",
"width",
"=",
"1",
")",
":",
"return",
"self",
".",
"tk",
".",
"create_line",
"(",
"x1",
",",
"y1",
",",
"x2",
",",
"y2",
",",
"width... | Draws a line between 2 points
:param int x1:
The x position of the starting point.
:param int y1:
The y position of the starting point.
:param int x2:
The x position of the end point.
:param int y2:
The y position of the end point.
... | [
"Draws",
"a",
"line",
"between",
"2",
"points"
] | 84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2 | https://github.com/lawsie/guizero/blob/84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2/guizero/Drawing.py#L49-L78 |
250,890 | lawsie/guizero | guizero/Drawing.py | Drawing.oval | def oval(self, x1, y1, x2, y2, color="black", outline=False, outline_color="black"):
"""
Draws an oval between 2 points
:param int x1:
The x position of the starting point.
:param int y1:
The y position of the starting point.
:param int x2:
... | python | def oval(self, x1, y1, x2, y2, color="black", outline=False, outline_color="black"):
return self.tk.create_oval(
x1, y1, x2, y2,
outline = utils.convert_color(outline_color) if outline else "",
width = int(outline),
fill = "" if color is None else utils.convert_c... | [
"def",
"oval",
"(",
"self",
",",
"x1",
",",
"y1",
",",
"x2",
",",
"y2",
",",
"color",
"=",
"\"black\"",
",",
"outline",
"=",
"False",
",",
"outline_color",
"=",
"\"black\"",
")",
":",
"return",
"self",
".",
"tk",
".",
"create_oval",
"(",
"x1",
",",... | Draws an oval between 2 points
:param int x1:
The x position of the starting point.
:param int y1:
The y position of the starting point.
:param int x2:
The x position of the end point.
:param int y2:
The y position of the end point.
... | [
"Draws",
"an",
"oval",
"between",
"2",
"points"
] | 84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2 | https://github.com/lawsie/guizero/blob/84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2/guizero/Drawing.py#L80-L113 |
250,891 | lawsie/guizero | guizero/Drawing.py | Drawing.rectangle | def rectangle(self, x1, y1, x2, y2, color="black", outline=False, outline_color="black"):
"""
Draws a rectangle between 2 points
:param int x1:
The x position of the starting point.
:param int y1:
The y position of the starting point.
:param int x2:
... | python | def rectangle(self, x1, y1, x2, y2, color="black", outline=False, outline_color="black"):
return self.tk.create_rectangle(
x1, y1, x2, y2,
outline = utils.convert_color(outline_color) if outline else "",
width = int(outline),
fill = "" if color is None else utils... | [
"def",
"rectangle",
"(",
"self",
",",
"x1",
",",
"y1",
",",
"x2",
",",
"y2",
",",
"color",
"=",
"\"black\"",
",",
"outline",
"=",
"False",
",",
"outline_color",
"=",
"\"black\"",
")",
":",
"return",
"self",
".",
"tk",
".",
"create_rectangle",
"(",
"x... | Draws a rectangle between 2 points
:param int x1:
The x position of the starting point.
:param int y1:
The y position of the starting point.
:param int x2:
The x position of the end point.
:param int y2:
The y position of the end point.... | [
"Draws",
"a",
"rectangle",
"between",
"2",
"points"
] | 84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2 | https://github.com/lawsie/guizero/blob/84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2/guizero/Drawing.py#L115-L148 |
250,892 | lawsie/guizero | guizero/Drawing.py | Drawing.polygon | def polygon(self, *coords, color="black", outline=False, outline_color="black"):
"""
Draws a polygon from an list of co-ordinates
:param int *coords:
Pairs of x and y positions which make up the polygon.
:param str color:
The color of the shape. Defaults to `"bl... | python | def polygon(self, *coords, color="black", outline=False, outline_color="black"):
return self.tk.create_polygon(
*coords,
outline = utils.convert_color(outline_color) if outline else "",
width = int(outline),
fill = "" if color is None else utils.convert_color(col... | [
"def",
"polygon",
"(",
"self",
",",
"*",
"coords",
",",
"color",
"=",
"\"black\"",
",",
"outline",
"=",
"False",
",",
"outline_color",
"=",
"\"black\"",
")",
":",
"return",
"self",
".",
"tk",
".",
"create_polygon",
"(",
"*",
"coords",
",",
"outline",
"... | Draws a polygon from an list of co-ordinates
:param int *coords:
Pairs of x and y positions which make up the polygon.
:param str color:
The color of the shape. Defaults to `"black"`.
:param int outline:
`0` or `False` is no outline. `True` or value > 1 set... | [
"Draws",
"a",
"polygon",
"from",
"an",
"list",
"of",
"co",
"-",
"ordinates"
] | 84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2 | https://github.com/lawsie/guizero/blob/84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2/guizero/Drawing.py#L150-L174 |
250,893 | lawsie/guizero | guizero/Drawing.py | Drawing.triangle | def triangle(self, x1, y1, x2, y2, x3, y3, color="black", outline=False, outline_color="black"):
"""
Draws a triangle between 3 points
:param int x1:
The x position of the starting point.
:param int y1:
The y position of the starting point.
:param int x... | python | def triangle(self, x1, y1, x2, y2, x3, y3, color="black", outline=False, outline_color="black"):
return self.polygon(
x1, y1, x2, y2, x3, y3,
color=color,
outline=outline,
outline_color=outline_color) | [
"def",
"triangle",
"(",
"self",
",",
"x1",
",",
"y1",
",",
"x2",
",",
"y2",
",",
"x3",
",",
"y3",
",",
"color",
"=",
"\"black\"",
",",
"outline",
"=",
"False",
",",
"outline_color",
"=",
"\"black\"",
")",
":",
"return",
"self",
".",
"polygon",
"(",... | Draws a triangle between 3 points
:param int x1:
The x position of the starting point.
:param int y1:
The y position of the starting point.
:param int x2:
The x position of the middle point.
:param int y2:
The y position of the middle p... | [
"Draws",
"a",
"triangle",
"between",
"3",
"points"
] | 84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2 | https://github.com/lawsie/guizero/blob/84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2/guizero/Drawing.py#L176-L214 |
250,894 | lawsie/guizero | guizero/base.py | Base._get_tk_config | def _get_tk_config(self, key, default=False):
"""
Gets the config from the widget's tk object.
:param string key:
The tk config key.
:param bool default:
Returns the default value for this key. Defaults to `False`.
"""
if default:
ret... | python | def _get_tk_config(self, key, default=False):
if default:
return self._tk_defaults[key]
else:
return self.tk[key] | [
"def",
"_get_tk_config",
"(",
"self",
",",
"key",
",",
"default",
"=",
"False",
")",
":",
"if",
"default",
":",
"return",
"self",
".",
"_tk_defaults",
"[",
"key",
"]",
"else",
":",
"return",
"self",
".",
"tk",
"[",
"key",
"]"
] | Gets the config from the widget's tk object.
:param string key:
The tk config key.
:param bool default:
Returns the default value for this key. Defaults to `False`. | [
"Gets",
"the",
"config",
"from",
"the",
"widget",
"s",
"tk",
"object",
"."
] | 84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2 | https://github.com/lawsie/guizero/blob/84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2/guizero/base.py#L62-L75 |
250,895 | lawsie/guizero | guizero/base.py | Base._set_tk_config | def _set_tk_config(self, keys, value):
"""
Gets the config from the widget's tk object
:param string/List keys:
The tk config key or a list of tk keys.
:param variable value:
The value to set. If the value is `None`, the config value will be
reset to... | python | def _set_tk_config(self, keys, value):
# if a single key is passed, convert to list
if isinstance(keys, str):
keys = [keys]
# loop through all the keys
for key in keys:
if key in self.tk.keys():
if value is None:
# reset to def... | [
"def",
"_set_tk_config",
"(",
"self",
",",
"keys",
",",
"value",
")",
":",
"# if a single key is passed, convert to list",
"if",
"isinstance",
"(",
"keys",
",",
"str",
")",
":",
"keys",
"=",
"[",
"keys",
"]",
"# loop through all the keys",
"for",
"key",
"in",
... | Gets the config from the widget's tk object
:param string/List keys:
The tk config key or a list of tk keys.
:param variable value:
The value to set. If the value is `None`, the config value will be
reset to its default. | [
"Gets",
"the",
"config",
"from",
"the",
"widget",
"s",
"tk",
"object"
] | 84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2 | https://github.com/lawsie/guizero/blob/84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2/guizero/base.py#L77-L100 |
250,896 | lawsie/guizero | guizero/base.py | Component.destroy | def destroy(self):
"""
Destroy the tk widget.
"""
# if this widget has a master remove the it from the master
if self.master is not None:
self.master._remove_child(self)
self.tk.destroy() | python | def destroy(self):
# if this widget has a master remove the it from the master
if self.master is not None:
self.master._remove_child(self)
self.tk.destroy() | [
"def",
"destroy",
"(",
"self",
")",
":",
"# if this widget has a master remove the it from the master",
"if",
"self",
".",
"master",
"is",
"not",
"None",
":",
"self",
".",
"master",
".",
"_remove_child",
"(",
"self",
")",
"self",
".",
"tk",
".",
"destroy",
"("... | Destroy the tk widget. | [
"Destroy",
"the",
"tk",
"widget",
"."
] | 84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2 | https://github.com/lawsie/guizero/blob/84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2/guizero/base.py#L169-L177 |
250,897 | lawsie/guizero | guizero/base.py | Container.add_tk_widget | def add_tk_widget(self, tk_widget, grid=None, align=None, visible=True, enabled=None, width=None, height=None):
"""
Adds a tk widget into a guizero container.
:param tkinter.Widget tk_widget:
The Container (App, Box, etc) the tk widget will belong too.
:param List grid:
... | python | def add_tk_widget(self, tk_widget, grid=None, align=None, visible=True, enabled=None, width=None, height=None):
return Widget(self, tk_widget, "tk widget", grid, align, visible, enabled, width, height) | [
"def",
"add_tk_widget",
"(",
"self",
",",
"tk_widget",
",",
"grid",
"=",
"None",
",",
"align",
"=",
"None",
",",
"visible",
"=",
"True",
",",
"enabled",
"=",
"None",
",",
"width",
"=",
"None",
",",
"height",
"=",
"None",
")",
":",
"return",
"Widget",... | Adds a tk widget into a guizero container.
:param tkinter.Widget tk_widget:
The Container (App, Box, etc) the tk widget will belong too.
:param List grid:
Grid co-ordinates for the widget, required if the master layout
is 'grid', defaults to `None`.
:param ... | [
"Adds",
"a",
"tk",
"widget",
"into",
"a",
"guizero",
"container",
"."
] | 84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2 | https://github.com/lawsie/guizero/blob/84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2/guizero/base.py#L289-L318 |
250,898 | lawsie/guizero | guizero/base.py | Container.display_widgets | def display_widgets(self):
"""
Displays all the widgets associated with this Container.
Should be called when the widgets need to be "re-packed/gridded".
"""
# All widgets are removed and then recreated to ensure the order they
# were created is the order they are displa... | python | def display_widgets(self):
# All widgets are removed and then recreated to ensure the order they
# were created is the order they are displayed.
for child in self.children:
if child.displayable:
# forget the widget
if self.layout != "grid":
... | [
"def",
"display_widgets",
"(",
"self",
")",
":",
"# All widgets are removed and then recreated to ensure the order they",
"# were created is the order they are displayed.",
"for",
"child",
"in",
"self",
".",
"children",
":",
"if",
"child",
".",
"displayable",
":",
"# forget t... | Displays all the widgets associated with this Container.
Should be called when the widgets need to be "re-packed/gridded". | [
"Displays",
"all",
"the",
"widgets",
"associated",
"with",
"this",
"Container",
"."
] | 84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2 | https://github.com/lawsie/guizero/blob/84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2/guizero/base.py#L334-L358 |
250,899 | lawsie/guizero | guizero/base.py | Container.disable | def disable(self):
"""
Disable all the widgets in this container
"""
self._enabled = False
for child in self.children:
if isinstance(child, (Container, Widget)):
child.disable() | python | def disable(self):
self._enabled = False
for child in self.children:
if isinstance(child, (Container, Widget)):
child.disable() | [
"def",
"disable",
"(",
"self",
")",
":",
"self",
".",
"_enabled",
"=",
"False",
"for",
"child",
"in",
"self",
".",
"children",
":",
"if",
"isinstance",
"(",
"child",
",",
"(",
"Container",
",",
"Widget",
")",
")",
":",
"child",
".",
"disable",
"(",
... | Disable all the widgets in this container | [
"Disable",
"all",
"the",
"widgets",
"in",
"this",
"container"
] | 84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2 | https://github.com/lawsie/guizero/blob/84c7f0b314fa86f9fc88eb11c9a0f6c4b57155e2/guizero/base.py#L442-L449 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.