id int32 0 252k | repo stringlengths 7 55 | path stringlengths 4 127 | func_name stringlengths 1 88 | original_string stringlengths 75 19.8k | language stringclasses 1
value | code stringlengths 75 19.8k | code_tokens list | docstring stringlengths 3 17.3k | docstring_tokens list | sha stringlengths 40 40 | url stringlengths 87 242 |
|---|---|---|---|---|---|---|---|---|---|---|---|
227,200 | SALib/SALib | src/SALib/sample/ff.py | cli_action | def cli_action(args):
"""Run sampling method
Parameters
----------
args : argparse namespace
"""
problem = read_param_file(args.paramfile)
param_values = sample(problem, seed=args.seed)
np.savetxt(args.output, param_values, delimiter=args.delimiter,
fmt='%.' + str(args.pr... | python | def cli_action(args):
"""Run sampling method
Parameters
----------
args : argparse namespace
"""
problem = read_param_file(args.paramfile)
param_values = sample(problem, seed=args.seed)
np.savetxt(args.output, param_values, delimiter=args.delimiter,
fmt='%.' + str(args.pr... | [
"def",
"cli_action",
"(",
"args",
")",
":",
"problem",
"=",
"read_param_file",
"(",
"args",
".",
"paramfile",
")",
"param_values",
"=",
"sample",
"(",
"problem",
",",
"seed",
"=",
"args",
".",
"seed",
")",
"np",
".",
"savetxt",
"(",
"args",
".",
"outpu... | Run sampling method
Parameters
----------
args : argparse namespace | [
"Run",
"sampling",
"method"
] | 9744d73bb17cfcffc8282c7dc4a727efdc4bea3f | https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/ff.py#L135-L145 |
227,201 | SALib/SALib | src/SALib/sample/common_args.py | setup | def setup(parser):
"""Add common sampling options to CLI parser.
Parameters
----------
parser : argparse object
Returns
----------
Updated argparse object
"""
parser.add_argument(
'-p', '--paramfile', type=str, required=True,
help='Parameter Range File')
parser.... | python | def setup(parser):
"""Add common sampling options to CLI parser.
Parameters
----------
parser : argparse object
Returns
----------
Updated argparse object
"""
parser.add_argument(
'-p', '--paramfile', type=str, required=True,
help='Parameter Range File')
parser.... | [
"def",
"setup",
"(",
"parser",
")",
":",
"parser",
".",
"add_argument",
"(",
"'-p'",
",",
"'--paramfile'",
",",
"type",
"=",
"str",
",",
"required",
"=",
"True",
",",
"help",
"=",
"'Parameter Range File'",
")",
"parser",
".",
"add_argument",
"(",
"'-o'",
... | Add common sampling options to CLI parser.
Parameters
----------
parser : argparse object
Returns
----------
Updated argparse object | [
"Add",
"common",
"sampling",
"options",
"to",
"CLI",
"parser",
"."
] | 9744d73bb17cfcffc8282c7dc4a727efdc4bea3f | https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/common_args.py#L4-L29 |
227,202 | SALib/SALib | src/SALib/sample/common_args.py | run_cli | def run_cli(cli_parser, run_sample, known_args=None):
"""Run sampling with CLI arguments.
Parameters
----------
cli_parser : function
Function to add method specific arguments to parser
run_sample: function
Method specific function that runs the sampling
known_args: list [option... | python | def run_cli(cli_parser, run_sample, known_args=None):
"""Run sampling with CLI arguments.
Parameters
----------
cli_parser : function
Function to add method specific arguments to parser
run_sample: function
Method specific function that runs the sampling
known_args: list [option... | [
"def",
"run_cli",
"(",
"cli_parser",
",",
"run_sample",
",",
"known_args",
"=",
"None",
")",
":",
"parser",
"=",
"create",
"(",
"cli_parser",
")",
"args",
"=",
"parser",
".",
"parse_args",
"(",
"known_args",
")",
"run_sample",
"(",
"args",
")"
] | Run sampling with CLI arguments.
Parameters
----------
cli_parser : function
Function to add method specific arguments to parser
run_sample: function
Method specific function that runs the sampling
known_args: list [optional]
Additional arguments to parse
Returns
--... | [
"Run",
"sampling",
"with",
"CLI",
"arguments",
"."
] | 9744d73bb17cfcffc8282c7dc4a727efdc4bea3f | https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/common_args.py#L54-L73 |
227,203 | SALib/SALib | src/SALib/sample/morris/strategy.py | Strategy.run_checks | def run_checks(number_samples, k_choices):
"""Runs checks on `k_choices`
"""
assert isinstance(k_choices, int), \
"Number of optimal trajectories should be an integer"
if k_choices < 2:
raise ValueError(
"The number of optimal trajectories must be... | python | def run_checks(number_samples, k_choices):
"""Runs checks on `k_choices`
"""
assert isinstance(k_choices, int), \
"Number of optimal trajectories should be an integer"
if k_choices < 2:
raise ValueError(
"The number of optimal trajectories must be... | [
"def",
"run_checks",
"(",
"number_samples",
",",
"k_choices",
")",
":",
"assert",
"isinstance",
"(",
"k_choices",
",",
"int",
")",
",",
"\"Number of optimal trajectories should be an integer\"",
"if",
"k_choices",
"<",
"2",
":",
"raise",
"ValueError",
"(",
"\"The nu... | Runs checks on `k_choices` | [
"Runs",
"checks",
"on",
"k_choices"
] | 9744d73bb17cfcffc8282c7dc4a727efdc4bea3f | https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/morris/strategy.py#L123-L135 |
227,204 | SALib/SALib | src/SALib/sample/morris/strategy.py | Strategy._make_index_list | def _make_index_list(num_samples, num_params, num_groups=None):
"""Identify indices of input sample associated with each trajectory
For each trajectory, identifies the indexes of the input sample which
is a function of the number of factors/groups and the number of samples
Arguments
... | python | def _make_index_list(num_samples, num_params, num_groups=None):
"""Identify indices of input sample associated with each trajectory
For each trajectory, identifies the indexes of the input sample which
is a function of the number of factors/groups and the number of samples
Arguments
... | [
"def",
"_make_index_list",
"(",
"num_samples",
",",
"num_params",
",",
"num_groups",
"=",
"None",
")",
":",
"if",
"num_groups",
"is",
"None",
":",
"num_groups",
"=",
"num_params",
"index_list",
"=",
"[",
"]",
"for",
"j",
"in",
"range",
"(",
"num_samples",
... | Identify indices of input sample associated with each trajectory
For each trajectory, identifies the indexes of the input sample which
is a function of the number of factors/groups and the number of samples
Arguments
---------
num_samples : int
The number of traject... | [
"Identify",
"indices",
"of",
"input",
"sample",
"associated",
"with",
"each",
"trajectory"
] | 9744d73bb17cfcffc8282c7dc4a727efdc4bea3f | https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/morris/strategy.py#L138-L170 |
227,205 | SALib/SALib | src/SALib/sample/morris/strategy.py | Strategy.compile_output | def compile_output(self, input_sample, num_samples, num_params,
maximum_combo, num_groups=None):
"""Picks the trajectories from the input
Arguments
---------
input_sample : numpy.ndarray
num_samples : int
num_params : int
maximum_combo : li... | python | def compile_output(self, input_sample, num_samples, num_params,
maximum_combo, num_groups=None):
"""Picks the trajectories from the input
Arguments
---------
input_sample : numpy.ndarray
num_samples : int
num_params : int
maximum_combo : li... | [
"def",
"compile_output",
"(",
"self",
",",
"input_sample",
",",
"num_samples",
",",
"num_params",
",",
"maximum_combo",
",",
"num_groups",
"=",
"None",
")",
":",
"if",
"num_groups",
"is",
"None",
":",
"num_groups",
"=",
"num_params",
"self",
".",
"check_input_... | Picks the trajectories from the input
Arguments
---------
input_sample : numpy.ndarray
num_samples : int
num_params : int
maximum_combo : list
num_groups : int | [
"Picks",
"the",
"trajectories",
"from",
"the",
"input"
] | 9744d73bb17cfcffc8282c7dc4a727efdc4bea3f | https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/morris/strategy.py#L172-L198 |
227,206 | SALib/SALib | src/SALib/sample/morris/strategy.py | Strategy.check_input_sample | def check_input_sample(input_sample, num_params, num_samples):
"""Check the `input_sample` is valid
Checks input sample is:
- the correct size
- values between 0 and 1
Arguments
---------
input_sample : numpy.ndarray
num_params : int
num_... | python | def check_input_sample(input_sample, num_params, num_samples):
"""Check the `input_sample` is valid
Checks input sample is:
- the correct size
- values between 0 and 1
Arguments
---------
input_sample : numpy.ndarray
num_params : int
num_... | [
"def",
"check_input_sample",
"(",
"input_sample",
",",
"num_params",
",",
"num_samples",
")",
":",
"assert",
"type",
"(",
"input_sample",
")",
"==",
"np",
".",
"ndarray",
",",
"\"Input sample is not an numpy array\"",
"assert",
"input_sample",
".",
"shape",
"[",
"... | Check the `input_sample` is valid
Checks input sample is:
- the correct size
- values between 0 and 1
Arguments
---------
input_sample : numpy.ndarray
num_params : int
num_samples : int | [
"Check",
"the",
"input_sample",
"is",
"valid"
] | 9744d73bb17cfcffc8282c7dc4a727efdc4bea3f | https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/morris/strategy.py#L201-L219 |
227,207 | SALib/SALib | src/SALib/sample/morris/strategy.py | Strategy.compute_distance | def compute_distance(m, l):
'''Compute distance between two trajectories
Returns
-------
numpy.ndarray
'''
if np.shape(m) != np.shape(l):
raise ValueError("Input matrices are different sizes")
if np.array_equal(m, l):
# print("Trajectory ... | python | def compute_distance(m, l):
'''Compute distance between two trajectories
Returns
-------
numpy.ndarray
'''
if np.shape(m) != np.shape(l):
raise ValueError("Input matrices are different sizes")
if np.array_equal(m, l):
# print("Trajectory ... | [
"def",
"compute_distance",
"(",
"m",
",",
"l",
")",
":",
"if",
"np",
".",
"shape",
"(",
"m",
")",
"!=",
"np",
".",
"shape",
"(",
"l",
")",
":",
"raise",
"ValueError",
"(",
"\"Input matrices are different sizes\"",
")",
"if",
"np",
".",
"array_equal",
"... | Compute distance between two trajectories
Returns
-------
numpy.ndarray | [
"Compute",
"distance",
"between",
"two",
"trajectories"
] | 9744d73bb17cfcffc8282c7dc4a727efdc4bea3f | https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/morris/strategy.py#L222-L238 |
227,208 | SALib/SALib | src/SALib/sample/morris/strategy.py | Strategy.compute_distance_matrix | def compute_distance_matrix(self, input_sample, num_samples, num_params,
num_groups=None,
local_optimization=False):
"""Computes the distance between each and every trajectory
Each entry in the matrix represents the sum of the geometric di... | python | def compute_distance_matrix(self, input_sample, num_samples, num_params,
num_groups=None,
local_optimization=False):
"""Computes the distance between each and every trajectory
Each entry in the matrix represents the sum of the geometric di... | [
"def",
"compute_distance_matrix",
"(",
"self",
",",
"input_sample",
",",
"num_samples",
",",
"num_params",
",",
"num_groups",
"=",
"None",
",",
"local_optimization",
"=",
"False",
")",
":",
"if",
"num_groups",
":",
"self",
".",
"check_input_sample",
"(",
"input_... | Computes the distance between each and every trajectory
Each entry in the matrix represents the sum of the geometric distances
between all the pairs of points of the two trajectories
If the `groups` argument is filled, then the distances are still
calculated for each trajectory,
... | [
"Computes",
"the",
"distance",
"between",
"each",
"and",
"every",
"trajectory"
] | 9744d73bb17cfcffc8282c7dc4a727efdc4bea3f | https://github.com/SALib/SALib/blob/9744d73bb17cfcffc8282c7dc4a727efdc4bea3f/src/SALib/sample/morris/strategy.py#L240-L290 |
227,209 | nicodv/kmodes | kmodes/kmodes.py | move_point_cat | def move_point_cat(point, ipoint, to_clust, from_clust, cl_attr_freq,
membship, centroids):
"""Move point between clusters, categorical attributes."""
membship[to_clust, ipoint] = 1
membship[from_clust, ipoint] = 0
# Update frequencies of attributes in cluster.
for iattr, curattr ... | python | def move_point_cat(point, ipoint, to_clust, from_clust, cl_attr_freq,
membship, centroids):
"""Move point between clusters, categorical attributes."""
membship[to_clust, ipoint] = 1
membship[from_clust, ipoint] = 0
# Update frequencies of attributes in cluster.
for iattr, curattr ... | [
"def",
"move_point_cat",
"(",
"point",
",",
"ipoint",
",",
"to_clust",
",",
"from_clust",
",",
"cl_attr_freq",
",",
"membship",
",",
"centroids",
")",
":",
"membship",
"[",
"to_clust",
",",
"ipoint",
"]",
"=",
"1",
"membship",
"[",
"from_clust",
",",
"ipoi... | Move point between clusters, categorical attributes. | [
"Move",
"point",
"between",
"clusters",
"categorical",
"attributes",
"."
] | cdb19fe5448aba1bf501626694bb52e68eafab45 | https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/kmodes.py#L83-L112 |
227,210 | nicodv/kmodes | kmodes/kmodes.py | _labels_cost | def _labels_cost(X, centroids, dissim, membship=None):
"""Calculate labels and cost function given a matrix of points and
a list of centroids for the k-modes algorithm.
"""
X = check_array(X)
n_points = X.shape[0]
cost = 0.
labels = np.empty(n_points, dtype=np.uint16)
for ipoint, curpo... | python | def _labels_cost(X, centroids, dissim, membship=None):
"""Calculate labels and cost function given a matrix of points and
a list of centroids for the k-modes algorithm.
"""
X = check_array(X)
n_points = X.shape[0]
cost = 0.
labels = np.empty(n_points, dtype=np.uint16)
for ipoint, curpo... | [
"def",
"_labels_cost",
"(",
"X",
",",
"centroids",
",",
"dissim",
",",
"membship",
"=",
"None",
")",
":",
"X",
"=",
"check_array",
"(",
"X",
")",
"n_points",
"=",
"X",
".",
"shape",
"[",
"0",
"]",
"cost",
"=",
"0.",
"labels",
"=",
"np",
".",
"emp... | Calculate labels and cost function given a matrix of points and
a list of centroids for the k-modes algorithm. | [
"Calculate",
"labels",
"and",
"cost",
"function",
"given",
"a",
"matrix",
"of",
"points",
"and",
"a",
"list",
"of",
"centroids",
"for",
"the",
"k",
"-",
"modes",
"algorithm",
"."
] | cdb19fe5448aba1bf501626694bb52e68eafab45 | https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/kmodes.py#L115-L131 |
227,211 | nicodv/kmodes | kmodes/kmodes.py | _k_modes_iter | def _k_modes_iter(X, centroids, cl_attr_freq, membship, dissim, random_state):
"""Single iteration of k-modes clustering algorithm"""
moves = 0
for ipoint, curpoint in enumerate(X):
clust = np.argmin(dissim(centroids, curpoint, X=X, membship=membship))
if membship[clust, ipoint]:
... | python | def _k_modes_iter(X, centroids, cl_attr_freq, membship, dissim, random_state):
"""Single iteration of k-modes clustering algorithm"""
moves = 0
for ipoint, curpoint in enumerate(X):
clust = np.argmin(dissim(centroids, curpoint, X=X, membship=membship))
if membship[clust, ipoint]:
... | [
"def",
"_k_modes_iter",
"(",
"X",
",",
"centroids",
",",
"cl_attr_freq",
",",
"membship",
",",
"dissim",
",",
"random_state",
")",
":",
"moves",
"=",
"0",
"for",
"ipoint",
",",
"curpoint",
"in",
"enumerate",
"(",
"X",
")",
":",
"clust",
"=",
"np",
".",... | Single iteration of k-modes clustering algorithm | [
"Single",
"iteration",
"of",
"k",
"-",
"modes",
"clustering",
"algorithm"
] | cdb19fe5448aba1bf501626694bb52e68eafab45 | https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/kmodes.py#L134-L162 |
227,212 | nicodv/kmodes | kmodes/kmodes.py | k_modes | def k_modes(X, n_clusters, max_iter, dissim, init, n_init, verbose, random_state, n_jobs):
"""k-modes algorithm"""
random_state = check_random_state(random_state)
if sparse.issparse(X):
raise TypeError("k-modes does not support sparse data.")
X = check_array(X, dtype=None)
# Convert the ca... | python | def k_modes(X, n_clusters, max_iter, dissim, init, n_init, verbose, random_state, n_jobs):
"""k-modes algorithm"""
random_state = check_random_state(random_state)
if sparse.issparse(X):
raise TypeError("k-modes does not support sparse data.")
X = check_array(X, dtype=None)
# Convert the ca... | [
"def",
"k_modes",
"(",
"X",
",",
"n_clusters",
",",
"max_iter",
",",
"dissim",
",",
"init",
",",
"n_init",
",",
"verbose",
",",
"random_state",
",",
"n_jobs",
")",
":",
"random_state",
"=",
"check_random_state",
"(",
"random_state",
")",
"if",
"sparse",
".... | k-modes algorithm | [
"k",
"-",
"modes",
"algorithm"
] | cdb19fe5448aba1bf501626694bb52e68eafab45 | https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/kmodes.py#L243-L287 |
227,213 | nicodv/kmodes | kmodes/kmodes.py | KModes.fit | def fit(self, X, y=None, **kwargs):
"""Compute k-modes clustering.
Parameters
----------
X : array-like, shape=[n_samples, n_features]
"""
X = pandas_to_numpy(X)
random_state = check_random_state(self.random_state)
self._enc_cluster_centroids, self._enc_... | python | def fit(self, X, y=None, **kwargs):
"""Compute k-modes clustering.
Parameters
----------
X : array-like, shape=[n_samples, n_features]
"""
X = pandas_to_numpy(X)
random_state = check_random_state(self.random_state)
self._enc_cluster_centroids, self._enc_... | [
"def",
"fit",
"(",
"self",
",",
"X",
",",
"y",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"X",
"=",
"pandas_to_numpy",
"(",
"X",
")",
"random_state",
"=",
"check_random_state",
"(",
"self",
".",
"random_state",
")",
"self",
".",
"_enc_cluster_cent... | Compute k-modes clustering.
Parameters
----------
X : array-like, shape=[n_samples, n_features] | [
"Compute",
"k",
"-",
"modes",
"clustering",
"."
] | cdb19fe5448aba1bf501626694bb52e68eafab45 | https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/kmodes.py#L381-L401 |
227,214 | nicodv/kmodes | kmodes/kmodes.py | KModes.fit_predict | def fit_predict(self, X, y=None, **kwargs):
"""Compute cluster centroids and predict cluster index for each sample.
Convenience method; equivalent to calling fit(X) followed by
predict(X).
"""
return self.fit(X, **kwargs).predict(X, **kwargs) | python | def fit_predict(self, X, y=None, **kwargs):
"""Compute cluster centroids and predict cluster index for each sample.
Convenience method; equivalent to calling fit(X) followed by
predict(X).
"""
return self.fit(X, **kwargs).predict(X, **kwargs) | [
"def",
"fit_predict",
"(",
"self",
",",
"X",
",",
"y",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"return",
"self",
".",
"fit",
"(",
"X",
",",
"*",
"*",
"kwargs",
")",
".",
"predict",
"(",
"X",
",",
"*",
"*",
"kwargs",
")"
] | Compute cluster centroids and predict cluster index for each sample.
Convenience method; equivalent to calling fit(X) followed by
predict(X). | [
"Compute",
"cluster",
"centroids",
"and",
"predict",
"cluster",
"index",
"for",
"each",
"sample",
"."
] | cdb19fe5448aba1bf501626694bb52e68eafab45 | https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/kmodes.py#L403-L409 |
227,215 | nicodv/kmodes | kmodes/util/__init__.py | get_max_value_key | def get_max_value_key(dic):
"""Gets the key for the maximum value in a dict."""
v = np.array(list(dic.values()))
k = np.array(list(dic.keys()))
maxima = np.where(v == np.max(v))[0]
if len(maxima) == 1:
return k[maxima[0]]
else:
# In order to be consistent, always selects the min... | python | def get_max_value_key(dic):
"""Gets the key for the maximum value in a dict."""
v = np.array(list(dic.values()))
k = np.array(list(dic.keys()))
maxima = np.where(v == np.max(v))[0]
if len(maxima) == 1:
return k[maxima[0]]
else:
# In order to be consistent, always selects the min... | [
"def",
"get_max_value_key",
"(",
"dic",
")",
":",
"v",
"=",
"np",
".",
"array",
"(",
"list",
"(",
"dic",
".",
"values",
"(",
")",
")",
")",
"k",
"=",
"np",
".",
"array",
"(",
"list",
"(",
"dic",
".",
"keys",
"(",
")",
")",
")",
"maxima",
"=",... | Gets the key for the maximum value in a dict. | [
"Gets",
"the",
"key",
"for",
"the",
"maximum",
"value",
"in",
"a",
"dict",
"."
] | cdb19fe5448aba1bf501626694bb52e68eafab45 | https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/util/__init__.py#L12-L23 |
227,216 | nicodv/kmodes | kmodes/util/__init__.py | decode_centroids | def decode_centroids(encoded, mapping):
"""Decodes the encoded centroids array back to the original data
labels using a list of mappings.
"""
decoded = []
for ii in range(encoded.shape[1]):
# Invert the mapping so that we can decode.
inv_mapping = {v: k for k, v in mapping[ii].items(... | python | def decode_centroids(encoded, mapping):
"""Decodes the encoded centroids array back to the original data
labels using a list of mappings.
"""
decoded = []
for ii in range(encoded.shape[1]):
# Invert the mapping so that we can decode.
inv_mapping = {v: k for k, v in mapping[ii].items(... | [
"def",
"decode_centroids",
"(",
"encoded",
",",
"mapping",
")",
":",
"decoded",
"=",
"[",
"]",
"for",
"ii",
"in",
"range",
"(",
"encoded",
".",
"shape",
"[",
"1",
"]",
")",
":",
"# Invert the mapping so that we can decode.",
"inv_mapping",
"=",
"{",
"v",
"... | Decodes the encoded centroids array back to the original data
labels using a list of mappings. | [
"Decodes",
"the",
"encoded",
"centroids",
"array",
"back",
"to",
"the",
"original",
"data",
"labels",
"using",
"a",
"list",
"of",
"mappings",
"."
] | cdb19fe5448aba1bf501626694bb52e68eafab45 | https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/util/__init__.py#L54-L63 |
227,217 | nicodv/kmodes | kmodes/kprototypes.py | move_point_num | def move_point_num(point, to_clust, from_clust, cl_attr_sum, cl_memb_sum):
"""Move point between clusters, numerical attributes."""
# Update sum of attributes in cluster.
for iattr, curattr in enumerate(point):
cl_attr_sum[to_clust][iattr] += curattr
cl_attr_sum[from_clust][iattr] -= curattr... | python | def move_point_num(point, to_clust, from_clust, cl_attr_sum, cl_memb_sum):
"""Move point between clusters, numerical attributes."""
# Update sum of attributes in cluster.
for iattr, curattr in enumerate(point):
cl_attr_sum[to_clust][iattr] += curattr
cl_attr_sum[from_clust][iattr] -= curattr... | [
"def",
"move_point_num",
"(",
"point",
",",
"to_clust",
",",
"from_clust",
",",
"cl_attr_sum",
",",
"cl_memb_sum",
")",
":",
"# Update sum of attributes in cluster.",
"for",
"iattr",
",",
"curattr",
"in",
"enumerate",
"(",
"point",
")",
":",
"cl_attr_sum",
"[",
... | Move point between clusters, numerical attributes. | [
"Move",
"point",
"between",
"clusters",
"numerical",
"attributes",
"."
] | cdb19fe5448aba1bf501626694bb52e68eafab45 | https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/kprototypes.py#L28-L37 |
227,218 | nicodv/kmodes | kmodes/kprototypes.py | _split_num_cat | def _split_num_cat(X, categorical):
"""Extract numerical and categorical columns.
Convert to numpy arrays, if needed.
:param X: Feature matrix
:param categorical: Indices of categorical columns
"""
Xnum = np.asanyarray(X[:, [ii for ii in range(X.shape[1])
if ii no... | python | def _split_num_cat(X, categorical):
"""Extract numerical and categorical columns.
Convert to numpy arrays, if needed.
:param X: Feature matrix
:param categorical: Indices of categorical columns
"""
Xnum = np.asanyarray(X[:, [ii for ii in range(X.shape[1])
if ii no... | [
"def",
"_split_num_cat",
"(",
"X",
",",
"categorical",
")",
":",
"Xnum",
"=",
"np",
".",
"asanyarray",
"(",
"X",
"[",
":",
",",
"[",
"ii",
"for",
"ii",
"in",
"range",
"(",
"X",
".",
"shape",
"[",
"1",
"]",
")",
"if",
"ii",
"not",
"in",
"categor... | Extract numerical and categorical columns.
Convert to numpy arrays, if needed.
:param X: Feature matrix
:param categorical: Indices of categorical columns | [
"Extract",
"numerical",
"and",
"categorical",
"columns",
".",
"Convert",
"to",
"numpy",
"arrays",
"if",
"needed",
"."
] | cdb19fe5448aba1bf501626694bb52e68eafab45 | https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/kprototypes.py#L40-L50 |
227,219 | nicodv/kmodes | kmodes/kprototypes.py | _labels_cost | def _labels_cost(Xnum, Xcat, centroids, num_dissim, cat_dissim, gamma, membship=None):
"""Calculate labels and cost function given a matrix of points and
a list of centroids for the k-prototypes algorithm.
"""
n_points = Xnum.shape[0]
Xnum = check_array(Xnum)
cost = 0.
labels = np.empty(n_... | python | def _labels_cost(Xnum, Xcat, centroids, num_dissim, cat_dissim, gamma, membship=None):
"""Calculate labels and cost function given a matrix of points and
a list of centroids for the k-prototypes algorithm.
"""
n_points = Xnum.shape[0]
Xnum = check_array(Xnum)
cost = 0.
labels = np.empty(n_... | [
"def",
"_labels_cost",
"(",
"Xnum",
",",
"Xcat",
",",
"centroids",
",",
"num_dissim",
",",
"cat_dissim",
",",
"gamma",
",",
"membship",
"=",
"None",
")",
":",
"n_points",
"=",
"Xnum",
".",
"shape",
"[",
"0",
"]",
"Xnum",
"=",
"check_array",
"(",
"Xnum"... | Calculate labels and cost function given a matrix of points and
a list of centroids for the k-prototypes algorithm. | [
"Calculate",
"labels",
"and",
"cost",
"function",
"given",
"a",
"matrix",
"of",
"points",
"and",
"a",
"list",
"of",
"centroids",
"for",
"the",
"k",
"-",
"prototypes",
"algorithm",
"."
] | cdb19fe5448aba1bf501626694bb52e68eafab45 | https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/kprototypes.py#L53-L73 |
227,220 | nicodv/kmodes | kmodes/kprototypes.py | _k_prototypes_iter | def _k_prototypes_iter(Xnum, Xcat, centroids, cl_attr_sum, cl_memb_sum, cl_attr_freq,
membship, num_dissim, cat_dissim, gamma, random_state):
"""Single iteration of the k-prototypes algorithm"""
moves = 0
for ipoint in range(Xnum.shape[0]):
clust = np.argmin(
num_d... | python | def _k_prototypes_iter(Xnum, Xcat, centroids, cl_attr_sum, cl_memb_sum, cl_attr_freq,
membship, num_dissim, cat_dissim, gamma, random_state):
"""Single iteration of the k-prototypes algorithm"""
moves = 0
for ipoint in range(Xnum.shape[0]):
clust = np.argmin(
num_d... | [
"def",
"_k_prototypes_iter",
"(",
"Xnum",
",",
"Xcat",
",",
"centroids",
",",
"cl_attr_sum",
",",
"cl_memb_sum",
",",
"cl_attr_freq",
",",
"membship",
",",
"num_dissim",
",",
"cat_dissim",
",",
"gamma",
",",
"random_state",
")",
":",
"moves",
"=",
"0",
"for"... | Single iteration of the k-prototypes algorithm | [
"Single",
"iteration",
"of",
"the",
"k",
"-",
"prototypes",
"algorithm"
] | cdb19fe5448aba1bf501626694bb52e68eafab45 | https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/kprototypes.py#L76-L127 |
227,221 | nicodv/kmodes | kmodes/kprototypes.py | k_prototypes | def k_prototypes(X, categorical, n_clusters, max_iter, num_dissim, cat_dissim,
gamma, init, n_init, verbose, random_state, n_jobs):
"""k-prototypes algorithm"""
random_state = check_random_state(random_state)
if sparse.issparse(X):
raise TypeError("k-prototypes does not support spar... | python | def k_prototypes(X, categorical, n_clusters, max_iter, num_dissim, cat_dissim,
gamma, init, n_init, verbose, random_state, n_jobs):
"""k-prototypes algorithm"""
random_state = check_random_state(random_state)
if sparse.issparse(X):
raise TypeError("k-prototypes does not support spar... | [
"def",
"k_prototypes",
"(",
"X",
",",
"categorical",
",",
"n_clusters",
",",
"max_iter",
",",
"num_dissim",
",",
"cat_dissim",
",",
"gamma",
",",
"init",
",",
"n_init",
",",
"verbose",
",",
"random_state",
",",
"n_jobs",
")",
":",
"random_state",
"=",
"che... | k-prototypes algorithm | [
"k",
"-",
"prototypes",
"algorithm"
] | cdb19fe5448aba1bf501626694bb52e68eafab45 | https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/kprototypes.py#L255-L327 |
227,222 | nicodv/kmodes | kmodes/kprototypes.py | KPrototypes.fit | def fit(self, X, y=None, categorical=None):
"""Compute k-prototypes clustering.
Parameters
----------
X : array-like, shape=[n_samples, n_features]
categorical : Index of columns that contain categorical data
"""
if categorical is not None:
assert isi... | python | def fit(self, X, y=None, categorical=None):
"""Compute k-prototypes clustering.
Parameters
----------
X : array-like, shape=[n_samples, n_features]
categorical : Index of columns that contain categorical data
"""
if categorical is not None:
assert isi... | [
"def",
"fit",
"(",
"self",
",",
"X",
",",
"y",
"=",
"None",
",",
"categorical",
"=",
"None",
")",
":",
"if",
"categorical",
"is",
"not",
"None",
":",
"assert",
"isinstance",
"(",
"categorical",
",",
"(",
"int",
",",
"list",
",",
"tuple",
")",
")",
... | Compute k-prototypes clustering.
Parameters
----------
X : array-like, shape=[n_samples, n_features]
categorical : Index of columns that contain categorical data | [
"Compute",
"k",
"-",
"prototypes",
"clustering",
"."
] | cdb19fe5448aba1bf501626694bb52e68eafab45 | https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/kprototypes.py#L431-L463 |
227,223 | nicodv/kmodes | kmodes/util/dissim.py | euclidean_dissim | def euclidean_dissim(a, b, **_):
"""Euclidean distance dissimilarity function"""
if np.isnan(a).any() or np.isnan(b).any():
raise ValueError("Missing values detected in numerical columns.")
return np.sum((a - b) ** 2, axis=1) | python | def euclidean_dissim(a, b, **_):
"""Euclidean distance dissimilarity function"""
if np.isnan(a).any() or np.isnan(b).any():
raise ValueError("Missing values detected in numerical columns.")
return np.sum((a - b) ** 2, axis=1) | [
"def",
"euclidean_dissim",
"(",
"a",
",",
"b",
",",
"*",
"*",
"_",
")",
":",
"if",
"np",
".",
"isnan",
"(",
"a",
")",
".",
"any",
"(",
")",
"or",
"np",
".",
"isnan",
"(",
"b",
")",
".",
"any",
"(",
")",
":",
"raise",
"ValueError",
"(",
"\"M... | Euclidean distance dissimilarity function | [
"Euclidean",
"distance",
"dissimilarity",
"function"
] | cdb19fe5448aba1bf501626694bb52e68eafab45 | https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/util/dissim.py#L13-L17 |
227,224 | nicodv/kmodes | kmodes/util/dissim.py | ng_dissim | def ng_dissim(a, b, X=None, membship=None):
"""Ng et al.'s dissimilarity measure, as presented in
Michael K. Ng, Mark Junjie Li, Joshua Zhexue Huang, and Zengyou He, "On the
Impact of Dissimilarity Measure in k-Modes Clustering Algorithm", IEEE
Transactions on Pattern Analysis and Machine Intelligence, ... | python | def ng_dissim(a, b, X=None, membship=None):
"""Ng et al.'s dissimilarity measure, as presented in
Michael K. Ng, Mark Junjie Li, Joshua Zhexue Huang, and Zengyou He, "On the
Impact of Dissimilarity Measure in k-Modes Clustering Algorithm", IEEE
Transactions on Pattern Analysis and Machine Intelligence, ... | [
"def",
"ng_dissim",
"(",
"a",
",",
"b",
",",
"X",
"=",
"None",
",",
"membship",
"=",
"None",
")",
":",
"# Without membership, revert to matching dissimilarity",
"if",
"membship",
"is",
"None",
":",
"return",
"matching_dissim",
"(",
"a",
",",
"b",
")",
"def",... | Ng et al.'s dissimilarity measure, as presented in
Michael K. Ng, Mark Junjie Li, Joshua Zhexue Huang, and Zengyou He, "On the
Impact of Dissimilarity Measure in k-Modes Clustering Algorithm", IEEE
Transactions on Pattern Analysis and Machine Intelligence, Vol. 29, No. 3,
January, 2007
This functio... | [
"Ng",
"et",
"al",
".",
"s",
"dissimilarity",
"measure",
"as",
"presented",
"in",
"Michael",
"K",
".",
"Ng",
"Mark",
"Junjie",
"Li",
"Joshua",
"Zhexue",
"Huang",
"and",
"Zengyou",
"He",
"On",
"the",
"Impact",
"of",
"Dissimilarity",
"Measure",
"in",
"k",
"... | cdb19fe5448aba1bf501626694bb52e68eafab45 | https://github.com/nicodv/kmodes/blob/cdb19fe5448aba1bf501626694bb52e68eafab45/kmodes/util/dissim.py#L20-L58 |
227,225 | Bogdanp/dramatiq | dramatiq/results/backend.py | ResultBackend.store_result | def store_result(self, message, result: Result, ttl: int) -> None:
"""Store a result in the backend.
Parameters:
message(Message)
result(object): Must be serializable.
ttl(int): The maximum amount of time the result may be
stored in the backend for.
"""... | python | def store_result(self, message, result: Result, ttl: int) -> None:
"""Store a result in the backend.
Parameters:
message(Message)
result(object): Must be serializable.
ttl(int): The maximum amount of time the result may be
stored in the backend for.
"""... | [
"def",
"store_result",
"(",
"self",
",",
"message",
",",
"result",
":",
"Result",
",",
"ttl",
":",
"int",
")",
"->",
"None",
":",
"message_key",
"=",
"self",
".",
"build_message_key",
"(",
"message",
")",
"return",
"self",
".",
"_store",
"(",
"message_ke... | Store a result in the backend.
Parameters:
message(Message)
result(object): Must be serializable.
ttl(int): The maximum amount of time the result may be
stored in the backend for. | [
"Store",
"a",
"result",
"in",
"the",
"backend",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/results/backend.py#L98-L108 |
227,226 | Bogdanp/dramatiq | dramatiq/results/backend.py | ResultBackend.build_message_key | def build_message_key(self, message) -> str:
"""Given a message, return its globally-unique key.
Parameters:
message(Message)
Returns:
str
"""
message_key = "%(namespace)s:%(queue_name)s:%(actor_name)s:%(message_id)s" % {
"namespace": self.namesp... | python | def build_message_key(self, message) -> str:
"""Given a message, return its globally-unique key.
Parameters:
message(Message)
Returns:
str
"""
message_key = "%(namespace)s:%(queue_name)s:%(actor_name)s:%(message_id)s" % {
"namespace": self.namesp... | [
"def",
"build_message_key",
"(",
"self",
",",
"message",
")",
"->",
"str",
":",
"message_key",
"=",
"\"%(namespace)s:%(queue_name)s:%(actor_name)s:%(message_id)s\"",
"%",
"{",
"\"namespace\"",
":",
"self",
".",
"namespace",
",",
"\"queue_name\"",
":",
"q_name",
"(",
... | Given a message, return its globally-unique key.
Parameters:
message(Message)
Returns:
str | [
"Given",
"a",
"message",
"return",
"its",
"globally",
"-",
"unique",
"key",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/results/backend.py#L110-L125 |
227,227 | Bogdanp/dramatiq | dramatiq/results/backend.py | ResultBackend._store | def _store(self, message_key: str, result: Result, ttl: int) -> None: # pragma: no cover
"""Store a result in the backend. Subclasses may implement
this method if they want to use the default implementation of
set_result.
"""
raise NotImplementedError("%(classname)r does not im... | python | def _store(self, message_key: str, result: Result, ttl: int) -> None: # pragma: no cover
"""Store a result in the backend. Subclasses may implement
this method if they want to use the default implementation of
set_result.
"""
raise NotImplementedError("%(classname)r does not im... | [
"def",
"_store",
"(",
"self",
",",
"message_key",
":",
"str",
",",
"result",
":",
"Result",
",",
"ttl",
":",
"int",
")",
"->",
"None",
":",
"# pragma: no cover",
"raise",
"NotImplementedError",
"(",
"\"%(classname)r does not implement _store()\"",
"%",
"{",
"\"c... | Store a result in the backend. Subclasses may implement
this method if they want to use the default implementation of
set_result. | [
"Store",
"a",
"result",
"in",
"the",
"backend",
".",
"Subclasses",
"may",
"implement",
"this",
"method",
"if",
"they",
"want",
"to",
"use",
"the",
"default",
"implementation",
"of",
"set_result",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/results/backend.py#L136-L143 |
227,228 | Bogdanp/dramatiq | dramatiq/rate_limits/rate_limiter.py | RateLimiter.acquire | def acquire(self, *, raise_on_failure=True):
"""Attempt to acquire a slot under this rate limiter.
Parameters:
raise_on_failure(bool): Whether or not failures should raise an
exception. If this is false, the context manager will instead
return a boolean value represen... | python | def acquire(self, *, raise_on_failure=True):
"""Attempt to acquire a slot under this rate limiter.
Parameters:
raise_on_failure(bool): Whether or not failures should raise an
exception. If this is false, the context manager will instead
return a boolean value represen... | [
"def",
"acquire",
"(",
"self",
",",
"*",
",",
"raise_on_failure",
"=",
"True",
")",
":",
"acquired",
"=",
"False",
"try",
":",
"acquired",
"=",
"self",
".",
"_acquire",
"(",
")",
"if",
"raise_on_failure",
"and",
"not",
"acquired",
":",
"raise",
"RateLimi... | Attempt to acquire a slot under this rate limiter.
Parameters:
raise_on_failure(bool): Whether or not failures should raise an
exception. If this is false, the context manager will instead
return a boolean value representing whether or not the rate
limit slot was ... | [
"Attempt",
"to",
"acquire",
"a",
"slot",
"under",
"this",
"rate",
"limiter",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/rate_limits/rate_limiter.py#L56-L78 |
227,229 | Bogdanp/dramatiq | dramatiq/middleware/prometheus.py | flock | def flock(path):
"""Attempt to acquire a POSIX file lock.
"""
with open(path, "w+") as lf:
try:
fcntl.flock(lf, fcntl.LOCK_EX | fcntl.LOCK_NB)
acquired = True
yield acquired
except OSError:
acquired = False
yield acquired
... | python | def flock(path):
"""Attempt to acquire a POSIX file lock.
"""
with open(path, "w+") as lf:
try:
fcntl.flock(lf, fcntl.LOCK_EX | fcntl.LOCK_NB)
acquired = True
yield acquired
except OSError:
acquired = False
yield acquired
... | [
"def",
"flock",
"(",
"path",
")",
":",
"with",
"open",
"(",
"path",
",",
"\"w+\"",
")",
"as",
"lf",
":",
"try",
":",
"fcntl",
".",
"flock",
"(",
"lf",
",",
"fcntl",
".",
"LOCK_EX",
"|",
"fcntl",
".",
"LOCK_NB",
")",
"acquired",
"=",
"True",
"yiel... | Attempt to acquire a POSIX file lock. | [
"Attempt",
"to",
"acquire",
"a",
"POSIX",
"file",
"lock",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/middleware/prometheus.py#L227-L242 |
227,230 | Bogdanp/dramatiq | dramatiq/message.py | Message.copy | def copy(self, **attributes):
"""Create a copy of this message.
"""
updated_options = attributes.pop("options", {})
options = self.options.copy()
options.update(updated_options)
return self._replace(**attributes, options=options) | python | def copy(self, **attributes):
"""Create a copy of this message.
"""
updated_options = attributes.pop("options", {})
options = self.options.copy()
options.update(updated_options)
return self._replace(**attributes, options=options) | [
"def",
"copy",
"(",
"self",
",",
"*",
"*",
"attributes",
")",
":",
"updated_options",
"=",
"attributes",
".",
"pop",
"(",
"\"options\"",
",",
"{",
"}",
")",
"options",
"=",
"self",
".",
"options",
".",
"copy",
"(",
")",
"options",
".",
"update",
"(",... | Create a copy of this message. | [
"Create",
"a",
"copy",
"of",
"this",
"message",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/message.py#L103-L109 |
227,231 | Bogdanp/dramatiq | dramatiq/message.py | Message.get_result | def get_result(self, *, backend=None, block=False, timeout=None):
"""Get the result associated with this message from a result
backend.
Warning:
If you use multiple result backends or brokers you should
always pass the backend parameter. This method is only able
t... | python | def get_result(self, *, backend=None, block=False, timeout=None):
"""Get the result associated with this message from a result
backend.
Warning:
If you use multiple result backends or brokers you should
always pass the backend parameter. This method is only able
t... | [
"def",
"get_result",
"(",
"self",
",",
"*",
",",
"backend",
"=",
"None",
",",
"block",
"=",
"False",
",",
"timeout",
"=",
"None",
")",
":",
"if",
"not",
"backend",
":",
"broker",
"=",
"get_broker",
"(",
")",
"for",
"middleware",
"in",
"broker",
".",
... | Get the result associated with this message from a result
backend.
Warning:
If you use multiple result backends or brokers you should
always pass the backend parameter. This method is only able
to infer the result backend off of the default broker.
Parameters:
... | [
"Get",
"the",
"result",
"associated",
"with",
"this",
"message",
"from",
"a",
"result",
"backend",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/message.py#L111-L147 |
227,232 | Bogdanp/dramatiq | dramatiq/common.py | compute_backoff | def compute_backoff(attempts, *, factor=5, jitter=True, max_backoff=2000, max_exponent=32):
"""Compute an exponential backoff value based on some number of attempts.
Parameters:
attempts(int): The number of attempts there have been so far.
factor(int): The number of milliseconds to multiply each ba... | python | def compute_backoff(attempts, *, factor=5, jitter=True, max_backoff=2000, max_exponent=32):
"""Compute an exponential backoff value based on some number of attempts.
Parameters:
attempts(int): The number of attempts there have been so far.
factor(int): The number of milliseconds to multiply each ba... | [
"def",
"compute_backoff",
"(",
"attempts",
",",
"*",
",",
"factor",
"=",
"5",
",",
"jitter",
"=",
"True",
",",
"max_backoff",
"=",
"2000",
",",
"max_exponent",
"=",
"32",
")",
":",
"exponent",
"=",
"min",
"(",
"attempts",
",",
"max_exponent",
")",
"bac... | Compute an exponential backoff value based on some number of attempts.
Parameters:
attempts(int): The number of attempts there have been so far.
factor(int): The number of milliseconds to multiply each backoff by.
max_backoff(int): The max number of milliseconds to backoff by.
max_exponent(... | [
"Compute",
"an",
"exponential",
"backoff",
"value",
"based",
"on",
"some",
"number",
"of",
"attempts",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/common.py#L24-L41 |
227,233 | Bogdanp/dramatiq | dramatiq/common.py | join_all | def join_all(joinables, timeout):
"""Wait on a list of objects that can be joined with a total
timeout represented by ``timeout``.
Parameters:
joinables(object): Objects with a join method.
timeout(int): The total timeout in milliseconds.
"""
started, elapsed = current_millis(), 0
f... | python | def join_all(joinables, timeout):
"""Wait on a list of objects that can be joined with a total
timeout represented by ``timeout``.
Parameters:
joinables(object): Objects with a join method.
timeout(int): The total timeout in milliseconds.
"""
started, elapsed = current_millis(), 0
f... | [
"def",
"join_all",
"(",
"joinables",
",",
"timeout",
")",
":",
"started",
",",
"elapsed",
"=",
"current_millis",
"(",
")",
",",
"0",
"for",
"ob",
"in",
"joinables",
":",
"ob",
".",
"join",
"(",
"timeout",
"=",
"timeout",
"/",
"1000",
")",
"elapsed",
... | Wait on a list of objects that can be joined with a total
timeout represented by ``timeout``.
Parameters:
joinables(object): Objects with a join method.
timeout(int): The total timeout in milliseconds. | [
"Wait",
"on",
"a",
"list",
"of",
"objects",
"that",
"can",
"be",
"joined",
"with",
"a",
"total",
"timeout",
"represented",
"by",
"timeout",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/common.py#L86-L98 |
227,234 | Bogdanp/dramatiq | dramatiq/common.py | dq_name | def dq_name(queue_name):
"""Returns the delayed queue name for a given queue. If the given
queue name already belongs to a delayed queue, then it is returned
unchanged.
"""
if queue_name.endswith(".DQ"):
return queue_name
if queue_name.endswith(".XQ"):
queue_name = queue_name[:... | python | def dq_name(queue_name):
"""Returns the delayed queue name for a given queue. If the given
queue name already belongs to a delayed queue, then it is returned
unchanged.
"""
if queue_name.endswith(".DQ"):
return queue_name
if queue_name.endswith(".XQ"):
queue_name = queue_name[:... | [
"def",
"dq_name",
"(",
"queue_name",
")",
":",
"if",
"queue_name",
".",
"endswith",
"(",
"\".DQ\"",
")",
":",
"return",
"queue_name",
"if",
"queue_name",
".",
"endswith",
"(",
"\".XQ\"",
")",
":",
"queue_name",
"=",
"queue_name",
"[",
":",
"-",
"3",
"]",... | Returns the delayed queue name for a given queue. If the given
queue name already belongs to a delayed queue, then it is returned
unchanged. | [
"Returns",
"the",
"delayed",
"queue",
"name",
"for",
"a",
"given",
"queue",
".",
"If",
"the",
"given",
"queue",
"name",
"already",
"belongs",
"to",
"a",
"delayed",
"queue",
"then",
"it",
"is",
"returned",
"unchanged",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/common.py#L109-L119 |
227,235 | Bogdanp/dramatiq | dramatiq/common.py | xq_name | def xq_name(queue_name):
"""Returns the dead letter queue name for a given queue. If the
given queue name belongs to a delayed queue, the dead letter queue
name for the original queue is generated.
"""
if queue_name.endswith(".XQ"):
return queue_name
if queue_name.endswith(".DQ"):
... | python | def xq_name(queue_name):
"""Returns the dead letter queue name for a given queue. If the
given queue name belongs to a delayed queue, the dead letter queue
name for the original queue is generated.
"""
if queue_name.endswith(".XQ"):
return queue_name
if queue_name.endswith(".DQ"):
... | [
"def",
"xq_name",
"(",
"queue_name",
")",
":",
"if",
"queue_name",
".",
"endswith",
"(",
"\".XQ\"",
")",
":",
"return",
"queue_name",
"if",
"queue_name",
".",
"endswith",
"(",
"\".DQ\"",
")",
":",
"queue_name",
"=",
"queue_name",
"[",
":",
"-",
"3",
"]",... | Returns the dead letter queue name for a given queue. If the
given queue name belongs to a delayed queue, the dead letter queue
name for the original queue is generated. | [
"Returns",
"the",
"dead",
"letter",
"queue",
"name",
"for",
"a",
"given",
"queue",
".",
"If",
"the",
"given",
"queue",
"name",
"belongs",
"to",
"a",
"delayed",
"queue",
"the",
"dead",
"letter",
"queue",
"name",
"for",
"the",
"original",
"queue",
"is",
"g... | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/common.py#L122-L132 |
227,236 | Bogdanp/dramatiq | dramatiq/broker.py | get_broker | def get_broker() -> "Broker":
"""Get the global broker instance. If no global broker is set,
this initializes a RabbitmqBroker and returns it.
Returns:
Broker: The default Broker.
"""
global global_broker
if global_broker is None:
from .brokers.rabbitmq import RabbitmqBroker
... | python | def get_broker() -> "Broker":
"""Get the global broker instance. If no global broker is set,
this initializes a RabbitmqBroker and returns it.
Returns:
Broker: The default Broker.
"""
global global_broker
if global_broker is None:
from .brokers.rabbitmq import RabbitmqBroker
... | [
"def",
"get_broker",
"(",
")",
"->",
"\"Broker\"",
":",
"global",
"global_broker",
"if",
"global_broker",
"is",
"None",
":",
"from",
".",
"brokers",
".",
"rabbitmq",
"import",
"RabbitmqBroker",
"set_broker",
"(",
"RabbitmqBroker",
"(",
"host",
"=",
"\"127.0.0.1\... | Get the global broker instance. If no global broker is set,
this initializes a RabbitmqBroker and returns it.
Returns:
Broker: The default Broker. | [
"Get",
"the",
"global",
"broker",
"instance",
".",
"If",
"no",
"global",
"broker",
"is",
"set",
"this",
"initializes",
"a",
"RabbitmqBroker",
"and",
"returns",
"it",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/broker.py#L26-L44 |
227,237 | Bogdanp/dramatiq | dramatiq/broker.py | Broker.add_middleware | def add_middleware(self, middleware, *, before=None, after=None):
"""Add a middleware object to this broker. The middleware is
appended to the end of the middleware list by default.
You can specify another middleware (by class) as a reference
point for where the new middleware should b... | python | def add_middleware(self, middleware, *, before=None, after=None):
"""Add a middleware object to this broker. The middleware is
appended to the end of the middleware list by default.
You can specify another middleware (by class) as a reference
point for where the new middleware should b... | [
"def",
"add_middleware",
"(",
"self",
",",
"middleware",
",",
"*",
",",
"before",
"=",
"None",
",",
"after",
"=",
"None",
")",
":",
"assert",
"not",
"(",
"before",
"and",
"after",
")",
",",
"\"provide either 'before' or 'after', but not both\"",
"if",
"before"... | Add a middleware object to this broker. The middleware is
appended to the end of the middleware list by default.
You can specify another middleware (by class) as a reference
point for where the new middleware should be added.
Parameters:
middleware(Middleware): The middlewar... | [
"Add",
"a",
"middleware",
"object",
"to",
"this",
"broker",
".",
"The",
"middleware",
"is",
"appended",
"to",
"the",
"end",
"of",
"the",
"middleware",
"list",
"by",
"default",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/broker.py#L102-L144 |
227,238 | Bogdanp/dramatiq | dramatiq/broker.py | Broker.declare_actor | def declare_actor(self, actor): # pragma: no cover
"""Declare a new actor on this broker. Declaring an Actor
twice replaces the first actor with the second by name.
Parameters:
actor(Actor): The actor being declared.
"""
self.emit_before("declare_actor", actor)
... | python | def declare_actor(self, actor): # pragma: no cover
"""Declare a new actor on this broker. Declaring an Actor
twice replaces the first actor with the second by name.
Parameters:
actor(Actor): The actor being declared.
"""
self.emit_before("declare_actor", actor)
... | [
"def",
"declare_actor",
"(",
"self",
",",
"actor",
")",
":",
"# pragma: no cover",
"self",
".",
"emit_before",
"(",
"\"declare_actor\"",
",",
"actor",
")",
"self",
".",
"declare_queue",
"(",
"actor",
".",
"queue_name",
")",
"self",
".",
"actors",
"[",
"actor... | Declare a new actor on this broker. Declaring an Actor
twice replaces the first actor with the second by name.
Parameters:
actor(Actor): The actor being declared. | [
"Declare",
"a",
"new",
"actor",
"on",
"this",
"broker",
".",
"Declaring",
"an",
"Actor",
"twice",
"replaces",
"the",
"first",
"actor",
"with",
"the",
"second",
"by",
"name",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/broker.py#L166-L176 |
227,239 | Bogdanp/dramatiq | dramatiq/brokers/rabbitmq.py | URLRabbitmqBroker | def URLRabbitmqBroker(url, *, middleware=None):
"""Alias for the RabbitMQ broker that takes a connection URL as a
positional argument.
Parameters:
url(str): A connection string.
middleware(list[Middleware]): The middleware to add to this
broker.
"""
warnings.warn(
"Use R... | python | def URLRabbitmqBroker(url, *, middleware=None):
"""Alias for the RabbitMQ broker that takes a connection URL as a
positional argument.
Parameters:
url(str): A connection string.
middleware(list[Middleware]): The middleware to add to this
broker.
"""
warnings.warn(
"Use R... | [
"def",
"URLRabbitmqBroker",
"(",
"url",
",",
"*",
",",
"middleware",
"=",
"None",
")",
":",
"warnings",
".",
"warn",
"(",
"\"Use RabbitmqBroker with the 'url' parameter instead of URLRabbitmqBroker.\"",
",",
"DeprecationWarning",
",",
"stacklevel",
"=",
"2",
",",
")",... | Alias for the RabbitMQ broker that takes a connection URL as a
positional argument.
Parameters:
url(str): A connection string.
middleware(list[Middleware]): The middleware to add to this
broker. | [
"Alias",
"for",
"the",
"RabbitMQ",
"broker",
"that",
"takes",
"a",
"connection",
"URL",
"as",
"a",
"positional",
"argument",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/brokers/rabbitmq.py#L387-L400 |
227,240 | Bogdanp/dramatiq | dramatiq/brokers/rabbitmq.py | RabbitmqBroker.close | def close(self):
"""Close all open RabbitMQ connections.
"""
# The main thread may keep connections open for a long time
# w/o publishing heartbeats, which means that they'll end up
# being closed by the time the broker is closed. When that
# happens, pika logs a bunch o... | python | def close(self):
"""Close all open RabbitMQ connections.
"""
# The main thread may keep connections open for a long time
# w/o publishing heartbeats, which means that they'll end up
# being closed by the time the broker is closed. When that
# happens, pika logs a bunch o... | [
"def",
"close",
"(",
"self",
")",
":",
"# The main thread may keep connections open for a long time",
"# w/o publishing heartbeats, which means that they'll end up",
"# being closed by the time the broker is closed. When that",
"# happens, pika logs a bunch of scary stuff so we want to",
"# fil... | Close all open RabbitMQ connections. | [
"Close",
"all",
"open",
"RabbitMQ",
"connections",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/brokers/rabbitmq.py#L147-L168 |
227,241 | Bogdanp/dramatiq | dramatiq/brokers/rabbitmq.py | RabbitmqBroker.declare_queue | def declare_queue(self, queue_name):
"""Declare a queue. Has no effect if a queue with the given
name already exists.
Parameters:
queue_name(str): The name of the new queue.
Raises:
ConnectionClosed: If the underlying channel or connection
has been clos... | python | def declare_queue(self, queue_name):
"""Declare a queue. Has no effect if a queue with the given
name already exists.
Parameters:
queue_name(str): The name of the new queue.
Raises:
ConnectionClosed: If the underlying channel or connection
has been clos... | [
"def",
"declare_queue",
"(",
"self",
",",
"queue_name",
")",
":",
"attempts",
"=",
"1",
"while",
"True",
":",
"try",
":",
"if",
"queue_name",
"not",
"in",
"self",
".",
"queues",
":",
"self",
".",
"emit_before",
"(",
"\"declare_queue\"",
",",
"queue_name",
... | Declare a queue. Has no effect if a queue with the given
name already exists.
Parameters:
queue_name(str): The name of the new queue.
Raises:
ConnectionClosed: If the underlying channel or connection
has been closed. | [
"Declare",
"a",
"queue",
".",
"Has",
"no",
"effect",
"if",
"a",
"queue",
"with",
"the",
"given",
"name",
"already",
"exists",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/brokers/rabbitmq.py#L183-L224 |
227,242 | Bogdanp/dramatiq | dramatiq/brokers/rabbitmq.py | RabbitmqBroker.get_queue_message_counts | def get_queue_message_counts(self, queue_name):
"""Get the number of messages in a queue. This method is only
meant to be used in unit and integration tests.
Parameters:
queue_name(str): The queue whose message counts to get.
Returns:
tuple: A triple representing t... | python | def get_queue_message_counts(self, queue_name):
"""Get the number of messages in a queue. This method is only
meant to be used in unit and integration tests.
Parameters:
queue_name(str): The queue whose message counts to get.
Returns:
tuple: A triple representing t... | [
"def",
"get_queue_message_counts",
"(",
"self",
",",
"queue_name",
")",
":",
"queue_response",
"=",
"self",
".",
"_declare_queue",
"(",
"queue_name",
")",
"dq_queue_response",
"=",
"self",
".",
"_declare_dq_queue",
"(",
"queue_name",
")",
"xq_queue_response",
"=",
... | Get the number of messages in a queue. This method is only
meant to be used in unit and integration tests.
Parameters:
queue_name(str): The queue whose message counts to get.
Returns:
tuple: A triple representing the number of messages in the
queue, its delayed q... | [
"Get",
"the",
"number",
"of",
"messages",
"in",
"a",
"queue",
".",
"This",
"method",
"is",
"only",
"meant",
"to",
"be",
"used",
"in",
"unit",
"and",
"integration",
"tests",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/brokers/rabbitmq.py#L318-L336 |
227,243 | Bogdanp/dramatiq | dramatiq/rate_limits/barrier.py | Barrier.create | def create(self, parties):
"""Create the barrier for the given number of parties.
Parameters:
parties(int): The number of parties to wait for.
Returns:
bool: Whether or not the new barrier was successfully created.
"""
assert parties > 0, "parties must be a ... | python | def create(self, parties):
"""Create the barrier for the given number of parties.
Parameters:
parties(int): The number of parties to wait for.
Returns:
bool: Whether or not the new barrier was successfully created.
"""
assert parties > 0, "parties must be a ... | [
"def",
"create",
"(",
"self",
",",
"parties",
")",
":",
"assert",
"parties",
">",
"0",
",",
"\"parties must be a positive integer.\"",
"return",
"self",
".",
"backend",
".",
"add",
"(",
"self",
".",
"key",
",",
"parties",
",",
"self",
".",
"ttl",
")"
] | Create the barrier for the given number of parties.
Parameters:
parties(int): The number of parties to wait for.
Returns:
bool: Whether or not the new barrier was successfully created. | [
"Create",
"the",
"barrier",
"for",
"the",
"given",
"number",
"of",
"parties",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/rate_limits/barrier.py#L50-L60 |
227,244 | Bogdanp/dramatiq | dramatiq/rate_limits/barrier.py | Barrier.wait | def wait(self, *, block=True, timeout=None):
"""Signal that a party has reached the barrier.
Warning:
Barrier blocking is currently only supported by the stub and
Redis backends.
Warning:
Re-using keys between blocking calls may lead to undefined
behavio... | python | def wait(self, *, block=True, timeout=None):
"""Signal that a party has reached the barrier.
Warning:
Barrier blocking is currently only supported by the stub and
Redis backends.
Warning:
Re-using keys between blocking calls may lead to undefined
behavio... | [
"def",
"wait",
"(",
"self",
",",
"*",
",",
"block",
"=",
"True",
",",
"timeout",
"=",
"None",
")",
":",
"cleared",
"=",
"not",
"self",
".",
"backend",
".",
"decr",
"(",
"self",
".",
"key",
",",
"1",
",",
"1",
",",
"self",
".",
"ttl",
")",
"if... | Signal that a party has reached the barrier.
Warning:
Barrier blocking is currently only supported by the stub and
Redis backends.
Warning:
Re-using keys between blocking calls may lead to undefined
behaviour. Make sure your barrier keys are always unique
... | [
"Signal",
"that",
"a",
"party",
"has",
"reached",
"the",
"barrier",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/rate_limits/barrier.py#L62-L91 |
227,245 | Bogdanp/dramatiq | dramatiq/middleware/threading.py | raise_thread_exception | def raise_thread_exception(thread_id, exception):
"""Raise an exception in a thread.
Currently, this is only available on CPython.
Note:
This works by setting an async exception in the thread. This means
that the exception will only get called the next time that thread
acquires the GIL.... | python | def raise_thread_exception(thread_id, exception):
"""Raise an exception in a thread.
Currently, this is only available on CPython.
Note:
This works by setting an async exception in the thread. This means
that the exception will only get called the next time that thread
acquires the GIL.... | [
"def",
"raise_thread_exception",
"(",
"thread_id",
",",
"exception",
")",
":",
"if",
"current_platform",
"==",
"\"CPython\"",
":",
"_raise_thread_exception_cpython",
"(",
"thread_id",
",",
"exception",
")",
"else",
":",
"message",
"=",
"\"Setting thread exceptions (%s) ... | Raise an exception in a thread.
Currently, this is only available on CPython.
Note:
This works by setting an async exception in the thread. This means
that the exception will only get called the next time that thread
acquires the GIL. Concretely, this means that this middleware can't
... | [
"Raise",
"an",
"exception",
"in",
"a",
"thread",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/middleware/threading.py#L43-L59 |
227,246 | Bogdanp/dramatiq | dramatiq/watcher.py | setup_file_watcher | def setup_file_watcher(path, use_polling=False):
"""Sets up a background thread that watches for source changes and
automatically sends SIGHUP to the current process whenever a file
changes.
"""
if use_polling:
observer_class = watchdog.observers.polling.PollingObserver
else:
obs... | python | def setup_file_watcher(path, use_polling=False):
"""Sets up a background thread that watches for source changes and
automatically sends SIGHUP to the current process whenever a file
changes.
"""
if use_polling:
observer_class = watchdog.observers.polling.PollingObserver
else:
obs... | [
"def",
"setup_file_watcher",
"(",
"path",
",",
"use_polling",
"=",
"False",
")",
":",
"if",
"use_polling",
":",
"observer_class",
"=",
"watchdog",
".",
"observers",
".",
"polling",
".",
"PollingObserver",
"else",
":",
"observer_class",
"=",
"EVENTED_OBSERVER",
"... | Sets up a background thread that watches for source changes and
automatically sends SIGHUP to the current process whenever a file
changes. | [
"Sets",
"up",
"a",
"background",
"thread",
"that",
"watches",
"for",
"source",
"changes",
"and",
"automatically",
"sends",
"SIGHUP",
"to",
"the",
"current",
"process",
"whenever",
"a",
"file",
"changes",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/watcher.py#L16-L30 |
227,247 | Bogdanp/dramatiq | dramatiq/brokers/stub.py | StubBroker.declare_queue | def declare_queue(self, queue_name):
"""Declare a queue. Has no effect if a queue with the given
name has already been declared.
Parameters:
queue_name(str): The name of the new queue.
"""
if queue_name not in self.queues:
self.emit_before("declare_queue",... | python | def declare_queue(self, queue_name):
"""Declare a queue. Has no effect if a queue with the given
name has already been declared.
Parameters:
queue_name(str): The name of the new queue.
"""
if queue_name not in self.queues:
self.emit_before("declare_queue",... | [
"def",
"declare_queue",
"(",
"self",
",",
"queue_name",
")",
":",
"if",
"queue_name",
"not",
"in",
"self",
".",
"queues",
":",
"self",
".",
"emit_before",
"(",
"\"declare_queue\"",
",",
"queue_name",
")",
"self",
".",
"queues",
"[",
"queue_name",
"]",
"=",... | Declare a queue. Has no effect if a queue with the given
name has already been declared.
Parameters:
queue_name(str): The name of the new queue. | [
"Declare",
"a",
"queue",
".",
"Has",
"no",
"effect",
"if",
"a",
"queue",
"with",
"the",
"given",
"name",
"has",
"already",
"been",
"declared",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/brokers/stub.py#L66-L81 |
227,248 | Bogdanp/dramatiq | dramatiq/brokers/stub.py | StubBroker.flush_all | def flush_all(self):
"""Drop all messages from all declared queues.
"""
for queue_name in chain(self.queues, self.delay_queues):
self.flush(queue_name) | python | def flush_all(self):
"""Drop all messages from all declared queues.
"""
for queue_name in chain(self.queues, self.delay_queues):
self.flush(queue_name) | [
"def",
"flush_all",
"(",
"self",
")",
":",
"for",
"queue_name",
"in",
"chain",
"(",
"self",
".",
"queues",
",",
"self",
".",
"delay_queues",
")",
":",
"self",
".",
"flush",
"(",
"queue_name",
")"
] | Drop all messages from all declared queues. | [
"Drop",
"all",
"messages",
"from",
"all",
"declared",
"queues",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/brokers/stub.py#L123-L127 |
227,249 | Bogdanp/dramatiq | dramatiq/composition.py | pipeline.run | def run(self, *, delay=None):
"""Run this pipeline.
Parameters:
delay(int): The minimum amount of time, in milliseconds, the
pipeline should be delayed by.
Returns:
pipeline: Itself.
"""
self.broker.enqueue(self.messages[0], delay=delay)
... | python | def run(self, *, delay=None):
"""Run this pipeline.
Parameters:
delay(int): The minimum amount of time, in milliseconds, the
pipeline should be delayed by.
Returns:
pipeline: Itself.
"""
self.broker.enqueue(self.messages[0], delay=delay)
... | [
"def",
"run",
"(",
"self",
",",
"*",
",",
"delay",
"=",
"None",
")",
":",
"self",
".",
"broker",
".",
"enqueue",
"(",
"self",
".",
"messages",
"[",
"0",
"]",
",",
"delay",
"=",
"delay",
")",
"return",
"self"
] | Run this pipeline.
Parameters:
delay(int): The minimum amount of time, in milliseconds, the
pipeline should be delayed by.
Returns:
pipeline: Itself. | [
"Run",
"this",
"pipeline",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/composition.py#L101-L112 |
227,250 | Bogdanp/dramatiq | dramatiq/composition.py | pipeline.get_result | def get_result(self, *, block=False, timeout=None):
"""Get the result of this pipeline.
Pipeline results are represented by the result of the last
message in the chain.
Parameters:
block(bool): Whether or not to block until a result is set.
timeout(int): The maximum... | python | def get_result(self, *, block=False, timeout=None):
"""Get the result of this pipeline.
Pipeline results are represented by the result of the last
message in the chain.
Parameters:
block(bool): Whether or not to block until a result is set.
timeout(int): The maximum... | [
"def",
"get_result",
"(",
"self",
",",
"*",
",",
"block",
"=",
"False",
",",
"timeout",
"=",
"None",
")",
":",
"return",
"self",
".",
"messages",
"[",
"-",
"1",
"]",
".",
"get_result",
"(",
"block",
"=",
"block",
",",
"timeout",
"=",
"timeout",
")"... | Get the result of this pipeline.
Pipeline results are represented by the result of the last
message in the chain.
Parameters:
block(bool): Whether or not to block until a result is set.
timeout(int): The maximum amount of time, in ms, to wait for
a result when b... | [
"Get",
"the",
"result",
"of",
"this",
"pipeline",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/composition.py#L114-L132 |
227,251 | Bogdanp/dramatiq | dramatiq/composition.py | pipeline.get_results | def get_results(self, *, block=False, timeout=None):
"""Get the results of each job in the pipeline.
Parameters:
block(bool): Whether or not to block until a result is set.
timeout(int): The maximum amount of time, in ms, to wait for
a result when block is True. Default... | python | def get_results(self, *, block=False, timeout=None):
"""Get the results of each job in the pipeline.
Parameters:
block(bool): Whether or not to block until a result is set.
timeout(int): The maximum amount of time, in ms, to wait for
a result when block is True. Default... | [
"def",
"get_results",
"(",
"self",
",",
"*",
",",
"block",
"=",
"False",
",",
"timeout",
"=",
"None",
")",
":",
"deadline",
"=",
"None",
"if",
"timeout",
":",
"deadline",
"=",
"time",
".",
"monotonic",
"(",
")",
"+",
"timeout",
"/",
"1000",
"for",
... | Get the results of each job in the pipeline.
Parameters:
block(bool): Whether or not to block until a result is set.
timeout(int): The maximum amount of time, in ms, to wait for
a result when block is True. Defaults to 10 seconds.
Raises:
ResultMissing: When ... | [
"Get",
"the",
"results",
"of",
"each",
"job",
"in",
"the",
"pipeline",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/composition.py#L134-L157 |
227,252 | Bogdanp/dramatiq | dramatiq/composition.py | group.run | def run(self, *, delay=None):
"""Run the actors in this group.
Parameters:
delay(int): The minimum amount of time, in milliseconds,
each message in the group should be delayed by.
"""
for child in self.children:
if isinstance(child, (group, pipeline)):
... | python | def run(self, *, delay=None):
"""Run the actors in this group.
Parameters:
delay(int): The minimum amount of time, in milliseconds,
each message in the group should be delayed by.
"""
for child in self.children:
if isinstance(child, (group, pipeline)):
... | [
"def",
"run",
"(",
"self",
",",
"*",
",",
"delay",
"=",
"None",
")",
":",
"for",
"child",
"in",
"self",
".",
"children",
":",
"if",
"isinstance",
"(",
"child",
",",
"(",
"group",
",",
"pipeline",
")",
")",
":",
"child",
".",
"run",
"(",
"delay",
... | Run the actors in this group.
Parameters:
delay(int): The minimum amount of time, in milliseconds,
each message in the group should be delayed by. | [
"Run",
"the",
"actors",
"in",
"this",
"group",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/composition.py#L220-L233 |
227,253 | Bogdanp/dramatiq | dramatiq/composition.py | group.get_results | def get_results(self, *, block=False, timeout=None):
"""Get the results of each job in the group.
Parameters:
block(bool): Whether or not to block until the results are stored.
timeout(int): The maximum amount of time, in milliseconds,
to wait for results when block is T... | python | def get_results(self, *, block=False, timeout=None):
"""Get the results of each job in the group.
Parameters:
block(bool): Whether or not to block until the results are stored.
timeout(int): The maximum amount of time, in milliseconds,
to wait for results when block is T... | [
"def",
"get_results",
"(",
"self",
",",
"*",
",",
"block",
"=",
"False",
",",
"timeout",
"=",
"None",
")",
":",
"deadline",
"=",
"None",
"if",
"timeout",
":",
"deadline",
"=",
"time",
".",
"monotonic",
"(",
")",
"+",
"timeout",
"/",
"1000",
"for",
... | Get the results of each job in the group.
Parameters:
block(bool): Whether or not to block until the results are stored.
timeout(int): The maximum amount of time, in milliseconds,
to wait for results when block is True. Defaults to 10
seconds.
Raises:
... | [
"Get",
"the",
"results",
"of",
"each",
"job",
"in",
"the",
"group",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/composition.py#L235-L262 |
227,254 | Bogdanp/dramatiq | dramatiq/composition.py | group.wait | def wait(self, *, timeout=None):
"""Block until all the jobs in the group have finished or
until the timeout expires.
Parameters:
timeout(int): The maximum amount of time, in ms, to wait.
Defaults to 10 seconds.
"""
for _ in self.get_results(block=True, tim... | python | def wait(self, *, timeout=None):
"""Block until all the jobs in the group have finished or
until the timeout expires.
Parameters:
timeout(int): The maximum amount of time, in ms, to wait.
Defaults to 10 seconds.
"""
for _ in self.get_results(block=True, tim... | [
"def",
"wait",
"(",
"self",
",",
"*",
",",
"timeout",
"=",
"None",
")",
":",
"for",
"_",
"in",
"self",
".",
"get_results",
"(",
"block",
"=",
"True",
",",
"timeout",
"=",
"timeout",
")",
":",
"# pragma: no cover",
"pass"
] | Block until all the jobs in the group have finished or
until the timeout expires.
Parameters:
timeout(int): The maximum amount of time, in ms, to wait.
Defaults to 10 seconds. | [
"Block",
"until",
"all",
"the",
"jobs",
"in",
"the",
"group",
"have",
"finished",
"or",
"until",
"the",
"timeout",
"expires",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/composition.py#L264-L273 |
227,255 | Bogdanp/dramatiq | dramatiq/actor.py | actor | def actor(fn=None, *, actor_class=Actor, actor_name=None, queue_name="default", priority=0, broker=None, **options):
"""Declare an actor.
Examples:
>>> import dramatiq
>>> @dramatiq.actor
... def add(x, y):
... print(x + y)
...
>>> add
Actor(<function add at 0x10... | python | def actor(fn=None, *, actor_class=Actor, actor_name=None, queue_name="default", priority=0, broker=None, **options):
"""Declare an actor.
Examples:
>>> import dramatiq
>>> @dramatiq.actor
... def add(x, y):
... print(x + y)
...
>>> add
Actor(<function add at 0x10... | [
"def",
"actor",
"(",
"fn",
"=",
"None",
",",
"*",
",",
"actor_class",
"=",
"Actor",
",",
"actor_name",
"=",
"None",
",",
"queue_name",
"=",
"\"default\"",
",",
"priority",
"=",
"0",
",",
"broker",
"=",
"None",
",",
"*",
"*",
"options",
")",
":",
"d... | Declare an actor.
Examples:
>>> import dramatiq
>>> @dramatiq.actor
... def add(x, y):
... print(x + y)
...
>>> add
Actor(<function add at 0x106c6d488>, queue_name='default', actor_name='add')
>>> add(1, 2)
3
>>> add.send(1, 2)
Message(
... | [
"Declare",
"an",
"actor",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/actor.py#L157-L225 |
227,256 | Bogdanp/dramatiq | dramatiq/actor.py | Actor.message | def message(self, *args, **kwargs):
"""Build a message. This method is useful if you want to
compose actors. See the actor composition documentation for
details.
Parameters:
*args(tuple): Positional arguments to send to the actor.
**kwargs(dict): Keyword arguments ... | python | def message(self, *args, **kwargs):
"""Build a message. This method is useful if you want to
compose actors. See the actor composition documentation for
details.
Parameters:
*args(tuple): Positional arguments to send to the actor.
**kwargs(dict): Keyword arguments ... | [
"def",
"message",
"(",
"self",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"return",
"self",
".",
"message_with_options",
"(",
"args",
"=",
"args",
",",
"kwargs",
"=",
"kwargs",
")"
] | Build a message. This method is useful if you want to
compose actors. See the actor composition documentation for
details.
Parameters:
*args(tuple): Positional arguments to send to the actor.
**kwargs(dict): Keyword arguments to send to the actor.
Examples:
... | [
"Build",
"a",
"message",
".",
"This",
"method",
"is",
"useful",
"if",
"you",
"want",
"to",
"compose",
"actors",
".",
"See",
"the",
"actor",
"composition",
"documentation",
"for",
"details",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/actor.py#L54-L70 |
227,257 | Bogdanp/dramatiq | dramatiq/actor.py | Actor.message_with_options | def message_with_options(self, *, args=None, kwargs=None, **options):
"""Build a message with an arbitray set of processing options.
This method is useful if you want to compose actors. See the
actor composition documentation for details.
Parameters:
args(tuple): Positional a... | python | def message_with_options(self, *, args=None, kwargs=None, **options):
"""Build a message with an arbitray set of processing options.
This method is useful if you want to compose actors. See the
actor composition documentation for details.
Parameters:
args(tuple): Positional a... | [
"def",
"message_with_options",
"(",
"self",
",",
"*",
",",
"args",
"=",
"None",
",",
"kwargs",
"=",
"None",
",",
"*",
"*",
"options",
")",
":",
"for",
"name",
"in",
"[",
"\"on_failure\"",
",",
"\"on_success\"",
"]",
":",
"callback",
"=",
"options",
"."... | Build a message with an arbitray set of processing options.
This method is useful if you want to compose actors. See the
actor composition documentation for details.
Parameters:
args(tuple): Positional arguments that are passed to the actor.
kwargs(dict): Keyword arguments ... | [
"Build",
"a",
"message",
"with",
"an",
"arbitray",
"set",
"of",
"processing",
"options",
".",
"This",
"method",
"is",
"useful",
"if",
"you",
"want",
"to",
"compose",
"actors",
".",
"See",
"the",
"actor",
"composition",
"documentation",
"for",
"details",
"."
... | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/actor.py#L72-L99 |
227,258 | Bogdanp/dramatiq | dramatiq/actor.py | Actor.send | def send(self, *args, **kwargs):
"""Asynchronously send a message to this actor.
Parameters:
*args(tuple): Positional arguments to send to the actor.
**kwargs(dict): Keyword arguments to send to the actor.
Returns:
Message: The enqueued message.
"""
... | python | def send(self, *args, **kwargs):
"""Asynchronously send a message to this actor.
Parameters:
*args(tuple): Positional arguments to send to the actor.
**kwargs(dict): Keyword arguments to send to the actor.
Returns:
Message: The enqueued message.
"""
... | [
"def",
"send",
"(",
"self",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"return",
"self",
".",
"send_with_options",
"(",
"args",
"=",
"args",
",",
"kwargs",
"=",
"kwargs",
")"
] | Asynchronously send a message to this actor.
Parameters:
*args(tuple): Positional arguments to send to the actor.
**kwargs(dict): Keyword arguments to send to the actor.
Returns:
Message: The enqueued message. | [
"Asynchronously",
"send",
"a",
"message",
"to",
"this",
"actor",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/actor.py#L101-L111 |
227,259 | Bogdanp/dramatiq | dramatiq/actor.py | Actor.send_with_options | def send_with_options(self, *, args=None, kwargs=None, delay=None, **options):
"""Asynchronously send a message to this actor, along with an
arbitrary set of processing options for the broker and
middleware.
Parameters:
args(tuple): Positional arguments that are passed to the ... | python | def send_with_options(self, *, args=None, kwargs=None, delay=None, **options):
"""Asynchronously send a message to this actor, along with an
arbitrary set of processing options for the broker and
middleware.
Parameters:
args(tuple): Positional arguments that are passed to the ... | [
"def",
"send_with_options",
"(",
"self",
",",
"*",
",",
"args",
"=",
"None",
",",
"kwargs",
"=",
"None",
",",
"delay",
"=",
"None",
",",
"*",
"*",
"options",
")",
":",
"message",
"=",
"self",
".",
"message_with_options",
"(",
"args",
"=",
"args",
","... | Asynchronously send a message to this actor, along with an
arbitrary set of processing options for the broker and
middleware.
Parameters:
args(tuple): Positional arguments that are passed to the actor.
kwargs(dict): Keyword arguments that are passed to the actor.
d... | [
"Asynchronously",
"send",
"a",
"message",
"to",
"this",
"actor",
"along",
"with",
"an",
"arbitrary",
"set",
"of",
"processing",
"options",
"for",
"the",
"broker",
"and",
"middleware",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/actor.py#L113-L130 |
227,260 | Bogdanp/dramatiq | dramatiq/worker.py | Worker.start | def start(self):
"""Initialize the worker boot sequence and start up all the
worker threads.
"""
self.broker.emit_before("worker_boot", self)
worker_middleware = _WorkerMiddleware(self)
self.broker.add_middleware(worker_middleware)
for _ in range(self.worker_thre... | python | def start(self):
"""Initialize the worker boot sequence and start up all the
worker threads.
"""
self.broker.emit_before("worker_boot", self)
worker_middleware = _WorkerMiddleware(self)
self.broker.add_middleware(worker_middleware)
for _ in range(self.worker_thre... | [
"def",
"start",
"(",
"self",
")",
":",
"self",
".",
"broker",
".",
"emit_before",
"(",
"\"worker_boot\"",
",",
"self",
")",
"worker_middleware",
"=",
"_WorkerMiddleware",
"(",
"self",
")",
"self",
".",
"broker",
".",
"add_middleware",
"(",
"worker_middleware",... | Initialize the worker boot sequence and start up all the
worker threads. | [
"Initialize",
"the",
"worker",
"boot",
"sequence",
"and",
"start",
"up",
"all",
"the",
"worker",
"threads",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/worker.py#L80-L91 |
227,261 | Bogdanp/dramatiq | dramatiq/worker.py | Worker.pause | def pause(self):
"""Pauses all the worker threads.
"""
for child in chain(self.consumers.values(), self.workers):
child.pause()
for child in chain(self.consumers.values(), self.workers):
child.paused_event.wait() | python | def pause(self):
"""Pauses all the worker threads.
"""
for child in chain(self.consumers.values(), self.workers):
child.pause()
for child in chain(self.consumers.values(), self.workers):
child.paused_event.wait() | [
"def",
"pause",
"(",
"self",
")",
":",
"for",
"child",
"in",
"chain",
"(",
"self",
".",
"consumers",
".",
"values",
"(",
")",
",",
"self",
".",
"workers",
")",
":",
"child",
".",
"pause",
"(",
")",
"for",
"child",
"in",
"chain",
"(",
"self",
".",... | Pauses all the worker threads. | [
"Pauses",
"all",
"the",
"worker",
"threads",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/worker.py#L93-L100 |
227,262 | Bogdanp/dramatiq | dramatiq/worker.py | Worker.resume | def resume(self):
"""Resumes all the worker threads.
"""
for child in chain(self.consumers.values(), self.workers):
child.resume() | python | def resume(self):
"""Resumes all the worker threads.
"""
for child in chain(self.consumers.values(), self.workers):
child.resume() | [
"def",
"resume",
"(",
"self",
")",
":",
"for",
"child",
"in",
"chain",
"(",
"self",
".",
"consumers",
".",
"values",
"(",
")",
",",
"self",
".",
"workers",
")",
":",
"child",
".",
"resume",
"(",
")"
] | Resumes all the worker threads. | [
"Resumes",
"all",
"the",
"worker",
"threads",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/worker.py#L102-L106 |
227,263 | Bogdanp/dramatiq | dramatiq/worker.py | Worker.stop | def stop(self, timeout=600000):
"""Gracefully stop the Worker and all of its consumers and
workers.
Parameters:
timeout(int): The number of milliseconds to wait for
everything to shut down.
"""
self.broker.emit_before("worker_shutdown", self)
self.l... | python | def stop(self, timeout=600000):
"""Gracefully stop the Worker and all of its consumers and
workers.
Parameters:
timeout(int): The number of milliseconds to wait for
everything to shut down.
"""
self.broker.emit_before("worker_shutdown", self)
self.l... | [
"def",
"stop",
"(",
"self",
",",
"timeout",
"=",
"600000",
")",
":",
"self",
".",
"broker",
".",
"emit_before",
"(",
"\"worker_shutdown\"",
",",
"self",
")",
"self",
".",
"logger",
".",
"info",
"(",
"\"Shutting down...\"",
")",
"# Stop workers before consumers... | Gracefully stop the Worker and all of its consumers and
workers.
Parameters:
timeout(int): The number of milliseconds to wait for
everything to shut down. | [
"Gracefully",
"stop",
"the",
"Worker",
"and",
"all",
"of",
"its",
"consumers",
"and",
"workers",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/worker.py#L108-L153 |
227,264 | Bogdanp/dramatiq | dramatiq/worker.py | Worker.join | def join(self):
"""Wait for this worker to complete its work in progress.
This method is useful when testing code.
"""
while True:
for consumer in self.consumers.values():
consumer.delay_queue.join()
self.work_queue.join()
# If nothin... | python | def join(self):
"""Wait for this worker to complete its work in progress.
This method is useful when testing code.
"""
while True:
for consumer in self.consumers.values():
consumer.delay_queue.join()
self.work_queue.join()
# If nothin... | [
"def",
"join",
"(",
"self",
")",
":",
"while",
"True",
":",
"for",
"consumer",
"in",
"self",
".",
"consumers",
".",
"values",
"(",
")",
":",
"consumer",
".",
"delay_queue",
".",
"join",
"(",
")",
"self",
".",
"work_queue",
".",
"join",
"(",
")",
"#... | Wait for this worker to complete its work in progress.
This method is useful when testing code. | [
"Wait",
"for",
"this",
"worker",
"to",
"complete",
"its",
"work",
"in",
"progress",
".",
"This",
"method",
"is",
"useful",
"when",
"testing",
"code",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/worker.py#L155-L174 |
227,265 | Bogdanp/dramatiq | dramatiq/worker.py | _ConsumerThread.handle_delayed_messages | def handle_delayed_messages(self):
"""Enqueue any delayed messages whose eta has passed.
"""
for eta, message in iter_queue(self.delay_queue):
if eta > current_millis():
self.delay_queue.put((eta, message))
self.delay_queue.task_done()
... | python | def handle_delayed_messages(self):
"""Enqueue any delayed messages whose eta has passed.
"""
for eta, message in iter_queue(self.delay_queue):
if eta > current_millis():
self.delay_queue.put((eta, message))
self.delay_queue.task_done()
... | [
"def",
"handle_delayed_messages",
"(",
"self",
")",
":",
"for",
"eta",
",",
"message",
"in",
"iter_queue",
"(",
"self",
".",
"delay_queue",
")",
":",
"if",
"eta",
">",
"current_millis",
"(",
")",
":",
"self",
".",
"delay_queue",
".",
"put",
"(",
"(",
"... | Enqueue any delayed messages whose eta has passed. | [
"Enqueue",
"any",
"delayed",
"messages",
"whose",
"eta",
"has",
"passed",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/worker.py#L285-L300 |
227,266 | Bogdanp/dramatiq | dramatiq/worker.py | _ConsumerThread.handle_message | def handle_message(self, message):
"""Handle a message received off of the underlying consumer.
If the message has an eta, delay it. Otherwise, put it on the
work queue.
"""
try:
if "eta" in message.options:
self.logger.debug("Pushing message %r onto ... | python | def handle_message(self, message):
"""Handle a message received off of the underlying consumer.
If the message has an eta, delay it. Otherwise, put it on the
work queue.
"""
try:
if "eta" in message.options:
self.logger.debug("Pushing message %r onto ... | [
"def",
"handle_message",
"(",
"self",
",",
"message",
")",
":",
"try",
":",
"if",
"\"eta\"",
"in",
"message",
".",
"options",
":",
"self",
".",
"logger",
".",
"debug",
"(",
"\"Pushing message %r onto delay queue.\"",
",",
"message",
".",
"message_id",
")",
"... | Handle a message received off of the underlying consumer.
If the message has an eta, delay it. Otherwise, put it on the
work queue. | [
"Handle",
"a",
"message",
"received",
"off",
"of",
"the",
"underlying",
"consumer",
".",
"If",
"the",
"message",
"has",
"an",
"eta",
"delay",
"it",
".",
"Otherwise",
"put",
"it",
"on",
"the",
"work",
"queue",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/worker.py#L302-L323 |
227,267 | Bogdanp/dramatiq | dramatiq/worker.py | _ConsumerThread.post_process_message | def post_process_message(self, message):
"""Called by worker threads whenever they're done processing
individual messages, signaling that each message is ready to
be acked or rejected.
"""
while True:
try:
if message.failed:
self.lo... | python | def post_process_message(self, message):
"""Called by worker threads whenever they're done processing
individual messages, signaling that each message is ready to
be acked or rejected.
"""
while True:
try:
if message.failed:
self.lo... | [
"def",
"post_process_message",
"(",
"self",
",",
"message",
")",
":",
"while",
"True",
":",
"try",
":",
"if",
"message",
".",
"failed",
":",
"self",
".",
"logger",
".",
"debug",
"(",
"\"Rejecting message %r.\"",
",",
"message",
".",
"message_id",
")",
"sel... | Called by worker threads whenever they're done processing
individual messages, signaling that each message is ready to
be acked or rejected. | [
"Called",
"by",
"worker",
"threads",
"whenever",
"they",
"re",
"done",
"processing",
"individual",
"messages",
"signaling",
"that",
"each",
"message",
"is",
"ready",
"to",
"be",
"acked",
"or",
"rejected",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/worker.py#L325-L373 |
227,268 | Bogdanp/dramatiq | dramatiq/worker.py | _ConsumerThread.close | def close(self):
"""Close this consumer thread and its underlying connection.
"""
try:
if self.consumer:
self.requeue_messages(m for _, m in iter_queue(self.delay_queue))
self.consumer.close()
except ConnectionError:
pass | python | def close(self):
"""Close this consumer thread and its underlying connection.
"""
try:
if self.consumer:
self.requeue_messages(m for _, m in iter_queue(self.delay_queue))
self.consumer.close()
except ConnectionError:
pass | [
"def",
"close",
"(",
"self",
")",
":",
"try",
":",
"if",
"self",
".",
"consumer",
":",
"self",
".",
"requeue_messages",
"(",
"m",
"for",
"_",
",",
"m",
"in",
"iter_queue",
"(",
"self",
".",
"delay_queue",
")",
")",
"self",
".",
"consumer",
".",
"cl... | Close this consumer thread and its underlying connection. | [
"Close",
"this",
"consumer",
"thread",
"and",
"its",
"underlying",
"connection",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/worker.py#L403-L411 |
227,269 | Bogdanp/dramatiq | dramatiq/worker.py | _WorkerThread.process_message | def process_message(self, message):
"""Process a message pulled off of the work queue then push it
back to its associated consumer for post processing.
Parameters:
message(MessageProxy)
"""
try:
self.logger.debug("Received message %s with id %r.", message, ... | python | def process_message(self, message):
"""Process a message pulled off of the work queue then push it
back to its associated consumer for post processing.
Parameters:
message(MessageProxy)
"""
try:
self.logger.debug("Received message %s with id %r.", message, ... | [
"def",
"process_message",
"(",
"self",
",",
"message",
")",
":",
"try",
":",
"self",
".",
"logger",
".",
"debug",
"(",
"\"Received message %s with id %r.\"",
",",
"message",
",",
"message",
".",
"message_id",
")",
"self",
".",
"broker",
".",
"emit_before",
"... | Process a message pulled off of the work queue then push it
back to its associated consumer for post processing.
Parameters:
message(MessageProxy) | [
"Process",
"a",
"message",
"pulled",
"off",
"of",
"the",
"work",
"queue",
"then",
"push",
"it",
"back",
"to",
"its",
"associated",
"consumer",
"for",
"post",
"processing",
"."
] | a8cc2728478e794952a5a50c3fb19ec455fe91b6 | https://github.com/Bogdanp/dramatiq/blob/a8cc2728478e794952a5a50c3fb19ec455fe91b6/dramatiq/worker.py#L456-L497 |
227,270 | github/octodns | octodns/manager.py | Manager.compare | def compare(self, a, b, zone):
'''
Compare zone data between 2 sources.
Note: only things supported by both sources will be considered
'''
self.log.info('compare: a=%s, b=%s, zone=%s', a, b, zone)
try:
a = [self.providers[source] for source in a]
... | python | def compare(self, a, b, zone):
'''
Compare zone data between 2 sources.
Note: only things supported by both sources will be considered
'''
self.log.info('compare: a=%s, b=%s, zone=%s', a, b, zone)
try:
a = [self.providers[source] for source in a]
... | [
"def",
"compare",
"(",
"self",
",",
"a",
",",
"b",
",",
"zone",
")",
":",
"self",
".",
"log",
".",
"info",
"(",
"'compare: a=%s, b=%s, zone=%s'",
",",
"a",
",",
"b",
",",
"zone",
")",
"try",
":",
"a",
"=",
"[",
"self",
".",
"providers",
"[",
"sou... | Compare zone data between 2 sources.
Note: only things supported by both sources will be considered | [
"Compare",
"zone",
"data",
"between",
"2",
"sources",
"."
] | 65ee60491e22e6bb0a2aa08f7069c6ecf6c3fee6 | https://github.com/github/octodns/blob/65ee60491e22e6bb0a2aa08f7069c6ecf6c3fee6/octodns/manager.py#L335-L358 |
227,271 | github/octodns | octodns/manager.py | Manager.dump | def dump(self, zone, output_dir, lenient, split, source, *sources):
'''
Dump zone data from the specified source
'''
self.log.info('dump: zone=%s, sources=%s', zone, sources)
# We broke out source to force at least one to be passed, add it to any
# others we got.
... | python | def dump(self, zone, output_dir, lenient, split, source, *sources):
'''
Dump zone data from the specified source
'''
self.log.info('dump: zone=%s, sources=%s', zone, sources)
# We broke out source to force at least one to be passed, add it to any
# others we got.
... | [
"def",
"dump",
"(",
"self",
",",
"zone",
",",
"output_dir",
",",
"lenient",
",",
"split",
",",
"source",
",",
"*",
"sources",
")",
":",
"self",
".",
"log",
".",
"info",
"(",
"'dump: zone=%s, sources=%s'",
",",
"zone",
",",
"sources",
")",
"# We broke out... | Dump zone data from the specified source | [
"Dump",
"zone",
"data",
"from",
"the",
"specified",
"source"
] | 65ee60491e22e6bb0a2aa08f7069c6ecf6c3fee6 | https://github.com/github/octodns/blob/65ee60491e22e6bb0a2aa08f7069c6ecf6c3fee6/octodns/manager.py#L360-L387 |
227,272 | github/octodns | octodns/provider/dyn.py | _CachingDynZone.flush_zone | def flush_zone(cls, zone_name):
'''Flushes the zone cache, if there is one'''
cls.log.debug('flush_zone: zone_name=%s', zone_name)
try:
del cls._cache[zone_name]
except KeyError:
pass | python | def flush_zone(cls, zone_name):
'''Flushes the zone cache, if there is one'''
cls.log.debug('flush_zone: zone_name=%s', zone_name)
try:
del cls._cache[zone_name]
except KeyError:
pass | [
"def",
"flush_zone",
"(",
"cls",
",",
"zone_name",
")",
":",
"cls",
".",
"log",
".",
"debug",
"(",
"'flush_zone: zone_name=%s'",
",",
"zone_name",
")",
"try",
":",
"del",
"cls",
".",
"_cache",
"[",
"zone_name",
"]",
"except",
"KeyError",
":",
"pass"
] | Flushes the zone cache, if there is one | [
"Flushes",
"the",
"zone",
"cache",
"if",
"there",
"is",
"one"
] | 65ee60491e22e6bb0a2aa08f7069c6ecf6c3fee6 | https://github.com/github/octodns/blob/65ee60491e22e6bb0a2aa08f7069c6ecf6c3fee6/octodns/provider/dyn.py#L156-L162 |
227,273 | github/octodns | octodns/provider/azuredns.py | AzureProvider._check_zone | def _check_zone(self, name, create=False):
'''Checks whether a zone specified in a source exist in Azure server.
Note that Azure zones omit end '.' eg: contoso.com vs contoso.com.
Returns the name if it exists.
:param name: Name of a zone to checks
:type name: ... | python | def _check_zone(self, name, create=False):
'''Checks whether a zone specified in a source exist in Azure server.
Note that Azure zones omit end '.' eg: contoso.com vs contoso.com.
Returns the name if it exists.
:param name: Name of a zone to checks
:type name: ... | [
"def",
"_check_zone",
"(",
"self",
",",
"name",
",",
"create",
"=",
"False",
")",
":",
"self",
".",
"log",
".",
"debug",
"(",
"'_check_zone: name=%s'",
",",
"name",
")",
"try",
":",
"if",
"name",
"in",
"self",
".",
"_azure_zones",
":",
"return",
"name"... | Checks whether a zone specified in a source exist in Azure server.
Note that Azure zones omit end '.' eg: contoso.com vs contoso.com.
Returns the name if it exists.
:param name: Name of a zone to checks
:type name: str
:param create: If True, creates the zo... | [
"Checks",
"whether",
"a",
"zone",
"specified",
"in",
"a",
"source",
"exist",
"in",
"Azure",
"server",
"."
] | 65ee60491e22e6bb0a2aa08f7069c6ecf6c3fee6 | https://github.com/github/octodns/blob/65ee60491e22e6bb0a2aa08f7069c6ecf6c3fee6/octodns/provider/azuredns.py#L306-L341 |
227,274 | github/octodns | octodns/provider/azuredns.py | AzureProvider._apply_Create | def _apply_Create(self, change):
'''A record from change must be created.
:param change: a change object
:type change: octodns.record.Change
:type return: void
'''
ar = _AzureRecord(self._resource_group, change.new)
create = self._dns_client.record_... | python | def _apply_Create(self, change):
'''A record from change must be created.
:param change: a change object
:type change: octodns.record.Change
:type return: void
'''
ar = _AzureRecord(self._resource_group, change.new)
create = self._dns_client.record_... | [
"def",
"_apply_Create",
"(",
"self",
",",
"change",
")",
":",
"ar",
"=",
"_AzureRecord",
"(",
"self",
".",
"_resource_group",
",",
"change",
".",
"new",
")",
"create",
"=",
"self",
".",
"_dns_client",
".",
"record_sets",
".",
"create_or_update",
"create",
... | A record from change must be created.
:param change: a change object
:type change: octodns.record.Change
:type return: void | [
"A",
"record",
"from",
"change",
"must",
"be",
"created",
"."
] | 65ee60491e22e6bb0a2aa08f7069c6ecf6c3fee6 | https://github.com/github/octodns/blob/65ee60491e22e6bb0a2aa08f7069c6ecf6c3fee6/octodns/provider/azuredns.py#L450-L467 |
227,275 | github/octodns | octodns/provider/base.py | BaseProvider.apply | def apply(self, plan):
'''
Submits actual planned changes to the provider. Returns the number of
changes made
'''
if self.apply_disabled:
self.log.info('apply: disabled')
return 0
self.log.info('apply: making changes')
self._apply(plan)
... | python | def apply(self, plan):
'''
Submits actual planned changes to the provider. Returns the number of
changes made
'''
if self.apply_disabled:
self.log.info('apply: disabled')
return 0
self.log.info('apply: making changes')
self._apply(plan)
... | [
"def",
"apply",
"(",
"self",
",",
"plan",
")",
":",
"if",
"self",
".",
"apply_disabled",
":",
"self",
".",
"log",
".",
"info",
"(",
"'apply: disabled'",
")",
"return",
"0",
"self",
".",
"log",
".",
"info",
"(",
"'apply: making changes'",
")",
"self",
"... | Submits actual planned changes to the provider. Returns the number of
changes made | [
"Submits",
"actual",
"planned",
"changes",
"to",
"the",
"provider",
".",
"Returns",
"the",
"number",
"of",
"changes",
"made"
] | 65ee60491e22e6bb0a2aa08f7069c6ecf6c3fee6 | https://github.com/github/octodns/blob/65ee60491e22e6bb0a2aa08f7069c6ecf6c3fee6/octodns/provider/base.py#L83-L94 |
227,276 | github/octodns | octodns/provider/ovh.py | OvhProvider._is_valid_dkim | def _is_valid_dkim(self, value):
"""Check if value is a valid DKIM"""
validator_dict = {'h': lambda val: val in ['sha1', 'sha256'],
's': lambda val: val in ['*', 'email'],
't': lambda val: val in ['y', 's'],
'v': lambda val: v... | python | def _is_valid_dkim(self, value):
"""Check if value is a valid DKIM"""
validator_dict = {'h': lambda val: val in ['sha1', 'sha256'],
's': lambda val: val in ['*', 'email'],
't': lambda val: val in ['y', 's'],
'v': lambda val: v... | [
"def",
"_is_valid_dkim",
"(",
"self",
",",
"value",
")",
":",
"validator_dict",
"=",
"{",
"'h'",
":",
"lambda",
"val",
":",
"val",
"in",
"[",
"'sha1'",
",",
"'sha256'",
"]",
",",
"'s'",
":",
"lambda",
"val",
":",
"val",
"in",
"[",
"'*'",
",",
"'ema... | Check if value is a valid DKIM | [
"Check",
"if",
"value",
"is",
"a",
"valid",
"DKIM"
] | 65ee60491e22e6bb0a2aa08f7069c6ecf6c3fee6 | https://github.com/github/octodns/blob/65ee60491e22e6bb0a2aa08f7069c6ecf6c3fee6/octodns/provider/ovh.py#L315-L341 |
227,277 | github/octodns | octodns/provider/googlecloud.py | GoogleCloudProvider._get_gcloud_records | def _get_gcloud_records(self, gcloud_zone, page_token=None):
""" Generator function which yields ResourceRecordSet for the managed
gcloud zone, until there are no more records to pull.
:param gcloud_zone: zone to pull records from
:type gcloud_zone: google.cloud.dns.ManagedZ... | python | def _get_gcloud_records(self, gcloud_zone, page_token=None):
""" Generator function which yields ResourceRecordSet for the managed
gcloud zone, until there are no more records to pull.
:param gcloud_zone: zone to pull records from
:type gcloud_zone: google.cloud.dns.ManagedZ... | [
"def",
"_get_gcloud_records",
"(",
"self",
",",
"gcloud_zone",
",",
"page_token",
"=",
"None",
")",
":",
"gcloud_iterator",
"=",
"gcloud_zone",
".",
"list_resource_record_sets",
"(",
"page_token",
"=",
"page_token",
")",
"for",
"gcloud_record",
"in",
"gcloud_iterato... | Generator function which yields ResourceRecordSet for the managed
gcloud zone, until there are no more records to pull.
:param gcloud_zone: zone to pull records from
:type gcloud_zone: google.cloud.dns.ManagedZone
:param page_token: page token for the page to get
... | [
"Generator",
"function",
"which",
"yields",
"ResourceRecordSet",
"for",
"the",
"managed",
"gcloud",
"zone",
"until",
"there",
"are",
"no",
"more",
"records",
"to",
"pull",
"."
] | 65ee60491e22e6bb0a2aa08f7069c6ecf6c3fee6 | https://github.com/github/octodns/blob/65ee60491e22e6bb0a2aa08f7069c6ecf6c3fee6/octodns/provider/googlecloud.py#L150-L171 |
227,278 | github/octodns | octodns/provider/googlecloud.py | GoogleCloudProvider._get_cloud_zones | def _get_cloud_zones(self, page_token=None):
"""Load all ManagedZones into the self._gcloud_zones dict which is
mapped with the dns_name as key.
:return: void
"""
gcloud_zones = self.gcloud_client.list_zones(page_token=page_token)
for gcloud_zone in gcloud_zones:
... | python | def _get_cloud_zones(self, page_token=None):
"""Load all ManagedZones into the self._gcloud_zones dict which is
mapped with the dns_name as key.
:return: void
"""
gcloud_zones = self.gcloud_client.list_zones(page_token=page_token)
for gcloud_zone in gcloud_zones:
... | [
"def",
"_get_cloud_zones",
"(",
"self",
",",
"page_token",
"=",
"None",
")",
":",
"gcloud_zones",
"=",
"self",
".",
"gcloud_client",
".",
"list_zones",
"(",
"page_token",
"=",
"page_token",
")",
"for",
"gcloud_zone",
"in",
"gcloud_zones",
":",
"self",
".",
"... | Load all ManagedZones into the self._gcloud_zones dict which is
mapped with the dns_name as key.
:return: void | [
"Load",
"all",
"ManagedZones",
"into",
"the",
"self",
".",
"_gcloud_zones",
"dict",
"which",
"is",
"mapped",
"with",
"the",
"dns_name",
"as",
"key",
"."
] | 65ee60491e22e6bb0a2aa08f7069c6ecf6c3fee6 | https://github.com/github/octodns/blob/65ee60491e22e6bb0a2aa08f7069c6ecf6c3fee6/octodns/provider/googlecloud.py#L173-L185 |
227,279 | nabla-c0d3/sslyze | sslyze/plugins/robot_plugin.py | RobotTlsRecordPayloads.get_client_key_exchange_record | def get_client_key_exchange_record(
cls,
robot_payload_enum: RobotPmsPaddingPayloadEnum,
tls_version: TlsVersionEnum,
modulus: int,
exponent: int
) -> TlsRsaClientKeyExchangeRecord:
"""A client key exchange record with a hardcoded pre_master_secret... | python | def get_client_key_exchange_record(
cls,
robot_payload_enum: RobotPmsPaddingPayloadEnum,
tls_version: TlsVersionEnum,
modulus: int,
exponent: int
) -> TlsRsaClientKeyExchangeRecord:
"""A client key exchange record with a hardcoded pre_master_secret... | [
"def",
"get_client_key_exchange_record",
"(",
"cls",
",",
"robot_payload_enum",
":",
"RobotPmsPaddingPayloadEnum",
",",
"tls_version",
":",
"TlsVersionEnum",
",",
"modulus",
":",
"int",
",",
"exponent",
":",
"int",
")",
"->",
"TlsRsaClientKeyExchangeRecord",
":",
"pms... | A client key exchange record with a hardcoded pre_master_secret, and a valid or invalid padding. | [
"A",
"client",
"key",
"exchange",
"record",
"with",
"a",
"hardcoded",
"pre_master_secret",
"and",
"a",
"valid",
"or",
"invalid",
"padding",
"."
] | 0fb3ae668453d7ecf616d0755f237ca7be9f62fa | https://github.com/nabla-c0d3/sslyze/blob/0fb3ae668453d7ecf616d0755f237ca7be9f62fa/sslyze/plugins/robot_plugin.py#L71-L90 |
227,280 | nabla-c0d3/sslyze | sslyze/plugins/robot_plugin.py | RobotTlsRecordPayloads.get_finished_record_bytes | def get_finished_record_bytes(cls, tls_version: TlsVersionEnum) -> bytes:
"""The Finished TLS record corresponding to the hardcoded PMS used in the Client Key Exchange record.
"""
# TODO(AD): The ROBOT poc script uses the same Finished record for all possible client hello (default, GCM,
... | python | def get_finished_record_bytes(cls, tls_version: TlsVersionEnum) -> bytes:
"""The Finished TLS record corresponding to the hardcoded PMS used in the Client Key Exchange record.
"""
# TODO(AD): The ROBOT poc script uses the same Finished record for all possible client hello (default, GCM,
... | [
"def",
"get_finished_record_bytes",
"(",
"cls",
",",
"tls_version",
":",
"TlsVersionEnum",
")",
"->",
"bytes",
":",
"# TODO(AD): The ROBOT poc script uses the same Finished record for all possible client hello (default, GCM,",
"# etc.); as the Finished record contains a hashes of all previ... | The Finished TLS record corresponding to the hardcoded PMS used in the Client Key Exchange record. | [
"The",
"Finished",
"TLS",
"record",
"corresponding",
"to",
"the",
"hardcoded",
"PMS",
"used",
"in",
"the",
"Client",
"Key",
"Exchange",
"record",
"."
] | 0fb3ae668453d7ecf616d0755f237ca7be9f62fa | https://github.com/nabla-c0d3/sslyze/blob/0fb3ae668453d7ecf616d0755f237ca7be9f62fa/sslyze/plugins/robot_plugin.py#L109-L116 |
227,281 | nabla-c0d3/sslyze | sslyze/plugins/robot_plugin.py | RobotServerResponsesAnalyzer.compute_result_enum | def compute_result_enum(self) -> RobotScanResultEnum:
"""Look at the server's response to each ROBOT payload and return the conclusion of the analysis.
"""
# Ensure the results were consistent
for payload_enum, server_responses in self._payload_responses.items():
# We ran the... | python | def compute_result_enum(self) -> RobotScanResultEnum:
"""Look at the server's response to each ROBOT payload and return the conclusion of the analysis.
"""
# Ensure the results were consistent
for payload_enum, server_responses in self._payload_responses.items():
# We ran the... | [
"def",
"compute_result_enum",
"(",
"self",
")",
"->",
"RobotScanResultEnum",
":",
"# Ensure the results were consistent",
"for",
"payload_enum",
",",
"server_responses",
"in",
"self",
".",
"_payload_responses",
".",
"items",
"(",
")",
":",
"# We ran the check twice per pa... | Look at the server's response to each ROBOT payload and return the conclusion of the analysis. | [
"Look",
"at",
"the",
"server",
"s",
"response",
"to",
"each",
"ROBOT",
"payload",
"and",
"return",
"the",
"conclusion",
"of",
"the",
"analysis",
"."
] | 0fb3ae668453d7ecf616d0755f237ca7be9f62fa | https://github.com/nabla-c0d3/sslyze/blob/0fb3ae668453d7ecf616d0755f237ca7be9f62fa/sslyze/plugins/robot_plugin.py#L135-L164 |
227,282 | nabla-c0d3/sslyze | sslyze/plugins/utils/trust_store/trust_store.py | TrustStore.is_extended_validation | def is_extended_validation(self, certificate: Certificate) -> bool:
"""Is the supplied server certificate EV?
"""
if not self.ev_oids:
raise ValueError('No EV OIDs supplied for {} store - cannot detect EV certificates'.format(self.name))
try:
cert_policies_ext = ... | python | def is_extended_validation(self, certificate: Certificate) -> bool:
"""Is the supplied server certificate EV?
"""
if not self.ev_oids:
raise ValueError('No EV OIDs supplied for {} store - cannot detect EV certificates'.format(self.name))
try:
cert_policies_ext = ... | [
"def",
"is_extended_validation",
"(",
"self",
",",
"certificate",
":",
"Certificate",
")",
"->",
"bool",
":",
"if",
"not",
"self",
".",
"ev_oids",
":",
"raise",
"ValueError",
"(",
"'No EV OIDs supplied for {} store - cannot detect EV certificates'",
".",
"format",
"("... | Is the supplied server certificate EV? | [
"Is",
"the",
"supplied",
"server",
"certificate",
"EV?"
] | 0fb3ae668453d7ecf616d0755f237ca7be9f62fa | https://github.com/nabla-c0d3/sslyze/blob/0fb3ae668453d7ecf616d0755f237ca7be9f62fa/sslyze/plugins/utils/trust_store/trust_store.py#L58-L72 |
227,283 | nabla-c0d3/sslyze | sslyze/synchronous_scanner.py | SynchronousScanner.run_scan_command | def run_scan_command(
self,
server_info: ServerConnectivityInfo,
scan_command: PluginScanCommand
) -> PluginScanResult:
"""Run a single scan command against a server; will block until the scan command has been completed.
Args:
server_info: The server'... | python | def run_scan_command(
self,
server_info: ServerConnectivityInfo,
scan_command: PluginScanCommand
) -> PluginScanResult:
"""Run a single scan command against a server; will block until the scan command has been completed.
Args:
server_info: The server'... | [
"def",
"run_scan_command",
"(",
"self",
",",
"server_info",
":",
"ServerConnectivityInfo",
",",
"scan_command",
":",
"PluginScanCommand",
")",
"->",
"PluginScanResult",
":",
"plugin_class",
"=",
"self",
".",
"_plugins_repository",
".",
"get_plugin_class_for_command",
"(... | Run a single scan command against a server; will block until the scan command has been completed.
Args:
server_info: The server's connectivity information. The test_connectivity_to_server() method must have been
called first to ensure that the server is online and accessible.
... | [
"Run",
"a",
"single",
"scan",
"command",
"against",
"a",
"server",
";",
"will",
"block",
"until",
"the",
"scan",
"command",
"has",
"been",
"completed",
"."
] | 0fb3ae668453d7ecf616d0755f237ca7be9f62fa | https://github.com/nabla-c0d3/sslyze/blob/0fb3ae668453d7ecf616d0755f237ca7be9f62fa/sslyze/synchronous_scanner.py#L32-L50 |
227,284 | nabla-c0d3/sslyze | sslyze/plugins/utils/trust_store/trust_store_repository.py | TrustStoresRepository.update_default | def update_default(cls) -> 'TrustStoresRepository':
"""Update the default trust stores used by SSLyze.
The latest stores will be downloaded from https://github.com/nabla-c0d3/trust_stores_observatory.
"""
temp_path = mkdtemp()
try:
# Download the latest trust stores
... | python | def update_default(cls) -> 'TrustStoresRepository':
"""Update the default trust stores used by SSLyze.
The latest stores will be downloaded from https://github.com/nabla-c0d3/trust_stores_observatory.
"""
temp_path = mkdtemp()
try:
# Download the latest trust stores
... | [
"def",
"update_default",
"(",
"cls",
")",
"->",
"'TrustStoresRepository'",
":",
"temp_path",
"=",
"mkdtemp",
"(",
")",
"try",
":",
"# Download the latest trust stores",
"archive_path",
"=",
"join",
"(",
"temp_path",
",",
"'trust_stores_as_pem.tar.gz'",
")",
"urlretrie... | Update the default trust stores used by SSLyze.
The latest stores will be downloaded from https://github.com/nabla-c0d3/trust_stores_observatory. | [
"Update",
"the",
"default",
"trust",
"stores",
"used",
"by",
"SSLyze",
"."
] | 0fb3ae668453d7ecf616d0755f237ca7be9f62fa | https://github.com/nabla-c0d3/sslyze/blob/0fb3ae668453d7ecf616d0755f237ca7be9f62fa/sslyze/plugins/utils/trust_store/trust_store_repository.py#L123-L146 |
227,285 | nabla-c0d3/sslyze | sslyze/plugins/openssl_cipher_suites_plugin.py | OpenSslCipherSuitesPlugin._get_preferred_cipher_suite | def _get_preferred_cipher_suite(
cls,
server_connectivity_info: ServerConnectivityInfo,
ssl_version: OpenSslVersionEnum,
accepted_cipher_list: List['AcceptedCipherSuite']
) -> Optional['AcceptedCipherSuite']:
"""Try to detect the server's preferred cipher suit... | python | def _get_preferred_cipher_suite(
cls,
server_connectivity_info: ServerConnectivityInfo,
ssl_version: OpenSslVersionEnum,
accepted_cipher_list: List['AcceptedCipherSuite']
) -> Optional['AcceptedCipherSuite']:
"""Try to detect the server's preferred cipher suit... | [
"def",
"_get_preferred_cipher_suite",
"(",
"cls",
",",
"server_connectivity_info",
":",
"ServerConnectivityInfo",
",",
"ssl_version",
":",
"OpenSslVersionEnum",
",",
"accepted_cipher_list",
":",
"List",
"[",
"'AcceptedCipherSuite'",
"]",
")",
"->",
"Optional",
"[",
"'Ac... | Try to detect the server's preferred cipher suite among all cipher suites supported by SSLyze. | [
"Try",
"to",
"detect",
"the",
"server",
"s",
"preferred",
"cipher",
"suite",
"among",
"all",
"cipher",
"suites",
"supported",
"by",
"SSLyze",
"."
] | 0fb3ae668453d7ecf616d0755f237ca7be9f62fa | https://github.com/nabla-c0d3/sslyze/blob/0fb3ae668453d7ecf616d0755f237ca7be9f62fa/sslyze/plugins/openssl_cipher_suites_plugin.py#L283-L330 |
227,286 | nabla-c0d3/sslyze | sslyze/plugins/openssl_cipher_suites_plugin.py | CipherSuite.name | def name(self) -> str:
"""OpenSSL uses a different naming convention than the corresponding RFCs.
"""
return OPENSSL_TO_RFC_NAMES_MAPPING[self.ssl_version].get(self.openssl_name, self.openssl_name) | python | def name(self) -> str:
"""OpenSSL uses a different naming convention than the corresponding RFCs.
"""
return OPENSSL_TO_RFC_NAMES_MAPPING[self.ssl_version].get(self.openssl_name, self.openssl_name) | [
"def",
"name",
"(",
"self",
")",
"->",
"str",
":",
"return",
"OPENSSL_TO_RFC_NAMES_MAPPING",
"[",
"self",
".",
"ssl_version",
"]",
".",
"get",
"(",
"self",
".",
"openssl_name",
",",
"self",
".",
"openssl_name",
")"
] | OpenSSL uses a different naming convention than the corresponding RFCs. | [
"OpenSSL",
"uses",
"a",
"different",
"naming",
"convention",
"than",
"the",
"corresponding",
"RFCs",
"."
] | 0fb3ae668453d7ecf616d0755f237ca7be9f62fa | https://github.com/nabla-c0d3/sslyze/blob/0fb3ae668453d7ecf616d0755f237ca7be9f62fa/sslyze/plugins/openssl_cipher_suites_plugin.py#L366-L369 |
227,287 | nabla-c0d3/sslyze | sslyze/concurrent_scanner.py | ConcurrentScanner.queue_scan_command | def queue_scan_command(self, server_info: ServerConnectivityInfo, scan_command: PluginScanCommand) -> None:
"""Queue a scan command targeting a specific server.
Args:
server_info: The server's connectivity information. The test_connectivity_to_server() method must have been
... | python | def queue_scan_command(self, server_info: ServerConnectivityInfo, scan_command: PluginScanCommand) -> None:
"""Queue a scan command targeting a specific server.
Args:
server_info: The server's connectivity information. The test_connectivity_to_server() method must have been
... | [
"def",
"queue_scan_command",
"(",
"self",
",",
"server_info",
":",
"ServerConnectivityInfo",
",",
"scan_command",
":",
"PluginScanCommand",
")",
"->",
"None",
":",
"# Ensure we have the right processes and queues in place for this hostname",
"self",
".",
"_check_and_create_proc... | Queue a scan command targeting a specific server.
Args:
server_info: The server's connectivity information. The test_connectivity_to_server() method must have been
called first to ensure that the server is online and accessible.
scan_command: The scan command to run agai... | [
"Queue",
"a",
"scan",
"command",
"targeting",
"a",
"specific",
"server",
"."
] | 0fb3ae668453d7ecf616d0755f237ca7be9f62fa | https://github.com/nabla-c0d3/sslyze/blob/0fb3ae668453d7ecf616d0755f237ca7be9f62fa/sslyze/concurrent_scanner.py#L83-L102 |
227,288 | nabla-c0d3/sslyze | sslyze/concurrent_scanner.py | ConcurrentScanner.get_results | def get_results(self) -> Iterable[PluginScanResult]:
"""Return the result of previously queued scan commands; new commands cannot be queued once this is called.
Returns:
The results of all the scan commands previously queued. Each result will be an instance of the scan
correspon... | python | def get_results(self) -> Iterable[PluginScanResult]:
"""Return the result of previously queued scan commands; new commands cannot be queued once this is called.
Returns:
The results of all the scan commands previously queued. Each result will be an instance of the scan
correspon... | [
"def",
"get_results",
"(",
"self",
")",
"->",
"Iterable",
"[",
"PluginScanResult",
"]",
":",
"# Put a 'None' sentinel in the queue to let the each process know when every task has been completed",
"for",
"_",
"in",
"range",
"(",
"self",
".",
"_get_current_processes_nb",
"(",
... | Return the result of previously queued scan commands; new commands cannot be queued once this is called.
Returns:
The results of all the scan commands previously queued. Each result will be an instance of the scan
corresponding command's PluginScanResult subclass. If there was an unexpe... | [
"Return",
"the",
"result",
"of",
"previously",
"queued",
"scan",
"commands",
";",
"new",
"commands",
"cannot",
"be",
"queued",
"once",
"this",
"is",
"called",
"."
] | 0fb3ae668453d7ecf616d0755f237ca7be9f62fa | https://github.com/nabla-c0d3/sslyze/blob/0fb3ae668453d7ecf616d0755f237ca7be9f62fa/sslyze/concurrent_scanner.py#L135-L172 |
227,289 | nabla-c0d3/sslyze | sslyze/utils/worker_process.py | WorkerProcess.run | def run(self) -> None:
"""The process will first complete tasks it gets from self.queue_in.
Once it gets notified that all the tasks have been completed, it terminates.
"""
from sslyze.concurrent_scanner import PluginRaisedExceptionScanResult
# Start processing task in the prior... | python | def run(self) -> None:
"""The process will first complete tasks it gets from self.queue_in.
Once it gets notified that all the tasks have been completed, it terminates.
"""
from sslyze.concurrent_scanner import PluginRaisedExceptionScanResult
# Start processing task in the prior... | [
"def",
"run",
"(",
"self",
")",
"->",
"None",
":",
"from",
"sslyze",
".",
"concurrent_scanner",
"import",
"PluginRaisedExceptionScanResult",
"# Start processing task in the priority queue first",
"current_queue_in",
"=",
"self",
".",
"priority_queue_in",
"while",
"True",
... | The process will first complete tasks it gets from self.queue_in.
Once it gets notified that all the tasks have been completed, it terminates. | [
"The",
"process",
"will",
"first",
"complete",
"tasks",
"it",
"gets",
"from",
"self",
".",
"queue_in",
".",
"Once",
"it",
"gets",
"notified",
"that",
"all",
"the",
"tasks",
"have",
"been",
"completed",
"it",
"terminates",
"."
] | 0fb3ae668453d7ecf616d0755f237ca7be9f62fa | https://github.com/nabla-c0d3/sslyze/blob/0fb3ae668453d7ecf616d0755f237ca7be9f62fa/sslyze/utils/worker_process.py#L26-L58 |
227,290 | nabla-c0d3/sslyze | sslyze/utils/connection_helpers.py | ProxyTunnelingConnectionHelper.connect_socket | def connect_socket(self, sock: socket.socket) -> None:
"""Setup HTTP tunneling with the configured proxy.
"""
# Setup HTTP tunneling
try:
sock.connect((self._tunnel_host, self._tunnel_port))
except socket.timeout as e:
raise ProxyError(self.ERR_PROXY_OFFLI... | python | def connect_socket(self, sock: socket.socket) -> None:
"""Setup HTTP tunneling with the configured proxy.
"""
# Setup HTTP tunneling
try:
sock.connect((self._tunnel_host, self._tunnel_port))
except socket.timeout as e:
raise ProxyError(self.ERR_PROXY_OFFLI... | [
"def",
"connect_socket",
"(",
"self",
",",
"sock",
":",
"socket",
".",
"socket",
")",
"->",
"None",
":",
"# Setup HTTP tunneling",
"try",
":",
"sock",
".",
"connect",
"(",
"(",
"self",
".",
"_tunnel_host",
",",
"self",
".",
"_tunnel_port",
")",
")",
"exc... | Setup HTTP tunneling with the configured proxy. | [
"Setup",
"HTTP",
"tunneling",
"with",
"the",
"configured",
"proxy",
"."
] | 0fb3ae668453d7ecf616d0755f237ca7be9f62fa | https://github.com/nabla-c0d3/sslyze/blob/0fb3ae668453d7ecf616d0755f237ca7be9f62fa/sslyze/utils/connection_helpers.py#L63-L85 |
227,291 | nabla-c0d3/sslyze | sslyze/server_connectivity_info.py | ServerConnectivityInfo.get_preconfigured_ssl_connection | def get_preconfigured_ssl_connection(
self,
override_ssl_version: Optional[OpenSslVersionEnum] = None,
ssl_verify_locations: Optional[str] = None,
should_use_legacy_openssl: Optional[bool] = None,
) -> SslConnection:
"""Get an SSLConnection instance with the r... | python | def get_preconfigured_ssl_connection(
self,
override_ssl_version: Optional[OpenSslVersionEnum] = None,
ssl_verify_locations: Optional[str] = None,
should_use_legacy_openssl: Optional[bool] = None,
) -> SslConnection:
"""Get an SSLConnection instance with the r... | [
"def",
"get_preconfigured_ssl_connection",
"(",
"self",
",",
"override_ssl_version",
":",
"Optional",
"[",
"OpenSslVersionEnum",
"]",
"=",
"None",
",",
"ssl_verify_locations",
":",
"Optional",
"[",
"str",
"]",
"=",
"None",
",",
"should_use_legacy_openssl",
":",
"Opt... | Get an SSLConnection instance with the right SSL configuration for successfully connecting to the server.
Used by all plugins to connect to the server and run scans. | [
"Get",
"an",
"SSLConnection",
"instance",
"with",
"the",
"right",
"SSL",
"configuration",
"for",
"successfully",
"connecting",
"to",
"the",
"server",
"."
] | 0fb3ae668453d7ecf616d0755f237ca7be9f62fa | https://github.com/nabla-c0d3/sslyze/blob/0fb3ae668453d7ecf616d0755f237ca7be9f62fa/sslyze/server_connectivity_info.py#L70-L114 |
227,292 | nabla-c0d3/sslyze | sslyze/cli/command_line_parser.py | CommandLineParser._add_plugin_options | def _add_plugin_options(self, available_plugins: Set[Type[Plugin]]) -> None:
"""Recovers the list of command line options implemented by the available plugins and adds them to the command
line parser.
"""
for plugin_class in available_plugins:
# Add the current plugin's comma... | python | def _add_plugin_options(self, available_plugins: Set[Type[Plugin]]) -> None:
"""Recovers the list of command line options implemented by the available plugins and adds them to the command
line parser.
"""
for plugin_class in available_plugins:
# Add the current plugin's comma... | [
"def",
"_add_plugin_options",
"(",
"self",
",",
"available_plugins",
":",
"Set",
"[",
"Type",
"[",
"Plugin",
"]",
"]",
")",
"->",
"None",
":",
"for",
"plugin_class",
"in",
"available_plugins",
":",
"# Add the current plugin's commands to the parser",
"group",
"=",
... | Recovers the list of command line options implemented by the available plugins and adds them to the command
line parser. | [
"Recovers",
"the",
"list",
"of",
"command",
"line",
"options",
"implemented",
"by",
"the",
"available",
"plugins",
"and",
"adds",
"them",
"to",
"the",
"command",
"line",
"parser",
"."
] | 0fb3ae668453d7ecf616d0755f237ca7be9f62fa | https://github.com/nabla-c0d3/sslyze/blob/0fb3ae668453d7ecf616d0755f237ca7be9f62fa/sslyze/cli/command_line_parser.py#L428-L437 |
227,293 | nabla-c0d3/sslyze | setup.py | get_long_description | def get_long_description():
"""Convert the README file into the long description.
"""
with open(path.join(root_path, 'README.md'), encoding='utf-8') as f:
long_description = f.read()
return long_description | python | def get_long_description():
"""Convert the README file into the long description.
"""
with open(path.join(root_path, 'README.md'), encoding='utf-8') as f:
long_description = f.read()
return long_description | [
"def",
"get_long_description",
"(",
")",
":",
"with",
"open",
"(",
"path",
".",
"join",
"(",
"root_path",
",",
"'README.md'",
")",
",",
"encoding",
"=",
"'utf-8'",
")",
"as",
"f",
":",
"long_description",
"=",
"f",
".",
"read",
"(",
")",
"return",
"lon... | Convert the README file into the long description. | [
"Convert",
"the",
"README",
"file",
"into",
"the",
"long",
"description",
"."
] | 0fb3ae668453d7ecf616d0755f237ca7be9f62fa | https://github.com/nabla-c0d3/sslyze/blob/0fb3ae668453d7ecf616d0755f237ca7be9f62fa/setup.py#L23-L28 |
227,294 | nabla-c0d3/sslyze | setup.py | get_include_files | def get_include_files():
""""Get the list of trust stores so they properly packaged when doing a cx_freeze build.
"""
plugin_data_files = []
trust_stores_pem_path = path.join(root_path, 'sslyze', 'plugins', 'utils', 'trust_store', 'pem_files')
for file in listdir(trust_stores_pem_path):
file... | python | def get_include_files():
""""Get the list of trust stores so they properly packaged when doing a cx_freeze build.
"""
plugin_data_files = []
trust_stores_pem_path = path.join(root_path, 'sslyze', 'plugins', 'utils', 'trust_store', 'pem_files')
for file in listdir(trust_stores_pem_path):
file... | [
"def",
"get_include_files",
"(",
")",
":",
"plugin_data_files",
"=",
"[",
"]",
"trust_stores_pem_path",
"=",
"path",
".",
"join",
"(",
"root_path",
",",
"'sslyze'",
",",
"'plugins'",
",",
"'utils'",
",",
"'trust_store'",
",",
"'pem_files'",
")",
"for",
"file",... | Get the list of trust stores so they properly packaged when doing a cx_freeze build. | [
"Get",
"the",
"list",
"of",
"trust",
"stores",
"so",
"they",
"properly",
"packaged",
"when",
"doing",
"a",
"cx_freeze",
"build",
"."
] | 0fb3ae668453d7ecf616d0755f237ca7be9f62fa | https://github.com/nabla-c0d3/sslyze/blob/0fb3ae668453d7ecf616d0755f237ca7be9f62fa/setup.py#L31-L41 |
227,295 | nabla-c0d3/sslyze | sslyze/plugins/utils/certificate_utils.py | CertificateUtils.get_dns_subject_alternative_names | def get_dns_subject_alternative_names(certificate: cryptography.x509.Certificate) -> List[str]:
"""Retrieve all the DNS entries of the Subject Alternative Name extension.
"""
subj_alt_names: List[str] = []
try:
san_ext = certificate.extensions.get_extension_for_oid(ExtensionO... | python | def get_dns_subject_alternative_names(certificate: cryptography.x509.Certificate) -> List[str]:
"""Retrieve all the DNS entries of the Subject Alternative Name extension.
"""
subj_alt_names: List[str] = []
try:
san_ext = certificate.extensions.get_extension_for_oid(ExtensionO... | [
"def",
"get_dns_subject_alternative_names",
"(",
"certificate",
":",
"cryptography",
".",
"x509",
".",
"Certificate",
")",
"->",
"List",
"[",
"str",
"]",
":",
"subj_alt_names",
":",
"List",
"[",
"str",
"]",
"=",
"[",
"]",
"try",
":",
"san_ext",
"=",
"certi... | Retrieve all the DNS entries of the Subject Alternative Name extension. | [
"Retrieve",
"all",
"the",
"DNS",
"entries",
"of",
"the",
"Subject",
"Alternative",
"Name",
"extension",
"."
] | 0fb3ae668453d7ecf616d0755f237ca7be9f62fa | https://github.com/nabla-c0d3/sslyze/blob/0fb3ae668453d7ecf616d0755f237ca7be9f62fa/sslyze/plugins/utils/certificate_utils.py#L24-L33 |
227,296 | nabla-c0d3/sslyze | sslyze/plugins/utils/certificate_utils.py | CertificateUtils.matches_hostname | def matches_hostname(cls, certificate: cryptography.x509.Certificate, hostname: str) -> None:
"""Verify that the certificate was issued for the given hostname.
Raises:
CertificateError: If the certificate was not issued for the supplied hostname.
"""
# Extract the names from... | python | def matches_hostname(cls, certificate: cryptography.x509.Certificate, hostname: str) -> None:
"""Verify that the certificate was issued for the given hostname.
Raises:
CertificateError: If the certificate was not issued for the supplied hostname.
"""
# Extract the names from... | [
"def",
"matches_hostname",
"(",
"cls",
",",
"certificate",
":",
"cryptography",
".",
"x509",
".",
"Certificate",
",",
"hostname",
":",
"str",
")",
"->",
"None",
":",
"# Extract the names from the certificate to create the properly-formatted dictionary",
"certificate_names",... | Verify that the certificate was issued for the given hostname.
Raises:
CertificateError: If the certificate was not issued for the supplied hostname. | [
"Verify",
"that",
"the",
"certificate",
"was",
"issued",
"for",
"the",
"given",
"hostname",
"."
] | 0fb3ae668453d7ecf616d0755f237ca7be9f62fa | https://github.com/nabla-c0d3/sslyze/blob/0fb3ae668453d7ecf616d0755f237ca7be9f62fa/sslyze/plugins/utils/certificate_utils.py#L36-L48 |
227,297 | nabla-c0d3/sslyze | sslyze/plugins/utils/certificate_utils.py | CertificateUtils.get_name_as_short_text | def get_name_as_short_text(cls, name_field: cryptography.x509.Name) -> str:
"""Convert a name field returned by the cryptography module to a string suitable for displaying it to the user.
"""
# Name_field is supposed to be a Subject or an Issuer; print the CN if there is one
common_names... | python | def get_name_as_short_text(cls, name_field: cryptography.x509.Name) -> str:
"""Convert a name field returned by the cryptography module to a string suitable for displaying it to the user.
"""
# Name_field is supposed to be a Subject or an Issuer; print the CN if there is one
common_names... | [
"def",
"get_name_as_short_text",
"(",
"cls",
",",
"name_field",
":",
"cryptography",
".",
"x509",
".",
"Name",
")",
"->",
"str",
":",
"# Name_field is supposed to be a Subject or an Issuer; print the CN if there is one",
"common_names",
"=",
"cls",
".",
"get_common_names",
... | Convert a name field returned by the cryptography module to a string suitable for displaying it to the user. | [
"Convert",
"a",
"name",
"field",
"returned",
"by",
"the",
"cryptography",
"module",
"to",
"a",
"string",
"suitable",
"for",
"displaying",
"it",
"to",
"the",
"user",
"."
] | 0fb3ae668453d7ecf616d0755f237ca7be9f62fa | https://github.com/nabla-c0d3/sslyze/blob/0fb3ae668453d7ecf616d0755f237ca7be9f62fa/sslyze/plugins/utils/certificate_utils.py#L51-L61 |
227,298 | nabla-c0d3/sslyze | sslyze/plugins/utils/certificate_utils.py | CertificateUtils.has_ocsp_must_staple_extension | def has_ocsp_must_staple_extension(certificate: cryptography.x509.Certificate) -> bool:
"""Return True if the certificate has the OCSP Must-Staple extension defined in RFC 6066.
"""
has_ocsp_must_staple = False
try:
tls_feature_ext = certificate.extensions.get_extension_for_o... | python | def has_ocsp_must_staple_extension(certificate: cryptography.x509.Certificate) -> bool:
"""Return True if the certificate has the OCSP Must-Staple extension defined in RFC 6066.
"""
has_ocsp_must_staple = False
try:
tls_feature_ext = certificate.extensions.get_extension_for_o... | [
"def",
"has_ocsp_must_staple_extension",
"(",
"certificate",
":",
"cryptography",
".",
"x509",
".",
"Certificate",
")",
"->",
"bool",
":",
"has_ocsp_must_staple",
"=",
"False",
"try",
":",
"tls_feature_ext",
"=",
"certificate",
".",
"extensions",
".",
"get_extension... | Return True if the certificate has the OCSP Must-Staple extension defined in RFC 6066. | [
"Return",
"True",
"if",
"the",
"certificate",
"has",
"the",
"OCSP",
"Must",
"-",
"Staple",
"extension",
"defined",
"in",
"RFC",
"6066",
"."
] | 0fb3ae668453d7ecf616d0755f237ca7be9f62fa | https://github.com/nabla-c0d3/sslyze/blob/0fb3ae668453d7ecf616d0755f237ca7be9f62fa/sslyze/plugins/utils/certificate_utils.py#L95-L108 |
227,299 | nabla-c0d3/sslyze | sslyze/utils/tls_wrapped_protocol_helpers.py | HttpsHelper.send_request | def send_request(self, ssl_client: SslClient) -> str:
"""Send an HTTP GET to the server and return the HTTP status code.
"""
try:
ssl_client.write(HttpRequestGenerator.get_request(self._hostname))
# Parse the response and print the Location header
http_respon... | python | def send_request(self, ssl_client: SslClient) -> str:
"""Send an HTTP GET to the server and return the HTTP status code.
"""
try:
ssl_client.write(HttpRequestGenerator.get_request(self._hostname))
# Parse the response and print the Location header
http_respon... | [
"def",
"send_request",
"(",
"self",
",",
"ssl_client",
":",
"SslClient",
")",
"->",
"str",
":",
"try",
":",
"ssl_client",
".",
"write",
"(",
"HttpRequestGenerator",
".",
"get_request",
"(",
"self",
".",
"_hostname",
")",
")",
"# Parse the response and print the ... | Send an HTTP GET to the server and return the HTTP status code. | [
"Send",
"an",
"HTTP",
"GET",
"to",
"the",
"server",
"and",
"return",
"the",
"HTTP",
"status",
"code",
"."
] | 0fb3ae668453d7ecf616d0755f237ca7be9f62fa | https://github.com/nabla-c0d3/sslyze/blob/0fb3ae668453d7ecf616d0755f237ca7be9f62fa/sslyze/utils/tls_wrapped_protocol_helpers.py#L65-L90 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.