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
75
19.8k
code_tokens
list
docstring
stringlengths
3
17.3k
docstring_tokens
list
sha
stringlengths
40
40
url
stringlengths
87
242
partition
stringclasses
1 value
aewallin/allantools
allantools/allantools.py
phase2radians
def phase2radians(phasedata, v0): """ Convert phase in seconds to phase in radians Parameters ---------- phasedata: np.array Data array of phase in seconds v0: float Nominal oscillator frequency in Hz Returns ------- fi: phase data in radians """ fi = [2...
python
def phase2radians(phasedata, v0): """ Convert phase in seconds to phase in radians Parameters ---------- phasedata: np.array Data array of phase in seconds v0: float Nominal oscillator frequency in Hz Returns ------- fi: phase data in radians """ fi = [2...
[ "def", "phase2radians", "(", "phasedata", ",", "v0", ")", ":", "fi", "=", "[", "2", "*", "np", ".", "pi", "*", "v0", "*", "xx", "for", "xx", "in", "phasedata", "]", "return", "fi" ]
Convert phase in seconds to phase in radians Parameters ---------- phasedata: np.array Data array of phase in seconds v0: float Nominal oscillator frequency in Hz Returns ------- fi: phase data in radians
[ "Convert", "phase", "in", "seconds", "to", "phase", "in", "radians" ]
b5c695a5af4379fcea4d4ce93a066cb902e7ee0a
https://github.com/aewallin/allantools/blob/b5c695a5af4379fcea4d4ce93a066cb902e7ee0a/allantools/allantools.py#L1621-L1637
train
aewallin/allantools
allantools/allantools.py
frequency2fractional
def frequency2fractional(frequency, mean_frequency=-1): """ Convert frequency in Hz to fractional frequency Parameters ---------- frequency: np.array Data array of frequency in Hz mean_frequency: float (optional) The nominal mean frequency, in Hz if omitted, defaults to mean...
python
def frequency2fractional(frequency, mean_frequency=-1): """ Convert frequency in Hz to fractional frequency Parameters ---------- frequency: np.array Data array of frequency in Hz mean_frequency: float (optional) The nominal mean frequency, in Hz if omitted, defaults to mean...
[ "def", "frequency2fractional", "(", "frequency", ",", "mean_frequency", "=", "-", "1", ")", ":", "if", "mean_frequency", "==", "-", "1", ":", "mu", "=", "np", ".", "mean", "(", "frequency", ")", "else", ":", "mu", "=", "mean_frequency", "y", "=", "[", ...
Convert frequency in Hz to fractional frequency Parameters ---------- frequency: np.array Data array of frequency in Hz mean_frequency: float (optional) The nominal mean frequency, in Hz if omitted, defaults to mean frequency=np.mean(frequency) Returns ------- y: ...
[ "Convert", "frequency", "in", "Hz", "to", "fractional", "frequency" ]
b5c695a5af4379fcea4d4ce93a066cb902e7ee0a
https://github.com/aewallin/allantools/blob/b5c695a5af4379fcea4d4ce93a066cb902e7ee0a/allantools/allantools.py#L1657-L1678
train
aewallin/allantools
allantools/dataset.py
Dataset.set_input
def set_input(self, data, rate=1.0, data_type="phase", taus=None): """ Optionnal method if you chose not to set inputs on init Parameters ---------- data: np.array Input data. Provide either phase or frequency (fractional, adimensional) ...
python
def set_input(self, data, rate=1.0, data_type="phase", taus=None): """ Optionnal method if you chose not to set inputs on init Parameters ---------- data: np.array Input data. Provide either phase or frequency (fractional, adimensional) ...
[ "def", "set_input", "(", "self", ",", "data", ",", "rate", "=", "1.0", ",", "data_type", "=", "\"phase\"", ",", "taus", "=", "None", ")", ":", "self", ".", "inp", "[", "\"data\"", "]", "=", "data", "self", ".", "inp", "[", "\"rate\"", "]", "=", "...
Optionnal method if you chose not to set inputs on init Parameters ---------- data: np.array Input data. Provide either phase or frequency (fractional, adimensional) rate: float The sampling rate for data, in Hz. Defaults to 1.0 data_type: {'p...
[ "Optionnal", "method", "if", "you", "chose", "not", "to", "set", "inputs", "on", "init" ]
b5c695a5af4379fcea4d4ce93a066cb902e7ee0a
https://github.com/aewallin/allantools/blob/b5c695a5af4379fcea4d4ce93a066cb902e7ee0a/allantools/dataset.py#L93-L113
train
aewallin/allantools
allantools/dataset.py
Dataset.compute
def compute(self, function): """Evaluate the passed function with the supplied data. Stores result in self.out. Parameters ---------- function: str Name of the :mod:`allantools` function to evaluate Returns ------- result: dict T...
python
def compute(self, function): """Evaluate the passed function with the supplied data. Stores result in self.out. Parameters ---------- function: str Name of the :mod:`allantools` function to evaluate Returns ------- result: dict T...
[ "def", "compute", "(", "self", ",", "function", ")", ":", "try", ":", "func", "=", "getattr", "(", "allantools", ",", "function", ")", "except", "AttributeError", ":", "raise", "AttributeError", "(", "\"function must be defined in allantools\"", ")", "whitelisted"...
Evaluate the passed function with the supplied data. Stores result in self.out. Parameters ---------- function: str Name of the :mod:`allantools` function to evaluate Returns ------- result: dict The results of the calculation.
[ "Evaluate", "the", "passed", "function", "with", "the", "supplied", "data", "." ]
b5c695a5af4379fcea4d4ce93a066cb902e7ee0a
https://github.com/aewallin/allantools/blob/b5c695a5af4379fcea4d4ce93a066cb902e7ee0a/allantools/dataset.py#L115-L148
train
aewallin/allantools
examples/noise-color_and_PSD.py
many_psds
def many_psds(k=2,fs=1.0, b0=1.0, N=1024): """ compute average of many PSDs """ psd=[] for j in range(k): print j x = noise.white(N=2*4096,b0=b0,fs=fs) f, tmp = noise.numpy_psd(x,fs) if j==0: psd = tmp else: psd = psd + tmp return f, psd/k
python
def many_psds(k=2,fs=1.0, b0=1.0, N=1024): """ compute average of many PSDs """ psd=[] for j in range(k): print j x = noise.white(N=2*4096,b0=b0,fs=fs) f, tmp = noise.numpy_psd(x,fs) if j==0: psd = tmp else: psd = psd + tmp return f, psd/k
[ "def", "many_psds", "(", "k", "=", "2", ",", "fs", "=", "1.0", ",", "b0", "=", "1.0", ",", "N", "=", "1024", ")", ":", "psd", "=", "[", "]", "for", "j", "in", "range", "(", "k", ")", ":", "print", "j", "x", "=", "noise", ".", "white", "("...
compute average of many PSDs
[ "compute", "average", "of", "many", "PSDs" ]
b5c695a5af4379fcea4d4ce93a066cb902e7ee0a
https://github.com/aewallin/allantools/blob/b5c695a5af4379fcea4d4ce93a066cb902e7ee0a/examples/noise-color_and_PSD.py#L7-L18
train
singnet/snet-cli
snet_cli/commands.py
OrganizationCommand.list_my
def list_my(self): """ Find organization that has the current identity as the owner or as the member """ org_list = self.call_contract_command("Registry", "listOrganizations", []) rez_owner = [] rez_member = [] for idx, org_id in enumerate(org_list): (found, org_id,...
python
def list_my(self): """ Find organization that has the current identity as the owner or as the member """ org_list = self.call_contract_command("Registry", "listOrganizations", []) rez_owner = [] rez_member = [] for idx, org_id in enumerate(org_list): (found, org_id,...
[ "def", "list_my", "(", "self", ")", ":", "org_list", "=", "self", ".", "call_contract_command", "(", "\"Registry\"", ",", "\"listOrganizations\"", ",", "[", "]", ")", "rez_owner", "=", "[", "]", "rez_member", "=", "[", "]", "for", "idx", ",", "org_id", "...
Find organization that has the current identity as the owner or as the member
[ "Find", "organization", "that", "has", "the", "current", "identity", "as", "the", "owner", "or", "as", "the", "member" ]
1b5ac98cb9a64211c861ead9fcfe6208f2749032
https://github.com/singnet/snet-cli/blob/1b5ac98cb9a64211c861ead9fcfe6208f2749032/snet_cli/commands.py#L541-L567
train
singnet/snet-cli
snet_cli/mpe_service_metadata.py
MPEServiceMetadata.add_group
def add_group(self, group_name, payment_address): """ Return new group_id in base64 """ if (self.is_group_name_exists(group_name)): raise Exception("the group \"%s\" is already present"%str(group_name)) group_id_base64 = base64.b64encode(secrets.token_bytes(32)) self.m["group...
python
def add_group(self, group_name, payment_address): """ Return new group_id in base64 """ if (self.is_group_name_exists(group_name)): raise Exception("the group \"%s\" is already present"%str(group_name)) group_id_base64 = base64.b64encode(secrets.token_bytes(32)) self.m["group...
[ "def", "add_group", "(", "self", ",", "group_name", ",", "payment_address", ")", ":", "if", "(", "self", ".", "is_group_name_exists", "(", "group_name", ")", ")", ":", "raise", "Exception", "(", "\"the group \\\"%s\\\" is already present\"", "%", "str", "(", "gr...
Return new group_id in base64
[ "Return", "new", "group_id", "in", "base64" ]
1b5ac98cb9a64211c861ead9fcfe6208f2749032
https://github.com/singnet/snet-cli/blob/1b5ac98cb9a64211c861ead9fcfe6208f2749032/snet_cli/mpe_service_metadata.py#L75-L83
train
singnet/snet-cli
snet_cli/mpe_service_metadata.py
MPEServiceMetadata.is_group_name_exists
def is_group_name_exists(self, group_name): """ check if group with given name is already exists """ groups = self.m["groups"] for g in groups: if (g["group_name"] == group_name): return True return False
python
def is_group_name_exists(self, group_name): """ check if group with given name is already exists """ groups = self.m["groups"] for g in groups: if (g["group_name"] == group_name): return True return False
[ "def", "is_group_name_exists", "(", "self", ",", "group_name", ")", ":", "groups", "=", "self", ".", "m", "[", "\"groups\"", "]", "for", "g", "in", "groups", ":", "if", "(", "g", "[", "\"group_name\"", "]", "==", "group_name", ")", ":", "return", "True...
check if group with given name is already exists
[ "check", "if", "group", "with", "given", "name", "is", "already", "exists" ]
1b5ac98cb9a64211c861ead9fcfe6208f2749032
https://github.com/singnet/snet-cli/blob/1b5ac98cb9a64211c861ead9fcfe6208f2749032/snet_cli/mpe_service_metadata.py#L103-L109
train
singnet/snet-cli
snet_cli/mpe_service_metadata.py
MPEServiceMetadata.get_group_name_nonetrick
def get_group_name_nonetrick(self, group_name = None): """ In all getter function in case of single payment group, group_name can be None """ groups = self.m["groups"] if (len(groups) == 0): raise Exception("Cannot find any groups in metadata") if (not group_name): ...
python
def get_group_name_nonetrick(self, group_name = None): """ In all getter function in case of single payment group, group_name can be None """ groups = self.m["groups"] if (len(groups) == 0): raise Exception("Cannot find any groups in metadata") if (not group_name): ...
[ "def", "get_group_name_nonetrick", "(", "self", ",", "group_name", "=", "None", ")", ":", "groups", "=", "self", ".", "m", "[", "\"groups\"", "]", "if", "(", "len", "(", "groups", ")", "==", "0", ")", ":", "raise", "Exception", "(", "\"Cannot find any gr...
In all getter function in case of single payment group, group_name can be None
[ "In", "all", "getter", "function", "in", "case", "of", "single", "payment", "group", "group_name", "can", "be", "None" ]
1b5ac98cb9a64211c861ead9fcfe6208f2749032
https://github.com/singnet/snet-cli/blob/1b5ac98cb9a64211c861ead9fcfe6208f2749032/snet_cli/mpe_service_metadata.py#L145-L154
train
singnet/snet-cli
snet_cli/utils_ipfs.py
get_from_ipfs_and_checkhash
def get_from_ipfs_and_checkhash(ipfs_client, ipfs_hash_base58, validate=True): """ Get file from ipfs We must check the hash becasue we cannot believe that ipfs_client wasn't been compromise """ if validate: from snet_cli.resources.proto.unixfs_pb2 import Data from snet_cli.resources...
python
def get_from_ipfs_and_checkhash(ipfs_client, ipfs_hash_base58, validate=True): """ Get file from ipfs We must check the hash becasue we cannot believe that ipfs_client wasn't been compromise """ if validate: from snet_cli.resources.proto.unixfs_pb2 import Data from snet_cli.resources...
[ "def", "get_from_ipfs_and_checkhash", "(", "ipfs_client", ",", "ipfs_hash_base58", ",", "validate", "=", "True", ")", ":", "if", "validate", ":", "from", "snet_cli", ".", "resources", ".", "proto", ".", "unixfs_pb2", "import", "Data", "from", "snet_cli", ".", ...
Get file from ipfs We must check the hash becasue we cannot believe that ipfs_client wasn't been compromise
[ "Get", "file", "from", "ipfs", "We", "must", "check", "the", "hash", "becasue", "we", "cannot", "believe", "that", "ipfs_client", "wasn", "t", "been", "compromise" ]
1b5ac98cb9a64211c861ead9fcfe6208f2749032
https://github.com/singnet/snet-cli/blob/1b5ac98cb9a64211c861ead9fcfe6208f2749032/snet_cli/utils_ipfs.py#L35-L63
train
singnet/snet-cli
snet_cli/utils_ipfs.py
hash_to_bytesuri
def hash_to_bytesuri(s): """ Convert in and from bytes uri format used in Registry contract """ # TODO: we should pad string with zeros till closest 32 bytes word because of a bug in processReceipt (in snet_cli.contract.process_receipt) s = "ipfs://" + s return s.encode("ascii").ljust(32 * (len(...
python
def hash_to_bytesuri(s): """ Convert in and from bytes uri format used in Registry contract """ # TODO: we should pad string with zeros till closest 32 bytes word because of a bug in processReceipt (in snet_cli.contract.process_receipt) s = "ipfs://" + s return s.encode("ascii").ljust(32 * (len(...
[ "def", "hash_to_bytesuri", "(", "s", ")", ":", "s", "=", "\"ipfs://\"", "+", "s", "return", "s", ".", "encode", "(", "\"ascii\"", ")", ".", "ljust", "(", "32", "*", "(", "len", "(", "s", ")", "//", "32", "+", "1", ")", ",", "b\"\\0\"", ")" ]
Convert in and from bytes uri format used in Registry contract
[ "Convert", "in", "and", "from", "bytes", "uri", "format", "used", "in", "Registry", "contract" ]
1b5ac98cb9a64211c861ead9fcfe6208f2749032
https://github.com/singnet/snet-cli/blob/1b5ac98cb9a64211c861ead9fcfe6208f2749032/snet_cli/utils_ipfs.py#L65-L71
train
singnet/snet-cli
snet_cli/mpe_treasurer_command.py
MPETreasurerCommand._get_stub_and_request_classes
def _get_stub_and_request_classes(self, service_name): """ import protobuf and return stub and request class """ # Compile protobuf if needed codegen_dir = Path.home().joinpath(".snet", "mpe_client", "control_service") proto_dir = Path(__file__).absolute().parent.joinpath("resources", ...
python
def _get_stub_and_request_classes(self, service_name): """ import protobuf and return stub and request class """ # Compile protobuf if needed codegen_dir = Path.home().joinpath(".snet", "mpe_client", "control_service") proto_dir = Path(__file__).absolute().parent.joinpath("resources", ...
[ "def", "_get_stub_and_request_classes", "(", "self", ",", "service_name", ")", ":", "codegen_dir", "=", "Path", ".", "home", "(", ")", ".", "joinpath", "(", "\".snet\"", ",", "\"mpe_client\"", ",", "\"control_service\"", ")", "proto_dir", "=", "Path", "(", "__...
import protobuf and return stub and request class
[ "import", "protobuf", "and", "return", "stub", "and", "request", "class" ]
1b5ac98cb9a64211c861ead9fcfe6208f2749032
https://github.com/singnet/snet-cli/blob/1b5ac98cb9a64211c861ead9fcfe6208f2749032/snet_cli/mpe_treasurer_command.py#L31-L40
train
singnet/snet-cli
snet_cli/mpe_treasurer_command.py
MPETreasurerCommand._start_claim_channels
def _start_claim_channels(self, grpc_channel, channels_ids): """ Safely run StartClaim for given channels """ unclaimed_payments = self._call_GetListUnclaimed(grpc_channel) unclaimed_payments_dict = {p["channel_id"] : p for p in unclaimed_payments} to_claim = [] for channel_id i...
python
def _start_claim_channels(self, grpc_channel, channels_ids): """ Safely run StartClaim for given channels """ unclaimed_payments = self._call_GetListUnclaimed(grpc_channel) unclaimed_payments_dict = {p["channel_id"] : p for p in unclaimed_payments} to_claim = [] for channel_id i...
[ "def", "_start_claim_channels", "(", "self", ",", "grpc_channel", ",", "channels_ids", ")", ":", "unclaimed_payments", "=", "self", ".", "_call_GetListUnclaimed", "(", "grpc_channel", ")", "unclaimed_payments_dict", "=", "{", "p", "[", "\"channel_id\"", "]", ":", ...
Safely run StartClaim for given channels
[ "Safely", "run", "StartClaim", "for", "given", "channels" ]
1b5ac98cb9a64211c861ead9fcfe6208f2749032
https://github.com/singnet/snet-cli/blob/1b5ac98cb9a64211c861ead9fcfe6208f2749032/snet_cli/mpe_treasurer_command.py#L103-L120
train
singnet/snet-cli
snet_cli/mpe_treasurer_command.py
MPETreasurerCommand._claim_in_progress_and_claim_channels
def _claim_in_progress_and_claim_channels(self, grpc_channel, channels): """ Claim all 'pending' payments in progress and after we claim given channels """ # first we get the list of all 'payments in progress' in case we 'lost' some payments. payments = self._call_GetListInProgress(grpc_channel)...
python
def _claim_in_progress_and_claim_channels(self, grpc_channel, channels): """ Claim all 'pending' payments in progress and after we claim given channels """ # first we get the list of all 'payments in progress' in case we 'lost' some payments. payments = self._call_GetListInProgress(grpc_channel)...
[ "def", "_claim_in_progress_and_claim_channels", "(", "self", ",", "grpc_channel", ",", "channels", ")", ":", "payments", "=", "self", ".", "_call_GetListInProgress", "(", "grpc_channel", ")", "if", "(", "len", "(", "payments", ")", ">", "0", ")", ":", "self", ...
Claim all 'pending' payments in progress and after we claim given channels
[ "Claim", "all", "pending", "payments", "in", "progress", "and", "after", "we", "claim", "given", "channels" ]
1b5ac98cb9a64211c861ead9fcfe6208f2749032
https://github.com/singnet/snet-cli/blob/1b5ac98cb9a64211c861ead9fcfe6208f2749032/snet_cli/mpe_treasurer_command.py#L122-L130
train
singnet/snet-cli
snet_cli/config.py
Config.create_default_config
def create_default_config(self): """ Create default configuration if config file does not exist """ # make config directory with the minimal possible permission self._config_file.parent.mkdir(mode=0o700, exist_ok=True) self["network.kovan"] = {"default_eth_rpc_endpoint": "https://kovan...
python
def create_default_config(self): """ Create default configuration if config file does not exist """ # make config directory with the minimal possible permission self._config_file.parent.mkdir(mode=0o700, exist_ok=True) self["network.kovan"] = {"default_eth_rpc_endpoint": "https://kovan...
[ "def", "create_default_config", "(", "self", ")", ":", "self", ".", "_config_file", ".", "parent", ".", "mkdir", "(", "mode", "=", "0o700", ",", "exist_ok", "=", "True", ")", "self", "[", "\"network.kovan\"", "]", "=", "{", "\"default_eth_rpc_endpoint\"", ":...
Create default configuration if config file does not exist
[ "Create", "default", "configuration", "if", "config", "file", "does", "not", "exist" ]
1b5ac98cb9a64211c861ead9fcfe6208f2749032
https://github.com/singnet/snet-cli/blob/1b5ac98cb9a64211c861ead9fcfe6208f2749032/snet_cli/config.py#L175-L187
train
singnet/snet-cli
snet_cli/utils_proto.py
switch_to_json_payload_encoding
def switch_to_json_payload_encoding(call_fn, response_class): """ Switch payload encoding to JSON for GRPC call """ def json_serializer(*args, **kwargs): return bytes(json_format.MessageToJson(args[0], True, preserving_proto_field_name=True), "utf-8") def json_deserializer(*args, **kwargs): ...
python
def switch_to_json_payload_encoding(call_fn, response_class): """ Switch payload encoding to JSON for GRPC call """ def json_serializer(*args, **kwargs): return bytes(json_format.MessageToJson(args[0], True, preserving_proto_field_name=True), "utf-8") def json_deserializer(*args, **kwargs): ...
[ "def", "switch_to_json_payload_encoding", "(", "call_fn", ",", "response_class", ")", ":", "def", "json_serializer", "(", "*", "args", ",", "**", "kwargs", ")", ":", "return", "bytes", "(", "json_format", ".", "MessageToJson", "(", "args", "[", "0", "]", ","...
Switch payload encoding to JSON for GRPC call
[ "Switch", "payload", "encoding", "to", "JSON", "for", "GRPC", "call" ]
1b5ac98cb9a64211c861ead9fcfe6208f2749032
https://github.com/singnet/snet-cli/blob/1b5ac98cb9a64211c861ead9fcfe6208f2749032/snet_cli/utils_proto.py#L72-L81
train
singnet/snet-cli
snet_cli/mpe_account_command.py
MPEAccountCommand.print_agi_and_mpe_balances
def print_agi_and_mpe_balances(self): """ Print balance of ETH, AGI, and MPE wallet """ if (self.args.account): account = self.args.account else: account = self.ident.address eth_wei = self.w3.eth.getBalance(account) agi_cogs = self.call_contract_command(...
python
def print_agi_and_mpe_balances(self): """ Print balance of ETH, AGI, and MPE wallet """ if (self.args.account): account = self.args.account else: account = self.ident.address eth_wei = self.w3.eth.getBalance(account) agi_cogs = self.call_contract_command(...
[ "def", "print_agi_and_mpe_balances", "(", "self", ")", ":", "if", "(", "self", ".", "args", ".", "account", ")", ":", "account", "=", "self", ".", "args", ".", "account", "else", ":", "account", "=", "self", ".", "ident", ".", "address", "eth_wei", "="...
Print balance of ETH, AGI, and MPE wallet
[ "Print", "balance", "of", "ETH", "AGI", "and", "MPE", "wallet" ]
1b5ac98cb9a64211c861ead9fcfe6208f2749032
https://github.com/singnet/snet-cli/blob/1b5ac98cb9a64211c861ead9fcfe6208f2749032/snet_cli/mpe_account_command.py#L10-L24
train
singnet/snet-cli
snet_cli/mpe_service_command.py
MPEServiceCommand.publish_proto_in_ipfs
def publish_proto_in_ipfs(self): """ Publish proto files in ipfs and print hash """ ipfs_hash_base58 = utils_ipfs.publish_proto_in_ipfs(self._get_ipfs_client(), self.args.protodir) self._printout(ipfs_hash_base58)
python
def publish_proto_in_ipfs(self): """ Publish proto files in ipfs and print hash """ ipfs_hash_base58 = utils_ipfs.publish_proto_in_ipfs(self._get_ipfs_client(), self.args.protodir) self._printout(ipfs_hash_base58)
[ "def", "publish_proto_in_ipfs", "(", "self", ")", ":", "ipfs_hash_base58", "=", "utils_ipfs", ".", "publish_proto_in_ipfs", "(", "self", ".", "_get_ipfs_client", "(", ")", ",", "self", ".", "args", ".", "protodir", ")", "self", ".", "_printout", "(", "ipfs_has...
Publish proto files in ipfs and print hash
[ "Publish", "proto", "files", "in", "ipfs", "and", "print", "hash" ]
1b5ac98cb9a64211c861ead9fcfe6208f2749032
https://github.com/singnet/snet-cli/blob/1b5ac98cb9a64211c861ead9fcfe6208f2749032/snet_cli/mpe_service_command.py#L15-L18
train
singnet/snet-cli
snet_cli/mpe_service_command.py
MPEServiceCommand.publish_proto_metadata_update
def publish_proto_metadata_update(self): """ Publish protobuf model in ipfs and update existing metadata file """ metadata = load_mpe_service_metadata(self.args.metadata_file) ipfs_hash_base58 = utils_ipfs.publish_proto_in_ipfs(self._get_ipfs_client(), self.args.protodir) metadata.set_si...
python
def publish_proto_metadata_update(self): """ Publish protobuf model in ipfs and update existing metadata file """ metadata = load_mpe_service_metadata(self.args.metadata_file) ipfs_hash_base58 = utils_ipfs.publish_proto_in_ipfs(self._get_ipfs_client(), self.args.protodir) metadata.set_si...
[ "def", "publish_proto_metadata_update", "(", "self", ")", ":", "metadata", "=", "load_mpe_service_metadata", "(", "self", ".", "args", ".", "metadata_file", ")", "ipfs_hash_base58", "=", "utils_ipfs", ".", "publish_proto_in_ipfs", "(", "self", ".", "_get_ipfs_client",...
Publish protobuf model in ipfs and update existing metadata file
[ "Publish", "protobuf", "model", "in", "ipfs", "and", "update", "existing", "metadata", "file" ]
1b5ac98cb9a64211c861ead9fcfe6208f2749032
https://github.com/singnet/snet-cli/blob/1b5ac98cb9a64211c861ead9fcfe6208f2749032/snet_cli/mpe_service_command.py#L37-L42
train
singnet/snet-cli
snet_cli/mpe_channel_command.py
MPEChannelCommand._get_persistent_mpe_dir
def _get_persistent_mpe_dir(self): """ get persistent storage for mpe """ mpe_address = self.get_mpe_address().lower() registry_address = self.get_registry_address().lower() return Path.home().joinpath(".snet", "mpe_client", "%s_%s"%(mpe_address, registry_address))
python
def _get_persistent_mpe_dir(self): """ get persistent storage for mpe """ mpe_address = self.get_mpe_address().lower() registry_address = self.get_registry_address().lower() return Path.home().joinpath(".snet", "mpe_client", "%s_%s"%(mpe_address, registry_address))
[ "def", "_get_persistent_mpe_dir", "(", "self", ")", ":", "mpe_address", "=", "self", ".", "get_mpe_address", "(", ")", ".", "lower", "(", ")", "registry_address", "=", "self", ".", "get_registry_address", "(", ")", ".", "lower", "(", ")", "return", "Path", ...
get persistent storage for mpe
[ "get", "persistent", "storage", "for", "mpe" ]
1b5ac98cb9a64211c861ead9fcfe6208f2749032
https://github.com/singnet/snet-cli/blob/1b5ac98cb9a64211c861ead9fcfe6208f2749032/snet_cli/mpe_channel_command.py#L21-L25
train
singnet/snet-cli
snet_cli/mpe_channel_command.py
MPEChannelCommand._check_mpe_address_metadata
def _check_mpe_address_metadata(self, metadata): """ we make sure that MultiPartyEscrow address from metadata is correct """ mpe_address = self.get_mpe_address() if (str(mpe_address).lower() != str(metadata["mpe_address"]).lower()): raise Exception("MultiPartyEscrow contract address ...
python
def _check_mpe_address_metadata(self, metadata): """ we make sure that MultiPartyEscrow address from metadata is correct """ mpe_address = self.get_mpe_address() if (str(mpe_address).lower() != str(metadata["mpe_address"]).lower()): raise Exception("MultiPartyEscrow contract address ...
[ "def", "_check_mpe_address_metadata", "(", "self", ",", "metadata", ")", ":", "mpe_address", "=", "self", ".", "get_mpe_address", "(", ")", "if", "(", "str", "(", "mpe_address", ")", ".", "lower", "(", ")", "!=", "str", "(", "metadata", "[", "\"mpe_address...
we make sure that MultiPartyEscrow address from metadata is correct
[ "we", "make", "sure", "that", "MultiPartyEscrow", "address", "from", "metadata", "is", "correct" ]
1b5ac98cb9a64211c861ead9fcfe6208f2749032
https://github.com/singnet/snet-cli/blob/1b5ac98cb9a64211c861ead9fcfe6208f2749032/snet_cli/mpe_channel_command.py#L74-L78
train
singnet/snet-cli
snet_cli/mpe_channel_command.py
MPEChannelCommand._init_or_update_registered_service_if_needed
def _init_or_update_registered_service_if_needed(self): ''' similar to _init_or_update_service_if_needed but we get service_registraion from registry, so we can update only registered services ''' if (self.is_service_initialized()): old_reg = self._read_service_info(s...
python
def _init_or_update_registered_service_if_needed(self): ''' similar to _init_or_update_service_if_needed but we get service_registraion from registry, so we can update only registered services ''' if (self.is_service_initialized()): old_reg = self._read_service_info(s...
[ "def", "_init_or_update_registered_service_if_needed", "(", "self", ")", ":", "if", "(", "self", ".", "is_service_initialized", "(", ")", ")", ":", "old_reg", "=", "self", ".", "_read_service_info", "(", "self", ".", "args", ".", "org_id", ",", "self", ".", ...
similar to _init_or_update_service_if_needed but we get service_registraion from registry, so we can update only registered services
[ "similar", "to", "_init_or_update_service_if_needed", "but", "we", "get", "service_registraion", "from", "registry", "so", "we", "can", "update", "only", "registered", "services" ]
1b5ac98cb9a64211c861ead9fcfe6208f2749032
https://github.com/singnet/snet-cli/blob/1b5ac98cb9a64211c861ead9fcfe6208f2749032/snet_cli/mpe_channel_command.py#L115-L136
train
singnet/snet-cli
snet_cli/mpe_channel_command.py
MPEChannelCommand._smart_get_initialized_channel_for_service
def _smart_get_initialized_channel_for_service(self, metadata, filter_by, is_try_initailize = True): ''' - filter_by can be sender or signer ''' channels = self._get_initialized_channels_for_service(self.args.org_id, self.args.service_id) group_id = metadata.get_group_id(self.ar...
python
def _smart_get_initialized_channel_for_service(self, metadata, filter_by, is_try_initailize = True): ''' - filter_by can be sender or signer ''' channels = self._get_initialized_channels_for_service(self.args.org_id, self.args.service_id) group_id = metadata.get_group_id(self.ar...
[ "def", "_smart_get_initialized_channel_for_service", "(", "self", ",", "metadata", ",", "filter_by", ",", "is_try_initailize", "=", "True", ")", ":", "channels", "=", "self", ".", "_get_initialized_channels_for_service", "(", "self", ".", "args", ".", "org_id", ",",...
- filter_by can be sender or signer
[ "-", "filter_by", "can", "be", "sender", "or", "signer" ]
1b5ac98cb9a64211c861ead9fcfe6208f2749032
https://github.com/singnet/snet-cli/blob/1b5ac98cb9a64211c861ead9fcfe6208f2749032/snet_cli/mpe_channel_command.py#L297-L320
train
singnet/snet-cli
snet_cli/mpe_channel_command.py
MPEChannelCommand._get_all_filtered_channels
def _get_all_filtered_channels(self, topics_without_signature): """ get all filtered chanels from blockchain logs """ mpe_address = self.get_mpe_address() event_signature = self.ident.w3.sha3(text="ChannelOpen(uint256,uint256,address,address,address,bytes32,uint256,uint256)").hex() t...
python
def _get_all_filtered_channels(self, topics_without_signature): """ get all filtered chanels from blockchain logs """ mpe_address = self.get_mpe_address() event_signature = self.ident.w3.sha3(text="ChannelOpen(uint256,uint256,address,address,address,bytes32,uint256,uint256)").hex() t...
[ "def", "_get_all_filtered_channels", "(", "self", ",", "topics_without_signature", ")", ":", "mpe_address", "=", "self", ".", "get_mpe_address", "(", ")", "event_signature", "=", "self", ".", "ident", ".", "w3", ".", "sha3", "(", "text", "=", "\"ChannelOpen(uint...
get all filtered chanels from blockchain logs
[ "get", "all", "filtered", "chanels", "from", "blockchain", "logs" ]
1b5ac98cb9a64211c861ead9fcfe6208f2749032
https://github.com/singnet/snet-cli/blob/1b5ac98cb9a64211c861ead9fcfe6208f2749032/snet_cli/mpe_channel_command.py#L415-L424
train
pachyderm/python-pachyderm
src/python_pachyderm/pfs_client.py
PfsClient.list_repo
def list_repo(self): """ Returns info about all Repos. """ req = proto.ListRepoRequest() res = self.stub.ListRepo(req, metadata=self.metadata) if hasattr(res, 'repo_info'): return res.repo_info return []
python
def list_repo(self): """ Returns info about all Repos. """ req = proto.ListRepoRequest() res = self.stub.ListRepo(req, metadata=self.metadata) if hasattr(res, 'repo_info'): return res.repo_info return []
[ "def", "list_repo", "(", "self", ")", ":", "req", "=", "proto", ".", "ListRepoRequest", "(", ")", "res", "=", "self", ".", "stub", ".", "ListRepo", "(", "req", ",", "metadata", "=", "self", ".", "metadata", ")", "if", "hasattr", "(", "res", ",", "'...
Returns info about all Repos.
[ "Returns", "info", "about", "all", "Repos", "." ]
1c58cf91d30e03716a4f45213989e890f7b8a78c
https://github.com/pachyderm/python-pachyderm/blob/1c58cf91d30e03716a4f45213989e890f7b8a78c/src/python_pachyderm/pfs_client.py#L71-L79
train
pachyderm/python-pachyderm
src/python_pachyderm/pfs_client.py
PfsClient.delete_repo
def delete_repo(self, repo_name=None, force=False, all=False): """ Deletes a repo and reclaims the storage space it was using. Params: * repo_name: The name of the repo. * force: If set to true, the repo will be removed regardless of errors. This argument should be used ...
python
def delete_repo(self, repo_name=None, force=False, all=False): """ Deletes a repo and reclaims the storage space it was using. Params: * repo_name: The name of the repo. * force: If set to true, the repo will be removed regardless of errors. This argument should be used ...
[ "def", "delete_repo", "(", "self", ",", "repo_name", "=", "None", ",", "force", "=", "False", ",", "all", "=", "False", ")", ":", "if", "not", "all", ":", "if", "repo_name", ":", "req", "=", "proto", ".", "DeleteRepoRequest", "(", "repo", "=", "proto...
Deletes a repo and reclaims the storage space it was using. Params: * repo_name: The name of the repo. * force: If set to true, the repo will be removed regardless of errors. This argument should be used with care. * all: Delete all repos.
[ "Deletes", "a", "repo", "and", "reclaims", "the", "storage", "space", "it", "was", "using", "." ]
1c58cf91d30e03716a4f45213989e890f7b8a78c
https://github.com/pachyderm/python-pachyderm/blob/1c58cf91d30e03716a4f45213989e890f7b8a78c/src/python_pachyderm/pfs_client.py#L81-L102
train
pachyderm/python-pachyderm
src/python_pachyderm/pfs_client.py
PfsClient.start_commit
def start_commit(self, repo_name, branch=None, parent=None, description=None): """ Begins the process of committing data to a Repo. Once started you can write to the Commit with PutFile and when all the data has been written you must finish the Commit with FinishCommit. NOTE, data is ...
python
def start_commit(self, repo_name, branch=None, parent=None, description=None): """ Begins the process of committing data to a Repo. Once started you can write to the Commit with PutFile and when all the data has been written you must finish the Commit with FinishCommit. NOTE, data is ...
[ "def", "start_commit", "(", "self", ",", "repo_name", ",", "branch", "=", "None", ",", "parent", "=", "None", ",", "description", "=", "None", ")", ":", "req", "=", "proto", ".", "StartCommitRequest", "(", "parent", "=", "proto", ".", "Commit", "(", "r...
Begins the process of committing data to a Repo. Once started you can write to the Commit with PutFile and when all the data has been written you must finish the Commit with FinishCommit. NOTE, data is not persisted until FinishCommit is called. A Commit object is returned. Para...
[ "Begins", "the", "process", "of", "committing", "data", "to", "a", "Repo", ".", "Once", "started", "you", "can", "write", "to", "the", "Commit", "with", "PutFile", "and", "when", "all", "the", "data", "has", "been", "written", "you", "must", "finish", "t...
1c58cf91d30e03716a4f45213989e890f7b8a78c
https://github.com/pachyderm/python-pachyderm/blob/1c58cf91d30e03716a4f45213989e890f7b8a78c/src/python_pachyderm/pfs_client.py#L104-L129
train
pachyderm/python-pachyderm
src/python_pachyderm/pfs_client.py
PfsClient.finish_commit
def finish_commit(self, commit): """ Ends the process of committing data to a Repo and persists the Commit. Once a Commit is finished the data becomes immutable and future attempts to write to it with PutFile will error. Params: * commit: A tuple, string, or Commit objec...
python
def finish_commit(self, commit): """ Ends the process of committing data to a Repo and persists the Commit. Once a Commit is finished the data becomes immutable and future attempts to write to it with PutFile will error. Params: * commit: A tuple, string, or Commit objec...
[ "def", "finish_commit", "(", "self", ",", "commit", ")", ":", "req", "=", "proto", ".", "FinishCommitRequest", "(", "commit", "=", "commit_from", "(", "commit", ")", ")", "res", "=", "self", ".", "stub", ".", "FinishCommit", "(", "req", ",", "metadata", ...
Ends the process of committing data to a Repo and persists the Commit. Once a Commit is finished the data becomes immutable and future attempts to write to it with PutFile will error. Params: * commit: A tuple, string, or Commit object representing the commit.
[ "Ends", "the", "process", "of", "committing", "data", "to", "a", "Repo", "and", "persists", "the", "Commit", ".", "Once", "a", "Commit", "is", "finished", "the", "data", "becomes", "immutable", "and", "future", "attempts", "to", "write", "to", "it", "with"...
1c58cf91d30e03716a4f45213989e890f7b8a78c
https://github.com/pachyderm/python-pachyderm/blob/1c58cf91d30e03716a4f45213989e890f7b8a78c/src/python_pachyderm/pfs_client.py#L131-L142
train
pachyderm/python-pachyderm
src/python_pachyderm/pfs_client.py
PfsClient.commit
def commit(self, repo_name, branch=None, parent=None, description=None): """A context manager for doing stuff inside a commit.""" commit = self.start_commit(repo_name, branch, parent, description) try: yield commit except Exception as e: print("An exception occurr...
python
def commit(self, repo_name, branch=None, parent=None, description=None): """A context manager for doing stuff inside a commit.""" commit = self.start_commit(repo_name, branch, parent, description) try: yield commit except Exception as e: print("An exception occurr...
[ "def", "commit", "(", "self", ",", "repo_name", ",", "branch", "=", "None", ",", "parent", "=", "None", ",", "description", "=", "None", ")", ":", "commit", "=", "self", ".", "start_commit", "(", "repo_name", ",", "branch", ",", "parent", ",", "descrip...
A context manager for doing stuff inside a commit.
[ "A", "context", "manager", "for", "doing", "stuff", "inside", "a", "commit", "." ]
1c58cf91d30e03716a4f45213989e890f7b8a78c
https://github.com/pachyderm/python-pachyderm/blob/1c58cf91d30e03716a4f45213989e890f7b8a78c/src/python_pachyderm/pfs_client.py#L145-L155
train
pachyderm/python-pachyderm
src/python_pachyderm/pfs_client.py
PfsClient.inspect_commit
def inspect_commit(self, commit): """ Returns info about a specific Commit. Params: * commit: A tuple, string, or Commit object representing the commit. """ req = proto.InspectCommitRequest(commit=commit_from(commit)) return self.stub.InspectCommit(req, metadata=...
python
def inspect_commit(self, commit): """ Returns info about a specific Commit. Params: * commit: A tuple, string, or Commit object representing the commit. """ req = proto.InspectCommitRequest(commit=commit_from(commit)) return self.stub.InspectCommit(req, metadata=...
[ "def", "inspect_commit", "(", "self", ",", "commit", ")", ":", "req", "=", "proto", ".", "InspectCommitRequest", "(", "commit", "=", "commit_from", "(", "commit", ")", ")", "return", "self", ".", "stub", ".", "InspectCommit", "(", "req", ",", "metadata", ...
Returns info about a specific Commit. Params: * commit: A tuple, string, or Commit object representing the commit.
[ "Returns", "info", "about", "a", "specific", "Commit", "." ]
1c58cf91d30e03716a4f45213989e890f7b8a78c
https://github.com/pachyderm/python-pachyderm/blob/1c58cf91d30e03716a4f45213989e890f7b8a78c/src/python_pachyderm/pfs_client.py#L157-L165
train
pachyderm/python-pachyderm
src/python_pachyderm/pfs_client.py
PfsClient.list_commit
def list_commit(self, repo_name, to_commit=None, from_commit=None, number=0): """ Gets a list of CommitInfo objects. Params: * repo_name: If only `repo_name` is given, all commits in the repo are returned. * to_commit: Optional. Only the ancestors of `to`, including `to`...
python
def list_commit(self, repo_name, to_commit=None, from_commit=None, number=0): """ Gets a list of CommitInfo objects. Params: * repo_name: If only `repo_name` is given, all commits in the repo are returned. * to_commit: Optional. Only the ancestors of `to`, including `to`...
[ "def", "list_commit", "(", "self", ",", "repo_name", ",", "to_commit", "=", "None", ",", "from_commit", "=", "None", ",", "number", "=", "0", ")", ":", "req", "=", "proto", ".", "ListCommitRequest", "(", "repo", "=", "proto", ".", "Repo", "(", "name", ...
Gets a list of CommitInfo objects. Params: * repo_name: If only `repo_name` is given, all commits in the repo are returned. * to_commit: Optional. Only the ancestors of `to`, including `to` itself, are considered. * from_commit: Optional. Only the descendants of `from`, ...
[ "Gets", "a", "list", "of", "CommitInfo", "objects", "." ]
1c58cf91d30e03716a4f45213989e890f7b8a78c
https://github.com/pachyderm/python-pachyderm/blob/1c58cf91d30e03716a4f45213989e890f7b8a78c/src/python_pachyderm/pfs_client.py#L177-L200
train
pachyderm/python-pachyderm
src/python_pachyderm/pfs_client.py
PfsClient.delete_commit
def delete_commit(self, commit): """ Deletes a commit. Params: * commit: A tuple, string, or Commit object representing the commit. """ req = proto.DeleteCommitRequest(commit=commit_from(commit)) self.stub.DeleteCommit(req, metadata=self.metadata)
python
def delete_commit(self, commit): """ Deletes a commit. Params: * commit: A tuple, string, or Commit object representing the commit. """ req = proto.DeleteCommitRequest(commit=commit_from(commit)) self.stub.DeleteCommit(req, metadata=self.metadata)
[ "def", "delete_commit", "(", "self", ",", "commit", ")", ":", "req", "=", "proto", ".", "DeleteCommitRequest", "(", "commit", "=", "commit_from", "(", "commit", ")", ")", "self", ".", "stub", ".", "DeleteCommit", "(", "req", ",", "metadata", "=", "self",...
Deletes a commit. Params: * commit: A tuple, string, or Commit object representing the commit.
[ "Deletes", "a", "commit", "." ]
1c58cf91d30e03716a4f45213989e890f7b8a78c
https://github.com/pachyderm/python-pachyderm/blob/1c58cf91d30e03716a4f45213989e890f7b8a78c/src/python_pachyderm/pfs_client.py#L202-L210
train
pachyderm/python-pachyderm
src/python_pachyderm/pfs_client.py
PfsClient.flush_commit
def flush_commit(self, commits, repos=tuple()): """ Blocks until all of the commits which have a set of commits as provenance have finished. For commits to be considered they must have all of the specified commits as provenance. This in effect waits for all of the jobs that are t...
python
def flush_commit(self, commits, repos=tuple()): """ Blocks until all of the commits which have a set of commits as provenance have finished. For commits to be considered they must have all of the specified commits as provenance. This in effect waits for all of the jobs that are t...
[ "def", "flush_commit", "(", "self", ",", "commits", ",", "repos", "=", "tuple", "(", ")", ")", ":", "req", "=", "proto", ".", "FlushCommitRequest", "(", "commit", "=", "[", "commit_from", "(", "c", ")", "for", "c", "in", "commits", "]", ",", "to_repo...
Blocks until all of the commits which have a set of commits as provenance have finished. For commits to be considered they must have all of the specified commits as provenance. This in effect waits for all of the jobs that are triggered by a set of commits to complete. It returns an erro...
[ "Blocks", "until", "all", "of", "the", "commits", "which", "have", "a", "set", "of", "commits", "as", "provenance", "have", "finished", ".", "For", "commits", "to", "be", "considered", "they", "must", "have", "all", "of", "the", "specified", "commits", "as...
1c58cf91d30e03716a4f45213989e890f7b8a78c
https://github.com/pachyderm/python-pachyderm/blob/1c58cf91d30e03716a4f45213989e890f7b8a78c/src/python_pachyderm/pfs_client.py#L212-L233
train
pachyderm/python-pachyderm
src/python_pachyderm/pfs_client.py
PfsClient.subscribe_commit
def subscribe_commit(self, repo_name, branch, from_commit_id=None): """ SubscribeCommit is like ListCommit but it keeps listening for commits as they come in. This returns an iterator Commit objects. Params: * repo_name: Name of the repo. * branch: Branch to subscribe to...
python
def subscribe_commit(self, repo_name, branch, from_commit_id=None): """ SubscribeCommit is like ListCommit but it keeps listening for commits as they come in. This returns an iterator Commit objects. Params: * repo_name: Name of the repo. * branch: Branch to subscribe to...
[ "def", "subscribe_commit", "(", "self", ",", "repo_name", ",", "branch", ",", "from_commit_id", "=", "None", ")", ":", "repo", "=", "proto", ".", "Repo", "(", "name", "=", "repo_name", ")", "req", "=", "proto", ".", "SubscribeCommitRequest", "(", "repo", ...
SubscribeCommit is like ListCommit but it keeps listening for commits as they come in. This returns an iterator Commit objects. Params: * repo_name: Name of the repo. * branch: Branch to subscribe to. * from_commit_id: Optional. Only commits created since this commit are...
[ "SubscribeCommit", "is", "like", "ListCommit", "but", "it", "keeps", "listening", "for", "commits", "as", "they", "come", "in", ".", "This", "returns", "an", "iterator", "Commit", "objects", "." ]
1c58cf91d30e03716a4f45213989e890f7b8a78c
https://github.com/pachyderm/python-pachyderm/blob/1c58cf91d30e03716a4f45213989e890f7b8a78c/src/python_pachyderm/pfs_client.py#L235-L251
train
pachyderm/python-pachyderm
src/python_pachyderm/pfs_client.py
PfsClient.list_branch
def list_branch(self, repo_name): """ Lists the active Branch objects on a Repo. Params: * repo_name: The name of the repo. """ req = proto.ListBranchRequest(repo=proto.Repo(name=repo_name)) res = self.stub.ListBranch(req, metadata=self.metadata) if hasat...
python
def list_branch(self, repo_name): """ Lists the active Branch objects on a Repo. Params: * repo_name: The name of the repo. """ req = proto.ListBranchRequest(repo=proto.Repo(name=repo_name)) res = self.stub.ListBranch(req, metadata=self.metadata) if hasat...
[ "def", "list_branch", "(", "self", ",", "repo_name", ")", ":", "req", "=", "proto", ".", "ListBranchRequest", "(", "repo", "=", "proto", ".", "Repo", "(", "name", "=", "repo_name", ")", ")", "res", "=", "self", ".", "stub", ".", "ListBranch", "(", "r...
Lists the active Branch objects on a Repo. Params: * repo_name: The name of the repo.
[ "Lists", "the", "active", "Branch", "objects", "on", "a", "Repo", "." ]
1c58cf91d30e03716a4f45213989e890f7b8a78c
https://github.com/pachyderm/python-pachyderm/blob/1c58cf91d30e03716a4f45213989e890f7b8a78c/src/python_pachyderm/pfs_client.py#L253-L264
train
pachyderm/python-pachyderm
src/python_pachyderm/pfs_client.py
PfsClient.set_branch
def set_branch(self, commit, branch_name): """ Sets a commit and its ancestors as a branch. Params: * commit: A tuple, string, or Commit object representing the commit. * branch_name: The name for the branch to set. """ res = proto.SetBranchRequest(commit=commit_...
python
def set_branch(self, commit, branch_name): """ Sets a commit and its ancestors as a branch. Params: * commit: A tuple, string, or Commit object representing the commit. * branch_name: The name for the branch to set. """ res = proto.SetBranchRequest(commit=commit_...
[ "def", "set_branch", "(", "self", ",", "commit", ",", "branch_name", ")", ":", "res", "=", "proto", ".", "SetBranchRequest", "(", "commit", "=", "commit_from", "(", "commit", ")", ",", "branch", "=", "branch_name", ")", "self", ".", "stub", ".", "SetBran...
Sets a commit and its ancestors as a branch. Params: * commit: A tuple, string, or Commit object representing the commit. * branch_name: The name for the branch to set.
[ "Sets", "a", "commit", "and", "its", "ancestors", "as", "a", "branch", "." ]
1c58cf91d30e03716a4f45213989e890f7b8a78c
https://github.com/pachyderm/python-pachyderm/blob/1c58cf91d30e03716a4f45213989e890f7b8a78c/src/python_pachyderm/pfs_client.py#L266-L275
train
pachyderm/python-pachyderm
src/python_pachyderm/pfs_client.py
PfsClient.delete_branch
def delete_branch(self, repo_name, branch_name): """ Deletes a branch, but leaves the commits themselves intact. In other words, those commits can still be accessed via commit IDs and other branches they happen to be on. Params: * repo_name: The name of the repo. ...
python
def delete_branch(self, repo_name, branch_name): """ Deletes a branch, but leaves the commits themselves intact. In other words, those commits can still be accessed via commit IDs and other branches they happen to be on. Params: * repo_name: The name of the repo. ...
[ "def", "delete_branch", "(", "self", ",", "repo_name", ",", "branch_name", ")", ":", "res", "=", "proto", ".", "DeleteBranchRequest", "(", "repo", "=", "Repo", "(", "name", "=", "repo_name", ")", ",", "branch", "=", "branch_name", ")", "self", ".", "stub...
Deletes a branch, but leaves the commits themselves intact. In other words, those commits can still be accessed via commit IDs and other branches they happen to be on. Params: * repo_name: The name of the repo. * branch_name: The name of the branch to delete.
[ "Deletes", "a", "branch", "but", "leaves", "the", "commits", "themselves", "intact", ".", "In", "other", "words", "those", "commits", "can", "still", "be", "accessed", "via", "commit", "IDs", "and", "other", "branches", "they", "happen", "to", "be", "on", ...
1c58cf91d30e03716a4f45213989e890f7b8a78c
https://github.com/pachyderm/python-pachyderm/blob/1c58cf91d30e03716a4f45213989e890f7b8a78c/src/python_pachyderm/pfs_client.py#L277-L288
train
pachyderm/python-pachyderm
src/python_pachyderm/pfs_client.py
PfsClient.put_file_url
def put_file_url(self, commit, path, url, recursive=False): """ Puts a file using the content found at a URL. The URL is sent to the server which performs the request. Params: * commit: A tuple, string, or Commit object representing the commit. * path: The path to the fi...
python
def put_file_url(self, commit, path, url, recursive=False): """ Puts a file using the content found at a URL. The URL is sent to the server which performs the request. Params: * commit: A tuple, string, or Commit object representing the commit. * path: The path to the fi...
[ "def", "put_file_url", "(", "self", ",", "commit", ",", "path", ",", "url", ",", "recursive", "=", "False", ")", ":", "req", "=", "iter", "(", "[", "proto", ".", "PutFileRequest", "(", "file", "=", "proto", ".", "File", "(", "commit", "=", "commit_fr...
Puts a file using the content found at a URL. The URL is sent to the server which performs the request. Params: * commit: A tuple, string, or Commit object representing the commit. * path: The path to the file. * url: The url of the file to put. * recursive: allow for re...
[ "Puts", "a", "file", "using", "the", "content", "found", "at", "a", "URL", ".", "The", "URL", "is", "sent", "to", "the", "server", "which", "performs", "the", "request", "." ]
1c58cf91d30e03716a4f45213989e890f7b8a78c
https://github.com/pachyderm/python-pachyderm/blob/1c58cf91d30e03716a4f45213989e890f7b8a78c/src/python_pachyderm/pfs_client.py#L363-L382
train
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): """ 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. ...
[ "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
train
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): """ 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....
[ "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
train
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): """ 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...
[ "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
train
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): """ 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. ...
[ "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
train
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): """ 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...
[ "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
train
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): """ 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 ...
[ "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
train
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): """ 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...
[ "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
train
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): """ 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...
[ "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
train
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): """ 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] ...
[ "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
train
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): """ 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 ...
[ "def", "_build_idp_config_endpoints", "(", "self", ",", "config", ",", "providers", ")", ":", "idp_endpoints", "=", "[", "]", "for", "endp_category", "in", "self", ".", "endpoints", ":", "for", "func", ",", "endpoint", "in", "self", ".", "endpoints", "[", ...
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
train
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): """ 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...
[ "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
train
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): """ 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...
[ "def", "_load_idp_dynamic_entity_id", "(", "self", ",", "state", ")", ":", "idp_config_file", "=", "copy", ".", "deepcopy", "(", "self", ".", "idp_config", ")", "idp_config_file", "[", "\"entityid\"", "]", "=", "\"{}/{}\"", ".", "format", "(", "self", ".", "...
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
train
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): """ 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...
[ "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
train
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): """ 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 ...
[ "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
train
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): """ 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...
[ "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
train
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): """ 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...
[ "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
train
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): """ 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 ...
[ "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
train
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): """ 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]...
[ "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
train
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): """ 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...
[ "def", "_create_co_virtual_idp", "(", "self", ",", "context", ")", ":", "co_name", "=", "self", ".", "_get_co_name", "(", "context", ")", "context", ".", "decorate", "(", "self", ".", "KEY_CO_NAME", ",", "co_name", ")", "co_names", "=", "self", ".", "_co_n...
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
train
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): """ 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...
[ "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
train
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): """ 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...
[ "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
train
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): """ 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 --...
[ "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
train
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 sensitive details like passwords from a configuration dictionary. """ filter_fields_default = [ 'bind_password', 'connection' ] filter_fields = fields or filter_fields_default ...
[ "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
train
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): """ 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: ...
[ "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
train
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): """ 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"]: ...
[ "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
train
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): """ 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 ...
[ "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
train
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): """ 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...
[ "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
train
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): """ 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: ...
[ "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
train
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): """ 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/...) ...
[ "def", "satosa_logging", "(", "logger", ",", "level", ",", "message", ",", "state", ",", "**", "kwargs", ")", ":", "if", "state", "is", "None", ":", "session_id", "=", "\"UNKNOWN\"", "else", ":", "try", ":", "session_id", "=", "state", "[", "LOGGER_STATE...
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
train
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): """ 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...
[ "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
train
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): """ 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_...
[ "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
train
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): """ 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 """ ...
[ "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
train
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): """ 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 ...
[ "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
train
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): """ 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 ...
[ "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
train
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): """ 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 ...
[ "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
train
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): """ 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...
[ "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
train
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): """ 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...
[ "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
train
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): """ 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...
[ "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
train
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): """ 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")
[ "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
train
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): """ 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...
[ "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
train
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): """ 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
[ "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
train
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): """ 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...
[ "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
train
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): """ 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...
[ "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
train
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): """ 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...
[ "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
train
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): """ 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...
[ "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
train
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): """ 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...
[ "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
train
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): """ 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...
[ "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
train
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): """ 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...
[ "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
train
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): """ 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]]] :...
[ "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
train
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): """ Generates SAML metadata for the given PROXY_CONF, signed with the given KEY and associated CERT. """ satosa_config = SATOSAConfig(pro...
[ "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
train
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): """ 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...
[ "def", "_handle_al_response", "(", "self", ",", "context", ")", ":", "saved_state", "=", "context", ".", "state", "[", "self", ".", "name", "]", "internal_response", "=", "InternalData", ".", "from_dict", "(", "saved_state", ")", "status_code", ",", "message",...
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
train
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): """ 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: ...
[ "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
train
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): """ 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...
[ "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
train
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): """ 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...
[ "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
train
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): """ 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...
[ "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
train
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): """ 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...
[ "def", "_auth_req_callback_func", "(", "self", ",", "context", ",", "internal_request", ")", ":", "state", "=", "context", ".", "state", "state", "[", "STATE_KEY", "]", "=", "{", "\"requester\"", ":", "internal_request", ".", "requester", "}", "try", ":", "s...
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
train
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): """ 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...
[ "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
train
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): """ 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...
[ "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
train
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): """ 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...
[ "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
train
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): """ 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...
[ "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
train
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): """ 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) ...
[ "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
train
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): """ 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 ...
[ "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
train