partition stringclasses 3
values | func_name stringlengths 1 134 | docstring stringlengths 1 46.9k | path stringlengths 4 223 | original_string stringlengths 75 104k | code stringlengths 75 104k | docstring_tokens listlengths 1 1.97k | repo stringlengths 7 55 | language stringclasses 1
value | url stringlengths 87 315 | code_tokens listlengths 19 28.4k | sha stringlengths 40 40 |
|---|---|---|---|---|---|---|---|---|---|---|---|
train | Logger.log | r"""Log ``_message.format(*args, **kwargs)`` with severity ``_level``. | loguru/_logger.py | 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):
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... | [
"r",
"Log",
"_message",
".",
"format",
"(",
"*",
"args",
"**",
"kwargs",
")",
"with",
"severity",
"_level",
"."
] | Delgan/loguru | python | https://github.com/Delgan/loguru/blob/6571879c37904e3a18567e694d70651c6886b860/loguru/_logger.py#L1600-L1610 | [
"def",
"log",
"(",
"_self",
",",
"_level",
",",
"_message",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"logger",
"=",
"_self",
".",
"opt",
"(",
"exception",
"=",
"_self",
".",
"_exception",
",",
"record",
"=",
"_self",
".",
"_record",
","... | 6571879c37904e3a18567e694d70651c6886b860 |
train | Logger.start | 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. | loguru/_logger.py | 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):
"""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(
... | [
"Deprecated",
"function",
"to",
"|add|",
"a",
"new",
"handler",
"."
] | Delgan/loguru | python | https://github.com/Delgan/loguru/blob/6571879c37904e3a18567e694d70651c6886b860/loguru/_logger.py#L1624-L1636 | [
"def",
"start",
"(",
"self",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"warnings",
".",
"warn",
"(",
"\"The 'start()' method is deprecated, please use 'add()' instead\"",
",",
"DeprecationWarning",
")",
"return",
"self",
".",
"add",
"(",
"*",
"args",
... | 6571879c37904e3a18567e694d70651c6886b860 |
train | Logger.stop | 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. | loguru/_logger.py | 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):
"""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... | [
"Deprecated",
"function",
"to",
"|remove|",
"an",
"existing",
"handler",
"."
] | Delgan/loguru | python | https://github.com/Delgan/loguru/blob/6571879c37904e3a18567e694d70651c6886b860/loguru/_logger.py#L1638-L1650 | [
"def",
"stop",
"(",
"self",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"warnings",
".",
"warn",
"(",
"\"The 'stop()' method is deprecated, please use 'remove()' instead\"",
",",
"DeprecationWarning",
")",
"return",
"self",
".",
"remove",
"(",
"*",
"arg... | 6571879c37904e3a18567e694d70651c6886b860 |
train | convert_serializer_field | 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 | graphene_django/rest_framework/serializer_converter.py | 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):
"""
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 = []
... | [
"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-python/graphene-django | python | https://github.com/graphql-python/graphene-django/blob/20160113948b4167b61dbdaa477bb301227aac2e/graphene_django/rest_framework/serializer_converter.py#L21-L56 | [
"def",
"convert_serializer_field",
"(",
"field",
",",
"is_input",
"=",
"True",
")",
":",
"graphql_type",
"=",
"get_graphene_type_from_serializer_field",
"(",
"field",
")",
"args",
"=",
"[",
"]",
"kwargs",
"=",
"{",
"\"description\"",
":",
"field",
".",
"help_tex... | 20160113948b4167b61dbdaa477bb301227aac2e |
train | perform_import | If the given setting is a string import notation,
then perform the necessary import or imports. | graphene_django/settings.py | 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 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,... | [
"If",
"the",
"given",
"setting",
"is",
"a",
"string",
"import",
"notation",
"then",
"perform",
"the",
"necessary",
"import",
"or",
"imports",
"."
] | graphql-python/graphene-django | python | https://github.com/graphql-python/graphene-django/blob/20160113948b4167b61dbdaa477bb301227aac2e/graphene_django/settings.py#L47-L58 | [
"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... | 20160113948b4167b61dbdaa477bb301227aac2e |
train | custom_filterset_factory | Create a filterset for the given model using the provided meta data | graphene_django/filter/filterset.py | 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):
""" 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... | [
"Create",
"a",
"filterset",
"for",
"the",
"given",
"model",
"using",
"the",
"provided",
"meta",
"data"
] | graphql-python/graphene-django | python | https://github.com/graphql-python/graphene-django/blob/20160113948b4167b61dbdaa477bb301227aac2e/graphene_django/filter/filterset.py#L95-L105 | [
"def",
"custom_filterset_factory",
"(",
"model",
",",
"filterset_base_class",
"=",
"FilterSet",
",",
"*",
"*",
"meta",
")",
":",
"meta",
".",
"update",
"(",
"{",
"\"model\"",
":",
"model",
"}",
")",
"meta_class",
"=",
"type",
"(",
"str",
"(",
"\"Meta\"",
... | 20160113948b4167b61dbdaa477bb301227aac2e |
train | GlobalIDFilter.filter | Convert the filter value to a primary key before filtering | graphene_django/filter/filterset.py | 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):
""" 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) | [
"Convert",
"the",
"filter",
"value",
"to",
"a",
"primary",
"key",
"before",
"filtering"
] | graphql-python/graphene-django | python | https://github.com/graphql-python/graphene-django/blob/20160113948b4167b61dbdaa477bb301227aac2e/graphene_django/filter/filterset.py#L16-L21 | [
"def",
"filter",
"(",
"self",
",",
"qs",
",",
"value",
")",
":",
"_id",
"=",
"None",
"if",
"value",
"is",
"not",
"None",
":",
"_",
",",
"_id",
"=",
"from_global_id",
"(",
"value",
")",
"return",
"super",
"(",
"GlobalIDFilter",
",",
"self",
")",
"."... | 20160113948b4167b61dbdaa477bb301227aac2e |
train | get_filtering_args_from_filterset | Inspect a FilterSet and produce the arguments to pass to
a Graphene Field. These arguments will be available to
filter against in the GraphQL | graphene_django/filter/utils.py | 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):
""" 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... | [
"Inspect",
"a",
"FilterSet",
"and",
"produce",
"the",
"arguments",
"to",
"pass",
"to",
"a",
"Graphene",
"Field",
".",
"These",
"arguments",
"will",
"be",
"available",
"to",
"filter",
"against",
"in",
"the",
"GraphQL"
] | graphql-python/graphene-django | python | https://github.com/graphql-python/graphene-django/blob/20160113948b4167b61dbdaa477bb301227aac2e/graphene_django/filter/utils.py#L6-L19 | [
"def",
"get_filtering_args_from_filterset",
"(",
"filterset_class",
",",
"type",
")",
":",
"from",
".",
".",
"forms",
".",
"converter",
"import",
"convert_form_field",
"args",
"=",
"{",
"}",
"for",
"name",
",",
"filter_field",
"in",
"six",
".",
"iteritems",
"(... | 20160113948b4167b61dbdaa477bb301227aac2e |
train | AdminClient._make_topics_result | Map per-topic results to per-topic futures in futmap.
The result value of each (successful) future is None. | confluent_kafka/admin/__init__.py | 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):
"""
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... | [
"Map",
"per",
"-",
"topic",
"results",
"to",
"per",
"-",
"topic",
"futures",
"in",
"futmap",
".",
"The",
"result",
"value",
"of",
"each",
"(",
"successful",
")",
"future",
"is",
"None",
"."
] | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/admin/__init__.py#L219-L240 | [
"def",
"_make_topics_result",
"(",
"f",
",",
"futmap",
")",
":",
"try",
":",
"result",
"=",
"f",
".",
"result",
"(",
")",
"for",
"topic",
",",
"error",
"in",
"result",
".",
"items",
"(",
")",
":",
"fut",
"=",
"futmap",
".",
"get",
"(",
"topic",
"... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | AdminClient._make_resource_result | Map per-resource results to per-resource futures in futmap.
The result value of each (successful) future is a ConfigResource. | confluent_kafka/admin/__init__.py | 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):
"""
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... | [
"Map",
"per",
"-",
"resource",
"results",
"to",
"per",
"-",
"resource",
"futures",
"in",
"futmap",
".",
"The",
"result",
"value",
"of",
"each",
"(",
"successful",
")",
"future",
"is",
"a",
"ConfigResource",
"."
] | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/admin/__init__.py#L243-L265 | [
"def",
"_make_resource_result",
"(",
"f",
",",
"futmap",
")",
":",
"try",
":",
"result",
"=",
"f",
".",
"result",
"(",
")",
"for",
"resource",
",",
"configs",
"in",
"result",
".",
"items",
"(",
")",
":",
"fut",
"=",
"futmap",
".",
"get",
"(",
"reso... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | AdminClient._make_futures | Create futures and a futuremap for the keys in futmap_keys,
and create a request-level future to be bassed to the C API. | confluent_kafka/admin/__init__.py | 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):
"""
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... | [
"Create",
"futures",
"and",
"a",
"futuremap",
"for",
"the",
"keys",
"in",
"futmap_keys",
"and",
"create",
"a",
"request",
"-",
"level",
"future",
"to",
"be",
"bassed",
"to",
"the",
"C",
"API",
"."
] | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/admin/__init__.py#L268-L290 | [
"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_... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | AdminClient.create_topics | 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... | confluent_kafka/admin/__init__.py | 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):
"""
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... | [
"Create",
"new",
"topics",
"in",
"cluster",
"."
] | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/admin/__init__.py#L292-L323 | [
"def",
"create_topics",
"(",
"self",
",",
"new_topics",
",",
"*",
"*",
"kwargs",
")",
":",
"f",
",",
"futmap",
"=",
"AdminClient",
".",
"_make_futures",
"(",
"[",
"x",
".",
"topic",
"for",
"x",
"in",
"new_topics",
"]",
",",
"None",
",",
"AdminClient",
... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | AdminClient.delete_topics | 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 ... | confluent_kafka/admin/__init__.py | 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):
"""
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... | [
"Delete",
"topics",
"."
] | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/admin/__init__.py#L325-L353 | [
"def",
"delete_topics",
"(",
"self",
",",
"topics",
",",
"*",
"*",
"kwargs",
")",
":",
"f",
",",
"futmap",
"=",
"AdminClient",
".",
"_make_futures",
"(",
"topics",
",",
"None",
",",
"AdminClient",
".",
"_make_topics_result",
")",
"super",
"(",
"AdminClient... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | AdminClient.create_partitions | 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 ... | confluent_kafka/admin/__init__.py | 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):
"""
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... | [
"Create",
"additional",
"partitions",
"for",
"the",
"given",
"topics",
"."
] | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/admin/__init__.py#L355-L386 | [
"def",
"create_partitions",
"(",
"self",
",",
"new_partitions",
",",
"*",
"*",
"kwargs",
")",
":",
"f",
",",
"futmap",
"=",
"AdminClient",
".",
"_make_futures",
"(",
"[",
"x",
".",
"topic",
"for",
"x",
"in",
"new_partitions",
"]",
",",
"None",
",",
"Ad... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | AdminClient.describe_configs | 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... | confluent_kafka/admin/__init__.py | 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):
"""
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... | [
"Get",
"configuration",
"for",
"the",
"specified",
"resources",
"."
] | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/admin/__init__.py#L388-L419 | [
"def",
"describe_configs",
"(",
"self",
",",
"resources",
",",
"*",
"*",
"kwargs",
")",
":",
"f",
",",
"futmap",
"=",
"AdminClient",
".",
"_make_futures",
"(",
"resources",
",",
"ConfigResource",
",",
"AdminClient",
".",
"_make_resource_result",
")",
"super",
... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | loads | Parse a schema given a schema string | confluent_kafka/avro/load.py | 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):
""" 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... | [
"Parse",
"a",
"schema",
"given",
"a",
"schema",
"string"
] | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/avro/load.py#L23-L31 | [
"def",
"loads",
"(",
"schema_str",
")",
":",
"try",
":",
"if",
"sys",
".",
"version_info",
"[",
"0",
"]",
"<",
"3",
":",
"return",
"schema",
".",
"parse",
"(",
"schema_str",
")",
"else",
":",
"return",
"schema",
".",
"Parse",
"(",
"schema_str",
")",
... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | AvroProducer.produce | 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... | confluent_kafka/avro/__init__.py | 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):
"""
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... | [
"Asynchronously",
"sends",
"message",
"to",
"Kafka",
"by",
"encoding",
"with",
"specified",
"or",
"default",
"avro",
"schema",
"."
] | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/avro/__init__.py#L53-L90 | [
"def",
"produce",
"(",
"self",
",",
"*",
"*",
"kwargs",
")",
":",
"# get schemas from kwargs if defined",
"key_schema",
"=",
"kwargs",
".",
"pop",
"(",
"'key_schema'",
",",
"self",
".",
"_key_schema",
")",
"value_schema",
"=",
"kwargs",
".",
"pop",
"(",
"'v... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | AvroConsumer.poll | 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 | confluent_kafka/avro/__init__.py | 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):
"""
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 ... | [
"This",
"is",
"an",
"overriden",
"method",
"from",
"confluent_kafka",
".",
"Consumer",
"class",
".",
"This",
"handles",
"message",
"deserialization",
"using",
"avro",
"schema"
] | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/avro/__init__.py#L128-L157 | [
"def",
"poll",
"(",
"self",
",",
"timeout",
"=",
"None",
")",
":",
"if",
"timeout",
"is",
"None",
":",
"timeout",
"=",
"-",
"1",
"message",
"=",
"super",
"(",
"AvroConsumer",
",",
"self",
")",
".",
"poll",
"(",
"timeout",
")",
"if",
"message",
"is"... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | MessageSerializer.encode_record_with_schema | 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
... | confluent_kafka/avro/serializer/message_serializer.py | 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):
"""
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
... | [
"Given",
"a",
"parsed",
"avro",
"schema",
"encode",
"a",
"record",
"for",
"the",
"given",
"topic",
".",
"The",
"record",
"is",
"expected",
"to",
"be",
"a",
"dictionary",
"."
] | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/avro/serializer/message_serializer.py#L86-L113 | [
"def",
"encode_record_with_schema",
"(",
"self",
",",
"topic",
",",
"schema",
",",
"record",
",",
"is_key",
"=",
"False",
")",
":",
"serialize_err",
"=",
"KeySerializerError",
"if",
"is_key",
"else",
"ValueSerializerError",
"subject_suffix",
"=",
"(",
"'-key'",
... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | MessageSerializer.encode_record_with_schema_id | 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 | confluent_kafka/avro/serializer/message_serializer.py | 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):
"""
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... | [
"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... | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/avro/serializer/message_serializer.py#L115-L149 | [
"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",... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | MessageSerializer.decode_message | 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: | confluent_kafka/avro/serializer/message_serializer.py | 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):
"""
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... | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/avro/serializer/message_serializer.py#L207-L227 | [
"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... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | acked | Delivery report callback called (from flush()) on successful or failed delivery of the message. | examples/confluent_cloud.py | 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):
"""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())) | [
"Delivery",
"report",
"callback",
"called",
"(",
"from",
"flush",
"()",
")",
"on",
"successful",
"or",
"failed",
"delivery",
"of",
"the",
"message",
"."
] | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/examples/confluent_cloud.py#L65-L70 | [
"def",
"acked",
"(",
"err",
",",
"msg",
")",
":",
"if",
"err",
"is",
"not",
"None",
":",
"print",
"(",
"\"failed to deliver message: {}\"",
".",
"format",
"(",
"err",
".",
"str",
"(",
")",
")",
")",
"else",
":",
"print",
"(",
"\"produced to: {} [{}] @ {}... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | example_create_topics | Create topics | examples/adminapi.py | 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):
""" 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... | [
"Create",
"topics"
] | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/examples/adminapi.py#L31-L48 | [
"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... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | example_delete_topics | delete topics | examples/adminapi.py | 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):
""" 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... | [
"delete",
"topics"
] | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/examples/adminapi.py#L51-L68 | [
"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)",
... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | example_create_partitions | create partitions | examples/adminapi.py | 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):
""" 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... | [
"create",
"partitions"
] | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/examples/adminapi.py#L71-L87 | [
"def",
"example_create_partitions",
"(",
"a",
",",
"topics",
")",
":",
"new_parts",
"=",
"[",
"NewPartitions",
"(",
"topic",
",",
"int",
"(",
"new_total_count",
")",
")",
"for",
"topic",
",",
"new_total_count",
"in",
"zip",
"(",
"topics",
"[",
"0",
":",
... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | example_describe_configs | describe configs | examples/adminapi.py | 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):
""" 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:
... | [
"describe",
"configs"
] | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/examples/adminapi.py#L99-L117 | [
"def",
"example_describe_configs",
"(",
"a",
",",
"args",
")",
":",
"resources",
"=",
"[",
"ConfigResource",
"(",
"restype",
",",
"resname",
")",
"for",
"restype",
",",
"resname",
"in",
"zip",
"(",
"args",
"[",
"0",
":",
":",
"2",
"]",
",",
"args",
"... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | example_alter_configs | Alter configs atomically, replacing non-specified
configuration properties with their default values. | examples/adminapi.py | 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):
""" 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... | [
"Alter",
"configs",
"atomically",
"replacing",
"non",
"-",
"specified",
"configuration",
"properties",
"with",
"their",
"default",
"values",
"."
] | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/examples/adminapi.py#L120-L140 | [
"def",
"example_alter_configs",
"(",
"a",
",",
"args",
")",
":",
"resources",
"=",
"[",
"]",
"for",
"restype",
",",
"resname",
",",
"configs",
"in",
"zip",
"(",
"args",
"[",
"0",
":",
":",
"3",
"]",
",",
"args",
"[",
"1",
":",
":",
"3",
"]",
",... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | example_delta_alter_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... | examples/adminapi.py | 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):
"""
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 ... | [
"The",
"AlterConfigs",
"Kafka",
"API",
"requires",
"all",
"configuration",
"to",
"be",
"passed",
"any",
"left",
"out",
"configuration",
"properties",
"will",
"revert",
"to",
"their",
"default",
"settings",
"."
] | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/examples/adminapi.py#L143-L232 | [
"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... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | example_list | list topics and cluster metadata | examples/adminapi.py | 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):
""" 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... | [
"list",
"topics",
"and",
"cluster",
"metadata"
] | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/examples/adminapi.py#L235-L274 | [
"def",
"example_list",
"(",
"a",
",",
"args",
")",
":",
"if",
"len",
"(",
"args",
")",
"==",
"0",
":",
"what",
"=",
"\"all\"",
"else",
":",
"what",
"=",
"args",
"[",
"0",
"]",
"md",
"=",
"a",
".",
"list_topics",
"(",
"timeout",
"=",
"10",
")",
... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | _resolve_plugins | Resolve embedded plugins from the wheel's library directory.
For internal module use only.
:param str plugins: The plugin.library.paths value | confluent_kafka/__init__.py | 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):
""" 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
... | [
"Resolve",
"embedded",
"plugins",
"from",
"the",
"wheel",
"s",
"library",
"directory",
"."
] | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/__init__.py#L47-L102 | [
"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",... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | on_delivery | 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. | examples/avro-cli.py | 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):
"""
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... | [
"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",
"."
] | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/examples/avro-cli.py#L68-L79 | [
"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",
... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | produce | Produce User records | examples/avro-cli.py | 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):
"""
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... | [
"Produce",
"User",
"records"
] | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/examples/avro-cli.py#L82-L113 | [
"def",
"produce",
"(",
"topic",
",",
"conf",
")",
":",
"from",
"confluent_kafka",
".",
"avro",
"import",
"AvroProducer",
"producer",
"=",
"AvroProducer",
"(",
"conf",
",",
"default_value_schema",
"=",
"record_schema",
")",
"print",
"(",
"\"Producing user records t... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | consume | Consume User records | examples/avro-cli.py | 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):
"""
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... | [
"Consume",
"User",
"records"
] | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/examples/avro-cli.py#L116-L151 | [
"def",
"consume",
"(",
"topic",
",",
"conf",
")",
":",
"from",
"confluent_kafka",
".",
"avro",
"import",
"AvroConsumer",
"from",
"confluent_kafka",
".",
"avro",
".",
"serializer",
"import",
"SerializerError",
"print",
"(",
"\"Consuming user records from topic {} with ... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | CachedSchemaRegistryClient.register | 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... | confluent_kafka/avro/cached_schema_registry_client.py | 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):
"""
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... | [
"POST",
"/",
"subjects",
"/",
"(",
"string",
":",
"subject",
")",
"/",
"versions",
"Register",
"a",
"schema",
"with",
"the",
"registry",
"under",
"the",
"given",
"subject",
"and",
"receive",
"a",
"schema",
"id",
"."
] | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/avro/cached_schema_registry_client.py#L192-L230 | [
"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_... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | CachedSchemaRegistryClient.delete_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: subject name
:returns: version of the schema del... | confluent_kafka/avro/cached_schema_registry_client.py | 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):
"""
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... | [
"DELETE",
"/",
"subjects",
"/",
"(",
"string",
":",
"subject",
")",
"Deletes",
"the",
"specified",
"subject",
"and",
"its",
"associated",
"compatibility",
"level",
"if",
"registered",
".",
"It",
"is",
"recommended",
"to",
"use",
"this",
"API",
"only",
"when"... | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/avro/cached_schema_registry_client.py#L232-L247 | [
"def",
"delete_subject",
"(",
"self",
",",
"subject",
")",
":",
"url",
"=",
"'/'",
".",
"join",
"(",
"[",
"self",
".",
"url",
",",
"'subjects'",
",",
"subject",
"]",
")",
"result",
",",
"code",
"=",
"self",
".",
"_send_request",
"(",
"url",
",",
"m... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | CachedSchemaRegistryClient.get_by_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 | confluent_kafka/avro/cached_schema_registry_client.py | 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):
"""
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... | [
"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... | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/avro/cached_schema_registry_client.py#L249-L279 | [
"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... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | CachedSchemaRegistryClient.get_version | 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 | confluent_kafka/avro/cached_schema_registry_client.py | 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):
"""
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... | [
"POST",
"/",
"subjects",
"/",
"(",
"string",
":",
"subject",
")"
] | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/avro/cached_schema_registry_client.py#L321-L351 | [
"def",
"get_version",
"(",
"self",
",",
"subject",
",",
"avro_schema",
")",
":",
"schemas_to_version",
"=",
"self",
".",
"subject_to_schema_versions",
"[",
"subject",
"]",
"version",
"=",
"schemas_to_version",
".",
"get",
"(",
"avro_schema",
",",
"None",
")",
... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | CachedSchemaRegistryClient.update_compatibility | 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' | confluent_kafka/avro/cached_schema_registry_client.py | 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):
"""
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... | [
"PUT",
"/",
"config",
"/",
"(",
"string",
":",
"subject",
")"
] | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/avro/cached_schema_registry_client.py#L385-L405 | [
"def",
"update_compatibility",
"(",
"self",
",",
"level",
",",
"subject",
"=",
"None",
")",
":",
"if",
"level",
"not",
"in",
"VALID_LEVELS",
":",
"raise",
"ClientError",
"(",
"\"Invalid level specified: %s\"",
"%",
"(",
"str",
"(",
"level",
")",
")",
")",
... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | CachedSchemaRegistryClient.get_compatibility | 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... | confluent_kafka/avro/cached_schema_registry_client.py | 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):
"""
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... | [
"GET",
"/",
"config",
"Get",
"the",
"current",
"compatibility",
"level",
"for",
"a",
"subject",
".",
"Result",
"will",
"be",
"one",
"of",
":"
] | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/confluent_kafka/avro/cached_schema_registry_client.py#L407-L434 | [
"def",
"get_compatibility",
"(",
"self",
",",
"subject",
"=",
"None",
")",
":",
"url",
"=",
"'/'",
".",
"join",
"(",
"[",
"self",
".",
"url",
",",
"'config'",
"]",
")",
"if",
"subject",
":",
"url",
"=",
"'/'",
".",
"join",
"(",
"[",
"url",
",",
... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | Artifact.download | Download artifact from S3 and store in dirpath directory.
If the artifact is already downloaded nothing is done. | tools/download-s3.py | 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):
""" 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.... | [
"Download",
"artifact",
"from",
"S3",
"and",
"store",
"in",
"dirpath",
"directory",
".",
"If",
"the",
"artifact",
"is",
"already",
"downloaded",
"nothing",
"is",
"done",
"."
] | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/tools/download-s3.py#L46-L54 | [
"def",
"download",
"(",
"self",
",",
"dirpath",
")",
":",
"if",
"os",
".",
"path",
".",
"isfile",
"(",
"self",
".",
"lpath",
")",
"and",
"os",
".",
"path",
".",
"getsize",
"(",
"self",
".",
"lpath",
")",
">",
"0",
":",
"return",
"print",
"(",
"... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | Artifacts.collect_single_s3 | Collect single S3 artifact
:param: path string: S3 path | tools/download-s3.py | 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):
""" 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... | [
"Collect",
"single",
"S3",
"artifact",
":",
"param",
":",
"path",
"string",
":",
"S3",
"path"
] | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/tools/download-s3.py#L68-L102 | [
"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",
"(... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | Artifacts.collect_s3 | Collect and download build-artifacts from S3 based on git reference | tools/download-s3.py | 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):
""" 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.... | [
"Collect",
"and",
"download",
"build",
"-",
"artifacts",
"from",
"S3",
"based",
"on",
"git",
"reference"
] | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/tools/download-s3.py#L104-L114 | [
"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",
... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | Artifacts.collect_local | Collect artifacts from a local directory possibly previously
collected from s3 | tools/download-s3.py | 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):
""" 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) | [
"Collect",
"artifacts",
"from",
"a",
"local",
"directory",
"possibly",
"previously",
"collected",
"from",
"s3"
] | confluentinc/confluent-kafka-python | python | https://github.com/confluentinc/confluent-kafka-python/blob/5a8aeb741609e61eaccafff2a67fa494dd549e8b/tools/download-s3.py#L116-L123 | [
"def",
"collect_local",
"(",
"self",
",",
"path",
")",
":",
"for",
"f",
"in",
"os",
".",
"listdir",
"(",
"path",
")",
":",
"lpath",
"=",
"os",
".",
"path",
".",
"join",
"(",
"path",
",",
"f",
")",
"if",
"not",
"os",
".",
"path",
".",
"isfile",
... | 5a8aeb741609e61eaccafff2a67fa494dd549e8b |
train | _config | 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'. | salt/modules/ddns.py | 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):
'''
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 ... | [
"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",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/ddns.py#L55-L68 | [
"def",
"_config",
"(",
"name",
",",
"key",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"key",
"is",
"None",
":",
"key",
"=",
"name",
"if",
"name",
"in",
"kwargs",
":",
"value",
"=",
"kwargs",
"[",
"name",
"]",
"else",
":",
"value",
"=... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | add_host | 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 | salt/modules/ddns.py | 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):
'''
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 = ... | [
"Add",
"replace",
"or",
"update",
"the",
"A",
"and",
"PTR",
"(",
"reverse",
")",
"records",
"for",
"a",
"host",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/ddns.py#L79-L109 | [
"def",
"add_host",
"(",
"zone",
",",
"name",
",",
"ttl",
",",
"ip",
",",
"nameserver",
"=",
"'127.0.0.1'",
",",
"replace",
"=",
"True",
",",
"timeout",
"=",
"5",
",",
"port",
"=",
"53",
",",
"*",
"*",
"kwargs",
")",
":",
"res",
"=",
"update",
"("... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | delete_host | 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 | salt/modules/ddns.py | 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):
'''
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... | [
"Delete",
"the",
"forward",
"and",
"reverse",
"records",
"for",
"a",
"host",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/ddns.py#L112-L151 | [
"def",
"delete_host",
"(",
"zone",
",",
"name",
",",
"nameserver",
"=",
"'127.0.0.1'",
",",
"timeout",
"=",
"5",
",",
"port",
"=",
"53",
",",
"*",
"*",
"kwargs",
")",
":",
"fqdn",
"=",
"'{0}.{1}'",
".",
"format",
"(",
"name",
",",
"zone",
")",
"req... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | update | 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... | salt/modules/ddns.py | 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):
'''
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... | [
"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",... | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/ddns.py#L154-L205 | [
"def",
"update",
"(",
"zone",
",",
"name",
",",
"ttl",
",",
"rdtype",
",",
"data",
",",
"nameserver",
"=",
"'127.0.0.1'",
",",
"timeout",
"=",
"5",
",",
"replace",
"=",
"False",
",",
"port",
"=",
"53",
",",
"*",
"*",
"kwargs",
")",
":",
"name",
"... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | _set_callables | Set all Ansible modules callables
:return: | salt/modules/ansiblegate.py | 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):
'''
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... | [
"Set",
"all",
"Ansible",
"modules",
"callables",
":",
"return",
":"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/ansiblegate.py#L190-L215 | [
"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 ... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | help | Display help on Ansible standard module.
:param module:
:return: | salt/modules/ansiblegate.py | 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):
'''
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... | [
"Display",
"help",
"on",
"Ansible",
"standard",
"module",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/ansiblegate.py#L237-L273 | [
"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",
":... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | playbooks | 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... | salt/modules/ansiblegate.py | 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, 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... | [
"Run",
"Ansible",
"Playbooks"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/ansiblegate.py#L286-L381 | [
"def",
"playbooks",
"(",
"playbook",
",",
"rundir",
"=",
"None",
",",
"check",
"=",
"False",
",",
"diff",
"=",
"False",
",",
"extra_vars",
"=",
"None",
",",
"flush_cache",
"=",
"False",
",",
"forks",
"=",
"5",
",",
"inventory",
"=",
"None",
",",
"lim... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | AnsibleModuleResolver._get_modules_map | Get installed Ansible modules
:return: | salt/modules/ansiblegate.py | 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):
'''
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)
... | [
"Get",
"installed",
"Ansible",
"modules",
":",
"return",
":"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/ansiblegate.py#L68-L92 | [
"def",
"_get_modules_map",
"(",
"self",
",",
"path",
"=",
"None",
")",
":",
"paths",
"=",
"{",
"}",
"root",
"=",
"ansible",
".",
"modules",
".",
"__path__",
"[",
"0",
"]",
"if",
"not",
"path",
":",
"path",
"=",
"root",
"for",
"p_el",
"in",
"os",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | AnsibleModuleResolver.load_module | Introspect Ansible module.
:param module:
:return: | salt/modules/ansiblegate.py | 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):
'''
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... | [
"Introspect",
"Ansible",
"module",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/ansiblegate.py#L94-L107 | [
"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... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | AnsibleModuleResolver.get_modules_list | Return module map references.
:return: | salt/modules/ansiblegate.py | 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):
'''
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... | [
"Return",
"module",
"map",
"references",
".",
":",
"return",
":"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/ansiblegate.py#L109-L122 | [
"def",
"get_modules_list",
"(",
"self",
",",
"pattern",
"=",
"None",
")",
":",
"if",
"pattern",
"and",
"'*'",
"not",
"in",
"pattern",
":",
"pattern",
"=",
"'*{0}*'",
".",
"format",
"(",
"pattern",
")",
"modules",
"=",
"[",
"]",
"for",
"m_name",
",",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | AnsibleModuleCaller.call | 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: | salt/modules/ansiblegate.py | 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):
'''
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)
... | [
"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",... | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/ansiblegate.py#L142-L183 | [
"def",
"call",
"(",
"self",
",",
"module",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"module",
"=",
"self",
".",
"_resolver",
".",
"load_module",
"(",
"module",
")",
"if",
"not",
"hasattr",
"(",
"module",
",",
"'main'",
")",
":",
"raise"... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | __clean_tmp | Clean out a template temp file | salt/modules/file.py | 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):
'''
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(
... | [
"Clean",
"out",
"a",
"template",
"temp",
"file"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L88-L100 | [
"def",
"__clean_tmp",
"(",
"sfn",
")",
":",
"if",
"sfn",
".",
"startswith",
"(",
"os",
".",
"path",
".",
"join",
"(",
"tempfile",
".",
"gettempdir",
"(",
")",
",",
"salt",
".",
"utils",
".",
"files",
".",
"TEMPFILE_PREFIX",
")",
")",
":",
"# Don't re... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | _binary_replace | 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... | salt/modules/file.py | 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):
'''
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... | [
"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",
... | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L112-L131 | [
"def",
"_binary_replace",
"(",
"old",
",",
"new",
")",
":",
"old_isbin",
"=",
"not",
"__utils__",
"[",
"'files.is_text'",
"]",
"(",
"old",
")",
"new_isbin",
"=",
"not",
"__utils__",
"[",
"'files.is_text'",
"]",
"(",
"new",
")",
"if",
"any",
"(",
"(",
"... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | _splitlines_preserving_trailing_newline | 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... | salt/modules/file.py | 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):
'''
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... | [
"Returns",
"a",
"list",
"of",
"the",
"lines",
"in",
"the",
"string",
"breaking",
"at",
"line",
"boundaries",
"and",
"preserving",
"a",
"trailing",
"newline",
"(",
"if",
"present",
")",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L142-L159 | [
"def",
"_splitlines_preserving_trailing_newline",
"(",
"str",
")",
":",
"lines",
"=",
"str",
".",
"splitlines",
"(",
")",
"if",
"str",
".",
"endswith",
"(",
"'\\n'",
")",
"or",
"str",
".",
"endswith",
"(",
"'\\r'",
")",
":",
"lines",
".",
"append",
"(",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | gid_to_group | 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 | salt/modules/file.py | 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):
'''
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... | [
"Convert",
"the",
"group",
"id",
"to",
"the",
"group",
"name",
"on",
"this",
"system"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L162-L189 | [
"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",
"==",
"''",
":",... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | group_to_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 | salt/modules/file.py | 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):
'''
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... | [
"Convert",
"the",
"group",
"to",
"the",
"gid",
"on",
"this",
"system"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L192-L212 | [
"def",
"group_to_gid",
"(",
"group",
")",
":",
"if",
"group",
"is",
"None",
":",
"return",
"''",
"try",
":",
"if",
"isinstance",
"(",
"group",
",",
"int",
")",
":",
"return",
"group",
"return",
"grp",
".",
"getgrnam",
"(",
"group",
")",
".",
"gr_gid"... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | get_gid | 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... | salt/modules/file.py | 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 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... | [
"Return",
"the",
"id",
"of",
"the",
"group",
"that",
"owns",
"a",
"given",
"file"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L215-L235 | [
"def",
"get_gid",
"(",
"path",
",",
"follow_symlinks",
"=",
"True",
")",
":",
"return",
"stats",
"(",
"os",
".",
"path",
".",
"expanduser",
"(",
"path",
")",
",",
"follow_symlinks",
"=",
"follow_symlinks",
")",
".",
"get",
"(",
"'gid'",
",",
"-",
"1",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | get_group | 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``... | salt/modules/file.py | 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 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
... | [
"Return",
"the",
"group",
"that",
"owns",
"a",
"given",
"file"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L238-L257 | [
"def",
"get_group",
"(",
"path",
",",
"follow_symlinks",
"=",
"True",
")",
":",
"return",
"stats",
"(",
"os",
".",
"path",
".",
"expanduser",
"(",
"path",
")",
",",
"follow_symlinks",
"=",
"follow_symlinks",
")",
".",
"get",
"(",
"'group'",
",",
"False",... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | user_to_uid | 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 | salt/modules/file.py | 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):
'''
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):
... | [
"Convert",
"user",
"name",
"to",
"a",
"uid"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L280-L300 | [
"def",
"user_to_uid",
"(",
"user",
")",
":",
"if",
"user",
"is",
"None",
":",
"user",
"=",
"salt",
".",
"utils",
".",
"user",
".",
"get_user",
"(",
")",
"try",
":",
"if",
"isinstance",
"(",
"user",
",",
"int",
")",
":",
"return",
"user",
"return",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | get_uid | 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... | salt/modules/file.py | 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 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
... | [
"Return",
"the",
"id",
"of",
"the",
"user",
"that",
"owns",
"a",
"given",
"file"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L303-L322 | [
"def",
"get_uid",
"(",
"path",
",",
"follow_symlinks",
"=",
"True",
")",
":",
"return",
"stats",
"(",
"os",
".",
"path",
".",
"expanduser",
"(",
"path",
")",
",",
"follow_symlinks",
"=",
"follow_symlinks",
")",
".",
"get",
"(",
"'uid'",
",",
"-",
"1",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | 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 | salt/modules/file.py | 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 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... | [
"Return",
"the",
"mode",
"of",
"a",
"file"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L347-L366 | [
"def",
"get_mode",
"(",
"path",
",",
"follow_symlinks",
"=",
"True",
")",
":",
"return",
"stats",
"(",
"os",
".",
"path",
".",
"expanduser",
"(",
"path",
")",
",",
"follow_symlinks",
"=",
"follow_symlinks",
")",
".",
"get",
"(",
"'mode'",
",",
"''",
")... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | set_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 | salt/modules/file.py | 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):
'''
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... | [
"Set",
"the",
"mode",
"of",
"a",
"file"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L369-L396 | [
"def",
"set_mode",
"(",
"path",
",",
"mode",
")",
":",
"path",
"=",
"os",
".",
"path",
".",
"expanduser",
"(",
"path",
")",
"mode",
"=",
"six",
".",
"text_type",
"(",
"mode",
")",
".",
"lstrip",
"(",
"'0Oo'",
")",
"if",
"not",
"mode",
":",
"mode"... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | lchown | 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 | salt/modules/file.py | 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):
'''
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... | [
"Chown",
"a",
"file",
"pass",
"the",
"file",
"the",
"desired",
"user",
"and",
"group",
"without",
"following",
"symlinks",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L399-L435 | [
"def",
"lchown",
"(",
"path",
",",
"user",
",",
"group",
")",
":",
"path",
"=",
"os",
".",
"path",
".",
"expanduser",
"(",
"path",
")",
"uid",
"=",
"user_to_uid",
"(",
"user",
")",
"gid",
"=",
"group_to_gid",
"(",
"group",
")",
"err",
"=",
"''",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | chown | 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 | salt/modules/file.py | 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):
'''
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... | [
"Chown",
"a",
"file",
"pass",
"the",
"file",
"the",
"desired",
"user",
"and",
"group"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L438-L481 | [
"def",
"chown",
"(",
"path",
",",
"user",
",",
"group",
")",
":",
"path",
"=",
"os",
".",
"path",
".",
"expanduser",
"(",
"path",
")",
"uid",
"=",
"user_to_uid",
"(",
"user",
")",
"gid",
"=",
"group_to_gid",
"(",
"group",
")",
"err",
"=",
"''",
"... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | chgrp | 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 | salt/modules/file.py | 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):
'''
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(... | [
"Change",
"the",
"group",
"of",
"a",
"file"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L484-L503 | [
"def",
"chgrp",
"(",
"path",
",",
"group",
")",
":",
"path",
"=",
"os",
".",
"path",
".",
"expanduser",
"(",
"path",
")",
"user",
"=",
"get_user",
"(",
"path",
")",
"return",
"chown",
"(",
"path",
",",
"user",
",",
"group",
")"
] | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | _cmp_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 have lsattr installed.
path
p... | salt/modules/file.py | 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):
'''
.. 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... | [
"..",
"versionadded",
"::",
"2018",
".",
"3",
".",
"0"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L506-L543 | [
"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",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | lsattr | .. 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 ... | salt/modules/file.py | 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):
'''
.. 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... | [
"..",
"versionadded",
"::",
"2018",
".",
"3",
".",
"0",
"..",
"versionchanged",
"::",
"2018",
".",
"3",
".",
"1",
"If",
"lsattr",
"is",
"not",
"installed",
"on",
"the",
"system",
"None",
"is",
"returned",
".",
"..",
"versionchanged",
"::",
"2018",
".",... | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L546-L582 | [
"def",
"lsattr",
"(",
"path",
")",
":",
"if",
"not",
"salt",
".",
"utils",
".",
"path",
".",
"which",
"(",
"'lsattr'",
")",
"or",
"salt",
".",
"utils",
".",
"platform",
".",
"is_aix",
"(",
")",
":",
"return",
"None",
"if",
"not",
"os",
".",
"path... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | chattr | .. 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... | salt/modules/file.py | 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):
'''
.. 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... | [
"..",
"versionadded",
"::",
"2018",
".",
"3",
".",
"0"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L585-L648 | [
"def",
"chattr",
"(",
"*",
"files",
",",
"*",
"*",
"kwargs",
")",
":",
"operator",
"=",
"kwargs",
".",
"pop",
"(",
"'operator'",
",",
"None",
")",
"attributes",
"=",
"kwargs",
".",
"pop",
"(",
"'attributes'",
",",
"None",
")",
"flags",
"=",
"kwargs",... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | get_sum | 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... | salt/modules/file.py | 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'):
'''
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... | [
"Return",
"the",
"checksum",
"for",
"the",
"given",
"file",
".",
"The",
"following",
"checksum",
"algorithms",
"are",
"supported",
":"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L651-L679 | [
"def",
"get_sum",
"(",
"path",
",",
"form",
"=",
"'sha256'",
")",
":",
"path",
"=",
"os",
".",
"path",
".",
"expanduser",
"(",
"path",
")",
"if",
"not",
"os",
".",
"path",
".",
"isfile",
"(",
"path",
")",
":",
"return",
"'File not found'",
"return",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | get_hash | 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... | salt/modules/file.py | 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):
'''
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 ... | [
"Get",
"the",
"hash",
"sum",
"of",
"a",
"file"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L682-L707 | [
"def",
"get_hash",
"(",
"path",
",",
"form",
"=",
"'sha256'",
",",
"chunk_size",
"=",
"65536",
")",
":",
"return",
"salt",
".",
"utils",
".",
"hashutils",
".",
"get_hash",
"(",
"os",
".",
"path",
".",
"expanduser",
"(",
"path",
")",
",",
"form",
",",... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | get_source_sum | .. 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>`.... | salt/modules/file.py | 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'):
'''
.. versionadded:: 2016.11.0
Used by :py:func:`file.get_managed <salt.modules.file.get_managed>` to
obtain the hash and ha... | [
"..",
"versionadded",
"::",
"2016",
".",
"11",
".",
"0"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L710-L848 | [
"def",
"get_source_sum",
"(",
"file_name",
"=",
"''",
",",
"source",
"=",
"''",
",",
"source_hash",
"=",
"None",
",",
"source_hash_name",
"=",
"None",
",",
"saltenv",
"=",
"'base'",
")",
":",
"def",
"_invalid_source_hash_format",
"(",
")",
":",
"'''\n ... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | check_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.
.. versionchanged:: 2016.11.4
For this and newer ... | salt/modules/file.py | 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):
'''
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... | [
"Check",
"if",
"a",
"file",
"matches",
"the",
"given",
"hash",
"string"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L851-L905 | [
"def",
"check_hash",
"(",
"path",
",",
"file_hash",
")",
":",
"path",
"=",
"os",
".",
"path",
".",
"expanduser",
"(",
"path",
")",
"if",
"not",
"isinstance",
"(",
"file_hash",
",",
"six",
".",
"string_types",
")",
":",
"raise",
"SaltInvocationError",
"("... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | find | 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... | salt/modules/file.py | 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):
'''
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 ... | [
"Approximate",
"the",
"Unix",
"find",
"(",
"1",
")",
"command",
"and",
"return",
"a",
"list",
"of",
"paths",
"that",
"meet",
"the",
"specified",
"criteria",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L908-L1034 | [
"def",
"find",
"(",
"path",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"'delete'",
"in",
"args",
":",
"kwargs",
"[",
"'delete'",
"]",
"=",
"'f'",
"elif",
"'print'",
"in",
"args",
":",
"kwargs",
"[",
"'print'",
"]",
"=",
"'path'",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | _sed_esc | Escape single quotes and forward slashes | salt/modules/file.py | def _sed_esc(string, escape_all=False):
'''
Escape single quotes and forward slashes
'''
special_chars = "^.[$()|*+?{"
string = string.replace("'", "'\"'\"'").replace("/", "\\/")
if escape_all is True:
for char in special_chars:
string = string.replace(char, "\\" + char)
... | def _sed_esc(string, escape_all=False):
'''
Escape single quotes and forward slashes
'''
special_chars = "^.[$()|*+?{"
string = string.replace("'", "'\"'\"'").replace("/", "\\/")
if escape_all is True:
for char in special_chars:
string = string.replace(char, "\\" + char)
... | [
"Escape",
"single",
"quotes",
"and",
"forward",
"slashes"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L1037-L1046 | [
"def",
"_sed_esc",
"(",
"string",
",",
"escape_all",
"=",
"False",
")",
":",
"special_chars",
"=",
"\"^.[$()|*+?{\"",
"string",
"=",
"string",
".",
"replace",
"(",
"\"'\"",
",",
"\"'\\\"'\\\"'\"",
")",
".",
"replace",
"(",
"\"/\"",
",",
"\"\\\\/\"",
")",
"... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | sed | .. deprecated:: 0.17.0
Use :py:func:`~salt.modules.file.replace` instead.
Make a simple edit to a file
Equivalent to:
.. code-block:: bash
sed <backup> <options> "/<limit>/ s/<before>/<after>/<flags> <file>"
path
The full path to the file to be edited
before
A pat... | salt/modules/file.py | def sed(path,
before,
after,
limit='',
backup='.bak',
options='-r -e',
flags='g',
escape_all=False,
negate_match=False):
'''
.. deprecated:: 0.17.0
Use :py:func:`~salt.modules.file.replace` instead.
Make a simple edit to a file
Equ... | def sed(path,
before,
after,
limit='',
backup='.bak',
options='-r -e',
flags='g',
escape_all=False,
negate_match=False):
'''
.. deprecated:: 0.17.0
Use :py:func:`~salt.modules.file.replace` instead.
Make a simple edit to a file
Equ... | [
"..",
"deprecated",
"::",
"0",
".",
"17",
".",
"0",
"Use",
":",
"py",
":",
"func",
":",
"~salt",
".",
"modules",
".",
"file",
".",
"replace",
"instead",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L1049-L1132 | [
"def",
"sed",
"(",
"path",
",",
"before",
",",
"after",
",",
"limit",
"=",
"''",
",",
"backup",
"=",
"'.bak'",
",",
"options",
"=",
"'-r -e'",
",",
"flags",
"=",
"'g'",
",",
"escape_all",
"=",
"False",
",",
"negate_match",
"=",
"False",
")",
":",
"... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | sed_contains | .. deprecated:: 0.17.0
Use :func:`search` instead.
Return True if the file at ``path`` contains ``text``. Utilizes sed to
perform the search (line-wise search).
Note: the ``p`` flag will be added to any flags you pass in.
CLI Example:
.. code-block:: bash
salt '*' file.contains /... | salt/modules/file.py | def sed_contains(path,
text,
limit='',
flags='g'):
'''
.. deprecated:: 0.17.0
Use :func:`search` instead.
Return True if the file at ``path`` contains ``text``. Utilizes sed to
perform the search (line-wise search).
Note: the ``p`` flag wil... | def sed_contains(path,
text,
limit='',
flags='g'):
'''
.. deprecated:: 0.17.0
Use :func:`search` instead.
Return True if the file at ``path`` contains ``text``. Utilizes sed to
perform the search (line-wise search).
Note: the ``p`` flag wil... | [
"..",
"deprecated",
"::",
"0",
".",
"17",
".",
"0",
"Use",
":",
"func",
":",
"search",
"instead",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L1135-L1179 | [
"def",
"sed_contains",
"(",
"path",
",",
"text",
",",
"limit",
"=",
"''",
",",
"flags",
"=",
"'g'",
")",
":",
"# Largely inspired by Fabric's contrib.files.contains()",
"path",
"=",
"os",
".",
"path",
".",
"expanduser",
"(",
"path",
")",
"if",
"not",
"os",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | psed | .. deprecated:: 0.17.0
Use :py:func:`~salt.modules.file.replace` instead.
Make a simple edit to a file (pure Python version)
Equivalent to:
.. code-block:: bash
sed <backup> <options> "/<limit>/ s/<before>/<after>/<flags> <file>"
path
The full path to the file to be edited
... | salt/modules/file.py | def psed(path,
before,
after,
limit='',
backup='.bak',
flags='gMS',
escape_all=False,
multi=False):
'''
.. deprecated:: 0.17.0
Use :py:func:`~salt.modules.file.replace` instead.
Make a simple edit to a file (pure Python version)
Equ... | def psed(path,
before,
after,
limit='',
backup='.bak',
flags='gMS',
escape_all=False,
multi=False):
'''
.. deprecated:: 0.17.0
Use :py:func:`~salt.modules.file.replace` instead.
Make a simple edit to a file (pure Python version)
Equ... | [
"..",
"deprecated",
"::",
"0",
".",
"17",
".",
"0",
"Use",
":",
"py",
":",
"func",
":",
"~salt",
".",
"modules",
".",
"file",
".",
"replace",
"instead",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L1182-L1280 | [
"def",
"psed",
"(",
"path",
",",
"before",
",",
"after",
",",
"limit",
"=",
"''",
",",
"backup",
"=",
"'.bak'",
",",
"flags",
"=",
"'gMS'",
",",
"escape_all",
"=",
"False",
",",
"multi",
"=",
"False",
")",
":",
"# Largely inspired by Fabric's contrib.files... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | _psed | Does the actual work for file.psed, so that single lines can be passed in | salt/modules/file.py | def _psed(text,
before,
after,
limit,
flags):
'''
Does the actual work for file.psed, so that single lines can be passed in
'''
atext = text
if limit:
limit = re.compile(limit)
comps = text.split(limit)
atext = ''.join(comps[1:])
c... | def _psed(text,
before,
after,
limit,
flags):
'''
Does the actual work for file.psed, so that single lines can be passed in
'''
atext = text
if limit:
limit = re.compile(limit)
comps = text.split(limit)
atext = ''.join(comps[1:])
c... | [
"Does",
"the",
"actual",
"work",
"for",
"file",
".",
"psed",
"so",
"that",
"single",
"lines",
"can",
"be",
"passed",
"in"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L1291-L1317 | [
"def",
"_psed",
"(",
"text",
",",
"before",
",",
"after",
",",
"limit",
",",
"flags",
")",
":",
"atext",
"=",
"text",
"if",
"limit",
":",
"limit",
"=",
"re",
".",
"compile",
"(",
"limit",
")",
"comps",
"=",
"text",
".",
"split",
"(",
"limit",
")"... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | uncomment | .. deprecated:: 0.17.0
Use :py:func:`~salt.modules.file.replace` instead.
Uncomment specified commented lines in a file
path
The full path to the file to be edited
regex
A regular expression used to find the lines that are to be uncommented.
This regex should not include the... | salt/modules/file.py | def uncomment(path,
regex,
char='#',
backup='.bak'):
'''
.. deprecated:: 0.17.0
Use :py:func:`~salt.modules.file.replace` instead.
Uncomment specified commented lines in a file
path
The full path to the file to be edited
regex
A regu... | def uncomment(path,
regex,
char='#',
backup='.bak'):
'''
.. deprecated:: 0.17.0
Use :py:func:`~salt.modules.file.replace` instead.
Uncomment specified commented lines in a file
path
The full path to the file to be edited
regex
A regu... | [
"..",
"deprecated",
"::",
"0",
".",
"17",
".",
"0",
"Use",
":",
"py",
":",
"func",
":",
"~salt",
".",
"modules",
".",
"file",
".",
"replace",
"instead",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L1320-L1354 | [
"def",
"uncomment",
"(",
"path",
",",
"regex",
",",
"char",
"=",
"'#'",
",",
"backup",
"=",
"'.bak'",
")",
":",
"return",
"comment_line",
"(",
"path",
"=",
"path",
",",
"regex",
"=",
"regex",
",",
"char",
"=",
"char",
",",
"cmnt",
"=",
"False",
","... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | comment | .. deprecated:: 0.17.0
Use :py:func:`~salt.modules.file.replace` instead.
Comment out specified lines in a file
path
The full path to the file to be edited
regex
A regular expression used to find the lines that are to be commented;
this pattern will be wrapped in parenthesis... | salt/modules/file.py | def comment(path,
regex,
char='#',
backup='.bak'):
'''
.. deprecated:: 0.17.0
Use :py:func:`~salt.modules.file.replace` instead.
Comment out specified lines in a file
path
The full path to the file to be edited
regex
A regular expression u... | def comment(path,
regex,
char='#',
backup='.bak'):
'''
.. deprecated:: 0.17.0
Use :py:func:`~salt.modules.file.replace` instead.
Comment out specified lines in a file
path
The full path to the file to be edited
regex
A regular expression u... | [
"..",
"deprecated",
"::",
"0",
".",
"17",
".",
"0",
"Use",
":",
"py",
":",
"func",
":",
"~salt",
".",
"modules",
".",
"file",
".",
"replace",
"instead",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L1357-L1396 | [
"def",
"comment",
"(",
"path",
",",
"regex",
",",
"char",
"=",
"'#'",
",",
"backup",
"=",
"'.bak'",
")",
":",
"return",
"comment_line",
"(",
"path",
"=",
"path",
",",
"regex",
"=",
"regex",
",",
"char",
"=",
"char",
",",
"cmnt",
"=",
"True",
",",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | comment_line | r'''
Comment or Uncomment a line in a text file.
:param path: string
The full path to the text file.
:param regex: string
A regex expression that begins with ``^`` that will find the line you wish
to comment. Can be as simple as ``^color =``
:param char: string
The cha... | salt/modules/file.py | def comment_line(path,
regex,
char='#',
cmnt=True,
backup='.bak'):
r'''
Comment or Uncomment a line in a text file.
:param path: string
The full path to the text file.
:param regex: string
A regex expression that begin... | def comment_line(path,
regex,
char='#',
cmnt=True,
backup='.bak'):
r'''
Comment or Uncomment a line in a text file.
:param path: string
The full path to the text file.
:param regex: string
A regex expression that begin... | [
"r",
"Comment",
"or",
"Uncomment",
"a",
"line",
"in",
"a",
"text",
"file",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L1399-L1578 | [
"def",
"comment_line",
"(",
"path",
",",
"regex",
",",
"char",
"=",
"'#'",
",",
"cmnt",
"=",
"True",
",",
"backup",
"=",
"'.bak'",
")",
":",
"# Get the regex for comment or uncomment",
"if",
"cmnt",
":",
"regex",
"=",
"'{0}({1}){2}'",
".",
"format",
"(",
"... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | _get_flags | Return an integer appropriate for use as a flag for the re module from a
list of human-readable strings
.. code-block:: python
>>> _get_flags(['MULTILINE', 'IGNORECASE'])
10
>>> _get_flags('MULTILINE')
8
>>> _get_flags(2)
2 | salt/modules/file.py | def _get_flags(flags):
'''
Return an integer appropriate for use as a flag for the re module from a
list of human-readable strings
.. code-block:: python
>>> _get_flags(['MULTILINE', 'IGNORECASE'])
10
>>> _get_flags('MULTILINE')
8
>>> _get_flags(2)
2
... | def _get_flags(flags):
'''
Return an integer appropriate for use as a flag for the re module from a
list of human-readable strings
.. code-block:: python
>>> _get_flags(['MULTILINE', 'IGNORECASE'])
10
>>> _get_flags('MULTILINE')
8
>>> _get_flags(2)
2
... | [
"Return",
"an",
"integer",
"appropriate",
"for",
"use",
"as",
"a",
"flag",
"for",
"the",
"re",
"module",
"from",
"a",
"list",
"of",
"human",
"-",
"readable",
"strings"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L1581-L1617 | [
"def",
"_get_flags",
"(",
"flags",
")",
":",
"if",
"isinstance",
"(",
"flags",
",",
"six",
".",
"string_types",
")",
":",
"flags",
"=",
"[",
"flags",
"]",
"if",
"isinstance",
"(",
"flags",
",",
"Iterable",
")",
"and",
"not",
"isinstance",
"(",
"flags",... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | _add_flags | Combine ``flags`` and ``new_flags`` | salt/modules/file.py | def _add_flags(flags, new_flags):
'''
Combine ``flags`` and ``new_flags``
'''
flags = _get_flags(flags)
new_flags = _get_flags(new_flags)
return flags | new_flags | def _add_flags(flags, new_flags):
'''
Combine ``flags`` and ``new_flags``
'''
flags = _get_flags(flags)
new_flags = _get_flags(new_flags)
return flags | new_flags | [
"Combine",
"flags",
"and",
"new_flags"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L1620-L1626 | [
"def",
"_add_flags",
"(",
"flags",
",",
"new_flags",
")",
":",
"flags",
"=",
"_get_flags",
"(",
"flags",
")",
"new_flags",
"=",
"_get_flags",
"(",
"new_flags",
")",
"return",
"flags",
"|",
"new_flags"
] | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | _mkstemp_copy | Create a temp file and move/copy the contents of ``path`` to the temp file.
Return the path to the temp file.
path
The full path to the file whose contents will be moved/copied to a temp file.
Whether it's moved or copied depends on the value of ``preserve_inode``.
preserve_inode
Pr... | salt/modules/file.py | def _mkstemp_copy(path,
preserve_inode=True):
'''
Create a temp file and move/copy the contents of ``path`` to the temp file.
Return the path to the temp file.
path
The full path to the file whose contents will be moved/copied to a temp file.
Whether it's moved or copi... | def _mkstemp_copy(path,
preserve_inode=True):
'''
Create a temp file and move/copy the contents of ``path`` to the temp file.
Return the path to the temp file.
path
The full path to the file whose contents will be moved/copied to a temp file.
Whether it's moved or copi... | [
"Create",
"a",
"temp",
"file",
"and",
"move",
"/",
"copy",
"the",
"contents",
"of",
"path",
"to",
"the",
"temp",
"file",
".",
"Return",
"the",
"path",
"to",
"the",
"temp",
"file",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L1629-L1680 | [
"def",
"_mkstemp_copy",
"(",
"path",
",",
"preserve_inode",
"=",
"True",
")",
":",
"temp_file",
"=",
"None",
"# Create the temp file",
"try",
":",
"temp_file",
"=",
"salt",
".",
"utils",
".",
"files",
".",
"mkstemp",
"(",
"prefix",
"=",
"salt",
".",
"utils... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | _starts_till | Returns True if src and probe at least matches at the beginning till some point. | salt/modules/file.py | def _starts_till(src, probe, strip_comments=True):
'''
Returns True if src and probe at least matches at the beginning till some point.
'''
def _strip_comments(txt):
'''
Strip possible comments.
Usually comments are one or two symbols at the beginning of the line, separated with ... | def _starts_till(src, probe, strip_comments=True):
'''
Returns True if src and probe at least matches at the beginning till some point.
'''
def _strip_comments(txt):
'''
Strip possible comments.
Usually comments are one or two symbols at the beginning of the line, separated with ... | [
"Returns",
"True",
"if",
"src",
"and",
"probe",
"at",
"least",
"matches",
"at",
"the",
"beginning",
"till",
"some",
"point",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L1683-L1721 | [
"def",
"_starts_till",
"(",
"src",
",",
"probe",
",",
"strip_comments",
"=",
"True",
")",
":",
"def",
"_strip_comments",
"(",
"txt",
")",
":",
"'''\n Strip possible comments.\n Usually comments are one or two symbols at the beginning of the line, separated with spac... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | _regex_to_static | Expand regular expression to static match. | salt/modules/file.py | def _regex_to_static(src, regex):
'''
Expand regular expression to static match.
'''
if not src or not regex:
return None
try:
compiled = re.compile(regex, re.DOTALL)
src = [line for line in src if compiled.search(line) or line.count(regex)]
except Exception as ex:
... | def _regex_to_static(src, regex):
'''
Expand regular expression to static match.
'''
if not src or not regex:
return None
try:
compiled = re.compile(regex, re.DOTALL)
src = [line for line in src if compiled.search(line) or line.count(regex)]
except Exception as ex:
... | [
"Expand",
"regular",
"expression",
"to",
"static",
"match",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L1724-L1737 | [
"def",
"_regex_to_static",
"(",
"src",
",",
"regex",
")",
":",
"if",
"not",
"src",
"or",
"not",
"regex",
":",
"return",
"None",
"try",
":",
"compiled",
"=",
"re",
".",
"compile",
"(",
"regex",
",",
"re",
".",
"DOTALL",
")",
"src",
"=",
"[",
"line",... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | _assert_occurrence | Raise an exception, if there are different amount of specified occurrences in src. | salt/modules/file.py | def _assert_occurrence(probe, target, amount=1):
'''
Raise an exception, if there are different amount of specified occurrences in src.
'''
occ = len(probe)
if occ > amount:
msg = 'more than'
elif occ < amount:
msg = 'less than'
elif not occ:
msg = 'no'
else:
... | def _assert_occurrence(probe, target, amount=1):
'''
Raise an exception, if there are different amount of specified occurrences in src.
'''
occ = len(probe)
if occ > amount:
msg = 'more than'
elif occ < amount:
msg = 'less than'
elif not occ:
msg = 'no'
else:
... | [
"Raise",
"an",
"exception",
"if",
"there",
"are",
"different",
"amount",
"of",
"specified",
"occurrences",
"in",
"src",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L1740-L1757 | [
"def",
"_assert_occurrence",
"(",
"probe",
",",
"target",
",",
"amount",
"=",
"1",
")",
":",
"occ",
"=",
"len",
"(",
"probe",
")",
"if",
"occ",
">",
"amount",
":",
"msg",
"=",
"'more than'",
"elif",
"occ",
"<",
"amount",
":",
"msg",
"=",
"'less than'... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | _set_line_indent | Indent the line with the source line. | salt/modules/file.py | def _set_line_indent(src, line, indent):
'''
Indent the line with the source line.
'''
if not indent:
return line
idt = []
for c in src:
if c not in ['\t', ' ']:
break
idt.append(c)
return ''.join(idt) + line.lstrip() | def _set_line_indent(src, line, indent):
'''
Indent the line with the source line.
'''
if not indent:
return line
idt = []
for c in src:
if c not in ['\t', ' ']:
break
idt.append(c)
return ''.join(idt) + line.lstrip() | [
"Indent",
"the",
"line",
"with",
"the",
"source",
"line",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L1760-L1773 | [
"def",
"_set_line_indent",
"(",
"src",
",",
"line",
",",
"indent",
")",
":",
"if",
"not",
"indent",
":",
"return",
"line",
"idt",
"=",
"[",
"]",
"for",
"c",
"in",
"src",
":",
"if",
"c",
"not",
"in",
"[",
"'\\t'",
",",
"' '",
"]",
":",
"break",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | _set_line_eol | Add line ending | salt/modules/file.py | def _set_line_eol(src, line):
'''
Add line ending
'''
line_ending = _get_eol(src) or os.linesep
return line.rstrip() + line_ending | def _set_line_eol(src, line):
'''
Add line ending
'''
line_ending = _get_eol(src) or os.linesep
return line.rstrip() + line_ending | [
"Add",
"line",
"ending"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L1781-L1786 | [
"def",
"_set_line_eol",
"(",
"src",
",",
"line",
")",
":",
"line_ending",
"=",
"_get_eol",
"(",
"src",
")",
"or",
"os",
".",
"linesep",
"return",
"line",
".",
"rstrip",
"(",
")",
"+",
"line_ending"
] | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | line | .. versionadded:: 2015.8.0
Edit a line in the configuration file. The ``path`` and ``content``
arguments are required, as well as passing in one of the ``mode``
options.
path
Filesystem path to the file to be edited.
content
Content of the line. Allowed to be empty if mode=delete.... | salt/modules/file.py | def line(path, content=None, match=None, mode=None, location=None,
before=None, after=None, show_changes=True, backup=False,
quiet=False, indent=True):
'''
.. versionadded:: 2015.8.0
Edit a line in the configuration file. The ``path`` and ``content``
arguments are required, as well as... | def line(path, content=None, match=None, mode=None, location=None,
before=None, after=None, show_changes=True, backup=False,
quiet=False, indent=True):
'''
.. versionadded:: 2015.8.0
Edit a line in the configuration file. The ``path`` and ``content``
arguments are required, as well as... | [
"..",
"versionadded",
"::",
"2015",
".",
"8",
".",
"0"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L1805-L2068 | [
"def",
"line",
"(",
"path",
",",
"content",
"=",
"None",
",",
"match",
"=",
"None",
",",
"mode",
"=",
"None",
",",
"location",
"=",
"None",
",",
"before",
"=",
"None",
",",
"after",
"=",
"None",
",",
"show_changes",
"=",
"True",
",",
"backup",
"=",... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | replace | .. versionadded:: 0.17.0
Replace occurrences of a pattern in a file. If ``show_changes`` is
``True``, then a diff of what changed will be returned, otherwise a
``True`` will be returned when changes are made, and ``False`` when
no changes are made.
This is a pure Python implementation that wraps P... | salt/modules/file.py | def replace(path,
pattern,
repl,
count=0,
flags=8,
bufsize=1,
append_if_not_found=False,
prepend_if_not_found=False,
not_found_content=None,
backup='.bak',
dry_run=False,
search_only=False... | def replace(path,
pattern,
repl,
count=0,
flags=8,
bufsize=1,
append_if_not_found=False,
prepend_if_not_found=False,
not_found_content=None,
backup='.bak',
dry_run=False,
search_only=False... | [
"..",
"versionadded",
"::",
"0",
".",
"17",
".",
"0"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L2071-L2450 | [
"def",
"replace",
"(",
"path",
",",
"pattern",
",",
"repl",
",",
"count",
"=",
"0",
",",
"flags",
"=",
"8",
",",
"bufsize",
"=",
"1",
",",
"append_if_not_found",
"=",
"False",
",",
"prepend_if_not_found",
"=",
"False",
",",
"not_found_content",
"=",
"Non... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | blockreplace | .. versionadded:: 2014.1.0
Replace content of a text block in a file, delimited by line markers
A block of content delimited by comments can help you manage several lines
entries without worrying about old entries removal.
.. note::
This function will store two copies of the file in-memory (... | salt/modules/file.py | def blockreplace(path,
marker_start='#-- start managed zone --',
marker_end='#-- end managed zone --',
content='',
append_if_not_found=False,
prepend_if_not_found=False,
backup='.bak',
dry_run=False,
show_changes=True,
append_newline=False,
... | def blockreplace(path,
marker_start='#-- start managed zone --',
marker_end='#-- end managed zone --',
content='',
append_if_not_found=False,
prepend_if_not_found=False,
backup='.bak',
dry_run=False,
show_changes=True,
append_newline=False,
... | [
"..",
"versionadded",
"::",
"2014",
".",
"1",
".",
"0"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L2453-L2776 | [
"def",
"blockreplace",
"(",
"path",
",",
"marker_start",
"=",
"'#-- start managed zone --'",
",",
"marker_end",
"=",
"'#-- end managed zone --'",
",",
"content",
"=",
"''",
",",
"append_if_not_found",
"=",
"False",
",",
"prepend_if_not_found",
"=",
"False",
",",
"ba... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | search | .. versionadded:: 0.17.0
Search for occurrences of a pattern in a file
Except for multiline, params are identical to
:py:func:`~salt.modules.file.replace`.
multiline
If true, inserts 'MULTILINE' into ``flags`` and sets ``bufsize`` to
'file'.
.. versionadded:: 2015.8.0
CL... | salt/modules/file.py | def search(path,
pattern,
flags=8,
bufsize=1,
ignore_if_missing=False,
multiline=False
):
'''
.. versionadded:: 0.17.0
Search for occurrences of a pattern in a file
Except for multiline, params are identical to
:py:func:`~salt.modules.file.replace`.
... | def search(path,
pattern,
flags=8,
bufsize=1,
ignore_if_missing=False,
multiline=False
):
'''
.. versionadded:: 0.17.0
Search for occurrences of a pattern in a file
Except for multiline, params are identical to
:py:func:`~salt.modules.file.replace`.
... | [
"..",
"versionadded",
"::",
"0",
".",
"17",
".",
"0"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L2779-L2821 | [
"def",
"search",
"(",
"path",
",",
"pattern",
",",
"flags",
"=",
"8",
",",
"bufsize",
"=",
"1",
",",
"ignore_if_missing",
"=",
"False",
",",
"multiline",
"=",
"False",
")",
":",
"if",
"multiline",
":",
"flags",
"=",
"_add_flags",
"(",
"flags",
",",
"... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | patch | .. versionadded:: 0.10.4
Apply a patch to a file or directory.
Equivalent to:
.. code-block:: bash
patch <options> -i <patchfile> <originalfile>
Or, when a directory is patched:
.. code-block:: bash
patch <options> -i <patchfile> -d <originalfile> -p0
originalfile
... | salt/modules/file.py | def patch(originalfile, patchfile, options='', dry_run=False):
'''
.. versionadded:: 0.10.4
Apply a patch to a file or directory.
Equivalent to:
.. code-block:: bash
patch <options> -i <patchfile> <originalfile>
Or, when a directory is patched:
.. code-block:: bash
pat... | def patch(originalfile, patchfile, options='', dry_run=False):
'''
.. versionadded:: 0.10.4
Apply a patch to a file or directory.
Equivalent to:
.. code-block:: bash
patch <options> -i <patchfile> <originalfile>
Or, when a directory is patched:
.. code-block:: bash
pat... | [
"..",
"versionadded",
"::",
"0",
".",
"10",
".",
"4"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L2824-L2903 | [
"def",
"patch",
"(",
"originalfile",
",",
"patchfile",
",",
"options",
"=",
"''",
",",
"dry_run",
"=",
"False",
")",
":",
"patchpath",
"=",
"salt",
".",
"utils",
".",
"path",
".",
"which",
"(",
"'patch'",
")",
"if",
"not",
"patchpath",
":",
"raise",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | contains | .. deprecated:: 0.17.0
Use :func:`search` instead.
Return ``True`` if the file at ``path`` contains ``text``
CLI Example:
.. code-block:: bash
salt '*' file.contains /etc/crontab 'mymaintenance.sh' | salt/modules/file.py | def contains(path, text):
'''
.. deprecated:: 0.17.0
Use :func:`search` instead.
Return ``True`` if the file at ``path`` contains ``text``
CLI Example:
.. code-block:: bash
salt '*' file.contains /etc/crontab 'mymaintenance.sh'
'''
path = os.path.expanduser(path)
if n... | def contains(path, text):
'''
.. deprecated:: 0.17.0
Use :func:`search` instead.
Return ``True`` if the file at ``path`` contains ``text``
CLI Example:
.. code-block:: bash
salt '*' file.contains /etc/crontab 'mymaintenance.sh'
'''
path = os.path.expanduser(path)
if n... | [
"..",
"deprecated",
"::",
"0",
".",
"17",
".",
"0",
"Use",
":",
"func",
":",
"search",
"instead",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L2906-L2932 | [
"def",
"contains",
"(",
"path",
",",
"text",
")",
":",
"path",
"=",
"os",
".",
"path",
".",
"expanduser",
"(",
"path",
")",
"if",
"not",
"os",
".",
"path",
".",
"exists",
"(",
"path",
")",
":",
"return",
"False",
"stripped_text",
"=",
"six",
".",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | contains_regex | .. deprecated:: 0.17.0
Use :func:`search` instead.
Return True if the given regular expression matches on any line in the text
of a given file.
If the lchar argument (leading char) is specified, it
will strip `lchar` from the left side of each line before trying to match
CLI Example:
... | salt/modules/file.py | def contains_regex(path, regex, lchar=''):
'''
.. deprecated:: 0.17.0
Use :func:`search` instead.
Return True if the given regular expression matches on any line in the text
of a given file.
If the lchar argument (leading char) is specified, it
will strip `lchar` from the left side of e... | def contains_regex(path, regex, lchar=''):
'''
.. deprecated:: 0.17.0
Use :func:`search` instead.
Return True if the given regular expression matches on any line in the text
of a given file.
If the lchar argument (leading char) is specified, it
will strip `lchar` from the left side of e... | [
"..",
"deprecated",
"::",
"0",
".",
"17",
".",
"0",
"Use",
":",
"func",
":",
"search",
"instead",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L2935-L2967 | [
"def",
"contains_regex",
"(",
"path",
",",
"regex",
",",
"lchar",
"=",
"''",
")",
":",
"path",
"=",
"os",
".",
"path",
".",
"expanduser",
"(",
"path",
")",
"if",
"not",
"os",
".",
"path",
".",
"exists",
"(",
"path",
")",
":",
"return",
"False",
"... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | contains_glob | .. deprecated:: 0.17.0
Use :func:`search` instead.
Return ``True`` if the given glob matches a string in the named file
CLI Example:
.. code-block:: bash
salt '*' file.contains_glob /etc/foobar '*cheese*' | salt/modules/file.py | def contains_glob(path, glob_expr):
'''
.. deprecated:: 0.17.0
Use :func:`search` instead.
Return ``True`` if the given glob matches a string in the named file
CLI Example:
.. code-block:: bash
salt '*' file.contains_glob /etc/foobar '*cheese*'
'''
path = os.path.expanduse... | def contains_glob(path, glob_expr):
'''
.. deprecated:: 0.17.0
Use :func:`search` instead.
Return ``True`` if the given glob matches a string in the named file
CLI Example:
.. code-block:: bash
salt '*' file.contains_glob /etc/foobar '*cheese*'
'''
path = os.path.expanduse... | [
"..",
"deprecated",
"::",
"0",
".",
"17",
".",
"0",
"Use",
":",
"func",
":",
"search",
"instead",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/file.py#L2970-L2995 | [
"def",
"contains_glob",
"(",
"path",
",",
"glob_expr",
")",
":",
"path",
"=",
"os",
".",
"path",
".",
"expanduser",
"(",
"path",
")",
"if",
"not",
"os",
".",
"path",
".",
"exists",
"(",
"path",
")",
":",
"return",
"False",
"try",
":",
"with",
"salt... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.