repo stringclasses 85
values | path stringlengths 8 121 | func_name stringlengths 1 82 | original_string stringlengths 112 65.5k | language stringclasses 1
value | code stringlengths 112 65.5k | code_tokens listlengths 20 4.09k | docstring stringlengths 3 46.3k | docstring_tokens listlengths 1 564 | sha stringclasses 85
values | url stringlengths 93 218 | partition stringclasses 1
value |
|---|---|---|---|---|---|---|---|---|---|---|---|
dmlc/gluon-nlp | scripts/bert/utils.py | load_vocab | def load_vocab(vocab_file):
"""Loads a vocabulary file into a dictionary."""
vocab = collections.OrderedDict()
index = 0
with io.open(vocab_file, 'r') as reader:
while True:
token = reader.readline()
if not token:
break
token = token.strip()
... | python | def load_vocab(vocab_file):
"""Loads a vocabulary file into a dictionary."""
vocab = collections.OrderedDict()
index = 0
with io.open(vocab_file, 'r') as reader:
while True:
token = reader.readline()
if not token:
break
token = token.strip()
... | [
"def",
"load_vocab",
"(",
"vocab_file",
")",
":",
"vocab",
"=",
"collections",
".",
"OrderedDict",
"(",
")",
"index",
"=",
"0",
"with",
"io",
".",
"open",
"(",
"vocab_file",
",",
"'r'",
")",
"as",
"reader",
":",
"while",
"True",
":",
"token",
"=",
"r... | Loads a vocabulary file into a dictionary. | [
"Loads",
"a",
"vocabulary",
"file",
"into",
"a",
"dictionary",
"."
] | 4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba | https://github.com/dmlc/gluon-nlp/blob/4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba/scripts/bert/utils.py#L125-L137 | train |
dmlc/gluon-nlp | src/gluonnlp/model/convolutional_encoder.py | ConvolutionalEncoder.hybrid_forward | def hybrid_forward(self, F, inputs, mask=None): # pylint: disable=arguments-differ
r"""
Forward computation for char_encoder
Parameters
----------
inputs: NDArray
The input tensor is of shape `(seq_len, batch_size, embedding_size)` TNC.
mask: NDArray
... | python | def hybrid_forward(self, F, inputs, mask=None): # pylint: disable=arguments-differ
r"""
Forward computation for char_encoder
Parameters
----------
inputs: NDArray
The input tensor is of shape `(seq_len, batch_size, embedding_size)` TNC.
mask: NDArray
... | [
"def",
"hybrid_forward",
"(",
"self",
",",
"F",
",",
"inputs",
",",
"mask",
"=",
"None",
")",
":",
"# pylint: disable=arguments-differ",
"if",
"mask",
"is",
"not",
"None",
":",
"inputs",
"=",
"F",
".",
"broadcast_mul",
"(",
"inputs",
",",
"mask",
".",
"e... | r"""
Forward computation for char_encoder
Parameters
----------
inputs: NDArray
The input tensor is of shape `(seq_len, batch_size, embedding_size)` TNC.
mask: NDArray
The mask applied to the input of shape `(seq_len, batch_size)`, the mask will
... | [
"r",
"Forward",
"computation",
"for",
"char_encoder"
] | 4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba | https://github.com/dmlc/gluon-nlp/blob/4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba/src/gluonnlp/model/convolutional_encoder.py#L135-L166 | train |
dmlc/gluon-nlp | src/gluonnlp/model/transformer.py | _position_encoding_init | def _position_encoding_init(max_length, dim):
"""Init the sinusoid position encoding table """
position_enc = np.arange(max_length).reshape((-1, 1)) \
/ (np.power(10000, (2. / dim) * np.arange(dim).reshape((1, -1))))
# Apply the cosine to even columns and sin to odds.
position_enc[:, ... | python | def _position_encoding_init(max_length, dim):
"""Init the sinusoid position encoding table """
position_enc = np.arange(max_length).reshape((-1, 1)) \
/ (np.power(10000, (2. / dim) * np.arange(dim).reshape((1, -1))))
# Apply the cosine to even columns and sin to odds.
position_enc[:, ... | [
"def",
"_position_encoding_init",
"(",
"max_length",
",",
"dim",
")",
":",
"position_enc",
"=",
"np",
".",
"arange",
"(",
"max_length",
")",
".",
"reshape",
"(",
"(",
"-",
"1",
",",
"1",
")",
")",
"/",
"(",
"np",
".",
"power",
"(",
"10000",
",",
"(... | Init the sinusoid position encoding table | [
"Init",
"the",
"sinusoid",
"position",
"encoding",
"table"
] | 4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba | https://github.com/dmlc/gluon-nlp/blob/4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba/src/gluonnlp/model/transformer.py#L46-L53 | train |
dmlc/gluon-nlp | src/gluonnlp/model/transformer.py | get_transformer_encoder_decoder | def get_transformer_encoder_decoder(num_layers=2,
num_heads=8, scaled=True,
units=512, hidden_size=2048, dropout=0.0, use_residual=True,
max_src_length=50, max_tgt_length=50,
w... | python | def get_transformer_encoder_decoder(num_layers=2,
num_heads=8, scaled=True,
units=512, hidden_size=2048, dropout=0.0, use_residual=True,
max_src_length=50, max_tgt_length=50,
w... | [
"def",
"get_transformer_encoder_decoder",
"(",
"num_layers",
"=",
"2",
",",
"num_heads",
"=",
"8",
",",
"scaled",
"=",
"True",
",",
"units",
"=",
"512",
",",
"hidden_size",
"=",
"2048",
",",
"dropout",
"=",
"0.0",
",",
"use_residual",
"=",
"True",
",",
"... | Build a pair of Parallel Transformer encoder/decoder
Parameters
----------
num_layers : int
num_heads : int
scaled : bool
units : int
hidden_size : int
dropout : float
use_residual : bool
max_src_length : int
max_tgt_length : int
weight_initializer : mx.init.Initializer ... | [
"Build",
"a",
"pair",
"of",
"Parallel",
"Transformer",
"encoder",
"/",
"decoder"
] | 4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba | https://github.com/dmlc/gluon-nlp/blob/4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba/src/gluonnlp/model/transformer.py#L1123-L1177 | train |
dmlc/gluon-nlp | src/gluonnlp/model/transformer.py | transformer_en_de_512 | def transformer_en_de_512(dataset_name=None, src_vocab=None, tgt_vocab=None, pretrained=False,
ctx=cpu(), root=os.path.join(get_home_dir(), 'models'), **kwargs):
r"""Transformer pretrained model.
Embedding size is 400, and hidden layer size is 1150.
Parameters
----------
... | python | def transformer_en_de_512(dataset_name=None, src_vocab=None, tgt_vocab=None, pretrained=False,
ctx=cpu(), root=os.path.join(get_home_dir(), 'models'), **kwargs):
r"""Transformer pretrained model.
Embedding size is 400, and hidden layer size is 1150.
Parameters
----------
... | [
"def",
"transformer_en_de_512",
"(",
"dataset_name",
"=",
"None",
",",
"src_vocab",
"=",
"None",
",",
"tgt_vocab",
"=",
"None",
",",
"pretrained",
"=",
"False",
",",
"ctx",
"=",
"cpu",
"(",
")",
",",
"root",
"=",
"os",
".",
"path",
".",
"join",
"(",
... | r"""Transformer pretrained model.
Embedding size is 400, and hidden layer size is 1150.
Parameters
----------
dataset_name : str or None, default None
src_vocab : gluonnlp.Vocab or None, default None
tgt_vocab : gluonnlp.Vocab or None, default None
pretrained : bool, default False
... | [
"r",
"Transformer",
"pretrained",
"model",
"."
] | 4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba | https://github.com/dmlc/gluon-nlp/blob/4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba/src/gluonnlp/model/transformer.py#L1200-L1251 | train |
dmlc/gluon-nlp | src/gluonnlp/model/transformer.py | BasePositionwiseFFN._get_activation | def _get_activation(self, act):
"""Get activation block based on the name. """
if isinstance(act, str):
if act.lower() == 'gelu':
return GELU()
else:
return gluon.nn.Activation(act)
assert isinstance(act, gluon.Block)
return act | python | def _get_activation(self, act):
"""Get activation block based on the name. """
if isinstance(act, str):
if act.lower() == 'gelu':
return GELU()
else:
return gluon.nn.Activation(act)
assert isinstance(act, gluon.Block)
return act | [
"def",
"_get_activation",
"(",
"self",
",",
"act",
")",
":",
"if",
"isinstance",
"(",
"act",
",",
"str",
")",
":",
"if",
"act",
".",
"lower",
"(",
")",
"==",
"'gelu'",
":",
"return",
"GELU",
"(",
")",
"else",
":",
"return",
"gluon",
".",
"nn",
".... | Get activation block based on the name. | [
"Get",
"activation",
"block",
"based",
"on",
"the",
"name",
"."
] | 4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba | https://github.com/dmlc/gluon-nlp/blob/4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba/src/gluonnlp/model/transformer.py#L116-L124 | train |
dmlc/gluon-nlp | src/gluonnlp/model/transformer.py | BasePositionwiseFFN.hybrid_forward | def hybrid_forward(self, F, inputs): # pylint: disable=arguments-differ
# pylint: disable=unused-argument
"""Position-wise encoding of the inputs.
Parameters
----------
inputs : Symbol or NDArray
Input sequence. Shape (batch_size, length, C_in)
Returns
... | python | def hybrid_forward(self, F, inputs): # pylint: disable=arguments-differ
# pylint: disable=unused-argument
"""Position-wise encoding of the inputs.
Parameters
----------
inputs : Symbol or NDArray
Input sequence. Shape (batch_size, length, C_in)
Returns
... | [
"def",
"hybrid_forward",
"(",
"self",
",",
"F",
",",
"inputs",
")",
":",
"# pylint: disable=arguments-differ",
"# pylint: disable=unused-argument",
"outputs",
"=",
"self",
".",
"ffn_1",
"(",
"inputs",
")",
"if",
"self",
".",
"activation",
":",
"outputs",
"=",
"s... | Position-wise encoding of the inputs.
Parameters
----------
inputs : Symbol or NDArray
Input sequence. Shape (batch_size, length, C_in)
Returns
-------
outputs : Symbol or NDArray
Shape (batch_size, length, C_out) | [
"Position",
"-",
"wise",
"encoding",
"of",
"the",
"inputs",
"."
] | 4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba | https://github.com/dmlc/gluon-nlp/blob/4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba/src/gluonnlp/model/transformer.py#L126-L149 | train |
dmlc/gluon-nlp | src/gluonnlp/model/transformer.py | BaseTransformerEncoderCell.hybrid_forward | def hybrid_forward(self, F, inputs, mask=None): # pylint: disable=arguments-differ
# pylint: disable=unused-argument
"""Transformer Encoder Attention Cell.
Parameters
----------
inputs : Symbol or NDArray
Input sequence. Shape (batch_size, length, C_in)
mask... | python | def hybrid_forward(self, F, inputs, mask=None): # pylint: disable=arguments-differ
# pylint: disable=unused-argument
"""Transformer Encoder Attention Cell.
Parameters
----------
inputs : Symbol or NDArray
Input sequence. Shape (batch_size, length, C_in)
mask... | [
"def",
"hybrid_forward",
"(",
"self",
",",
"F",
",",
"inputs",
",",
"mask",
"=",
"None",
")",
":",
"# pylint: disable=arguments-differ",
"# pylint: disable=unused-argument",
"outputs",
",",
"attention_weights",
"=",
"self",
".",
"attention_cell",
"(",
"inputs",
",",... | Transformer Encoder Attention Cell.
Parameters
----------
inputs : Symbol or NDArray
Input sequence. Shape (batch_size, length, C_in)
mask : Symbol or NDArray or None
Mask for inputs. Shape (batch_size, length, length)
Returns
-------
enc... | [
"Transformer",
"Encoder",
"Attention",
"Cell",
"."
] | 4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba | https://github.com/dmlc/gluon-nlp/blob/4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba/src/gluonnlp/model/transformer.py#L236-L267 | train |
dmlc/gluon-nlp | src/gluonnlp/model/transformer.py | TransformerDecoderCell.hybrid_forward | def hybrid_forward(self, F, inputs, mem_value, mask=None, mem_mask=None): #pylint: disable=unused-argument
# pylint: disable=arguments-differ
"""Transformer Decoder Attention Cell.
Parameters
----------
inputs : Symbol or NDArray
Input sequence. Shape (batch_size, ... | python | def hybrid_forward(self, F, inputs, mem_value, mask=None, mem_mask=None): #pylint: disable=unused-argument
# pylint: disable=arguments-differ
"""Transformer Decoder Attention Cell.
Parameters
----------
inputs : Symbol or NDArray
Input sequence. Shape (batch_size, ... | [
"def",
"hybrid_forward",
"(",
"self",
",",
"F",
",",
"inputs",
",",
"mem_value",
",",
"mask",
"=",
"None",
",",
"mem_mask",
"=",
"None",
")",
":",
"#pylint: disable=unused-argument",
"# pylint: disable=arguments-differ",
"outputs",
",",
"attention_in_outputs",
"=",... | Transformer Decoder Attention Cell.
Parameters
----------
inputs : Symbol or NDArray
Input sequence. Shape (batch_size, length, C_in)
mem_value : Symbol or NDArrays
Memory value, i.e. output of the encoder. Shape (batch_size, mem_length, C_in)
mask : Symb... | [
"Transformer",
"Decoder",
"Attention",
"Cell",
"."
] | 4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba | https://github.com/dmlc/gluon-nlp/blob/4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba/src/gluonnlp/model/transformer.py#L778-L823 | train |
dmlc/gluon-nlp | src/gluonnlp/model/transformer.py | TransformerDecoder.init_state_from_encoder | def init_state_from_encoder(self, encoder_outputs, encoder_valid_length=None):
"""Initialize the state from the encoder outputs.
Parameters
----------
encoder_outputs : list
encoder_valid_length : NDArray or None
Returns
-------
decoder_states : list
... | python | def init_state_from_encoder(self, encoder_outputs, encoder_valid_length=None):
"""Initialize the state from the encoder outputs.
Parameters
----------
encoder_outputs : list
encoder_valid_length : NDArray or None
Returns
-------
decoder_states : list
... | [
"def",
"init_state_from_encoder",
"(",
"self",
",",
"encoder_outputs",
",",
"encoder_valid_length",
"=",
"None",
")",
":",
"mem_value",
"=",
"encoder_outputs",
"decoder_states",
"=",
"[",
"mem_value",
"]",
"mem_length",
"=",
"mem_value",
".",
"shape",
"[",
"1",
... | Initialize the state from the encoder outputs.
Parameters
----------
encoder_outputs : list
encoder_valid_length : NDArray or None
Returns
-------
decoder_states : list
The decoder states, includes:
- mem_value : NDArray
- me... | [
"Initialize",
"the",
"state",
"from",
"the",
"encoder",
"outputs",
"."
] | 4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba | https://github.com/dmlc/gluon-nlp/blob/4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba/src/gluonnlp/model/transformer.py#L905-L932 | train |
dmlc/gluon-nlp | src/gluonnlp/model/transformer.py | TransformerDecoder.decode_seq | def decode_seq(self, inputs, states, valid_length=None):
"""Decode the decoder inputs. This function is only used for training.
Parameters
----------
inputs : NDArray, Shape (batch_size, length, C_in)
states : list of NDArrays or None
Initial states. The list of deco... | python | def decode_seq(self, inputs, states, valid_length=None):
"""Decode the decoder inputs. This function is only used for training.
Parameters
----------
inputs : NDArray, Shape (batch_size, length, C_in)
states : list of NDArrays or None
Initial states. The list of deco... | [
"def",
"decode_seq",
"(",
"self",
",",
"inputs",
",",
"states",
",",
"valid_length",
"=",
"None",
")",
":",
"batch_size",
"=",
"inputs",
".",
"shape",
"[",
"0",
"]",
"length",
"=",
"inputs",
".",
"shape",
"[",
"1",
"]",
"length_array",
"=",
"mx",
"."... | Decode the decoder inputs. This function is only used for training.
Parameters
----------
inputs : NDArray, Shape (batch_size, length, C_in)
states : list of NDArrays or None
Initial states. The list of decoder states
valid_length : NDArray or None
Valid ... | [
"Decode",
"the",
"decoder",
"inputs",
".",
"This",
"function",
"is",
"only",
"used",
"for",
"training",
"."
] | 4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba | https://github.com/dmlc/gluon-nlp/blob/4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba/src/gluonnlp/model/transformer.py#L934-L982 | train |
dmlc/gluon-nlp | src/gluonnlp/model/transformer.py | ParallelTransformer.forward_backward | def forward_backward(self, x):
"""Perform forward and backward computation for a batch of src seq and dst seq"""
(src_seq, tgt_seq, src_valid_length, tgt_valid_length), batch_size = x
with mx.autograd.record():
out, _ = self._model(src_seq, tgt_seq[:, :-1],
... | python | def forward_backward(self, x):
"""Perform forward and backward computation for a batch of src seq and dst seq"""
(src_seq, tgt_seq, src_valid_length, tgt_valid_length), batch_size = x
with mx.autograd.record():
out, _ = self._model(src_seq, tgt_seq[:, :-1],
... | [
"def",
"forward_backward",
"(",
"self",
",",
"x",
")",
":",
"(",
"src_seq",
",",
"tgt_seq",
",",
"src_valid_length",
",",
"tgt_valid_length",
")",
",",
"batch_size",
"=",
"x",
"with",
"mx",
".",
"autograd",
".",
"record",
"(",
")",
":",
"out",
",",
"_"... | Perform forward and backward computation for a batch of src seq and dst seq | [
"Perform",
"forward",
"and",
"backward",
"computation",
"for",
"a",
"batch",
"of",
"src",
"seq",
"and",
"dst",
"seq"
] | 4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba | https://github.com/dmlc/gluon-nlp/blob/4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba/src/gluonnlp/model/transformer.py#L1274-L1284 | train |
dmlc/gluon-nlp | scripts/natural_language_inference/main.py | parse_args | def parse_args():
"""
Parse arguments.
"""
parser = argparse.ArgumentParser()
parser.add_argument('--gpu-id', type=int, default=0,
help='GPU id (-1 means CPU)')
parser.add_argument('--train-file', default='snli_1.0/snli_1.0_train.txt',
help='traini... | python | def parse_args():
"""
Parse arguments.
"""
parser = argparse.ArgumentParser()
parser.add_argument('--gpu-id', type=int, default=0,
help='GPU id (-1 means CPU)')
parser.add_argument('--train-file', default='snli_1.0/snli_1.0_train.txt',
help='traini... | [
"def",
"parse_args",
"(",
")",
":",
"parser",
"=",
"argparse",
".",
"ArgumentParser",
"(",
")",
"parser",
".",
"add_argument",
"(",
"'--gpu-id'",
",",
"type",
"=",
"int",
",",
"default",
"=",
"0",
",",
"help",
"=",
"'GPU id (-1 means CPU)'",
")",
"parser",... | Parse arguments. | [
"Parse",
"arguments",
"."
] | 4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba | https://github.com/dmlc/gluon-nlp/blob/4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba/scripts/natural_language_inference/main.py#L53-L97 | train |
dmlc/gluon-nlp | scripts/natural_language_inference/main.py | train_model | def train_model(model, train_data_loader, val_data_loader, embedding, ctx, args):
"""
Train model and validate/save every epoch.
"""
logger.info(vars(args))
# Initialization
model.hybridize()
model.collect_params().initialize(mx.init.Normal(0.01), ctx=ctx)
model.word_emb.weight.set_data... | python | def train_model(model, train_data_loader, val_data_loader, embedding, ctx, args):
"""
Train model and validate/save every epoch.
"""
logger.info(vars(args))
# Initialization
model.hybridize()
model.collect_params().initialize(mx.init.Normal(0.01), ctx=ctx)
model.word_emb.weight.set_data... | [
"def",
"train_model",
"(",
"model",
",",
"train_data_loader",
",",
"val_data_loader",
",",
"embedding",
",",
"ctx",
",",
"args",
")",
":",
"logger",
".",
"info",
"(",
"vars",
"(",
"args",
")",
")",
"# Initialization",
"model",
".",
"hybridize",
"(",
")",
... | Train model and validate/save every epoch. | [
"Train",
"model",
"and",
"validate",
"/",
"save",
"every",
"epoch",
"."
] | 4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba | https://github.com/dmlc/gluon-nlp/blob/4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba/scripts/natural_language_inference/main.py#L99-L163 | train |
dmlc/gluon-nlp | scripts/natural_language_inference/main.py | main | def main(args):
"""
Entry point: train or test.
"""
json.dump(vars(args), open(os.path.join(args.output_dir, 'config.json'), 'w'))
if args.gpu_id == -1:
ctx = mx.cpu()
else:
ctx = mx.gpu(args.gpu_id)
mx.random.seed(args.seed, ctx=ctx)
if args.mode == 'train':
t... | python | def main(args):
"""
Entry point: train or test.
"""
json.dump(vars(args), open(os.path.join(args.output_dir, 'config.json'), 'w'))
if args.gpu_id == -1:
ctx = mx.cpu()
else:
ctx = mx.gpu(args.gpu_id)
mx.random.seed(args.seed, ctx=ctx)
if args.mode == 'train':
t... | [
"def",
"main",
"(",
"args",
")",
":",
"json",
".",
"dump",
"(",
"vars",
"(",
"args",
")",
",",
"open",
"(",
"os",
".",
"path",
".",
"join",
"(",
"args",
".",
"output_dir",
",",
"'config.json'",
")",
",",
"'w'",
")",
")",
"if",
"args",
".",
"gpu... | Entry point: train or test. | [
"Entry",
"point",
":",
"train",
"or",
"test",
"."
] | 4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba | https://github.com/dmlc/gluon-nlp/blob/4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba/scripts/natural_language_inference/main.py#L184-L231 | train |
dmlc/gluon-nlp | src/gluonnlp/data/candidate_sampler.py | UnigramCandidateSampler.hybrid_forward | def hybrid_forward(self, F, candidates_like, prob, alias):
# pylint: disable=unused-argument
"""Draw samples from uniform distribution and return sampled candidates.
Parameters
----------
candidates_like: mxnet.nd.NDArray or mxnet.sym.Symbol
This input specifies the ... | python | def hybrid_forward(self, F, candidates_like, prob, alias):
# pylint: disable=unused-argument
"""Draw samples from uniform distribution and return sampled candidates.
Parameters
----------
candidates_like: mxnet.nd.NDArray or mxnet.sym.Symbol
This input specifies the ... | [
"def",
"hybrid_forward",
"(",
"self",
",",
"F",
",",
"candidates_like",
",",
"prob",
",",
"alias",
")",
":",
"# pylint: disable=unused-argument",
"flat_shape",
"=",
"functools",
".",
"reduce",
"(",
"operator",
".",
"mul",
",",
"self",
".",
"_shape",
")",
"id... | Draw samples from uniform distribution and return sampled candidates.
Parameters
----------
candidates_like: mxnet.nd.NDArray or mxnet.sym.Symbol
This input specifies the shape of the to be sampled candidates. #
TODO shape selection is not yet supported. Shape must be sp... | [
"Draw",
"samples",
"from",
"uniform",
"distribution",
"and",
"return",
"sampled",
"candidates",
"."
] | 4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba | https://github.com/dmlc/gluon-nlp/blob/4b83eb6bcc8881e5f1081a3675adaa19fac5c0ba/src/gluonnlp/data/candidate_sampler.py#L105-L134 | train |
Delgan/loguru | loguru/_logger.py | Logger.add | def add(
self,
sink,
*,
level=_defaults.LOGURU_LEVEL,
format=_defaults.LOGURU_FORMAT,
filter=_defaults.LOGURU_FILTER,
colorize=_defaults.LOGURU_COLORIZE,
serialize=_defaults.LOGURU_SERIALIZE,
backtrace=_defaults.LOGURU_BACKTRACE,
diagnose=_... | python | def add(
self,
sink,
*,
level=_defaults.LOGURU_LEVEL,
format=_defaults.LOGURU_FORMAT,
filter=_defaults.LOGURU_FILTER,
colorize=_defaults.LOGURU_COLORIZE,
serialize=_defaults.LOGURU_SERIALIZE,
backtrace=_defaults.LOGURU_BACKTRACE,
diagnose=_... | [
"def",
"add",
"(",
"self",
",",
"sink",
",",
"*",
",",
"level",
"=",
"_defaults",
".",
"LOGURU_LEVEL",
",",
"format",
"=",
"_defaults",
".",
"LOGURU_FORMAT",
",",
"filter",
"=",
"_defaults",
".",
"LOGURU_FILTER",
",",
"colorize",
"=",
"_defaults",
".",
"... | r"""Add a handler sending log messages to a sink adequately configured.
Parameters
----------
sink : |file-like object|_, |str|, |Path|, |function|_, |Handler| or |class|_
An object in charge of receiving formatted logging messages and propagating them to an
appropriate ... | [
"r",
"Add",
"a",
"handler",
"sending",
"log",
"messages",
"to",
"a",
"sink",
"adequately",
"configured",
"."
] | 6571879c37904e3a18567e694d70651c6886b860 | https://github.com/Delgan/loguru/blob/6571879c37904e3a18567e694d70651c6886b860/loguru/_logger.py#L166-L843 | train |
Delgan/loguru | loguru/_logger.py | Logger.remove | def remove(self, handler_id=None):
"""Remove a previously added handler and stop sending logs to its sink.
Parameters
----------
handler_id : |int| or ``None``
The id of the sink to remove, as it was returned by the |add| method. If ``None``, all
handlers are rem... | python | def remove(self, handler_id=None):
"""Remove a previously added handler and stop sending logs to its sink.
Parameters
----------
handler_id : |int| or ``None``
The id of the sink to remove, as it was returned by the |add| method. If ``None``, all
handlers are rem... | [
"def",
"remove",
"(",
"self",
",",
"handler_id",
"=",
"None",
")",
":",
"with",
"self",
".",
"_lock",
":",
"handlers",
"=",
"self",
".",
"_handlers",
".",
"copy",
"(",
")",
"if",
"handler_id",
"is",
"None",
":",
"for",
"handler",
"in",
"handlers",
".... | Remove a previously added handler and stop sending logs to its sink.
Parameters
----------
handler_id : |int| or ``None``
The id of the sink to remove, as it was returned by the |add| method. If ``None``, all
handlers are removed. The pre-configured handler is guaranteed... | [
"Remove",
"a",
"previously",
"added",
"handler",
"and",
"stop",
"sending",
"logs",
"to",
"its",
"sink",
"."
] | 6571879c37904e3a18567e694d70651c6886b860 | https://github.com/Delgan/loguru/blob/6571879c37904e3a18567e694d70651c6886b860/loguru/_logger.py#L845-L883 | train |
Delgan/loguru | loguru/_logger.py | Logger.catch | def catch(
self,
exception=Exception,
*,
level="ERROR",
reraise=False,
message="An error has been caught in function '{record[function]}', "
"process '{record[process].name}' ({record[process].id}), "
"thread '{record[thread].name}' ({record[thread].id}):"... | python | def catch(
self,
exception=Exception,
*,
level="ERROR",
reraise=False,
message="An error has been caught in function '{record[function]}', "
"process '{record[process].name}' ({record[process].id}), "
"thread '{record[thread].name}' ({record[thread].id}):"... | [
"def",
"catch",
"(",
"self",
",",
"exception",
"=",
"Exception",
",",
"*",
",",
"level",
"=",
"\"ERROR\"",
",",
"reraise",
"=",
"False",
",",
"message",
"=",
"\"An error has been caught in function '{record[function]}', \"",
"\"process '{record[process].name}' ({record[pr... | Return a decorator to automatically log possibly caught error in wrapped function.
This is useful to ensure unexpected exceptions are logged, the entire program can be
wrapped by this method. This is also very useful to decorate |Thread.run| methods while
using threads to propagate errors to th... | [
"Return",
"a",
"decorator",
"to",
"automatically",
"log",
"possibly",
"caught",
"error",
"in",
"wrapped",
"function",
"."
] | 6571879c37904e3a18567e694d70651c6886b860 | https://github.com/Delgan/loguru/blob/6571879c37904e3a18567e694d70651c6886b860/loguru/_logger.py#L885-L1011 | train |
Delgan/loguru | loguru/_logger.py | Logger.opt | def opt(self, *, exception=None, record=False, lazy=False, ansi=False, raw=False, depth=0):
r"""Parametrize a logging call to slightly change generated log message.
Parameters
----------
exception : |bool|, |tuple| or |Exception|, optional
If it does not evaluate as ``False`... | python | def opt(self, *, exception=None, record=False, lazy=False, ansi=False, raw=False, depth=0):
r"""Parametrize a logging call to slightly change generated log message.
Parameters
----------
exception : |bool|, |tuple| or |Exception|, optional
If it does not evaluate as ``False`... | [
"def",
"opt",
"(",
"self",
",",
"*",
",",
"exception",
"=",
"None",
",",
"record",
"=",
"False",
",",
"lazy",
"=",
"False",
",",
"ansi",
"=",
"False",
",",
"raw",
"=",
"False",
",",
"depth",
"=",
"0",
")",
":",
"return",
"Logger",
"(",
"self",
... | r"""Parametrize a logging call to slightly change generated log message.
Parameters
----------
exception : |bool|, |tuple| or |Exception|, optional
If it does not evaluate as ``False``, the passed exception is formatted and added to the
log message. It could be an |Excep... | [
"r",
"Parametrize",
"a",
"logging",
"call",
"to",
"slightly",
"change",
"generated",
"log",
"message",
"."
] | 6571879c37904e3a18567e694d70651c6886b860 | https://github.com/Delgan/loguru/blob/6571879c37904e3a18567e694d70651c6886b860/loguru/_logger.py#L1013-L1079 | train |
Delgan/loguru | loguru/_logger.py | Logger.bind | def bind(_self, **kwargs):
"""Bind attributes to the ``extra`` dict of each logged message record.
This is used to add custom context to each logging call.
Parameters
----------
**kwargs
Mapping between keys and values that will be added to the ``extra`` dict.
... | python | def bind(_self, **kwargs):
"""Bind attributes to the ``extra`` dict of each logged message record.
This is used to add custom context to each logging call.
Parameters
----------
**kwargs
Mapping between keys and values that will be added to the ``extra`` dict.
... | [
"def",
"bind",
"(",
"_self",
",",
"*",
"*",
"kwargs",
")",
":",
"return",
"Logger",
"(",
"{",
"*",
"*",
"_self",
".",
"_extra",
",",
"*",
"*",
"kwargs",
"}",
",",
"_self",
".",
"_exception",
",",
"_self",
".",
"_record",
",",
"_self",
".",
"_lazy... | Bind attributes to the ``extra`` dict of each logged message record.
This is used to add custom context to each logging call.
Parameters
----------
**kwargs
Mapping between keys and values that will be added to the ``extra`` dict.
Returns
-------
:c... | [
"Bind",
"attributes",
"to",
"the",
"extra",
"dict",
"of",
"each",
"logged",
"message",
"record",
"."
] | 6571879c37904e3a18567e694d70651c6886b860 | https://github.com/Delgan/loguru/blob/6571879c37904e3a18567e694d70651c6886b860/loguru/_logger.py#L1081-L1123 | train |
Delgan/loguru | loguru/_logger.py | Logger.level | def level(self, name, no=None, color=None, icon=None):
"""Add, update or retrieve a logging level.
Logging levels are defined by their ``name`` to which a severity ``no``, an ansi ``color``
and an ``icon`` are associated and possibly modified at run-time. To |log| to a custom
level, you... | python | def level(self, name, no=None, color=None, icon=None):
"""Add, update or retrieve a logging level.
Logging levels are defined by their ``name`` to which a severity ``no``, an ansi ``color``
and an ``icon`` are associated and possibly modified at run-time. To |log| to a custom
level, you... | [
"def",
"level",
"(",
"self",
",",
"name",
",",
"no",
"=",
"None",
",",
"color",
"=",
"None",
",",
"icon",
"=",
"None",
")",
":",
"if",
"not",
"isinstance",
"(",
"name",
",",
"str",
")",
":",
"raise",
"ValueError",
"(",
"\"Invalid level name, it should ... | Add, update or retrieve a logging level.
Logging levels are defined by their ``name`` to which a severity ``no``, an ansi ``color``
and an ``icon`` are associated and possibly modified at run-time. To |log| to a custom
level, you should necessarily use its name, the severity number is not linke... | [
"Add",
"update",
"or",
"retrieve",
"a",
"logging",
"level",
"."
] | 6571879c37904e3a18567e694d70651c6886b860 | https://github.com/Delgan/loguru/blob/6571879c37904e3a18567e694d70651c6886b860/loguru/_logger.py#L1125-L1212 | train |
Delgan/loguru | loguru/_logger.py | Logger.configure | def configure(self, *, handlers=None, levels=None, extra=None, activation=None):
"""Configure the core logger.
It should be noted that ``extra`` values set using this function are available across all
modules, so this is the best way to set overall default values.
Parameters
--... | python | def configure(self, *, handlers=None, levels=None, extra=None, activation=None):
"""Configure the core logger.
It should be noted that ``extra`` values set using this function are available across all
modules, so this is the best way to set overall default values.
Parameters
--... | [
"def",
"configure",
"(",
"self",
",",
"*",
",",
"handlers",
"=",
"None",
",",
"levels",
"=",
"None",
",",
"extra",
"=",
"None",
",",
"activation",
"=",
"None",
")",
":",
"if",
"handlers",
"is",
"not",
"None",
":",
"self",
".",
"remove",
"(",
")",
... | Configure the core logger.
It should be noted that ``extra`` values set using this function are available across all
modules, so this is the best way to set overall default values.
Parameters
----------
handlers : |list| of |dict|, optional
A list of each handler to... | [
"Configure",
"the",
"core",
"logger",
"."
] | 6571879c37904e3a18567e694d70651c6886b860 | https://github.com/Delgan/loguru/blob/6571879c37904e3a18567e694d70651c6886b860/loguru/_logger.py#L1255-L1330 | train |
Delgan/loguru | loguru/_logger.py | Logger.parse | def parse(file, pattern, *, cast={}, chunk=2 ** 16):
"""
Parse raw logs and extract each entry as a |dict|.
The logging format has to be specified as the regex ``pattern``, it will then be
used to parse the ``file`` and retrieve each entries based on the named groups present
in ... | python | def parse(file, pattern, *, cast={}, chunk=2 ** 16):
"""
Parse raw logs and extract each entry as a |dict|.
The logging format has to be specified as the regex ``pattern``, it will then be
used to parse the ``file`` and retrieve each entries based on the named groups present
in ... | [
"def",
"parse",
"(",
"file",
",",
"pattern",
",",
"*",
",",
"cast",
"=",
"{",
"}",
",",
"chunk",
"=",
"2",
"**",
"16",
")",
":",
"if",
"isinstance",
"(",
"file",
",",
"(",
"str",
",",
"PathLike",
")",
")",
":",
"should_close",
"=",
"True",
"fil... | Parse raw logs and extract each entry as a |dict|.
The logging format has to be specified as the regex ``pattern``, it will then be
used to parse the ``file`` and retrieve each entries based on the named groups present
in the regex.
Parameters
----------
file : |str|, |... | [
"Parse",
"raw",
"logs",
"and",
"extract",
"each",
"entry",
"as",
"a",
"|dict|",
"."
] | 6571879c37904e3a18567e694d70651c6886b860 | https://github.com/Delgan/loguru/blob/6571879c37904e3a18567e694d70651c6886b860/loguru/_logger.py#L1359-L1450 | train |
Delgan/loguru | loguru/_logger.py | Logger.log | def log(_self, _level, _message, *args, **kwargs):
r"""Log ``_message.format(*args, **kwargs)`` with severity ``_level``."""
logger = _self.opt(
exception=_self._exception,
record=_self._record,
lazy=_self._lazy,
ansi=_self._ansi,
raw=_self._ra... | python | def log(_self, _level, _message, *args, **kwargs):
r"""Log ``_message.format(*args, **kwargs)`` with severity ``_level``."""
logger = _self.opt(
exception=_self._exception,
record=_self._record,
lazy=_self._lazy,
ansi=_self._ansi,
raw=_self._ra... | [
"def",
"log",
"(",
"_self",
",",
"_level",
",",
"_message",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"logger",
"=",
"_self",
".",
"opt",
"(",
"exception",
"=",
"_self",
".",
"_exception",
",",
"record",
"=",
"_self",
".",
"_record",
","... | r"""Log ``_message.format(*args, **kwargs)`` with severity ``_level``. | [
"r",
"Log",
"_message",
".",
"format",
"(",
"*",
"args",
"**",
"kwargs",
")",
"with",
"severity",
"_level",
"."
] | 6571879c37904e3a18567e694d70651c6886b860 | https://github.com/Delgan/loguru/blob/6571879c37904e3a18567e694d70651c6886b860/loguru/_logger.py#L1600-L1610 | train |
Delgan/loguru | loguru/_logger.py | Logger.start | def start(self, *args, **kwargs):
"""Deprecated function to |add| a new handler.
Warnings
--------
.. deprecated:: 0.2.2
``start()`` will be removed in Loguru 1.0.0, it is replaced by ``add()`` which is a less
confusing name.
"""
warnings.warn(
... | python | def start(self, *args, **kwargs):
"""Deprecated function to |add| a new handler.
Warnings
--------
.. deprecated:: 0.2.2
``start()`` will be removed in Loguru 1.0.0, it is replaced by ``add()`` which is a less
confusing name.
"""
warnings.warn(
... | [
"def",
"start",
"(",
"self",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"warnings",
".",
"warn",
"(",
"\"The 'start()' method is deprecated, please use 'add()' instead\"",
",",
"DeprecationWarning",
")",
"return",
"self",
".",
"add",
"(",
"*",
"args",
... | Deprecated function to |add| a new handler.
Warnings
--------
.. deprecated:: 0.2.2
``start()`` will be removed in Loguru 1.0.0, it is replaced by ``add()`` which is a less
confusing name. | [
"Deprecated",
"function",
"to",
"|add|",
"a",
"new",
"handler",
"."
] | 6571879c37904e3a18567e694d70651c6886b860 | https://github.com/Delgan/loguru/blob/6571879c37904e3a18567e694d70651c6886b860/loguru/_logger.py#L1624-L1636 | train |
Delgan/loguru | loguru/_logger.py | Logger.stop | def stop(self, *args, **kwargs):
"""Deprecated function to |remove| an existing handler.
Warnings
--------
.. deprecated:: 0.2.2
``stop()`` will be removed in Loguru 1.0.0, it is replaced by ``remove()`` which is a less
confusing name.
"""
warnings.wa... | python | def stop(self, *args, **kwargs):
"""Deprecated function to |remove| an existing handler.
Warnings
--------
.. deprecated:: 0.2.2
``stop()`` will be removed in Loguru 1.0.0, it is replaced by ``remove()`` which is a less
confusing name.
"""
warnings.wa... | [
"def",
"stop",
"(",
"self",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"warnings",
".",
"warn",
"(",
"\"The 'stop()' method is deprecated, please use 'remove()' instead\"",
",",
"DeprecationWarning",
")",
"return",
"self",
".",
"remove",
"(",
"*",
"arg... | Deprecated function to |remove| an existing handler.
Warnings
--------
.. deprecated:: 0.2.2
``stop()`` will be removed in Loguru 1.0.0, it is replaced by ``remove()`` which is a less
confusing name. | [
"Deprecated",
"function",
"to",
"|remove|",
"an",
"existing",
"handler",
"."
] | 6571879c37904e3a18567e694d70651c6886b860 | https://github.com/Delgan/loguru/blob/6571879c37904e3a18567e694d70651c6886b860/loguru/_logger.py#L1638-L1650 | train |
graphql-python/graphene-django | graphene_django/rest_framework/serializer_converter.py | convert_serializer_field | def convert_serializer_field(field, is_input=True):
"""
Converts a django rest frameworks field to a graphql field
and marks the field as required if we are creating an input type
and the field itself is required
"""
graphql_type = get_graphene_type_from_serializer_field(field)
args = []
... | python | def convert_serializer_field(field, is_input=True):
"""
Converts a django rest frameworks field to a graphql field
and marks the field as required if we are creating an input type
and the field itself is required
"""
graphql_type = get_graphene_type_from_serializer_field(field)
args = []
... | [
"def",
"convert_serializer_field",
"(",
"field",
",",
"is_input",
"=",
"True",
")",
":",
"graphql_type",
"=",
"get_graphene_type_from_serializer_field",
"(",
"field",
")",
"args",
"=",
"[",
"]",
"kwargs",
"=",
"{",
"\"description\"",
":",
"field",
".",
"help_tex... | Converts a django rest frameworks field to a graphql field
and marks the field as required if we are creating an input type
and the field itself is required | [
"Converts",
"a",
"django",
"rest",
"frameworks",
"field",
"to",
"a",
"graphql",
"field",
"and",
"marks",
"the",
"field",
"as",
"required",
"if",
"we",
"are",
"creating",
"an",
"input",
"type",
"and",
"the",
"field",
"itself",
"is",
"required"
] | 20160113948b4167b61dbdaa477bb301227aac2e | https://github.com/graphql-python/graphene-django/blob/20160113948b4167b61dbdaa477bb301227aac2e/graphene_django/rest_framework/serializer_converter.py#L21-L56 | train |
graphql-python/graphene-django | graphene_django/settings.py | perform_import | def perform_import(val, setting_name):
"""
If the given setting is a string import notation,
then perform the necessary import or imports.
"""
if val is None:
return None
elif isinstance(val, six.string_types):
return import_from_string(val, setting_name)
elif isinstance(val,... | python | def perform_import(val, setting_name):
"""
If the given setting is a string import notation,
then perform the necessary import or imports.
"""
if val is None:
return None
elif isinstance(val, six.string_types):
return import_from_string(val, setting_name)
elif isinstance(val,... | [
"def",
"perform_import",
"(",
"val",
",",
"setting_name",
")",
":",
"if",
"val",
"is",
"None",
":",
"return",
"None",
"elif",
"isinstance",
"(",
"val",
",",
"six",
".",
"string_types",
")",
":",
"return",
"import_from_string",
"(",
"val",
",",
"setting_nam... | If the given setting is a string import notation,
then perform the necessary import or imports. | [
"If",
"the",
"given",
"setting",
"is",
"a",
"string",
"import",
"notation",
"then",
"perform",
"the",
"necessary",
"import",
"or",
"imports",
"."
] | 20160113948b4167b61dbdaa477bb301227aac2e | https://github.com/graphql-python/graphene-django/blob/20160113948b4167b61dbdaa477bb301227aac2e/graphene_django/settings.py#L47-L58 | train |
graphql-python/graphene-django | graphene_django/filter/filterset.py | custom_filterset_factory | def custom_filterset_factory(model, filterset_base_class=FilterSet, **meta):
""" Create a filterset for the given model using the provided meta data
"""
meta.update({"model": model})
meta_class = type(str("Meta"), (object,), meta)
filterset = type(
str("%sFilterSet" % model._meta.object_name... | python | def custom_filterset_factory(model, filterset_base_class=FilterSet, **meta):
""" Create a filterset for the given model using the provided meta data
"""
meta.update({"model": model})
meta_class = type(str("Meta"), (object,), meta)
filterset = type(
str("%sFilterSet" % model._meta.object_name... | [
"def",
"custom_filterset_factory",
"(",
"model",
",",
"filterset_base_class",
"=",
"FilterSet",
",",
"*",
"*",
"meta",
")",
":",
"meta",
".",
"update",
"(",
"{",
"\"model\"",
":",
"model",
"}",
")",
"meta_class",
"=",
"type",
"(",
"str",
"(",
"\"Meta\"",
... | Create a filterset for the given model using the provided meta data | [
"Create",
"a",
"filterset",
"for",
"the",
"given",
"model",
"using",
"the",
"provided",
"meta",
"data"
] | 20160113948b4167b61dbdaa477bb301227aac2e | https://github.com/graphql-python/graphene-django/blob/20160113948b4167b61dbdaa477bb301227aac2e/graphene_django/filter/filterset.py#L95-L105 | train |
graphql-python/graphene-django | graphene_django/filter/filterset.py | GlobalIDFilter.filter | def filter(self, qs, value):
""" Convert the filter value to a primary key before filtering """
_id = None
if value is not None:
_, _id = from_global_id(value)
return super(GlobalIDFilter, self).filter(qs, _id) | python | def filter(self, qs, value):
""" Convert the filter value to a primary key before filtering """
_id = None
if value is not None:
_, _id = from_global_id(value)
return super(GlobalIDFilter, self).filter(qs, _id) | [
"def",
"filter",
"(",
"self",
",",
"qs",
",",
"value",
")",
":",
"_id",
"=",
"None",
"if",
"value",
"is",
"not",
"None",
":",
"_",
",",
"_id",
"=",
"from_global_id",
"(",
"value",
")",
"return",
"super",
"(",
"GlobalIDFilter",
",",
"self",
")",
"."... | Convert the filter value to a primary key before filtering | [
"Convert",
"the",
"filter",
"value",
"to",
"a",
"primary",
"key",
"before",
"filtering"
] | 20160113948b4167b61dbdaa477bb301227aac2e | https://github.com/graphql-python/graphene-django/blob/20160113948b4167b61dbdaa477bb301227aac2e/graphene_django/filter/filterset.py#L16-L21 | train |
graphql-python/graphene-django | graphene_django/filter/utils.py | get_filtering_args_from_filterset | def get_filtering_args_from_filterset(filterset_class, type):
""" Inspect a FilterSet and produce the arguments to pass to
a Graphene Field. These arguments will be available to
filter against in the GraphQL
"""
from ..forms.converter import convert_form_field
args = {}
for name, fi... | python | def get_filtering_args_from_filterset(filterset_class, type):
""" Inspect a FilterSet and produce the arguments to pass to
a Graphene Field. These arguments will be available to
filter against in the GraphQL
"""
from ..forms.converter import convert_form_field
args = {}
for name, fi... | [
"def",
"get_filtering_args_from_filterset",
"(",
"filterset_class",
",",
"type",
")",
":",
"from",
".",
".",
"forms",
".",
"converter",
"import",
"convert_form_field",
"args",
"=",
"{",
"}",
"for",
"name",
",",
"filter_field",
"in",
"six",
".",
"iteritems",
"(... | Inspect a FilterSet and produce the arguments to pass to
a Graphene Field. These arguments will be available to
filter against in the GraphQL | [
"Inspect",
"a",
"FilterSet",
"and",
"produce",
"the",
"arguments",
"to",
"pass",
"to",
"a",
"Graphene",
"Field",
".",
"These",
"arguments",
"will",
"be",
"available",
"to",
"filter",
"against",
"in",
"the",
"GraphQL"
] | 20160113948b4167b61dbdaa477bb301227aac2e | https://github.com/graphql-python/graphene-django/blob/20160113948b4167b61dbdaa477bb301227aac2e/graphene_django/filter/utils.py#L6-L19 | train |
confluentinc/confluent-kafka-python | confluent_kafka/admin/__init__.py | AdminClient._make_topics_result | def _make_topics_result(f, futmap):
"""
Map per-topic results to per-topic futures in futmap.
The result value of each (successful) future is None.
"""
try:
result = f.result()
for topic, error in result.items():
fut = futmap.get(topic, Non... | python | def _make_topics_result(f, futmap):
"""
Map per-topic results to per-topic futures in futmap.
The result value of each (successful) future is None.
"""
try:
result = f.result()
for topic, error in result.items():
fut = futmap.get(topic, Non... | [
"def",
"_make_topics_result",
"(",
"f",
",",
"futmap",
")",
":",
"try",
":",
"result",
"=",
"f",
".",
"result",
"(",
")",
"for",
"topic",
",",
"error",
"in",
"result",
".",
"items",
"(",
")",
":",
"fut",
"=",
"futmap",
".",
"get",
"(",
"topic",
"... | Map per-topic results to per-topic futures in futmap.
The result value of each (successful) future is None. | [
"Map",
"per",
"-",
"topic",
"results",
"to",
"per",
"-",
"topic",
"futures",
"in",
"futmap",
".",
"The",
"result",
"value",
"of",
"each",
"(",
"successful",
")",
"future",
"is",
"None",
"."
] | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/admin/__init__.py#L219-L240 | train |
confluentinc/confluent-kafka-python | confluent_kafka/admin/__init__.py | AdminClient._make_resource_result | def _make_resource_result(f, futmap):
"""
Map per-resource results to per-resource futures in futmap.
The result value of each (successful) future is a ConfigResource.
"""
try:
result = f.result()
for resource, configs in result.items():
fu... | python | def _make_resource_result(f, futmap):
"""
Map per-resource results to per-resource futures in futmap.
The result value of each (successful) future is a ConfigResource.
"""
try:
result = f.result()
for resource, configs in result.items():
fu... | [
"def",
"_make_resource_result",
"(",
"f",
",",
"futmap",
")",
":",
"try",
":",
"result",
"=",
"f",
".",
"result",
"(",
")",
"for",
"resource",
",",
"configs",
"in",
"result",
".",
"items",
"(",
")",
":",
"fut",
"=",
"futmap",
".",
"get",
"(",
"reso... | Map per-resource results to per-resource futures in futmap.
The result value of each (successful) future is a ConfigResource. | [
"Map",
"per",
"-",
"resource",
"results",
"to",
"per",
"-",
"resource",
"futures",
"in",
"futmap",
".",
"The",
"result",
"value",
"of",
"each",
"(",
"successful",
")",
"future",
"is",
"a",
"ConfigResource",
"."
] | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/admin/__init__.py#L243-L265 | train |
confluentinc/confluent-kafka-python | confluent_kafka/admin/__init__.py | AdminClient._make_futures | def _make_futures(futmap_keys, class_check, make_result_fn):
"""
Create futures and a futuremap for the keys in futmap_keys,
and create a request-level future to be bassed to the C API.
"""
futmap = {}
for key in futmap_keys:
if class_check is not None and not... | python | def _make_futures(futmap_keys, class_check, make_result_fn):
"""
Create futures and a futuremap for the keys in futmap_keys,
and create a request-level future to be bassed to the C API.
"""
futmap = {}
for key in futmap_keys:
if class_check is not None and not... | [
"def",
"_make_futures",
"(",
"futmap_keys",
",",
"class_check",
",",
"make_result_fn",
")",
":",
"futmap",
"=",
"{",
"}",
"for",
"key",
"in",
"futmap_keys",
":",
"if",
"class_check",
"is",
"not",
"None",
"and",
"not",
"isinstance",
"(",
"key",
",",
"class_... | Create futures and a futuremap for the keys in futmap_keys,
and create a request-level future to be bassed to the C API. | [
"Create",
"futures",
"and",
"a",
"futuremap",
"for",
"the",
"keys",
"in",
"futmap_keys",
"and",
"create",
"a",
"request",
"-",
"level",
"future",
"to",
"be",
"bassed",
"to",
"the",
"C",
"API",
"."
] | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/admin/__init__.py#L268-L290 | train |
confluentinc/confluent-kafka-python | confluent_kafka/admin/__init__.py | AdminClient.create_topics | def create_topics(self, new_topics, **kwargs):
"""
Create new topics in cluster.
The future result() value is None.
:param list(NewTopic) new_topics: New topics to be created.
:param float operation_timeout: Set broker's operation timeout in seconds,
controlli... | python | def create_topics(self, new_topics, **kwargs):
"""
Create new topics in cluster.
The future result() value is None.
:param list(NewTopic) new_topics: New topics to be created.
:param float operation_timeout: Set broker's operation timeout in seconds,
controlli... | [
"def",
"create_topics",
"(",
"self",
",",
"new_topics",
",",
"*",
"*",
"kwargs",
")",
":",
"f",
",",
"futmap",
"=",
"AdminClient",
".",
"_make_futures",
"(",
"[",
"x",
".",
"topic",
"for",
"x",
"in",
"new_topics",
"]",
",",
"None",
",",
"AdminClient",
... | Create new topics in cluster.
The future result() value is None.
:param list(NewTopic) new_topics: New topics to be created.
:param float operation_timeout: Set broker's operation timeout in seconds,
controlling how long the CreateTopics request will block
o... | [
"Create",
"new",
"topics",
"in",
"cluster",
"."
] | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/admin/__init__.py#L292-L323 | train |
confluentinc/confluent-kafka-python | confluent_kafka/admin/__init__.py | AdminClient.delete_topics | def delete_topics(self, topics, **kwargs):
"""
Delete topics.
The future result() value is None.
:param list(str) topics: Topics to mark for deletion.
:param float operation_timeout: Set broker's operation timeout in seconds,
controlling how long the DeleteTop... | python | def delete_topics(self, topics, **kwargs):
"""
Delete topics.
The future result() value is None.
:param list(str) topics: Topics to mark for deletion.
:param float operation_timeout: Set broker's operation timeout in seconds,
controlling how long the DeleteTop... | [
"def",
"delete_topics",
"(",
"self",
",",
"topics",
",",
"*",
"*",
"kwargs",
")",
":",
"f",
",",
"futmap",
"=",
"AdminClient",
".",
"_make_futures",
"(",
"topics",
",",
"None",
",",
"AdminClient",
".",
"_make_topics_result",
")",
"super",
"(",
"AdminClient... | Delete topics.
The future result() value is None.
:param list(str) topics: Topics to mark for deletion.
:param float operation_timeout: Set broker's operation timeout in seconds,
controlling how long the DeleteTopics request will block
on the broker waiting ... | [
"Delete",
"topics",
"."
] | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/admin/__init__.py#L325-L353 | train |
confluentinc/confluent-kafka-python | confluent_kafka/admin/__init__.py | AdminClient.create_partitions | def create_partitions(self, new_partitions, **kwargs):
"""
Create additional partitions for the given topics.
The future result() value is None.
:param list(NewPartitions) new_partitions: New partitions to be created.
:param float operation_timeout: Set broker's operation timeo... | python | def create_partitions(self, new_partitions, **kwargs):
"""
Create additional partitions for the given topics.
The future result() value is None.
:param list(NewPartitions) new_partitions: New partitions to be created.
:param float operation_timeout: Set broker's operation timeo... | [
"def",
"create_partitions",
"(",
"self",
",",
"new_partitions",
",",
"*",
"*",
"kwargs",
")",
":",
"f",
",",
"futmap",
"=",
"AdminClient",
".",
"_make_futures",
"(",
"[",
"x",
".",
"topic",
"for",
"x",
"in",
"new_partitions",
"]",
",",
"None",
",",
"Ad... | Create additional partitions for the given topics.
The future result() value is None.
:param list(NewPartitions) new_partitions: New partitions to be created.
:param float operation_timeout: Set broker's operation timeout in seconds,
controlling how long the CreatePartitions ... | [
"Create",
"additional",
"partitions",
"for",
"the",
"given",
"topics",
"."
] | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/admin/__init__.py#L355-L386 | train |
confluentinc/confluent-kafka-python | confluent_kafka/admin/__init__.py | AdminClient.describe_configs | def describe_configs(self, resources, **kwargs):
"""
Get configuration for the specified resources.
The future result() value is a dict(<configname, ConfigEntry>).
:warning: Multiple resources and resource types may be requested,
but at most one resource of type RESOU... | python | def describe_configs(self, resources, **kwargs):
"""
Get configuration for the specified resources.
The future result() value is a dict(<configname, ConfigEntry>).
:warning: Multiple resources and resource types may be requested,
but at most one resource of type RESOU... | [
"def",
"describe_configs",
"(",
"self",
",",
"resources",
",",
"*",
"*",
"kwargs",
")",
":",
"f",
",",
"futmap",
"=",
"AdminClient",
".",
"_make_futures",
"(",
"resources",
",",
"ConfigResource",
",",
"AdminClient",
".",
"_make_resource_result",
")",
"super",
... | Get configuration for the specified resources.
The future result() value is a dict(<configname, ConfigEntry>).
:warning: Multiple resources and resource types may be requested,
but at most one resource of type RESOURCE_BROKER is allowed
per call since these resource... | [
"Get",
"configuration",
"for",
"the",
"specified",
"resources",
"."
] | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/admin/__init__.py#L388-L419 | train |
confluentinc/confluent-kafka-python | confluent_kafka/avro/load.py | loads | def loads(schema_str):
""" Parse a schema given a schema string """
try:
if sys.version_info[0] < 3:
return schema.parse(schema_str)
else:
return schema.Parse(schema_str)
except schema.SchemaParseException as e:
raise ClientError("Schema parse failed: %s" % (s... | python | def loads(schema_str):
""" Parse a schema given a schema string """
try:
if sys.version_info[0] < 3:
return schema.parse(schema_str)
else:
return schema.Parse(schema_str)
except schema.SchemaParseException as e:
raise ClientError("Schema parse failed: %s" % (s... | [
"def",
"loads",
"(",
"schema_str",
")",
":",
"try",
":",
"if",
"sys",
".",
"version_info",
"[",
"0",
"]",
"<",
"3",
":",
"return",
"schema",
".",
"parse",
"(",
"schema_str",
")",
"else",
":",
"return",
"schema",
".",
"Parse",
"(",
"schema_str",
")",
... | Parse a schema given a schema string | [
"Parse",
"a",
"schema",
"given",
"a",
"schema",
"string"
] | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/avro/load.py#L23-L31 | train |
confluentinc/confluent-kafka-python | confluent_kafka/avro/__init__.py | AvroProducer.produce | def produce(self, **kwargs):
"""
Asynchronously sends message to Kafka by encoding with specified or default avro schema.
:param str topic: topic name
:param object value: An object to serialize
:param str value_schema: Avro schema for value
:param ob... | python | def produce(self, **kwargs):
"""
Asynchronously sends message to Kafka by encoding with specified or default avro schema.
:param str topic: topic name
:param object value: An object to serialize
:param str value_schema: Avro schema for value
:param ob... | [
"def",
"produce",
"(",
"self",
",",
"*",
"*",
"kwargs",
")",
":",
"# get schemas from kwargs if defined",
"key_schema",
"=",
"kwargs",
".",
"pop",
"(",
"'key_schema'",
",",
"self",
".",
"_key_schema",
")",
"value_schema",
"=",
"kwargs",
".",
"pop",
"(",
"'v... | Asynchronously sends message to Kafka by encoding with specified or default avro schema.
:param str topic: topic name
:param object value: An object to serialize
:param str value_schema: Avro schema for value
:param object key: An object to serialize
:param s... | [
"Asynchronously",
"sends",
"message",
"to",
"Kafka",
"by",
"encoding",
"with",
"specified",
"or",
"default",
"avro",
"schema",
"."
] | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/avro/__init__.py#L53-L90 | train |
confluentinc/confluent-kafka-python | confluent_kafka/avro/__init__.py | AvroConsumer.poll | def poll(self, timeout=None):
"""
This is an overriden method from confluent_kafka.Consumer class. This handles message
deserialization using avro schema
:param float timeout: Poll timeout in seconds (default: indefinite)
:returns: message object with deserialized key and value ... | python | def poll(self, timeout=None):
"""
This is an overriden method from confluent_kafka.Consumer class. This handles message
deserialization using avro schema
:param float timeout: Poll timeout in seconds (default: indefinite)
:returns: message object with deserialized key and value ... | [
"def",
"poll",
"(",
"self",
",",
"timeout",
"=",
"None",
")",
":",
"if",
"timeout",
"is",
"None",
":",
"timeout",
"=",
"-",
"1",
"message",
"=",
"super",
"(",
"AvroConsumer",
",",
"self",
")",
".",
"poll",
"(",
"timeout",
")",
"if",
"message",
"is"... | This is an overriden method from confluent_kafka.Consumer class. This handles message
deserialization using avro schema
:param float timeout: Poll timeout in seconds (default: indefinite)
:returns: message object with deserialized key and value as dict objects
:rtype: Message | [
"This",
"is",
"an",
"overriden",
"method",
"from",
"confluent_kafka",
".",
"Consumer",
"class",
".",
"This",
"handles",
"message",
"deserialization",
"using",
"avro",
"schema"
] | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/avro/__init__.py#L128-L157 | train |
confluentinc/confluent-kafka-python | confluent_kafka/avro/serializer/message_serializer.py | MessageSerializer.encode_record_with_schema | def encode_record_with_schema(self, topic, schema, record, is_key=False):
"""
Given a parsed avro schema, encode a record for the given topic. The
record is expected to be a dictionary.
The schema is registered with the subject of 'topic-value'
:param str topic: Topic name
... | python | def encode_record_with_schema(self, topic, schema, record, is_key=False):
"""
Given a parsed avro schema, encode a record for the given topic. The
record is expected to be a dictionary.
The schema is registered with the subject of 'topic-value'
:param str topic: Topic name
... | [
"def",
"encode_record_with_schema",
"(",
"self",
",",
"topic",
",",
"schema",
",",
"record",
",",
"is_key",
"=",
"False",
")",
":",
"serialize_err",
"=",
"KeySerializerError",
"if",
"is_key",
"else",
"ValueSerializerError",
"subject_suffix",
"=",
"(",
"'-key'",
... | Given a parsed avro schema, encode a record for the given topic. The
record is expected to be a dictionary.
The schema is registered with the subject of 'topic-value'
:param str topic: Topic name
:param schema schema: Avro Schema
:param dict record: An object to serialize
... | [
"Given",
"a",
"parsed",
"avro",
"schema",
"encode",
"a",
"record",
"for",
"the",
"given",
"topic",
".",
"The",
"record",
"is",
"expected",
"to",
"be",
"a",
"dictionary",
"."
] | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/avro/serializer/message_serializer.py#L86-L113 | train |
confluentinc/confluent-kafka-python | confluent_kafka/avro/serializer/message_serializer.py | MessageSerializer.encode_record_with_schema_id | def encode_record_with_schema_id(self, schema_id, record, is_key=False):
"""
Encode a record with a given schema id. The record must
be a python dictionary.
:param int schema_id: integer ID
:param dict record: An object to serialize
:param bool is_key: If the record is a... | python | def encode_record_with_schema_id(self, schema_id, record, is_key=False):
"""
Encode a record with a given schema id. The record must
be a python dictionary.
:param int schema_id: integer ID
:param dict record: An object to serialize
:param bool is_key: If the record is a... | [
"def",
"encode_record_with_schema_id",
"(",
"self",
",",
"schema_id",
",",
"record",
",",
"is_key",
"=",
"False",
")",
":",
"serialize_err",
"=",
"KeySerializerError",
"if",
"is_key",
"else",
"ValueSerializerError",
"# use slow avro",
"if",
"schema_id",
"not",
"in",... | Encode a record with a given schema id. The record must
be a python dictionary.
:param int schema_id: integer ID
:param dict record: An object to serialize
:param bool is_key: If the record is a key
:returns: decoder function
:rtype: func | [
"Encode",
"a",
"record",
"with",
"a",
"given",
"schema",
"id",
".",
"The",
"record",
"must",
"be",
"a",
"python",
"dictionary",
".",
":",
"param",
"int",
"schema_id",
":",
"integer",
"ID",
":",
"param",
"dict",
"record",
":",
"An",
"object",
"to",
"ser... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/avro/serializer/message_serializer.py#L115-L149 | train |
confluentinc/confluent-kafka-python | confluent_kafka/avro/serializer/message_serializer.py | MessageSerializer.decode_message | def decode_message(self, message, is_key=False):
"""
Decode a message from kafka that has been encoded for use with
the schema registry.
:param str|bytes or None message: message key or value to be decoded
:returns: Decoded message contents.
:rtype dict:
"""
... | python | def decode_message(self, message, is_key=False):
"""
Decode a message from kafka that has been encoded for use with
the schema registry.
:param str|bytes or None message: message key or value to be decoded
:returns: Decoded message contents.
:rtype dict:
"""
... | [
"def",
"decode_message",
"(",
"self",
",",
"message",
",",
"is_key",
"=",
"False",
")",
":",
"if",
"message",
"is",
"None",
":",
"return",
"None",
"if",
"len",
"(",
"message",
")",
"<=",
"5",
":",
"raise",
"SerializerError",
"(",
"\"message is too small to... | Decode a message from kafka that has been encoded for use with
the schema registry.
:param str|bytes or None message: message key or value to be decoded
:returns: Decoded message contents.
:rtype dict: | [
"Decode",
"a",
"message",
"from",
"kafka",
"that",
"has",
"been",
"encoded",
"for",
"use",
"with",
"the",
"schema",
"registry",
".",
":",
"param",
"str|bytes",
"or",
"None",
"message",
":",
"message",
"key",
"or",
"value",
"to",
"be",
"decoded",
":",
"re... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/avro/serializer/message_serializer.py#L207-L227 | train |
confluentinc/confluent-kafka-python | examples/confluent_cloud.py | acked | def acked(err, msg):
"""Delivery report callback called (from flush()) on successful or failed delivery of the message."""
if err is not None:
print("failed to deliver message: {}".format(err.str()))
else:
print("produced to: {} [{}] @ {}".format(msg.topic(), msg.partition(), msg.offset())) | python | def acked(err, msg):
"""Delivery report callback called (from flush()) on successful or failed delivery of the message."""
if err is not None:
print("failed to deliver message: {}".format(err.str()))
else:
print("produced to: {} [{}] @ {}".format(msg.topic(), msg.partition(), msg.offset())) | [
"def",
"acked",
"(",
"err",
",",
"msg",
")",
":",
"if",
"err",
"is",
"not",
"None",
":",
"print",
"(",
"\"failed to deliver message: {}\"",
".",
"format",
"(",
"err",
".",
"str",
"(",
")",
")",
")",
"else",
":",
"print",
"(",
"\"produced to: {} [{}] @ {}... | Delivery report callback called (from flush()) on successful or failed delivery of the message. | [
"Delivery",
"report",
"callback",
"called",
"(",
"from",
"flush",
"()",
")",
"on",
"successful",
"or",
"failed",
"delivery",
"of",
"the",
"message",
"."
] | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/examples/confluent_cloud.py#L65-L70 | train |
confluentinc/confluent-kafka-python | examples/adminapi.py | example_create_topics | def example_create_topics(a, topics):
""" Create topics """
new_topics = [NewTopic(topic, num_partitions=3, replication_factor=1) for topic in topics]
# Call create_topics to asynchronously create topics, a dict
# of <topic,future> is returned.
fs = a.create_topics(new_topics)
# Wait for opera... | python | def example_create_topics(a, topics):
""" Create topics """
new_topics = [NewTopic(topic, num_partitions=3, replication_factor=1) for topic in topics]
# Call create_topics to asynchronously create topics, a dict
# of <topic,future> is returned.
fs = a.create_topics(new_topics)
# Wait for opera... | [
"def",
"example_create_topics",
"(",
"a",
",",
"topics",
")",
":",
"new_topics",
"=",
"[",
"NewTopic",
"(",
"topic",
",",
"num_partitions",
"=",
"3",
",",
"replication_factor",
"=",
"1",
")",
"for",
"topic",
"in",
"topics",
"]",
"# Call create_topics to asynch... | Create topics | [
"Create",
"topics"
] | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/examples/adminapi.py#L31-L48 | train |
confluentinc/confluent-kafka-python | examples/adminapi.py | example_delete_topics | def example_delete_topics(a, topics):
""" delete topics """
# Call delete_topics to asynchronously delete topics, a future is returned.
# By default this operation on the broker returns immediately while
# topics are deleted in the background. But here we give it some time (30s)
# to propagate in t... | python | def example_delete_topics(a, topics):
""" delete topics """
# Call delete_topics to asynchronously delete topics, a future is returned.
# By default this operation on the broker returns immediately while
# topics are deleted in the background. But here we give it some time (30s)
# to propagate in t... | [
"def",
"example_delete_topics",
"(",
"a",
",",
"topics",
")",
":",
"# Call delete_topics to asynchronously delete topics, a future is returned.",
"# By default this operation on the broker returns immediately while",
"# topics are deleted in the background. But here we give it some time (30s)",
... | delete topics | [
"delete",
"topics"
] | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/examples/adminapi.py#L51-L68 | train |
confluentinc/confluent-kafka-python | examples/adminapi.py | example_create_partitions | def example_create_partitions(a, topics):
""" create partitions """
new_parts = [NewPartitions(topic, int(new_total_count)) for
topic, new_total_count in zip(topics[0::2], topics[1::2])]
# Try switching validate_only to True to only validate the operation
# on the broker but not actua... | python | def example_create_partitions(a, topics):
""" create partitions """
new_parts = [NewPartitions(topic, int(new_total_count)) for
topic, new_total_count in zip(topics[0::2], topics[1::2])]
# Try switching validate_only to True to only validate the operation
# on the broker but not actua... | [
"def",
"example_create_partitions",
"(",
"a",
",",
"topics",
")",
":",
"new_parts",
"=",
"[",
"NewPartitions",
"(",
"topic",
",",
"int",
"(",
"new_total_count",
")",
")",
"for",
"topic",
",",
"new_total_count",
"in",
"zip",
"(",
"topics",
"[",
"0",
":",
... | create partitions | [
"create",
"partitions"
] | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/examples/adminapi.py#L71-L87 | train |
confluentinc/confluent-kafka-python | examples/adminapi.py | example_describe_configs | def example_describe_configs(a, args):
""" describe configs """
resources = [ConfigResource(restype, resname) for
restype, resname in zip(args[0::2], args[1::2])]
fs = a.describe_configs(resources)
# Wait for operation to finish.
for res, f in fs.items():
try:
... | python | def example_describe_configs(a, args):
""" describe configs """
resources = [ConfigResource(restype, resname) for
restype, resname in zip(args[0::2], args[1::2])]
fs = a.describe_configs(resources)
# Wait for operation to finish.
for res, f in fs.items():
try:
... | [
"def",
"example_describe_configs",
"(",
"a",
",",
"args",
")",
":",
"resources",
"=",
"[",
"ConfigResource",
"(",
"restype",
",",
"resname",
")",
"for",
"restype",
",",
"resname",
"in",
"zip",
"(",
"args",
"[",
"0",
":",
":",
"2",
"]",
",",
"args",
"... | describe configs | [
"describe",
"configs"
] | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/examples/adminapi.py#L99-L117 | train |
confluentinc/confluent-kafka-python | examples/adminapi.py | example_alter_configs | def example_alter_configs(a, args):
""" Alter configs atomically, replacing non-specified
configuration properties with their default values.
"""
resources = []
for restype, resname, configs in zip(args[0::3], args[1::3], args[2::3]):
resource = ConfigResource(restype, resname)
reso... | python | def example_alter_configs(a, args):
""" Alter configs atomically, replacing non-specified
configuration properties with their default values.
"""
resources = []
for restype, resname, configs in zip(args[0::3], args[1::3], args[2::3]):
resource = ConfigResource(restype, resname)
reso... | [
"def",
"example_alter_configs",
"(",
"a",
",",
"args",
")",
":",
"resources",
"=",
"[",
"]",
"for",
"restype",
",",
"resname",
",",
"configs",
"in",
"zip",
"(",
"args",
"[",
"0",
":",
":",
"3",
"]",
",",
"args",
"[",
"1",
":",
":",
"3",
"]",
",... | Alter configs atomically, replacing non-specified
configuration properties with their default values. | [
"Alter",
"configs",
"atomically",
"replacing",
"non",
"-",
"specified",
"configuration",
"properties",
"with",
"their",
"default",
"values",
"."
] | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/examples/adminapi.py#L120-L140 | train |
confluentinc/confluent-kafka-python | examples/adminapi.py | example_delta_alter_configs | def example_delta_alter_configs(a, args):
"""
The AlterConfigs Kafka API requires all configuration to be passed,
any left out configuration properties will revert to their default settings.
This example shows how to just modify the supplied configuration entries
by first reading the configuration ... | python | def example_delta_alter_configs(a, args):
"""
The AlterConfigs Kafka API requires all configuration to be passed,
any left out configuration properties will revert to their default settings.
This example shows how to just modify the supplied configuration entries
by first reading the configuration ... | [
"def",
"example_delta_alter_configs",
"(",
"a",
",",
"args",
")",
":",
"# Convert supplied config to resources.",
"# We can reuse the same resources both for describe_configs and",
"# alter_configs.",
"resources",
"=",
"[",
"]",
"for",
"restype",
",",
"resname",
",",
"configs... | The AlterConfigs Kafka API requires all configuration to be passed,
any left out configuration properties will revert to their default settings.
This example shows how to just modify the supplied configuration entries
by first reading the configuration from the broker, updating the supplied
configurati... | [
"The",
"AlterConfigs",
"Kafka",
"API",
"requires",
"all",
"configuration",
"to",
"be",
"passed",
"any",
"left",
"out",
"configuration",
"properties",
"will",
"revert",
"to",
"their",
"default",
"settings",
"."
] | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/examples/adminapi.py#L143-L232 | train |
confluentinc/confluent-kafka-python | examples/adminapi.py | example_list | def example_list(a, args):
""" list topics and cluster metadata """
if len(args) == 0:
what = "all"
else:
what = args[0]
md = a.list_topics(timeout=10)
print("Cluster {} metadata (response from broker {}):".format(md.cluster_id, md.orig_broker_name))
if what in ("all", "broke... | python | def example_list(a, args):
""" list topics and cluster metadata """
if len(args) == 0:
what = "all"
else:
what = args[0]
md = a.list_topics(timeout=10)
print("Cluster {} metadata (response from broker {}):".format(md.cluster_id, md.orig_broker_name))
if what in ("all", "broke... | [
"def",
"example_list",
"(",
"a",
",",
"args",
")",
":",
"if",
"len",
"(",
"args",
")",
"==",
"0",
":",
"what",
"=",
"\"all\"",
"else",
":",
"what",
"=",
"args",
"[",
"0",
"]",
"md",
"=",
"a",
".",
"list_topics",
"(",
"timeout",
"=",
"10",
")",
... | list topics and cluster metadata | [
"list",
"topics",
"and",
"cluster",
"metadata"
] | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/examples/adminapi.py#L235-L274 | train |
confluentinc/confluent-kafka-python | confluent_kafka/__init__.py | _resolve_plugins | def _resolve_plugins(plugins):
""" Resolve embedded plugins from the wheel's library directory.
For internal module use only.
:param str plugins: The plugin.library.paths value
"""
import os
from sys import platform
# Location of __init__.py and the embedded library directory
... | python | def _resolve_plugins(plugins):
""" Resolve embedded plugins from the wheel's library directory.
For internal module use only.
:param str plugins: The plugin.library.paths value
"""
import os
from sys import platform
# Location of __init__.py and the embedded library directory
... | [
"def",
"_resolve_plugins",
"(",
"plugins",
")",
":",
"import",
"os",
"from",
"sys",
"import",
"platform",
"# Location of __init__.py and the embedded library directory",
"basedir",
"=",
"os",
".",
"path",
".",
"dirname",
"(",
"__file__",
")",
"if",
"platform",
"in",... | Resolve embedded plugins from the wheel's library directory.
For internal module use only.
:param str plugins: The plugin.library.paths value | [
"Resolve",
"embedded",
"plugins",
"from",
"the",
"wheel",
"s",
"library",
"directory",
"."
] | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/__init__.py#L47-L102 | train |
confluentinc/confluent-kafka-python | examples/avro-cli.py | on_delivery | def on_delivery(err, msg, obj):
"""
Handle delivery reports served from producer.poll.
This callback takes an extra argument, obj.
This allows the original contents to be included for debugging purposes.
"""
if err is not None:
print('Message {} delivery failed for user {} wi... | python | def on_delivery(err, msg, obj):
"""
Handle delivery reports served from producer.poll.
This callback takes an extra argument, obj.
This allows the original contents to be included for debugging purposes.
"""
if err is not None:
print('Message {} delivery failed for user {} wi... | [
"def",
"on_delivery",
"(",
"err",
",",
"msg",
",",
"obj",
")",
":",
"if",
"err",
"is",
"not",
"None",
":",
"print",
"(",
"'Message {} delivery failed for user {} with error {}'",
".",
"format",
"(",
"obj",
".",
"id",
",",
"obj",
".",
"name",
",",
"err",
... | Handle delivery reports served from producer.poll.
This callback takes an extra argument, obj.
This allows the original contents to be included for debugging purposes. | [
"Handle",
"delivery",
"reports",
"served",
"from",
"producer",
".",
"poll",
".",
"This",
"callback",
"takes",
"an",
"extra",
"argument",
"obj",
".",
"This",
"allows",
"the",
"original",
"contents",
"to",
"be",
"included",
"for",
"debugging",
"purposes",
"."
] | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/examples/avro-cli.py#L68-L79 | train |
confluentinc/confluent-kafka-python | examples/avro-cli.py | produce | def produce(topic, conf):
"""
Produce User records
"""
from confluent_kafka.avro import AvroProducer
producer = AvroProducer(conf, default_value_schema=record_schema)
print("Producing user records to topic {}. ^c to exit.".format(topic))
while True:
# Instantiate new User, pop... | python | def produce(topic, conf):
"""
Produce User records
"""
from confluent_kafka.avro import AvroProducer
producer = AvroProducer(conf, default_value_schema=record_schema)
print("Producing user records to topic {}. ^c to exit.".format(topic))
while True:
# Instantiate new User, pop... | [
"def",
"produce",
"(",
"topic",
",",
"conf",
")",
":",
"from",
"confluent_kafka",
".",
"avro",
"import",
"AvroProducer",
"producer",
"=",
"AvroProducer",
"(",
"conf",
",",
"default_value_schema",
"=",
"record_schema",
")",
"print",
"(",
"\"Producing user records t... | Produce User records | [
"Produce",
"User",
"records"
] | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/examples/avro-cli.py#L82-L113 | train |
confluentinc/confluent-kafka-python | examples/avro-cli.py | consume | def consume(topic, conf):
"""
Consume User records
"""
from confluent_kafka.avro import AvroConsumer
from confluent_kafka.avro.serializer import SerializerError
print("Consuming user records from topic {} with group {}. ^c to exit.".format(topic, conf["group.id"]))
c = AvroConsumer(con... | python | def consume(topic, conf):
"""
Consume User records
"""
from confluent_kafka.avro import AvroConsumer
from confluent_kafka.avro.serializer import SerializerError
print("Consuming user records from topic {} with group {}. ^c to exit.".format(topic, conf["group.id"]))
c = AvroConsumer(con... | [
"def",
"consume",
"(",
"topic",
",",
"conf",
")",
":",
"from",
"confluent_kafka",
".",
"avro",
"import",
"AvroConsumer",
"from",
"confluent_kafka",
".",
"avro",
".",
"serializer",
"import",
"SerializerError",
"print",
"(",
"\"Consuming user records from topic {} with ... | Consume User records | [
"Consume",
"User",
"records"
] | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/examples/avro-cli.py#L116-L151 | train |
confluentinc/confluent-kafka-python | confluent_kafka/avro/cached_schema_registry_client.py | CachedSchemaRegistryClient.register | def register(self, subject, avro_schema):
"""
POST /subjects/(string: subject)/versions
Register a schema with the registry under the given subject
and receive a schema id.
avro_schema must be a parsed schema from the python avro library
Multiple instances of the same s... | python | def register(self, subject, avro_schema):
"""
POST /subjects/(string: subject)/versions
Register a schema with the registry under the given subject
and receive a schema id.
avro_schema must be a parsed schema from the python avro library
Multiple instances of the same s... | [
"def",
"register",
"(",
"self",
",",
"subject",
",",
"avro_schema",
")",
":",
"schemas_to_id",
"=",
"self",
".",
"subject_to_schema_ids",
"[",
"subject",
"]",
"schema_id",
"=",
"schemas_to_id",
".",
"get",
"(",
"avro_schema",
",",
"None",
")",
"if",
"schema_... | POST /subjects/(string: subject)/versions
Register a schema with the registry under the given subject
and receive a schema id.
avro_schema must be a parsed schema from the python avro library
Multiple instances of the same schema will result in cache misses.
:param str subject... | [
"POST",
"/",
"subjects",
"/",
"(",
"string",
":",
"subject",
")",
"/",
"versions",
"Register",
"a",
"schema",
"with",
"the",
"registry",
"under",
"the",
"given",
"subject",
"and",
"receive",
"a",
"schema",
"id",
"."
] | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/avro/cached_schema_registry_client.py#L192-L230 | train |
confluentinc/confluent-kafka-python | confluent_kafka/avro/cached_schema_registry_client.py | CachedSchemaRegistryClient.delete_subject | def delete_subject(self, subject):
"""
DELETE /subjects/(string: subject)
Deletes the specified subject and its associated compatibility level if registered.
It is recommended to use this API only when a topic needs to be recycled or in development environments.
:param subject: s... | python | def delete_subject(self, subject):
"""
DELETE /subjects/(string: subject)
Deletes the specified subject and its associated compatibility level if registered.
It is recommended to use this API only when a topic needs to be recycled or in development environments.
:param subject: s... | [
"def",
"delete_subject",
"(",
"self",
",",
"subject",
")",
":",
"url",
"=",
"'/'",
".",
"join",
"(",
"[",
"self",
".",
"url",
",",
"'subjects'",
",",
"subject",
"]",
")",
"result",
",",
"code",
"=",
"self",
".",
"_send_request",
"(",
"url",
",",
"m... | DELETE /subjects/(string: subject)
Deletes the specified subject and its associated compatibility level if registered.
It is recommended to use this API only when a topic needs to be recycled or in development environments.
:param subject: subject name
:returns: version of the schema del... | [
"DELETE",
"/",
"subjects",
"/",
"(",
"string",
":",
"subject",
")",
"Deletes",
"the",
"specified",
"subject",
"and",
"its",
"associated",
"compatibility",
"level",
"if",
"registered",
".",
"It",
"is",
"recommended",
"to",
"use",
"this",
"API",
"only",
"when"... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/avro/cached_schema_registry_client.py#L232-L247 | train |
confluentinc/confluent-kafka-python | confluent_kafka/avro/cached_schema_registry_client.py | CachedSchemaRegistryClient.get_by_id | def get_by_id(self, schema_id):
"""
GET /schemas/ids/{int: id}
Retrieve a parsed avro schema by id or None if not found
:param int schema_id: int value
:returns: Avro schema
:rtype: schema
"""
if schema_id in self.id_to_schema:
return self.id_t... | python | def get_by_id(self, schema_id):
"""
GET /schemas/ids/{int: id}
Retrieve a parsed avro schema by id or None if not found
:param int schema_id: int value
:returns: Avro schema
:rtype: schema
"""
if schema_id in self.id_to_schema:
return self.id_t... | [
"def",
"get_by_id",
"(",
"self",
",",
"schema_id",
")",
":",
"if",
"schema_id",
"in",
"self",
".",
"id_to_schema",
":",
"return",
"self",
".",
"id_to_schema",
"[",
"schema_id",
"]",
"# fetch from the registry",
"url",
"=",
"'/'",
".",
"join",
"(",
"[",
"se... | GET /schemas/ids/{int: id}
Retrieve a parsed avro schema by id or None if not found
:param int schema_id: int value
:returns: Avro schema
:rtype: schema | [
"GET",
"/",
"schemas",
"/",
"ids",
"/",
"{",
"int",
":",
"id",
"}",
"Retrieve",
"a",
"parsed",
"avro",
"schema",
"by",
"id",
"or",
"None",
"if",
"not",
"found",
":",
"param",
"int",
"schema_id",
":",
"int",
"value",
":",
"returns",
":",
"Avro",
"sc... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/avro/cached_schema_registry_client.py#L249-L279 | train |
confluentinc/confluent-kafka-python | confluent_kafka/avro/cached_schema_registry_client.py | CachedSchemaRegistryClient.get_version | def get_version(self, subject, avro_schema):
"""
POST /subjects/(string: subject)
Get the version of a schema for a given subject.
Returns None if not found.
:param str subject: subject name
:param: schema avro_schema: Avro schema
:returns: version
:rtyp... | python | def get_version(self, subject, avro_schema):
"""
POST /subjects/(string: subject)
Get the version of a schema for a given subject.
Returns None if not found.
:param str subject: subject name
:param: schema avro_schema: Avro schema
:returns: version
:rtyp... | [
"def",
"get_version",
"(",
"self",
",",
"subject",
",",
"avro_schema",
")",
":",
"schemas_to_version",
"=",
"self",
".",
"subject_to_schema_versions",
"[",
"subject",
"]",
"version",
"=",
"schemas_to_version",
".",
"get",
"(",
"avro_schema",
",",
"None",
")",
... | POST /subjects/(string: subject)
Get the version of a schema for a given subject.
Returns None if not found.
:param str subject: subject name
:param: schema avro_schema: Avro schema
:returns: version
:rtype: int | [
"POST",
"/",
"subjects",
"/",
"(",
"string",
":",
"subject",
")"
] | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/avro/cached_schema_registry_client.py#L321-L351 | train |
confluentinc/confluent-kafka-python | confluent_kafka/avro/cached_schema_registry_client.py | CachedSchemaRegistryClient.update_compatibility | def update_compatibility(self, level, subject=None):
"""
PUT /config/(string: subject)
Update the compatibility level for a subject. Level must be one of:
:param str level: ex: 'NONE','FULL','FORWARD', or 'BACKWARD'
"""
if level not in VALID_LEVELS:
raise C... | python | def update_compatibility(self, level, subject=None):
"""
PUT /config/(string: subject)
Update the compatibility level for a subject. Level must be one of:
:param str level: ex: 'NONE','FULL','FORWARD', or 'BACKWARD'
"""
if level not in VALID_LEVELS:
raise C... | [
"def",
"update_compatibility",
"(",
"self",
",",
"level",
",",
"subject",
"=",
"None",
")",
":",
"if",
"level",
"not",
"in",
"VALID_LEVELS",
":",
"raise",
"ClientError",
"(",
"\"Invalid level specified: %s\"",
"%",
"(",
"str",
"(",
"level",
")",
")",
")",
... | PUT /config/(string: subject)
Update the compatibility level for a subject. Level must be one of:
:param str level: ex: 'NONE','FULL','FORWARD', or 'BACKWARD' | [
"PUT",
"/",
"config",
"/",
"(",
"string",
":",
"subject",
")"
] | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/avro/cached_schema_registry_client.py#L385-L405 | train |
confluentinc/confluent-kafka-python | confluent_kafka/avro/cached_schema_registry_client.py | CachedSchemaRegistryClient.get_compatibility | def get_compatibility(self, subject=None):
"""
GET /config
Get the current compatibility level for a subject. Result will be one of:
:param str subject: subject name
:raises ClientError: if the request was unsuccessful or an invalid compatibility level was returned
:ret... | python | def get_compatibility(self, subject=None):
"""
GET /config
Get the current compatibility level for a subject. Result will be one of:
:param str subject: subject name
:raises ClientError: if the request was unsuccessful or an invalid compatibility level was returned
:ret... | [
"def",
"get_compatibility",
"(",
"self",
",",
"subject",
"=",
"None",
")",
":",
"url",
"=",
"'/'",
".",
"join",
"(",
"[",
"self",
".",
"url",
",",
"'config'",
"]",
")",
"if",
"subject",
":",
"url",
"=",
"'/'",
".",
"join",
"(",
"[",
"url",
",",
... | GET /config
Get the current compatibility level for a subject. Result will be one of:
:param str subject: subject name
:raises ClientError: if the request was unsuccessful or an invalid compatibility level was returned
:returns: one of 'NONE','FULL','FORWARD', or 'BACKWARD'
:rt... | [
"GET",
"/",
"config",
"Get",
"the",
"current",
"compatibility",
"level",
"for",
"a",
"subject",
".",
"Result",
"will",
"be",
"one",
"of",
":"
] | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/avro/cached_schema_registry_client.py#L407-L434 | train |
confluentinc/confluent-kafka-python | tools/download-s3.py | Artifact.download | def download(self, dirpath):
""" Download artifact from S3 and store in dirpath directory.
If the artifact is already downloaded nothing is done. """
if os.path.isfile(self.lpath) and os.path.getsize(self.lpath) > 0:
return
print('Downloading %s -> %s' % (self.path, self.... | python | def download(self, dirpath):
""" Download artifact from S3 and store in dirpath directory.
If the artifact is already downloaded nothing is done. """
if os.path.isfile(self.lpath) and os.path.getsize(self.lpath) > 0:
return
print('Downloading %s -> %s' % (self.path, self.... | [
"def",
"download",
"(",
"self",
",",
"dirpath",
")",
":",
"if",
"os",
".",
"path",
".",
"isfile",
"(",
"self",
".",
"lpath",
")",
"and",
"os",
".",
"path",
".",
"getsize",
"(",
"self",
".",
"lpath",
")",
">",
"0",
":",
"return",
"print",
"(",
"... | Download artifact from S3 and store in dirpath directory.
If the artifact is already downloaded nothing is done. | [
"Download",
"artifact",
"from",
"S3",
"and",
"store",
"in",
"dirpath",
"directory",
".",
"If",
"the",
"artifact",
"is",
"already",
"downloaded",
"nothing",
"is",
"done",
"."
] | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/tools/download-s3.py#L46-L54 | train |
confluentinc/confluent-kafka-python | tools/download-s3.py | Artifacts.collect_single_s3 | def collect_single_s3(self, path):
""" Collect single S3 artifact
:param: path string: S3 path
"""
# The S3 folder contains the tokens needed to perform
# matching of project, gitref, etc.
folder = os.path.dirname(path)
rinfo = re.findall(r'(?P<tag>[^-]+)-(?P<v... | python | def collect_single_s3(self, path):
""" Collect single S3 artifact
:param: path string: S3 path
"""
# The S3 folder contains the tokens needed to perform
# matching of project, gitref, etc.
folder = os.path.dirname(path)
rinfo = re.findall(r'(?P<tag>[^-]+)-(?P<v... | [
"def",
"collect_single_s3",
"(",
"self",
",",
"path",
")",
":",
"# The S3 folder contains the tokens needed to perform",
"# matching of project, gitref, etc.",
"folder",
"=",
"os",
".",
"path",
".",
"dirname",
"(",
"path",
")",
"rinfo",
"=",
"re",
".",
"findall",
"(... | Collect single S3 artifact
:param: path string: S3 path | [
"Collect",
"single",
"S3",
"artifact",
":",
"param",
":",
"path",
"string",
":",
"S3",
"path"
] | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/tools/download-s3.py#L68-L102 | train |
confluentinc/confluent-kafka-python | tools/download-s3.py | Artifacts.collect_s3 | def collect_s3(self):
""" Collect and download build-artifacts from S3 based on git reference """
print('Collecting artifacts matching tag/sha %s from S3 bucket %s' % (self.gitref, s3_bucket))
self.s3 = boto3.resource('s3')
self.s3_bucket = self.s3.Bucket(s3_bucket)
self.s3.meta.... | python | def collect_s3(self):
""" Collect and download build-artifacts from S3 based on git reference """
print('Collecting artifacts matching tag/sha %s from S3 bucket %s' % (self.gitref, s3_bucket))
self.s3 = boto3.resource('s3')
self.s3_bucket = self.s3.Bucket(s3_bucket)
self.s3.meta.... | [
"def",
"collect_s3",
"(",
"self",
")",
":",
"print",
"(",
"'Collecting artifacts matching tag/sha %s from S3 bucket %s'",
"%",
"(",
"self",
".",
"gitref",
",",
"s3_bucket",
")",
")",
"self",
".",
"s3",
"=",
"boto3",
".",
"resource",
"(",
"'s3'",
")",
"self",
... | Collect and download build-artifacts from S3 based on git reference | [
"Collect",
"and",
"download",
"build",
"-",
"artifacts",
"from",
"S3",
"based",
"on",
"git",
"reference"
] | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/tools/download-s3.py#L104-L114 | train |
confluentinc/confluent-kafka-python | tools/download-s3.py | Artifacts.collect_local | def collect_local(self, path):
""" Collect artifacts from a local directory possibly previously
collected from s3 """
for f in os.listdir(path):
lpath = os.path.join(path, f)
if not os.path.isfile(lpath):
continue
Artifact(self, lpath) | python | def collect_local(self, path):
""" Collect artifacts from a local directory possibly previously
collected from s3 """
for f in os.listdir(path):
lpath = os.path.join(path, f)
if not os.path.isfile(lpath):
continue
Artifact(self, lpath) | [
"def",
"collect_local",
"(",
"self",
",",
"path",
")",
":",
"for",
"f",
"in",
"os",
".",
"listdir",
"(",
"path",
")",
":",
"lpath",
"=",
"os",
".",
"path",
".",
"join",
"(",
"path",
",",
"f",
")",
"if",
"not",
"os",
".",
"path",
".",
"isfile",
... | Collect artifacts from a local directory possibly previously
collected from s3 | [
"Collect",
"artifacts",
"from",
"a",
"local",
"directory",
"possibly",
"previously",
"collected",
"from",
"s3"
] | 5a8aeb741609e61eaccafff2a67fa494dd549e8b | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/tools/download-s3.py#L116-L123 | train |
saltstack/salt | salt/modules/ddns.py | _config | def _config(name, key=None, **kwargs):
'''
Return a value for 'name' from command line args then config file options.
Specify 'key' if the config file option is not the same as 'name'.
'''
if key is None:
key = name
if name in kwargs:
value = kwargs[name]
else:
value ... | python | def _config(name, key=None, **kwargs):
'''
Return a value for 'name' from command line args then config file options.
Specify 'key' if the config file option is not the same as 'name'.
'''
if key is None:
key = name
if name in kwargs:
value = kwargs[name]
else:
value ... | [
"def",
"_config",
"(",
"name",
",",
"key",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"key",
"is",
"None",
":",
"key",
"=",
"name",
"if",
"name",
"in",
"kwargs",
":",
"value",
"=",
"kwargs",
"[",
"name",
"]",
"else",
":",
"value",
"=... | Return a value for 'name' from command line args then config file options.
Specify 'key' if the config file option is not the same as 'name'. | [
"Return",
"a",
"value",
"for",
"name",
"from",
"command",
"line",
"args",
"then",
"config",
"file",
"options",
".",
"Specify",
"key",
"if",
"the",
"config",
"file",
"option",
"is",
"not",
"the",
"same",
"as",
"name",
"."
] | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/ddns.py#L55-L68 | train |
saltstack/salt | salt/modules/ddns.py | add_host | def add_host(zone, name, ttl, ip, nameserver='127.0.0.1', replace=True,
timeout=5, port=53, **kwargs):
'''
Add, replace, or update the A and PTR (reverse) records for a host.
CLI Example:
.. code-block:: bash
salt ns1 ddns.add_host example.com host1 60 10.1.1.1
'''
res = ... | python | def add_host(zone, name, ttl, ip, nameserver='127.0.0.1', replace=True,
timeout=5, port=53, **kwargs):
'''
Add, replace, or update the A and PTR (reverse) records for a host.
CLI Example:
.. code-block:: bash
salt ns1 ddns.add_host example.com host1 60 10.1.1.1
'''
res = ... | [
"def",
"add_host",
"(",
"zone",
",",
"name",
",",
"ttl",
",",
"ip",
",",
"nameserver",
"=",
"'127.0.0.1'",
",",
"replace",
"=",
"True",
",",
"timeout",
"=",
"5",
",",
"port",
"=",
"53",
",",
"*",
"*",
"kwargs",
")",
":",
"res",
"=",
"update",
"("... | Add, replace, or update the A and PTR (reverse) records for a host.
CLI Example:
.. code-block:: bash
salt ns1 ddns.add_host example.com host1 60 10.1.1.1 | [
"Add",
"replace",
"or",
"update",
"the",
"A",
"and",
"PTR",
"(",
"reverse",
")",
"records",
"for",
"a",
"host",
"."
] | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/ddns.py#L79-L109 | train |
saltstack/salt | salt/modules/ddns.py | delete_host | def delete_host(zone, name, nameserver='127.0.0.1', timeout=5, port=53,
**kwargs):
'''
Delete the forward and reverse records for a host.
Returns true if any records are deleted.
CLI Example:
.. code-block:: bash
salt ns1 ddns.delete_host example.com host1
'''
fqd... | python | def delete_host(zone, name, nameserver='127.0.0.1', timeout=5, port=53,
**kwargs):
'''
Delete the forward and reverse records for a host.
Returns true if any records are deleted.
CLI Example:
.. code-block:: bash
salt ns1 ddns.delete_host example.com host1
'''
fqd... | [
"def",
"delete_host",
"(",
"zone",
",",
"name",
",",
"nameserver",
"=",
"'127.0.0.1'",
",",
"timeout",
"=",
"5",
",",
"port",
"=",
"53",
",",
"*",
"*",
"kwargs",
")",
":",
"fqdn",
"=",
"'{0}.{1}'",
".",
"format",
"(",
"name",
",",
"zone",
")",
"req... | Delete the forward and reverse records for a host.
Returns true if any records are deleted.
CLI Example:
.. code-block:: bash
salt ns1 ddns.delete_host example.com host1 | [
"Delete",
"the",
"forward",
"and",
"reverse",
"records",
"for",
"a",
"host",
"."
] | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/ddns.py#L112-L151 | train |
saltstack/salt | salt/modules/ddns.py | update | def update(zone, name, ttl, rdtype, data, nameserver='127.0.0.1', timeout=5,
replace=False, port=53, **kwargs):
'''
Add, replace, or update a DNS record.
nameserver must be an IP address and the minion running this module
must have update privileges on that server.
If replace is true, fir... | python | def update(zone, name, ttl, rdtype, data, nameserver='127.0.0.1', timeout=5,
replace=False, port=53, **kwargs):
'''
Add, replace, or update a DNS record.
nameserver must be an IP address and the minion running this module
must have update privileges on that server.
If replace is true, fir... | [
"def",
"update",
"(",
"zone",
",",
"name",
",",
"ttl",
",",
"rdtype",
",",
"data",
",",
"nameserver",
"=",
"'127.0.0.1'",
",",
"timeout",
"=",
"5",
",",
"replace",
"=",
"False",
",",
"port",
"=",
"53",
",",
"*",
"*",
"kwargs",
")",
":",
"name",
"... | Add, replace, or update a DNS record.
nameserver must be an IP address and the minion running this module
must have update privileges on that server.
If replace is true, first deletes all records for this name and type.
CLI Example:
.. code-block:: bash
salt ns1 ddns.update example.com ho... | [
"Add",
"replace",
"or",
"update",
"a",
"DNS",
"record",
".",
"nameserver",
"must",
"be",
"an",
"IP",
"address",
"and",
"the",
"minion",
"running",
"this",
"module",
"must",
"have",
"update",
"privileges",
"on",
"that",
"server",
".",
"If",
"replace",
"is",... | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/ddns.py#L154-L205 | train |
saltstack/salt | salt/modules/ansiblegate.py | _set_callables | def _set_callables(modules):
'''
Set all Ansible modules callables
:return:
'''
def _set_function(cmd_name, doc):
'''
Create a Salt function for the Ansible module.
'''
def _cmd(*args, **kw):
'''
Call an Ansible module as a function from the Sa... | python | def _set_callables(modules):
'''
Set all Ansible modules callables
:return:
'''
def _set_function(cmd_name, doc):
'''
Create a Salt function for the Ansible module.
'''
def _cmd(*args, **kw):
'''
Call an Ansible module as a function from the Sa... | [
"def",
"_set_callables",
"(",
"modules",
")",
":",
"def",
"_set_function",
"(",
"cmd_name",
",",
"doc",
")",
":",
"'''\n Create a Salt function for the Ansible module.\n '''",
"def",
"_cmd",
"(",
"*",
"args",
",",
"*",
"*",
"kw",
")",
":",
"'''\n ... | Set all Ansible modules callables
:return: | [
"Set",
"all",
"Ansible",
"modules",
"callables",
":",
"return",
":"
] | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/ansiblegate.py#L190-L215 | train |
saltstack/salt | salt/modules/ansiblegate.py | help | def help(module=None, *args):
'''
Display help on Ansible standard module.
:param module:
:return:
'''
if not module:
raise CommandExecutionError('Please tell me what module you want to have helped with. '
'Or call "ansible.list" to know what is avail... | python | def help(module=None, *args):
'''
Display help on Ansible standard module.
:param module:
:return:
'''
if not module:
raise CommandExecutionError('Please tell me what module you want to have helped with. '
'Or call "ansible.list" to know what is avail... | [
"def",
"help",
"(",
"module",
"=",
"None",
",",
"*",
"args",
")",
":",
"if",
"not",
"module",
":",
"raise",
"CommandExecutionError",
"(",
"'Please tell me what module you want to have helped with. '",
"'Or call \"ansible.list\" to know what is available.'",
")",
"try",
":... | Display help on Ansible standard module.
:param module:
:return: | [
"Display",
"help",
"on",
"Ansible",
"standard",
"module",
"."
] | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/ansiblegate.py#L237-L273 | train |
saltstack/salt | salt/modules/ansiblegate.py | playbooks | def playbooks(playbook, rundir=None, check=False, diff=False, extra_vars=None,
flush_cache=False, forks=5, inventory=None, limit=None,
list_hosts=False, list_tags=False, list_tasks=False,
module_path=None, skip_tags=None, start_at_task=None,
syntax_check=False, ta... | python | def playbooks(playbook, rundir=None, check=False, diff=False, extra_vars=None,
flush_cache=False, forks=5, inventory=None, limit=None,
list_hosts=False, list_tags=False, list_tasks=False,
module_path=None, skip_tags=None, start_at_task=None,
syntax_check=False, ta... | [
"def",
"playbooks",
"(",
"playbook",
",",
"rundir",
"=",
"None",
",",
"check",
"=",
"False",
",",
"diff",
"=",
"False",
",",
"extra_vars",
"=",
"None",
",",
"flush_cache",
"=",
"False",
",",
"forks",
"=",
"5",
",",
"inventory",
"=",
"None",
",",
"lim... | Run Ansible Playbooks
:param playbook: Which playbook to run.
:param rundir: Directory to run `ansible-playbook` in. (Default: None)
:param check: don't make any changes; instead, try to predict some
of the changes that may occur (Default: False)
:param diff: when changing (small) fil... | [
"Run",
"Ansible",
"Playbooks"
] | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/ansiblegate.py#L286-L381 | train |
saltstack/salt | salt/modules/ansiblegate.py | AnsibleModuleResolver._get_modules_map | def _get_modules_map(self, path=None):
'''
Get installed Ansible modules
:return:
'''
paths = {}
root = ansible.modules.__path__[0]
if not path:
path = root
for p_el in os.listdir(path):
p_el_path = os.path.join(path, p_el)
... | python | def _get_modules_map(self, path=None):
'''
Get installed Ansible modules
:return:
'''
paths = {}
root = ansible.modules.__path__[0]
if not path:
path = root
for p_el in os.listdir(path):
p_el_path = os.path.join(path, p_el)
... | [
"def",
"_get_modules_map",
"(",
"self",
",",
"path",
"=",
"None",
")",
":",
"paths",
"=",
"{",
"}",
"root",
"=",
"ansible",
".",
"modules",
".",
"__path__",
"[",
"0",
"]",
"if",
"not",
"path",
":",
"path",
"=",
"root",
"for",
"p_el",
"in",
"os",
... | Get installed Ansible modules
:return: | [
"Get",
"installed",
"Ansible",
"modules",
":",
"return",
":"
] | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/ansiblegate.py#L68-L92 | train |
saltstack/salt | salt/modules/ansiblegate.py | AnsibleModuleResolver.load_module | def load_module(self, module):
'''
Introspect Ansible module.
:param module:
:return:
'''
m_ref = self._modules_map.get(module)
if m_ref is None:
raise LoaderError('Module "{0}" was not found'.format(module))
mod = importlib.import_module('ans... | python | def load_module(self, module):
'''
Introspect Ansible module.
:param module:
:return:
'''
m_ref = self._modules_map.get(module)
if m_ref is None:
raise LoaderError('Module "{0}" was not found'.format(module))
mod = importlib.import_module('ans... | [
"def",
"load_module",
"(",
"self",
",",
"module",
")",
":",
"m_ref",
"=",
"self",
".",
"_modules_map",
".",
"get",
"(",
"module",
")",
"if",
"m_ref",
"is",
"None",
":",
"raise",
"LoaderError",
"(",
"'Module \"{0}\" was not found'",
".",
"format",
"(",
"mod... | Introspect Ansible module.
:param module:
:return: | [
"Introspect",
"Ansible",
"module",
"."
] | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/ansiblegate.py#L94-L107 | train |
saltstack/salt | salt/modules/ansiblegate.py | AnsibleModuleResolver.get_modules_list | def get_modules_list(self, pattern=None):
'''
Return module map references.
:return:
'''
if pattern and '*' not in pattern:
pattern = '*{0}*'.format(pattern)
modules = []
for m_name, m_path in self._modules_map.items():
m_path = m_path.spli... | python | def get_modules_list(self, pattern=None):
'''
Return module map references.
:return:
'''
if pattern and '*' not in pattern:
pattern = '*{0}*'.format(pattern)
modules = []
for m_name, m_path in self._modules_map.items():
m_path = m_path.spli... | [
"def",
"get_modules_list",
"(",
"self",
",",
"pattern",
"=",
"None",
")",
":",
"if",
"pattern",
"and",
"'*'",
"not",
"in",
"pattern",
":",
"pattern",
"=",
"'*{0}*'",
".",
"format",
"(",
"pattern",
")",
"modules",
"=",
"[",
"]",
"for",
"m_name",
",",
... | Return module map references.
:return: | [
"Return",
"module",
"map",
"references",
".",
":",
"return",
":"
] | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/ansiblegate.py#L109-L122 | train |
saltstack/salt | salt/modules/ansiblegate.py | AnsibleModuleCaller.call | def call(self, module, *args, **kwargs):
'''
Call an Ansible module by invoking it.
:param module: the name of the module.
:param args: Arguments to the module
:param kwargs: keywords to the module
:return:
'''
module = self._resolver.load_module(module)
... | python | def call(self, module, *args, **kwargs):
'''
Call an Ansible module by invoking it.
:param module: the name of the module.
:param args: Arguments to the module
:param kwargs: keywords to the module
:return:
'''
module = self._resolver.load_module(module)
... | [
"def",
"call",
"(",
"self",
",",
"module",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"module",
"=",
"self",
".",
"_resolver",
".",
"load_module",
"(",
"module",
")",
"if",
"not",
"hasattr",
"(",
"module",
",",
"'main'",
")",
":",
"raise"... | Call an Ansible module by invoking it.
:param module: the name of the module.
:param args: Arguments to the module
:param kwargs: keywords to the module
:return: | [
"Call",
"an",
"Ansible",
"module",
"by",
"invoking",
"it",
".",
":",
"param",
"module",
":",
"the",
"name",
"of",
"the",
"module",
".",
":",
"param",
"args",
":",
"Arguments",
"to",
"the",
"module",
":",
"param",
"kwargs",
":",
"keywords",
"to",
"the",... | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/ansiblegate.py#L142-L183 | train |
saltstack/salt | salt/modules/file.py | __clean_tmp | def __clean_tmp(sfn):
'''
Clean out a template temp file
'''
if sfn.startswith(os.path.join(tempfile.gettempdir(),
salt.utils.files.TEMPFILE_PREFIX)):
# Don't remove if it exists in file_roots (any saltenv)
all_roots = itertools.chain.from_iterable(
... | python | def __clean_tmp(sfn):
'''
Clean out a template temp file
'''
if sfn.startswith(os.path.join(tempfile.gettempdir(),
salt.utils.files.TEMPFILE_PREFIX)):
# Don't remove if it exists in file_roots (any saltenv)
all_roots = itertools.chain.from_iterable(
... | [
"def",
"__clean_tmp",
"(",
"sfn",
")",
":",
"if",
"sfn",
".",
"startswith",
"(",
"os",
".",
"path",
".",
"join",
"(",
"tempfile",
".",
"gettempdir",
"(",
")",
",",
"salt",
".",
"utils",
".",
"files",
".",
"TEMPFILE_PREFIX",
")",
")",
":",
"# Don't re... | Clean out a template temp file | [
"Clean",
"out",
"a",
"template",
"temp",
"file"
] | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L88-L100 | train |
saltstack/salt | salt/modules/file.py | _binary_replace | def _binary_replace(old, new):
'''
This function does NOT do any diffing, it just checks the old and new files
to see if either is binary, and provides an appropriate string noting the
difference between the two files. If neither file is binary, an empty
string is returned.
This function should... | python | def _binary_replace(old, new):
'''
This function does NOT do any diffing, it just checks the old and new files
to see if either is binary, and provides an appropriate string noting the
difference between the two files. If neither file is binary, an empty
string is returned.
This function should... | [
"def",
"_binary_replace",
"(",
"old",
",",
"new",
")",
":",
"old_isbin",
"=",
"not",
"__utils__",
"[",
"'files.is_text'",
"]",
"(",
"old",
")",
"new_isbin",
"=",
"not",
"__utils__",
"[",
"'files.is_text'",
"]",
"(",
"new",
")",
"if",
"any",
"(",
"(",
"... | This function does NOT do any diffing, it just checks the old and new files
to see if either is binary, and provides an appropriate string noting the
difference between the two files. If neither file is binary, an empty
string is returned.
This function should only be run AFTER it has been determined t... | [
"This",
"function",
"does",
"NOT",
"do",
"any",
"diffing",
"it",
"just",
"checks",
"the",
"old",
"and",
"new",
"files",
"to",
"see",
"if",
"either",
"is",
"binary",
"and",
"provides",
"an",
"appropriate",
"string",
"noting",
"the",
"difference",
"between",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L112-L131 | train |
saltstack/salt | salt/modules/file.py | _splitlines_preserving_trailing_newline | def _splitlines_preserving_trailing_newline(str):
'''
Returns a list of the lines in the string, breaking at line boundaries and
preserving a trailing newline (if present).
Essentially, this works like ``str.striplines(False)`` but preserves an
empty line at the end. This is equivalent to the follo... | python | def _splitlines_preserving_trailing_newline(str):
'''
Returns a list of the lines in the string, breaking at line boundaries and
preserving a trailing newline (if present).
Essentially, this works like ``str.striplines(False)`` but preserves an
empty line at the end. This is equivalent to the follo... | [
"def",
"_splitlines_preserving_trailing_newline",
"(",
"str",
")",
":",
"lines",
"=",
"str",
".",
"splitlines",
"(",
")",
"if",
"str",
".",
"endswith",
"(",
"'\\n'",
")",
"or",
"str",
".",
"endswith",
"(",
"'\\r'",
")",
":",
"lines",
".",
"append",
"(",
... | Returns a list of the lines in the string, breaking at line boundaries and
preserving a trailing newline (if present).
Essentially, this works like ``str.striplines(False)`` but preserves an
empty line at the end. This is equivalent to the following code:
.. code-block:: python
lines = str.sp... | [
"Returns",
"a",
"list",
"of",
"the",
"lines",
"in",
"the",
"string",
"breaking",
"at",
"line",
"boundaries",
"and",
"preserving",
"a",
"trailing",
"newline",
"(",
"if",
"present",
")",
"."
] | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L142-L159 | train |
saltstack/salt | salt/modules/file.py | gid_to_group | def gid_to_group(gid):
'''
Convert the group id to the group name on this system
gid
gid to convert to a group name
CLI Example:
.. code-block:: bash
salt '*' file.gid_to_group 0
'''
try:
gid = int(gid)
except ValueError:
# This is not an integer, mayb... | python | def gid_to_group(gid):
'''
Convert the group id to the group name on this system
gid
gid to convert to a group name
CLI Example:
.. code-block:: bash
salt '*' file.gid_to_group 0
'''
try:
gid = int(gid)
except ValueError:
# This is not an integer, mayb... | [
"def",
"gid_to_group",
"(",
"gid",
")",
":",
"try",
":",
"gid",
"=",
"int",
"(",
"gid",
")",
"except",
"ValueError",
":",
"# This is not an integer, maybe it's already the group name?",
"gid",
"=",
"group_to_gid",
"(",
"gid",
")",
"if",
"gid",
"==",
"''",
":",... | Convert the group id to the group name on this system
gid
gid to convert to a group name
CLI Example:
.. code-block:: bash
salt '*' file.gid_to_group 0 | [
"Convert",
"the",
"group",
"id",
"to",
"the",
"group",
"name",
"on",
"this",
"system"
] | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L162-L189 | train |
saltstack/salt | salt/modules/file.py | group_to_gid | def group_to_gid(group):
'''
Convert the group to the gid on this system
group
group to convert to its gid
CLI Example:
.. code-block:: bash
salt '*' file.group_to_gid root
'''
if group is None:
return ''
try:
if isinstance(group, int):
ret... | python | def group_to_gid(group):
'''
Convert the group to the gid on this system
group
group to convert to its gid
CLI Example:
.. code-block:: bash
salt '*' file.group_to_gid root
'''
if group is None:
return ''
try:
if isinstance(group, int):
ret... | [
"def",
"group_to_gid",
"(",
"group",
")",
":",
"if",
"group",
"is",
"None",
":",
"return",
"''",
"try",
":",
"if",
"isinstance",
"(",
"group",
",",
"int",
")",
":",
"return",
"group",
"return",
"grp",
".",
"getgrnam",
"(",
"group",
")",
".",
"gr_gid"... | Convert the group to the gid on this system
group
group to convert to its gid
CLI Example:
.. code-block:: bash
salt '*' file.group_to_gid root | [
"Convert",
"the",
"group",
"to",
"the",
"gid",
"on",
"this",
"system"
] | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L192-L212 | train |
saltstack/salt | salt/modules/file.py | get_gid | def get_gid(path, follow_symlinks=True):
'''
Return the id of the group that owns a given file
path
file or directory of which to get the gid
follow_symlinks
indicated if symlinks should be followed
CLI Example:
.. code-block:: bash
salt '*' file.get_gid /etc/passwd... | python | def get_gid(path, follow_symlinks=True):
'''
Return the id of the group that owns a given file
path
file or directory of which to get the gid
follow_symlinks
indicated if symlinks should be followed
CLI Example:
.. code-block:: bash
salt '*' file.get_gid /etc/passwd... | [
"def",
"get_gid",
"(",
"path",
",",
"follow_symlinks",
"=",
"True",
")",
":",
"return",
"stats",
"(",
"os",
".",
"path",
".",
"expanduser",
"(",
"path",
")",
",",
"follow_symlinks",
"=",
"follow_symlinks",
")",
".",
"get",
"(",
"'gid'",
",",
"-",
"1",
... | Return the id of the group that owns a given file
path
file or directory of which to get the gid
follow_symlinks
indicated if symlinks should be followed
CLI Example:
.. code-block:: bash
salt '*' file.get_gid /etc/passwd
.. versionchanged:: 0.16.4
``follow_sym... | [
"Return",
"the",
"id",
"of",
"the",
"group",
"that",
"owns",
"a",
"given",
"file"
] | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L215-L235 | train |
saltstack/salt | salt/modules/file.py | get_group | def get_group(path, follow_symlinks=True):
'''
Return the group that owns a given file
path
file or directory of which to get the group
follow_symlinks
indicated if symlinks should be followed
CLI Example:
.. code-block:: bash
salt '*' file.get_group /etc/passwd
... | python | def get_group(path, follow_symlinks=True):
'''
Return the group that owns a given file
path
file or directory of which to get the group
follow_symlinks
indicated if symlinks should be followed
CLI Example:
.. code-block:: bash
salt '*' file.get_group /etc/passwd
... | [
"def",
"get_group",
"(",
"path",
",",
"follow_symlinks",
"=",
"True",
")",
":",
"return",
"stats",
"(",
"os",
".",
"path",
".",
"expanduser",
"(",
"path",
")",
",",
"follow_symlinks",
"=",
"follow_symlinks",
")",
".",
"get",
"(",
"'group'",
",",
"False",... | Return the group that owns a given file
path
file or directory of which to get the group
follow_symlinks
indicated if symlinks should be followed
CLI Example:
.. code-block:: bash
salt '*' file.get_group /etc/passwd
.. versionchanged:: 0.16.4
``follow_symlinks``... | [
"Return",
"the",
"group",
"that",
"owns",
"a",
"given",
"file"
] | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L238-L257 | train |
saltstack/salt | salt/modules/file.py | user_to_uid | def user_to_uid(user):
'''
Convert user name to a uid
user
user name to convert to its uid
CLI Example:
.. code-block:: bash
salt '*' file.user_to_uid root
'''
if user is None:
user = salt.utils.user.get_user()
try:
if isinstance(user, int):
... | python | def user_to_uid(user):
'''
Convert user name to a uid
user
user name to convert to its uid
CLI Example:
.. code-block:: bash
salt '*' file.user_to_uid root
'''
if user is None:
user = salt.utils.user.get_user()
try:
if isinstance(user, int):
... | [
"def",
"user_to_uid",
"(",
"user",
")",
":",
"if",
"user",
"is",
"None",
":",
"user",
"=",
"salt",
".",
"utils",
".",
"user",
".",
"get_user",
"(",
")",
"try",
":",
"if",
"isinstance",
"(",
"user",
",",
"int",
")",
":",
"return",
"user",
"return",
... | Convert user name to a uid
user
user name to convert to its uid
CLI Example:
.. code-block:: bash
salt '*' file.user_to_uid root | [
"Convert",
"user",
"name",
"to",
"a",
"uid"
] | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L280-L300 | train |
saltstack/salt | salt/modules/file.py | get_uid | def get_uid(path, follow_symlinks=True):
'''
Return the id of the user that owns a given file
path
file or directory of which to get the uid
follow_symlinks
indicated if symlinks should be followed
CLI Example:
.. code-block:: bash
salt '*' file.get_uid /etc/passwd
... | python | def get_uid(path, follow_symlinks=True):
'''
Return the id of the user that owns a given file
path
file or directory of which to get the uid
follow_symlinks
indicated if symlinks should be followed
CLI Example:
.. code-block:: bash
salt '*' file.get_uid /etc/passwd
... | [
"def",
"get_uid",
"(",
"path",
",",
"follow_symlinks",
"=",
"True",
")",
":",
"return",
"stats",
"(",
"os",
".",
"path",
".",
"expanduser",
"(",
"path",
")",
",",
"follow_symlinks",
"=",
"follow_symlinks",
")",
".",
"get",
"(",
"'uid'",
",",
"-",
"1",
... | Return the id of the user that owns a given file
path
file or directory of which to get the uid
follow_symlinks
indicated if symlinks should be followed
CLI Example:
.. code-block:: bash
salt '*' file.get_uid /etc/passwd
.. versionchanged:: 0.16.4
``follow_symli... | [
"Return",
"the",
"id",
"of",
"the",
"user",
"that",
"owns",
"a",
"given",
"file"
] | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L303-L322 | train |
saltstack/salt | salt/modules/file.py | get_mode | def get_mode(path, follow_symlinks=True):
'''
Return the mode of a file
path
file or directory of which to get the mode
follow_symlinks
indicated if symlinks should be followed
CLI Example:
.. code-block:: bash
salt '*' file.get_mode /etc/passwd
.. versionchange... | python | def get_mode(path, follow_symlinks=True):
'''
Return the mode of a file
path
file or directory of which to get the mode
follow_symlinks
indicated if symlinks should be followed
CLI Example:
.. code-block:: bash
salt '*' file.get_mode /etc/passwd
.. versionchange... | [
"def",
"get_mode",
"(",
"path",
",",
"follow_symlinks",
"=",
"True",
")",
":",
"return",
"stats",
"(",
"os",
".",
"path",
".",
"expanduser",
"(",
"path",
")",
",",
"follow_symlinks",
"=",
"follow_symlinks",
")",
".",
"get",
"(",
"'mode'",
",",
"''",
")... | Return the mode of a file
path
file or directory of which to get the mode
follow_symlinks
indicated if symlinks should be followed
CLI Example:
.. code-block:: bash
salt '*' file.get_mode /etc/passwd
.. versionchanged:: 2014.1.0
``follow_symlinks`` option added | [
"Return",
"the",
"mode",
"of",
"a",
"file"
] | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L347-L366 | train |
saltstack/salt | salt/modules/file.py | set_mode | def set_mode(path, mode):
'''
Set the mode of a file
path
file or directory of which to set the mode
mode
mode to set the path to
CLI Example:
.. code-block:: bash
salt '*' file.set_mode /etc/passwd 0644
'''
path = os.path.expanduser(path)
mode = six.tex... | python | def set_mode(path, mode):
'''
Set the mode of a file
path
file or directory of which to set the mode
mode
mode to set the path to
CLI Example:
.. code-block:: bash
salt '*' file.set_mode /etc/passwd 0644
'''
path = os.path.expanduser(path)
mode = six.tex... | [
"def",
"set_mode",
"(",
"path",
",",
"mode",
")",
":",
"path",
"=",
"os",
".",
"path",
".",
"expanduser",
"(",
"path",
")",
"mode",
"=",
"six",
".",
"text_type",
"(",
"mode",
")",
".",
"lstrip",
"(",
"'0Oo'",
")",
"if",
"not",
"mode",
":",
"mode"... | Set the mode of a file
path
file or directory of which to set the mode
mode
mode to set the path to
CLI Example:
.. code-block:: bash
salt '*' file.set_mode /etc/passwd 0644 | [
"Set",
"the",
"mode",
"of",
"a",
"file"
] | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L369-L396 | train |
saltstack/salt | salt/modules/file.py | lchown | def lchown(path, user, group):
'''
Chown a file, pass the file the desired user and group without following
symlinks.
path
path to the file or directory
user
user owner
group
group owner
CLI Example:
.. code-block:: bash
salt '*' file.chown /etc/pass... | python | def lchown(path, user, group):
'''
Chown a file, pass the file the desired user and group without following
symlinks.
path
path to the file or directory
user
user owner
group
group owner
CLI Example:
.. code-block:: bash
salt '*' file.chown /etc/pass... | [
"def",
"lchown",
"(",
"path",
",",
"user",
",",
"group",
")",
":",
"path",
"=",
"os",
".",
"path",
".",
"expanduser",
"(",
"path",
")",
"uid",
"=",
"user_to_uid",
"(",
"user",
")",
"gid",
"=",
"group_to_gid",
"(",
"group",
")",
"err",
"=",
"''",
... | Chown a file, pass the file the desired user and group without following
symlinks.
path
path to the file or directory
user
user owner
group
group owner
CLI Example:
.. code-block:: bash
salt '*' file.chown /etc/passwd root root | [
"Chown",
"a",
"file",
"pass",
"the",
"file",
"the",
"desired",
"user",
"and",
"group",
"without",
"following",
"symlinks",
"."
] | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L399-L435 | train |
saltstack/salt | salt/modules/file.py | chown | def chown(path, user, group):
'''
Chown a file, pass the file the desired user and group
path
path to the file or directory
user
user owner
group
group owner
CLI Example:
.. code-block:: bash
salt '*' file.chown /etc/passwd root root
'''
path = o... | python | def chown(path, user, group):
'''
Chown a file, pass the file the desired user and group
path
path to the file or directory
user
user owner
group
group owner
CLI Example:
.. code-block:: bash
salt '*' file.chown /etc/passwd root root
'''
path = o... | [
"def",
"chown",
"(",
"path",
",",
"user",
",",
"group",
")",
":",
"path",
"=",
"os",
".",
"path",
".",
"expanduser",
"(",
"path",
")",
"uid",
"=",
"user_to_uid",
"(",
"user",
")",
"gid",
"=",
"group_to_gid",
"(",
"group",
")",
"err",
"=",
"''",
"... | Chown a file, pass the file the desired user and group
path
path to the file or directory
user
user owner
group
group owner
CLI Example:
.. code-block:: bash
salt '*' file.chown /etc/passwd root root | [
"Chown",
"a",
"file",
"pass",
"the",
"file",
"the",
"desired",
"user",
"and",
"group"
] | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L438-L481 | train |
saltstack/salt | salt/modules/file.py | chgrp | def chgrp(path, group):
'''
Change the group of a file
path
path to the file or directory
group
group owner
CLI Example:
.. code-block:: bash
salt '*' file.chgrp /etc/passwd root
'''
path = os.path.expanduser(path)
user = get_user(path)
return chown(... | python | def chgrp(path, group):
'''
Change the group of a file
path
path to the file or directory
group
group owner
CLI Example:
.. code-block:: bash
salt '*' file.chgrp /etc/passwd root
'''
path = os.path.expanduser(path)
user = get_user(path)
return chown(... | [
"def",
"chgrp",
"(",
"path",
",",
"group",
")",
":",
"path",
"=",
"os",
".",
"path",
".",
"expanduser",
"(",
"path",
")",
"user",
"=",
"get_user",
"(",
"path",
")",
"return",
"chown",
"(",
"path",
",",
"user",
",",
"group",
")"
] | Change the group of a file
path
path to the file or directory
group
group owner
CLI Example:
.. code-block:: bash
salt '*' file.chgrp /etc/passwd root | [
"Change",
"the",
"group",
"of",
"a",
"file"
] | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L484-L503 | train |
saltstack/salt | salt/modules/file.py | _cmp_attrs | def _cmp_attrs(path, attrs):
'''
.. versionadded:: 2018.3.0
Compare attributes of a given file to given attributes.
Returns a pair (list) where first item are attributes to
add and second item are to be removed.
Please take into account when using this function that some minions will
not h... | python | def _cmp_attrs(path, attrs):
'''
.. versionadded:: 2018.3.0
Compare attributes of a given file to given attributes.
Returns a pair (list) where first item are attributes to
add and second item are to be removed.
Please take into account when using this function that some minions will
not h... | [
"def",
"_cmp_attrs",
"(",
"path",
",",
"attrs",
")",
":",
"diff",
"=",
"[",
"None",
",",
"None",
"]",
"# lsattr for AIX is not the same thing as lsattr for linux.",
"if",
"salt",
".",
"utils",
".",
"platform",
".",
"is_aix",
"(",
")",
":",
"return",
"None",
... | .. versionadded:: 2018.3.0
Compare attributes of a given file to given attributes.
Returns a pair (list) where first item are attributes to
add and second item are to be removed.
Please take into account when using this function that some minions will
not have lsattr installed.
path
p... | [
"..",
"versionadded",
"::",
"2018",
".",
"3",
".",
"0"
] | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L506-L543 | train |
saltstack/salt | salt/modules/file.py | lsattr | def lsattr(path):
'''
.. versionadded:: 2018.3.0
.. versionchanged:: 2018.3.1
If ``lsattr`` is not installed on the system, ``None`` is returned.
.. versionchanged:: 2018.3.4
If on ``AIX``, ``None`` is returned even if in filesystem as lsattr on ``AIX``
is not the same thing as t... | python | def lsattr(path):
'''
.. versionadded:: 2018.3.0
.. versionchanged:: 2018.3.1
If ``lsattr`` is not installed on the system, ``None`` is returned.
.. versionchanged:: 2018.3.4
If on ``AIX``, ``None`` is returned even if in filesystem as lsattr on ``AIX``
is not the same thing as t... | [
"def",
"lsattr",
"(",
"path",
")",
":",
"if",
"not",
"salt",
".",
"utils",
".",
"path",
".",
"which",
"(",
"'lsattr'",
")",
"or",
"salt",
".",
"utils",
".",
"platform",
".",
"is_aix",
"(",
")",
":",
"return",
"None",
"if",
"not",
"os",
".",
"path... | .. versionadded:: 2018.3.0
.. versionchanged:: 2018.3.1
If ``lsattr`` is not installed on the system, ``None`` is returned.
.. versionchanged:: 2018.3.4
If on ``AIX``, ``None`` is returned even if in filesystem as lsattr on ``AIX``
is not the same thing as the linux version.
Obtain ... | [
"..",
"versionadded",
"::",
"2018",
".",
"3",
".",
"0",
"..",
"versionchanged",
"::",
"2018",
".",
"3",
".",
"1",
"If",
"lsattr",
"is",
"not",
"installed",
"on",
"the",
"system",
"None",
"is",
"returned",
".",
"..",
"versionchanged",
"::",
"2018",
".",... | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L546-L582 | train |
saltstack/salt | salt/modules/file.py | chattr | def chattr(*files, **kwargs):
'''
.. versionadded:: 2018.3.0
Change the attributes of files. This function accepts one or more files and
the following options:
operator
Can be wither ``add`` or ``remove``. Determines whether attributes
should be added or removed from files
att... | python | def chattr(*files, **kwargs):
'''
.. versionadded:: 2018.3.0
Change the attributes of files. This function accepts one or more files and
the following options:
operator
Can be wither ``add`` or ``remove``. Determines whether attributes
should be added or removed from files
att... | [
"def",
"chattr",
"(",
"*",
"files",
",",
"*",
"*",
"kwargs",
")",
":",
"operator",
"=",
"kwargs",
".",
"pop",
"(",
"'operator'",
",",
"None",
")",
"attributes",
"=",
"kwargs",
".",
"pop",
"(",
"'attributes'",
",",
"None",
")",
"flags",
"=",
"kwargs",... | .. versionadded:: 2018.3.0
Change the attributes of files. This function accepts one or more files and
the following options:
operator
Can be wither ``add`` or ``remove``. Determines whether attributes
should be added or removed from files
attributes
One or more of the followi... | [
"..",
"versionadded",
"::",
"2018",
".",
"3",
".",
"0"
] | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L585-L648 | train |
saltstack/salt | salt/modules/file.py | get_sum | def get_sum(path, form='sha256'):
'''
Return the checksum for the given file. The following checksum algorithms
are supported:
* md5
* sha1
* sha224
* sha256 **(default)**
* sha384
* sha512
path
path to the file or directory
form
desired sum format
CLI... | python | def get_sum(path, form='sha256'):
'''
Return the checksum for the given file. The following checksum algorithms
are supported:
* md5
* sha1
* sha224
* sha256 **(default)**
* sha384
* sha512
path
path to the file or directory
form
desired sum format
CLI... | [
"def",
"get_sum",
"(",
"path",
",",
"form",
"=",
"'sha256'",
")",
":",
"path",
"=",
"os",
".",
"path",
".",
"expanduser",
"(",
"path",
")",
"if",
"not",
"os",
".",
"path",
".",
"isfile",
"(",
"path",
")",
":",
"return",
"'File not found'",
"return",
... | Return the checksum for the given file. The following checksum algorithms
are supported:
* md5
* sha1
* sha224
* sha256 **(default)**
* sha384
* sha512
path
path to the file or directory
form
desired sum format
CLI Example:
.. code-block:: bash
s... | [
"Return",
"the",
"checksum",
"for",
"the",
"given",
"file",
".",
"The",
"following",
"checksum",
"algorithms",
"are",
"supported",
":"
] | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L651-L679 | train |
saltstack/salt | salt/modules/file.py | get_hash | def get_hash(path, form='sha256', chunk_size=65536):
'''
Get the hash sum of a file
This is better than ``get_sum`` for the following reasons:
- It does not read the entire file into memory.
- It does not return a string on error. The returned value of
``get_sum`` cannot really ... | python | def get_hash(path, form='sha256', chunk_size=65536):
'''
Get the hash sum of a file
This is better than ``get_sum`` for the following reasons:
- It does not read the entire file into memory.
- It does not return a string on error. The returned value of
``get_sum`` cannot really ... | [
"def",
"get_hash",
"(",
"path",
",",
"form",
"=",
"'sha256'",
",",
"chunk_size",
"=",
"65536",
")",
":",
"return",
"salt",
".",
"utils",
".",
"hashutils",
".",
"get_hash",
"(",
"os",
".",
"path",
".",
"expanduser",
"(",
"path",
")",
",",
"form",
",",... | Get the hash sum of a file
This is better than ``get_sum`` for the following reasons:
- It does not read the entire file into memory.
- It does not return a string on error. The returned value of
``get_sum`` cannot really be trusted since it is vulnerable to
collisions: ``ge... | [
"Get",
"the",
"hash",
"sum",
"of",
"a",
"file"
] | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L682-L707 | train |
saltstack/salt | salt/modules/file.py | get_source_sum | def get_source_sum(file_name='',
source='',
source_hash=None,
source_hash_name=None,
saltenv='base'):
'''
.. versionadded:: 2016.11.0
Used by :py:func:`file.get_managed <salt.modules.file.get_managed>` to
obtain the hash and ha... | python | def get_source_sum(file_name='',
source='',
source_hash=None,
source_hash_name=None,
saltenv='base'):
'''
.. versionadded:: 2016.11.0
Used by :py:func:`file.get_managed <salt.modules.file.get_managed>` to
obtain the hash and ha... | [
"def",
"get_source_sum",
"(",
"file_name",
"=",
"''",
",",
"source",
"=",
"''",
",",
"source_hash",
"=",
"None",
",",
"source_hash_name",
"=",
"None",
",",
"saltenv",
"=",
"'base'",
")",
":",
"def",
"_invalid_source_hash_format",
"(",
")",
":",
"'''\n ... | .. versionadded:: 2016.11.0
Used by :py:func:`file.get_managed <salt.modules.file.get_managed>` to
obtain the hash and hash type from the parameters specified below.
file_name
Optional file name being managed, for matching with
:py:func:`file.extract_hash <salt.modules.file.extract_hash>`.... | [
"..",
"versionadded",
"::",
"2016",
".",
"11",
".",
"0"
] | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L710-L848 | train |
saltstack/salt | salt/modules/file.py | check_hash | def check_hash(path, file_hash):
'''
Check if a file matches the given hash string
Returns ``True`` if the hash matches, otherwise ``False``.
path
Path to a file local to the minion.
hash
The hash to check against the file specified in the ``path`` argument.
.. versioncha... | python | def check_hash(path, file_hash):
'''
Check if a file matches the given hash string
Returns ``True`` if the hash matches, otherwise ``False``.
path
Path to a file local to the minion.
hash
The hash to check against the file specified in the ``path`` argument.
.. versioncha... | [
"def",
"check_hash",
"(",
"path",
",",
"file_hash",
")",
":",
"path",
"=",
"os",
".",
"path",
".",
"expanduser",
"(",
"path",
")",
"if",
"not",
"isinstance",
"(",
"file_hash",
",",
"six",
".",
"string_types",
")",
":",
"raise",
"SaltInvocationError",
"("... | Check if a file matches the given hash string
Returns ``True`` if the hash matches, otherwise ``False``.
path
Path to a file local to the minion.
hash
The hash to check against the file specified in the ``path`` argument.
.. versionchanged:: 2016.11.4
For this and newer ... | [
"Check",
"if",
"a",
"file",
"matches",
"the",
"given",
"hash",
"string"
] | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L851-L905 | train |
saltstack/salt | salt/modules/file.py | find | def find(path, *args, **kwargs):
'''
Approximate the Unix ``find(1)`` command and return a list of paths that
meet the specified criteria.
The options include match criteria:
.. code-block:: text
name = path-glob # case sensitive
iname = path-glob ... | python | def find(path, *args, **kwargs):
'''
Approximate the Unix ``find(1)`` command and return a list of paths that
meet the specified criteria.
The options include match criteria:
.. code-block:: text
name = path-glob # case sensitive
iname = path-glob ... | [
"def",
"find",
"(",
"path",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"'delete'",
"in",
"args",
":",
"kwargs",
"[",
"'delete'",
"]",
"=",
"'f'",
"elif",
"'print'",
"in",
"args",
":",
"kwargs",
"[",
"'print'",
"]",
"=",
"'path'",
... | Approximate the Unix ``find(1)`` command and return a list of paths that
meet the specified criteria.
The options include match criteria:
.. code-block:: text
name = path-glob # case sensitive
iname = path-glob # case insensitive
regex = path... | [
"Approximate",
"the",
"Unix",
"find",
"(",
"1",
")",
"command",
"and",
"return",
"a",
"list",
"of",
"paths",
"that",
"meet",
"the",
"specified",
"criteria",
"."
] | e8541fd6e744ab0df786c0f76102e41631f45d46 | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L908-L1034 | train |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.